/mandos/release : revision 237.7.281

1

#!/usr/bin/python3 -bI

2

# -*- coding: utf-8; lexical-binding: t -*-

3

#

1

#!/usr/bin/python2.7

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

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

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

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

# Add collections.abc.Callable if it does not exist

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.15"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.8"

147

95

stored_state_file = "clients.pickle"

148

96

149

log = logging.getLogger(os.path.basename(sys.argv[0]))

150

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

97

logger = logging.getLogger()

151

98

syslogger = None

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

165

112

return interface_index

166

113

167

114

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

115

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

185

116

"""init logger and add loglevel"""

186

117

187

118

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

191

123

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

124

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

125

' %(message)s'))

126

logger.addHandler(syslogger)

127

196

128

if debug:

197

129

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

130

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

131

' [%(process)d]:'

132

' %(levelname)s:'

133

' %(message)s'))

134

logger.addHandler(console)

135

logger.setLevel(level)

204

136

205

137

206

138

class PGPError(Exception):

208

140

pass

209

141

210

142

211

class PGPEngine:

143

class PGPEngine(object):

212

144

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

213

214

145

def __init__(self):

215

146

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

147

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

149

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

235

153

def __enter__(self):

236

154

return self

237

155

238

156

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

239

157

self._cleanup()

240

158

return False

241

159

242

160

def __del__(self):

243

161

self._cleanup()

244

162

245

163

def _cleanup(self):

246

164

if self.tempdir is not None:

247

165

# Delete contents of tempdir

248

166

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

249

topdown=False):

167

topdown = False):

250

168

for filename in files:

251

169

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

252

170

for dirname in dirs:

254

172

# Remove tempdir

255

173

os.rmdir(self.tempdir)

256

174

self.tempdir = None

257

175

258

176

def password_encode(self, password):

259

177

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

260

178

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

265

183

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

266

184

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

267

185

return encoded

268

186

269

187

def encrypt(self, data, password):

270

188

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

273

191

passfile.write(passphrase)

274

192

passfile.flush()

275

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

276

"--passphrase-file",

193

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

194

'--passphrase-file',

277

195

passfile.name]

278

196

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

283

201

if proc.returncode != 0:

284

202

raise PGPError(err)

285

203

return ciphertext

286

204

287

205

def decrypt(self, data, password):

288

206

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

291

209

passfile.write(passphrase)

292

210

passfile.flush()

293

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

294

"--passphrase-file",

211

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

212

'--passphrase-file',

295

213

passfile.name]

296

214

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

301

220

if proc.returncode != 0:

302

221

raise PGPError(err)

303

222

return decrypted_plaintext

304

223

305

224

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

225

class AvahiError(Exception):

333

226

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

334

227

self.value = value

335

228

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

336

229

**kwargs)

337

230

338

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

353

354

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

244

245

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

355

246

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

356

247

port: integer; what port to announce

357

248

TXT: list of strings; TXT record for the service

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

277

278

def rename(self):

395

279

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

396

280

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

281

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

282

" after %i retries, exiting.",

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

287

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

288

self.name)

289

self.remove()

290

try:

291

self.add()

292

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

403

296

self.rename_count += 1

404

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

405

self.name)

406

if remove:

407

self.remove()

408

try:

409

self.add()

410

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

297

420

298

def remove(self):

421

299

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

422

300

if self.entry_group_state_changed_match is not None:

424

302

self.entry_group_state_changed_match = None

425

303

if self.group is not None:

426

304

self.group.Reset()

427

305

428

306

def add(self):

429

307

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

430

308

self.remove()

435

313

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

314

self.entry_group_state_changed_match = (

437

315

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

log.debug("Adding Zeroconf service '%s' of type '%s' ...",

440

self.name, self.type)

316

'StateChanged', self.entry_group_state_changed))

317

logger.debug("Adding Zeroconf service '%s' of type '%s' ...",

318

self.name, self.type)

441

319

self.group.AddService(

442

320

self.interface,

443

321

self.protocol,

447

325

dbus.UInt16(self.port),

448

326

avahi.string_array_to_txt_array(self.TXT))

449

327

self.group.Commit()

450

328

451

329

def entry_group_state_changed(self, state, error):

452

330

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

453

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

454

331

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

332

455

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

334

logger.debug("Zeroconf service established.")

457

335

elif state == avahi.ENTRY_GROUP_COLLISION:

458

log.info("Zeroconf service name collision.")

336

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

459

337

self.rename()

460

338

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

463

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

464

339

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

340

str(error))

341

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

342

.format(error))

343

465

344

def cleanup(self):

466

345

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

467

346

if self.group is not None:

472

351

pass

473

352

self.group = None

474

353

self.remove()

475

354

476

355

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

477

356

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

478

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

357

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

485

365

if state in bad_states:

486

366

if bad_states[state] is not None:

487

367

if error is None:

488

log.error(bad_states[state])

368

logger.error(bad_states[state])

489

369

else:

490

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

370

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

491

371

self.cleanup()

492

372

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

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

499

return self.rename(remove=False)

500

else:

501

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

502

self.cleanup()

503

os._exit(1)

373

self.add()

504

374

else:

505

375

if error is None:

506

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

376

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

507

377

else:

508

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

509

378

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

379

510

380

def activate(self):

511

381

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

512

382

if self.server is None:

516

386

follow_name_owner_changes=True),

517

387

avahi.DBUS_INTERFACE_SERVER)

518

388

self.server.connect_to_signal("StateChanged",

519

self.server_state_changed)

389

self.server_state_changed)

520

390

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

521

391

522

392

523

393

class AvahiServiceToSyslog(AvahiService):

524

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

394

def rename(self):

525

395

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

526

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

527

**kwargs)

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

531

401

return ret

532

402

533

403

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

"utf-8", errors="replace")

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

raise TypeError("Not of type {}: {!r}"

611

.format(self.cls.__name__, obj))

612

return ctypes.byref(obj.from_param(obj))

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

raise TypeError("Not of type {}: {!r}"

621

.format(self.cls.__name__, obj))

622

return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

data_len -= gnutls.record_send(self, data[-data_len:],

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

init.argtypes = [PointerTo(ClientSession), ctypes.c_int]

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

def call_pipe(connection, # : multiprocessing.Connection

864

func, *args, **kwargs):

865

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

866

867

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

868

return value on the provided multiprocessing.Connection.

869

"""

870

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

871

connection.close()

872

873

874

class Client:

404

class Client(object):

875

405

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

876

406

877

407

Attributes:

878

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

408

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

879

409

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

880

410

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

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

411

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

412

to see if the client lives.

413

'None' if no process is running.

414

checker_callback_tag: a gobject event source tag, or None

885

415

checker_command: string; External command which is run to check

886

416

if client lives. %() expansions are done at

887

417

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

888

418

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

889

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

890

420

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

891

421

client_structure: Object describing what attributes a client has

892

422

and is used for storing the client at exit

893

423

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

895

425

enabled: bool()

896

426

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

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

427

uniquely identify the client

900

428

host: string; available for use by the checker command

901

429

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

902

430

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

904

432

last_checker_status: integer between 0 and 255 reflecting exit

905

433

status of last checker. -1 reflects crashed

906

434

checker, -2 means no checker completed yet.

907

last_checker_signal: The signal which killed the last checker, if

908

last_checker_status is -1

909

435

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

910

436

911

437

D-Bus identifiers

918

444

disabled, or None

919

445

server_settings: The server_settings dict from main()

920

446

"""

921

447

922

448

runtime_expansions = ("approval_delay", "approval_duration",

923

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

449

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

924

450

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

925

451

"last_approval_request", "last_checked_ok",

926

452

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

927

client_defaults = {

928

"timeout": "PT5M",

929

"extended_timeout": "PT15M",

930

"interval": "PT2M",

931

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

932

"host": "",

933

"approval_delay": "PT0S",

934

"approval_duration": "PT1S",

935

"approved_by_default": "True",

936

"enabled": "True",

937

}

938

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

463

939

464

@staticmethod

940

465

def config_parser(config):

941

466

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

948

473

for client_name in config.sections():

949

474

section = dict(config.items(client_name))

950

475

client = settings[client_name] = {}

951

476

952

477

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

953

478

# Reformat values from string types to Python types

954

479

client["approved_by_default"] = config.getboolean(

955

480

client_name, "approved_by_default")

956

481

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

957

482

"enabled")

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

483

964

484

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

965

485

.replace(" ", ""))

966

486

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

487

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

970

488

elif "secfile" in section:

971

489

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

972

490

(section["secfile"])),

987

505

client["last_approval_request"] = None

988

506

client["last_checked_ok"] = None

989

507

client["last_checker_status"] = -2

990

508

991

509

return settings

992

993

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

510

511

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

994

512

self.name = name

995

513

if server_settings is None:

996

514

server_settings = {}

998

516

# adding all client settings

999

517

for setting, value in settings.items():

1000

518

setattr(self, setting, value)

1001

519

1002

520

if self.enabled:

1003

521

if not hasattr(self, "last_enabled"):

1004

522

self.last_enabled = datetime.datetime.utcnow()

1008

526

else:

1009

527

self.last_enabled = None

1010

528

self.expires = None

1011

1012

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

1013

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

1014

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

529

530

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

534

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

1015

535

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

1016

536

datetime.datetime.utcnow())

1017

537

1018

538

# attributes specific for this server instance

1019

539

self.checker = None

1020

540

self.checker_initiator_tag = None

1023

543

self.current_checker_command = None

1024

544

self.approved = None

1025

545

self.approvals_pending = 0

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

1030

551

if not attr.startswith("_")]

1031

552

self.client_structure.append("client_structure")

1032

1033

for name, t in inspect.getmembers(

1034

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

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

1035

558

if not name.startswith("_"):

1036

559

self.client_structure.append(name)

1037

560

1038

561

# Send notice to process children that client state has changed

1039

562

def send_changedstate(self):

1040

563

with self.changedstate:

1041

564

self.changedstate.notify_all()

1042

565

1043

566

def enable(self):

1044

567

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

1045

568

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

1050

573

self.last_enabled = datetime.datetime.utcnow()

1051

574

self.init_checker()

1052

575

self.send_changedstate()

1053

576

1054

577

def disable(self, quiet=True):

1055

578

"""Disable this client."""

1056

579

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

1057

580

return False

1058

581

if not quiet:

1059

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

582

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

1060

583

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

1061

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1062

585

self.disable_initiator_tag = None

1063

586

self.expires = None

1064

587

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

1065

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1066

589

self.checker_initiator_tag = None

1067

590

self.stop_checker()

1068

591

self.enabled = False

1069

592

if not quiet:

1070

593

self.send_changedstate()

1071

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

594

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

1072

595

return False

1073

596

1074

597

def __del__(self):

1075

598

self.disable()

1076

599

1077

600

def init_checker(self):

1078

601

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

1079

602

# and every interval from then on.

1080

603

if self.checker_initiator_tag is not None:

1081

GLib.source_remove(self.checker_initiator_tag)

1082

self.checker_initiator_tag = GLib.timeout_add(

1083

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

1084

+ 1)),

1085

self.start_checker)

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

self.start_checker))

1086

609

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

1087

610

if self.disable_initiator_tag is not None:

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

1090

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

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

1091

616

# Also start a new checker *right now*.

1092

617

self.start_checker()

1093

1094

def checker_callback(self, source, condition, connection,

1095

command):

618

619

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

1096

620

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

1097

# Read return code from connection (see call_pipe)

1098

returncode = connection.recv()

1099

connection.close()

1100

if self.checker is not None:

1101

self.checker.join()

1102

621

self.checker_callback_tag = None

1103

622

self.checker = None

1104

1105

if returncode >= 0:

1106

self.last_checker_status = returncode

1107

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1108

625

if self.last_checker_status == 0:

1109

log.info("Checker for %(name)s succeeded", vars(self))

626

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

627

vars(self))

1110

628

self.checked_ok()

1111

629

else:

1112

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

630

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

631

vars(self))

1113

632

else:

1114

633

self.last_checker_status = -1

1115

self.last_checker_signal = -returncode

1116

log.warning("Checker for %(name)s crashed?", vars(self))

1117

return False

1118

634

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

635

vars(self))

636

1119

637

def checked_ok(self):

1120

638

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

1121

639

self.last_checked_ok = datetime.datetime.utcnow()

1122

640

self.last_checker_status = 0

1123

self.last_checker_signal = None

1124

641

self.bump_timeout()

1125

642

1126

643

def bump_timeout(self, timeout=None):

1127

644

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

1128

645

if timeout is None:

1129

646

timeout = self.timeout

1130

647

if self.disable_initiator_tag is not None:

1131

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1132

649

self.disable_initiator_tag = None

1133

650

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

1134

