/mandos/release : revision 302

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

import collections

79

import codecs

80

import unittest

81

71

82

72

import dbus

83

73

import dbus.service

84

import gi

85

from gi.repository import GLib

74

import gobject

75

import avahi

86

76

from dbus.mainloop.glib import DBusGMainLoop

87

77

import ctypes

88

78

import ctypes.util

89

79

import xml.dom.minidom

90

80

import inspect

91

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

str = unicode

95

96

# Show warnings by default

97

if not sys.warnoptions:

98

import warnings

99

warnings.simplefilter("default")

100

101

# Try to find the value of SO_BINDTODEVICE:

81

import GnuPGInterface

82

102

83

try:

103

# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and

104

# newer, and it is also the most natural place for it:

105

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

106

85

except AttributeError:

107

86

try:

108

# This is where SO_BINDTODEVICE was up to and including Python

109

# 2.6, and also 3.2:

110

87

from IN import SO_BINDTODEVICE

111

88

except ImportError:

112

# In Python 2.7 it seems to have been removed entirely.

113

# Try running the C preprocessor:

114

try:

115

cc = subprocess.Popen(["cc", "--language=c", "-E",

116

"/dev/stdin"],

117

stdin=subprocess.PIPE,

118

stdout=subprocess.PIPE)

119

stdout = cc.communicate(

120

"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]

121

SO_BINDTODEVICE = int(stdout.splitlines()[-1])

122

except (OSError, ValueError, IndexError):

123

# No value found

124

SO_BINDTODEVICE = None

125

126

if sys.version_info < (3, 2):

127

configparser.Configparser = configparser.SafeConfigParser

128

129

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

130

92

stored_state_file = "clients.pickle"

131

93

132

94

logger = logging.getLogger()

133

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

134

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

135

98

136

99

try:

137

if_nametoindex = ctypes.cdll.LoadLibrary(

138

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

139

103

except (OSError, AttributeError):

140

141

104

def if_nametoindex(interface):

142

105

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

143

106

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

144

107

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

145

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

146

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

147

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

148

113

return interface_index

149

114

150

115

151

def copy_function(func):

152

"""Make a copy of a function"""

153

if sys.version_info.major == 2:

154

return types.FunctionType(func.func_code,

155

func.func_globals,

156

func.func_name,

157

func.func_defaults,

158

func.func_closure)

159

else:

160

return types.FunctionType(func.__code__,

161

func.__globals__,

162

func.__name__,

163

func.__defaults__,

164

func.__closure__)

165

166

167

116

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

168

117

"""init logger and add loglevel"""

169

170

global syslogger

171

syslogger = (logging.handlers.SysLogHandler(

172

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

173

address="/dev/log"))

118

174

119

syslogger.setFormatter(logging.Formatter

175

120

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

176

121

' %(message)s'))

177

122

logger.addHandler(syslogger)

178

123

179

124

if debug:

180

125

console = logging.StreamHandler()

181

126

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

191

136

pass

192

137

193

138

194

class PGPEngine:

139

class PGPEngine(object):

195

140

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

196

197

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

198

143

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

199

self.gpg = "gpg"

200

try:

201

output = subprocess.check_output(["gpgconf"])

202

for line in output.splitlines():

203

name, text, path = line.split(b":")

204

if name == b"gpg":

205

self.gpg = path

206

break

207

except OSError as e:

208

if e.errno != errno.ENOENT:

209

raise

210

self.gnupgargs = ['--batch',

211

'--homedir', self.tempdir,

212

'--force-mdc',

213

'--quiet']

214

# Only GPG version 1 has the --no-use-agent option.

215

if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):

216

self.gnupgargs.append("--no-use-agent")

217

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

218

151

def __enter__(self):

219

152

return self

220

153

221

154

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

222

155

self._cleanup()

223

156

return False

224

157

225

158

def __del__(self):

226

159

self._cleanup()

227

160

228

161

def _cleanup(self):

229

162

if self.tempdir is not None:

230

163

# Delete contents of tempdir

231

164

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

232

topdown=False):

165

topdown = False):

233

166

for filename in files:

234

167

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

235

168

for dirname in dirs:

237

170

# Remove tempdir

238

171

os.rmdir(self.tempdir)

239

172

self.tempdir = None

240

173

241

174

def password_encode(self, password):

242

175

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

243

176

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

244

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

245

if len(encoded) > 2048:

246

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

247

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

248

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

249

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

250

return encoded

251

177

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

178

252

179

def encrypt(self, data, password):

253

passphrase = self.password_encode(password)

254

with tempfile.NamedTemporaryFile(

255

dir=self.tempdir) as passfile:

256

passfile.write(passphrase)

257

passfile.flush()

258

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

259

'--passphrase-file',

260

passfile.name]

261

+ self.gnupgargs,

262

stdin=subprocess.PIPE,

263

stdout=subprocess.PIPE,

264

stderr=subprocess.PIPE)

265

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

266

if proc.returncode != 0:

267

raise PGPError(err)

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

268

194

return ciphertext

269

195

270

196

def decrypt(self, data, password):

271

passphrase = self.password_encode(password)

272

with tempfile.NamedTemporaryFile(

273

dir=self.tempdir) as passfile:

274

passfile.write(passphrase)

275

passfile.flush()

276

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

277

'--passphrase-file',

278

passfile.name]

279

+ self.gnupgargs,

280

stdin=subprocess.PIPE,

281

stdout=subprocess.PIPE,

282

stderr=subprocess.PIPE)

283

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

284

if proc.returncode != 0:

285

raise PGPError(err)

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

286

211

return decrypted_plaintext

287

212

288

213

289

# Pretend that we have an Avahi module

290

class avahi:

291

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

292

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

293

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

294

PROTO_INET = 0 # avahi-common/address.h

295

PROTO_INET6 = 1 # avahi-common/address.h

296

DBUS_NAME = "org.freedesktop.Avahi"

297

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

298

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

299

DBUS_PATH_SERVER = "/"

300

301

@staticmethod

302

def string_array_to_txt_array(t):

303

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

304

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

305

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

306

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

307

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

308

SERVER_INVALID = 0 # avahi-common/defs.h

309

SERVER_REGISTERING = 1 # avahi-common/defs.h

310

SERVER_RUNNING = 2 # avahi-common/defs.h

311

SERVER_COLLISION = 3 # avahi-common/defs.h

312

SERVER_FAILURE = 4 # avahi-common/defs.h

313

314

315

214

class AvahiError(Exception):

316

215

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

317

216

self.value = value

318

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

319

**kwargs)

320

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

321

220

322

221

class AvahiServiceError(AvahiError):

323

222

pass

324

223

325

326

224

class AvahiGroupError(AvahiError):

327

225

pass

328

226

329

227

330

class AvahiService:

228

class AvahiService(object):

331

229

"""An Avahi (Zeroconf) service.

332

230

333

231

Attributes:

334

232

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

335

233

Used to optionally bind to the specified interface.

336

234

name: string; Example: 'Mandos'

337

235

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

338

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

236

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

339

237

port: integer; what port to announce

340

238

TXT: list of strings; TXT record for the service

341

239

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

347

245

server: D-Bus Server

348

246

bus: dbus.SystemBus()

349

247

"""

350

351

def __init__(self,

352

interface=avahi.IF_UNSPEC,

353

name=None,

354

servicetype=None,

355

port=None,

356

TXT=None,

357

domain="",

358

host="",

359

max_renames=32768,

360

protocol=avahi.PROTO_UNSPEC,

361

bus=None):

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

362

253

self.interface = interface

363

254

self.name = name

364

255

self.type = servicetype

373

264

self.server = None

374

265

self.bus = bus

375

266

self.entry_group_state_changed_match = None

376

377

def rename(self, remove=True):

267

268

def rename(self):

378

269

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

379

270

if self.rename_count >= self.max_renames:

380

271

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

381

272

" after %i retries, exiting.",

382

273

self.rename_count)

383

274

raise AvahiServiceError("Too many renames")

384

self.name = str(

385

self.server.GetAlternativeServiceName(self.name))

386

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

387

277

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

388

278

self.name)

389

if remove:

390

self.remove()

279

self.remove()

391

280

try:

392

281

self.add()

393

282

except dbus.exceptions.DBusException as error:

394

if (error.get_dbus_name()

395

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

396

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

397

return self.rename(remove=False)

398

else:

399

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

400

self.cleanup()

401

os._exit(1)

402

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

403

288

def remove(self):

404

289

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

405

290

if self.entry_group_state_changed_match is not None:

407

292

self.entry_group_state_changed_match = None

408

293

if self.group is not None:

409

294

self.group.Reset()

410

295

411

296

def add(self):

412

297

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

413

298

self.remove()

430

315

dbus.UInt16(self.port),

431

316

avahi.string_array_to_txt_array(self.TXT))

432

317

self.group.Commit()

433

318

434

319

def entry_group_state_changed(self, state, error):

435

320

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

436

321

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

437

322

438

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

439

324

logger.debug("Zeroconf service established.")

440

325

elif state == avahi.ENTRY_GROUP_COLLISION:

442

327

self.rename()

443

328

elif state == avahi.ENTRY_GROUP_FAILURE:

444

329

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

445

str(error))

446

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

447

330

unicode(error))

331

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

332

.format(error))

333

448

334

def cleanup(self):

449

335

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

450

336

if self.group is not None:

455

341

pass

456

342

self.group = None

457

343

self.remove()

458

344

459

345

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

460

346

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

461

347

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

462

bad_states = {

463

avahi.SERVER_INVALID: "Zeroconf server invalid",

464

avahi.SERVER_REGISTERING: None,

465

avahi.SERVER_COLLISION: "Zeroconf server name collision",

466

avahi.SERVER_FAILURE: "Zeroconf server failure",

467

}

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

468

355

if state in bad_states:

469

356

if bad_states[state] is not None:

470

357

if error is None:

473

360

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

474

361

self.cleanup()

475

362

elif state == avahi.SERVER_RUNNING:

476

try:

477

self.add()

478

except dbus.exceptions.DBusException as error:

479

if (error.get_dbus_name()

480

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

481

logger.info("Local Zeroconf service name"

482

" collision.")

483

return self.rename(remove=False)

484

else:

485

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

486

self.cleanup()

487

os._exit(1)

363

self.add()

488

364

else:

489

365

if error is None:

490

366

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

491

367

else:

492

368

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

493

369

494

370

def activate(self):

495

371

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

496

372

if self.server is None:

500

376

follow_name_owner_changes=True),

501

377

avahi.DBUS_INTERFACE_SERVER)

502

378

self.server.connect_to_signal("StateChanged",

503

self.server_state_changed)

379

self.server_state_changed)

504

380

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

505

381

506

382

507

383

class AvahiServiceToSyslog(AvahiService):

508

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

384

def rename(self):

509

385

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

510

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

511

syslogger.setFormatter(logging.Formatter(

512

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

513

.format(self.name)))

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

.format(self.name)))

514

391

return ret

515

392

516

393

517

# Pretend that we have a GnuTLS module

518

class gnutls:

519

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

520

521

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

522

if library is None:

523

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

524

_library = ctypes.cdll.LoadLibrary(library)

525

del library

526

527

# Unless otherwise indicated, the constants and types below are

528

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

529

530

# Constants

531

E_SUCCESS = 0

532

E_INTERRUPTED = -52

533

E_AGAIN = -28

534

CRT_OPENPGP = 2

535

CRT_RAWPK = 3

536

CLIENT = 2

537

SHUT_RDWR = 0

538

CRD_CERTIFICATE = 1

539

E_NO_CERTIFICATE_FOUND = -49

540

X509_FMT_DER = 0

541

NO_TICKETS = 1<<10

542

ENABLE_RAWPK = 1<<18

543

CTYPE_PEERS = 3

544

KEYID_USE_SHA256 = 1 # gnutls/x509.h

545

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

546

547

# Types

548

class session_int(ctypes.Structure):

549

_fields_ = []

550

session_t = ctypes.POINTER(session_int)

551

552

class certificate_credentials_st(ctypes.Structure):

553

_fields_ = []

554

certificate_credentials_t = ctypes.POINTER(

555

certificate_credentials_st)

556

certificate_type_t = ctypes.c_int

557

558

class datum_t(ctypes.Structure):

559

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

560

('size', ctypes.c_uint)]

561

562

class openpgp_crt_int(ctypes.Structure):

563

_fields_ = []

564

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

565

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

566

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

567

credentials_type_t = ctypes.c_int

568

transport_ptr_t = ctypes.c_void_p

569

close_request_t = ctypes.c_int

570

571

# Exceptions

572

class Error(Exception):

573

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

574

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

575

# code is passed, convert it to a string with

576

# gnutls.strerror()

577

self.code = code

578

if message is None and code is not None:

579

message = gnutls.strerror(code)

580

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

581

message, *args)

582

583

class CertificateSecurityError(Error):

584

pass

585

586

# Classes

587

class Credentials:

588

def __init__(self):

589

self._c_object = gnutls.certificate_credentials_t()

590

gnutls.certificate_allocate_credentials(

591

ctypes.byref(self._c_object))

592

self.type = gnutls.CRD_CERTIFICATE

593

594

def __del__(self):

595

gnutls.certificate_free_credentials(self._c_object)

596

597

class ClientSession:

598

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

599

self._c_object = gnutls.session_t()

600

gnutls_flags = gnutls.CLIENT

601

if gnutls.check_version(b"3.5.6"):

602

gnutls_flags |= gnutls.NO_TICKETS

603

if gnutls.has_rawpk:

604

gnutls_flags |= gnutls.ENABLE_RAWPK

605

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

606

del gnutls_flags

607

gnutls.set_default_priority(self._c_object)

608

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

