/mandos/release : revision 237.7.110

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

37

import SocketServer as socketserver

47

38

import socket

48

39

import argparse

49

40

import datetime

50

41

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

55

49

import sys

56

50

import re

57

51

import os

66

60

import struct

67

61

import fcntl

68

62

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

63

import cPickle as pickle

73

64

import multiprocessing

74

65

import types

75

66

import binascii

76

67

import tempfile

77

68

import itertools

78

import collections

79

import codecs

80

69

81

70

import dbus

82

71

import dbus.service

83

from gi.repository import GLib

72

import gobject

73

import avahi

84

74

from dbus.mainloop.glib import DBusGMainLoop

85

75

import ctypes

86

76

import ctypes.util

87

77

import xml.dom.minidom

88

78

import inspect

79

import GnuPGInterface

89

80

90

# Try to find the value of SO_BINDTODEVICE:

91

81

try:

92

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

93

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

94

82

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

83

except AttributeError:

96

84

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

85

from IN import SO_BINDTODEVICE

100

86

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.4"

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

119

90

stored_state_file = "clients.pickle"

120

91

121

92

logger = logging.getLogger()

122

syslogger = None

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

123

96

124

97

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

127

101

except (OSError, AttributeError):

128

129

102

def if_nametoindex(interface):

130

103

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

131

104

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

132

105

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

133

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

136

111

return interface_index

137

112

138

113

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

114

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

156

115

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

116

162

117

syslogger.setFormatter(logging.Formatter

163

118

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

164

119

' %(message)s'))

165

120

logger.addHandler(syslogger)

166

121

167

122

if debug:

168

123

console = logging.StreamHandler()

169

124

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

181

136

182

137

class PGPEngine(object):

183

138

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

184

185

139

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

186

141

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

206

149

def __enter__(self):

207

150

return self

208

209

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

151

152

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

210

153

self._cleanup()

211

154

return False

212

155

213

156

def __del__(self):

214

157

self._cleanup()

215

158

216

159

def _cleanup(self):

217

160

if self.tempdir is not None:

218

161

# Delete contents of tempdir

219

162

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

220

topdown=False):

163

topdown = False):

221

164

for filename in files:

222

165

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

223

166

for dirname in dirs:

225

168

# Remove tempdir

226

169

os.rmdir(self.tempdir)

227

170

self.tempdir = None

228

171

229

172

def password_encode(self, password):

230

173

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

231

174

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

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

175

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

176

240

177

def encrypt(self, data, password):

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

178

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

179

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

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

256

192

return ciphertext

257

193

258

194

def decrypt(self, data, password):

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

195

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

196

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

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

274

209

return decrypted_plaintext

275

210

276

211

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

212

303

213

class AvahiError(Exception):

304

214

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

305

215

self.value = value

306

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

307

**kwargs)

308

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

309

219

310

220

class AvahiServiceError(AvahiError):

311

221

pass

312

222

313

314

223

class AvahiGroupError(AvahiError):

315

224

pass

316

225

317

226

318

227

class AvahiService(object):

319

228

"""An Avahi (Zeroconf) service.

320

229

321

230

Attributes:

322

231

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

323

232

Used to optionally bind to the specified interface.

324

233

name: string; Example: 'Mandos'

325

234

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

326

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

235

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

327

236

port: integer; what port to announce

328

237

TXT: list of strings; TXT record for the service

329

238

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

335

244

server: D-Bus Server

336

245

bus: dbus.SystemBus()

337

246

"""

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

247

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

248

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

249

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

250

protocol = avahi.PROTO_UNSPEC, bus = None):

350

251

self.interface = interface

351

252

self.name = name

352

253

self.type = servicetype

361

262

self.server = None

362

263

self.bus = bus

363

264

self.entry_group_state_changed_match = None

364

365

def rename(self, remove=True):

265

def rename(self):

366

266

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

367

267

if self.rename_count >= self.max_renames:

368

268

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

369

269

" after %i retries, exiting.",

370

270

self.rename_count)

371

271

raise AvahiServiceError("Too many renames")

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

375

274

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

376

275

self.name)

377

if remove:

378

self.remove()

276

self.remove()

379

277

try:

380

278

self.add()

381

279

except dbus.exceptions.DBusException as error:

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

280

logger.critical("DBusException: %s", error)

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

391

284

def remove(self):

392

285

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

393

286

if self.entry_group_state_changed_match is not None:

395

288

self.entry_group_state_changed_match = None

396

289

if self.group is not None:

397

290

self.group.Reset()

398

399

291

def add(self):

400

292

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

401

293

self.remove()

418

310

dbus.UInt16(self.port),

419

311

avahi.string_array_to_txt_array(self.TXT))

420

312

self.group.Commit()

421

422

313

def entry_group_state_changed(self, state, error):

423

314

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

424

315

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

425

316

426

317

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

318

logger.debug("Zeroconf service established.")

428

319

elif state == avahi.ENTRY_GROUP_COLLISION:

430

321

self.rename()

431

322

elif state == avahi.ENTRY_GROUP_FAILURE:

432

323

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

433

str(error))

434

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

435

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

436

327

def cleanup(self):

437

328

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

438

329

if self.group is not None:

443

334

pass

444

335

self.group = None

445

336

self.remove()

446

447

337

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

448

338

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

449

339

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

340

bad_states = { avahi.SERVER_INVALID:

341

"Zeroconf server invalid",

342

avahi.SERVER_REGISTERING: None,

343

avahi.SERVER_COLLISION:

344

"Zeroconf server name collision",

345

avahi.SERVER_FAILURE:

346

"Zeroconf server failure" }

456

347

if state in bad_states:

457

348

if bad_states[state] is not None:

458

349

if error is None:

461

352

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

462

353

self.cleanup()

463

354

elif state == avahi.SERVER_RUNNING:

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

355

self.add()

476

356

else:

477

357

if error is None:

478

358

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

479

359

else:

480

360

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

481

482

361

def activate(self):

483

362

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

484

363

if self.server is None:

488

367

follow_name_owner_changes=True),

489

368

avahi.DBUS_INTERFACE_SERVER)

490

369

self.server.connect_to_signal("StateChanged",

491

self.server_state_changed)

370

self.server_state_changed)

492

371

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

493

372

494

495

373

class AvahiServiceToSyslog(AvahiService):

496

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

374

def rename(self):

497

375

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

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

376

ret = AvahiService.rename(self)

377

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

% self.name))

502

381

return ret

503

382

504

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version("3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

815

816

383

def timedelta_to_milliseconds(td):

384

"Convert a datetime.timedelta() to milliseconds"

385

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

386

+ (td.seconds * 1000)

387

+ (td.microseconds // 1000))

388

817

389

class Client(object):

818

390

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

819

391

820

392

Attributes:

821

393

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

822

394

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

824

396

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

825

397

to see if the client lives.

826

398

'None' if no process is running.

827

checker_callback_tag: a GLib event source tag, or None

399

checker_callback_tag: a gobject event source tag, or None

828

400

checker_command: string; External command which is run to check

829

401

if client lives. %() expansions are done at

830

402

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

831

403

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

832

checker_initiator_tag: a GLib event source tag, or None

404

checker_initiator_tag: a gobject event source tag, or None

833

405

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

834

406

client_structure: Object describing what attributes a client has

835

407

and is used for storing the client at exit

836

408

current_checker_command: string; current running checker_command

837

disable_initiator_tag: a GLib event source tag, or None

409

disable_initiator_tag: a gobject event source tag, or None

838

410

enabled: bool()

839

411

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

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

412

uniquely identify the client

843

413

host: string; available for use by the checker command

844

414

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

845

415

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

847

417

last_checker_status: integer between 0 and 255 reflecting exit

848

418

status of last checker. -1 reflects crashed

849

419

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

852

420

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

853

421

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

854

422

D-Bus identifiers

859

427

runtime_expansions: Allowed attributes for runtime expansion.

860

428

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

861

429

disabled, or None

862

server_settings: The server_settings dict from main()

863

430

"""

864

431

865

432

runtime_expansions = ("approval_delay", "approval_duration",

866

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

867

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

868

"last_approval_request", "last_checked_ok",

433

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

434

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

869

435

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

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

436

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

437

"extended_timeout": "15m",

438

"interval": "2m",

439

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

440

"host": "",

441

"approval_delay": "0s",

442

"approval_duration": "1s",

443

"approved_by_default": "True",

444

"enabled": "True",

445

}

446

447

def timeout_milliseconds(self):

448

"Return the 'timeout' attribute in milliseconds"

449

return timedelta_to_milliseconds(self.timeout)

450

451

def extended_timeout_milliseconds(self):

452

"Return the 'extended_timeout' attribute in milliseconds"

453

return timedelta_to_milliseconds(self.extended_timeout)

454

455

def interval_milliseconds(self):

456

"Return the 'interval' attribute in milliseconds"

457

return timedelta_to_milliseconds(self.interval)

458

459

def approval_delay_milliseconds(self):

460

return timedelta_to_milliseconds(self.approval_delay)

881

461

882

462

@staticmethod

883

463

def config_parser(config):

891

471

for client_name in config.sections():

892

472

section = dict(config.items(client_name))

893

473

client = settings[client_name] = {}

894

474

895

475

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

896

476

# Reformat values from string types to Python types

897

477

client["approved_by_default"] = config.getboolean(

898

478

client_name, "approved_by_default")

899

479

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

900

480

"enabled")

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

481

907

482

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

908

483

.replace(" ", ""))

909

484

if "secret" in section:

910

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

911

.encode("utf-8"),

912

"base64")

485

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

913

486

elif "secfile" in section:

914

487

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

915

488

(section["secfile"])),

916

489

"rb") as secfile:

917

490

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

918

491

else:

919

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

920

.format(section))

492

raise TypeError("No secret or secfile for section %s"

493

% section)

921

494

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

922

495

client["extended_timeout"] = string_to_delta(

923

496

section["extended_timeout"])

930

503

client["last_approval_request"] = None

931

504

client["last_checked_ok"] = None

932

505

client["last_checker_status"] = -2

933

506

934

507

return settings

935

936

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

508

509

510

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

511

"""Note: the 'checker' key in 'config' sets the

512

'checker_command' attribute and *not* the 'checker'

513

attribute."""

937

514

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

941

515

# adding all client settings

942

for setting, value in settings.items():

516

for setting, value in settings.iteritems():

943

517

setattr(self, setting, value)

944

518

945

519

if self.enabled:

946

520

if not hasattr(self, "last_enabled"):

947

521

self.last_enabled = datetime.datetime.utcnow()

951

525

else:

952

526

self.last_enabled = None

953

527

self.expires = None

954

528

955

529

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

956

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

530

# Uppercase and remove spaces from fingerprint for later

531

# comparison purposes with return value from the fingerprint()

532

# function

957

533

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

958

534

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

959

535

datetime.datetime.utcnow())

966

542

self.current_checker_command = None

967

543

self.approved = None

968

544

self.approvals_pending = 0

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

545

self.changedstate = (multiprocessing_manager

546

.Condition(multiprocessing_manager

547

.Lock()))

548

self.client_structure = [attr for attr in

549

self.__dict__.iterkeys()

973

550

if not attr.startswith("_")]

974

551

self.client_structure.append("client_structure")

975

976

for name, t in inspect.getmembers(

977

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

552

553

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

554

lambda obj:

555

isinstance(obj,

556

property)):

978

557

if not name.startswith("_"):

979

558

self.client_structure.append(name)

980

559

981

560

# Send notice to process children that client state has changed

982

561

def send_changedstate(self):

983

562

with self.changedstate:

984

563

self.changedstate.notify_all()

985

564

986

565

def enable(self):

987

566

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

988

567

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

989

568

# Already enabled

990

569

return

570

self.send_changedstate()

991

571

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

992

572

self.enabled = True

993

573

self.last_enabled = datetime.datetime.utcnow()

994

574

self.init_checker()

995

self.send_changedstate()

996

575

997

576

def disable(self, quiet=True):

998

577

"""Disable this client."""

999

578

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

1000

579

return False

1001

580

if not quiet:

581

self.send_changedstate()

582

if not quiet:

1002

583

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

1003

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

1004

GLib.source_remove(self.disable_initiator_tag)

584

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

585

gobject.source_remove(self.disable_initiator_tag)

1005

586

self.disable_initiator_tag = None

1006

587

self.expires = None

1007

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

1008

GLib.source_remove(self.checker_initiator_tag)

588

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

589

gobject.source_remove(self.checker_initiator_tag)

1009

590

self.checker_initiator_tag = None

1010

591

self.stop_checker()

1011

592

self.enabled = False

1012

if not quiet:

1013

self.send_changedstate()

1014

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

593

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

1015

594

return False

1016

595

1017

596

def __del__(self):

1018

597

self.disable()

1019

598

1020

599

def init_checker(self):

1021

600

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

1022

601

# and every interval from then on.

1023

if self.checker_initiator_tag is not None:

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

self.start_checker))

1028

605

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

1029

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

self.disable))

1033

609

# Also start a new checker *right now*.

1034

610

self.start_checker()

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

611

612

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

1038

613

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

1039

614

self.checker_callback_tag = None

1040

615

self.checker = None

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

616

if os.WIFEXITED(condition):

617

self.last_checker_status = os.WEXITSTATUS(condition)

1048

618

if self.last_checker_status == 0:

1049

619

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

1050

620

vars(self))

1051

621

self.checked_ok()

1052

622

else:

1053

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

623

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

624

vars(self))

1054

625

else:

1055

626

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

1057

627

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

1058

628

vars(self))

1059

return False

1060

629

1061

630

def checked_ok(self):

1062

631

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

1063

632

self.last_checked_ok = datetime.datetime.utcnow()

1064

633

self.last_checker_status = 0

1065

self.last_checker_signal = None

1066

634

self.bump_timeout()

1067

635

1068

636

def bump_timeout(self, timeout=None):

1069

637

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

1070

638

if timeout is None:

1071

639

timeout = self.timeout

1072

640

if self.disable_initiator_tag is not None:

1073

GLib.source_remove(self.disable_initiator_tag)

1074

self.disable_initiator_tag = None

641

gobject.source_remove(self.disable_initiator_tag)

1075

642

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

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1078

646

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

1079

647

1080

648

def need_approval(self):

1081

649

self.last_approval_request = datetime.datetime.utcnow()

1082

650

1083

651

def start_checker(self):

1084

652

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

1085

653

1086

654

If a checker already exists, leave it running and do

1087

655

nothing."""

1088

656

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

1089

# did that, and if a checker (for some reason) started running

1090

# slowly and taking more than 'interval' time, then the client

1091

# would inevitably timeout, since no checker would get a

1092

# chance to run to completion. If we instead leave running

657

# did that, then if a checker (for some reason) started

658

# running slowly and taking more than 'interval' time, the

659

# client would inevitably timeout, since no checker would get

660

# a chance to run to completion. If we instead leave running

1093

661

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

1094

662

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

1095

663

# should be.

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

664

665

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

666

try:

667

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

668

except (AttributeError, OSError) as error:

669

if (isinstance(error, OSError)

670

and error.errno != errno.ECHILD):

671

raise error

672

else:

673

if pid:

674

logger.warning("Checker was a zombie")

675

gobject.source_remove(self.checker_callback_tag)

676

self.checker_callback(pid, status,

677

self.current_checker_command)

1101

678

# Start a new checker if needed

1102

679

if self.checker is None:

1103

# Escape attributes for the shell

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

1107

680

try:

1108

command = self.checker_command % escaped_attrs

1109

except TypeError as error:

1110

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

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

' %s', self.checker_command, error)

698

return True # Try again later

1114

699

self.current_checker_command = command

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

pipe[0].fileno(), GLib.IO_IN,

1139

self.checker_callback, pipe[0], command)