self.disable_initiator_tag = GLib.timeout_add(

1135

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1136

654

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

1137

655

1138

656

def need_approval(self):

1139

657

self.last_approval_request = datetime.datetime.utcnow()

1140

658

1141

659

def start_checker(self):

1142

660

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

1143

661

1144

662

If a checker already exists, leave it running and do

1145

663

nothing."""

1146

664

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

1151

669

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

1152

670

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

1153

671

# should be.

1154

1155

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

1156

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

1157

self.checker.join()

1158

self.checker = None

672

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1159

687

# Start a new checker if needed

1160

688

if self.checker is None:

1161

689

# Escape attributes for the shell

1162

escaped_attrs = {

1163

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

1164

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1165

693

try:

1166

694

command = self.checker_command % escaped_attrs

1167

695

except TypeError as error:

1168

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

1169

self.checker_command, exc_info=error)

1170

return True # Try again later

696

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

697

self.checker_command, exc_info=error)

698

return True # Try again later

1171

699

self.current_checker_command = command

1172

log.info("Starting checker %r for %s", command, self.name)

1173

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

1174

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

1175

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

1176

# always replaced by /dev/null.)

1177

# The exception is when not debugging but nevertheless

1178

# running in the foreground; use the previously

1179

# created wnull.

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

1183

if (not self.server_settings["debug"]

1184

and self.server_settings["foreground"]):

1185

popen_args.update({"stdout": wnull,

1186

"stderr": wnull})

1187

pipe = multiprocessing.Pipe(duplex=False)

1188

self.checker = multiprocessing.Process(

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

1192

self.checker.start()

1193

self.checker_callback_tag = GLib.io_add_watch(

1194

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

1195

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1196

self.checker_callback, pipe[0], command)

1197

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

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

# The exception is when not debugging but nevertheless

708

# running in the foreground; use the previously

709

# created wnull.

710

popen_args = {}

711

if (not self.server_settings["debug"]

712

and self.server_settings["foreground"]):

713

popen_args.update({"stdout": wnull,

714

"stderr": wnull })

715

self.checker = subprocess.Popen(command,

716

close_fds=True,

717

shell=True, cwd="/",

718

**popen_args)

719

except OSError as error:

720

logger.error("Failed to start subprocess",

721

exc_info=error)

722

return True

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

try:

730

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

731

except OSError as error:

732

if error.errno == errno.ECHILD:

733

# This should never happen

734

logger.error("Child process vanished",

735

exc_info=error)

736

return True

737

raise

738

if pid:

739

gobject.source_remove(self.checker_callback_tag)

740

self.checker_callback(pid, status, command)

741

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

1198

742

return True

1199

743

1200

744

def stop_checker(self):

1201

745

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

1202

746

if self.checker_callback_tag:

1203

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1204

748

self.checker_callback_tag = None

1205

749

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

1206

750

return

1207

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

1208

self.checker.terminate()

751

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

752

try:

753

self.checker.terminate()

754

#time.sleep(0.5)

755

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

756

# self.checker.kill()

757

except OSError as error:

758

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

759

raise

1209

760

self.checker = None

1210

761

1211

762

1212

def dbus_service_property(dbus_interface,

1213

signature="v",

1214

access="readwrite",

1215

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1216

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1217

766

become properties on the D-Bus.

1218

767

1219

768

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

1220

769

and with one argument by "Set".

1221

770

1222

771

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

1223

772

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

1224

773

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

1228

777

if byte_arrays and signature != "ay":

1229

778

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

1230

779

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

1231

1232

780

def decorator(func):

1233

781

func._dbus_is_property = True

1234

782

func._dbus_interface = dbus_interface

1237

785

func._dbus_name = func.__name__

1238

786

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

1239

787

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

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1241

789

return func

1242

1243

790

return decorator

1244

791

1245

792

1246

793

def dbus_interface_annotations(dbus_interface):

1247

794

"""Decorator for marking functions returning interface annotations

1248

795

1249

796

Usage:

1250

797

1251

798

@dbus_interface_annotations("org.example.Interface")

1252

799

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

1253

800

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

1254

801

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

1255

802

"false"}

1256

803

"""

1257

1258

804

def decorator(func):

1259

805

func._dbus_is_interface = True

1260

806

func._dbus_interface = dbus_interface

1261

807

func._dbus_name = dbus_interface

1262

808

return func

1263

1264

809

return decorator

1265

810

1266

811

1267

812

def dbus_annotations(annotations):

1268

813

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

1269

814

Usage:

1270

815

1271

816

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

1272

817

"org.freedesktop.DBus.Property."

1273

818

"EmitsChangedSignal": "false"})

1275

820

access="r")

1276

821

def Property_dbus_property(self):

1277

822

return dbus.Boolean(False)

1278

1279

See also the DBusObjectWithAnnotations class.

1280

823

"""

1281

1282

824

def decorator(func):

1283

825

func._dbus_annotations = annotations

1284

826

return func

1285

1286

827

return decorator

1287

828

1288

829

1291

832

"""

1292

833

pass

1293

834

1294

1295

835

class DBusPropertyAccessException(DBusPropertyException):

1296

836

"""A property's access permissions disallows an operation.

1297

837

"""

1304

844

pass

1305

845

1306

846

1307

class DBusObjectWithAnnotations(dbus.service.Object):

1308

"""A D-Bus object with annotations.

1309

1310

Classes inheriting from this can use the dbus_annotations

1311

decorator to add annotations to methods or signals.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1312

853

"""

1313

854

1314

855

@staticmethod

1315

856

def _is_dbus_thing(thing):

1316

857

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

1317

858

1318

859

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

1319

860

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

1320

861

"""

1321

862

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

1322

863

False)

1323

864

1324

865

def _get_all_dbus_things(self, thing):

1325

866

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

1326

867

"""

1327

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

868

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

869

name),

1328

870

athing.__get__(self))

1329

871

for cls in self.__class__.__mro__

1330

872

for name, athing in

1331

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

1332

1333

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1334

out_signature="s",

1335

path_keyword="object_path",

1336

connection_keyword="connection")

1337

def Introspect(self, object_path, connection):

1338

"""Overloading of standard D-Bus method.

1339

1340

Inserts annotation tags on methods and signals.

1341

"""

1342

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

1343

connection)

1344

try:

1345

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

1346

1347

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

1348

# Add annotation tags

1349

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

1350

for tag in if_tag.getElementsByTagName(typ):

1351

annots = dict()

1352

for name, prop in (self.

1353

_get_all_dbus_things(typ)):

1354

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

1355

and prop._dbus_interface

1356

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

1357

annots.update(getattr(

1358

prop, "_dbus_annotations", {}))

1359

for name, value in annots.items():

1360

ann_tag = document.createElement(

1361

"annotation")

1362

ann_tag.setAttribute("name", name)

1363

ann_tag.setAttribute("value", value)

1364

tag.appendChild(ann_tag)

1365

# Add interface annotation tags

1366

for annotation, value in dict(

1367

itertools.chain.from_iterable(

1368

annotations().items()

1369

for name, annotations

1370

in self._get_all_dbus_things("interface")

1371

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

1372

)).items():

1373

ann_tag = document.createElement("annotation")

1374

ann_tag.setAttribute("name", annotation)

1375

ann_tag.setAttribute("value", value)

1376

if_tag.appendChild(ann_tag)

1377

# Fix argument name for the Introspect method itself

1378

if (if_tag.getAttribute("name")

1379

== dbus.INTROSPECTABLE_IFACE):

1380

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

1381

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

1382

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

1383

if (arg.getAttribute("direction")

1384

== "out"):

1385

arg.setAttribute("name",

1386

"xml_data")

1387

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

1388

document.unlink()

1389

except (AttributeError, xml.dom.DOMException,

1390

xml.parsers.expat.ExpatError) as error:

1391

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

1392

exc_info=error)

1393

return xmlstring

1394

1395

1396

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1397

"""A D-Bus object with properties.

1398

1399

Classes inheriting from this can use the dbus_service_property

1400

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

1401

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

1402

"""

1403

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1404

876

def _get_dbus_property(self, interface_name, property_name):

1405

877

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

1406

878

property with the specified name and interface.

1407

879

"""

1408

for cls in self.__class__.__mro__:

1409

for name, value in inspect.getmembers(

1410

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1411

884

if (value._dbus_name == property_name

1412

885

and value._dbus_interface == interface_name):

1413

886

return value.__get__(self)

1414

887

1415

888

# No such property

1416

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

1417

self.dbus_object_path, interface_name, property_name))

1418

1419

@classmethod

1420

def _get_all_interface_names(cls):

1421

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

1422

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

1423

"_dbus_interface", None)

1424

for x in (inspect.getmro(cls))

1425

for attr in dir(x))

1426

if name is not None)

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="ss",

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1430

894

out_signature="v")

1431

895

def Get(self, interface_name, property_name):

1432

896

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

1438

902

if not hasattr(value, "variant_level"):

1439

903

return value

1440

904

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

1441

905

1442

906

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

1443

907

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

1444

908

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

1453

917

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

1454

918

"'ay' signature {!r}"

1455

919

.format(prop._dbus_signature))

1456

value = dbus.ByteArray(bytes(value))

920

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

921

for byte in value))

1457

922

prop(value)

1458

1459

@dbus.service.method(dbus.PROPERTIES_IFACE,

1460

in_signature="s",

923

924

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

1461

925

out_signature="a{sv}")

1462

926

def GetAll(self, interface_name):

1463

927

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

1464

928

standard.

1465

929

1466

930

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

1467

931

"""

1468

932

properties = {}

1478

942

if not hasattr(value, "variant_level"):

1479

943

properties[name] = value

1480

944

continue

1481

properties[name] = type(value)(

1482

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1483

947

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

1484

948

1485

949

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

1486

950

def PropertiesChanged(self, interface_name, changed_properties,

1487

951

invalidated_properties):

1489

953

standard.

1490

954

"""

1491

955

pass

1492

956

1493

957

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1494

958

out_signature="s",

1495

path_keyword="object_path",

1496

connection_keyword="connection")

959

path_keyword='object_path',

960

connection_keyword='connection')

1497

961

def Introspect(self, object_path, connection):

1498

962

"""Overloading of standard D-Bus method.

1499

963

1500

964

Inserts property tags and interface annotation tags.

1501

965

"""

1502

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1503

object_path,

1504

connection)

966

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

967

connection)

1505

968

try:

1506

969

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

1507

1508

970

def make_tag(document, name, prop):

1509

971

e = document.createElement("property")

1510

972

e.setAttribute("name", name)

1511

973

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

1512

974

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

1513

975

return e

1514

1515

976

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

1516

977

# Add property tags

1517

978

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

1520

981

if prop._dbus_interface

1521

982

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

1522

983

if_tag.appendChild(tag)

1523

# Add annotation tags for properties

1524

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

1525

annots = dict()

1526

for name, prop in self._get_all_dbus_things(

1527

"property"):

1528

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

1529

and prop._dbus_interface

1530

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

1531

annots.update(getattr(

1532

prop, "_dbus_annotations", {}))

1533

for name, value in annots.items():

1534

ann_tag = document.createElement(

1535

"annotation")

1536

ann_tag.setAttribute("name", name)

1537

ann_tag.setAttribute("value", value)

1538

tag.appendChild(ann_tag)

984

# Add annotation tags

985

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

986

for tag in if_tag.getElementsByTagName(typ):

987

annots = dict()

988

for name, prop in (self.

989

_get_all_dbus_things(typ)):

990

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

991

and prop._dbus_interface

992

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

993

annots.update(getattr

994

(prop,

995

"_dbus_annotations",

996

{}))

997

for name, value in annots.items():

998

ann_tag = document.createElement(

999

"annotation")

1000

ann_tag.setAttribute("name", name)

1001

ann_tag.setAttribute("value", value)

1002

tag.appendChild(ann_tag)

1003

# Add interface annotation tags

1004

for annotation, value in dict(

1005

itertools.chain.from_iterable(

1006

annotations().items()

1007

for name, annotations in

1008

self._get_all_dbus_things("interface")

1009

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

1010

)).items():

1011

ann_tag = document.createElement("annotation")

1012

ann_tag.setAttribute("name", annotation)

1013

ann_tag.setAttribute("value", value)

1014

if_tag.appendChild(ann_tag)

1539

1015

# Add the names to the return values for the

1540

1016

# "org.freedesktop.DBus.Properties" methods

1541

1017

if (if_tag.getAttribute("name")

1555

1031

document.unlink()

1556

1032

except (AttributeError, xml.dom.DOMException,

1557

1033

xml.parsers.expat.ExpatError) as error:

1558

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

1559

exc_info=error)

1560

return xmlstring

1561

1562

1563

try:

1564

dbus.OBJECT_MANAGER_IFACE

1565

except AttributeError:

1566

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

1567

1568

1569

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1570

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

1571

1572

Classes inheriting from this exposes the standard

1573

GetManagedObjects call and the InterfacesAdded and

1574

InterfacesRemoved signals on the standard

1575

"org.freedesktop.DBus.ObjectManager" interface.

1576

1577

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

1578

manually.

1579

"""

1580

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1581

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

1582

def GetManagedObjects(self):

1583

"""This function must be overridden"""

1584

raise NotImplementedError()

1585

1586

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1587

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

1588

def InterfacesAdded(self, object_path, interfaces_and_properties):

1589

pass

1590

1591

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

1592

def InterfacesRemoved(self, object_path, interfaces):

1593

pass

1594

1595

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1596

out_signature="s",

1597

path_keyword="object_path",

1598

connection_keyword="connection")

1599

def Introspect(self, object_path, connection):

1600

"""Overloading of standard D-Bus method.