609

gnutls.handshake_set_private_extensions(self._c_object,

610

True)

611

self.socket = socket

612

if credentials is None:

613

credentials = gnutls.Credentials()

614

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

615

ctypes.cast(credentials._c_object,

616

ctypes.c_void_p))

617

self.credentials = credentials

618

619

def __del__(self):

620

gnutls.deinit(self._c_object)

621

622

def handshake(self):

623

return gnutls.handshake(self._c_object)

624

625

def send(self, data):

626

data = bytes(data)

627

data_len = len(data)

628

while data_len > 0:

629

data_len -= gnutls.record_send(self._c_object,

630

data[-data_len:],

631

data_len)

632

633

def bye(self):

634

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

635

636

# Error handling functions

637

def _error_code(result):

638

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

639

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

640

if result >= 0:

641

return result

642

if result == gnutls.E_NO_CERTIFICATE_FOUND:

643

raise gnutls.CertificateSecurityError(code=result)

644

raise gnutls.Error(code=result)

645

646

def _retry_on_error(result, func, arguments):

647

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

648

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

649

while result < 0:

650

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

651

return _error_code(result)

652

result = func(*arguments)

653

return result

654

655

# Unless otherwise indicated, the function declarations below are

656

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

657

658

# Functions

659

priority_set_direct = _library.gnutls_priority_set_direct

660

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

661

ctypes.POINTER(ctypes.c_char_p)]

662

priority_set_direct.restype = _error_code

663

664

init = _library.gnutls_init

665

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

666

init.restype = _error_code

667

668

set_default_priority = _library.gnutls_set_default_priority

669

set_default_priority.argtypes = [session_t]

670

set_default_priority.restype = _error_code

671

672

record_send = _library.gnutls_record_send

673

record_send.argtypes = [session_t, ctypes.c_void_p,

674

ctypes.c_size_t]

675

record_send.restype = ctypes.c_ssize_t

676

record_send.errcheck = _retry_on_error

677

678

certificate_allocate_credentials = (

679

_library.gnutls_certificate_allocate_credentials)

680

certificate_allocate_credentials.argtypes = [

681

ctypes.POINTER(certificate_credentials_t)]

682

certificate_allocate_credentials.restype = _error_code

683

684

certificate_free_credentials = (

685

_library.gnutls_certificate_free_credentials)

686

certificate_free_credentials.argtypes = [

687

certificate_credentials_t]

688

certificate_free_credentials.restype = None

689

690

handshake_set_private_extensions = (

691

_library.gnutls_handshake_set_private_extensions)

692

handshake_set_private_extensions.argtypes = [session_t,

693

ctypes.c_int]

694

handshake_set_private_extensions.restype = None

695

696

credentials_set = _library.gnutls_credentials_set

697

credentials_set.argtypes = [session_t, credentials_type_t,

698

ctypes.c_void_p]

699

credentials_set.restype = _error_code

700

701

strerror = _library.gnutls_strerror

702

strerror.argtypes = [ctypes.c_int]

703

strerror.restype = ctypes.c_char_p

704

705

certificate_type_get = _library.gnutls_certificate_type_get

706

certificate_type_get.argtypes = [session_t]

707

certificate_type_get.restype = _error_code

708

709

certificate_get_peers = _library.gnutls_certificate_get_peers

710

certificate_get_peers.argtypes = [session_t,

711

ctypes.POINTER(ctypes.c_uint)]

712

certificate_get_peers.restype = ctypes.POINTER(datum_t)

713

714

global_set_log_level = _library.gnutls_global_set_log_level

715

global_set_log_level.argtypes = [ctypes.c_int]

716

global_set_log_level.restype = None

717

718

global_set_log_function = _library.gnutls_global_set_log_function

719

global_set_log_function.argtypes = [log_func]

720

global_set_log_function.restype = None

721

722

deinit = _library.gnutls_deinit

723

deinit.argtypes = [session_t]

724

deinit.restype = None

725

726

handshake = _library.gnutls_handshake

727

handshake.argtypes = [session_t]

728

handshake.restype = _error_code

729

handshake.errcheck = _retry_on_error

730

731

transport_set_ptr = _library.gnutls_transport_set_ptr

732

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

733

transport_set_ptr.restype = None

734

735

bye = _library.gnutls_bye

736

bye.argtypes = [session_t, close_request_t]

737

bye.restype = _error_code

738

bye.errcheck = _retry_on_error

739

740

check_version = _library.gnutls_check_version

741

check_version.argtypes = [ctypes.c_char_p]

742

check_version.restype = ctypes.c_char_p

743

744

_need_version = b"3.3.0"

745

if check_version(_need_version) is None:

746

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

747

.format(_need_version))

748

749

_tls_rawpk_version = b"3.6.6"

750

has_rawpk = bool(check_version(_tls_rawpk_version))

751

752

if has_rawpk:

753

# Types

754

class pubkey_st(ctypes.Structure):

755

_fields = []

756

pubkey_t = ctypes.POINTER(pubkey_st)

757

758

x509_crt_fmt_t = ctypes.c_int

759

760

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

761

pubkey_init = _library.gnutls_pubkey_init

762

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

763

pubkey_init.restype = _error_code

764

765

pubkey_import = _library.gnutls_pubkey_import

766

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

767

x509_crt_fmt_t]

768

pubkey_import.restype = _error_code

769

770

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

771

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

772

ctypes.POINTER(ctypes.c_ubyte),

773

ctypes.POINTER(ctypes.c_size_t)]

774

pubkey_get_key_id.restype = _error_code

775

776

pubkey_deinit = _library.gnutls_pubkey_deinit

777

pubkey_deinit.argtypes = [pubkey_t]

778

pubkey_deinit.restype = None

779

else:

780

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

781

782

openpgp_crt_init = _library.gnutls_openpgp_crt_init

783

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

784

openpgp_crt_init.restype = _error_code

785

786

openpgp_crt_import = _library.gnutls_openpgp_crt_import

787

openpgp_crt_import.argtypes = [openpgp_crt_t,

788

ctypes.POINTER(datum_t),

789

openpgp_crt_fmt_t]

790

openpgp_crt_import.restype = _error_code

791

792

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

793

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

794

ctypes.POINTER(ctypes.c_uint)]

795

openpgp_crt_verify_self.restype = _error_code

796

797

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

798

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

799

openpgp_crt_deinit.restype = None

800

801

openpgp_crt_get_fingerprint = (

802

_library.gnutls_openpgp_crt_get_fingerprint)

803

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

804

ctypes.c_void_p,

805

ctypes.POINTER(

806

ctypes.c_size_t)]

807

openpgp_crt_get_fingerprint.restype = _error_code

808

809

if check_version(b"3.6.4"):

810

certificate_type_get2 = _library.gnutls_certificate_type_get2

811

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

812

certificate_type_get2.restype = _error_code

813

814

# Remove non-public functions

815

del _error_code, _retry_on_error

816

817

818

def call_pipe(connection, # : multiprocessing.Connection

819

func, *args, **kwargs):

820

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

821

822

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

823

return value on the provided multiprocessing.Connection.

824

"""

825

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

826

connection.close()

827

828

829

class Client:

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

400

401

class Client(object):

830

402

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

831

403

832

404

Attributes:

833

405

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

834

406

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

835

407

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

836

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

837

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

838

running.

839

checker_callback_tag: a GLib event source tag, or None

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

840

412

checker_command: string; External command which is run to check

841

413

if client lives. %() expansions are done at

842

414

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

843

415

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

844

checker_initiator_tag: a GLib event source tag, or None

416

checker_initiator_tag: a gobject event source tag, or None

845

417

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

846

418

client_structure: Object describing what attributes a client has

847

419

and is used for storing the client at exit

848

420

current_checker_command: string; current running checker_command

849

disable_initiator_tag: a GLib event source tag, or None

421

disable_initiator_tag: a gobject event source tag, or None

850

422

enabled: bool()

851

423

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

852

uniquely identify an OpenPGP client

853

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

854

a client using raw public keys

424

uniquely identify the client

855

425

host: string; available for use by the checker command

856

426

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

857

427

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

859

429

last_checker_status: integer between 0 and 255 reflecting exit

860

430

status of last checker. -1 reflects crashed

861

431

checker, -2 means no checker completed yet.

862

last_checker_signal: The signal which killed the last checker, if

863

last_checker_status is -1

864

432

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

865

433

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

866

434

D-Bus identifiers

871

439

runtime_expansions: Allowed attributes for runtime expansion.

872

440

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

873

441

disabled, or None

874

server_settings: The server_settings dict from main()

875

442

"""

876

443

877

444

runtime_expansions = ("approval_delay", "approval_duration",

878

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

445

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

879

446

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

880

447

"last_approval_request", "last_checked_ok",

881

448

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

882

client_defaults = {

883

"timeout": "PT5M",

884

"extended_timeout": "PT15M",

885

"interval": "PT2M",

886

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

887

"host": "",

888

"approval_delay": "PT0S",

889

"approval_duration": "PT1S",

890

"approved_by_default": "True",

891

"enabled": "True",

892

}

893

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

894

475

@staticmethod

895

476

def config_parser(config):

896

477

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

903

484

for client_name in config.sections():

904

485

section = dict(config.items(client_name))

905

486

client = settings[client_name] = {}

906

487

907

488

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

908

489

# Reformat values from string types to Python types

909

490

client["approved_by_default"] = config.getboolean(

910

491

client_name, "approved_by_default")

911

492

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

912

493

"enabled")

913

914

# Uppercase and remove spaces from key_id and fingerprint

915

# for later comparison purposes with return value from the

916

# key_id() and fingerprint() functions

917

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

918

.replace(" ", ""))

494

919

495

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

920

496

.replace(" ", ""))

921

497

if "secret" in section:

922

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

923

.encode("utf-8"),

924

"base64")

498

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

925

499

elif "secfile" in section:

926

500

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

927

501

(section["secfile"])),

928

502

"rb") as secfile:

929

503

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

930

504

else:

931

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

505

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

932

506

.format(section))

933

507

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

934

508

client["extended_timeout"] = string_to_delta(

942

516

client["last_approval_request"] = None

943

517

client["last_checked_ok"] = None

944

518

client["last_checker_status"] = -2

945

519

946

520

return settings

947

948

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

521

522

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

949

523

self.name = name

950

if server_settings is None:

951

server_settings = {}

952

self.server_settings = server_settings

953

524

# adding all client settings

954

for setting, value in settings.items():

525

for setting, value in settings.iteritems():

955

526

setattr(self, setting, value)

956

527

957

528

if self.enabled:

958

529

if not hasattr(self, "last_enabled"):

959

530

self.last_enabled = datetime.datetime.utcnow()

963

534

else:

964

535

self.last_enabled = None

965

536

self.expires = None

966

537

967

538

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

968

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

969

542

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

970

543

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

971

544

datetime.datetime.utcnow())

972

545

973

546

# attributes specific for this server instance

974

547

self.checker = None

975

548

self.checker_initiator_tag = None

978

551

self.current_checker_command = None

979

552

self.approved = None

980

553

self.approvals_pending = 0

981

self.changedstate = multiprocessing_manager.Condition(

982

multiprocessing_manager.Lock())

983

self.client_structure = [attr

984

for attr in self.__dict__.keys()

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

985

559

if not attr.startswith("_")]

986

560

self.client_structure.append("client_structure")

987

988

for name, t in inspect.getmembers(

989

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

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

990

566

if not name.startswith("_"):

991

567

self.client_structure.append(name)

992

568

993

569

# Send notice to process children that client state has changed

994

570

def send_changedstate(self):

995

571

with self.changedstate:

996

572

self.changedstate.notify_all()

997

573

998

574

def enable(self):

999

575

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

1000

576

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

1005

581

self.last_enabled = datetime.datetime.utcnow()

1006

582

self.init_checker()

1007

583

self.send_changedstate()

1008

584

1009

585

def disable(self, quiet=True):

1010

586

"""Disable this client."""

1011

587

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

1013

589

if not quiet:

1014

590

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

1015

591

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

1016

GLib.source_remove(self.disable_initiator_tag)

592

gobject.source_remove(self.disable_initiator_tag)

1017

593

self.disable_initiator_tag = None

1018

594

self.expires = None

1019

595

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

1020

GLib.source_remove(self.checker_initiator_tag)

596

gobject.source_remove(self.checker_initiator_tag)

1021

597

self.checker_initiator_tag = None

1022

598

self.stop_checker()

1023

599

self.enabled = False

1024

600

if not quiet:

1025

601

self.send_changedstate()

1026

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

602

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

1027

603

return False

1028

604

1029

605

def __del__(self):

1030

606

self.disable()

1031

607

1032

608

def init_checker(self):

1033

609

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

1034

610

# and every interval from then on.

1035

611

if self.checker_initiator_tag is not None:

1036

GLib.source_remove(self.checker_initiator_tag)

1037

self.checker_initiator_tag = GLib.timeout_add(

1038

int(self.interval.total_seconds() * 1000),

1039

self.start_checker)

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

1040

616

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

1041

617

if self.disable_initiator_tag is not None:

1042

GLib.source_remove(self.disable_initiator_tag)

1043

self.disable_initiator_tag = GLib.timeout_add(

1044

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

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

1045

622

# Also start a new checker *right now*.

1046

623

self.start_checker()

1047

1048

def checker_callback(self, source, condition, connection,

1049

command):

624

625

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

1050

626

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

1051

# Read return code from connection (see call_pipe)

1052

returncode = connection.recv()

1053

connection.close()

1054

if self.checker is not None:

1055

self.checker.join()

1056

627

self.checker_callback_tag = None

1057

628

self.checker = None

1058

1059

if returncode >= 0:

1060

self.last_checker_status = returncode

1061

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1062

631

if self.last_checker_status == 0:

1063

632

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

1064

633

vars(self))

1065

634

self.checked_ok()

1066

635

else:

1067

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

636

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

637

vars(self))