1140

# 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

self.checker = subprocess.Popen(command,

708

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

720

except OSError as error:

721

logger.error("Failed to start subprocess: %s",

722

error)

723

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

1141

724

return True

1142

725

1143

726

def stop_checker(self):

1144

727

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

1145

728

if self.checker_callback_tag:

1146

GLib.source_remove(self.checker_callback_tag)

729

gobject.source_remove(self.checker_callback_tag)

1147

730

self.checker_callback_tag = None

1148

731

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

1149

732

return

1150

733

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

1151

self.checker.terminate()

734

try:

735

os.kill(self.checker.pid, signal.SIGTERM)

736

#time.sleep(0.5)

737

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

738

# os.kill(self.checker.pid, signal.SIGKILL)

739

except OSError as error:

740

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

741

raise

1152

742

self.checker = None

1153

743

1154

744

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1159

747

"""Decorators for marking methods of a DBusObjectWithProperties to

1160

748

become properties on the D-Bus.

1161

749

1162

750

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

1163

751

and with one argument by "Set".

1164

752

1165

753

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

1166

754

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

1167

755

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

1170

758

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

1171

759

if byte_arrays and signature != "ay":

1172

760

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

1173

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

1174

761

" signature %r" % signature)

1175

762

def decorator(func):

1176

763

func._dbus_is_property = True

1177

764

func._dbus_interface = dbus_interface

1180

767

func._dbus_name = func.__name__

1181

768

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

1182

769

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

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1184

771

return func

1185

1186

772

return decorator

1187

773

1188

774

1189

775

def dbus_interface_annotations(dbus_interface):

1190

"""Decorator for marking functions returning interface annotations

1191

776

"""Decorator for marking functions returning interface annotations.

777

1192

778

Usage:

1193

779

1194

780

@dbus_interface_annotations("org.example.Interface")

1195

781

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

1196

782

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

1197

783

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

1198

784

"false"}

1199

785

"""

1200

1201

786

def decorator(func):

1202

787

func._dbus_is_interface = True

1203

788

func._dbus_interface = dbus_interface

1204

789

func._dbus_name = dbus_interface

1205

790

return func

1206

1207

791

return decorator

1208

792

1209

793

1210

794

def dbus_annotations(annotations):

1211

795

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

1212

796

Usage:

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

797

1217

798

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

1218

799

access="r")

800

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

801

"org.freedesktop.DBus.Property."

802

"EmitsChangedSignal": "false"})

1219

803

def Property_dbus_property(self):

1220

804

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

1223

805

"""

1224

1225

806

def decorator(func):

1226

807

func._dbus_annotations = annotations

1227

808

return func

1228

1229

809

return decorator

1230

810

1231

811

1232

812

class DBusPropertyException(dbus.exceptions.DBusException):

1233

813

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

1234

814

"""

1235

pass

815

def __unicode__(self):

816

return unicode(str(self))

1236

817

1237

818

1238

819

class DBusPropertyAccessException(DBusPropertyException):

1247

828

pass

1248

829

1249

830

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

831

class DBusObjectWithProperties(dbus.service.Object):

832

"""A D-Bus object with properties.

833

834

Classes inheriting from this can use the dbus_service_property

835

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

836

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

1255

837

"""

1256

838

1257

839

@staticmethod

1258

840

def _is_dbus_thing(thing):

1259

841

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

1260

842

1261

843

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

1262

844

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

1263

845

"""

1264

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

846

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

1265

847

False)

1266

848

1267

849

def _get_all_dbus_things(self, thing):

1268

850

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

1269

851

"""

1270

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

852

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

853

name),

1271

854

athing.__get__(self))

1272

855

for cls in self.__class__.__mro__

1273

856

for name, athing in

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

857

inspect.getmembers(cls,

858

self._is_dbus_thing(thing)))

859

1347

860

def _get_dbus_property(self, interface_name, property_name):

1348

861

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

1349

862

property with the specified name and interface.

1350

863

"""

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

864

for cls in self.__class__.__mro__:

865

for name, value in (inspect.getmembers

866

(cls,

867

self._is_dbus_thing("property"))):

1354

868

if (value._dbus_name == property_name

1355

869

and value._dbus_interface == interface_name):

1356

870

return value.__get__(self)

1357

871

1358

872

# No such property

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

873

raise DBusPropertyNotFound(self.dbus_object_path + ":"

874

+ interface_name + "."

875

+ property_name)

876

877

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

1373

878

out_signature="v")

1374

879

def Get(self, interface_name, property_name):

1375

880

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

1381

886

if not hasattr(value, "variant_level"):

1382

887

return value

1383

888

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

1384

889

1385

890

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

1386

891

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

1387

892

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

1393

898

# The byte_arrays option is not supported yet on

1394

899

# signatures other than "ay".

1395

900

if prop._dbus_signature != "ay":

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

901

raise ValueError

1399

902

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

1400

903

for byte in value))

1401

904

prop(value)

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

905

906

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

1405

907

out_signature="a{sv}")

1406

908

def GetAll(self, interface_name):

1407

909

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

1408

910

standard.

1409

911

1410

912

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

1411

913

"""

1412

914

properties = {}

1422

924

if not hasattr(value, "variant_level"):

1423

925

properties[name] = value

1424

926

continue

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

927

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

928

value.variant_level+1)

1427

929

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

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

930

1437

931

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1438

932

out_signature="s",

1439

933

path_keyword='object_path',

1440

934

connection_keyword='connection')

1441

935

def Introspect(self, object_path, connection):

1442

936

"""Overloading of standard D-Bus method.

1443

937

1444

938

Inserts property tags and interface annotation tags.

1445

939

"""

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

940

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

941

connection)

1449

942

try:

1450

943

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

1451

1452

944

def make_tag(document, name, prop):

1453

945

e = document.createElement("property")

1454

946

e.setAttribute("name", name)

1455

947

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

1456

948

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

1457

949

return e

1458

1459

950

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

1460

951

# Add property tags

1461

952

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

1464

955

if prop._dbus_interface

1465

956

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

1466

957

if_tag.appendChild(tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

958

# Add annotation tags

959

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

960

for tag in if_tag.getElementsByTagName(typ):

961

annots = dict()

962

for name, prop in (self.

963

_get_all_dbus_things(typ)):

964

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

965

and prop._dbus_interface

966

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

967

annots.update(getattr

968

(prop,

969

"_dbus_annotations",

970

{}))

971

for name, value in annots.iteritems():

972

ann_tag = document.createElement(

973

"annotation")

974

ann_tag.setAttribute("name", name)

975

ann_tag.setAttribute("value", value)

976

tag.appendChild(ann_tag)

977

# Add interface annotation tags

978

for annotation, value in dict(

979

itertools.chain(

980

*(annotations().iteritems()

981

for name, annotations in

982

self._get_all_dbus_things("interface")

983

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

984

))).iteritems():

985

ann_tag = document.createElement("annotation")

986

ann_tag.setAttribute("name", annotation)

987

ann_tag.setAttribute("value", value)

988

if_tag.appendChild(ann_tag)

1483

989

# Add the names to the return values for the

1484

990

# "org.freedesktop.DBus.Properties" methods

1485

991

if (if_tag.getAttribute("name")

1500

1006

except (AttributeError, xml.dom.DOMException,

1501

1007

xml.parsers.expat.ExpatError) as error:

1502

1008

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

1503

exc_info=error)

1504

return xmlstring

1505

1506

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1578

def datetime_to_dbus(dt, variant_level=0):

1009

error)

1010

return xmlstring

1011

1012

1013

def datetime_to_dbus (dt, variant_level=0):

1579

1014

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

1580

1015

if dt is None:

1581

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

1582

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

1583

1584

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1586