1601

1602

Override return argument name of GetManagedObjects to be

1603

"objpath_interfaces_and_properties"

1604

"""

1605

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1606

object_path,

1607

connection)

1608

try:

1609

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

1610

1611

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

1612

# Fix argument name for the GetManagedObjects method

1613

if (if_tag.getAttribute("name")

1614

== dbus.OBJECT_MANAGER_IFACE):

1615

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

1616

if (cn.getAttribute("name")

1617

== "GetManagedObjects"):

1618

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

1619

if (arg.getAttribute("direction")

1620

== "out"):

1621

arg.setAttribute(

1622

"name",

1623

"objpath_interfaces"

1624

"_and_properties")

1625

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

1626

document.unlink()

1627

except (AttributeError, xml.dom.DOMException,

1628

xml.parsers.expat.ExpatError) as error:

1629

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

1630

exc_info=error)

1034

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

1035

exc_info=error)

1631

1036

return xmlstring

1632

1037

1633

1038

1634

1039

def datetime_to_dbus(dt, variant_level=0):

1635

1040

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

1636

1041

if dt is None:

1637

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

1638

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

1042

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

1043

return dbus.String(dt.isoformat(),

1044

variant_level=variant_level)

1639

1045

1640

1046

1641

1047

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1643

1049

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

1644

1050

interface names according to the "alt_interface_names" mapping.

1645

1051

Usage:

1646

1052

1647

1053

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

1648

1054

"net.example.AlternateInterface"})

1649

1055

class SampleDBusObject(dbus.service.Object):

1650

1056

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

1651

1057

def SampleDBusMethod():

1652

1058

pass

1653

1059

1654

1060

The above "SampleDBusMethod" on "SampleDBusObject" will be

1655

1061

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

1656

1062

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

1657

1063

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

1658

1064

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

1659

1065

1660

1066

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

1661

1067

(from DBusObjectWithProperties) and interfaces (from the

1662

1068

dbus_interface_annotations decorator).

1663

1069

"""

1664

1665

1070

def wrapper(cls):

1666

1071

for orig_interface_name, alt_interface_name in (

1667

alt_interface_names.items()):

1072

alt_interface_names.items()):

1668

1073

attr = {}

1669

1074

interface_names = set()

1670

1075

# Go though all attributes of the class

1672

1077

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

1673

1078

# with the wrong interface name

1674

1079

if (not hasattr(attribute, "_dbus_interface")

1675

or not attribute._dbus_interface.startswith(

1676

orig_interface_name)):

1080

or not attribute._dbus_interface

1081

.startswith(orig_interface_name)):

1677

1082

continue

1678

1083

# Create an alternate D-Bus interface name based on

1679

1084

# the current name

1680

alt_interface = attribute._dbus_interface.replace(

1681

orig_interface_name, alt_interface_name)

1085

alt_interface = (attribute._dbus_interface

1086

.replace(orig_interface_name,

1087

alt_interface_name))

1682

1088

interface_names.add(alt_interface)

1683

1089

# Is this a D-Bus signal?

1684

1090

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

1685

1091

# Extract the original non-method undecorated

1686

1092

# function by black magic

1687

if sys.version_info.major == 2:

1688

nonmethod_func = (dict(

1093

nonmethod_func = (dict(

1689

1094

zip(attribute.func_code.co_freevars,

1690

attribute.__closure__))

1691

["func"].cell_contents)

1692

else:

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1095

attribute.__closure__))["func"]

1096

.cell_contents)

1697

1097

# Create a new, but exactly alike, function

1698

1098

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

1699

1099

# with the alternate D-Bus interface name

1700

new_function = copy_function(nonmethod_func)

1701

new_function = (dbus.service.signal(

1702

alt_interface,

1703

attribute._dbus_signature)(new_function))

1100

new_function = (dbus.service.signal

1101

(alt_interface,

1102

attribute._dbus_signature)

1103

(types.FunctionType(

1104

nonmethod_func.func_code,

1105

nonmethod_func.func_globals,

1106

nonmethod_func.func_name,

1107

nonmethod_func.func_defaults,

1108

nonmethod_func.func_closure)))

1704

1109

# Copy annotations, if any

1705

1110

try:

1706

new_function._dbus_annotations = dict(

1707

attribute._dbus_annotations)

1111

new_function._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1708

1113

except AttributeError:

1709

1114

pass

1710

1711

1115

# Define a creator of a function to call both the

1712

1116

# original and alternate functions, so both the

1713

1117

# original and alternate signals gets sent when

1716

1120

"""This function is a scope container to pass

1717

1121

func1 and func2 to the "call_both" function

1718

1122

outside of its arguments"""

1719

1720

@functools.wraps(func2)

1721

1123

def call_both(*args, **kwargs):

1722

1124

"""This function will emit two D-Bus

1723

1125

signals by calling func1 and func2"""

1724

1126

func1(*args, **kwargs)

1725

1127

func2(*args, **kwargs)

1726

# Make wrapper function look like a D-Bus

1727

# signal

1728

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

1729

if name.startswith("_dbus_"):

1730

setattr(call_both, name, attr)

1731

1732

1128

return call_both

1733

1129

# Create the "call_both" function and add it to

1734

1130

# the class

1739

1135

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

1740

1136

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

1741

1137

# to the class.

1742

attr[attrname] = (

1743

dbus.service.method(

1744

alt_interface,

1745

attribute._dbus_in_signature,

1746

attribute._dbus_out_signature)

1747

(copy_function(attribute)))

1138

attr[attrname] = (dbus.service.method

1139

(alt_interface,

1140

attribute._dbus_in_signature,

1141

attribute._dbus_out_signature)

1142

(types.FunctionType

1143

(attribute.func_code,

1144

attribute.func_globals,

1145

attribute.func_name,

1146

attribute.func_defaults,

1147

attribute.func_closure)))

1748

1148

# Copy annotations, if any

1749

1149

try:

1750

attr[attrname]._dbus_annotations = dict(

1751

attribute._dbus_annotations)

1150

attr[attrname]._dbus_annotations = (

1151

dict(attribute._dbus_annotations))

1752

1152

except AttributeError:

1753

1153

pass

1754

1154

# Is this a D-Bus property?

1757

1157

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

1758

1158

# property with the alternate D-Bus interface

1759

1159

# name. Add it to the class.

1760

attr[attrname] = (dbus_service_property(

1761

alt_interface, attribute._dbus_signature,

1762

attribute._dbus_access,

1763

attribute._dbus_get_args_options

1764

["byte_arrays"])

1765

(copy_function(attribute)))

1160

attr[attrname] = (dbus_service_property

1161

(alt_interface,

1162

attribute._dbus_signature,

1163

attribute._dbus_access,

1164

attribute

1165

._dbus_get_args_options

1166

["byte_arrays"])

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1766

1173

# Copy annotations, if any

1767

1174

try:

1768

attr[attrname]._dbus_annotations = dict(

1769

attribute._dbus_annotations)

1175

attr[attrname]._dbus_annotations = (

1176

dict(attribute._dbus_annotations))

1770

1177

except AttributeError:

1771

1178

pass

1772

1179

# Is this a D-Bus interface?

1775

1182

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

1776

1183

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

1777

1184

# to the class.

1778

attr[attrname] = (

1779

dbus_interface_annotations(alt_interface)

1780

(copy_function(attribute)))

1185

attr[attrname] = (dbus_interface_annotations

1186

(alt_interface)

1187

(types.FunctionType

1188

(attribute.func_code,

1189

attribute.func_globals,

1190

attribute.func_name,

1191

attribute.func_defaults,

1192

attribute.func_closure)))

1781

1193

if deprecate:

1782

1194

# Deprecate all alternate interfaces

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1195

iname="_AlternateDBusNames_interface_annotation{}"

1784

1196

for interface_name in interface_names:

1785

1786

1197

@dbus_interface_annotations(interface_name)

1787

1198

def func(self):

1788

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

1789

"true"}

1199

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

1200

"true" }

1790

1201

# Find an unused name

1791

1202

for aname in (iname.format(i)

1792

1203

for i in itertools.count()):

1796

1207

if interface_names:

1797

1208

# Replace the class with a new subclass of it with

1798

1209

# methods, signals, etc. as created above.

1799

if sys.version_info.major == 2:

1800

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

1801

(cls, ), attr)

1802

else:

1803

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

1804

(cls, ), attr)

1210

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

1211

(cls,), attr)

1805

1212

return cls

1806

1807

1213

return wrapper

1808

1214

1809

1215

1810

1216

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

1811

"se.bsnet.fukt.Mandos"})

1217

"se.bsnet.fukt.Mandos"})

1812

1218

class ClientDBus(Client, DBusObjectWithProperties):

1813

1219

"""A Client class using D-Bus

1814

1220

1815

1221

Attributes:

1816

1222

dbus_object_path: dbus.ObjectPath

1817

1223

bus: dbus.SystemBus()

1818

1224

"""

1819

1225

1820

1226

runtime_expansions = (Client.runtime_expansions

1821

+ ("dbus_object_path", ))

1822

1227

+ ("dbus_object_path",))

1228

1823

1229

_interface = "se.recompile.Mandos.Client"

1824

1230

1825

1231

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

1826

1827

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

1232

1233

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

1828

1234

self.bus = bus

1829

1235

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

1830

1236

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

1832

1238