1068

638

else:

1069

639

self.last_checker_status = -1

1070

self.last_checker_signal = -returncode

1071

640

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

1072

641

vars(self))

1073

return False

1074

642

1075

643

def checked_ok(self):

1076

644

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

1077

645

self.last_checked_ok = datetime.datetime.utcnow()

1078

646

self.last_checker_status = 0

1079

self.last_checker_signal = None

1080

647

self.bump_timeout()

1081

648

1082

649

def bump_timeout(self, timeout=None):

1083

650

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

1084

651

if timeout is None:

1085

652

timeout = self.timeout

1086

653

if self.disable_initiator_tag is not None:

1087

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1088

655

self.disable_initiator_tag = None

1089

656

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

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1092

660

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

1093

661

1094

662

def need_approval(self):

1095

663

self.last_approval_request = datetime.datetime.utcnow()

1096

664

1097

665

def start_checker(self):

1098

666

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

1099

667

1100

668

If a checker already exists, leave it running and do

1101

669

nothing."""

1102

670

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

1107

675

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

1108

676

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

1109

677

# should be.

1110

1111

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

1112

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

1113

self.checker.join()

1114

self.checker = None

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

1115

692

# Start a new checker if needed

1116

693

if self.checker is None:

1117

694

# Escape attributes for the shell

1118

escaped_attrs = {

1119

attr: re.escape(str(getattr(self, attr)))

1120

for attr in self.runtime_expansions}

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1121

699

try:

1122

700

command = self.checker_command % escaped_attrs

1123

701

except TypeError as error:

1124

702

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

1125

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

1126

718

exc_info=error)

1127

return True # Try again later

1128

self.current_checker_command = command

1129

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

1130

self.name)

1131

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

1132

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

1133

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

1134

# always replaced by /dev/null.)

1135

# The exception is when not debugging but nevertheless

1136

# running in the foreground; use the previously

1137

# created wnull.

1138

popen_args = {"close_fds": True,

1139

"shell": True,

1140

"cwd": "/"}

1141

if (not self.server_settings["debug"]

1142

and self.server_settings["foreground"]):

1143

popen_args.update({"stdout": wnull,

1144

"stderr": wnull})

1145

pipe = multiprocessing.Pipe(duplex=False)

1146

self.checker = multiprocessing.Process(

1147

target=call_pipe,

1148

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

1149

kwargs=popen_args)

1150

self.checker.start()

1151

self.checker_callback_tag = GLib.io_add_watch(

1152

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

1153

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1154

self.checker_callback, pipe[0], command)

1155

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

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

1156

730

return True

1157

731

1158

732

def stop_checker(self):

1159

733

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

1160

734

if self.checker_callback_tag:

1161

GLib.source_remove(self.checker_callback_tag)

735

gobject.source_remove(self.checker_callback_tag)

1162

736

self.checker_callback_tag = None

1163

737

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

1164

738

return

1165

739

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

1166

self.checker.terminate()

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1167

748

self.checker = None

1168

749

1169

750

1170

def dbus_service_property(dbus_interface,

1171

signature="v",

1172

access="readwrite",

1173

byte_arrays=False):

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1174

753

"""Decorators for marking methods of a DBusObjectWithProperties to

1175

754

become properties on the D-Bus.

1176

755

1177

756

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

1178

757

and with one argument by "Set".

1179

758

1180

759

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

1181

760

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

1182

761

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

1185

764

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

1186

765

if byte_arrays and signature != "ay":

1187

766

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

1188

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

1189

767

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

1190

768

def decorator(func):

1191

769

func._dbus_is_property = True

1192

770

func._dbus_interface = dbus_interface

1195

773

func._dbus_name = func.__name__

1196

774

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

1197

775

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

1198

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1199

777

return func

1200

1201

778

return decorator

1202

779

1203

780

1204

781

def dbus_interface_annotations(dbus_interface):

1205

782

"""Decorator for marking functions returning interface annotations

1206

783

1207

784

Usage:

1208

785

1209

786

@dbus_interface_annotations("org.example.Interface")

1210

787

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

1211

788

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

1212

789

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

1213

790

"false"}

1214

791

"""

1215

1216

792

def decorator(func):

1217

793

func._dbus_is_interface = True

1218

794

func._dbus_interface = dbus_interface

1219

795

func._dbus_name = dbus_interface

1220

796

return func

1221

1222

797

return decorator

1223

798

1224

799

1225

800

def dbus_annotations(annotations):

1226

801

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

1227

802

Usage:

1228

1229

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

1230

"org.freedesktop.DBus.Property."

1231

"EmitsChangedSignal": "false"})

803

1232

804

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

1233

805

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

1234

809

def Property_dbus_property(self):

1235

810

return dbus.Boolean(False)

1236

1237

See also the DBusObjectWithAnnotations class.

1238

811

"""

1239

1240

812

def decorator(func):

1241

813

func._dbus_annotations = annotations

1242

814

return func

1243

1244

815

return decorator

1245

816

1246

817

1247

818

class DBusPropertyException(dbus.exceptions.DBusException):

1248

819

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

1249

820

"""

1250

pass

821

def __unicode__(self):

822

return unicode(str(self))

1251

823

1252

824

1253

825

class DBusPropertyAccessException(DBusPropertyException):

1262

834

pass

1263

835

1264

836

1265

class DBusObjectWithAnnotations(dbus.service.Object):

1266

"""A D-Bus object with annotations.

1267

1268

Classes inheriting from this can use the dbus_annotations

1269

decorator to add annotations to methods or signals.

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

1270

843

"""

1271

844

1272

845

@staticmethod

1273

846

def _is_dbus_thing(thing):

1274

847

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

1275

848

1276

849

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

1277

850

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

1278

851

"""

1279

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

852

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

1280

853

False)

1281

854

1282

855

def _get_all_dbus_things(self, thing):

1283

856

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

1284

857

"""

1285

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

858

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

859

name),

1286

860

athing.__get__(self))

1287

861

for cls in self.__class__.__mro__

1288

862

for name, athing in

1289

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

1290

1291

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1292

out_signature="s",

1293

path_keyword='object_path',

1294

connection_keyword='connection')

1295

def Introspect(self, object_path, connection):

1296

"""Overloading of standard D-Bus method.

1297

1298

Inserts annotation tags on methods and signals.

1299

"""

1300

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

1301

connection)

1302

try:

1303

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

1304

1305

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

1306

# Add annotation tags

1307

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

1308

for tag in if_tag.getElementsByTagName(typ):

1309

annots = dict()

1310

for name, prop in (self.

1311

_get_all_dbus_things(typ)):

1312

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

1313

and prop._dbus_interface

1314

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

1315

annots.update(getattr(

1316

prop, "_dbus_annotations", {}))

1317

for name, value in annots.items():

1318

ann_tag = document.createElement(

1319

"annotation")

1320

ann_tag.setAttribute("name", name)

1321

ann_tag.setAttribute("value", value)

1322

tag.appendChild(ann_tag)

1323

# Add interface annotation tags

1324

for annotation, value in dict(

1325

itertools.chain.from_iterable(

1326

annotations().items()

1327

for name, annotations

1328

in self._get_all_dbus_things("interface")

1329

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

1330

)).items():

1331

ann_tag = document.createElement("annotation")

1332

ann_tag.setAttribute("name", annotation)

1333

ann_tag.setAttribute("value", value)

1334

if_tag.appendChild(ann_tag)

1335

# Fix argument name for the Introspect method itself

1336

if (if_tag.getAttribute("name")

1337

== dbus.INTROSPECTABLE_IFACE):

1338

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

1339

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

1340

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

1341

if (arg.getAttribute("direction")

1342

== "out"):

1343

arg.setAttribute("name",

1344

"xml_data")

1345

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

1346

document.unlink()

1347

except (AttributeError, xml.dom.DOMException,

1348

xml.parsers.expat.ExpatError) as error:

1349

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

1350

exc_info=error)

1351

return xmlstring

1352

1353

1354

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1355

"""A D-Bus object with properties.

1356

1357

Classes inheriting from this can use the dbus_service_property

1358

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

1359

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

1360

"""

1361

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1362

866

def _get_dbus_property(self, interface_name, property_name):

1363

867

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

1364

868

property with the specified name and interface.

1365

869

"""

1366

for cls in self.__class__.__mro__:

1367

for name, value in inspect.getmembers(

1368

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

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1369

874

if (value._dbus_name == property_name

1370

875

and value._dbus_interface == interface_name):

1371

876

return value.__get__(self)

1372

877

1373

878

# No such property

1374

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

1375

self.dbus_object_path, interface_name, property_name))

1376

1377

@classmethod

1378

def _get_all_interface_names(cls):

1379

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

1380

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

1381

"_dbus_interface", None)

1382

for x in (inspect.getmro(cls))

1383

for attr in dir(x))

1384

if name is not None)

1385

1386

@dbus.service.method(dbus.PROPERTIES_IFACE,

1387

in_signature="ss",

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

1388

884

out_signature="v")

1389

885

def Get(self, interface_name, property_name):

1390

886

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

1396

892

if not hasattr(value, "variant_level"):

1397

893

return value

1398

894

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

1399

895

1400

896

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

1401

897

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

1402

898

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

1408

904

# The byte_arrays option is not supported yet on

1409

905

# signatures other than "ay".

1410

906

if prop._dbus_signature != "ay":

1411

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

1412

"'ay' signature {!r}"

1413

.format(prop._dbus_signature))

1414

value = dbus.ByteArray(bytes(value))

907

raise ValueError

908

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

909

for byte in value))

1415

910

prop(value)

1416

1417

@dbus.service.method(dbus.PROPERTIES_IFACE,

1418

in_signature="s",

911

912

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

1419

913

out_signature="a{sv}")

1420

914

def GetAll(self, interface_name):

1421

915

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

1422

916

standard.

1423

917

1424

918

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

1425

919

"""

1426

920

properties = {}

1436

930

if not hasattr(value, "variant_level"):

1437

931

properties[name] = value

1438

932

continue

1439

properties[name] = type(value)(

1440

value, variant_level=value.variant_level + 1)

933

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

934

value.variant_level+1)

1441

935

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

1442

1443

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

1444

def PropertiesChanged(self, interface_name, changed_properties,

1445

invalidated_properties):

1446

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

1447

standard.

1448

"""

1449

pass

1450

936

1451

937

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1452

938

out_signature="s",

1453

939

path_keyword='object_path',

1454

940

connection_keyword='connection')

1455

941

def Introspect(self, object_path, connection):

1456

942

"""Overloading of standard D-Bus method.

1457

943

1458

944

Inserts property tags and interface annotation tags.

1459

945

"""

1460

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1461

object_path,

1462

connection)

946

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

947

connection)

1463

948

try:

1464

949

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

1465

1466

950

def make_tag(document, name, prop):

1467

951

e = document.createElement("property")

1468

952

e.setAttribute("name", name)

1469

953

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

1470

954

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

1471

955

return e

1472

1473

956

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

1474

957

# Add property tags

1475

958

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

1478

961

if prop._dbus_interface

1479

962

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

1480

963

if_tag.appendChild(tag)

1481

# Add annotation tags for properties

1482

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

1483

annots = dict()

1484

for name, prop in self._get_all_dbus_things(

1485

"property"):

1486

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

1487

and prop._dbus_interface

1488

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

1489

annots.update(getattr(

1490

prop, "_dbus_annotations", {}))

1491

for name, value in annots.items():

1492

ann_tag = document.createElement(

1493

"annotation")

1494

ann_tag.setAttribute("name", name)

1495

ann_tag.setAttribute("value", value)

1496

tag.appendChild(ann_tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

1497

995

# Add the names to the return values for the

1498

996

# "org.freedesktop.DBus.Properties" methods

1499

997

if (if_tag.getAttribute("name")

1518

1016

return xmlstring

1519

1017

1520

1018

1521

try:

1522

dbus.OBJECT_MANAGER_IFACE

1523

except AttributeError:

1524

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

1525

1526

1527

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1528

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

1529

1530

Classes inheriting from this exposes the standard

1531

GetManagedObjects call and the InterfacesAdded and

1532

InterfacesRemoved signals on the standard

1533

"org.freedesktop.DBus.ObjectManager" interface.

1534

1535

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

1536

manually.

1537

"""

1538

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def GetManagedObjects(self):

1541

"""This function must be overridden"""

1542

raise NotImplementedError()

1543

1544

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1545

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

1546

def InterfacesAdded(self, object_path, interfaces_and_properties):

1547

pass

1548

1549

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

1550

def InterfacesRemoved(self, object_path, interfaces):

1551

pass

1552

1553

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1554

out_signature="s",

1555

path_keyword='object_path',

1556

connection_keyword='connection')

1557

def Introspect(self, object_path, connection):

1558

"""Overloading of standard D-Bus method.

1559

1560

Override return argument name of GetManagedObjects to be

1561

"objpath_interfaces_and_properties"

1562

"""

1563

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1564

object_path,

1565

connection)

1566

try:

1567

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

1568

1569

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

1570

# Fix argument name for the GetManagedObjects method

1571

if (if_tag.getAttribute("name")

1572

== dbus.OBJECT_MANAGER_IFACE):

1573

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

1574

if (cn.getAttribute("name")

1575

== "GetManagedObjects"):

1576

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

1577

if (arg.getAttribute("direction")

1578

== "out"):

1579

arg.setAttribute(

1580

"name",

1581

"objpath_interfaces"

1582

"_and_properties")

1583

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