"""A class decorator; applied to a subclass of

1587

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

1588

interface names according to the "alt_interface_names" mapping.

1589

Usage:

1590

1591

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

1592

"net.example.AlternateInterface"})

1593

class SampleDBusObject(dbus.service.Object):

1594

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

1595

def SampleDBusMethod():

1596

pass

1597

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1599

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

1600

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

1601

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

1602

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

1603

1604

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

1605

(from DBusObjectWithProperties) and interfaces (from the

1606

dbus_interface_annotations decorator).

1016

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

1017

return dbus.String(dt.isoformat(),

1018

variant_level=variant_level)

1019

1020

1021

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1022

.__metaclass__):

1023

"""Applied to an empty subclass of a D-Bus object, this metaclass

1024

will add additional D-Bus attributes matching a certain pattern.

1607

1025

"""

1608

1609

def wrapper(cls):

1610

for orig_interface_name, alt_interface_name in (

1611

alt_interface_names.items()):

1612

attr = {}

1613

interface_names = set()

1614

# Go though all attributes of the class

1615

for attrname, attribute in inspect.getmembers(cls):

1026

def __new__(mcs, name, bases, attr):

1027

# Go through all the base classes which could have D-Bus

1028

# methods, signals, or properties in them

1029

old_interface_names = []

1030

for base in (b for b in bases

1031

if issubclass(b, dbus.service.Object)):

1032

# Go though all attributes of the base class

1033

for attrname, attribute in inspect.getmembers(base):

1616

1034

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

1617

1035

# with the wrong interface name

1618

1036

if (not hasattr(attribute, "_dbus_interface")

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1037

or not attribute._dbus_interface

1038

.startswith("se.recompile.Mandos")):

1621

1039

continue

1622

1040

# Create an alternate D-Bus interface name based on

1623

1041

# the current name

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1626

interface_names.add(alt_interface)

1042

alt_interface = (attribute._dbus_interface

1043

.replace("se.recompile.Mandos",

1044

"se.bsnet.fukt.Mandos"))

1045

if alt_interface != attribute._dbus_interface:

1046

old_interface_names.append(alt_interface)

1627

1047

# Is this a D-Bus signal?

1628

1048

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

1629

# Extract the original non-method undecorated

1630

# function by black magic

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1049

# Extract the original non-method function by

1050

# black magic

1051

nonmethod_func = (dict(

1633

1052

zip(attribute.func_code.co_freevars,

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1053

attribute.__closure__))["func"]

1054

.cell_contents)

1641

1055

# Create a new, but exactly alike, function

1642

1056

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

1643

1057

# with the alternate D-Bus interface name

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1058

new_function = (dbus.service.signal

1059

(alt_interface,

1060

attribute._dbus_signature)

1061

(types.FunctionType(

1062

nonmethod_func.func_code,

1063

nonmethod_func.func_globals,

1064

nonmethod_func.func_name,

1065

nonmethod_func.func_defaults,

1066

nonmethod_func.func_closure)))

1648

1067

# Copy annotations, if any

1649

1068

try:

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1069

new_function._dbus_annotations = (

1070

dict(attribute._dbus_annotations))

1652

1071

except AttributeError:

1653

1072

pass

1654

1655

1073

# Define a creator of a function to call both the

1656

# original and alternate functions, so both the

1657

# original and alternate signals gets sent when

1658

# the function is called

1074

# old and new functions, so both the old and new

1075

# signals gets sent when the function is called

1659

1076

def fixscope(func1, func2):

1660

1077

"""This function is a scope container to pass

1661

1078

func1 and func2 to the "call_both" function

1662

1079

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1665

1080

def call_both(*args, **kwargs):

1666

1081

"""This function will emit two D-Bus

1667

1082

signals by calling func1 and func2"""

1668

1083

func1(*args, **kwargs)

1669

1084

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1676

1085

return call_both

1677

1086

# Create the "call_both" function and add it to

1678

1087

# the class

1679

attr[attrname] = fixscope(attribute, new_function)

1088

attr[attrname] = fixscope(attribute,

1089

new_function)

1680

1090

# Is this a D-Bus method?

1681

1091

elif getattr(attribute, "_dbus_is_method", False):

1682

1092

# Create a new, but exactly alike, function

1683

1093

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

1684

1094

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

1685

1095

# to the class.

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1096

attr[attrname] = (dbus.service.method

1097

(alt_interface,

1098

attribute._dbus_in_signature,

1099

attribute._dbus_out_signature)

1100

(types.FunctionType

1101

(attribute.func_code,

1102

attribute.func_globals,

1103

attribute.func_name,

1104

attribute.func_defaults,

1105

attribute.func_closure)))

1692

1106

# Copy annotations, if any

1693

1107

try:

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1108

attr[attrname]._dbus_annotations = (

1109

dict(attribute._dbus_annotations))

1696

1110

except AttributeError:

1697

1111

pass

1698

1112

# Is this a D-Bus property?

1701

1115

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

1702

1116

# property with the alternate D-Bus interface

1703

1117

# name. Add it to the class.

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1118

attr[attrname] = (dbus_service_property

1119

(alt_interface,

1120

attribute._dbus_signature,

1121

attribute._dbus_access,

1122

attribute

1123

._dbus_get_args_options

1124

["byte_arrays"])

1125

(types.FunctionType

1126

(attribute.func_code,

1127

attribute.func_globals,

1128

attribute.func_name,

1129

attribute.func_defaults,

1130

attribute.func_closure)))

1710

1131

# Copy annotations, if any

1711

1132

try:

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1133

attr[attrname]._dbus_annotations = (

1134

dict(attribute._dbus_annotations))

1714

1135

except AttributeError:

1715

1136

pass

1716

1137

# Is this a D-Bus interface?

1719

1140

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

1720

1141

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

1721

1142

# to the class.

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1725

if deprecate:

1726

# Deprecate all alternate interfaces

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1728

for interface_name in interface_names:

1729

1730

@dbus_interface_annotations(interface_name)

1731

def func(self):

1732

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

1733

"true"}

1734

# Find an unused name

1735

for aname in (iname.format(i)

1736

for i in itertools.count()):

1737

if aname not in attr:

1738

attr[aname] = func

1739

break

1740

if interface_names:

1741

# Replace the class with a new subclass of it with

1742

# methods, signals, etc. as created above.

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1749

return cls

1750

1751

return wrapper

1752

1753

1754

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

1755

"se.bsnet.fukt.Mandos"})

1143