client_object_name = str(self.name).translate(

1833

1239

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

1834

1240

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

1835

self.dbus_object_path = dbus.ObjectPath(

1836

"/clients/" + client_object_name)

1241

self.dbus_object_path = (dbus.ObjectPath

1242

("/clients/" + client_object_name))

1837

1243

DBusObjectWithProperties.__init__(self, self.bus,

1838

1244

self.dbus_object_path)

1839

1840

def notifychangeproperty(transform_func, dbus_name,

1841

type_func=lambda x: x,

1842

variant_level=1,

1843

invalidate_only=False,

1245

1246

def notifychangeproperty(transform_func,

1247

dbus_name, type_func=lambda x: x,

1248

variant_level=1, invalidate_only=False,

1844

1249

_interface=_interface):

1845

1250

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

1846

1251

its changes to DBus.

1847

1252

1848

1253

transform_fun: Function that takes a value and a variant_level

1849

1254

and transforms it to a D-Bus type.

1850

1255

dbus_name: D-Bus name of the variable

1853

1258

variant_level: D-Bus variant level. Default: 1

1854

1259

"""

1855

1260

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

1856

1857

1261

def setter(self, value):

1858

1262

if hasattr(self, "dbus_object_path"):

1859

1263

if (not hasattr(self, attrname) or

1860

1264

type_func(getattr(self, attrname, None))

1861

1265

!= type_func(value)):

1862

1266

if invalidate_only:

1863

self.PropertiesChanged(

1864

_interface, dbus.Dictionary(),

1865

dbus.Array((dbus_name, )))

1267

self.PropertiesChanged(_interface,

1268

dbus.Dictionary(),

1269

dbus.Array

1270

((dbus_name,)))

1866

1271

else:

1867

dbus_value = transform_func(

1868

type_func(value),

1869

variant_level=variant_level)

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1870

1275

self.PropertyChanged(dbus.String(dbus_name),

1871

1276

dbus_value)

1872

self.PropertiesChanged(

1873

_interface,

1874

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

1875

dbus_value}),

1876

dbus.Array())

1277

self.PropertiesChanged(_interface,

1278

dbus.Dictionary({

1279

dbus.String(dbus_name):

1280

dbus_value }), dbus.Array())

1877

1281

setattr(self, attrname, value)

1878

1282

1879

1283

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

1880

1284

1881

1285

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1882

1286

approvals_pending = notifychangeproperty(dbus.Boolean,

1883

1287

"ApprovalPending",

1884

type_func=bool)

1288

type_func = bool)

1885

1289

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

1886

1290

last_enabled = notifychangeproperty(datetime_to_dbus,

1887

1291

"LastEnabled")

1888

checker = notifychangeproperty(

1889

dbus.Boolean, "CheckerRunning",

1890

type_func=lambda checker: checker is not None)

1292

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

1293

type_func = lambda checker:

1294

checker is not None)

1891

1295

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1892

1296

"LastCheckedOK")

1893

1297

last_checker_status = notifychangeproperty(dbus.Int16,

1896

1300

datetime_to_dbus, "LastApprovalRequest")

1897

1301

approved_by_default = notifychangeproperty(dbus.Boolean,

1898

1302

"ApprovedByDefault")

1899

approval_delay = notifychangeproperty(

1900

dbus.UInt64, "ApprovalDelay",

1901

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

1303

approval_delay = notifychangeproperty(dbus.UInt64,

1304

"ApprovalDelay",

1305

type_func =

1306

lambda td: td.total_seconds()

1307

* 1000)

1902

1308

approval_duration = notifychangeproperty(

1903

1309

dbus.UInt64, "ApprovalDuration",

1904

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

1310

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

1905

1311

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

1906

timeout = notifychangeproperty(

1907

dbus.UInt64, "Timeout",

1908

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

1312

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

1313

type_func = lambda td:

1314

td.total_seconds() * 1000)

1909

1315

extended_timeout = notifychangeproperty(

1910

1316

dbus.UInt64, "ExtendedTimeout",

1911

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

1912

interval = notifychangeproperty(

1913

dbus.UInt64, "Interval",

1914

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

1317

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

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

lambda td: td.total_seconds()

1322

* 1000)

1915

1323

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

1916

1324

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

1917

1325

invalidate_only=True)

1918

1326

1919

1327

del notifychangeproperty

1920

1328

1921

1329

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

1922

1330

try:

1923

1331

self.remove_from_connection()

1926

1334

if hasattr(DBusObjectWithProperties, "__del__"):

1927

1335

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

1928

1336

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

1929

1930

def checker_callback(self, source, condition,

1931

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

1932

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

1933

connection, command, *args,

1934

**kwargs)

1935

exitstatus = self.last_checker_status

1936

if exitstatus >= 0:

1337

1338

def checker_callback(self, pid, condition, command,

1339

*args, **kwargs):

1340

self.checker_callback_tag = None

1341

self.checker = None

1342

if os.WIFEXITED(condition):

1343

exitstatus = os.WEXITSTATUS(condition)

1937

1344

# Emit D-Bus signal

1938

1345

self.CheckerCompleted(dbus.Int16(exitstatus),

1939

# This is specific to GNU libC

1940

dbus.Int64(exitstatus << 8),

1346

dbus.Int64(condition),

1941

1347

dbus.String(command))

1942

1348

else:

1943

1349

# Emit D-Bus signal

1944

1350

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

1945

dbus.Int64(

1946

# This is specific to GNU libC

1947

(exitstatus << 8)

1948

| self.last_checker_signal),

1351

dbus.Int64(condition),

1949

1352

dbus.String(command))

1950

return ret

1951

1353

1354

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

1355

*args, **kwargs)

1356

1952

1357

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

1953

1358

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

1954

1359

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

1958

1363

# Emit D-Bus signal

1959

1364

self.CheckerStarted(self.current_checker_command)

1960

1365

return r

1961

1366

1962

1367

def _reset_approved(self):

1963

1368

self.approved = None

1964

1369

return False

1965

1370

1966

1371

def approve(self, value=True):

1967

1372

self.approved = value

1968

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

1969

* 1000), self._reset_approved)

1373

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

1374

* 1000), self._reset_approved)

1970

1375

self.send_changedstate()

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1376

1377

## D-Bus methods, signals & properties

1378

1379

## Interfaces

1380

1381

## Signals

1382

1978

1383

# CheckerCompleted - signal

1979

1384

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

1980

1385

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

1981

1386

"D-Bus signal"

1982

1387

pass

1983

1388

1984

1389

# CheckerStarted - signal

1985

1390

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

1986

1391

def CheckerStarted(self, command):

1987

1392

"D-Bus signal"

1988

1393

pass

1989

1394

1990

1395

# PropertyChanged - signal

1991

1396

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

1992

1397

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

1993

1398

def PropertyChanged(self, property, value):

1994

1399

"D-Bus signal"

1995

1400

pass

1996

1401

1997

1402

# GotSecret - signal

1998

1403

@dbus.service.signal(_interface)

1999

1404

def GotSecret(self):

2002

1407

server to mandos-client

2003

1408

"""

2004

1409

pass

2005

1410

2006

1411

# Rejected - signal

2007

1412

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

2008

1413

def Rejected(self, reason):

2009

1414

"D-Bus signal"

2010

1415

pass

2011

1416

2012

1417

# NeedApproval - signal

2013

1418

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

2014

1419

def NeedApproval(self, timeout, default):

2015

1420

"D-Bus signal"

2016

1421

return self.need_approval()

2017

2018

# Methods

2019

1422

1423

## Methods

1424

2020

1425

# Approve - method

2021

1426

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

2022

1427

def Approve(self, value):

2023

1428

self.approve(value)

2024

1429

2025

1430

# CheckedOK - method

2026

1431

@dbus.service.method(_interface)

2027

1432

def CheckedOK(self):

2028

1433

self.checked_ok()

2029

1434

2030

1435

# Enable - method

2031

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

2032

1436

@dbus.service.method(_interface)

2033

1437

def Enable(self):

2034

1438

"D-Bus method"

2035

1439

self.enable()

2036

1440

2037

1441

# StartChecker - method

2038

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

2039

1442

@dbus.service.method(_interface)

2040

1443

def StartChecker(self):

2041

1444

"D-Bus method"

2042

1445

self.start_checker()

2043

1446

2044

1447

# Disable - method

2045

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

2046

1448

@dbus.service.method(_interface)

2047

1449

def Disable(self):

2048

1450

"D-Bus method"

2049

1451

self.disable()

2050

1452

2051

1453

# StopChecker - method

2052

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

2053

1454

@dbus.service.method(_interface)

2054

1455

def StopChecker(self):

2055

1456

self.stop_checker()

2056

2057

# Properties

2058

1457

1458

## Properties

1459

2059

1460

# ApprovalPending - property

2060

1461

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

2061

1462

def ApprovalPending_dbus_property(self):

2062

1463

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

2063

1464

2064

1465

# ApprovedByDefault - property

2065

@dbus_service_property(_interface,

2066

signature="b",

1466

@dbus_service_property(_interface, signature="b",

2067

1467

access="readwrite")

2068

1468

def ApprovedByDefault_dbus_property(self, value=None):

2069

1469

if value is None: # get

2070

1470

return dbus.Boolean(self.approved_by_default)

2071

1471

self.approved_by_default = bool(value)

2072

1472

2073

1473

# ApprovalDelay - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1474

@dbus_service_property(_interface, signature="t",

2076

1475

access="readwrite")

2077

1476

def ApprovalDelay_dbus_property(self, value=None):

2078

1477

if value is None: # get

2079

1478

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

2080

1479

* 1000)

2081

1480

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

2082

1481

2083

1482

# ApprovalDuration - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1483

@dbus_service_property(_interface, signature="t",

2086

1484

access="readwrite")

2087

1485

def ApprovalDuration_dbus_property(self, value=None):

2088

1486

if value is None: # get

2089

1487

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

2090

1488

* 1000)

2091

1489

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

2092

1490

2093

1491

# Name - property

2094

@dbus_annotations(

2095

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

2096

1492

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

2097

1493

def Name_dbus_property(self):

2098

1494

return dbus.String(self.name)

2099

2100

# KeyID - property

2101

@dbus_annotations(

2102

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

2103

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

2104

def KeyID_dbus_property(self):

2105

return dbus.String(self.key_id)

2106

1495

2107

1496

# Fingerprint - property

2108

@dbus_annotations(

2109

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

2110

1497

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

2111

1498

def Fingerprint_dbus_property(self):

2112

1499

return dbus.String(self.fingerprint)

2113

1500

2114

1501

# Host - property

2115

@dbus_service_property(_interface,

2116

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2117

1503

access="readwrite")

2118

1504

def Host_dbus_property(self, value=None):

2119

1505

if value is None: # get

2120

1506

return dbus.String(self.host)

2121

1507

self.host = str(value)

2122

1508

2123

1509

# Created - property

2124

@dbus_annotations(

2125

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

2126

1510

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

2127

1511

def Created_dbus_property(self):

2128

1512

return datetime_to_dbus(self.created)

2129

1513

2130

1514

# LastEnabled - property

2131

1515

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

2132

1516

def LastEnabled_dbus_property(self):

2133

1517

return datetime_to_dbus(self.last_enabled)

2134

1518

2135

1519

# Enabled - property

2136

@dbus_service_property(_interface,

2137

signature="b",

1520

@dbus_service_property(_interface, signature="b",

2138

1521

access="readwrite")

2139

1522

def Enabled_dbus_property(self, value=None):

2140

1523

if value is None: # get

2143

1526

self.enable()

2144

1527

else:

2145

1528

self.disable()

2146

1529

2147

1530

# LastCheckedOK - property

2148

@dbus_service_property(_interface,

2149

signature="s",

1531

@dbus_service_property(_interface, signature="s",

2150

1532

access="readwrite")

2151

1533

def LastCheckedOK_dbus_property(self, value=None):

2152

1534

if value is not None:

2153

1535

self.checked_ok()

2154

1536

return

2155

1537

return datetime_to_dbus(self.last_checked_ok)

2156

1538

2157

1539

# LastCheckerStatus - property

2158

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

1540

@dbus_service_property(_interface, signature="n",

1541

access="read")

2159

1542

def LastCheckerStatus_dbus_property(self):

2160

1543

return dbus.Int16(self.last_checker_status)

2161

1544

2162

1545

# Expires - property

2163

1546

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

2164

1547

def Expires_dbus_property(self):

2165

1548

return datetime_to_dbus(self.expires)

2166

1549

2167

1550

# LastApprovalRequest - property

2168

1551

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

2169

1552

def LastApprovalRequest_dbus_property(self):

2170

1553

return datetime_to_dbus(self.last_approval_request)

2171

1554

2172

1555

# Timeout - property

2173

@dbus_service_property(_interface,

2174

signature="t",

1556

@dbus_service_property(_interface, signature="t",

2175

1557

access="readwrite")

2176

1558

def Timeout_dbus_property(self, value=None):

2177

1559

if value is None: # get

2189

1571

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

2190

1572

is None):

2191

1573

return

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

2194

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

2195

self.disable)

2196

1574

gobject.source_remove(self.disable_initiator_tag)

1575

self.disable_initiator_tag = (

1576

gobject.timeout_add(

1577

int((self.expires - now).total_seconds()

1578

* 1000), self.disable))

1579

2197

1580

# ExtendedTimeout - property

2198

@dbus_service_property(_interface,

2199

signature="t",

1581

@dbus_service_property(_interface, signature="t",

2200

1582

access="readwrite")

2201

1583

def ExtendedTimeout_dbus_property(self, value=None):

2202

1584

if value is None: # get

2203

1585

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

2204

1586

* 1000)

2205

1587

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

2206

1588

2207

1589

# Interval - property

2208

@dbus_service_property(_interface,

2209

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2210

1591

access="readwrite")

2211

1592

def Interval_dbus_property(self, value=None):

2212

1593

if value is None: # get

2216

1597

return

2217

1598

if self.enabled:

2218

1599

# Reschedule checker run

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

2221

value, self.start_checker)

2222

self.start_checker() # Start one now, too

2223

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2224

1605

# Checker - property

2225

@dbus_service_property(_interface,

2226

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2227

1607

access="readwrite")

2228

1608

def Checker_dbus_property(self, value=None):

2229

1609

if value is None: # get

2230

1610

return dbus.String(self.checker_command)

2231

1611

self.checker_command = str(value)

2232

1612

2233

1613

# CheckerRunning - property

2234

@dbus_service_property(_interface,

2235

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2236

1615

access="readwrite")

2237

1616

def CheckerRunning_dbus_property(self, value=None):

2238

1617

if value is None: # get

2241

1620

self.start_checker()

2242

1621

else:

2243

1622

self.stop_checker()

2244

1623

2245

1624

# ObjectPath - property

2246

@dbus_annotations(

2247

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

2248

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

2249

1625

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

2250

1626

def ObjectPath_dbus_property(self):

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2253

1629

# Secret = property

2254

@dbus_annotations(

2255

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

2256

"invalidates"})

2257

@dbus_service_property(_interface,

2258

signature="ay",

2259

access="write",

2260

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2261

1632

def Secret_dbus_property(self, value):

2262

1633

self.secret = bytes(value)

2263

1634

2264

1635

del _interface

2265

1636

2266

1637

2267

class ProxyClient:

2268

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

1638

class ProxyClient(object):

1639

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

2269

1640

self._pipe = child_pipe

2270

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

1641

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

2271

1642

if not self._pipe.recv():

2272

raise KeyError(key_id or fpr)

2273

1643

raise KeyError()

1644

2274

1645

def __getattribute__(self, name):

2275

if name == "_pipe":

1646

if name == '_pipe':

2276

1647

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

2277

self._pipe.send(("getattr", name))

1648

self._pipe.send(('getattr', name))

2278

1649

data = self._pipe.recv()

2279

if data[0] == "data":

1650

if data[0] == 'data':

2280

1651

return data[1]

2281

if data[0] == "function":

2282

1652

if data[0] == 'function':

2283

1653

def func(*args, **kwargs):

2284

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

1654

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

2285

1655

return self._pipe.recv()[1]

2286

2287

1656

return func

2288

1657

2289

1658

def __setattr__(self, name, value):

2290

if name == "_pipe":

1659

if name == '_pipe':

2291

1660

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

2292

self._pipe.send(("setattr", name, value))

1661

self._pipe.send(('setattr', name, value))

2293

1662

2294

1663

2295

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2296

1665

"""A class to handle client connections.

2297

1666

2298

1667

Instantiated once for each connection to handle it.

2299

1668

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

2300

1669

2301

1670

def handle(self):

2302

1671

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

2303

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

2304

str(self.client_address))

2305

log.debug("Pipe FD: %d", self.server.child_pipe.fileno())

2306

2307

session = gnutls.ClientSession(self.request)

2308

2309

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

2310

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

2311

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

2312

# "+DHE-DSS"))

1672

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

1673

str(self.client_address))

1674

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

1675

self.server.child_pipe.fileno())

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2313

1691

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

2314

1692

priority = self.server.gnutls_priority

2315

1693

if priority is None:

2316

1694

priority = "NORMAL"

2317

gnutls.priority_set_direct(session,

2318

priority.encode("utf-8"), None)

2319

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2320

1699

# Start communication using the Mandos protocol

2321

1700

# Get protocol number

2322

1701

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

2323

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

1702

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

2324

1703

try:

2325

1704

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

2326

1705

raise RuntimeError(line)

2327

1706

except (ValueError, IndexError, RuntimeError) as error:

2328

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

1707

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

2329

1708

return

2330

1709

2331

1710

# Start GnuTLS connection

2332

1711

try:

2333

1712

session.handshake()

2334

except gnutls.Error as error:

2335

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

1713

except gnutls.errors.GNUTLSError as error:

1714

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

2336

1715

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

2337

1716

# established. Just abandon the request.

2338

1717

return

2339

log.debug("Handshake succeeded")

2340

1718

logger.debug("Handshake succeeded")

1719

2341

1720

approval_required = False

2342

1721

try:

2343

if gnutls.has_rawpk:

2344

fpr = b""

2345

try:

2346

key_id = self.key_id(

2347

self.peer_certificate(session))

2348

except (TypeError, gnutls.Error) as error:

2349

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

2350

return

2351

log.debug("Key ID: %s",

2352

key_id.decode("utf-8",

2353

errors="replace"))

2354

2355

else:

2356

key_id = b""

2357

try:

2358

fpr = self.fingerprint(

2359

self.peer_certificate(session))

2360

except (TypeError, gnutls.Error) as error:

2361

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

2362

return

2363

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

2364

2365

try:

2366

client = ProxyClient(child_pipe, key_id, fpr,

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

2367

1733

self.client_address)

2368

1734

except KeyError:

2369

1735

return

2370

1736

2371

1737

if client.approval_delay:

2372

1738

delay = client.approval_delay

2373

1739

client.approvals_pending += 1

2374

1740

approval_required = True

2375

1741

2376

1742

while True:

2377

1743

if not client.enabled:

2378

log.info("Client %s is disabled", client.name)

1744

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

1745

client.name)

2379

1746

if self.server.use_dbus:

2380

1747

# Emit D-Bus signal

2381

1748

client.Rejected("Disabled")

2382

1749

return

2383

1750

2384

1751

if client.approved or not client.approval_delay:

2385

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2386

1753

break

2387

1754

elif client.approved is None:

2388

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

2389

client.name)

1755

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

1756

client.name)

2390

1757

if self.server.use_dbus:

2391

1758

# Emit D-Bus signal

2392

1759

client.NeedApproval(

2393

1760

client.approval_delay.total_seconds()

2394

1761

* 1000, client.approved_by_default)

2395

1762

else:

2396

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

2397

client.name)

1763

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

1764

client.name)

2398

1765

if self.server.use_dbus:

2399

1766

# Emit D-Bus signal

2400

1767

client.Rejected("Denied")

2401

1768

return

2402

2403

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2404

1771

time = datetime.datetime.now()

2405

1772

client.changedstate.acquire()

2406

1773

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

2408

1775

time2 = datetime.datetime.now()

2409

1776

if (time2 - time) >= delay:

2410

1777

if not client.approved_by_default:

2411

log.warning("Client %s timed out while"

2412

" waiting for approval",

2413

client.name)

1778

logger.warning("Client %s timed out while"

1779

" waiting for approval",

1780

client.name)

2414

1781

if self.server.use_dbus:

2415

1782

# Emit D-Bus signal

2416

1783

client.Rejected("Approval timed out")

2419

1786

break

2420

1787

else:

2421

1788

delay -= time2 - time

2422

2423

try:

2424

session.send(client.secret)

2425

except gnutls.Error as error:

2426

log.warning("gnutls send failed", exc_info=error)

2427

return

2428

2429

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

1789

1790

sent_size = 0

1791

while sent_size < len(client.secret):

1792

try:

1793

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

1794

except gnutls.errors.GNUTLSError as error:

1795

logger.warning("gnutls send failed",

1796

exc_info=error)

1797

return

1798

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

1799

sent, len(client.secret)

1800

- (sent_size + sent))

1801

sent_size += sent

1802

1803

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

2430

1804

# bump the timeout using extended_timeout

2431

1805

client.bump_timeout(client.extended_timeout)

2432

1806

if self.server.use_dbus:

2433

1807

# Emit D-Bus signal

2434

1808

client.GotSecret()

2435

1809

2436

1810

finally:

2437

1811

if approval_required:

2438

1812

client.approvals_pending -= 1

2439

1813

try:

2440

1814

session.bye()

2441

except gnutls.Error as error:

2442

log.warning("GnuTLS bye failed", exc_info=error)

2443

1815

except gnutls.errors.GNUTLSError as error:

1816

logger.warning("GnuTLS bye failed",

1817

exc_info=error)

1818

2444

1819

@staticmethod

2445

1820

def peer_certificate(session):

2446

"Return the peer's certificate as a bytestring"

2447

try:

2448

cert_type = gnutls.certificate_type_get2(

2449

session, gnutls.CTYPE_PEERS)

2450

except AttributeError:

2451

cert_type = gnutls.certificate_type_get(session)

2452

if gnutls.has_rawpk:

2453

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2454

else:

2455

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2456

# If not a valid certificate type...

2457

if cert_type not in valid_cert_types:

2458

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

2459

valid_cert_types)

2460

# ...return invalid data

2461

return b""

1821

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

1822

# If not an OpenPGP certificate...

1823

if (gnutls.library.functions

1824

.gnutls_certificate_type_get(session._c_object)

1825

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1826

# ...do the normal thing

1827

return session.peer_certificate

2462

1828

list_size = ctypes.c_uint(1)

2463

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

1829

cert_list = (gnutls.library.functions

1830

.gnutls_certificate_get_peers

1831

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

2465

1832

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

2466

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

1833

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

1834

" certificate")

2467

1835

if list_size.value == 0:

2468

1836

return None

2469

1837

cert = cert_list[0]

2470

1838

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

2471

2472

@staticmethod

2473

def key_id(certificate):

2474

"Convert a certificate bytestring to a hexdigit key ID"

2475

# New GnuTLS "datum" with the public key

2476

datum = gnutls.datum_t(

2477

ctypes.cast(ctypes.c_char_p(certificate),

2478

ctypes.POINTER(ctypes.c_ubyte)),

2479

ctypes.c_uint(len(certificate)))

2480

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

2481

# New empty GnuTLS certificate

2482

pubkey = gnutls.pubkey_t()

2483

gnutls.pubkey_init(ctypes.byref(pubkey))

2484

# Import the raw public key into the certificate

2485

gnutls.pubkey_import(pubkey,

2486

ctypes.byref(datum),

2487

gnutls.X509_FMT_DER)

2488

# New buffer for the key ID

2489

buf = ctypes.create_string_buffer(32)

2490

buf_len = ctypes.c_size_t(len(buf))

2491

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

2492

gnutls.pubkey_get_key_id(

2493

pubkey,

2494

gnutls.KEYID_USE_SHA256,

2495

ctypes.cast(ctypes.byref(buf),

2496

ctypes.POINTER(ctypes.c_ubyte)),

2497

ctypes.byref(buf_len))

2498

# Deinit the certificate

2499

gnutls.pubkey_deinit(pubkey)

2500

2501

# Convert the buffer to a Python bytestring

2502

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

2503

# Convert the bytestring to hexadecimal notation

2504

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

2505

return hex_key_id

2506

1839

2507

1840

@staticmethod

2508

1841

def fingerprint(openpgp):

2509

1842

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2510

1843

# New GnuTLS "datum" with the OpenPGP public key

2511

datum = gnutls.datum_t(

2512

ctypes.cast(ctypes.c_char_p(openpgp),

2513

ctypes.POINTER(ctypes.c_ubyte)),

2514

ctypes.c_uint(len(openpgp)))

1844

datum = (gnutls.library.types

1845

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

1846

ctypes.POINTER

1847

(ctypes.c_ubyte)),

1848

ctypes.c_uint(len(openpgp))))

2515

1849

# New empty GnuTLS certificate

2516

crt = gnutls.openpgp_crt_t()

2517

gnutls.openpgp_crt_init(ctypes.byref(crt))

1850

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1851

(gnutls.library.functions

1852

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2518

1853

# Import the OpenPGP public key into the certificate

2519

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

2520

gnutls.OPENPGP_FMT_RAW)

1854

(gnutls.library.functions

1855

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

1856

gnutls.library.constants

1857

.GNUTLS_OPENPGP_FMT_RAW))

2521

1858

# Verify the self signature in the key

2522

1859

crtverify = ctypes.c_uint()

2523

gnutls.openpgp_crt_verify_self(crt, 0,

2524

ctypes.byref(crtverify))

1860

(gnutls.library.functions

1861

.gnutls_openpgp_crt_verify_self(crt, 0,

1862

ctypes.byref(crtverify)))

2525

1863

if crtverify.value != 0:

2526

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

1864

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1865

raise (gnutls.errors.CertificateSecurityError

1866

("Verify failed"))

2529

1867

# New buffer for the fingerprint

2530

1868

buf = ctypes.create_string_buffer(20)

2531

1869

buf_len = ctypes.c_size_t()

2532

1870

# Get the fingerprint from the certificate into the buffer

2533

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

2534

ctypes.byref(buf_len))

1871

(gnutls.library.functions

1872

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

1873

ctypes.byref(buf_len)))

2535

1874

# Deinit the certificate

2536

gnutls.openpgp_crt_deinit(crt)

1875

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2537

1876

# Convert the buffer to a Python bytestring

2538

1877

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

2539

1878

# Convert the bytestring to hexadecimal notation

2541

1880

return hex_fpr

2542

1881

2543

1882

2544

class MultiprocessingMixIn:

1883

class MultiprocessingMixIn(object):

2545

1884

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

2546

2547

1885

def sub_process_main(self, request, address):

2548

1886

try:

2549

1887

self.finish_request(request, address)

2550

1888

except Exception:

2551

1889

self.handle_error(request, address)

2552

1890

self.close_request(request)

2553

1891

2554

1892

def process_request(self, request, address):

2555

1893

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

2556

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

2557

args=(request, address))

1894

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

1895

args = (request, address))

2558

1896

proc.start()

2559

1897

return proc

2560

1898

2561

1899

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1900

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2563

1901

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

2564

2565

1902

def process_request(self, request, client_address):

2566

1903

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

2567

1904

2568

1905

This function creates a new pipe in self.pipe

2569

1906

"""

2570

1907

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2571

1908

2572

1909

proc = MultiprocessingMixIn.process_request(self, request,

2573

1910

client_address)

2574

1911

self.child_pipe.close()

2575

1912

self.add_pipe(parent_pipe, proc)

2576

1913

2577

1914

def add_pipe(self, parent_pipe, proc):

2578

1915

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

2579

1916

raise NotImplementedError()

2580

1917

2581

1918

2582

1919

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2583

socketserver.TCPServer):

2584

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

2585

1920

socketserver.TCPServer, object):

1921

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

1922

2586

1923

Attributes:

2587

1924

enabled: Boolean; whether this server is activated yet

2588

1925

interface: None or a network interface name (string)

2589

1926

use_ipv6: Boolean; to use IPv6 or not

2590

1927

"""

2591

2592

1928

def __init__(self, server_address, RequestHandlerClass,

2593

interface=None,

2594

use_ipv6=True,

2595

socketfd=None):

1929

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

2596

1930

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

2597

1931

creating a new one with socket.socket().

2598

1932

"""

2604

1938

self.socketfd = socketfd

2605

1939

# Save the original socket.socket() function

2606

1940

self.socket_socket = socket.socket

2607

2608

1941

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

2609

#

1942

#

2610

1943

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

2611

1944

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

2612

1945

# patching socket.socket.)

2613

#

1946

#

2614

1947

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

2615

1948

@functools.wraps(socket.socket)

2616

1949

def socket_wrapper(*args, **kwargs):

2628

1961

# socket_wrapper(), if socketfd was set.

2629

1962

socketserver.TCPServer.__init__(self, server_address,

2630

1963

RequestHandlerClass)

2631

1964

2632

1965

def server_bind(self):

2633

1966

"""This overrides the normal server_bind() function

2634

1967

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

2635

1968

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

2636

global SO_BINDTODEVICE

2637

1969

if self.interface is not None:

2638

1970

if SO_BINDTODEVICE is None:

2639

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

2640

# common enough.

2641

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

2642

SO_BINDTODEVICE = 25

2643

try:

2644

self.socket.setsockopt(

2645

socket.SOL_SOCKET, SO_BINDTODEVICE,

2646

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

2647

except socket.error as error:

2648

if error.errno == errno.EPERM:

2649

log.error("No permission to bind to interface %s",

2650

self.interface)

2651

elif error.errno == errno.ENOPROTOOPT:

2652

log.error("SO_BINDTODEVICE not available; cannot"

2653

" bind to interface %s", self.interface)

2654

elif error.errno == errno.ENODEV:

2655

log.error("Interface %s does not exist, cannot"

2656

" bind", self.interface)

2657

else:

2658

raise

1971

logger.error("SO_BINDTODEVICE does not exist;"

1972

" cannot bind to interface %s",

1973

self.interface)

1974

else:

1975

try:

1976

self.socket.setsockopt(socket.SOL_SOCKET,

1977

SO_BINDTODEVICE,

1978

(self.interface + "\0")

1979

.encode("utf-8"))

1980

except socket.error as error:

1981

if error.errno == errno.EPERM:

1982

logger.error("No permission to bind to"

1983

" interface %s", self.interface)

1984

elif error.errno == errno.ENOPROTOOPT:

1985

logger.error("SO_BINDTODEVICE not available;"

1986

" cannot bind to interface %s",

1987

self.interface)

1988

elif error.errno == errno.ENODEV:

1989

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

1990

" cannot bind", self.interface)

1991

else:

1992

raise

2659

1993

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

2660

1994

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

2663

1995

if not self.server_address[0]:

2664

1996

if self.address_family == socket.AF_INET6:

2665

any_address = "::" # in6addr_any

1997

any_address = "::" # in6addr_any

2666

1998

else:

2667

any_address = "0.0.0.0" # INADDR_ANY

1999

any_address = "0.0.0.0" # INADDR_ANY

2668

2000

self.server_address = (any_address,

2669

2001

self.server_address[1])

2670

2002

elif not self.server_address[1]:

2671

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

2003

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

2004

0)

2672

2005

# if self.interface:

2673

2006

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

2674

2007

# 0, # port

2680

2013

2681

2014

class MandosServer(IPv6_TCPServer):

2682

2015

"""Mandos server.

2683

2016

2684

2017

Attributes:

2685

2018

clients: set of Client objects

2686

2019

gnutls_priority GnuTLS priority string

2687

2020

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

2688

2689

Assumes a GLib.MainLoop event loop.

2021

2022

Assumes a gobject.MainLoop event loop.

2690

2023

"""

2691

2692

2024

def __init__(self, server_address, RequestHandlerClass,

2693

interface=None,

2694

use_ipv6=True,

2695

clients=None,

2696

gnutls_priority=None,

2697

use_dbus=True,

2698

socketfd=None):

2025

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

2026

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

2699

2027

self.enabled = False

2700

2028

self.clients = clients

2701

2029

if self.clients is None:

2704

2032

self.gnutls_priority = gnutls_priority

2705

2033

IPv6_TCPServer.__init__(self, server_address,

2706

2034

RequestHandlerClass,

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

2035

interface = interface,

2036

use_ipv6 = use_ipv6,

2037

socketfd = socketfd)

2711

2038

def server_activate(self):

2712

2039

if self.enabled:

2713

2040

return socketserver.TCPServer.server_activate(self)

2714

2041

2715

2042

def enable(self):

2716

2043

self.enabled = True

2717

2044

2718

2045

def add_pipe(self, parent_pipe, proc):

2719

2046

# Call "handle_ipc" for both data and EOF events

2720

GLib.io_add_watch(

2721

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

2722

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

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2727

def handle_ipc(self, source, condition,

2728

parent_pipe=None,

2729

proc=None,

2730

client_object=None):

2047

gobject.io_add_watch(parent_pipe.fileno(),

2048

gobject.IO_IN | gobject.IO_HUP,

2049

functools.partial(self.handle_ipc,

2050

parent_pipe =

2051

parent_pipe,

2052

proc = proc))

2053

2054

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

2055

proc = None, client_object=None):

2731

2056

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

2732

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

2057

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

2733

2058

# Wait for other process to exit

2734

2059

proc.join()

2735

2060

return False

2736

2061

2737

2062

# Read a request from the child

2738

2063

request = parent_pipe.recv()

2739

2064

command = request[0]

2740

2741

if command == "init":

2742

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

2743

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

2744

address = request[3]

2745

2746

for c in self.clients.values():

2747

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2748

"27AE41E4649B934CA495991B7852B855"):

2749

continue

2750

if key_id and c.key_id == key_id:

2751

client = c

2752

break

2753

if fpr and c.fingerprint == fpr:

2065

2066

if command == 'init':

2067

fpr = request[1]

2068

address = request[2]

2069

2070

for c in self.clients.itervalues():

2071

if c.fingerprint == fpr:

2754

2072

client = c

2755

2073

break

2756

2074

else:

2757

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

2758

" %s", key_id or fpr, address)

2075

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

2076

"dress: %s", fpr, address)

2759

2077

if self.use_dbus:

2760

2078

# Emit D-Bus signal

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2079

mandos_dbus_service.ClientNotFound(fpr,

2762

2080

address[0])

2763

2081

parent_pipe.send(False)

2764

2082

return False

2765

2766

GLib.io_add_watch(

2767

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

2768

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

2769

functools.partial(self.handle_ipc,

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2083

2084

gobject.io_add_watch(parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2086

functools.partial(self.handle_ipc,

2087

parent_pipe =

2088

parent_pipe,

2089

proc = proc,

2090

client_object =

2091

client))

2773

2092

parent_pipe.send(True)

2774

2093

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

2775

2094

# same fileno

2776

2095

return False

2777

if command == "funcall":

2096

if command == 'funcall':

2778

2097

funcname = request[1]

2779

2098

args = request[2]

2780

2099

kwargs = request[3]

2781

2782

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

2100

2101

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

2783

2102

funcname)(*args,

2784

**kwargs)))

2785

2786

if command == "getattr":

2103

**kwargs)))

2104

2105

if command == 'getattr':

2787

2106

attrname = request[1]

2788

if isinstance(client_object.__getattribute__(attrname),

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2107

if callable(client_object.__getattribute__(attrname)):

2108

parent_pipe.send(('function',))

2791

2109

else:

2792

parent_pipe.send((

2793

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

2794

2795

if command == "setattr":

2110

parent_pipe.send(('data', client_object

2111

.__getattribute__(attrname)))

2112

2113

if command == 'setattr':

2796

2114

attrname = request[1]

2797

2115

value = request[2]

2798

2116

setattr(client_object, attrname, value)

2799

2117

2800

2118

return True

2801

2119

2802

2120

2803

2121

def rfc3339_duration_to_delta(duration):

2804

2122

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

2805

2806

>>> timedelta = datetime.timedelta

2807

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

2808

True

2809

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

2810

True

2811

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

2812

True

2813

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

2814

True

2815

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

2816

True

2817

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

2818

True

2819

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

2820

True

2821

>>> del timedelta

2123

2124

>>> rfc3339_duration_to_delta("P7D")

2125

datetime.timedelta(7)

2126

>>> rfc3339_duration_to_delta("PT60S")

2127

datetime.timedelta(0, 60)

2128

>>> rfc3339_duration_to_delta("PT60M")

2129

datetime.timedelta(0, 3600)

2130

>>> rfc3339_duration_to_delta("PT24H")

2131

datetime.timedelta(1)

2132

>>> rfc3339_duration_to_delta("P1W")

2133

datetime.timedelta(7)

2134

>>> rfc3339_duration_to_delta("PT5M30S")

2135

datetime.timedelta(0, 330)

2136

>>> rfc3339_duration_to_delta("P1DT3M20S")

2137

datetime.timedelta(1, 200)

2822

2138

"""

2823

2139

2824

2140

# Parsing an RFC 3339 duration with regular expressions is not

2825

2141

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

2826

2142

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

2827

2143

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

2828

2144

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

2829

2145

# avoid excessive use of external libraries.

2830

2146

2831

2147

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

2832

Token = collections.namedtuple("Token", (

2833

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

2834

# a "group" containing digits

2835

"value", # datetime.timedelta or None

2836

"followers")) # Tokens valid after this token

2148

Token = collections.namedtuple("Token",

2149

("regexp", # To match token; if

2150

# "value" is not None,

2151

# must have a "group"

2152

# containing digits

2153

"value", # datetime.timedelta or

2154

# None

2155

"followers")) # Tokens valid after

2156

# this token

2837

2157

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

2838

2158

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

2839

2159

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

2840

2160

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

2841

2161

datetime.timedelta(seconds=1),

2842

frozenset((token_end, )))

2162

frozenset((token_end,)))

2843

2163

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

2844

2164

datetime.timedelta(minutes=1),

2845

2165

frozenset((token_second, token_end)))

2861

2181

frozenset((token_month, token_end)))