1584

document.unlink()

1585

except (AttributeError, xml.dom.DOMException,

1586

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

1019

def datetime_to_dbus(dt, variant_level=0):

1593

1020

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

1594

1021

if dt is None:

1595

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

1596

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

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1597

1025

1598

1026

1599

1027

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1601

1029

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

1602

1030

interface names according to the "alt_interface_names" mapping.

1603

1031

Usage:

1604

1032

1605

1033

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

1606

1034

"net.example.AlternateInterface"})

1607

1035

class SampleDBusObject(dbus.service.Object):

1608

1036

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

1609

1037

def SampleDBusMethod():

1610

1038

pass

1611

1039

1612

1040

The above "SampleDBusMethod" on "SampleDBusObject" will be

1613

1041

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

1614

1042

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

1615

1043

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

1616

1044

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

1617

1045

1618

1046

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

1619

1047

(from DBusObjectWithProperties) and interfaces (from the

1620

1048

dbus_interface_annotations decorator).

1621

1049

"""

1622

1623

1050

def wrapper(cls):

1624

1051

for orig_interface_name, alt_interface_name in (

1625

alt_interface_names.items()):

1052

alt_interface_names.iteritems()):

1626

1053

attr = {}

1627

1054

interface_names = set()

1628

1055

# Go though all attributes of the class

1630

1057

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

1631

1058

# with the wrong interface name

1632

1059

if (not hasattr(attribute, "_dbus_interface")

1633

or not attribute._dbus_interface.startswith(

1634

orig_interface_name)):

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1635

1062

continue

1636

1063

# Create an alternate D-Bus interface name based on

1637

1064

# the current name

1638

alt_interface = attribute._dbus_interface.replace(

1639

orig_interface_name, alt_interface_name)

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1640

1068

interface_names.add(alt_interface)

1641

1069

# Is this a D-Bus signal?

1642

1070

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

1643

# Extract the original non-method undecorated

1644

# function by black magic

1645

if sys.version_info.major == 2:

1646

nonmethod_func = (dict(

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1647

1074

zip(attribute.func_code.co_freevars,

1648

attribute.__closure__))

1649

["func"].cell_contents)

1650

else:

1651

nonmethod_func = (dict(

1652

zip(attribute.__code__.co_freevars,

1653

attribute.__closure__))

1654

["func"].cell_contents)

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1655

1077

# Create a new, but exactly alike, function

1656

1078

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

1657

1079

# with the alternate D-Bus interface name

1658

new_function = copy_function(nonmethod_func)

1659

new_function = (dbus.service.signal(

1660

alt_interface,

1661

attribute._dbus_signature)(new_function))

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1662

1089

# Copy annotations, if any

1663

1090

try:

1664

new_function._dbus_annotations = dict(

1665

attribute._dbus_annotations)

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1666

1093

except AttributeError:

1667

1094

pass

1668

1669

1095

# Define a creator of a function to call both the

1670

1096

# original and alternate functions, so both the

1671

1097

# original and alternate signals gets sent when

1674

1100

"""This function is a scope container to pass

1675

1101

func1 and func2 to the "call_both" function

1676

1102

outside of its arguments"""

1677

1678

@functools.wraps(func2)

1679

1103

def call_both(*args, **kwargs):

1680

1104

"""This function will emit two D-Bus

1681

1105

signals by calling func1 and func2"""

1682

1106

func1(*args, **kwargs)

1683

1107

func2(*args, **kwargs)

1684

# Make wrapper function look like a D-Bus

1685

# signal

1686

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

1687

if name.startswith("_dbus_"):

1688

setattr(call_both, name, attr)

1689

1690

1108

return call_both

1691

1109

# Create the "call_both" function and add it to

1692

1110

# the class

1697

1115

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

1698

1116

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

1699

1117

# to the class.

1700

attr[attrname] = (

1701

dbus.service.method(

1702

alt_interface,

1703

attribute._dbus_in_signature,

1704

attribute._dbus_out_signature)

1705

(copy_function(attribute)))

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1706

1128

# Copy annotations, if any

1707

1129

try:

1708

attr[attrname]._dbus_annotations = dict(

1709

attribute._dbus_annotations)

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1710

1132

except AttributeError:

1711

1133

pass

1712

1134

# Is this a D-Bus property?

1715

1137

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

1716

1138

# property with the alternate D-Bus interface

1717

1139

# name. Add it to the class.

1718

attr[attrname] = (dbus_service_property(

1719

alt_interface, attribute._dbus_signature,

1720

attribute._dbus_access,

1721

attribute._dbus_get_args_options

1722

["byte_arrays"])

1723

(copy_function(attribute)))

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

1724

1153

# Copy annotations, if any

1725

1154

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1728

1157

except AttributeError:

1729

1158

pass

1730

1159

# Is this a D-Bus interface?

1733

1162

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

1734

1163

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

1735

1164

# to the class.

1736

attr[attrname] = (

1737

dbus_interface_annotations(alt_interface)

1738

(copy_function(attribute)))

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1739

1173

if deprecate:

1740

1174

# Deprecate all alternate interfaces

1741

iname = "_AlternateDBusNames_interface_annotation{}"

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1742

1176

for interface_name in interface_names:

1743

1744

1177

@dbus_interface_annotations(interface_name)

1745

1178

def func(self):

1746

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

1747

"true"}

1179

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

1180

"true" }

1748

1181

# Find an unused name

1749

1182

for aname in (iname.format(i)

1750

1183

for i in itertools.count()):

1754

1187

if interface_names:

1755

1188

# Replace the class with a new subclass of it with

1756

1189

# methods, signals, etc. as created above.

1757

if sys.version_info.major == 2:

1758

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

1759

(cls, ), attr)

1760

else:

1761

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

1762

(cls, ), attr)

1190

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

1191

(cls,), attr)

1763

1192

return cls

1764

1765

1193

return wrapper

1766

1194

1767

1195

1768

1196

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

1769

"se.bsnet.fukt.Mandos"})

1197

"se.bsnet.fukt.Mandos"})

1770

1198

class ClientDBus(Client, DBusObjectWithProperties):

1771

1199

"""A Client class using D-Bus

1772

1200

1773

1201

Attributes:

1774

1202

dbus_object_path: dbus.ObjectPath

1775

1203

bus: dbus.SystemBus()

1776

1204

"""

1777

1205

1778

1206

runtime_expansions = (Client.runtime_expansions

1779

+ ("dbus_object_path", ))

1780

1781

_interface = "se.recompile.Mandos.Client"

1782

1207

+ ("dbus_object_path",))

1208

1783

1209

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

1784

1785

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

1210

1211

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

1786

1212

self.bus = bus

1787

1213

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

1788

1214

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

1789

1215

# the D-Bus

1790

client_object_name = str(self.name).translate(

1216

client_object_name = unicode(self.name).translate(

1791

1217

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

1792

1218

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

1793

self.dbus_object_path = dbus.ObjectPath(

1794

"/clients/" + client_object_name)

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1795

1221

DBusObjectWithProperties.__init__(self, self.bus,

1796

1222

self.dbus_object_path)

1797

1798

def notifychangeproperty(transform_func, dbus_name,

1799

type_func=lambda x: x,

1800

variant_level=1,

1801

invalidate_only=False,

1802

_interface=_interface):

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1803

1227

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

1804

1228

its changes to DBus.

1805

1229

1806

1230

transform_fun: Function that takes a value and a variant_level

1807

1231

and transforms it to a D-Bus type.

1808

1232

dbus_name: D-Bus name of the variable

1810

1234

to the D-Bus. Default: no transform

1811

1235

variant_level: D-Bus variant level. Default: 1

1812

1236

"""

1813

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

1814

1237

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

1815

1238

def setter(self, value):

1816

1239

if hasattr(self, "dbus_object_path"):

1817

1240

if (not hasattr(self, attrname) or

1818

1241

type_func(getattr(self, attrname, None))

1819

1242

!= type_func(value)):

1820

if invalidate_only:

1821

self.PropertiesChanged(

1822

_interface, dbus.Dictionary(),

1823

dbus.Array((dbus_name, )))

1824

else:

1825

dbus_value = transform_func(

1826

type_func(value),

1827

variant_level=variant_level)

1828

self.PropertyChanged(dbus.String(dbus_name),

1829

dbus_value)

1830

self.PropertiesChanged(

1831

_interface,

1832

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

1833

dbus_value}),

1834

dbus.Array())

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_value)

1835

1248

setattr(self, attrname, value)

1836

1249

1837

1250

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

1838

1251

1839

1252

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1840

1253

approvals_pending = notifychangeproperty(dbus.Boolean,

1841

1254

"ApprovalPending",

1842

type_func=bool)

1255

type_func = bool)

1843

1256

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

1844

1257

last_enabled = notifychangeproperty(datetime_to_dbus,

1845

1258

"LastEnabled")

1846

checker = notifychangeproperty(

1847

dbus.Boolean, "CheckerRunning",

1848

type_func=lambda checker: checker is not None)

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1849

1262

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1850

1263

"LastCheckedOK")

1851

1264

last_checker_status = notifychangeproperty(dbus.Int16,

1854

1267

datetime_to_dbus, "LastApprovalRequest")

1855

1268

approved_by_default = notifychangeproperty(dbus.Boolean,

1856

1269

"ApprovedByDefault")

1857

approval_delay = notifychangeproperty(

1858

dbus.UInt64, "ApprovalDelay",

1859

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

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1860

1274

approval_duration = notifychangeproperty(

1861

1275

dbus.UInt64, "ApprovalDuration",

1862

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

1276

type_func = timedelta_to_milliseconds)

1863

1277

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

1864

timeout = notifychangeproperty(

1865

dbus.UInt64, "Timeout",

1866

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1867

1281

extended_timeout = notifychangeproperty(

1868

1282

dbus.UInt64, "ExtendedTimeout",

1869

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

1870

interval = notifychangeproperty(

1871

dbus.UInt64, "Interval",

1872

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

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1873

1288

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

1874

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

1875

invalidate_only=True)

1876

1289

1877

1290

del notifychangeproperty

1878

1291

1879

1292

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

1880

1293

try:

1881

1294

self.remove_from_connection()

1884

1297

if hasattr(DBusObjectWithProperties, "__del__"):

1885

1298

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

1886

1299

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

1887

1888

def checker_callback(self, source, condition,

1889

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

1890

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

1891

connection, command, *args,

1892

**kwargs)

1893

exitstatus = self.last_checker_status

1894

if exitstatus >= 0:

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

1895

1307

# Emit D-Bus signal

1896

1308

self.CheckerCompleted(dbus.Int16(exitstatus),

1897

# This is specific to GNU libC

1898

dbus.Int64(exitstatus << 8),

1309

dbus.Int64(condition),

1899

1310

dbus.String(command))

1900

1311

else:

1901

1312

# Emit D-Bus signal

1902

1313

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

1903

dbus.Int64(

1904

# This is specific to GNU libC

1905

(exitstatus << 8)

1906

| self.last_checker_signal),

1314

dbus.Int64(condition),

1907

1315

dbus.String(command))

1908

return ret

1909

1316

1317

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

1318

*args, **kwargs)

1319

1910

1320

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

1911

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1912

1326

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

1913

1327

# Only if new checker process was started

1914

1328

if (self.checker is not None

1916

1330

# Emit D-Bus signal

1917

1331

self.CheckerStarted(self.current_checker_command)

1918

1332

return r

1919

1333

1920

1334

def _reset_approved(self):

1921

1335

self.approved = None

1922

1336

return False

1923

1337

1924

1338

def approve(self, value=True):

1925

1339

self.approved = value

1926

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

1927

* 1000), self._reset_approved)

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1928

1343

self.send_changedstate()

1929

1930

# D-Bus methods, signals & properties

1931

1932

# Interfaces

1933

1934

# Signals

1935

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

1936

1357

# CheckerCompleted - signal

1937

1358

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

1938

1359

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

1939

1360

"D-Bus signal"

1940

1361

pass

1941

1362

1942

1363

# CheckerStarted - signal

1943

1364

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

1944

1365

def CheckerStarted(self, command):

1945

1366

"D-Bus signal"

1946

1367

pass

1947

1368

1948

1369

# PropertyChanged - signal

1949

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

1950

1370

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

1951

1371

def PropertyChanged(self, property, value):

1952

1372

"D-Bus signal"

1953

1373

pass

1954

1374

1955

1375

# GotSecret - signal

1956

1376

@dbus.service.signal(_interface)

1957

1377

def GotSecret(self):

1960

1380

server to mandos-client

1961

1381