attr[attrname] = (dbus_interface_annotations

1144

(alt_interface)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1151

# Deprecate all old interfaces

1152

basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1153

for old_interface_name in old_interface_names:

1154

@dbus_interface_annotations(old_interface_name)

1155

def func(self):

1156

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

1157

# Find an unused name

1158

for aname in (basename.format(i) for i in

1159

itertools.count()):

1160

if aname not in attr:

1161

attr[aname] = func

1162

break

1163

return type.__new__(mcs, name, bases, attr)

1164

1165

1756

1166

class ClientDBus(Client, DBusObjectWithProperties):

1757

1167

"""A Client class using D-Bus

1758

1168

1759

1169

Attributes:

1760

1170

dbus_object_path: dbus.ObjectPath

1761

1171

bus: dbus.SystemBus()

1762

1172

"""

1763

1173

1764

1174

runtime_expansions = (Client.runtime_expansions

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1175

+ ("dbus_object_path",))

1176

1769

1177

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

1770

1771

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

1178

1179

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

1772

1180

self.bus = bus

1773

1181

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

1774

1182

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

1775

1183

# the D-Bus

1776

client_object_name = str(self.name).translate(

1184

client_object_name = unicode(self.name).translate(

1777

1185

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

1778

1186

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

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1187

self.dbus_object_path = (dbus.ObjectPath

1188

("/clients/" + client_object_name))

1781

1189

DBusObjectWithProperties.__init__(self, self.bus,

1782

1190

self.dbus_object_path)

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1191

1192

def notifychangeproperty(transform_func,

1193

dbus_name, type_func=lambda x: x,

1194

variant_level=1):

1789

1195

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

1790

1196

its changes to DBus.

1791

1197

1792

1198

transform_fun: Function that takes a value and a variant_level

1793

1199

and transforms it to a D-Bus type.

1794

1200

dbus_name: D-Bus name of the variable

1796

1202

to the D-Bus. Default: no transform

1797

1203

variant_level: D-Bus variant level. Default: 1

1798

1204

"""

1799

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

1800

1205

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

1801

1206

def setter(self, value):

1802

1207

if hasattr(self, "dbus_object_path"):

1803

1208

if (not hasattr(self, attrname) or

1804

1209

type_func(getattr(self, attrname, None))

1805

1210

!= type_func(value)):

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1211

dbus_value = transform_func(type_func(value),

1212

variant_level

1213

=variant_level)

1214

self.PropertyChanged(dbus.String(dbus_name),

1215

dbus_value)

1821

1216

setattr(self, attrname, value)

1822

1217

1823

1218

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

1824

1219

1220

1825

1221

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1826

1222

approvals_pending = notifychangeproperty(dbus.Boolean,

1827

1223

"ApprovalPending",

1828

type_func=bool)

1224

type_func = bool)

1829

1225

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

1830

1226

last_enabled = notifychangeproperty(datetime_to_dbus,

1831

1227

"LastEnabled")

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1228

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

1229

type_func = lambda checker:

1230

checker is not None)

1835

1231

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1836

1232

"LastCheckedOK")

1837

1233

last_checker_status = notifychangeproperty(dbus.Int16,

1840

1236

datetime_to_dbus, "LastApprovalRequest")

1841

1237

approved_by_default = notifychangeproperty(dbus.Boolean,

1842

1238

"ApprovedByDefault")

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1239

approval_delay = notifychangeproperty(dbus.UInt64,

1240

"ApprovalDelay",

1241

type_func =

1242

timedelta_to_milliseconds)

1846

1243

approval_duration = notifychangeproperty(

1847

1244

dbus.UInt64, "ApprovalDuration",

1848

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

1245

type_func = timedelta_to_milliseconds)

1849

1246

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

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1247

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

1248

type_func =

1249

timedelta_to_milliseconds)

1853

1250

extended_timeout = notifychangeproperty(

1854

1251

dbus.UInt64, "ExtendedTimeout",

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1252

type_func = timedelta_to_milliseconds)

1253

interval = notifychangeproperty(dbus.UInt64,

1254

"Interval",

1255

type_func =

1256

timedelta_to_milliseconds)

1859

1257

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

1860

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

1861

invalidate_only=True)

1862

1258

1863

1259

del notifychangeproperty

1864

1260

1865

1261

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

1866

1262

try:

1867

1263

self.remove_from_connection()

1870

1266

if hasattr(DBusObjectWithProperties, "__del__"):

1871

1267

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

1872

1268

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

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1269

1270

def checker_callback(self, pid, condition, command,

1271

*args, **kwargs):

1272

self.checker_callback_tag = None

1273

self.checker = None

1274

if os.WIFEXITED(condition):

1275

exitstatus = os.WEXITSTATUS(condition)

1881

1276

# Emit D-Bus signal

1882

1277

self.CheckerCompleted(dbus.Int16(exitstatus),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1278

dbus.Int64(condition),

1885

1279

dbus.String(command))

1886

1280

else:

1887

1281

# Emit D-Bus signal

1888

1282

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

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1283

dbus.Int64(condition),

1893

1284

dbus.String(command))

1894

return ret

1895

1285

1286

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

1287

*args, **kwargs)

1288

1896

1289

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

1897

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

1290

old_checker = self.checker

1291

if self.checker is not None:

1292

old_checker_pid = self.checker.pid

1293

else:

1294

old_checker_pid = None

1898

1295

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

1899

1296

# Only if new checker process was started

1900

1297

if (self.checker is not None

1902

1299

# Emit D-Bus signal

1903

1300

self.CheckerStarted(self.current_checker_command)

1904

1301

return r

1905

1302

1906

1303

def _reset_approved(self):

1907

1304

self.approved = None

1908

1305

return False

1909

1306

1910

1307

def approve(self, value=True):

1308

self.send_changedstate()

1911

1309

self.approved = value

1912

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

1913

* 1000), self._reset_approved)

1914

self.send_changedstate()

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1310

gobject.timeout_add(timedelta_to_milliseconds

1311

(self.approval_duration),

1312

self._reset_approved)

1313

1314

1315

## D-Bus methods, signals & properties

1316

_interface = "se.recompile.Mandos.Client"

1317

1318

## Interfaces

1319

1320

@dbus_interface_annotations(_interface)

1321

def _foo(self):

1322

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

1323

"false"}

1324

1325

## Signals

1326

1922

1327

# CheckerCompleted - signal

1923

1328

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

1924

1329

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

1925

1330

"D-Bus signal"

1926

1331

pass

1927

1332

1928

1333

# CheckerStarted - signal

1929

1334

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

1930

1335

def CheckerStarted(self, command):

1931

1336

"D-Bus signal"

1932

1337

pass

1933

1338

1934

1339

# PropertyChanged - signal

1935

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

1936

1340

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

1937

1341

def PropertyChanged(self, property, value):

1938

1342

"D-Bus signal"

1939

1343

pass

1940

1344

1941

1345

# GotSecret - signal

1942

1346

@dbus.service.signal(_interface)

1943

1347

def GotSecret(self):

1946

1350

server to mandos-client

1947

1351

"""

1948

1352

pass

1949

1353

1950

1354

# Rejected - signal

1951

1355

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

1952

1356

def Rejected(self, reason):

1953

1357

"D-Bus signal"

1954

1358

pass

1955

1359

1956

1360

# NeedApproval - signal

1957

1361

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

1958

1362

def NeedApproval(self, timeout, default):

1959

1363

"D-Bus signal"

1960

1364

return self.need_approval()

1961

1962

# Methods

1963

1365

1366

## Methods

1367

1964

1368

# Approve - method

1965

1369

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

1966

1370

def Approve(self, value):

1967

1371

self.approve(value)

1968

1372

1969

1373

# CheckedOK - method

1970

1374

@dbus.service.method(_interface)

1971

1375

def CheckedOK(self):

1972

1376

self.checked_ok()

1973

1377

1974

1378

# Enable - method

1975

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

1976

1379

@dbus.service.method(_interface)

1977

1380

def Enable(self):

1978

1381

"D-Bus method"

1979

1382

self.enable()

1980

1383

1981

1384

# StartChecker - method

1982

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

1983

1385

@dbus.service.method(_interface)

1984

1386

def StartChecker(self):

1985

1387

"D-Bus method"

1986

1388

self.start_checker()

1987

1389

1988

1390

# Disable - method

1989

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

1990

1391

@dbus.service.method(_interface)

1991

1392

def Disable(self):

1992

1393

"D-Bus method"

1993

1394

self.disable()

1994

1395

1995

1396

# StopChecker - method

1996

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

1997

1397

@dbus.service.method(_interface)

1998

1398

def StopChecker(self):

1999

1399

self.stop_checker()

2000

2001

# Properties

2002

1400

1401

## Properties

1402

2003

1403

# ApprovalPending - property

2004

1404

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

2005

1405

def ApprovalPending_dbus_property(self):

2006

1406

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

2007

1407

2008

1408

# ApprovedByDefault - property

2009

@dbus_service_property(_interface,

2010

signature="b",

1409

@dbus_service_property(_interface, signature="b",

2011

1410

access="readwrite")

2012

1411

def ApprovedByDefault_dbus_property(self, value=None):

2013

1412

if value is None: # get

2014

1413

return dbus.Boolean(self.approved_by_default)

2015

1414

self.approved_by_default = bool(value)

2016

1415

2017

1416

# ApprovalDelay - property

2018

@dbus_service_property(_interface,

2019

signature="t",

1417

@dbus_service_property(_interface, signature="t",

2020

1418

access="readwrite")

2021

1419

def ApprovalDelay_dbus_property(self, value=None):

2022

1420

if value is None: # get

2023

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

2024

* 1000)

1421

return dbus.UInt64(self.approval_delay_milliseconds())

2025

1422

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

2026

1423

2027

1424

# ApprovalDuration - property

2028

@dbus_service_property(_interface,

2029

signature="t",

1425

@dbus_service_property(_interface, signature="t",

2030

1426

access="readwrite")

2031

1427

def ApprovalDuration_dbus_property(self, value=None):

2032

1428

if value is None: # get

2033

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

2034

* 1000)

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

2035

1431

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

2036

1432

2037

1433

# Name - property

2038

@dbus_annotations(

2039

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

2040

1434

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

2041

1435

def Name_dbus_property(self):

2042

1436

return dbus.String(self.name)

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1437

2051

1438

# Fingerprint - property

2052

@dbus_annotations(

2053

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

2054

1439

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

2055

1440

def Fingerprint_dbus_property(self):

2056

1441

return dbus.String(self.fingerprint)

2057

1442

2058

1443

# Host - property

2059

@dbus_service_property(_interface,

2060

signature="s",

1444

@dbus_service_property(_interface, signature="s",

2061

1445

access="readwrite")

2062

1446

def Host_dbus_property(self, value=None):

2063

1447

if value is None: # get

2064

1448

return dbus.String(self.host)

2065

self.host = str(value)

2066

1449

self.host = unicode(value)

1450

2067

1451

# Created - property

2068

@dbus_annotations(

2069

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

2070

1452

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

2071

1453

def Created_dbus_property(self):

2072

1454

return datetime_to_dbus(self.created)

2073

1455

2074

1456

# LastEnabled - property

2075

1457

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

2076

1458

def LastEnabled_dbus_property(self):

2077

1459

return datetime_to_dbus(self.last_enabled)

2078

1460

2079

1461

# Enabled - property

2080

@dbus_service_property(_interface,

2081

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2082

1463

access="readwrite")

2083

1464

def Enabled_dbus_property(self, value=None):

2084

1465

if value is None: # get

2087

1468

self.enable()

2088

1469

else:

2089

1470

self.disable()

2090

1471

2091

1472

# LastCheckedOK - property

2092

@dbus_service_property(_interface,

2093

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2094

1474

access="readwrite")

2095

1475

def LastCheckedOK_dbus_property(self, value=None):

2096

1476

if value is not None:

2097

1477

self.checked_ok()

2098

1478

return

2099

1479

return datetime_to_dbus(self.last_checked_ok)

2100

1480

2101

1481

# LastCheckerStatus - property

2102

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

1482

@dbus_service_property(_interface, signature="n",

1483

access="read")

2103

1484

def LastCheckerStatus_dbus_property(self):

2104

1485

return dbus.Int16(self.last_checker_status)

2105

1486

2106

1487

# Expires - property

2107

1488

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

2108

1489

def Expires_dbus_property(self):

2109

1490

return datetime_to_dbus(self.expires)

2110

1491

2111

1492

# LastApprovalRequest - property

2112

1493

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

2113

1494

def LastApprovalRequest_dbus_property(self):

2114

1495

return datetime_to_dbus(self.last_approval_request)

2115

1496

2116

1497

# Timeout - property

2117

@dbus_service_property(_interface,

2118

signature="t",

1498

@dbus_service_property(_interface, signature="t",

2119

1499

access="readwrite")

2120

1500

def Timeout_dbus_property(self, value=None):

2121

1501

if value is None: # get

2122

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

2123

old_timeout = self.timeout

1502

return dbus.UInt64(self.timeout_milliseconds())

2124

1503

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

2125

# Reschedule disabling

1504

# Reschedule timeout

2126

1505

if self.enabled:

2127

1506

now = datetime.datetime.utcnow()

2128

self.expires += self.timeout - old_timeout

2129

if self.expires <= now:

1507

time_to_die = timedelta_to_milliseconds(

1508

(self.last_checked_ok + self.timeout) - now)

1509

if time_to_die <= 0:

2130

1510

# The timeout has passed

2131

1511

self.disable()

2132

1512

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

2133

1516

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

2134

1517

is None):

2135

1518

return

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1519

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1523

2141

1524

# ExtendedTimeout - property

2142

@dbus_service_property(_interface,

2143

signature="t",

1525

@dbus_service_property(_interface, signature="t",

2144

1526

access="readwrite")

2145

1527

def ExtendedTimeout_dbus_property(self, value=None):

2146

1528

if value is None: # get

2147

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

2148

* 1000)

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

2149

1530

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

2150

1531

2151

1532

# Interval - property

2152

@dbus_service_property(_interface,

2153

signature="t",

1533

@dbus_service_property(_interface, signature="t",

2154

1534

access="readwrite")

2155

1535

def Interval_dbus_property(self, value=None):

2156

1536

if value is None: # get

2157

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

1537

return dbus.UInt64(self.interval_milliseconds())

2158

1538

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

2159

1539

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

2160

1540

return

2161

1541

if self.enabled:

2162

1542

# Reschedule checker run

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1543

gobject.source_remove(self.checker_initiator_tag)

1544

self.checker_initiator_tag = (gobject.timeout_add

1545

(value, self.start_checker))

1546

self.start_checker() # Start one now, too

1547

2168

1548

# Checker - property

2169

@dbus_service_property(_interface,

2170

signature="s",

1549

@dbus_service_property(_interface, signature="s",

2171

1550

access="readwrite")

2172

1551

def Checker_dbus_property(self, value=None):

2173

1552

if value is None: # get

2174

1553

return dbus.String(self.checker_command)

2175

self.checker_command = str(value)

2176

1554

self.checker_command = unicode(value)

1555

2177

1556

# CheckerRunning - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1557

@dbus_service_property(_interface, signature="b",

2180

1558

access="readwrite")

2181

1559

def CheckerRunning_dbus_property(self, value=None):

2182

1560

if value is None: # get

2185

1563

self.start_checker()

2186

1564

else:

2187

1565

self.stop_checker()

2188

1566

2189

1567

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

2193

1568

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

2194

1569

def ObjectPath_dbus_property(self):

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1570

return self.dbus_object_path # is already a dbus.ObjectPath

1571

2197

1572

# Secret = property

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1573

@dbus_service_property(_interface, signature="ay",

1574

access="write", byte_arrays=True)

2205

1575

def Secret_dbus_property(self, value):

2206

self.secret = bytes(value)

2207

1576

self.secret = str(value)

1577

2208

1578

del _interface

2209

1579

2210

1580

2211

1581

class ProxyClient(object):

2212

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

1582

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

2213

1583

self._pipe = child_pipe

2214

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

1584

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

2215

1585

if not self._pipe.recv():

2216

raise KeyError(key_id or fpr)

2217

1586

raise KeyError()

1587

2218

1588

def __getattribute__(self, name):

2219

1589

if name == '_pipe':

2220

1590

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

2223

1593

if data[0] == 'data':

2224

1594

return data[1]

2225

1595

if data[0] == 'function':

2226

2227

1596

def func(*args, **kwargs):

2228

1597

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

2229

1598

return self._pipe.recv()[1]

2230

2231

1599

return func

2232

1600

2233

1601

def __setattr__(self, name, value):

2234

1602

if name == '_pipe':

2235

1603

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

2236

1604

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

2237

1605

2238

1606

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

2239

1611

class ClientHandler(socketserver.BaseRequestHandler, object):

2240

1612

"""A class to handle client connections.

2241

1613

2242

1614

Instantiated once for each connection to handle it.

2243

1615

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

2244

1616

2245

1617

def handle(self):

2246

1618

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

2247

1619

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

2248

str(self.client_address))

1620

unicode(self.client_address))

2249

1621

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

2250

1622

self.server.child_pipe.fileno())

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1623

1624

session = (gnutls.connection

1625

.ClientSession(self.request,

1626

gnutls.connection

1627

.X509Credentials()))

1628

1629

# Note: gnutls.connection.X509Credentials is really a

1630

# generic GnuTLS certificate credentials object so long as

1631

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

1632

# here despite using OpenPGP certificates.

1633

1634

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

1635

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

1636

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

1637

# "+DHE-DSS"))

2258

1638

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

2259

1639

priority = self.server.gnutls_priority

2260

1640

if priority is None:

2261

1641

priority = "NORMAL"

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1642

(gnutls.library.functions

1643

.gnutls_priority_set_direct(session._c_object,

1644

priority, None))

1645

2266

1646

# Start communication using the Mandos protocol

2267

1647

# Get protocol number

2268

1648

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

2269

1649

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

2270

1650

try:

2271

1651

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

2272

raise RuntimeError(line)

1652

raise RuntimeError

2273

1653

except (ValueError, IndexError, RuntimeError) as error:

2274

1654

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

2275

1655

return

2276

1656

2277

1657

# Start GnuTLS connection

2278

1658

try:

2279

1659

session.handshake()

2280

except gnutls.Error as error:

1660

except gnutls.errors.GNUTLSError as error:

2281

1661

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

2282

1662

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

2283

1663

# established. Just abandon the request.

2284

1664

return

2285

1665

logger.debug("Handshake succeeded")

2286

1666

2287

1667

approval_required = False

2288

1668

try:

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1669

try:

1670

fpr = self.fingerprint(self.peer_certificate

1671

(session))

1672

except (TypeError,

1673

gnutls.errors.GNUTLSError) as error:

1674

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

1675

return

1676

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

1677

1678

try:

1679

client = ProxyClient(child_pipe, fpr,

2311

1680

self.client_address)

2312

1681

except KeyError:

2313

1682

return

2314

1683

2315

1684

if client.approval_delay:

2316

1685

delay = client.approval_delay

2317

1686

client.approvals_pending += 1

2318

1687

approval_required = True

2319

1688

2320

1689

while True:

2321

1690

if not client.enabled:

2322

1691

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

2323

client.name)

1692

client.name)

2324

1693

if self.server.use_dbus:

2325

1694

# Emit D-Bus signal

2326

1695

client.Rejected("Disabled")

2327

1696

return

2328

1697

2329

1698

if client.approved or not client.approval_delay:

2330

# We are approved or approval is disabled

1699

#We are approved or approval is disabled

2331

1700

break

2332

1701

elif client.approved is None:

2333

1702

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

2335

1704

if self.server.use_dbus:

2336

1705

# Emit D-Bus signal

2337

1706

client.NeedApproval(

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

2340

1709

else:

2341

1710

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

2342

1711

client.name)

2344

1713

# Emit D-Bus signal

2345

1714

client.Rejected("Denied")

2346

1715

return

2347

2348

# wait until timeout or approved

1716

1717

#wait until timeout or approved

2349

1718

time = datetime.datetime.now()

2350

1719

client.changedstate.acquire()

2351

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

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

2352

1723

client.changedstate.release()

2353

1724

time2 = datetime.datetime.now()

2354

1725

if (time2 - time) >= delay:

2364

1735

break

2365

1736

else:

2366

1737

delay -= time2 - time

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1738

1739

sent_size = 0

1740

while sent_size < len(client.secret):

1741

try:

1742

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

1743

except gnutls.errors.GNUTLSError as error:

1744

logger.warning("gnutls send failed")

1745

return

1746

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

1747

sent, len(client.secret)

1748

- (sent_size + sent))

1749

sent_size += sent

1750

2375

1751

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

2376

1752

# bump the timeout using extended_timeout

2377

1753

client.bump_timeout(client.extended_timeout)

2378

1754

if self.server.use_dbus:

2379

1755

# Emit D-Bus signal

2380

1756

client.GotSecret()

2381

1757

2382

1758

finally:

2383

1759

if approval_required:

2384

1760

client.approvals_pending -= 1

2385

1761

try:

2386

1762

session.bye()

2387

except gnutls.Error as error:

2388

logger.warning("GnuTLS bye failed",

2389

exc_info=error)

2390

1763

except gnutls.errors.GNUTLSError as error:

1764

logger.warning("GnuTLS bye failed")

1765

2391

1766

@staticmethod

2392

1767

def peer_certificate(session):

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1768

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

1769

# If not an OpenPGP certificate...

1770

if (gnutls.library.functions

1771

.gnutls_certificate_type_get(session._c_object)

1772

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1773

# ...do the normal thing

1774

return session.peer_certificate

2409

1775

list_size = ctypes.c_uint(1)

2410

cert_list = (gnutls.certificate_get_peers

1776

cert_list = (gnutls.library.functions

1777

.gnutls_certificate_get_peers

2411

1778

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

2412

1779

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

2413

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

1780

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

1781

" certificate")

2414

1782

if list_size.value == 0:

2415

1783

return None

2416

1784

cert = cert_list[0]

2417

1785

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

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1786

2453

1787

@staticmethod

2454

1788

def fingerprint(openpgp):

2455

1789

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2456

1790

# New GnuTLS "datum" with the OpenPGP public key

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1791

datum = (gnutls.library.types

1792

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

1793

ctypes.POINTER

1794

(ctypes.c_ubyte)),

1795

ctypes.c_uint(len(openpgp))))

2461

1796

# New empty GnuTLS certificate

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1797

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1798

(gnutls.library.functions

1799

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2464

1800

# Import the OpenPGP public key into the certificate

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1801

(gnutls.library.functions

1802

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

1803

gnutls.library.constants

1804

.GNUTLS_OPENPGP_FMT_RAW))

2467

1805

# Verify the self signature in the key

2468

1806

crtverify = ctypes.c_uint()

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1807

(gnutls.library.functions

1808

.gnutls_openpgp_crt_verify_self(crt, 0,

1809

ctypes.byref(crtverify)))

2471

1810

if crtverify.value != 0:

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1811

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1812

raise (gnutls.errors.CertificateSecurityError

1813

("Verify failed"))

2475

1814

# New buffer for the fingerprint

2476

1815

buf = ctypes.create_string_buffer(20)

2477

1816

buf_len = ctypes.c_size_t()

2478

1817

# Get the fingerprint from the certificate into the buffer

2479

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

2480

ctypes.byref(buf_len))

1818

(gnutls.library.functions

1819

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

1820

ctypes.byref(buf_len)))

2481

1821

# Deinit the certificate

2482

gnutls.openpgp_crt_deinit(crt)

1822

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

1823

# Convert the buffer to a Python bytestring

2484

1824

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

2485

1825

# Convert the bytestring to hexadecimal notation

2489

1829

2490

1830

class MultiprocessingMixIn(object):

2491

1831

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

2492

2493

1832

def sub_process_main(self, request, address):

2494

1833

try:

2495

1834

self.finish_request(request, address)

2496

1835

except Exception:

2497

1836

self.handle_error(request, address)

2498

1837

self.close_request(request)

2499

1838

2500

1839

def process_request(self, request, address):

2501

1840

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

2502

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

2503

args=(request, address))

1841

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

1842

args = (request,

1843

address))

2504

1844

proc.start()

2505

1845

return proc

2506

1846

2507

1847

2508

1848

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2509

1849

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

2510

2511

1850

def process_request(self, request, client_address):

2512

1851

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

2513

1852

2514

1853

This function creates a new pipe in self.pipe

2515

1854

"""

2516

1855

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2517

1856

2518

1857

proc = MultiprocessingMixIn.process_request(self, request,

2519

1858

client_address)

2520

1859

self.child_pipe.close()

2521

1860

self.add_pipe(parent_pipe, proc)

2522

1861

2523

1862

def add_pipe(self, parent_pipe, proc):

2524

1863

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

2525

raise NotImplementedError()

1864

raise NotImplementedError

2526

1865

2527

1866

2528

1867

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2529

1868

socketserver.TCPServer, object):

2530

1869

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

2531

1870

2532

1871

Attributes:

2533

1872

enabled: Boolean; whether this server is activated yet

2534

1873

interface: None or a network interface name (string)

2535

1874

use_ipv6: Boolean; to use IPv6 or not

2536

1875

"""

2537

2538

1876

def __init__(self, server_address, RequestHandlerClass,

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

2542

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

2543

creating a new one with socket.socket().

2544

"""

1877

interface=None, use_ipv6=True):

2545

1878

self.interface = interface

2546

1879

if use_ipv6:

2547

1880

self.address_family = socket.AF_INET6

2548

if socketfd is not None:

2549

# Save the file descriptor

2550

self.socketfd = socketfd

2551

# Save the original socket.socket() function

2552

self.socket_socket = socket.socket

2553

2554

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

2555

#

2556

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

2557

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

2558

# patching socket.socket.)

2559

#

2560

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

2561

@functools.wraps(socket.socket)

2562

def socket_wrapper(*args, **kwargs):

2563

# Restore original function so subsequent calls are

2564

# not affected.

2565

socket.socket = self.socket_socket

2566

del self.socket_socket

2567

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

2568

# saved file descriptor.

2569

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

2570

# Replace socket.socket() function with wrapper

2571

socket.socket = socket_wrapper

2572

# The socketserver.TCPServer.__init__ will call

2573

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

2574

# socket_wrapper(), if socketfd was set.

2575

1881

socketserver.TCPServer.__init__(self, server_address,

2576

1882

RequestHandlerClass)

2577

2578

1883

def server_bind(self):

2579

1884

"""This overrides the normal server_bind() function

2580

1885

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

2581

1886

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

2582

global SO_BINDTODEVICE

2583

1887

if self.interface is not None:

2584

1888

if SO_BINDTODEVICE is None:

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1889

logger.error("SO_BINDTODEVICE does not exist;"

1890

" cannot bind to interface %s",

1891

self.interface)

1892

else:

1893

try:

1894

self.socket.setsockopt(socket.SOL_SOCKET,

1895

SO_BINDTODEVICE,

1896

str(self.interface

1897

+ '\0'))

1898

except socket.error as error:

1899

if error[0] == errno.EPERM:

1900

logger.error("No permission to"

1901

" bind to interface %s",

1902

self.interface)

1903

elif error[0] == errno.ENOPROTOOPT:

1904

logger.error("SO_BINDTODEVICE not available;"

1905

" cannot bind to interface %s",

1906

self.interface)

1907

else:

1908

raise

2606

1909

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

2607

1910

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

2608

if self.server_address[1]:

2609

self.allow_reuse_address = True

2610

1911

if not self.server_address[0]:

2611

1912

if self.address_family == socket.AF_INET6:

2612

any_address = "::" # in6addr_any

1913

any_address = "::" # in6addr_any

2613

1914

else:

2614

any_address = "0.0.0.0" # INADDR_ANY

1915

any_address = socket.INADDR_ANY

2615

1916

self.server_address = (any_address,

2616

1917

self.server_address[1])

2617

1918

elif not self.server_address[1]:

2618

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

1919

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

1920

0)

2619

1921

# if self.interface:

2620

1922

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

2621

1923

# 0, # port

2627

1929

2628

1930

class MandosServer(IPv6_TCPServer):

2629

1931

"""Mandos server.

2630

1932

2631

1933

Attributes:

2632

1934

clients: set of Client objects

2633

1935

gnutls_priority GnuTLS priority string

2634

1936

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

2635

2636

Assumes a GLib.MainLoop event loop.

1937

1938

Assumes a gobject.MainLoop event loop.

2637

1939

"""

2638

2639

1940

def __init__(self, server_address, RequestHandlerClass,

2640

interface=None,

2641

use_ipv6=True,

2642

clients=None,

2643

gnutls_priority=None,

2644

use_dbus=True,

2645

socketfd=None):

1941

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

1942

gnutls_priority=None, use_dbus=True):

2646

1943

self.enabled = False

2647

1944

self.clients = clients

2648

1945

if self.clients is None:

2651

1948

self.gnutls_priority = gnutls_priority

2652

1949

IPv6_TCPServer.__init__(self, server_address,

2653

1950

RequestHandlerClass,

2654

interface=interface,

2655

use_ipv6=use_ipv6,

2656

socketfd=socketfd)

2657

1951

interface = interface,

1952

use_ipv6 = use_ipv6)

2658

1953

def server_activate(self):

2659

1954

if self.enabled:

2660

1955

return socketserver.TCPServer.server_activate(self)

2661

1956

2662

1957

def enable(self):

2663

1958

self.enabled = True

2664

1959

2665

1960

def add_pipe(self, parent_pipe, proc):

2666

1961

# Call "handle_ipc" for both data and EOF events

2667

GLib.io_add_watch(

2668

parent_pipe.fileno(),

2669

GLib.IO_IN | GLib.IO_HUP,

2670

functools.partial(self.handle_ipc,

2671

parent_pipe=parent_pipe,

2672

proc=proc))

2673

2674

def handle_ipc(self, source, condition,

2675

parent_pipe=None,

2676

proc=None,

2677

client_object=None):

1962

gobject.io_add_watch(parent_pipe.fileno(),

1963

gobject.IO_IN | gobject.IO_HUP,

1964

functools.partial(self.handle_ipc,

1965

parent_pipe =

1966

parent_pipe,

1967

proc = proc))

1968

1969

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

1970

proc = None, client_object=None):

1971

condition_names = {

1972

gobject.IO_IN: "IN", # There is data to read.

1973

gobject.IO_OUT: "OUT", # Data can be written (without

1974

# blocking).

1975

gobject.IO_PRI: "PRI", # There is urgent data to read.

1976

gobject.IO_ERR: "ERR", # Error condition.

1977

gobject.IO_HUP: "HUP" # Hung up (the connection has been

1978

# broken, usually for pipes and

1979

# sockets).

1980

}

1981

conditions_string = ' | '.join(name

1982

for cond, name in

1983

condition_names.iteritems()

1984

if cond & condition)

2678

1985

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

2679

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

1986

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

2680

1987

# Wait for other process to exit

2681

1988

proc.join()

2682

1989

return False

2683

1990

2684

1991

# Read a request from the child

2685

1992

request = parent_pipe.recv()

2686

1993

command = request[0]

2687

1994

2688

1995

if command == 'init':

2689

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

2690

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

2691

address = request[3]

2692

2693

for c in self.clients.values():

2694

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2695

continue

2696

if key_id and c.key_id == key_id:

2697

client = c

2698

break

2699

if fpr and c.fingerprint == fpr:

1996

fpr = request[1]

1997

address = request[2]

1998

1999

for c in self.clients.itervalues():

2000

if c.fingerprint == fpr:

2700

2001

client = c

2701

2002

break

2702

2003

else:

2703

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

2704

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

2004

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

2005

"dress: %s", fpr, address)

2705

2006

if self.use_dbus:

2706

2007

# Emit D-Bus signal

2707

mandos_dbus_service.ClientNotFound(key_id or fpr,

2008

mandos_dbus_service.ClientNotFound(fpr,

2708

2009

address[0])

2709

2010

parent_pipe.send(False)

2710

2011

return False

2711

2712

GLib.io_add_watch(

2713

parent_pipe.fileno(),

2714

GLib.IO_IN | GLib.IO_HUP,

2715

functools.partial(self.handle_ipc,

2716

parent_pipe=parent_pipe,

2717

proc=proc,

2718

client_object=client))

2012

2013

gobject.io_add_watch(parent_pipe.fileno(),

2014

gobject.IO_IN | gobject.IO_HUP,

2015

functools.partial(self.handle_ipc,

2016

parent_pipe =

2017

parent_pipe,

2018

proc = proc,

2019

client_object =

2020

client))

2719

2021

parent_pipe.send(True)

2720

2022

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

2721

2023

# same fileno

2724

2026

funcname = request[1]

2725

2027

args = request[2]

2726

2028

kwargs = request[3]

2727

2029

2728

2030

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

2729

2031

funcname)(*args,

2730

**kwargs)))

2731

2032

**kwargs)))

2033

2732

2034

if command == 'getattr':

2733

2035

attrname = request[1]

2734

if isinstance(client_object.__getattribute__(attrname),

2735

collections.Callable):

2736

parent_pipe.send(('function', ))

2036

if callable(client_object.__getattribute__(attrname)):

2037

parent_pipe.send(('function',))

2737

2038

else:

2738

parent_pipe.send((

2739

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

2740

2039

parent_pipe.send(('data', client_object

2040

.__getattribute__(attrname)))

2041

2741

2042

if command == 'setattr':

2742

2043

attrname = request[1]

2743

2044

value = request[2]

2744

2045

setattr(client_object, attrname, value)

2745

2046

2746

2047

return True

2747

2048

2748

2049

2749

def rfc3339_duration_to_delta(duration):

2750

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

2751

2752

>>> rfc3339_duration_to_delta("P7D")

2753

datetime.timedelta(7)

2754

>>> rfc3339_duration_to_delta("PT60S")

2755

datetime.timedelta(0, 60)

2756

>>> rfc3339_duration_to_delta("PT60M")

2757

datetime.timedelta(0, 3600)

2758

>>> rfc3339_duration_to_delta("PT24H")

2759

datetime.timedelta(1)

2760

>>> rfc3339_duration_to_delta("P1W")

2761

datetime.timedelta(7)

2762

>>> rfc3339_duration_to_delta("PT5M30S")

2763

datetime.timedelta(0, 330)

2764

>>> rfc3339_duration_to_delta("P1DT3M20S")

2765

datetime.timedelta(1, 200)

2766

"""

2767

2768

# Parsing an RFC 3339 duration with regular expressions is not

2769

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

2770

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

2771

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

2772

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

2773

# avoid excessive use of external libraries.

2774

2775

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

2776

Token = collections.namedtuple("Token", (

2777

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

2778

# a "group" containing digits

2779

"value", # datetime.timedelta or None

2780

"followers")) # Tokens valid after this token

2781

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

2782

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

2783

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

2784

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

2785

datetime.timedelta(seconds=1),

2786

frozenset((token_end, )))

2787

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

2788

datetime.timedelta(minutes=1),

2789

frozenset((token_second, token_end)))

2790

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

2791

datetime.timedelta(hours=1),

2792

frozenset((token_minute, token_end)))

2793

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

2794

None,

2795

frozenset((token_hour, token_minute,

2796

token_second)))

2797

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

2798

datetime.timedelta(days=1),

2799

frozenset((token_time, token_end)))

2800

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

2801

datetime.timedelta(weeks=4),

2802

frozenset((token_day, token_end)))

2803

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

2804

datetime.timedelta(weeks=52),

2805

frozenset((token_month, token_end)))

2806

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

2807

datetime.timedelta(weeks=1),

2808

frozenset((token_end, )))