2862

2182

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

2863

2183

datetime.timedelta(weeks=1),

2864

frozenset((token_end, )))

2184

frozenset((token_end,)))

2865

2185

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

2866

2186

frozenset((token_year, token_month,

2867

2187

token_day, token_time,

2868

2188

token_week)))

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2189

# Define starting values

2190

value = datetime.timedelta() # Value so far

2872

2191

found_token = None

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2192

followers = frozenset((token_duration,)) # Following valid tokens

2193

s = duration # String left to parse

2877

2194

# Loop until end token is found

2878

2195

while found_token is not token_end:

2879

2196

# Search for any currently valid tokens

2895

2212

break

2896

2213

else:

2897

2214

# No currently valid tokens were found

2898

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

2899

.format(duration))

2215

raise ValueError("Invalid RFC 3339 duration")

2900

2216

# End token found

2901

2217

return value

2902

2218

2903

2219

2904

2220

def string_to_delta(interval):

2905

2221

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

2906

2907

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

2908

True

2909

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

2910

True

2911

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

2912

True

2913

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

2914

True

2915

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

2916

True

2917

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

2918

True

2222

2223

>>> string_to_delta('7d')

2224

datetime.timedelta(7)

2225

>>> string_to_delta('60s')

2226

datetime.timedelta(0, 60)