"""

1962

1382

pass

1963

1383

1964

1384

# Rejected - signal

1965

1385

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

1966

1386

def Rejected(self, reason):

1967

1387

"D-Bus signal"

1968

1388

pass

1969

1389

1970

1390

# NeedApproval - signal

1971

1391

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

1972

1392

def NeedApproval(self, timeout, default):

1973

1393

"D-Bus signal"

1974

1394

return self.need_approval()

1975

1976

# Methods

1977

1395

1396

## Methods

1397

1978

1398

# Approve - method

1979

1399

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

1980

1400

def Approve(self, value):

1981

1401

self.approve(value)

1982

1402

1983

1403

# CheckedOK - method

1984

1404

@dbus.service.method(_interface)

1985

1405

def CheckedOK(self):

1986

1406

self.checked_ok()

1987

1407

1988

1408

# Enable - method

1989

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

1990

1409

@dbus.service.method(_interface)

1991

1410

def Enable(self):

1992

1411

"D-Bus method"

1993

1412

self.enable()

1994

1413

1995

1414

# StartChecker - method

1996

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

1997

1415

@dbus.service.method(_interface)

1998

1416

def StartChecker(self):

1999

1417

"D-Bus method"

2000

1418

self.start_checker()

2001

1419

2002

1420

# Disable - method

2003

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

2004

1421

@dbus.service.method(_interface)

2005

1422

def Disable(self):

2006

1423

"D-Bus method"

2007

1424

self.disable()

2008

1425

2009

1426

# StopChecker - method

2010

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

2011

1427

@dbus.service.method(_interface)

2012

1428

def StopChecker(self):

2013

1429

self.stop_checker()

2014

2015

# Properties

2016

1430

1431

## Properties

1432

2017

1433

# ApprovalPending - property

2018

1434

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

2019

1435

def ApprovalPending_dbus_property(self):

2020

1436

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

2021

1437

2022

1438

# ApprovedByDefault - property

2023

@dbus_service_property(_interface,

2024

signature="b",

1439

@dbus_service_property(_interface, signature="b",

2025

1440

access="readwrite")

2026

1441

def ApprovedByDefault_dbus_property(self, value=None):

2027

1442

if value is None: # get

2028

1443

return dbus.Boolean(self.approved_by_default)

2029

1444

self.approved_by_default = bool(value)

2030

1445

2031

1446

# ApprovalDelay - property

2032

@dbus_service_property(_interface,

2033

signature="t",

1447

@dbus_service_property(_interface, signature="t",

2034

1448

access="readwrite")

2035

1449

def ApprovalDelay_dbus_property(self, value=None):

2036

1450

if value is None: # get

2037

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

2038

* 1000)

1451

return dbus.UInt64(self.approval_delay_milliseconds())

2039

1452

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

2040

1453

2041

1454

# ApprovalDuration - property

2042

@dbus_service_property(_interface,

2043

signature="t",

1455

@dbus_service_property(_interface, signature="t",

2044

1456

access="readwrite")

2045

1457

def ApprovalDuration_dbus_property(self, value=None):

2046

1458

if value is None: # get

2047

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

2048

* 1000)

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

2049

1461

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

2050

1462

2051

1463

# Name - property

2052

@dbus_annotations(

2053

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

2054

1464

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

2055

1465

def Name_dbus_property(self):

2056

1466

return dbus.String(self.name)

2057

2058

# KeyID - property

2059

@dbus_annotations(

2060

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

2061

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

2062

def KeyID_dbus_property(self):

2063

return dbus.String(self.key_id)

2064

1467

2065

1468

# Fingerprint - property

2066

@dbus_annotations(

2067

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

2068

1469

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

2069

1470

def Fingerprint_dbus_property(self):

2070

1471

return dbus.String(self.fingerprint)

2071

1472

2072

1473

# Host - property

2073

@dbus_service_property(_interface,

2074

signature="s",

1474

@dbus_service_property(_interface, signature="s",

2075

1475

access="readwrite")

2076

1476

def Host_dbus_property(self, value=None):

2077

1477

if value is None: # get

2078

1478

return dbus.String(self.host)

2079

self.host = str(value)

2080

1479

self.host = unicode(value)

1480

2081

1481

# Created - property

2082

@dbus_annotations(

2083

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

2084

1482

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

2085

1483

def Created_dbus_property(self):

2086

1484

return datetime_to_dbus(self.created)

2087

1485

2088

1486

# LastEnabled - property

2089

1487

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

2090

1488

def LastEnabled_dbus_property(self):

2091

1489

return datetime_to_dbus(self.last_enabled)

2092

1490

2093

1491

# Enabled - property

2094

@dbus_service_property(_interface,

2095

signature="b",

1492

@dbus_service_property(_interface, signature="b",

2096

1493

access="readwrite")

2097

1494

def Enabled_dbus_property(self, value=None):

2098

1495

if value is None: # get

2101

1498

self.enable()

2102

1499

else:

2103

1500

self.disable()

2104

1501

2105

1502

# LastCheckedOK - property

2106

@dbus_service_property(_interface,

2107

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2108

1504

access="readwrite")

2109

1505

def LastCheckedOK_dbus_property(self, value=None):

2110

1506

if value is not None:

2111

1507

self.checked_ok()

2112

1508

return

2113

1509

return datetime_to_dbus(self.last_checked_ok)

2114

1510

2115

1511

# LastCheckerStatus - property

2116

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

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2117

1514

def LastCheckerStatus_dbus_property(self):

2118

1515

return dbus.Int16(self.last_checker_status)

2119

1516

2120

1517

# Expires - property

2121

1518

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

2122

1519

def Expires_dbus_property(self):

2123

1520

return datetime_to_dbus(self.expires)

2124

1521

2125

1522

# LastApprovalRequest - property

2126

1523

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

2127

1524

def LastApprovalRequest_dbus_property(self):

2128

1525

return datetime_to_dbus(self.last_approval_request)

2129

1526

2130

1527

# Timeout - property

2131

@dbus_service_property(_interface,

2132

signature="t",

1528

@dbus_service_property(_interface, signature="t",

2133

1529

access="readwrite")

2134

1530

def Timeout_dbus_property(self, value=None):

2135

1531

if value is None: # get

2136

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

1532

return dbus.UInt64(self.timeout_milliseconds())

2137

1533

old_timeout = self.timeout

2138

1534

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

2139

1535

# Reschedule disabling

2147

1543

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

2148

1544

is None):

2149

1545

return

2150

GLib.source_remove(self.disable_initiator_tag)

2151

self.disable_initiator_tag = GLib.timeout_add(

2152

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

2153

self.disable)

2154

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

2155

1552

# ExtendedTimeout - property

2156

@dbus_service_property(_interface,

2157

signature="t",

1553

@dbus_service_property(_interface, signature="t",

2158

1554

access="readwrite")

2159

1555

def ExtendedTimeout_dbus_property(self, value=None):

2160

1556

if value is None: # get

2161

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

2162

* 1000)

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2163

1558

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

2164

1559

2165

1560

# Interval - property

2166

@dbus_service_property(_interface,

2167

signature="t",

1561

@dbus_service_property(_interface, signature="t",

2168

1562

access="readwrite")

2169

1563

def Interval_dbus_property(self, value=None):

2170

1564

if value is None: # get

2171

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

1565

return dbus.UInt64(self.interval_milliseconds())

2172

1566

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

2173

1567

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

2174

1568

return

2175

1569

if self.enabled:

2176

1570

# Reschedule checker run

2177

GLib.source_remove(self.checker_initiator_tag)

2178

self.checker_initiator_tag = GLib.timeout_add(

2179

value, self.start_checker)

2180

self.start_checker() # Start one now, too

2181

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

2182

1576

# Checker - property

2183

@dbus_service_property(_interface,

2184

signature="s",

1577

@dbus_service_property(_interface, signature="s",

2185

1578

access="readwrite")

2186

1579

def Checker_dbus_property(self, value=None):

2187

1580

if value is None: # get

2188

1581

return dbus.String(self.checker_command)

2189

self.checker_command = str(value)

2190

1582

self.checker_command = unicode(value)

1583

2191

1584

# CheckerRunning - property

2192

@dbus_service_property(_interface,

2193

signature="b",

1585

@dbus_service_property(_interface, signature="b",

2194

1586

access="readwrite")

2195

1587

def CheckerRunning_dbus_property(self, value=None):

2196

1588

if value is None: # get

2199

1591

self.start_checker()

2200

1592

else:

2201

1593

self.stop_checker()

2202

1594

2203

1595

# ObjectPath - property

2204

@dbus_annotations(

2205

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

2206

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

2207

1596

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

2208

1597

def ObjectPath_dbus_property(self):

2209

return self.dbus_object_path # is already a dbus.ObjectPath

2210

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2211

1600

# Secret = property

2212

@dbus_annotations(

2213

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

2214

"invalidates"})

2215

@dbus_service_property(_interface,

2216

signature="ay",

2217

access="write",

2218

byte_arrays=True)

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2219

1603

def Secret_dbus_property(self, value):

2220

self.secret = bytes(value)

2221

1604

self.secret = str(value)

1605

2222

1606

del _interface

2223

1607

2224

1608

2225

class ProxyClient:

2226

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

1609

class ProxyClient(object):

1610

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

2227

1611

self._pipe = child_pipe

2228

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

1612

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

2229

1613

if not self._pipe.recv():

2230

raise KeyError(key_id or fpr)

2231

1614

raise KeyError()

1615

2232

1616

def __getattribute__(self, name):

2233

1617

if name == '_pipe':

2234

1618

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

2237

1621

if data[0] == 'data':

2238

1622

return data[1]

2239

1623

if data[0] == 'function':

2240

2241

1624

def func(*args, **kwargs):

2242

1625

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

2243

1626

return self._pipe.recv()[1]

2244

2245

1627

return func

2246

1628

2247

1629

def __setattr__(self, name, value):

2248

1630

if name == '_pipe':

2249

1631

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

2252

1634

2253

1635

class ClientHandler(socketserver.BaseRequestHandler, object):

2254

1636

"""A class to handle client connections.

2255

1637

2256

1638

Instantiated once for each connection to handle it.

2257

1639

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

2258

1640

2259

1641

def handle(self):

2260

1642

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

2261

1643

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

2262

str(self.client_address))

1644

unicode(self.client_address))

2263

1645

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

2264

1646

self.server.child_pipe.fileno())

2265

2266

session = gnutls.ClientSession(self.request)

2267

2268

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

2269

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

2270

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

2271

# "+DHE-DSS"))

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

2272

1662

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

2273

1663

priority = self.server.gnutls_priority

2274

1664

if priority is None:

2275

1665

priority = "NORMAL"

2276

gnutls.priority_set_direct(session._c_object,

2277

priority.encode("utf-8"),

2278

None)

2279

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2280

1670

# Start communication using the Mandos protocol

2281

1671

# Get protocol number

2282

1672

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

2283

1673

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

2284

1674

try:

2285

1675

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

2286

raise RuntimeError(line)

1676

raise RuntimeError

2287

1677

except (ValueError, IndexError, RuntimeError) as error:

2288

1678

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

2289

1679

return

2290

1680

2291

1681

# Start GnuTLS connection

2292

1682

try:

2293

1683

session.handshake()

2294

except gnutls.Error as error:

1684

except gnutls.errors.GNUTLSError as error:

2295

1685

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

2296

1686

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

2297

1687

# established. Just abandon the request.

2298

1688

return

2299

1689

logger.debug("Handshake succeeded")

2300

1690

2301

1691

approval_required = False

2302

1692

try:

2303

if gnutls.has_rawpk:

2304

fpr = b""

2305

try:

2306

key_id = self.key_id(

2307

self.peer_certificate(session))

2308

except (TypeError, gnutls.Error) as error:

2309

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

2310

return

2311

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

2312

2313

else:

2314

key_id = b""

2315

try:

2316

fpr = self.fingerprint(

2317

self.peer_certificate(session))

2318

except (TypeError, gnutls.Error) as error:

2319

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

2320

return

2321

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

2322

2323

try:

2324

client = ProxyClient(child_pipe, key_id, fpr,

1693

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

1698

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

1699

return

1700

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

1701

1702

try:

1703

client = ProxyClient(child_pipe, fpr,

2325

1704

self.client_address)

2326

1705

except KeyError:

2327

1706

return

2328

1707

2329

1708

if client.approval_delay:

2330

1709

delay = client.approval_delay

2331

1710

client.approvals_pending += 1

2332

1711

approval_required = True

2333

1712

2334

1713

while True:

2335

1714

if not client.enabled:

2336

1715

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

2337

client.name)

1716

client.name)

2338

1717

if self.server.use_dbus:

2339

1718

# Emit D-Bus signal

2340

1719

client.Rejected("Disabled")

2341

1720

return

2342

1721

2343

1722

if client.approved or not client.approval_delay:

2344

# We are approved or approval is disabled

1723

#We are approved or approval is disabled

2345

1724

break

2346

1725

elif client.approved is None:

2347

1726

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

2349

1728

if self.server.use_dbus:

2350

1729

# Emit D-Bus signal

2351

1730

client.NeedApproval(

2352

client.approval_delay.total_seconds()

2353

* 1000, client.approved_by_default)

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2354

1733

else:

2355

1734

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

2356

1735

client.name)

2358

1737

# Emit D-Bus signal

2359

1738

client.Rejected("Denied")

2360

1739

return

2361

2362

# wait until timeout or approved

1740

1741

#wait until timeout or approved

2363

1742

time = datetime.datetime.now()

2364

1743

client.changedstate.acquire()

2365

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

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2366

1747

client.changedstate.release()

2367

1748

time2 = datetime.datetime.now()

2368

1749

if (time2 - time) >= delay:

2378

1759

break

2379

1760

else:

2380

1761

delay -= time2 - time

2381

2382

try:

2383

session.send(client.secret)

2384

except gnutls.Error as error:

2385

logger.warning("gnutls send failed",

2386

exc_info=error)

2387

return

2388

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

2389

1776

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

2390

1777

# bump the timeout using extended_timeout

2391

1778

client.bump_timeout(client.extended_timeout)

2392

1779

if self.server.use_dbus:

2393

1780

# Emit D-Bus signal

2394

1781

client.GotSecret()

2395

1782

2396

1783

finally:

2397

1784

if approval_required:

2398

1785

client.approvals_pending -= 1

2399

1786

try:

2400

1787

session.bye()

2401

except gnutls.Error as error:

1788

except gnutls.errors.GNUTLSError as error:

2402

1789

logger.warning("GnuTLS bye failed",

2403

1790

exc_info=error)

2404

1791

2405

1792

@staticmethod

2406

1793

def peer_certificate(session):

2407

"Return the peer's certificate as a bytestring"

2408

try:

2409

cert_type = gnutls.certificate_type_get2(session._c_object,

2410

gnutls.CTYPE_PEERS)