2809

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

2810

frozenset((token_year, token_month,

2811

token_day, token_time,

2812

token_week)))

2813

# Define starting values:

2814

# Value so far

2815

value = datetime.timedelta()

2816

found_token = None

2817

# Following valid tokens

2818

followers = frozenset((token_duration, ))

2819

# String left to parse

2820

s = duration

2821

# Loop until end token is found

2822

while found_token is not token_end:

2823

# Search for any currently valid tokens

2824

for token in followers:

2825

match = token.regexp.match(s)

2826

if match is not None:

2827

# Token found

2828

if token.value is not None:

2829

# Value found, parse digits

2830

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

2831

# Add to value so far

2832

value += factor * token.value

2833

# Strip token from string

2834

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

2835

# Go to found token

2836

found_token = token

2837

# Set valid next tokens

2838

followers = found_token.followers

2839

break

2840

else:

2841

# No currently valid tokens were found

2842

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

2843

.format(duration))

2844

# End token found

2845

return value

2846

2847

2848

2050

def string_to_delta(interval):

2849

2051

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

2850

2052

2851

2053

>>> string_to_delta('7d')

2852

2054

datetime.timedelta(7)

2853

2055

>>> string_to_delta('60s')

2861

2063

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

2862

2064

datetime.timedelta(0, 330)