2227

>>> string_to_delta('60m')

2228

datetime.timedelta(0, 3600)

2229

>>> string_to_delta('24h')

2230

datetime.timedelta(1)

2231

>>> string_to_delta('1w')

2232

datetime.timedelta(7)

2233

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

2234

datetime.timedelta(0, 330)

2919

2235

"""

2920

2236

2921

2237

try:

2922

2238

return rfc3339_duration_to_delta(interval)

2923

2239

except ValueError:

2924

2240

pass

2925

2241

2926

2242

timevalue = datetime.timedelta(0)

2927

2243

for s in interval.split():

2928

2244

try:

2939

2255

elif suffix == "w":

2940

2256

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

2941

2257

else:

2942

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

2258

raise ValueError("Unknown suffix {!r}"

2259

.format(suffix))

2943

2260

except IndexError as e:

2944

2261

raise ValueError(*(e.args))

2945

2262

timevalue += delta

2946

2263

return timevalue

2947

2264

2948

2265

2949

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

2266

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

2950

2267

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

2951

2268

2952

2269

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

2953

2270

if os.fork():

2954

2271

sys.exit()

2961

2278

# Close all standard open file descriptors

2962

2279

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

2963

2280

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

2964

raise OSError(errno.ENODEV,

2965

"{} not a character device"

2281

raise OSError(errno.ENODEV, "{} not a character device"

2966

2282

.format(os.devnull))

2967

2283

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

2968

2284

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

2972

2288

2973

2289

2974

2290

def main():

2975

2291

2976

2292

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

2977

2293

# Parsing of options, both command line and config file

2978

2294

2979

2295

parser = argparse.ArgumentParser()

2980

2296

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

2981

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

2297

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

2982

2298

help="show version number and exit")

2983

2299

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

2984

2300

help="Bind to interface IF")

3020

2336

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

3021

2337

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

3022

2338

default=None)

3023

2339

3024

2340

options = parser.parse_args()

3025

2341

2342

if options.check:

2343

import doctest

2344

fail_count, test_count = doctest.testmod()

2345

sys.exit(os.EX_OK if fail_count == 0 else 1)

2346

3026

2347

# Default values for config file for server-global settings

3027

if gnutls.has_rawpk:

3028

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

3029

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

3030

else:

3031

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

3032

":+SIGN-DSA-SHA256")

3033

server_defaults = {"interface": "",

3034

"address": "",

3035

"port": "",

3036

"debug": "False",

3037

"priority": priority,

3038

"servicename": "Mandos",

3039

"use_dbus": "True",

3040

"use_ipv6": "True",

3041

"debuglevel": "",

3042

"restore": "True",

3043

"socket": "",

3044

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

3045

"foreground": "False",

3046

"zeroconf": "True",

3047

}

3048

del priority

3049

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

"zeroconf": "True",

2363

}

2364

3050

2365

# Parse config file for server-global settings

3051

server_config = configparser.ConfigParser(server_defaults)

2366

server_config = configparser.SafeConfigParser(server_defaults)

3052

2367

del server_defaults

3053

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

3054

# Convert the ConfigParser object to a dict

2368

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

2369

"mandos.conf"))

2370

# Convert the SafeConfigParser object to a dict

3055

2371

server_settings = server_config.defaults()

3056

2372

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

3057

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

3058

"foreground", "zeroconf"):

2373

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

3059

2374

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

3060

2375

option)

3061

2376

if server_settings["port"]:

3071

2386

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

3072

2387

["socket"])

3073

2388

del server_config

3074

2389

3075

2390

# Override the settings from the config file with command line

3076

2391

# options, if set.

3077

2392

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

3078

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

3079

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

3080

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

2393

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

2394

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

2395

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

3081

2396

value = getattr(options, option)

3082

2397

if value is not None:

3083

2398

server_settings[option] = value

3095

2410

if server_settings["debug"]:

3096

2411

server_settings["foreground"] = True

3097

2412

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

3098

2413

3099

2414

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

3100

3101

if (not server_settings["zeroconf"]

3102

and not (server_settings["port"]

3103

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

3104

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

3105

2415

2416

if (not server_settings["zeroconf"] and

2417

not (server_settings["port"]

2418

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

2419

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

2420

" Zeroconf")

2421

3106

2422

# For convenience

3107

2423

debug = server_settings["debug"]

3108

2424

debuglevel = server_settings["debuglevel"]

3112

2428

stored_state_file)

3113

2429

foreground = server_settings["foreground"]

3114

2430

zeroconf = server_settings["zeroconf"]

3115

2431

3116

2432

if debug:

3117

2433

initlogger(debug, logging.DEBUG)

3118

2434

else:

3121

2437

else:

3122

2438

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

3123

2439

initlogger(debug, level)

3124

2440

3125

2441

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

3126

syslogger.setFormatter(

3127

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

3128

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

3129

server_settings["servicename"])))

3130

2442

syslogger.setFormatter(logging.Formatter

2443

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

2444

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

2445

.format(server_settings

2446

["servicename"])))

2447

3131

2448

# Parse config file with clients

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2449

client_config = configparser.SafeConfigParser(Client

2450

.client_defaults)

3133

2451

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

3134

2452

"clients.conf"))

3135

2453

3136

2454

global mandos_dbus_service

3137

2455

mandos_dbus_service = None

3138

2456

3139

2457

socketfd = None

3140

2458

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

3141

2459

socketfd = server_settings["socket"]

3142

tcp_server = MandosServer(

3143

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

3144

ClientHandler,

3145

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

3146

use_ipv6=use_ipv6,

3147

gnutls_priority=server_settings["priority"],

3148

use_dbus=use_dbus,

3149

socketfd=socketfd)

2460

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

2461

server_settings["port"]),

2462

ClientHandler,

2463

interface=(server_settings["interface"]

2464

or None),

2465

use_ipv6=use_ipv6,

2466

gnutls_priority=

2467

server_settings["priority"],

2468

use_dbus=use_dbus,

2469

socketfd=socketfd)

3150

2470

if not foreground:

3151

2471

pidfilename = "/run/mandos.pid"

3152

2472

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

3153

2473

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

3154

2474

pidfile = None

3155

2475

try:

3156

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

2476

pidfile = open(pidfilename, "w")

3157

2477

except IOError as e:

3158

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

3159

exc_info=e)

3160

3161

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

3162

("mandos", "mandos"),

3163

("nobody", "nogroup")):

2478

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

2479

exc_info=e)

2480

2481

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

3164

2482

try:

3165

2483

uid = pwd.getpwnam(name).pw_uid

3166

gid = pwd.getpwnam(group).pw_gid

2484

gid = pwd.getpwnam(name).pw_gid

3167

2485

break

3168

2486

except KeyError:

3169

2487

continue

3173

2491

try:

3174

2492

os.setgid(gid)

3175

2493

os.setuid(uid)

3176

log.debug("Did setuid/setgid to %s:%s", uid, gid)

3177

2494

except OSError as error:

3178

log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,

3179

os.strerror(error.errno))

3180

2495

if error.errno != errno.EPERM:

3181

2496

raise

3182

2497

3183

2498

if debug:

3184

2499

# Enable all possible GnuTLS debugging

3185

2500

3186

2501

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

3187

2502

# - GnuTLS manual

3188

gnutls.global_set_log_level(11)

3189

3190

@gnutls.log_func

2503

gnutls.library.functions.gnutls_global_set_log_level(11)

2504

2505

@gnutls.library.types.gnutls_log_func

3191

2506

def debug_gnutls(level, string):

3192

log.debug("GnuTLS: %s",

3193

string[:-1].decode("utf-8", errors="replace"))

3194

3195

gnutls.global_set_log_function(debug_gnutls)

3196

2507

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

2508

2509

(gnutls.library.functions

2510

.gnutls_global_set_log_function(debug_gnutls))

2511

3197

2512

# Redirect stdin so all checkers get /dev/null

3198

2513

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

3199

2514

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

3200

2515

if null > 2:

3201

2516

os.close(null)

3202

2517

3203

2518

# Need to fork before connecting to D-Bus

3204

2519

if not foreground:

3205

2520

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

3206

2521

daemon()

3207

3208

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

3209

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

3210

# need to inform GLib that threads will be used.

3211

GLib.threads_init()

3212

2522

2523

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

2524

# need to inform gobject that threads will be used.

2525

gobject.threads_init()

2526

3213

2527

global main_loop

3214

2528

# From the Avahi example code

3215

2529

DBusGMainLoop(set_as_default=True)

3216

main_loop = GLib.MainLoop()

2530

main_loop = gobject.MainLoop()

3217

2531

bus = dbus.SystemBus()

3218

2532

# End of Avahi example code

3219

2533

if use_dbus:

3220

2534

try:

3221

2535

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

3222

bus,

3223

do_not_queue=True)

3224

old_bus_name = dbus.service.BusName(

3225

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

3226

do_not_queue=True)

3227

except dbus.exceptions.DBusException as e:

3228

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

2536

bus, do_not_queue=True)

2537

old_bus_name = (dbus.service.BusName

2538

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

2539

do_not_queue=True))

2540

except dbus.exceptions.NameExistsException as e:

2541

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

3229

2542

use_dbus = False

3230

2543

server_settings["use_dbus"] = False

3231

2544

tcp_server.use_dbus = False

3232

2545

if zeroconf:

3233

2546

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3234

service = AvahiServiceToSyslog(

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

2547

service = AvahiServiceToSyslog(name =

2548

server_settings["servicename"],

2549

servicetype = "_mandos._tcp",

2550

protocol = protocol, bus = bus)

3239

2551

if server_settings["interface"]:

3240

service.interface = if_nametoindex(

3241

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

3242

2552

service.interface = (if_nametoindex

2553

(server_settings["interface"]

2554

.encode("utf-8")))

2555

3243

2556

global multiprocessing_manager

3244

2557

multiprocessing_manager = multiprocessing.Manager()

3245

2558

3246

2559

client_class = Client

3247

2560

if use_dbus:

3248

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

3249

2561

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

2562

3250

2563

client_settings = Client.config_parser(client_config)

3251

2564

old_client_settings = {}

3252

2565

clients_data = {}

3253

2566

3254

2567

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

3255

2568

global wnull

3256

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

2569

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

3257

2570

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

3258

2571

# mode

3259

2572

if debug or not foreground:

3260

2573

wnull.close()

3261

2574

3262

2575

# Get client data and settings from last running state.

3263

2576

if server_settings["restore"]:

3264

2577

try:

3265

2578

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

3266

if sys.version_info.major == 2:

3267

clients_data, old_client_settings = pickle.load(

3268

stored_state)

3269

else:

3270

bytes_clients_data, bytes_old_client_settings = (

3271

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

3272

# Fix bytes to strings

3273

# clients_data

3274

# .keys()

3275

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

3276

if isinstance(key, bytes)

3277

else key): value

3278

for key, value in

3279

bytes_clients_data.items()}

3280

del bytes_clients_data

3281

for key in clients_data:

3282

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

3283

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

3284

for k, v in

3285

clients_data[key].items()}

3286

clients_data[key] = value

3287

# .client_structure

3288

value["client_structure"] = [

3289

(s.decode("utf-8")

3290

if isinstance(s, bytes)

3291

else s) for s in

3292

value["client_structure"]]

3293

# .name, .host, and .checker_command

3294

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

3295

if isinstance(value[k], bytes):

3296

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

3297

if "key_id" not in value:

3298

value["key_id"] = ""

3299

elif "fingerprint" not in value:

3300

value["fingerprint"] = ""

3301

# old_client_settings

3302

# .keys()

3303

old_client_settings = {

3304

(key.decode("utf-8")

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_old_client_settings.items()}

3309

del bytes_old_client_settings

3310

# .host and .checker_command

3311

for value in old_client_settings.values():

3312

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

3313

if isinstance(value[attribute], bytes):

3314

value[attribute] = (value[attribute]

3315

.decode("utf-8"))

2579

clients_data, old_client_settings = (pickle.load

2580

(stored_state))

3316

2581

os.remove(stored_state_path)

3317

2582

except IOError as e:

3318

2583

if e.errno == errno.ENOENT:

3319

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

3320

" %s", os.strerror(e.errno))

2584

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

2585

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

3321

2586

else:

3322

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

3323

exc_info=e)

2587

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

2588

exc_info=e)

3324

2589

raise

3325

2590

except EOFError as e:

3326

log.warning("Could not load persistent state: EOFError:",

3327

exc_info=e)

3328

2591

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

2592

"EOFError:", exc_info=e)

2593

3329

2594

with PGPEngine() as pgp:

3330

2595

for client_name, client in clients_data.items():

3331

2596

# Skip removed clients

3332

2597

if client_name not in client_settings:

3333

2598

continue

3334

2599

3335

2600

# Decide which value to use after restoring saved state.

3336

2601

# We have three different values: Old config file,

3337

2602

# new config file, and saved state.

3342

2607

# For each value in new config, check if it

3343

2608

# differs from the old config value (Except for

3344

2609

# the "secret" attribute)

3345

if (name != "secret"

3346

and (value !=

3347

old_client_settings[client_name][name])):

2610

if (name != "secret" and

2611

value != old_client_settings[client_name]

2612

[name]):

3348

2613

client[name] = value

3349

2614

except KeyError:

3350

2615

pass

3351

2616

3352

2617

# Clients who has passed its expire date can still be

3353

# enabled if its last checker was successful. A Client

2618

# enabled if its last checker was successful. Clients

3354

2619

# whose checker succeeded before we stored its state is

3355

2620

# assumed to have successfully run all checkers during

3356

2621

# downtime.

3357

2622

if client["enabled"]:

3358

2623

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

3359

2624

if not client["last_checked_ok"]:

3360

log.warning("disabling client %s - Client"

3361

" never performed a successful"

3362

" checker", client_name)

2625

logger.warning(

2626

"disabling client {} - Client never "

2627

"performed a successful checker"

2628

.format(client_name))

3363

2629

client["enabled"] = False

3364

2630

elif client["last_checker_status"] != 0:

3365

log.warning("disabling client %s - Client"

3366

" last checker failed with error"

3367

" code %s", client_name,

3368

client["last_checker_status"])

2631

logger.warning(

2632

"disabling client {} - Client last"

2633

" checker failed with error code {}"

2634

.format(client_name,

2635

client["last_checker_status"]))

3369

2636

client["enabled"] = False

3370

2637

else:

3371

client["expires"] = (

3372

datetime.datetime.utcnow()

3373

+ client["timeout"])

3374

log.debug("Last checker succeeded, keeping %s"

3375

" enabled", client_name)

2638

client["expires"] = (datetime.datetime

2639

.utcnow()

2640

+ client["timeout"])

2641

logger.debug("Last checker succeeded,"

2642

" keeping {} enabled"

2643

.format(client_name))

3376

2644

try:

3377

client["secret"] = pgp.decrypt(

3378

client["encrypted_secret"],

3379

client_settings[client_name]["secret"])

2645

client["secret"] = (

2646

pgp.decrypt(client["encrypted_secret"],

2647

client_settings[client_name]

2648

["secret"]))

3380

2649

except PGPError:

3381

2650

# If decryption fails, we use secret from new settings

3382

log.debug("Failed to decrypt %s old secret",

3383

client_name)

3384

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

3385

["secret"])

3386

2651

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

2652

.format(client_name))

2653

client["secret"] = (

2654

client_settings[client_name]["secret"])

2655

3387

2656

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

3388

2657

for client_name in (set(old_client_settings)

3389

2658

- set(client_settings)):

3391

2660

for client_name in (set(client_settings)

3392

2661

- set(old_client_settings)):

3393

2662

clients_data[client_name] = client_settings[client_name]

3394

2663

3395

2664

# Create all client objects

3396

2665

for client_name, client in clients_data.items():

3397

2666

tcp_server.clients[client_name] = client_class(

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

2667

name = client_name, settings = client,

2668

server_settings = server_settings)

2669

3402

2670

if not tcp_server.clients:

3403

log.warning("No clients defined")

3404

2671

logger.warning("No clients defined")

2672

3405

2673

if not foreground:

3406

2674

if pidfile is not None:

3407

pid = os.getpid()

3408

2675

try:

3409

2676

with pidfile:

3410

print(pid, file=pidfile)

2677

pid = os.getpid()

2678

pidfile.write("{}\n".format(pid).encode("utf-8"))

3411

2679

except IOError:

3412

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

3413

pidfilename, pid)

2680

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

2681

pidfilename, pid)

3414

2682

del pidfile

3415

2683

del pidfilename

3416

3417

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

3418

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3419

lambda: main_loop.quit() and False)

3420

2684

2685

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

2686

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

2687

3421

2688

if use_dbus:

3422

3423

@alternate_dbus_interfaces(

3424

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

3425

class MandosDBusService(DBusObjectWithObjectManager):

2689

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

2690

"se.bsnet.fukt.Mandos"})

2691

class MandosDBusService(DBusObjectWithProperties):

3426

2692

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

3427

3428

2693

def __init__(self):

3429

2694

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

3430

3431

2695

_interface = "se.recompile.Mandos"

3432

2696

2697

@dbus_interface_annotations(_interface)

2698

def _foo(self):

2699

return { "org.freedesktop.DBus.Property"

2700

".EmitsChangedSignal":

2701

"false"}

2702

3433

2703

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

3434

2704

def ClientAdded(self, objpath):

3435

2705

"D-Bus signal"

3436

2706

pass

3437

2707

3438

2708

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

3439

def ClientNotFound(self, key_id, address):

2709

def ClientNotFound(self, fingerprint, address):

3440

2710

"D-Bus signal"

3441

2711

pass

3442

3443

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

3444

"true"})

2712

3445

2713

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

3446

2714

def ClientRemoved(self, objpath, name):

3447

2715

"D-Bus signal"

3448

2716

pass

3449

3450

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

3451

"true"})

2717

3452

2718

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

3453

2719

def GetAllClients(self):

3454

2720

"D-Bus method"

3455

return dbus.Array(c.dbus_object_path for c in

3456

tcp_server.clients.values())

3457

3458

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

3459

"true"})

2721

return dbus.Array(c.dbus_object_path

2722

for c in

2723

tcp_server.clients.itervalues())

2724

3460

2725

@dbus.service.method(_interface,

3461

2726

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

3462

2727

def GetAllClientsWithProperties(self):

3463

2728

"D-Bus method"

3464

2729

return dbus.Dictionary(

3465

{c.dbus_object_path: c.GetAll(

3466

"se.recompile.Mandos.Client")

3467

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

2730

{ c.dbus_object_path: c.GetAll("")

2731

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

3468

2732

signature="oa{sv}")

3469

2733

3470

2734

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

3471

2735

def RemoveClient(self, object_path):

3472

2736

"D-Bus method"

3473

for c in tcp_server.clients.values():

2737

for c in tcp_server.clients.itervalues():

3474

2738

if c.dbus_object_path == object_path:

3475

2739

del tcp_server.clients[c.name]

3476

2740

c.remove_from_connection()

3477

# Don't signal the disabling

2741

# Don't signal anything except ClientRemoved

3478

2742

c.disable(quiet=True)

3479

# Emit D-Bus signal for removal

3480

self.client_removed_signal(c)

2743

# Emit D-Bus signal

2744

self.ClientRemoved(object_path, c.name)

3481

2745

return

3482

2746

raise KeyError(object_path)

3483

2747

3484

2748

del _interface

3485

3486

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3487

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

3488

def GetManagedObjects(self):

3489

"""D-Bus method"""

3490

return dbus.Dictionary(

3491

{client.dbus_object_path:

3492

dbus.Dictionary(

3493

{interface: client.GetAll(interface)

3494

for interface in

3495

client._get_all_interface_names()})

3496

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

3497

3498

def client_added_signal(self, client):

3499

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

3500

if use_dbus:

3501

# New standard signal

3502

self.InterfacesAdded(

3503

client.dbus_object_path,

3504

dbus.Dictionary(

3505

{interface: client.GetAll(interface)

3506

for interface in

3507

client._get_all_interface_names()}))

3508

# Old signal

3509

self.ClientAdded(client.dbus_object_path)

3510

3511

def client_removed_signal(self, client):

3512

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

3513

if use_dbus:

3514

# New standard signal

3515

self.InterfacesRemoved(

3516

client.dbus_object_path,

3517

client._get_all_interface_names())

3518

# Old signal

3519

self.ClientRemoved(client.dbus_object_path,

3520

client.name)

3521

2749

3522

2750

mandos_dbus_service = MandosDBusService()

3523

3524

# Save modules to variables to exempt the modules from being

3525

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

3526

mp = multiprocessing

3527

wn = wnull

3528

2751

3529

2752

def cleanup():

3530

2753

"Cleanup function; run on exit"

3531

2754

if zeroconf:

3532

2755

service.cleanup()

3533

3534

mp.active_children()

3535

wn.close()

2756

2757

multiprocessing.active_children()

2758

wnull.close()

3536

2759

if not (tcp_server.clients or client_settings):

3537

2760

return

3538

2761

3539

2762

# Store client before exiting. Secrets are encrypted with key

3540

2763

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

3541

2764

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

3542

2765

clients = {}

3543

2766

with PGPEngine() as pgp:

3544

for client in tcp_server.clients.values():

2767

for client in tcp_server.clients.itervalues():

3545

2768

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

3546

2769

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

3547

2770

key)

3548

2771

client_dict = {}

3549

2772

3550

2773

# A list of attributes that can not be pickled

3551

2774

# + secret.

3552

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

3553

"checker", "server_settings"}

3554

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

3555

.Object):

2775

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

2776

"checker", "server_settings" }

2777

for name, typ in (inspect.getmembers

2778

(dbus.service.Object)):

3556

2779

exclude.add(name)

3557

2780

3558

2781

client_dict["encrypted_secret"] = (client

3559

2782

.encrypted_secret)

3560

2783

for attr in client.client_structure:

3561

2784

if attr not in exclude:

3562

2785

client_dict[attr] = getattr(client, attr)

3563

2786

3564

2787

clients[client.name] = client_dict

3565

2788

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

3566

2789

3567

2790

try:

3568

with tempfile.NamedTemporaryFile(

3569

mode="wb",

3570

suffix=".pickle",

3571

prefix="clients-",

3572

dir=os.path.dirname(stored_state_path),

3573

delete=False) as stored_state:

3574

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

3575

protocol=2)

3576

tempname = stored_state.name

2791

with (tempfile.NamedTemporaryFile

2792

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

2793

dir=os.path.dirname(stored_state_path),

2794

delete=False)) as stored_state:

2795

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

2796

tempname=stored_state.name

3577

2797

os.rename(tempname, stored_state_path)

3578

2798

except (IOError, OSError) as e:

3579

2799

if not debug:

3582

2802

except NameError:

3583

2803

pass

3584

2804

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

3585

log.warning("Could not save persistent state: %s",

3586

os.strerror(e.errno))

2805

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

2806

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

3587

2807

else:

3588

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

3589

exc_info=e)

2808

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

2809

exc_info=e)

3590

2810

raise

3591

2811

3592

2812

# Delete all clients, and settings from config

3593

2813

while tcp_server.clients:

3594

2814

name, client = tcp_server.clients.popitem()

3595

2815

if use_dbus:

3596

2816

client.remove_from_connection()

3597

# Don't signal the disabling

2817

# Don't signal anything except ClientRemoved

3598

2818

client.disable(quiet=True)

3599

# Emit D-Bus signal for removal

3600

2819

if use_dbus:

3601

mandos_dbus_service.client_removed_signal(client)

2820

# Emit D-Bus signal

2821

mandos_dbus_service.ClientRemoved(client

2822

.dbus_object_path,

2823

client.name)

3602

2824

client_settings.clear()

3603

2825

3604

2826

atexit.register(cleanup)

3605

3606

for client in tcp_server.clients.values():

2827

2828

for client in tcp_server.clients.itervalues():

3607

2829

if use_dbus:

3608

# Emit D-Bus signal for adding

3609

mandos_dbus_service.client_added_signal(client)

2830

# Emit D-Bus signal

2831

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3610

2832

# Need to initiate checking of clients

3611

2833

if client.enabled:

3612

2834

client.init_checker()

3613

2835

3614

2836

tcp_server.enable()

3615

2837

tcp_server.server_activate()

3616

2838

3617

2839

# Find out what port we got

3618

2840

if zeroconf:

3619

2841

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

3620

2842

if use_ipv6:

3621

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

3622

" scope_id %d", *tcp_server.socket.getsockname())

2843

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

2844

" flowinfo %d, scope_id %d",

2845

*tcp_server.socket.getsockname())

3623

2846

else: # IPv4

3624

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

3625

*tcp_server.socket.getsockname())

3626

3627

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

3628

2847

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

2848

*tcp_server.socket.getsockname())

2849

2850

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

2851

3629

2852

try:

3630

2853

if zeroconf:

3631

2854

# From the Avahi example code

3632

2855

try:

3633

2856

service.activate()

3634

2857

except dbus.exceptions.DBusException as error:

3635

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

2858

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

3636

2859

cleanup()

3637

2860

sys.exit(1)

3638

2861

# End of Avahi example code

3639

3640

GLib.io_add_watch(

3641

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

3642

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3643

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

3644

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

3645

3646

log.debug("Starting main loop")

2862

2863

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

2864

lambda *args, **kwargs:

2865

(tcp_server.handle_request

2866

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

2867

2868

logger.debug("Starting main loop")

3647

2869

main_loop.run()

3648

2870

except AvahiError as error:

3649

log.critical("Avahi Error", exc_info=error)

2871

logger.critical("Avahi Error", exc_info=error)

3650

2872

cleanup()

3651

2873

sys.exit(1)

3652

2874

except KeyboardInterrupt:

3653

2875

if debug:

3654

2876

print("", file=sys.stderr)

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

2877

logger.debug("Server received KeyboardInterrupt")

2878

logger.debug("Server exiting")

3657

2879

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

3658

2880

cleanup()

3659

2881

3660

3661

def parse_test_args():

3662

# type: () -> argparse.Namespace

3663

parser = argparse.ArgumentParser(add_help=False)

3664

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

3665

parser.add_argument("--prefix", )

3666

args, unknown_args = parser.parse_known_args()

3667

if args.check:

3668

# Remove test options from sys.argv

3669

sys.argv[1:] = unknown_args

3670

return args

3671

3672

# Add all tests from doctest strings

3673

def load_tests(loader, tests, none):

3674

import doctest

3675

tests.addTests(doctest.DocTestSuite())

3676

return tests

3677

3678

if __name__ == "__main__":

3679

options = parse_test_args()

3680

try:

3681

if options.check:

3682

extra_test_prefix = options.prefix

3683

if extra_test_prefix is not None:

3684

if not (unittest.main(argv=[""], exit=False)

3685

.result.wasSuccessful()):

3686

sys.exit(1)

3687

class ExtraTestLoader(unittest.TestLoader):

3688

testMethodPrefix = extra_test_prefix

3689

# Call using ./scriptname --test [--verbose]

3690

unittest.main(argv=[""], testLoader=ExtraTestLoader())

3691

else:

3692

unittest.main(argv=[""])

3693

else:

3694

main()

3695

finally:

3696

logging.shutdown()

3697

3698

# Local Variables:

3699

# run-tests:

3700

# (lambda (&optional extra)

3701

# (if (not (funcall run-tests-in-test-buffer default-directory

3702

# extra))

3703

# (funcall show-test-buffer-in-test-window)

3704

# (funcall remove-test-window)

3705

# (if extra (message "Extra tests run successfully!"))))

3706

# run-tests-in-test-buffer:

3707

# (lambda (dir &optional extra)

3708

# (with-current-buffer (get-buffer-create "*Test*")

3709

# (setq buffer-read-only nil

3710

# default-directory dir)

3711

# (erase-buffer)

3712

# (compilation-mode))

3713

# (let ((process-result

3714

# (let ((inhibit-read-only t))

3715

# (process-file-shell-command

3716

# (funcall get-command-line extra) nil "*Test*"))))

3717

# (and (numberp process-result)

3718

# (= process-result 0))))

3719

# get-command-line:

3720

# (lambda (&optional extra)

3721

# (let ((quoted-script

3722

# (shell-quote-argument (funcall get-script-name))))

3723

# (format

3724

# (concat "%s --check" (if extra " --prefix=atest" ""))

3725

# quoted-script)))

3726

# get-script-name:

3727

# (lambda ()

3728

# (if (fboundp 'file-local-name)

3729

# (file-local-name (buffer-file-name))

3730

# (or (file-remote-p (buffer-file-name) 'localname)

3731

# (buffer-file-name))))

3732

# remove-test-window:

3733

# (lambda ()

3734

# (let ((test-window (get-buffer-window "*Test*")))

3735

# (if test-window (delete-window test-window))))

3736

# show-test-buffer-in-test-window:

3737

# (lambda ()

3738

# (when (not (get-buffer-window-list "*Test*"))

3739

# (setq next-error-last-buffer (get-buffer "*Test*"))

3740

# (let* ((side (if (>= (window-width) 146) 'right 'bottom))

3741

# (display-buffer-overriding-action

3742

# `((display-buffer-in-side-window) (side . ,side)

3743

# (window-height . fit-window-to-buffer)

3744

# (window-width . fit-window-to-buffer))))

3745

# (display-buffer "*Test*"))))

3746

# eval:

3747

# (progn

3748

# (let* ((run-extra-tests (lambda () (interactive)

3749

# (funcall run-tests t)))

3750

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3751

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3752

# (setq minor-mode-overriding-map-alist

3753

# (cons `(run-tests . ,outer-keymap)

3754

# minor-mode-overriding-map-alist)))

3755

# (add-hook 'after-save-hook run-tests 90 t))

3756

# End:

2882

if __name__ == '__main__':

2883

main()