2411

except AttributeError:

2412

cert_type = gnutls.certificate_type_get(session._c_object)

2413

if gnutls.has_rawpk:

2414

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2415

else:

2416

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2417

# If not a valid certificate type...

2418

if cert_type not in valid_cert_types:

2419

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

2420

valid_cert_types)

2421

# ...return invalid data

2422

return b""

1794

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

1795

# If not an OpenPGP certificate...

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

2423

1801

list_size = ctypes.c_uint(1)

2424

cert_list = (gnutls.certificate_get_peers

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2425

1804

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

2426

1805

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

2427

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

1806

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

1807

" certificate")

2428

1808

if list_size.value == 0:

2429

1809

return None

2430

1810

cert = cert_list[0]

2431

1811

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

2432

2433

@staticmethod

2434

def key_id(certificate):

2435

"Convert a certificate bytestring to a hexdigit key ID"

2436

# New GnuTLS "datum" with the public key

2437

datum = gnutls.datum_t(

2438

ctypes.cast(ctypes.c_char_p(certificate),

2439

ctypes.POINTER(ctypes.c_ubyte)),

2440

ctypes.c_uint(len(certificate)))

2441

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

2442

# New empty GnuTLS certificate

2443

pubkey = gnutls.pubkey_t()

2444

gnutls.pubkey_init(ctypes.byref(pubkey))

2445

# Import the raw public key into the certificate

2446

gnutls.pubkey_import(pubkey,

2447

ctypes.byref(datum),

2448

gnutls.X509_FMT_DER)

2449

# New buffer for the key ID

2450

buf = ctypes.create_string_buffer(32)

2451

buf_len = ctypes.c_size_t(len(buf))

2452

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

2453

gnutls.pubkey_get_key_id(pubkey,

2454

gnutls.KEYID_USE_SHA256,

2455

ctypes.cast(ctypes.byref(buf),

2456

ctypes.POINTER(ctypes.c_ubyte)),

2457

ctypes.byref(buf_len))

2458

# Deinit the certificate

2459

gnutls.pubkey_deinit(pubkey)

2460

2461

# Convert the buffer to a Python bytestring

2462

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

2463

# Convert the bytestring to hexadecimal notation

2464

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

2465

return hex_key_id

2466

1812

2467

1813

@staticmethod

2468

1814

def fingerprint(openpgp):

2469

1815

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2470

1816

# New GnuTLS "datum" with the OpenPGP public key

2471

datum = gnutls.datum_t(

2472

ctypes.cast(ctypes.c_char_p(openpgp),

2473

ctypes.POINTER(ctypes.c_ubyte)),

2474

ctypes.c_uint(len(openpgp)))

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

2475

1822

# New empty GnuTLS certificate

2476

crt = gnutls.openpgp_crt_t()

2477

gnutls.openpgp_crt_init(ctypes.byref(crt))

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

1826

# Import the OpenPGP public key into the certificate

2479

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

2480

gnutls.OPENPGP_FMT_RAW)

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2481

1831

# Verify the self signature in the key

2482

1832

crtverify = ctypes.c_uint()

2483

gnutls.openpgp_crt_verify_self(crt, 0,

2484

ctypes.byref(crtverify))

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2485

1836

if crtverify.value != 0:

2486

gnutls.openpgp_crt_deinit(crt)

2487

raise gnutls.CertificateSecurityError(code

2488

=crtverify.value)

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2489

1840

# New buffer for the fingerprint

2490

1841

buf = ctypes.create_string_buffer(20)

2491

1842

buf_len = ctypes.c_size_t()

2492

1843

# Get the fingerprint from the certificate into the buffer

2493

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

2494

ctypes.byref(buf_len))

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2495

1847

# Deinit the certificate

2496

gnutls.openpgp_crt_deinit(crt)

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2497

1849

# Convert the buffer to a Python bytestring

2498

1850

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

2499

1851

# Convert the bytestring to hexadecimal notation

2501

1853

return hex_fpr

2502

1854

2503

1855

2504

class MultiprocessingMixIn:

1856

class MultiprocessingMixIn(object):

2505

1857

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

2506

2507

1858

def sub_process_main(self, request, address):

2508

1859

try:

2509

1860

self.finish_request(request, address)

2510

1861

except Exception:

2511

1862

self.handle_error(request, address)

2512

1863

self.close_request(request)

2513

1864

2514

1865

def process_request(self, request, address):

2515

1866

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

2516

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

2517

args=(request, address))

1867

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

1868

args = (request, address))

2518

1869

proc.start()

2519

1870

return proc

2520

1871

2521

1872

2522

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2523

1874

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

2524

2525

1875

def process_request(self, request, client_address):

2526

1876

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

2527

1877

2528

1878

This function creates a new pipe in self.pipe

2529

1879

"""

2530

1880

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2531

1881

2532

1882

proc = MultiprocessingMixIn.process_request(self, request,

2533

1883

client_address)

2534

1884

self.child_pipe.close()

2535

1885

self.add_pipe(parent_pipe, proc)

2536

1886

2537

1887

def add_pipe(self, parent_pipe, proc):

2538

1888

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

2539

raise NotImplementedError()

1889

raise NotImplementedError

2540

1890

2541

1891

2542

1892

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2543

socketserver.TCPServer):

1893

socketserver.TCPServer, object):

2544

1894

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

2545

1895

2546

1896

Attributes:

2547

1897

enabled: Boolean; whether this server is activated yet

2548

1898

interface: None or a network interface name (string)

2549

1899

use_ipv6: Boolean; to use IPv6 or not

2550

1900

"""

2551

2552

1901

def __init__(self, server_address, RequestHandlerClass,

2553

interface=None,

2554

use_ipv6=True,

2555

socketfd=None):

1902

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

2556

1903

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

2557

1904

creating a new one with socket.socket().

2558

1905

"""

2564

1911

self.socketfd = socketfd

2565

1912

# Save the original socket.socket() function

2566

1913

self.socket_socket = socket.socket

2567

2568

1914

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

2569

#

1915

#

2570

1916

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

2571

1917

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

2572

1918

# patching socket.socket.)

2573

#

1919

#

2574

1920

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

2575

1921

@functools.wraps(socket.socket)

2576

1922

def socket_wrapper(*args, **kwargs):

2588

1934

# socket_wrapper(), if socketfd was set.

2589

1935

socketserver.TCPServer.__init__(self, server_address,

2590

1936

RequestHandlerClass)

2591

1937

2592

1938

def server_bind(self):

2593

1939

"""This overrides the normal server_bind() function

2594

1940

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

2595

1941

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

2596

global SO_BINDTODEVICE

2597

1942

if self.interface is not None:

2598

1943

if SO_BINDTODEVICE is None:

2599

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

2600

# common enough.

2601

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

2602

SO_BINDTODEVICE = 25

2603

try:

2604

self.socket.setsockopt(

2605

socket.SOL_SOCKET, SO_BINDTODEVICE,

2606

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

2607

except socket.error as error:

2608

if error.errno == errno.EPERM:

2609

logger.error("No permission to bind to"

2610

" interface %s", self.interface)

2611

elif error.errno == errno.ENOPROTOOPT:

2612

logger.error("SO_BINDTODEVICE not available;"

2613

" cannot bind to interface %s",

2614

self.interface)

2615

elif error.errno == errno.ENODEV:

2616

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

2617

" cannot bind", self.interface)

2618

else:

2619

raise

1944

logger.error("SO_BINDTODEVICE does not exist;"

1945

" cannot bind to interface %s",

1946

self.interface)

1947

else:

1948

try:

1949

self.socket.setsockopt(socket.SOL_SOCKET,

1950

SO_BINDTODEVICE,

1951

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

1952

except socket.error as error:

1953

if error.errno == errno.EPERM:

1954

logger.error("No permission to bind to"

1955

" interface %s", self.interface)

1956

elif error.errno == errno.ENOPROTOOPT:

1957

logger.error("SO_BINDTODEVICE not available;"

1958

" cannot bind to interface %s",

1959

self.interface)

1960

elif error.errno == errno.ENODEV:

1961

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

1962

" cannot bind", self.interface)

1963

else:

1964

raise

2620

1965

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

2621

1966

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

2622

if self.server_address[1]:

2623

self.allow_reuse_address = True

2624

1967

if not self.server_address[0]:

2625

1968

if self.address_family == socket.AF_INET6:

2626

any_address = "::" # in6addr_any

1969

any_address = "::" # in6addr_any

2627

1970

else:

2628

any_address = "0.0.0.0" # INADDR_ANY

1971

any_address = socket.INADDR_ANY

2629

1972

self.server_address = (any_address,

2630

1973

self.server_address[1])

2631

1974

elif not self.server_address[1]:

2632

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

1975

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

1976

0)

2633

1977

# if self.interface:

2634

1978

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

2635

1979

# 0, # port

2641

1985

2642

1986

class MandosServer(IPv6_TCPServer):

2643

1987

"""Mandos server.

2644

1988

2645

1989

Attributes:

2646

1990

clients: set of Client objects

2647

1991

gnutls_priority GnuTLS priority string

2648

1992

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

2649

2650

Assumes a GLib.MainLoop event loop.

1993

1994

Assumes a gobject.MainLoop event loop.

2651

1995

"""

2652

2653

1996

def __init__(self, server_address, RequestHandlerClass,

2654

interface=None,

2655

use_ipv6=True,

2656

clients=None,

2657

gnutls_priority=None,

2658

use_dbus=True,

2659

socketfd=None):

1997

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

1998

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

2660

1999

self.enabled = False

2661

2000

self.clients = clients

2662

2001

if self.clients is None:

2665

2004

self.gnutls_priority = gnutls_priority

2666

2005

IPv6_TCPServer.__init__(self, server_address,

2667

2006

RequestHandlerClass,

2668

interface=interface,

2669

use_ipv6=use_ipv6,

2670

socketfd=socketfd)

2671

2007

interface = interface,

2008

use_ipv6 = use_ipv6,

2009

socketfd = socketfd)

2672

2010

def server_activate(self):

2673

2011

if self.enabled:

2674

2012

return socketserver.TCPServer.server_activate(self)

2675

2013

2676

2014

def enable(self):

2677

2015

self.enabled = True

2678

2016

2679

2017

def add_pipe(self, parent_pipe, proc):

2680

2018

# Call "handle_ipc" for both data and EOF events

2681

GLib.io_add_watch(

2682

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

2683

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

2684

functools.partial(self.handle_ipc,

2685

parent_pipe=parent_pipe,

2686

proc=proc))

2687

2688

def handle_ipc(self, source, condition,

2689

parent_pipe=None,

2690

proc=None,

2691

client_object=None):

2019

gobject.io_add_watch(parent_pipe.fileno(),

2020

gobject.IO_IN | gobject.IO_HUP,

2021

functools.partial(self.handle_ipc,

2022

parent_pipe =

2023

parent_pipe,

2024

proc = proc))

2025

2026

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

2027

proc = None, client_object=None):

2692

2028

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

2693

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

2029

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

2694

2030

# Wait for other process to exit

2695

2031

proc.join()

2696

2032

return False

2697

2033

2698

2034

# Read a request from the child

2699

2035

request = parent_pipe.recv()

2700

2036

command = request[0]

2701

2037

2702

2038

if command == 'init':

2703

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

2704

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

2705

address = request[3]

2706

2707

for c in self.clients.values():

2708

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2709

continue

2710

if key_id and c.key_id == key_id:

2711

client = c

2712

break

2713

if fpr and c.fingerprint == fpr:

2039

fpr = request[1]

2040

address = request[2]

2041

2042

for c in self.clients.itervalues():

2043

if c.fingerprint == fpr:

2714

2044

client = c

2715

2045

break

2716

2046

else:

2717

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

2718

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

2047

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

2048

"dress: %s", fpr, address)

2719

2049

if self.use_dbus:

2720

2050

# Emit D-Bus signal

2721

mandos_dbus_service.ClientNotFound(key_id or fpr,

2051

mandos_dbus_service.ClientNotFound(fpr,

2722

2052

address[0])

2723

2053

parent_pipe.send(False)

2724

2054

return False

2725

2726

GLib.io_add_watch(

2727

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

2728

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

2729

functools.partial(self.handle_ipc,

2730

parent_pipe=parent_pipe,

2731

proc=proc,

2732

client_object=client))

2055

2056

gobject.io_add_watch(parent_pipe.fileno(),

2057

gobject.IO_IN | gobject.IO_HUP,

2058

functools.partial(self.handle_ipc,

2059

parent_pipe =

2060

parent_pipe,

2061

proc = proc,

2062

client_object =

2063

client))

2733

2064

parent_pipe.send(True)

2734

2065

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

2735

2066

# same fileno

2738

2069

funcname = request[1]

2739

2070

args = request[2]

2740

2071

kwargs = request[3]

2741

2072

2742

2073

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

2743

2074

funcname)(*args,

2744

**kwargs)))

2745

2075

**kwargs)))

2076

2746

2077

if command == 'getattr':

2747

2078

attrname = request[1]

2748

if isinstance(client_object.__getattribute__(attrname),

2749

collections.Callable):

2750

parent_pipe.send(('function', ))

2079

if callable(client_object.__getattribute__(attrname)):

2080

parent_pipe.send(('function',))

2751

2081

else:

2752