2863

2065

"""

2864

2865

try:

2866

return rfc3339_duration_to_delta(interval)

2867

except ValueError:

2868

pass

2869

2870

2066

timevalue = datetime.timedelta(0)

2871

2067

for s in interval.split():

2872

2068

try:

2873

suffix = s[-1]

2069

suffix = unicode(s[-1])

2874

2070

value = int(s[:-1])

2875

2071

if suffix == "d":

2876

2072

delta = datetime.timedelta(value)

2883

2079

elif suffix == "w":

2884

2080

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

2885

2081

else:

2886

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

2887

except IndexError as e:

2082

raise ValueError("Unknown suffix %r" % suffix)

2083

except (ValueError, IndexError) as e:

2888

2084

raise ValueError(*(e.args))

2889

2085

timevalue += delta

2890

2086

return timevalue

2891

2087

2892

2088

2893

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

2089

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

2894

2090

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

2895

2091

2896

2092

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

2897

2093

if os.fork():

2898

2094

sys.exit()

2906

2102

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

2907

2103

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

2908

2104

raise OSError(errno.ENODEV,

2909

"{} not a character device"

2910

.format(os.devnull))

2105

"%s not a character device"

2106

% os.devnull)

2911

2107

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

2912

2108

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

2913

2109

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

2916

2112

2917

2113

2918

2114

def main():

2919

2115

2920

2116

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

2921

2117

# Parsing of options, both command line and config file

2922

2118

2923

2119

parser = argparse.ArgumentParser()

2924

2120

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

2925

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

2121

version = "%%(prog)s %s" % version,

2926

2122

help="show version number and exit")

2927

2123

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

2928

2124

help="Bind to interface IF")

2934

2130

help="Run self-test")

2935

2131

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

2936

2132

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

2937

" to terminal", default=None)

2133

" to terminal")

2938

2134

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

2939

2135

help="Debug level for stdout output")

2940

2136

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

2947

2143

" files")

2948

2144

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

2949

2145

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

2950

" system bus interface", default=None)

2146

" system bus interface")

2951

2147

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

2952

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

2953

default=None)

2148

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

2954

2149

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

2955

2150

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

2956

" state", default=None)

2957

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

2958

help="Specify a file descriptor to a network"

2959

" socket to use instead of creating one")

2151

" state")

2960

2152

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

2961

2153

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

2962

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

2963

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

2964

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

2965

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

2966

default=None)

2967

2154

2968

2155

options = parser.parse_args()

2969

2156

2970

2157

if options.check:

2971

2158

import doctest

2972

fail_count, test_count = doctest.testmod()

2973

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

2974

2159

doctest.testmod()

2160

sys.exit()

2161

2975

2162

# Default values for config file for server-global settings

2976

if gnutls.has_rawpk:

2977

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

2978

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

2979

else:

2980

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

2981

":+SIGN-DSA-SHA256")

2982

server_defaults = {"interface": "",

2983

"address": "",

2984

"port": "",

2985

"debug": "False",

2986

"priority": priority,

2987

"servicename": "Mandos",

2988

"use_dbus": "True",

2989

"use_ipv6": "True",

2990

"debuglevel": "",

2991

"restore": "True",

2992

"socket": "",

2993

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

2994

"foreground": "False",

2995

"zeroconf": "True",

2996

}

2997

del priority

2998

2163

server_defaults = { "interface": "",

2164

"address": "",

2165

"port": "",

2166

"debug": "False",

2167

"priority":

2168

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

2169

"servicename": "Mandos",

2170

"use_dbus": "True",

2171

"use_ipv6": "True",

2172

"debuglevel": "",

2173

"restore": "True",

2174

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

2175

}

2176

2999

2177

# Parse config file for server-global settings

3000

2178

server_config = configparser.SafeConfigParser(server_defaults)

3001

2179

del server_defaults

3002

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

2180

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

2181

"mandos.conf"))

3003

2182

# Convert the SafeConfigParser object to a dict

3004

2183

server_settings = server_config.defaults()

3005

2184

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

3006

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

3007

"foreground", "zeroconf"):

2185

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

3008

2186

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

3009

2187

option)

3010

2188

if server_settings["port"]:

3011

2189

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

3012

2190

"port")

3013

if server_settings["socket"]:

3014

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

3015

"socket")

3016

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

3017

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

3018

# happen with a supplied network socket.

3019

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

3020

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

3021

["socket"])

3022

2191

del server_config

3023

2192

3024

2193

# Override the settings from the config file with command line

3025

2194

# options, if set.

3026

2195

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

3027

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

3028

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

3029

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

2196

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

2197

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

2198

"statedir"):

3030

2199

value = getattr(options, option)

3031

2200

if value is not None:

3032

2201

server_settings[option] = value

3033

2202

del options

3034

2203

# Force all strings to be unicode

3035

2204

for option in server_settings.keys():

3036

if isinstance(server_settings[option], bytes):

3037

server_settings[option] = (server_settings[option]

3038

.decode("utf-8"))

3039

# Force all boolean options to be boolean

3040

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

3041

"foreground", "zeroconf"):

3042

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

3043

# Debug implies foreground

3044

if server_settings["debug"]:

3045

server_settings["foreground"] = True

2205

if type(server_settings[option]) is str:

2206

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

3046

2207

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

3047

2208

3048

2209

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

3049

3050

if (not server_settings["zeroconf"]

3051

and not (server_settings["port"]

3052

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

3053

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

3054

2210

3055

2211

# For convenience

3056

2212

debug = server_settings["debug"]

3057

2213

debuglevel = server_settings["debuglevel"]

3059

2215

use_ipv6 = server_settings["use_ipv6"]

3060

2216

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

3061

2217

stored_state_file)

3062

foreground = server_settings["foreground"]

3063

zeroconf = server_settings["zeroconf"]

3064

2218

3065

2219

if debug:

3066

2220

initlogger(debug, logging.DEBUG)

3067

2221

else:

3070

2224

else:

3071

2225

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

3072

2226

initlogger(debug, level)

3073

2227

3074

2228

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

3075

syslogger.setFormatter(

3076

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

3077

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

3078

server_settings["servicename"])))

3079

2229

syslogger.setFormatter(logging.Formatter

2230

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

2231

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

2232

% server_settings["servicename"]))

2233

3080

2234

# Parse config file with clients

3081

2235

client_config = configparser.SafeConfigParser(Client

3082

2236

.client_defaults)

3083

2237

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

3084

2238

"clients.conf"))

3085

2239

3086

2240

global mandos_dbus_service

3087

2241

mandos_dbus_service = None

3088

3089

socketfd = None

3090

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

3091

socketfd = server_settings["socket"]

3092

tcp_server = MandosServer(

3093

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

3094

ClientHandler,

3095

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

3096

use_ipv6=use_ipv6,

3097

gnutls_priority=server_settings["priority"],

3098

use_dbus=use_dbus,

3099

socketfd=socketfd)

3100

if not foreground:

3101

pidfilename = "/run/mandos.pid"

3102

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

3103

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

3104

pidfile = None

3105

try:

3106

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

3107

except IOError as e:

3108

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

3109

exc_info=e)

3110

3111

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

3112

("mandos", "mandos"),

3113

("nobody", "nogroup")):

3114

try:

3115

uid = pwd.getpwnam(name).pw_uid

3116

gid = pwd.getpwnam(group).pw_gid

3117

break

2242

2243

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

2244

server_settings["port"]),

2245

ClientHandler,

2246

interface=(server_settings["interface"]

2247

or None),

2248

use_ipv6=use_ipv6,

2249

gnutls_priority=

2250

server_settings["priority"],

2251

use_dbus=use_dbus)

2252

if not debug:

2253

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

2254

try:

2255

pidfile = open(pidfilename, "w")

2256

except IOError:

2257

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

2258

2259

try:

2260

uid = pwd.getpwnam("_mandos").pw_uid

2261

gid = pwd.getpwnam("_mandos").pw_gid

2262

except KeyError:

2263

try:

2264

uid = pwd.getpwnam("mandos").pw_uid

2265

gid = pwd.getpwnam("mandos").pw_gid

3118

2266

except KeyError:

3119

continue

3120

else:

3121

uid = 65534

3122

gid = 65534

2267

try:

2268

uid = pwd.getpwnam("nobody").pw_uid

2269

gid = pwd.getpwnam("nobody").pw_gid

2270

except KeyError:

2271

uid = 65534

2272

gid = 65534

3123

2273

try:

3124

2274

os.setgid(gid)

3125

2275

os.setuid(uid)

3126

if debug:

3127

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

3128

gid))

3129

2276

except OSError as error:

3130

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

3131

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

3132

if error.errno != errno.EPERM:

3133

raise

3134

2277

if error[0] != errno.EPERM:

2278

raise error

2279

3135

2280

if debug:

3136

2281

# Enable all possible GnuTLS debugging

3137

2282

3138

2283

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

3139

2284

# - GnuTLS manual

3140

gnutls.global_set_log_level(11)

3141

3142

@gnutls.log_func

2285

gnutls.library.functions.gnutls_global_set_log_level(11)

2286

2287

@gnutls.library.types.gnutls_log_func

3143

2288

def debug_gnutls(level, string):

3144

2289

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

3145

3146

gnutls.global_set_log_function(debug_gnutls)

3147

2290

2291

(gnutls.library.functions

2292

.gnutls_global_set_log_function(debug_gnutls))

2293

3148

2294

# Redirect stdin so all checkers get /dev/null

3149

2295

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

3150

2296

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

3151

2297

if null > 2:

3152

2298

os.close(null)

3153

2299

3154

2300

# Need to fork before connecting to D-Bus

3155

if not foreground:

2301

if not debug:

3156

2302

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

3157

2303

daemon()

3158

3159

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

3160

# to inform GLib that threads will be used.

3161

GLib.threads_init()

3162

2304

2305

gobject.threads_init()

2306

3163

2307

global main_loop

3164

2308

# From the Avahi example code

3165

2309

DBusGMainLoop(set_as_default=True)

3166

main_loop = GLib.MainLoop()

2310

main_loop = gobject.MainLoop()

3167

2311

bus = dbus.SystemBus()

3168

2312

# End of Avahi example code

3169

2313

if use_dbus:

3170

2314

try:

3171

2315

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

3172

bus,

3173

do_not_queue=True)

3174

old_bus_name = dbus.service.BusName(

3175

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

3176

do_not_queue=True)

3177

except dbus.exceptions.DBusException as e:

3178

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

2316

bus, do_not_queue=True)

2317

old_bus_name = (dbus.service.BusName

2318

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

2319

do_not_queue=True))

2320

except dbus.exceptions.NameExistsException as e:

2321

logger.error(unicode(e) + ", disabling D-Bus")

3179

2322

use_dbus = False

3180

2323

server_settings["use_dbus"] = False

3181

2324

tcp_server.use_dbus = False

3182

if zeroconf:

3183

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3184

service = AvahiServiceToSyslog(

3185

name=server_settings["servicename"],

3186

servicetype="_mandos._tcp",

3187

protocol=protocol,

3188

bus=bus)

3189

if server_settings["interface"]:

3190

service.interface = if_nametoindex(

3191

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

3192

2325

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2326

service = AvahiServiceToSyslog(name =

2327

server_settings["servicename"],

2328

servicetype = "_mandos._tcp",

2329

protocol = protocol, bus = bus)

2330

if server_settings["interface"]:

2331

service.interface = (if_nametoindex

2332

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

2333

3193

2334

global multiprocessing_manager

3194

2335

multiprocessing_manager = multiprocessing.Manager()

3195

2336

3196

2337

client_class = Client

3197

2338

if use_dbus:

3198

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

3199

2339

client_class = functools.partial(ClientDBusTransitional,

2340

bus = bus)

2341

3200

2342

client_settings = Client.config_parser(client_config)

3201

2343

old_client_settings = {}

3202

2344

clients_data = {}

3203

3204

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

3205

global wnull

3206

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

3207

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

3208

# mode

3209

if debug or not foreground:

3210

wnull.close()

3211

2345

3212

2346

# Get client data and settings from last running state.

3213

2347

if server_settings["restore"]:

3214

2348

try:

3215

2349

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

3216

if sys.version_info.major == 2:

3217

clients_data, old_client_settings = pickle.load(

3218

stored_state)

3219

else:

3220

bytes_clients_data, bytes_old_client_settings = (

3221

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

3222

# Fix bytes to strings

3223

# clients_data

3224

# .keys()

3225

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

3226

if isinstance(key, bytes)

3227

else key): value

3228

for key, value in

3229

bytes_clients_data.items()}

3230

del bytes_clients_data

3231

for key in clients_data:

3232

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

3233

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

3234

for k, v in

3235

clients_data[key].items()}

3236

clients_data[key] = value

3237

# .client_structure

3238

value["client_structure"] = [

3239

(s.decode("utf-8")

3240

if isinstance(s, bytes)

3241

else s) for s in

3242

value["client_structure"]]

3243

# .name & .host

3244

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

3245

if isinstance(value[k], bytes):

3246

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

3247

if not value.has_key("key_id"):

3248

value["key_id"] = ""

3249

elif not value.has_key("fingerprint"):

3250

value["fingerprint"] = ""

3251

# old_client_settings

3252

# .keys()

3253

old_client_settings = {

3254

(key.decode("utf-8")

3255

if isinstance(key, bytes)

3256

else key): value

3257

for key, value in

3258

bytes_old_client_settings.items()}

3259

del bytes_old_client_settings

3260

# .host

3261

for value in old_client_settings.values():

3262

if isinstance(value["host"], bytes):

3263

value["host"] = (value["host"]

3264

.decode("utf-8"))

2350

clients_data, old_client_settings = (pickle.load

2351

(stored_state))

3265

2352

os.remove(stored_state_path)

3266

2353

except IOError as e:

3267

if e.errno == errno.ENOENT:

3268

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

3269

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

3270

else:

3271

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

3272

exc_info=e)

2354

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

2355

.format(e))

2356

if e.errno != errno.ENOENT:

3273

2357

raise

3274

2358

except EOFError as e:

3275

2359

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

3276

"EOFError:",

3277

exc_info=e)

3278

2360

"EOFError: {0}".format(e))

2361

3279

2362

with PGPEngine() as pgp:

3280

for client_name, client in clients_data.items():

3281

# Skip removed clients

3282

if client_name not in client_settings:

3283

continue

3284

2363

for client_name, client in clients_data.iteritems():

3285

2364

# Decide which value to use after restoring saved state.

3286

2365

# We have three different values: Old config file,

3287

2366

# new config file, and saved state.

3292

2371

# For each value in new config, check if it

3293

2372

# differs from the old config value (Except for

3294

2373

# the "secret" attribute)

3295

if (name != "secret"

3296

and (value !=

3297

old_client_settings[client_name][name])):

2374

if (name != "secret" and

2375

value != old_client_settings[client_name]

2376

[name]):

3298

2377

client[name] = value

3299

2378

except KeyError:

3300

2379

pass

3301

2380

3302

2381

# Clients who has passed its expire date can still be

3303

# enabled if its last checker was successful. A Client

2382

# enabled if its last checker was successful. Clients

3304

2383

# whose checker succeeded before we stored its state is

3305

2384

# assumed to have successfully run all checkers during

3306

2385

# downtime.

3308

2387

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

3309

2388

if not client["last_checked_ok"]:

3310

2389

logger.warning(

3311

"disabling client {} - Client never "

3312

"performed a successful checker".format(

3313

client_name))

2390

"disabling client {0} - Client never "

2391

"performed a successful checker"

2392

.format(client_name))

3314

2393

client["enabled"] = False

3315

2394

elif client["last_checker_status"] != 0:

3316

2395

logger.warning(

3317

"disabling client {} - Client last"

3318

" checker failed with error code"

3319

" {}".format(

3320

client_name,

3321

client["last_checker_status"]))

2396

"disabling client {0} - Client "

2397

"last checker failed with error code {1}"

2398

.format(client_name,

2399

client["last_checker_status"]))

3322

2400

client["enabled"] = False

3323

2401

else:

3324

client["expires"] = (

3325

datetime.datetime.utcnow()

3326

+ client["timeout"])

2402

client["expires"] = (datetime.datetime

2403

.utcnow()

2404

+ client["timeout"])

3327

2405

logger.debug("Last checker succeeded,"

3328

" keeping {} enabled".format(

3329

client_name))

2406

" keeping {0} enabled"

2407

.format(client_name))

3330

2408

try:

3331

client["secret"] = pgp.decrypt(

3332

client["encrypted_secret"],

3333

client_settings[client_name]["secret"])

2409

client["secret"] = (

2410

pgp.decrypt(client["encrypted_secret"],

2411

client_settings[client_name]

2412

["secret"]))

3334

2413

except PGPError:

3335

2414

# If decryption fails, we use secret from new settings

3336

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

3337

client_name))

3338

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

3339

["secret"])

2415

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

2416

.format(client_name))

2417

client["secret"] = (

2418

client_settings[client_name]["secret"])

3340

2419

2420

3341

2421

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

3342

2422

for client_name in (set(old_client_settings)

3343

2423

- set(client_settings)):

3347

2427

clients_data[client_name] = client_settings[client_name]

3348

2428

3349

2429

# Create all client objects

3350

for client_name, client in clients_data.items():

2430

for client_name, client in clients_data.iteritems():

3351

2431

tcp_server.clients[client_name] = client_class(

3352

name=client_name,

3353

settings=client,

3354

server_settings=server_settings)

3355

2432

name = client_name, settings = client)

2433

3356

2434

if not tcp_server.clients:

3357

2435

logger.warning("No clients defined")

3358

3359

if not foreground:

3360

if pidfile is not None:

3361

pid = os.getpid()

3362

try:

3363

with pidfile:

3364

print(pid, file=pidfile)

3365

except IOError:

3366

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

3367

pidfilename, pid)

3368

del pidfile

2436

2437

if not debug:

2438

try:

2439

with pidfile:

2440

pid = os.getpid()

2441

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

2442

del pidfile

2443

except IOError:

2444

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

2445

pidfilename, pid)

2446

except NameError:

2447

# "pidfile" was never created

2448

pass

3369

2449

del pidfilename

3370

3371

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

3372

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3373

lambda: main_loop.quit() and False)

3374

2450

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

2451

2452

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

2453

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

2454

3375

2455

if use_dbus:

3376

3377

@alternate_dbus_interfaces(

3378

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

3379

class MandosDBusService(DBusObjectWithObjectManager):

2456

class MandosDBusService(DBusObjectWithProperties):

3380

2457

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

3381

3382

2458

def __init__(self):

3383

2459

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

3384

3385

2460

_interface = "se.recompile.Mandos"

3386

2461

2462

@dbus_interface_annotations(_interface)

2463

def _foo(self):

2464

return { "org.freedesktop.DBus.Property"

2465

".EmitsChangedSignal":

2466

"false"}

2467

3387

2468

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

3388

2469

def ClientAdded(self, objpath):

3389

2470

"D-Bus signal"

3390

2471

pass

3391

2472

3392

2473

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

3393

def ClientNotFound(self, key_id, address):

2474

def ClientNotFound(self, fingerprint, address):

3394

2475

"D-Bus signal"

3395

2476

pass

3396

3397

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

3398

"true"})

2477

3399

2478

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

3400

2479

def ClientRemoved(self, objpath, name):

3401

2480

"D-Bus signal"

3402

2481

pass

3403

3404

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

3405

"true"})

2482

3406

2483

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

3407

2484

def GetAllClients(self):

3408

2485

"D-Bus method"

3409

return dbus.Array(c.dbus_object_path for c in

3410

tcp_server.clients.values())

3411

3412

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

3413

"true"})

2486

return dbus.Array(c.dbus_object_path

2487

for c in

2488

tcp_server.clients.itervalues())

2489

3414

2490

@dbus.service.method(_interface,

3415

2491

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

3416

2492

def GetAllClientsWithProperties(self):

3417

2493

"D-Bus method"

3418

2494

return dbus.Dictionary(

3419

{c.dbus_object_path: c.GetAll(

3420

"se.recompile.Mandos.Client")

3421

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

2495

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

2496

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

3422

2497

signature="oa{sv}")

3423

2498

3424

2499

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

3425

2500

def RemoveClient(self, object_path):

3426

2501

"D-Bus method"

3427

for c in tcp_server.clients.values():

2502

for c in tcp_server.clients.itervalues():

3428

2503

if c.dbus_object_path == object_path:

3429

2504

del tcp_server.clients[c.name]

3430

2505

c.remove_from_connection()

3431

# Don't signal the disabling

2506

# Don't signal anything except ClientRemoved

3432

2507

c.disable(quiet=True)

3433

# Emit D-Bus signal for removal

3434

self.client_removed_signal(c)

2508

# Emit D-Bus signal

2509

self.ClientRemoved(object_path, c.name)

3435

2510

return

3436

2511

raise KeyError(object_path)

3437

2512

3438

2513

del _interface

3439

3440

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3441

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

3442

def GetManagedObjects(self):

3443

"""D-Bus method"""

3444

return dbus.Dictionary(

3445

{client.dbus_object_path:

3446

dbus.Dictionary(

3447

{interface: client.GetAll(interface)

3448

for interface in

3449

client._get_all_interface_names()})

3450

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

3451

3452

def client_added_signal(self, client):

3453

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

3454

if use_dbus:

3455

# New standard signal

3456

self.InterfacesAdded(

3457

client.dbus_object_path,

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()}))

3462

# Old signal

3463

self.ClientAdded(client.dbus_object_path)

3464

3465

def client_removed_signal(self, client):

3466

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

3467

if use_dbus:

3468

# New standard signal

3469

self.InterfacesRemoved(

3470

client.dbus_object_path,

3471

client._get_all_interface_names())

3472

# Old signal

3473

self.ClientRemoved(client.dbus_object_path,

3474

client.name)

3475

3476

mandos_dbus_service = MandosDBusService()

3477

3478

# Save modules to variables to exempt the modules from being

3479

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

3480

mp = multiprocessing

3481

wn = wnull

3482

2514

2515

class MandosDBusServiceTransitional(MandosDBusService):

2516

__metaclass__ = AlternateDBusNamesMetaclass

2517

mandos_dbus_service = MandosDBusServiceTransitional()

2518

3483

2519

def cleanup():

3484

2520

"Cleanup function; run on exit"

3485

if zeroconf:

3486

service.cleanup()

3487

3488

mp.active_children()

3489

wn.close()

2521

service.cleanup()

2522

2523

multiprocessing.active_children()

3490

2524

if not (tcp_server.clients or client_settings):

3491

2525

return

3492

2526

3493

2527

# Store client before exiting. Secrets are encrypted with key

3494

2528

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

3495

2529

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

3496

2530

clients = {}

3497

2531

with PGPEngine() as pgp:

3498

for client in tcp_server.clients.values():

2532

for client in tcp_server.clients.itervalues():

3499

2533

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

3500

2534

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

3501

2535

key)

3502

2536

client_dict = {}

3503

2537

3504

2538

# A list of attributes that can not be pickled

3505

2539

# + secret.

3506

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

3507

"checker", "server_settings"}

3508

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

3509

.Object):

2540

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

2541

"checker"))

2542

for name, typ in (inspect.getmembers

2543

(dbus.service.Object)):

3510

2544

exclude.add(name)

3511

2545

3512

2546

client_dict["encrypted_secret"] = (client

3513

2547

.encrypted_secret)

3514

2548

for attr in client.client_structure:

3515

2549

if attr not in exclude:

3516

2550

client_dict[attr] = getattr(client, attr)

3517

2551

3518

2552

clients[client.name] = client_dict

3519

2553

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

3520

2554

3521

2555

try:

3522

with tempfile.NamedTemporaryFile(

3523

mode='wb',

3524

suffix=".pickle",

3525

prefix='clients-',

3526

dir=os.path.dirname(stored_state_path),

3527

delete=False) as stored_state:

3528

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

3529

protocol=2)

3530

tempname = stored_state.name

2556

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2557

prefix="clients-",

2558

dir=os.path.dirname

2559

(stored_state_path))

2560

with os.fdopen(tempfd, "wb") as stored_state:

2561

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

3531

2562

os.rename(tempname, stored_state_path)

3532

2563

except (IOError, OSError) as e:

2564

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

2565

.format(e))

3533

2566

if not debug:

3534

2567

try:

3535

2568

os.remove(tempname)

3536

2569

except NameError:

3537

2570

pass

3538

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

3539

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

3540

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

3541

else:

3542

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

3543

exc_info=e)

3544

raise

3545

2571

if e.errno not in set((errno.ENOENT, errno.EACCES,

2572

errno.EEXIST)):

2573

raise e

2574

3546

2575

# Delete all clients, and settings from config

3547

2576

while tcp_server.clients:

3548

2577

name, client = tcp_server.clients.popitem()

3549

2578

if use_dbus:

3550

2579

client.remove_from_connection()

3551

# Don't signal the disabling

2580

# Don't signal anything except ClientRemoved

3552

2581

client.disable(quiet=True)

3553

# Emit D-Bus signal for removal

3554

2582

if use_dbus:

3555

mandos_dbus_service.client_removed_signal(client)

2583

# Emit D-Bus signal

2584

mandos_dbus_service.ClientRemoved(client

2585

.dbus_object_path,

2586

client.name)

3556

2587

client_settings.clear()

3557

2588

3558

2589

atexit.register(cleanup)

3559

3560

for client in tcp_server.clients.values():

2590

2591

for client in tcp_server.clients.itervalues():

3561

2592

if use_dbus:

3562

# Emit D-Bus signal for adding

3563

mandos_dbus_service.client_added_signal(client)

2593

# Emit D-Bus signal

2594

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3564

2595

# Need to initiate checking of clients

3565

2596

if client.enabled:

3566

2597

client.init_checker()

3567

2598

3568

2599

tcp_server.enable()

3569

2600

tcp_server.server_activate()

3570

2601

3571

2602

# Find out what port we got

3572

if zeroconf:

3573

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

2603

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

3574

2604

if use_ipv6:

3575

2605

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

3576

" flowinfo %d, scope_id %d",

3577

*tcp_server.socket.getsockname())

2606

" flowinfo %d, scope_id %d"

2607

% tcp_server.socket.getsockname())

3578

2608

else: # IPv4

3579

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

3580

*tcp_server.socket.getsockname())

3581

3582

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

3583

2609

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

2610

% tcp_server.socket.getsockname())

2611

2612

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

2613

3584

2614

try:

3585

if zeroconf:

3586

# From the Avahi example code

3587

try:

3588

service.activate()

3589

except dbus.exceptions.DBusException as error:

3590

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

3591

cleanup()

3592

sys.exit(1)

3593

# End of Avahi example code

3594

3595

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

3596

lambda *args, **kwargs:

3597

(tcp_server.handle_request

3598

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

3599

2615

# From the Avahi example code

2616

try:

2617

service.activate()

2618

except dbus.exceptions.DBusException as error:

2619

logger.critical("DBusException: %s", error)

2620

cleanup()

2621

sys.exit(1)

2622

# End of Avahi example code

2623

2624

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

2625

lambda *args, **kwargs:

2626

(tcp_server.handle_request

2627

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

2628

3600

2629

logger.debug("Starting main loop")

3601

2630

main_loop.run()

3602

2631

except AvahiError as error:

3603

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

2632

logger.critical("AvahiError: %s", error)

3604

2633

cleanup()

3605

2634

sys.exit(1)

3606

2635

except KeyboardInterrupt:

3611

2640

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

3612

2641

cleanup()

3613

2642

3614

3615

2643

if __name__ == '__main__':

3616

2644

main()