parent_pipe.send((

2753

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

2754

2082

parent_pipe.send(('data', client_object

2083

.__getattribute__(attrname)))

2084

2755

2085

if command == 'setattr':

2756

2086

attrname = request[1]

2757

2087

value = request[2]

2758

2088

setattr(client_object, attrname, value)

2759

2089

2760

2090

return True

2761

2091

2762

2092

2763

def rfc3339_duration_to_delta(duration):

2764

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

2765

2766

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

2767

True

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

"""

2781

2782

# Parsing an RFC 3339 duration with regular expressions is not

2783

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

2784

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

2785

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

2786

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

2787

# avoid excessive use of external libraries.

2788

2789

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

2790

Token = collections.namedtuple("Token", (

2791

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

2792

# a "group" containing digits

2793

"value", # datetime.timedelta or None

2794

"followers")) # Tokens valid after this token

2795

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

2796

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

2797

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

2798

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

2799

datetime.timedelta(seconds=1),

2800

frozenset((token_end, )))

2801

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

2802

datetime.timedelta(minutes=1),

2803

frozenset((token_second, token_end)))

2804

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

2805

datetime.timedelta(hours=1),

2806

frozenset((token_minute, token_end)))

2807

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

2808

None,

2809

frozenset((token_hour, token_minute,

2810

token_second)))

2811

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

2812

datetime.timedelta(days=1),

2813

frozenset((token_time, token_end)))

2814

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

2815

datetime.timedelta(weeks=4),

2816

frozenset((token_day, token_end)))

2817

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

2818

datetime.timedelta(weeks=52),

2819

frozenset((token_month, token_end)))

2820

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

2821

datetime.timedelta(weeks=1),

2822

frozenset((token_end, )))

2823

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

2824

frozenset((token_year, token_month,

2825

token_day, token_time,

2826

token_week)))

2827

# Define starting values:

2828

# Value so far

2829

value = datetime.timedelta()

2830

found_token = None

2831

# Following valid tokens

2832

followers = frozenset((token_duration, ))

2833

# String left to parse

2834

s = duration

2835

# Loop until end token is found

2836

while found_token is not token_end:

2837

# Search for any currently valid tokens

2838

for token in followers:

2839

match = token.regexp.match(s)

2840

if match is not None:

2841

# Token found

2842

if token.value is not None:

2843

# Value found, parse digits

2844

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

2845

# Add to value so far

2846

value += factor * token.value

2847

# Strip token from string

2848

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

2849

# Go to found token

2850

found_token = token

2851

# Set valid next tokens

2852

followers = found_token.followers

2853

break

2854

else:

2855

# No currently valid tokens were found

2856

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

2857

.format(duration))

2858

# End token found

2859

return value

2860

2861

2862

2093

def string_to_delta(interval):

2863

2094

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

2864

2865

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

2866

True

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2095

2096

>>> string_to_delta('7d')

2097

datetime.timedelta(7)

2098

>>> string_to_delta('60s')

2099

datetime.timedelta(0, 60)

2100

>>> string_to_delta('60m')

2101

datetime.timedelta(0, 3600)

2102

>>> string_to_delta('24h')

2103

datetime.timedelta(1)

2104

>>> string_to_delta('1w')

2105

datetime.timedelta(7)

2106

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

2107

datetime.timedelta(0, 330)

2877

2108

"""

2878

2879

try:

2880

return rfc3339_duration_to_delta(interval)

2881

except ValueError:

2882

pass

2883

2884

2109

timevalue = datetime.timedelta(0)

2885

2110

for s in interval.split():

2886

2111

try:

2887

suffix = s[-1]

2112

suffix = unicode(s[-1])

2888

2113

value = int(s[:-1])

2889

2114

if suffix == "d":

2890

2115

delta = datetime.timedelta(value)

2897

2122

elif suffix == "w":

2898

2123

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

2899

2124

else:

2900

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

2901

except IndexError as e:

2125

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

2126

.format(suffix))

2127

except (ValueError, IndexError) as e:

2902

2128

raise ValueError(*(e.args))

2903

2129

timevalue += delta

2904

2130

return timevalue

2905

2131

2906

2132

2907

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

2133

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

2908

2134

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

2909

2135

2910

2136

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

2911

2137

if os.fork():

2912

2138

sys.exit()

2920

2146

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

2921

2147

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

2922

2148

raise OSError(errno.ENODEV,

2923

"{} not a character device"

2149

"{0} not a character device"

2924

2150

.format(os.devnull))

2925

2151

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

2926

2152

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

2930

2156

2931

2157

2932

2158

def main():

2933

2159

2934

2160

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

2935

2161

# Parsing of options, both command line and config file

2936

2162

2937

2163

parser = argparse.ArgumentParser()

2938

2164

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

2939

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

2165

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

2940

2166

help="show version number and exit")

2941

2167

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

2942

2168

help="Bind to interface IF")

2948

2174

help="Run self-test")

2949

2175

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

2950

2176

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

2951

" to terminal", default=None)

2177

" to terminal")

2952

2178

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

2953

2179

help="Debug level for stdout output")

2954

2180

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

2961

2187

" files")

2962

2188

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

2963

2189

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

2964

" system bus interface", default=None)

2190

" system bus interface")

2965

2191

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

2966

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

2967

default=None)

2192

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

2968

2193

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

2969

2194

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

2970

" state", default=None)

2195

" state")

2971

2196

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

2972

2197

help="Specify a file descriptor to a network"

2973

2198

" socket to use instead of creating one")

2974

2199

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

2975

2200

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

2976

2201

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

2977

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

2978

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

2979

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

2980

default=None)

2981

2202

help="Run in foreground")

2203

2982

2204

options = parser.parse_args()

2983

2205

2206

if options.check:

2207

import doctest

2208

doctest.testmod()

2209

sys.exit()

2210

2984

2211

# Default values for config file for server-global settings

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2212

server_defaults = { "interface": "",

2213

"address": "",

2214

"port": "",

2215

"debug": "False",

2216

"priority":

2217

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

2218

"servicename": "Mandos",

2219

"use_dbus": "True",

2220

"use_ipv6": "True",

2221

"debuglevel": "",

2222

"restore": "True",

2223

"socket": "",

2224

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

2225

"foreground": "False",

2226

}

2227

3008

2228

# Parse config file for server-global settings

3009

server_config = configparser.ConfigParser(server_defaults)

2229

server_config = configparser.SafeConfigParser(server_defaults)

3010

2230

del server_defaults

3011

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

3012

# Convert the ConfigParser object to a dict

2231

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

2232

"mandos.conf"))

2233

# Convert the SafeConfigParser object to a dict

3013

2234

server_settings = server_config.defaults()

3014

2235

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

3015

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

3016

"foreground", "zeroconf"):

2236

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

3017

2237

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

3018

2238

option)

3019

2239

if server_settings["port"]:

3029

2249

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

3030

2250

["socket"])

3031

2251

del server_config

3032

2252

3033

2253

# Override the settings from the config file with command line

3034

2254

# options, if set.

3035

2255

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

3036

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

3037

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

3038

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

2256

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

2257

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

2258

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

3039

2259

value = getattr(options, option)

3040

2260

if value is not None:

3041

2261

server_settings[option] = value

3042

2262

del options

3043

2263

# Force all strings to be unicode

3044

2264

for option in server_settings.keys():

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

3048

# Force all boolean options to be boolean

3049

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

3050

"foreground", "zeroconf"):

3051

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

2265

if type(server_settings[option]) is str:

2266

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

3052

2267

# Debug implies foreground

3053

2268

if server_settings["debug"]:

3054

2269

server_settings["foreground"] = True

3055

2270

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

3056

2271

3057

2272

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

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2273

3064

2274

# For convenience

3065

2275

debug = server_settings["debug"]

3066

2276

debuglevel = server_settings["debuglevel"]

3069

2279

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

3070

2280

stored_state_file)

3071

2281

foreground = server_settings["foreground"]

3072

zeroconf = server_settings["zeroconf"]

3073

2282

3074

2283

if debug:

3075

2284

initlogger(debug, logging.DEBUG)

3076

2285

else:

3079

2288

else:

3080

2289

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

3081

2290

initlogger(debug, level)

3082

2291

3083

2292

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

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2293

syslogger.setFormatter(logging.Formatter

2294

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

2295

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

2296

.format(server_settings

2297

["servicename"])))

2298

3089

2299

# Parse config file with clients

3090

client_config = configparser.ConfigParser(Client.client_defaults)

2300

client_config = configparser.SafeConfigParser(Client

2301

.client_defaults)

3091

2302

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

3092

2303

"clients.conf"))

3093

2304

3094

2305

global mandos_dbus_service

3095

2306

mandos_dbus_service = None

3096

3097

socketfd = None

3098

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

3099

socketfd = server_settings["socket"]

3100

tcp_server = MandosServer(

3101

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

3102

ClientHandler,

3103

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

3104

use_ipv6=use_ipv6,

3105

gnutls_priority=server_settings["priority"],

3106

use_dbus=use_dbus,

3107

socketfd=socketfd)

2307

2308

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

2309

server_settings["port"]),

2310

ClientHandler,

2311

interface=(server_settings["interface"]

2312

or None),

2313

use_ipv6=use_ipv6,

2314

gnutls_priority=

2315

server_settings["priority"],

2316

use_dbus=use_dbus,

2317

socketfd=(server_settings["socket"]

2318

or None))

3108

2319

if not foreground:

3109

pidfilename = "/run/mandos.pid"

3110

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

3111

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

2320

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

3112

2321

pidfile = None

3113

2322

try:

3114

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

2323

pidfile = open(pidfilename, "w")

3115

2324

except IOError as e:

3116

2325

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

3117

2326

exc_info=e)

3118

3119

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

3120

("mandos", "mandos"),

3121

("nobody", "nogroup")):

2327

2328

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

3122

2329

try:

3123

2330

uid = pwd.getpwnam(name).pw_uid

3124

gid = pwd.getpwnam(group).pw_gid

2331

gid = pwd.getpwnam(name).pw_gid

3125

2332

break

3126

2333

except KeyError:

3127

2334

continue

3131

2338

try:

3132

2339

os.setgid(gid)

3133

2340

os.setuid(uid)

3134

if debug:

3135

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

3136

gid))

3137

2341

except OSError as error:

3138

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

3139

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

3140

2342

if error.errno != errno.EPERM:

3141

raise

3142

2343

raise error

2344

3143

2345

if debug:

3144

2346

# Enable all possible GnuTLS debugging

3145

2347

3146

2348

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

3147

2349

# - GnuTLS manual

3148

gnutls.global_set_log_level(11)

3149

3150

@gnutls.log_func

2350

gnutls.library.functions.gnutls_global_set_log_level(11)

2351

2352

@gnutls.library.types.gnutls_log_func

3151

2353

def debug_gnutls(level, string):

3152

2354

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

3153

3154

gnutls.global_set_log_function(debug_gnutls)

3155

2355

2356

(gnutls.library.functions

2357

.gnutls_global_set_log_function(debug_gnutls))

2358

3156

2359

# Redirect stdin so all checkers get /dev/null

3157

2360

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

3158

2361

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

3159

2362

if null > 2:

3160

2363

os.close(null)

3161

2364

3162

2365

# Need to fork before connecting to D-Bus

3163

2366

if not foreground:

3164

2367

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

3165

2368

daemon()

3166

3167

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

3168

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

3169

# need to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2369

2370

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

2371

# need to inform gobject that threads will be used.

2372

gobject.threads_init()

2373

3172

2374

global main_loop

3173

2375

# From the Avahi example code

3174

2376

DBusGMainLoop(set_as_default=True)

3175

main_loop = GLib.MainLoop()

2377

main_loop = gobject.MainLoop()

3176

2378

bus = dbus.SystemBus()

3177

2379

# End of Avahi example code

3178

2380

if use_dbus:

3179

2381

try:

3180

2382

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

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

2383

bus, do_not_queue=True)

2384

old_bus_name = (dbus.service.BusName

2385

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

2386

do_not_queue=True))

2387

except dbus.exceptions.NameExistsException as e:

3187

2388

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

3188

2389

use_dbus = False

3189

2390

server_settings["use_dbus"] = False

3190

2391

tcp_server.use_dbus = False

3191

if zeroconf:

3192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

3198

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2392

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2393

service = AvahiServiceToSyslog(name =

2394

server_settings["servicename"],

2395

servicetype = "_mandos._tcp",

2396

protocol = protocol, bus = bus)

2397

if server_settings["interface"]:

2398

service.interface = (if_nametoindex

2399

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

2400

3202

2401

global multiprocessing_manager

3203

2402

multiprocessing_manager = multiprocessing.Manager()

3204

2403

3205

2404

client_class = Client

3206

2405

if use_dbus:

3207

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

3208

2406

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

2407

3209

2408

client_settings = Client.config_parser(client_config)

3210

2409

old_client_settings = {}

3211

2410

clients_data = {}

3212

3213

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

3214

global wnull

3215

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

3216

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

3217

# mode

3218

if debug or not foreground:

3219

wnull.close()

3220

2411

3221

2412

# Get client data and settings from last running state.

3222

2413

if server_settings["restore"]:

3223

2414

try:

3224

2415

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

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name, .host, and .checker_command

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if "key_id" not in value:

3257

value["key_id"] = ""

3258

elif "fingerprint" not in value:

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host and .checker_command

3270

for value in old_client_settings.values():

3271

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

3272

if isinstance(value[attribute], bytes):

3273

value[attribute] = (value[attribute]

3274

.decode("utf-8"))

2416

clients_data, old_client_settings = (pickle.load

2417

(stored_state))

3275

2418

os.remove(stored_state_path)

3276

2419

except IOError as e:

3277

2420

if e.errno == errno.ENOENT:

3278

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

3279

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

2421

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

2422

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

3280

2423

else:

3281

2424

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

3282

2425

exc_info=e)

3283

2426

raise

3284

2427

except EOFError as e:

3285

2428

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

3286

"EOFError:",

3287

exc_info=e)

3288

2429

"EOFError:", exc_info=e)

2430

3289

2431

with PGPEngine() as pgp:

3290

for client_name, client in clients_data.items():

3291

# Skip removed clients

3292

if client_name not in client_settings:

3293

continue

3294

2432

for client_name, client in clients_data.iteritems():

3295

2433

# Decide which value to use after restoring saved state.

3296

2434

# We have three different values: Old config file,

3297

2435

# new config file, and saved state.

3302

2440

# For each value in new config, check if it

3303

2441

# differs from the old config value (Except for

3304

2442

# the "secret" attribute)

3305

if (name != "secret"

3306

and (value !=

3307

old_client_settings[client_name][name])):

2443

if (name != "secret" and

2444

value != old_client_settings[client_name]

2445

[name]):

3308

2446

client[name] = value

3309

2447

except KeyError:

3310

2448

pass

3311

2449

3312

2450

# Clients who has passed its expire date can still be

3313

# enabled if its last checker was successful. A Client

2451

# enabled if its last checker was successful. Clients

3314

2452

# whose checker succeeded before we stored its state is

3315

2453

# assumed to have successfully run all checkers during

3316

2454

# downtime.

3318

2456

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

3319

2457

if not client["last_checked_ok"]:

3320

2458

logger.warning(

3321

"disabling client {} - Client never "

3322

"performed a successful checker".format(

3323

client_name))

2459

"disabling client {0} - Client never "

2460

"performed a successful checker"

2461

.format(client_name))

3324

2462

client["enabled"] = False

3325

2463

elif client["last_checker_status"] != 0:

3326

2464

logger.warning(

3327

"disabling client {} - Client last"

3328

" checker failed with error code"

3329

" {}".format(

3330

client_name,

3331

client["last_checker_status"]))

2465

"disabling client {0} - Client "

2466

"last checker failed with error code {1}"

2467

.format(client_name,

2468

client["last_checker_status"]))

3332

2469

client["enabled"] = False

3333

2470

else:

3334

client["expires"] = (

3335

datetime.datetime.utcnow()

3336

+ client["timeout"])

2471

client["expires"] = (datetime.datetime

2472

.utcnow()

2473

+ client["timeout"])

3337

2474

logger.debug("Last checker succeeded,"

3338

" keeping {} enabled".format(

3339

client_name))

2475

" keeping {0} enabled"

2476

.format(client_name))

3340

2477

try:

3341

client["secret"] = pgp.decrypt(

3342

client["encrypted_secret"],

3343

client_settings[client_name]["secret"])

2478

client["secret"] = (

2479

pgp.decrypt(client["encrypted_secret"],

2480

client_settings[client_name]

2481

["secret"]))

3344

2482

except PGPError:

3345

2483

# If decryption fails, we use secret from new settings

3346

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

3347

client_name))

3348

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

3349

["secret"])

3350

2484

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

2485

.format(client_name))

2486

client["secret"] = (

2487

client_settings[client_name]["secret"])

2488

3351

2489

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

3352

2490

for client_name in (set(old_client_settings)

3353

2491

- set(client_settings)):

3355

2493

for client_name in (set(client_settings)

3356

2494

- set(old_client_settings)):

3357

2495

clients_data[client_name] = client_settings[client_name]

3358

2496

3359

2497

# Create all client objects

3360

for client_name, client in clients_data.items():

2498

for client_name, client in clients_data.iteritems():

3361

2499

tcp_server.clients[client_name] = client_class(

3362

name=client_name,

3363

settings=client,

3364

server_settings=server_settings)

3365

2500

name = client_name, settings = client)

2501

3366

2502

if not tcp_server.clients:

3367

2503

logger.warning("No clients defined")

3368

2504

3369

2505

if not foreground:

3370

2506

if pidfile is not None:

3371

pid = os.getpid()

3372

2507

try:

3373

2508

with pidfile:

3374

print(pid, file=pidfile)

2509

pid = os.getpid()

2510

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

3375

2511

except IOError:

3376

2512

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

3377

2513

pidfilename, pid)

3378

2514

del pidfile

3379

2515

del pidfilename

3380

3381

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

3382

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3383

lambda: main_loop.quit() and False)

3384

2516

2517

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

2518

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

2519

3385

2520

if use_dbus:

3386

3387

@alternate_dbus_interfaces(

3388

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

3389

class MandosDBusService(DBusObjectWithObjectManager):

2521

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

2522

"se.bsnet.fukt.Mandos"})

2523

class MandosDBusService(DBusObjectWithProperties):

3390

2524

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

3391

3392

2525

def __init__(self):

3393

2526

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

3394

3395

2527

_interface = "se.recompile.Mandos"

3396

2528

2529

@dbus_interface_annotations(_interface)

2530

def _foo(self):

2531

return { "org.freedesktop.DBus.Property"

2532

".EmitsChangedSignal":

2533

"false"}

2534

3397

2535

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

3398

2536

def ClientAdded(self, objpath):

3399

2537

"D-Bus signal"

3400

2538

pass

3401

2539

3402

2540

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

3403

def ClientNotFound(self, key_id, address):

2541

def ClientNotFound(self, fingerprint, address):

3404

2542

"D-Bus signal"

3405

2543

pass

3406

3407

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

3408

"true"})

2544

3409

2545

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

3410

2546

def ClientRemoved(self, objpath, name):

3411

2547

"D-Bus signal"

3412

2548

pass

3413

3414

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

3415

"true"})

2549

3416

2550

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

3417

2551

def GetAllClients(self):

3418

2552

"D-Bus method"

3419

return dbus.Array(c.dbus_object_path for c in

3420

tcp_server.clients.values())

3421

3422

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

3423

"true"})

2553

return dbus.Array(c.dbus_object_path

2554

for c in

2555

tcp_server.clients.itervalues())

2556

3424

2557

@dbus.service.method(_interface,

3425

2558

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

3426

2559

def GetAllClientsWithProperties(self):

3427

2560

"D-Bus method"

3428

2561

return dbus.Dictionary(

3429

{c.dbus_object_path: c.GetAll(

3430

"se.recompile.Mandos.Client")

3431

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

2562

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

2563

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

3432

2564

signature="oa{sv}")

3433

2565

3434

2566

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

3435

2567

def RemoveClient(self, object_path):

3436

2568

"D-Bus method"

3437

for c in tcp_server.clients.values():

2569

for c in tcp_server.clients.itervalues():

3438

2570

if c.dbus_object_path == object_path:

3439

2571

del tcp_server.clients[c.name]

3440

2572

c.remove_from_connection()

3441

# Don't signal the disabling

2573

# Don't signal anything except ClientRemoved

3442

2574

c.disable(quiet=True)

3443

# Emit D-Bus signal for removal

3444

self.client_removed_signal(c)

2575

# Emit D-Bus signal

2576

self.ClientRemoved(object_path, c.name)

3445

2577

return

3446

2578

raise KeyError(object_path)

3447

2579

3448

2580

del _interface

3449

3450

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3451

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

3452

def GetManagedObjects(self):

3453

"""D-Bus method"""

3454

return dbus.Dictionary(

3455

{client.dbus_object_path:

3456

dbus.Dictionary(

3457

{interface: client.GetAll(interface)

3458

for interface in

3459

client._get_all_interface_names()})

3460

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

3461

3462

def client_added_signal(self, client):

3463

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

3464

if use_dbus:

3465

# New standard signal

3466

self.InterfacesAdded(

3467

client.dbus_object_path,

3468

dbus.Dictionary(

3469

{interface: client.GetAll(interface)

3470

for interface in

3471

client._get_all_interface_names()}))

3472

# Old signal

3473

self.ClientAdded(client.dbus_object_path)

3474

3475

def client_removed_signal(self, client):

3476

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

3477

if use_dbus:

3478

# New standard signal

3479

self.InterfacesRemoved(

3480

client.dbus_object_path,

3481

client._get_all_interface_names())

3482

# Old signal

3483

self.ClientRemoved(client.dbus_object_path,

3484

client.name)

3485

2581

3486

2582

mandos_dbus_service = MandosDBusService()

3487

3488

# Save modules to variables to exempt the modules from being

3489

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

3490

mp = multiprocessing

3491

wn = wnull

3492

2583

3493

2584

def cleanup():

3494

2585

"Cleanup function; run on exit"

3495

if zeroconf:

3496

service.cleanup()

3497

3498

mp.active_children()

3499

wn.close()

2586

service.cleanup()

2587

2588

multiprocessing.active_children()

3500

2589

if not (tcp_server.clients or client_settings):

3501

2590

return

3502

2591

3503

2592

# Store client before exiting. Secrets are encrypted with key

3504

2593

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

3505

2594

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

3506

2595

clients = {}

3507

2596

with PGPEngine() as pgp:

3508

for client in tcp_server.clients.values():

2597

for client in tcp_server.clients.itervalues():

3509

2598

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

3510

2599

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

3511

2600

key)

3512

2601

client_dict = {}

3513

2602

3514

2603

# A list of attributes that can not be pickled

3515

2604

# + secret.

3516

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

3517

"checker", "server_settings"}

3518

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

3519

.Object):

2605

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

2606

"checker"))

2607

for name, typ in (inspect.getmembers

2608

(dbus.service.Object)):

3520

2609

exclude.add(name)

3521

2610

3522

2611

client_dict["encrypted_secret"] = (client

3523

2612

.encrypted_secret)

3524

2613

for attr in client.client_structure:

3525

2614

if attr not in exclude:

3526

2615

client_dict[attr] = getattr(client, attr)

3527

2616

3528

2617

clients[client.name] = client_dict

3529

2618

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

3530

2619

3531

2620

try:

3532

with tempfile.NamedTemporaryFile(

3533

mode='wb',

3534

suffix=".pickle",

3535

prefix='clients-',

3536

dir=os.path.dirname(stored_state_path),

3537

delete=False) as stored_state:

3538

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

3539

protocol=2)

3540

tempname = stored_state.name

2621

with (tempfile.NamedTemporaryFile

2622

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

2623

dir=os.path.dirname(stored_state_path),

2624

delete=False)) as stored_state:

2625

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

2626

tempname=stored_state.name

3541

2627

os.rename(tempname, stored_state_path)

3542

2628

except (IOError, OSError) as e:

3543

2629

if not debug:

3546

2632

except NameError:

3547

2633

pass

3548

2634

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

3549

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

2635

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

3550

2636

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

3551

2637

else:

3552

2638

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

3553

2639

exc_info=e)

3554

raise

3555

2640

raise e

2641

3556

2642

# Delete all clients, and settings from config

3557

2643

while tcp_server.clients:

3558

2644

name, client = tcp_server.clients.popitem()

3559

2645

if use_dbus:

3560

2646

client.remove_from_connection()

3561

# Don't signal the disabling

2647

# Don't signal anything except ClientRemoved

3562

2648

client.disable(quiet=True)

3563

# Emit D-Bus signal for removal

3564

2649

if use_dbus:

3565

mandos_dbus_service.client_removed_signal(client)

2650

# Emit D-Bus signal

2651

mandos_dbus_service.ClientRemoved(client

2652

.dbus_object_path,

2653

client.name)

3566

2654

client_settings.clear()

3567

2655

3568

2656

atexit.register(cleanup)

3569

3570

for client in tcp_server.clients.values():

2657

2658

for client in tcp_server.clients.itervalues():

3571

2659

if use_dbus:

3572

# Emit D-Bus signal for adding

3573

mandos_dbus_service.client_added_signal(client)

2660

# Emit D-Bus signal

2661

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3574

2662

# Need to initiate checking of clients

3575

2663

if client.enabled:

3576

2664

client.init_checker()

3577

2665

3578

2666

tcp_server.enable()

3579

2667

tcp_server.server_activate()

3580

2668

3581

2669

# Find out what port we got

3582

if zeroconf:

3583

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

2670

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

3584

2671

if use_ipv6:

3585

2672

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

3586

2673

" flowinfo %d, scope_id %d",

3588

2675

else: # IPv4

3589

2676

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

3590

2677

*tcp_server.socket.getsockname())

3591

3592

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

3593

2678

2679

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

2680

3594

2681

try:

3595

if zeroconf:

3596

# From the Avahi example code

3597

try:

3598

service.activate()

3599

except dbus.exceptions.DBusException as error:

3600

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

3601

cleanup()

3602

sys.exit(1)

3603

# End of Avahi example code

3604

3605

GLib.io_add_watch(

3606

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

3607

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3608

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

3609

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

3610

2682

# From the Avahi example code

2683

try:

2684

service.activate()

2685

except dbus.exceptions.DBusException as error:

2686

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

2687

cleanup()

2688

sys.exit(1)

2689

# End of Avahi example code

2690

2691

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

2692

lambda *args, **kwargs:

2693

(tcp_server.handle_request

2694

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

2695

3611

2696

logger.debug("Starting main loop")

3612

2697

main_loop.run()

3613

2698

except AvahiError as error:

3622

2707

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

3623

2708

cleanup()

3624

2709

3625

3626

def should_only_run_tests():

3627

parser = argparse.ArgumentParser(add_help=False)

3628

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

3629

args, unknown_args = parser.parse_known_args()

3630

run_tests = args.check

3631

if run_tests:

3632

# Remove --check argument from sys.argv

3633

sys.argv[1:] = unknown_args

3634

return run_tests

3635

3636

# Add all tests from doctest strings

3637

def load_tests(loader, tests, none):

3638

import doctest

3639

tests.addTests(doctest.DocTestSuite())

3640

return tests

3641

3642

2710

if __name__ == '__main__':

3643

try:

3644

if should_only_run_tests():

3645

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

3646

unittest.main()

3647

else:

3648

main()

3649

finally:

3650

logging.shutdown()

2711

main()