/mandos/release : revision 237.7.127

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

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

import collections

79

import codecs

80

71

81

72

import dbus

82

73

import dbus.service

83

import gi

84

from gi.repository import GLib

74

import gobject

75

import avahi

85

76

from dbus.mainloop.glib import DBusGMainLoop

86

77

import ctypes

87

78

import ctypes.util

88

79

import xml.dom.minidom

89

80

import inspect

90

91

if sys.version_info.major == 2:

92

__metaclass__ = type

93

94

# Try to find the value of SO_BINDTODEVICE:

81

import GnuPGInterface

82

95

83

try:

96

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

97

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

98

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

99

85

except AttributeError:

100

86

try:

101

# This is where SO_BINDTODEVICE was up to and including Python

102

# 2.6, and also 3.2:

103

87

from IN import SO_BINDTODEVICE

104

88

except ImportError:

105

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

106

# Try running the C preprocessor:

107

try:

108

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

109

"/dev/stdin"],

110

stdin=subprocess.PIPE,

111

stdout=subprocess.PIPE)

112

stdout = cc.communicate(

113

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

114

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

115

except (OSError, ValueError, IndexError):

116

# No value found

117

SO_BINDTODEVICE = None

118

119

if sys.version_info.major == 2:

120

str = unicode

121

122

if sys.version_info < (3, 2):

123

configparser.Configparser = configparser.SafeConfigParser

124

125

version = "1.8.7"

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

126

92

stored_state_file = "clients.pickle"

127

93

128

94

logger = logging.getLogger()

129

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

130

98

131

99

try:

132

if_nametoindex = ctypes.cdll.LoadLibrary(

133

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

134

103

except (OSError, AttributeError):

135

136

104

def if_nametoindex(interface):

137

105

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

138

106

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

139

107

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

140

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

141

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

142

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

143

113

return interface_index

144

114

145

115

146

def copy_function(func):

147

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

148

if sys.version_info.major == 2:

149

return types.FunctionType(func.func_code,

150

func.func_globals,

151

func.func_name,

152

func.func_defaults,

153

func.func_closure)

154

else:

155

return types.FunctionType(func.__code__,

156

func.__globals__,

157

func.__name__,

158

func.__defaults__,

159

func.__closure__)

160

161

162

116

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

163

117

"""init logger and add loglevel"""

164

165

global syslogger

166

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

118

169

119

syslogger.setFormatter(logging.Formatter

170

120

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

171

121

' %(message)s'))

172

122

logger.addHandler(syslogger)

173

123

174

124

if debug:

175

125

console = logging.StreamHandler()

176

126

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

186

136

pass

187

137

188

138

189

class PGPEngine:

139

class PGPEngine(object):

190

140

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

191

192

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

193

143

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

194

self.gpg = "gpg"

195

try:

196

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

197

for line in output.splitlines():

198

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

199

if name == "gpg":

200

self.gpg = path

201

break

202

except OSError as e:

203

if e.errno != errno.ENOENT:

204

raise

205

self.gnupgargs = ['--batch',

206

'--homedir', self.tempdir,

207

'--force-mdc',

208

'--quiet']

209

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

210

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

211

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

212

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

213

151

def __enter__(self):

214

152

return self

215

216

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

153

154

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

217

155

self._cleanup()

218

156

return False

219

157

220

158

def __del__(self):

221

159

self._cleanup()

222

160

223

161

def _cleanup(self):

224

162

if self.tempdir is not None:

225

163

# Delete contents of tempdir

226

164

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

227

topdown=False):

165

topdown = False):

228

166

for filename in files:

229

167

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

230

168

for dirname in dirs:

232

170

# Remove tempdir

233

171

os.rmdir(self.tempdir)

234

172

self.tempdir = None

235

173

236

174

def password_encode(self, password):

237

175

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

238

176

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

239

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

240

if len(encoded) > 2048:

241

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

242

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

243

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

244

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

245

return encoded

246

177

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

178

247

179

def encrypt(self, data, password):

248

passphrase = self.password_encode(password)

249

with tempfile.NamedTemporaryFile(

250

dir=self.tempdir) as passfile:

251

passfile.write(passphrase)

252

passfile.flush()

253

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

254

'--passphrase-file',

255

passfile.name]

256

+ self.gnupgargs,

257

stdin=subprocess.PIPE,

258

stdout=subprocess.PIPE,

259

stderr=subprocess.PIPE)

260

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

261

if proc.returncode != 0:

262

raise PGPError(err)

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

263

194

return ciphertext

264

195

265

196

def decrypt(self, data, password):

266

passphrase = self.password_encode(password)

267

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

269

passfile.write(passphrase)

270

passfile.flush()

271

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

272

'--passphrase-file',

273

passfile.name]

274

+ self.gnupgargs,

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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

279

if proc.returncode != 0:

280

raise PGPError(err)

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

281

211

return decrypted_plaintext

282

212

283

213

284

# Pretend that we have an Avahi module

285

class avahi:

286

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

287

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

288

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

289

PROTO_INET = 0 # avahi-common/address.h

290

PROTO_INET6 = 1 # avahi-common/address.h

291

DBUS_NAME = "org.freedesktop.Avahi"

292

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

293

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

294

DBUS_PATH_SERVER = "/"

295

296

@staticmethod

297

def string_array_to_txt_array(t):

298

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

299

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

300

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

301

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

302

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

303

SERVER_INVALID = 0 # avahi-common/defs.h

304

SERVER_REGISTERING = 1 # avahi-common/defs.h

305

SERVER_RUNNING = 2 # avahi-common/defs.h

306

SERVER_COLLISION = 3 # avahi-common/defs.h

307

SERVER_FAILURE = 4 # avahi-common/defs.h

308

309

310

214

class AvahiError(Exception):

311

215

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

312

216

self.value = value

313

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

314

**kwargs)

315

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

316

220

317

221

class AvahiServiceError(AvahiError):

318

222

pass

319

223

320

321

224

class AvahiGroupError(AvahiError):

322

225

pass

323

226

324

227

325

class AvahiService:

228

class AvahiService(object):

326

229

"""An Avahi (Zeroconf) service.

327

230

328

231

Attributes:

329

232

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

330

233

Used to optionally bind to the specified interface.

331

234

name: string; Example: 'Mandos'

332

235

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

333

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

236

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

334

237

port: integer; what port to announce

335

238

TXT: list of strings; TXT record for the service

336

239

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

342

245

server: D-Bus Server

343

246

bus: dbus.SystemBus()

344

247

"""

345

346

def __init__(self,

347

interface=avahi.IF_UNSPEC,

348

name=None,

349

servicetype=None,

350

port=None,

351

TXT=None,

352

domain="",

353

host="",

354

max_renames=32768,

355

protocol=avahi.PROTO_UNSPEC,

356

bus=None):

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

357

253

self.interface = interface

358

254

self.name = name

359

255

self.type = servicetype

368

264

self.server = None

369

265

self.bus = bus

370

266

self.entry_group_state_changed_match = None

371

372

def rename(self, remove=True):

267

268

def rename(self):

373

269

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

374

270

if self.rename_count >= self.max_renames:

375

271

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

376

272

" after %i retries, exiting.",

377

273

self.rename_count)

378

274

raise AvahiServiceError("Too many renames")

379

self.name = str(

380

self.server.GetAlternativeServiceName(self.name))

381

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

382

277

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

383

278

self.name)

384

if remove:

385

self.remove()

279

self.remove()

386

280

try:

387

281

self.add()

388

282

except dbus.exceptions.DBusException as error:

389

if (error.get_dbus_name()

390

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

391

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

392

return self.rename(remove=False)

393

else:

394

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

395

self.cleanup()

396

os._exit(1)

397

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

398

288

def remove(self):

399

289

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

400

290

if self.entry_group_state_changed_match is not None:

402

292

self.entry_group_state_changed_match = None

403

293

if self.group is not None:

404

294

self.group.Reset()

405

295

406

296

def add(self):

407

297

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

408

298

self.remove()

425

315

dbus.UInt16(self.port),

426

316

avahi.string_array_to_txt_array(self.TXT))

427

317

self.group.Commit()

428

318

429

319

def entry_group_state_changed(self, state, error):

430

320

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

431

321

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

432

322

433

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

434

324

logger.debug("Zeroconf service established.")

435

325

elif state == avahi.ENTRY_GROUP_COLLISION:

437

327

self.rename()

438

328

elif state == avahi.ENTRY_GROUP_FAILURE:

439

329

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

440

str(error))

441

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

442

330

unicode(error))

331

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

332

.format(error))

333

443

334

def cleanup(self):

444

335

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

445

336

if self.group is not None:

450

341

pass

451

342

self.group = None

452

343

self.remove()

453

344

454

345

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

455

346

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

456

347

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

457

bad_states = {

458

avahi.SERVER_INVALID: "Zeroconf server invalid",

459

avahi.SERVER_REGISTERING: None,

460

avahi.SERVER_COLLISION: "Zeroconf server name collision",

461

avahi.SERVER_FAILURE: "Zeroconf server failure",

462

}

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

463

355

if state in bad_states:

464

356

if bad_states[state] is not None:

465

357

if error is None:

468

360

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

469

361

self.cleanup()

470

362

elif state == avahi.SERVER_RUNNING:

471

try:

472

self.add()

473

except dbus.exceptions.DBusException as error:

474

if (error.get_dbus_name()

475

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

476

logger.info("Local Zeroconf service name"

477

" collision.")

478

return self.rename(remove=False)

479

else:

480

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

481

self.cleanup()

482

os._exit(1)

363

self.add()

483

364

else:

484

365

if error is None:

485

366

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

486

367

else:

487

368

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

488

369

489

370

def activate(self):

490

371

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

491

372

if self.server is None:

495

376

follow_name_owner_changes=True),

496

377

avahi.DBUS_INTERFACE_SERVER)

497

378

self.server.connect_to_signal("StateChanged",

498

self.server_state_changed)

379

self.server_state_changed)

499

380

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

500

381

501

502

382

class AvahiServiceToSyslog(AvahiService):

503

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

383

def rename(self):

504

384

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

505

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

506

syslogger.setFormatter(logging.Formatter(

507

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

508

.format(self.name)))

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

509

390

return ret

510

391

511

512

# Pretend that we have a GnuTLS module

513

class gnutls:

514

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

515

516

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

517

if library is None:

518

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

519

_library = ctypes.cdll.LoadLibrary(library)

520

del library

521

522

# Unless otherwise indicated, the constants and types below are

523

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

524

525

# Constants

526

E_SUCCESS = 0

527

E_INTERRUPTED = -52

528

E_AGAIN = -28

529

CRT_OPENPGP = 2

530

CRT_RAWPK = 3

531

CLIENT = 2

532

SHUT_RDWR = 0

533

CRD_CERTIFICATE = 1

534

E_NO_CERTIFICATE_FOUND = -49

535

X509_FMT_DER = 0

536

NO_TICKETS = 1<<10

537

ENABLE_RAWPK = 1<<18

538

CTYPE_PEERS = 3

539

KEYID_USE_SHA256 = 1 # gnutls/x509.h

540

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

541

542

# Types

543

class session_int(ctypes.Structure):

544

_fields_ = []

545

session_t = ctypes.POINTER(session_int)

546

547

class certificate_credentials_st(ctypes.Structure):

548

_fields_ = []

549

certificate_credentials_t = ctypes.POINTER(

550

certificate_credentials_st)

551

certificate_type_t = ctypes.c_int

552

553

class datum_t(ctypes.Structure):

554

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

555

('size', ctypes.c_uint)]

556

557

class openpgp_crt_int(ctypes.Structure):

558

_fields_ = []

559

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

560

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

561

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

562

credentials_type_t = ctypes.c_int

563

transport_ptr_t = ctypes.c_void_p

564

close_request_t = ctypes.c_int

565

566

# Exceptions

567

class Error(Exception):

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = gnutls.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials:

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession:

593

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

594

self._c_object = gnutls.session_t()

595

gnutls_flags = gnutls.CLIENT

596

if gnutls.check_version(b"3.5.6"):

597

gnutls_flags |= gnutls.NO_TICKETS

598

if gnutls.has_rawpk:

599

gnutls_flags |= gnutls.ENABLE_RAWPK

600

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

601

del gnutls_flags

602

gnutls.set_default_priority(self._c_object)

603

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

604

gnutls.handshake_set_private_extensions(self._c_object,

605

True)

606

self.socket = socket

607

if credentials is None:

608

credentials = gnutls.Credentials()

609

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

610

ctypes.cast(credentials._c_object,

611

ctypes.c_void_p))

612

self.credentials = credentials

613

614

def __del__(self):

615

gnutls.deinit(self._c_object)

616

617

def handshake(self):

618

return gnutls.handshake(self._c_object)

619

620

def send(self, data):

621

data = bytes(data)

622

data_len = len(data)

623

while data_len > 0:

624

data_len -= gnutls.record_send(self._c_object,

625

data[-data_len:],

626

data_len)

627

628

def bye(self):

629

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

630

631

# Error handling functions

632

def _error_code(result):

633

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

634

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

635

if result >= 0:

636

return result

637

if result == gnutls.E_NO_CERTIFICATE_FOUND:

638

raise gnutls.CertificateSecurityError(code=result)

639

raise gnutls.Error(code=result)

640

641

def _retry_on_error(result, func, arguments):

642

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

643

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

644

while result < 0:

645

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

646

return _error_code(result)

647

result = func(*arguments)

648

return result

649

650

# Unless otherwise indicated, the function declarations below are

651

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

652

653

# Functions

654

priority_set_direct = _library.gnutls_priority_set_direct

655

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

656

ctypes.POINTER(ctypes.c_char_p)]

657

priority_set_direct.restype = _error_code

658

659

init = _library.gnutls_init

660

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

661

init.restype = _error_code

662

663

set_default_priority = _library.gnutls_set_default_priority

664

set_default_priority.argtypes = [session_t]

665

set_default_priority.restype = _error_code

666

667

record_send = _library.gnutls_record_send

668

record_send.argtypes = [session_t, ctypes.c_void_p,

669

ctypes.c_size_t]

670

record_send.restype = ctypes.c_ssize_t

671

record_send.errcheck = _retry_on_error

672

673

certificate_allocate_credentials = (

674

_library.gnutls_certificate_allocate_credentials)

675

certificate_allocate_credentials.argtypes = [

676

ctypes.POINTER(certificate_credentials_t)]

677

certificate_allocate_credentials.restype = _error_code

678

679

certificate_free_credentials = (

680

_library.gnutls_certificate_free_credentials)

681

certificate_free_credentials.argtypes = [

682

certificate_credentials_t]

683

certificate_free_credentials.restype = None

684

685

handshake_set_private_extensions = (

686

_library.gnutls_handshake_set_private_extensions)

687

handshake_set_private_extensions.argtypes = [session_t,

688

ctypes.c_int]

689

handshake_set_private_extensions.restype = None

690

691

credentials_set = _library.gnutls_credentials_set

692

credentials_set.argtypes = [session_t, credentials_type_t,

693

ctypes.c_void_p]

694

credentials_set.restype = _error_code

695

696

strerror = _library.gnutls_strerror

697

strerror.argtypes = [ctypes.c_int]

698

strerror.restype = ctypes.c_char_p

699

700

certificate_type_get = _library.gnutls_certificate_type_get

701

certificate_type_get.argtypes = [session_t]

702

certificate_type_get.restype = _error_code

703

704

certificate_get_peers = _library.gnutls_certificate_get_peers

705

certificate_get_peers.argtypes = [session_t,

706

ctypes.POINTER(ctypes.c_uint)]

707

certificate_get_peers.restype = ctypes.POINTER(datum_t)

708

709

global_set_log_level = _library.gnutls_global_set_log_level

710

global_set_log_level.argtypes = [ctypes.c_int]

711

global_set_log_level.restype = None

712

713

global_set_log_function = _library.gnutls_global_set_log_function

714

global_set_log_function.argtypes = [log_func]

715

global_set_log_function.restype = None

716

717

deinit = _library.gnutls_deinit

718

deinit.argtypes = [session_t]

719

deinit.restype = None

720

721

handshake = _library.gnutls_handshake

722

handshake.argtypes = [session_t]

723

handshake.restype = _error_code

724

handshake.errcheck = _retry_on_error

725

726

transport_set_ptr = _library.gnutls_transport_set_ptr

727

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

728

transport_set_ptr.restype = None

729

730

bye = _library.gnutls_bye

731

bye.argtypes = [session_t, close_request_t]

732

bye.restype = _error_code

733

bye.errcheck = _retry_on_error

734

735

check_version = _library.gnutls_check_version

736

check_version.argtypes = [ctypes.c_char_p]

737

check_version.restype = ctypes.c_char_p

738

739

_need_version = b"3.3.0"

740

if check_version(_need_version) is None:

741

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

742

.format(_need_version))

743

744

_tls_rawpk_version = b"3.6.6"

745

has_rawpk = bool(check_version(_tls_rawpk_version))

746

747

if has_rawpk:

748

# Types

749

class pubkey_st(ctypes.Structure):

750

_fields = []

751

pubkey_t = ctypes.POINTER(pubkey_st)

752

753

x509_crt_fmt_t = ctypes.c_int

754

755

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

756

pubkey_init = _library.gnutls_pubkey_init

757

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

758

pubkey_init.restype = _error_code

759

760

pubkey_import = _library.gnutls_pubkey_import

761

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

762

x509_crt_fmt_t]

763

pubkey_import.restype = _error_code

764

765

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

766

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

767

ctypes.POINTER(ctypes.c_ubyte),

768

ctypes.POINTER(ctypes.c_size_t)]

769

pubkey_get_key_id.restype = _error_code

770

771

pubkey_deinit = _library.gnutls_pubkey_deinit

772

pubkey_deinit.argtypes = [pubkey_t]

773

pubkey_deinit.restype = None

774

else:

775

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

776

777

openpgp_crt_init = _library.gnutls_openpgp_crt_init

778

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

779

openpgp_crt_init.restype = _error_code

780

781

openpgp_crt_import = _library.gnutls_openpgp_crt_import

782

openpgp_crt_import.argtypes = [openpgp_crt_t,

783

ctypes.POINTER(datum_t),

784

openpgp_crt_fmt_t]

785

openpgp_crt_import.restype = _error_code

786

787

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

788

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

789

ctypes.POINTER(ctypes.c_uint)]

790

openpgp_crt_verify_self.restype = _error_code

791

792

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

793

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

794

openpgp_crt_deinit.restype = None

795

796

openpgp_crt_get_fingerprint = (

797

_library.gnutls_openpgp_crt_get_fingerprint)

798

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

799

ctypes.c_void_p,

800

ctypes.POINTER(

801

ctypes.c_size_t)]

802

openpgp_crt_get_fingerprint.restype = _error_code

803

804

if check_version(b"3.6.4"):

805

certificate_type_get2 = _library.gnutls_certificate_type_get2

806

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

807

certificate_type_get2.restype = _error_code

808

809

# Remove non-public functions

810

del _error_code, _retry_on_error

811

812

813

def call_pipe(connection, # : multiprocessing.Connection

814

func, *args, **kwargs):

815

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

816

817

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

818

return value on the provided multiprocessing.Connection.

819

"""

820

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

821

connection.close()

822

823

824

class Client:

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

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

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

397

398

class Client(object):

825

399

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

826

400

827

401

Attributes:

828

402

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

829

403

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

830

404

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

831

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

832

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

833

running.

834

checker_callback_tag: a GLib event source tag, or None

405

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

406

to see if the client lives.

407

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

835

409

checker_command: string; External command which is run to check

836

410

if client lives. %() expansions are done at

837

411

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

838

412

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

839

checker_initiator_tag: a GLib event source tag, or None

413

checker_initiator_tag: a gobject event source tag, or None

840

414

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

841

415

client_structure: Object describing what attributes a client has

842

416

and is used for storing the client at exit

843

417

current_checker_command: string; current running checker_command

844

disable_initiator_tag: a GLib event source tag, or None

418

disable_initiator_tag: a gobject event source tag, or None

845

419

enabled: bool()

846

420

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

847

uniquely identify an OpenPGP client

848

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

849

a client using raw public keys

421

uniquely identify the client

850

422

host: string; available for use by the checker command

851

423

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

852

424

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

854

426

last_checker_status: integer between 0 and 255 reflecting exit

855

427

status of last checker. -1 reflects crashed

856

428

checker, -2 means no checker completed yet.

857

last_checker_signal: The signal which killed the last checker, if

858

last_checker_status is -1

859

429

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

860

430

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

861

431

D-Bus identifiers

866

436

runtime_expansions: Allowed attributes for runtime expansion.

867

437

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

868

438

disabled, or None

869

server_settings: The server_settings dict from main()

870

439

"""

871

440

872

441

runtime_expansions = ("approval_delay", "approval_duration",

873

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

874

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

875

"last_approval_request", "last_checked_ok",

442

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

443

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

876

444

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

877

client_defaults = {

878

"timeout": "PT5M",

879

"extended_timeout": "PT15M",

880

"interval": "PT2M",

881

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

882

"host": "",

883

"approval_delay": "PT0S",

884

"approval_duration": "PT1S",

885

"approved_by_default": "True",

886

"enabled": "True",

887

}

888

445

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

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

470

889

471

@staticmethod

890

472

def config_parser(config):

891

473

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

898

480

for client_name in config.sections():

899

481

section = dict(config.items(client_name))

900

482

client = settings[client_name] = {}

901

483

902

484

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

903

485

# Reformat values from string types to Python types

904

486

client["approved_by_default"] = config.getboolean(

905

487

client_name, "approved_by_default")

906

488

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

907

489

"enabled")

908

909

# Uppercase and remove spaces from key_id and fingerprint

910

# for later comparison purposes with return value from the

911

# key_id() and fingerprint() functions

912

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

913

.replace(" ", ""))

490

914

491

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

915

492

.replace(" ", ""))

916

493

if "secret" in section:

917

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

918

.encode("utf-8"),

919

"base64")

494

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

920

495

elif "secfile" in section:

921

496

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

922

497

(section["secfile"])),

923

498

"rb") as secfile:

924

499

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

925

500

else:

926

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

501

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

927

502

.format(section))

928

503

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

929

504

client["extended_timeout"] = string_to_delta(

937

512

client["last_approval_request"] = None

938

513

client["last_checked_ok"] = None

939

514

client["last_checker_status"] = -2

940

515

941

516

return settings

942

943

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

517

518

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

944

519

self.name = name

945

if server_settings is None:

946

server_settings = {}

947

self.server_settings = server_settings

948

520

# adding all client settings

949

for setting, value in settings.items():

521

for setting, value in settings.iteritems():

950

522

setattr(self, setting, value)

951

523

952

524

if self.enabled:

953

525

if not hasattr(self, "last_enabled"):

954

526

self.last_enabled = datetime.datetime.utcnow()

958

530

else:

959

531

self.last_enabled = None

960

532

self.expires = None

961

533

962

534

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

963

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

964

538

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

965

539

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

966

540

datetime.datetime.utcnow())

967

541

968

542

# attributes specific for this server instance

969

543

self.checker = None

970

544

self.checker_initiator_tag = None

973

547

self.current_checker_command = None

974

548

self.approved = None

975

549

self.approvals_pending = 0

976

self.changedstate = multiprocessing_manager.Condition(

977

multiprocessing_manager.Lock())

978

self.client_structure = [attr

979

for attr in self.__dict__.keys()

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

980

555

if not attr.startswith("_")]

981

556

self.client_structure.append("client_structure")

982

983

for name, t in inspect.getmembers(

984

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

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

985

562

if not name.startswith("_"):

986

563

self.client_structure.append(name)

987

564

988

565

# Send notice to process children that client state has changed

989

566

def send_changedstate(self):

990

567

with self.changedstate:

991

568

self.changedstate.notify_all()

992

569

993

570

def enable(self):

994

571

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

995

572

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

996

573

# Already enabled

997

574

return

575

self.send_changedstate()

998

576

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

999

577

self.enabled = True

1000

578

self.last_enabled = datetime.datetime.utcnow()

1001

579

self.init_checker()

1002

self.send_changedstate()

1003

580

1004

581

def disable(self, quiet=True):

1005

582

"""Disable this client."""

1006

583

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

1007

584

return False

1008

585

if not quiet:

586

self.send_changedstate()

587

if not quiet:

1009

588

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

1010

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

1011

GLib.source_remove(self.disable_initiator_tag)

589

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

590

gobject.source_remove(self.disable_initiator_tag)

1012

591

self.disable_initiator_tag = None

1013

592

self.expires = None

1014

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

1015

GLib.source_remove(self.checker_initiator_tag)

593

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

594

gobject.source_remove(self.checker_initiator_tag)

1016

595

self.checker_initiator_tag = None

1017

596

self.stop_checker()

1018

597

self.enabled = False

1019

if not quiet:

1020

self.send_changedstate()

1021

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

598

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

1022

599

return False

1023

600

1024

601

def __del__(self):

1025

602

self.disable()

1026

603

1027

604

def init_checker(self):

1028

605

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

1029

606

# and every interval from then on.

1030

if self.checker_initiator_tag is not None:

1031

GLib.source_remove(self.checker_initiator_tag)

1032

self.checker_initiator_tag = GLib.timeout_add(

1033

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

1034

self.start_checker)

607

self.checker_initiator_tag = (gobject.timeout_add

608

(self.interval_milliseconds(),

609

self.start_checker))

1035

610

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

1036

if self.disable_initiator_tag is not None:

1037

GLib.source_remove(self.disable_initiator_tag)

1038

self.disable_initiator_tag = GLib.timeout_add(

1039

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

611

self.disable_initiator_tag = (gobject.timeout_add

612

(self.timeout_milliseconds(),

613

self.disable))

1040

614

# Also start a new checker *right now*.

1041

615

self.start_checker()

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

616

617

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

1045

618

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

1046

# Read return code from connection (see call_pipe)

1047

returncode = connection.recv()

1048

connection.close()

1049

self.checker.join()

1050

619

self.checker_callback_tag = None

1051

620

self.checker = None

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

621

if os.WIFEXITED(condition):

622

self.last_checker_status = os.WEXITSTATUS(condition)

1056

623

if self.last_checker_status == 0:

1057

624

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

1058

625

vars(self))

1059

626

self.checked_ok()

1060

627

else:

1061

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

628

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

629

vars(self))

1062

630

else:

1063

631

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

1065

632

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

1066

633

vars(self))

1067

return False

1068

634

1069

635

def checked_ok(self):

1070

636

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

1071

637

self.last_checked_ok = datetime.datetime.utcnow()

1072

638

self.last_checker_status = 0

1073

self.last_checker_signal = None

1074

639

self.bump_timeout()

1075

640

1076

641

def bump_timeout(self, timeout=None):

1077

642

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

1078

643

if timeout is None:

1079

644

timeout = self.timeout

1080

645

if self.disable_initiator_tag is not None:

1081

GLib.source_remove(self.disable_initiator_tag)

1082

self.disable_initiator_tag = None

646

gobject.source_remove(self.disable_initiator_tag)

1083

647

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

1084

self.disable_initiator_tag = GLib.timeout_add(

1085

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(timedelta_to_milliseconds

650

(timeout), self.disable))

1086

651

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

1087

652

1088

653

def need_approval(self):

1089

654

self.last_approval_request = datetime.datetime.utcnow()

1090

655

1091

656

def start_checker(self):

1092

657

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

1093

658

1094

659

If a checker already exists, leave it running and do

1095

660

nothing."""

1096

661

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

1101

666

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

1102

667

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

1103

668

# should be.

1104

1105

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

1106

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

1107

self.checker.join()

1108

self.checker = None

669

670

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

671

try:

672

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

673

except (AttributeError, OSError) as error:

674

if (isinstance(error, OSError)

675

and error.errno != errno.ECHILD):

676

raise error

677

else:

678

if pid:

679

logger.warning("Checker was a zombie")

680

gobject.source_remove(self.checker_callback_tag)

681

self.checker_callback(pid, status,

682

self.current_checker_command)

1109

683

# Start a new checker if needed

1110

684

if self.checker is None:

1111

# Escape attributes for the shell

1112

escaped_attrs = {

1113

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

1114

for attr in self.runtime_expansions}

1115

try:

1116

command = self.checker_command % escaped_attrs

1117

except TypeError as error:

1118

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

1119

self.checker_command,

685

try:

686

# In case checker_command has exactly one % operator

687

command = self.checker_command % self.host

688

except TypeError:

689

# Escape attributes for the shell

690

escaped_attrs = dict(

691

(attr,

692

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

693

errors=

694

'replace')))

695

for attr in

696

self.runtime_expansions)

697

698

try:

699

command = self.checker_command % escaped_attrs

700

except TypeError as error:

701

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

702

self.checker_command, exc_info=error)

703

return True # Try again later

704

self.current_checker_command = command

705

try:

706

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

707

command, self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

self.checker = subprocess.Popen(command,

713

close_fds=True,

714

shell=True, cwd="/")

715

self.checker_callback_tag = (gobject.child_watch_add

716

(self.checker.pid,

717

self.checker_callback,

718

data=command))

719

# The checker may have completed before the gobject

720

# watch was added. Check for this.

721

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

722

if pid:

723

gobject.source_remove(self.checker_callback_tag)

724

self.checker_callback(pid, status, command)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

1120

727

exc_info=error)

1121

return True # Try again later

1122

self.current_checker_command = command

1123

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

1124

self.name)

1125

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

1126

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

1127

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

1128

# always replaced by /dev/null.)

1129

# The exception is when not debugging but nevertheless

1130

# running in the foreground; use the previously

1131

# created wnull.

1132

popen_args = {"close_fds": True,

1133

"shell": True,

1134

"cwd": "/"}

1135

if (not self.server_settings["debug"]

1136

and self.server_settings["foreground"]):

1137

popen_args.update({"stdout": wnull,

1138

"stderr": wnull})

1139

pipe = multiprocessing.Pipe(duplex=False)

1140

self.checker = multiprocessing.Process(

1141

target=call_pipe,

1142

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

1143

kwargs=popen_args)

1144

self.checker.start()

1145

self.checker_callback_tag = GLib.io_add_watch(

1146

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

1147

self.checker_callback, pipe[0], command)

1148

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

728

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

1149

729

return True

1150

730

1151

731

def stop_checker(self):

1152

732

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

1153

733

if self.checker_callback_tag:

1154

GLib.source_remove(self.checker_callback_tag)

734

gobject.source_remove(self.checker_callback_tag)

1155

735

self.checker_callback_tag = None

1156

736

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

1157

737

return

1158

738

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

1159

self.checker.terminate()

739

try:

740

self.checker.terminate()

741

#time.sleep(0.5)

742

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

743

# self.checker.kill()

744

except OSError as error:

745

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

746

raise

1160

747

self.checker = None

1161

748

1162

749

1163

def dbus_service_property(dbus_interface,

1164

signature="v",

1165

access="readwrite",

1166

byte_arrays=False):

750

def dbus_service_property(dbus_interface, signature="v",

751

access="readwrite", byte_arrays=False):

1167

752

"""Decorators for marking methods of a DBusObjectWithProperties to

1168

753

become properties on the D-Bus.

1169

754

1170

755

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

1171

756

and with one argument by "Set".

1172

757

1173

758

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

1174

759

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

1175

760

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

1178

763

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

1179

764

if byte_arrays and signature != "ay":

1180

765

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

1181

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

1182

766

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

1183

767

def decorator(func):

1184

768

func._dbus_is_property = True

1185

769

func._dbus_interface = dbus_interface

1188

772

func._dbus_name = func.__name__

1189

773

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

1190

774

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

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

775

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1192

776

return func

1193

1194

777

return decorator

1195

778

1196

779

1197

780

def dbus_interface_annotations(dbus_interface):

1198

781

"""Decorator for marking functions returning interface annotations

1199

782

1200

783

Usage:

1201

784

1202

785

@dbus_interface_annotations("org.example.Interface")

1203

786

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

1204

787

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

1205

788

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

1206

789

"false"}

1207

790

"""

1208

1209

791

def decorator(func):

1210

792

func._dbus_is_interface = True

1211

793

func._dbus_interface = dbus_interface

1212

794

func._dbus_name = dbus_interface

1213

795

return func

1214

1215

796

return decorator

1216

797

1217

798

1218

799

def dbus_annotations(annotations):

1219

800

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

1220

801

Usage:

1221

1222

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

1223

"org.freedesktop.DBus.Property."

1224

"EmitsChangedSignal": "false"})

802

1225

803

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

1226

804

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

1227

808

def Property_dbus_property(self):

1228

809

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

1231

810

"""

1232

1233

811

def decorator(func):

1234

812

func._dbus_annotations = annotations

1235

813

return func

1236

1237

814

return decorator

1238

815

1239

816

1240

817

class DBusPropertyException(dbus.exceptions.DBusException):

1241

818

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

1242

819

"""

1243

pass

820

def __unicode__(self):

821

return unicode(str(self))

1244

822

1245

823

1246

824

class DBusPropertyAccessException(DBusPropertyException):

1255

833

pass

1256

834

1257

835

1258

class DBusObjectWithAnnotations(dbus.service.Object):

1259

"""A D-Bus object with annotations.

1260

1261

Classes inheriting from this can use the dbus_annotations

1262

decorator to add annotations to methods or signals.

836

class DBusObjectWithProperties(dbus.service.Object):

837

"""A D-Bus object with properties.

838

839

Classes inheriting from this can use the dbus_service_property

840

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

841

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

1263

842

"""

1264

843

1265

844

@staticmethod

1266

845

def _is_dbus_thing(thing):

1267

846

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

1268

847

1269

848

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

1270

849

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

1271

850

"""

1272

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

851

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

1273

852

False)

1274

853

1275

854

def _get_all_dbus_things(self, thing):

1276

855

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

1277

856

"""

1278

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

857

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

858

name),

1279

859

athing.__get__(self))

1280

860

for cls in self.__class__.__mro__

1281

861

for name, athing in

1282

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

1283

1284

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1285

out_signature="s",

1286

path_keyword='object_path',

1287

connection_keyword='connection')

1288

def Introspect(self, object_path, connection):

1289

"""Overloading of standard D-Bus method.

1290

1291

Inserts annotation tags on methods and signals.

1292

"""

1293

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

1294

connection)

1295

try:

1296

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

1297

1298

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

1299

# Add annotation tags

1300

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

1301

for tag in if_tag.getElementsByTagName(typ):

1302

annots = dict()

1303

for name, prop in (self.

1304

_get_all_dbus_things(typ)):

1305

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

1306

and prop._dbus_interface

1307

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

1308

annots.update(getattr(

1309

prop, "_dbus_annotations", {}))

1310

for name, value in annots.items():

1311

ann_tag = document.createElement(

1312

"annotation")

1313

ann_tag.setAttribute("name", name)

1314

ann_tag.setAttribute("value", value)

1315

tag.appendChild(ann_tag)

1316

# Add interface annotation tags

1317

for annotation, value in dict(

1318

itertools.chain.from_iterable(

1319

annotations().items()

1320

for name, annotations

1321

in self._get_all_dbus_things("interface")

1322

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

1323

)).items():

1324

ann_tag = document.createElement("annotation")

1325

ann_tag.setAttribute("name", annotation)

1326

ann_tag.setAttribute("value", value)

1327

if_tag.appendChild(ann_tag)

1328

# Fix argument name for the Introspect method itself

1329

if (if_tag.getAttribute("name")

1330

== dbus.INTROSPECTABLE_IFACE):

1331

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

1332

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

1333

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

1334

if (arg.getAttribute("direction")

1335

== "out"):

1336

arg.setAttribute("name",

1337

"xml_data")

1338

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

1339

document.unlink()

1340

except (AttributeError, xml.dom.DOMException,

1341

xml.parsers.expat.ExpatError) as error:

1342

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

1343

exc_info=error)

1344

return xmlstring

1345

1346

1347

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1348

"""A D-Bus object with properties.

1349

1350

Classes inheriting from this can use the dbus_service_property

1351

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

1352

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

1353

"""

1354

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

864

1355

865

def _get_dbus_property(self, interface_name, property_name):

1356

866

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

1357

867

property with the specified name and interface.

1358

868

"""

1359

for cls in self.__class__.__mro__:

1360

for name, value in inspect.getmembers(

1361

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

869

for cls in self.__class__.__mro__:

870

for name, value in (inspect.getmembers

871

(cls,

872

self._is_dbus_thing("property"))):

1362

873

if (value._dbus_name == property_name

1363

874

and value._dbus_interface == interface_name):

1364

875

return value.__get__(self)

1365

876

1366

877

# No such property

1367

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

1368

self.dbus_object_path, interface_name, property_name))

1369

1370

@classmethod

1371

def _get_all_interface_names(cls):

1372

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

1373

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

1374

"_dbus_interface", None)

1375

for x in (inspect.getmro(cls))

1376

for attr in dir(x))

1377

if name is not None)

1378

1379

@dbus.service.method(dbus.PROPERTIES_IFACE,

1380

in_signature="ss",

878

raise DBusPropertyNotFound(self.dbus_object_path + ":"

879

+ interface_name + "."

880

+ property_name)

881

882

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

1381

883

out_signature="v")

1382

884

def Get(self, interface_name, property_name):

1383

885

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

1389

891

if not hasattr(value, "variant_level"):

1390

892

return value

1391

893

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

1392

894

1393

895

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

1394

896

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

1395

897

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

1401

903

# The byte_arrays option is not supported yet on

1402

904

# signatures other than "ay".

1403

905

if prop._dbus_signature != "ay":

1404

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

1405

"'ay' signature {!r}"

1406

.format(prop._dbus_signature))

906

raise ValueError

1407

907

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

1408

908

for byte in value))

1409

909

prop(value)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="s",

910

911

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

1413

912

out_signature="a{sv}")

1414

913

def GetAll(self, interface_name):

1415

914

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

1416

915

standard.

1417

916

1418

917

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

1419

918

"""

1420

919

properties = {}

1430

929

if not hasattr(value, "variant_level"):

1431

930

properties[name] = value

1432

931

continue

1433

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

932

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

933

value.variant_level+1)

1435

934

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

1436

1437

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

1438

def PropertiesChanged(self, interface_name, changed_properties,

1439

invalidated_properties):

1440

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

1441

standard.

1442

"""

1443

pass

1444

935

1445

936

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1446

937

out_signature="s",

1447

938

path_keyword='object_path',

1448

939

connection_keyword='connection')

1449

940

def Introspect(self, object_path, connection):

1450

941

"""Overloading of standard D-Bus method.

1451

942

1452

943

Inserts property tags and interface annotation tags.

1453

944

"""

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

945

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

946

connection)

1457

947

try:

1458

948

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

1459

1460

949

def make_tag(document, name, prop):

1461

950

e = document.createElement("property")

1462

951

e.setAttribute("name", name)

1463

952

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

1464

953

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

1465

954

return e

1466

1467

955

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

1468

956

# Add property tags

1469

957

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

1472

960

if prop._dbus_interface

1473

961

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

1474

962

if_tag.appendChild(tag)

1475

# Add annotation tags for properties

1476

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

1477

annots = dict()

1478

for name, prop in self._get_all_dbus_things(

1479

"property"):

1480

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

1481

and prop._dbus_interface

1482

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

1483

annots.update(getattr(

1484

prop, "_dbus_annotations", {}))

1485

for name, value in annots.items():

1486

ann_tag = document.createElement(

1487

"annotation")

1488

ann_tag.setAttribute("name", name)

1489

ann_tag.setAttribute("value", value)

1490

tag.appendChild(ann_tag)

963

# Add annotation tags

964

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

965

for tag in if_tag.getElementsByTagName(typ):

966

annots = dict()

967

for name, prop in (self.

968

_get_all_dbus_things(typ)):

969

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

970

and prop._dbus_interface

971

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

972

annots.update(getattr

973

(prop,

974

"_dbus_annotations",

975

{}))

976

for name, value in annots.iteritems():

977

ann_tag = document.createElement(

978

"annotation")

979

ann_tag.setAttribute("name", name)

980

ann_tag.setAttribute("value", value)

981

tag.appendChild(ann_tag)

982

# Add interface annotation tags

983

for annotation, value in dict(

984

itertools.chain.from_iterable(

985

annotations().iteritems()

986

for name, annotations in

987

self._get_all_dbus_things("interface")

988

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

989

)).iteritems():

990

ann_tag = document.createElement("annotation")

991

ann_tag.setAttribute("name", annotation)

992

ann_tag.setAttribute("value", value)

993

if_tag.appendChild(ann_tag)

1491

994

# Add the names to the return values for the

1492

995

# "org.freedesktop.DBus.Properties" methods

1493

996

if (if_tag.getAttribute("name")

1512

1015

return xmlstring

1513

1016

1514

1017

1515

try:

1516

dbus.OBJECT_MANAGER_IFACE

1517

except AttributeError:

1518

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

1519

1520

1521

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1522

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

1523

1524

Classes inheriting from this exposes the standard

1525

GetManagedObjects call and the InterfacesAdded and

1526

InterfacesRemoved signals on the standard

1527

"org.freedesktop.DBus.ObjectManager" interface.

1528

1529

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

1530

manually.

1531

"""

1532

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1533

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

1534

def GetManagedObjects(self):

1535

"""This function must be overridden"""

1536

raise NotImplementedError()

1537

1538

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def InterfacesAdded(self, object_path, interfaces_and_properties):

1541

pass

1542

1543

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

1544

def InterfacesRemoved(self, object_path, interfaces):

1545

pass

1546

1547

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1548

out_signature="s",

1549

path_keyword='object_path',

1550

connection_keyword='connection')

1551

def Introspect(self, object_path, connection):

1552

"""Overloading of standard D-Bus method.

1553

1554

Override return argument name of GetManagedObjects to be

1555

"objpath_interfaces_and_properties"

1556

"""

1557

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1558

object_path,

1559

connection)

1560

try:

1561

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

1562

1563

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

1564

# Fix argument name for the GetManagedObjects method

1565

if (if_tag.getAttribute("name")

1566

== dbus.OBJECT_MANAGER_IFACE):

1567

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

1568

if (cn.getAttribute("name")

1569

== "GetManagedObjects"):

1570

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

1571

if (arg.getAttribute("direction")

1572

== "out"):

1573

arg.setAttribute(

1574

"name",

1575

"objpath_interfaces"

1576

"_and_properties")

1577

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

1578

document.unlink()

1579

except (AttributeError, xml.dom.DOMException,

1580

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

def datetime_to_dbus(dt, variant_level=0):

1018

def datetime_to_dbus (dt, variant_level=0):

1587

1019

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

1588

1020

if dt is None:

1589

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

1590

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

1021

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

1022

return dbus.String(dt.isoformat(),

1023

variant_level=variant_level)

1591

1024

1592

1025

1593

1026

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1595

1028

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

1596

1029

interface names according to the "alt_interface_names" mapping.

1597

1030

Usage:

1598

1599

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

1600

"net.example.AlternateInterface"})

1031

1032

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

1033

"net.example.AlternateInterface"})

1601

1034

class SampleDBusObject(dbus.service.Object):

1602

1035

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

1603

1036

def SampleDBusMethod():

1604

1037

pass

1605

1038

1606

1039

The above "SampleDBusMethod" on "SampleDBusObject" will be

1607

1040

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

1608

1041

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

1609

1042

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

1610

1043

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

1611

1044

1612

1045

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

1613

1046

(from DBusObjectWithProperties) and interfaces (from the

1614

1047

dbus_interface_annotations decorator).

1615

1048

"""

1616

1617

1049

def wrapper(cls):

1618

1050

for orig_interface_name, alt_interface_name in (

1619

alt_interface_names.items()):

1051

alt_interface_names.iteritems()):

1620

1052

attr = {}

1621

1053

interface_names = set()

1622

1054

# Go though all attributes of the class

1624

1056

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

1625

1057

# with the wrong interface name

1626

1058

if (not hasattr(attribute, "_dbus_interface")

1627

or not attribute._dbus_interface.startswith(

1628

orig_interface_name)):

1059

or not attribute._dbus_interface

1060

.startswith(orig_interface_name)):

1629

1061

continue

1630

1062

# Create an alternate D-Bus interface name based on

1631

1063

# the current name

1632

alt_interface = attribute._dbus_interface.replace(

1633

orig_interface_name, alt_interface_name)

1064

alt_interface = (attribute._dbus_interface

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1634

1067

interface_names.add(alt_interface)

1635

1068

# Is this a D-Bus signal?

1636

1069

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

1637

# Extract the original non-method undecorated

1638

# function by black magic

1639

if sys.version_info.major == 2:

1640

nonmethod_func = (dict(

1070

# Extract the original non-method function by

1071

# black magic

1072

nonmethod_func = (dict(

1641

1073

zip(attribute.func_code.co_freevars,

1642

attribute.__closure__))

1643

["func"].cell_contents)

1644

else:

1645

nonmethod_func = (dict(

1646

zip(attribute.__code__.co_freevars,

1647

attribute.__closure__))

1648

["func"].cell_contents)

1074

attribute.__closure__))["func"]

1075

.cell_contents)

1649

1076

# Create a new, but exactly alike, function

1650

1077

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

1651

1078

# with the alternate D-Bus interface name

1652

new_function = copy_function(nonmethod_func)

1653

new_function = (dbus.service.signal(

1654

alt_interface,

1655

attribute._dbus_signature)(new_function))

1079

new_function = (dbus.service.signal

1080

(alt_interface,

1081

attribute._dbus_signature)

1082

(types.FunctionType(

1083

nonmethod_func.func_code,

1084

nonmethod_func.func_globals,

1085

nonmethod_func.func_name,

1086

nonmethod_func.func_defaults,

1087

nonmethod_func.func_closure)))

1656

1088

# Copy annotations, if any

1657

1089

try:

1658

new_function._dbus_annotations = dict(

1659

attribute._dbus_annotations)

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1660

1092

except AttributeError:

1661

1093

pass

1662

1663

1094

# Define a creator of a function to call both the

1664

1095

# original and alternate functions, so both the

1665

1096

# original and alternate signals gets sent when

1668

1099

"""This function is a scope container to pass

1669

1100

func1 and func2 to the "call_both" function

1670

1101

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1673

1102

def call_both(*args, **kwargs):

1674

1103

"""This function will emit two D-Bus

1675

1104

signals by calling func1 and func2"""

1676

1105

func1(*args, **kwargs)

1677

1106

func2(*args, **kwargs)

1678

# Make wrapper function look like a D-Bus

1679

# signal

1680

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

1681

if name.startswith("_dbus_"):

1682

setattr(call_both, name, attr)

1683

1684

1107

return call_both

1685

1108

# Create the "call_both" function and add it to

1686

1109

# the class

1691

1114

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

1692

1115

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

1693

1116

# to the class.

1694

attr[attrname] = (

1695

dbus.service.method(

1696

alt_interface,

1697

attribute._dbus_in_signature,

1698

attribute._dbus_out_signature)

1699

(copy_function(attribute)))

1117

attr[attrname] = (dbus.service.method

1118

(alt_interface,

1119

attribute._dbus_in_signature,

1120

attribute._dbus_out_signature)

1121

(types.FunctionType

1122

(attribute.func_code,

1123

attribute.func_globals,

1124

attribute.func_name,

1125

attribute.func_defaults,

1126

attribute.func_closure)))

1700

1127

# Copy annotations, if any

1701

1128

try:

1702

attr[attrname]._dbus_annotations = dict(

1703

attribute._dbus_annotations)

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1704

1131

except AttributeError:

1705

1132

pass

1706

1133

# Is this a D-Bus property?

1709

1136

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

1710

1137

# property with the alternate D-Bus interface

1711

1138

# name. Add it to the class.

1712

attr[attrname] = (dbus_service_property(

1713

alt_interface, attribute._dbus_signature,

1714

attribute._dbus_access,

1715

attribute._dbus_get_args_options

1716

["byte_arrays"])

1717

(copy_function(attribute)))

1139

attr[attrname] = (dbus_service_property

1140

(alt_interface,

1141

attribute._dbus_signature,

1142

attribute._dbus_access,

1143

attribute

1144

._dbus_get_args_options

1145

["byte_arrays"])

1146

(types.FunctionType

1147

(attribute.func_code,

1148

attribute.func_globals,

1149

attribute.func_name,

1150

attribute.func_defaults,

1151

attribute.func_closure)))

1718

1152

# Copy annotations, if any

1719

1153

try:

1720

attr[attrname]._dbus_annotations = dict(

1721

attribute._dbus_annotations)

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1722

1156

except AttributeError:

1723

1157

pass

1724

1158

# Is this a D-Bus interface?

1727

1161

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

1728

1162

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

1729

1163

# to the class.

1730

attr[attrname] = (

1731

dbus_interface_annotations(alt_interface)

1732

(copy_function(attribute)))

1164

attr[attrname] = (dbus_interface_annotations

1165

(alt_interface)

1166

(types.FunctionType

1167

(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1733

1172

if deprecate:

1734

1173

# Deprecate all alternate interfaces

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1736

1175

for interface_name in interface_names:

1737

1738

1176

@dbus_interface_annotations(interface_name)

1739

1177

def func(self):

1740

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

1741

"true"}

1178

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

1179

"true" }

1742

1180

# Find an unused name

1743

1181

for aname in (iname.format(i)

1744

1182

for i in itertools.count()):

1748

1186

if interface_names:

1749

1187

# Replace the class with a new subclass of it with

1750

1188

# methods, signals, etc. as created above.

1751

if sys.version_info.major == 2:

1752

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

1753

(cls, ), attr)

1754

else:

1755

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

1756

(cls, ), attr)

1189

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

1190

(cls,), attr)

1757

1191

return cls

1758

1759

1192

return wrapper

1760

1193

1761

1194

1762

1195

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

1763

"se.bsnet.fukt.Mandos"})

1196

"se.bsnet.fukt.Mandos"})

1764

1197

class ClientDBus(Client, DBusObjectWithProperties):

1765

1198

"""A Client class using D-Bus

1766

1199

1767

1200

Attributes:

1768

1201

dbus_object_path: dbus.ObjectPath

1769

1202

bus: dbus.SystemBus()

1770

1203

"""

1771

1204

1772

1205

runtime_expansions = (Client.runtime_expansions

1773

+ ("dbus_object_path", ))

1774

1775

_interface = "se.recompile.Mandos.Client"

1776

1206

+ ("dbus_object_path",))

1207

1777

1208

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

1778

1779

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

1209

1210

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

1780

1211

self.bus = bus

1781

1212

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

1782

1213

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

1783

1214

# the D-Bus

1784

client_object_name = str(self.name).translate(

1215

client_object_name = unicode(self.name).translate(

1785

1216

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

1786

1217

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

1787

self.dbus_object_path = dbus.ObjectPath(

1788

"/clients/" + client_object_name)

1218

self.dbus_object_path = (dbus.ObjectPath

1219

("/clients/" + client_object_name))

1789

1220

DBusObjectWithProperties.__init__(self, self.bus,

1790

1221

self.dbus_object_path)

1791

1792

def notifychangeproperty(transform_func, dbus_name,

1793

type_func=lambda x: x,

1794

variant_level=1,

1795

invalidate_only=False,

1796

_interface=_interface):

1222

1223

def notifychangeproperty(transform_func,

1224

dbus_name, type_func=lambda x: x,

1225

variant_level=1):

1797

1226

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

1798

1227

its changes to DBus.

1799

1228

1800

1229

transform_fun: Function that takes a value and a variant_level

1801

1230

and transforms it to a D-Bus type.

1802

1231

dbus_name: D-Bus name of the variable

1804

1233

to the D-Bus. Default: no transform

1805

1234

variant_level: D-Bus variant level. Default: 1

1806

1235

"""

1807

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

1808

1236

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

1809

1237

def setter(self, value):

1810

1238

if hasattr(self, "dbus_object_path"):

1811

1239

if (not hasattr(self, attrname) or

1812

1240

type_func(getattr(self, attrname, None))

1813

1241

!= type_func(value)):

1814

if invalidate_only:

1815

self.PropertiesChanged(

1816

_interface, dbus.Dictionary(),

1817

dbus.Array((dbus_name, )))

1818

else:

1819

dbus_value = transform_func(

1820

type_func(value),

1821

variant_level=variant_level)

1822

self.PropertyChanged(dbus.String(dbus_name),

1823

dbus_value)

1824

self.PropertiesChanged(

1825

_interface,

1826

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

1827

dbus_value}),

1828

dbus.Array())

1242

dbus_value = transform_func(type_func(value),

1243

variant_level

1244

=variant_level)

1245

self.PropertyChanged(dbus.String(dbus_name),

1246

dbus_value)

1829

1247

setattr(self, attrname, value)

1830

1248

1831

1249

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

1832

1250

1833

1251

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1834

1252

approvals_pending = notifychangeproperty(dbus.Boolean,

1835

1253

"ApprovalPending",

1836

type_func=bool)

1254

type_func = bool)

1837

1255

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

1838

1256

last_enabled = notifychangeproperty(datetime_to_dbus,

1839

1257

"LastEnabled")

1840

checker = notifychangeproperty(

1841

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1258

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

1259

type_func = lambda checker:

1260

checker is not None)

1843

1261

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1844

1262

"LastCheckedOK")

1845

1263

last_checker_status = notifychangeproperty(dbus.Int16,

1848

1266

datetime_to_dbus, "LastApprovalRequest")

1849

1267

approved_by_default = notifychangeproperty(dbus.Boolean,

1850

1268

"ApprovedByDefault")

1851

approval_delay = notifychangeproperty(

1852

dbus.UInt64, "ApprovalDelay",

1853

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

1269

approval_delay = notifychangeproperty(dbus.UInt64,

1270

"ApprovalDelay",

1271

type_func =

1272

timedelta_to_milliseconds)

1854

1273

approval_duration = notifychangeproperty(

1855

1274

dbus.UInt64, "ApprovalDuration",

1856

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

1275

type_func = timedelta_to_milliseconds)

1857

1276

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

1858

timeout = notifychangeproperty(

1859

dbus.UInt64, "Timeout",

1860

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

1277

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

1278

type_func =

1279

timedelta_to_milliseconds)

1861

1280

extended_timeout = notifychangeproperty(

1862

1281

dbus.UInt64, "ExtendedTimeout",

1863

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

1864

interval = notifychangeproperty(

1865

dbus.UInt64, "Interval",

1866

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

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

1284

"Interval",

1285

type_func =

1286

timedelta_to_milliseconds)

1867

1287

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

1868

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

1869

invalidate_only=True)

1870

1288

1871

1289

del notifychangeproperty

1872

1290

1873

1291

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

1874

1292

try:

1875

1293

self.remove_from_connection()

1878

1296

if hasattr(DBusObjectWithProperties, "__del__"):

1879

1297

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

1880

1298

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

1881

1882

def checker_callback(self, source, condition,

1883

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

1884

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

1885

connection, command, *args,

1886

**kwargs)

1887

exitstatus = self.last_checker_status

1888

if exitstatus >= 0:

1299

1300

def checker_callback(self, pid, condition, command,

1301

*args, **kwargs):

1302

self.checker_callback_tag = None

1303

self.checker = None

1304

if os.WIFEXITED(condition):

1305

exitstatus = os.WEXITSTATUS(condition)

1889

1306

# Emit D-Bus signal

1890

1307

self.CheckerCompleted(dbus.Int16(exitstatus),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1308

dbus.Int64(condition),

1893

1309

dbus.String(command))

1894

1310

else:

1895

1311

# Emit D-Bus signal

1896

1312

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

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1313

dbus.Int64(condition),

1901

1314

dbus.String(command))

1902

return ret

1903

1315

1316

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

1317

*args, **kwargs)

1318

1904

1319

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

1905

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

1320

old_checker = self.checker

1321

if self.checker is not None:

1322

old_checker_pid = self.checker.pid

1323

else:

1324

old_checker_pid = None

1906

1325

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

1907

1326

# Only if new checker process was started

1908

1327

if (self.checker is not None

1910

1329

# Emit D-Bus signal

1911

1330

self.CheckerStarted(self.current_checker_command)

1912

1331

return r

1913

1332

1914

1333

def _reset_approved(self):

1915

1334

self.approved = None

1916

1335

return False

1917

1336

1918

1337

def approve(self, value=True):

1338

self.send_changedstate()

1919

1339

self.approved = value

1920

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

1921

* 1000), self._reset_approved)

1922

self.send_changedstate()

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1343

1344

## D-Bus methods, signals & properties

1345

_interface = "se.recompile.Mandos.Client"

1346

1347

## Interfaces

1348

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1354

## Signals

1355

1930

1356

# CheckerCompleted - signal

1931

1357

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

1932

1358

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

1933

1359

"D-Bus signal"

1934

1360

pass

1935

1361

1936

1362

# CheckerStarted - signal

1937

1363

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

1938

1364

def CheckerStarted(self, command):

1939

1365

"D-Bus signal"

1940

1366

pass

1941

1367

1942

1368

# PropertyChanged - signal

1943

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

1944

1369

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

1945

1370

def PropertyChanged(self, property, value):

1946

1371

"D-Bus signal"

1947

1372

pass

1948

1373

1949

1374

# GotSecret - signal

1950

1375

@dbus.service.signal(_interface)

1951

1376

def GotSecret(self):

1954

1379

server to mandos-client

1955

1380

"""

1956

1381

pass

1957

1382

1958

1383

# Rejected - signal

1959

1384

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

1960

1385

def Rejected(self, reason):

1961

1386

"D-Bus signal"

1962

1387

pass

1963

1388

1964

1389

# NeedApproval - signal

1965

1390

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

1966

1391

def NeedApproval(self, timeout, default):

1967

1392

"D-Bus signal"

1968

1393

return self.need_approval()

1969

1970

# Methods

1971

1394

1395

## Methods

1396

1972

1397

# Approve - method

1973

1398

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

1974

1399

def Approve(self, value):

1975

1400

self.approve(value)

1976

1401

1977

1402

# CheckedOK - method

1978

1403

@dbus.service.method(_interface)

1979

1404

def CheckedOK(self):

1980

1405

self.checked_ok()

1981

1406

1982

1407

# Enable - method

1983

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

1984

1408

@dbus.service.method(_interface)

1985

1409

def Enable(self):

1986

1410

"D-Bus method"

1987

1411

self.enable()

1988

1412

1989

1413

# StartChecker - method

1990

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

1991

1414

@dbus.service.method(_interface)

1992

1415

def StartChecker(self):

1993

1416

"D-Bus method"

1994

1417

self.start_checker()

1995

1418

1996

1419

# Disable - method

1997

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

1998

1420

@dbus.service.method(_interface)

1999

1421

def Disable(self):

2000

1422

"D-Bus method"

2001

1423

self.disable()

2002

1424

2003

1425

# StopChecker - method

2004

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

2005

1426

@dbus.service.method(_interface)

2006

1427

def StopChecker(self):

2007

1428

self.stop_checker()

2008

2009

# Properties

2010

1429

1430

## Properties

1431

2011

1432

# ApprovalPending - property

2012

1433

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

2013

1434

def ApprovalPending_dbus_property(self):

2014

1435

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

2015

1436

2016

1437

# ApprovedByDefault - property

2017

@dbus_service_property(_interface,

2018

signature="b",

1438

@dbus_service_property(_interface, signature="b",

2019

1439

access="readwrite")

2020

1440

def ApprovedByDefault_dbus_property(self, value=None):

2021

1441

if value is None: # get

2022

1442

return dbus.Boolean(self.approved_by_default)

2023

1443

self.approved_by_default = bool(value)

2024

1444

2025

1445

# ApprovalDelay - property

2026

@dbus_service_property(_interface,

2027

signature="t",

1446

@dbus_service_property(_interface, signature="t",

2028

1447

access="readwrite")

2029

1448

def ApprovalDelay_dbus_property(self, value=None):

2030

1449

if value is None: # get

2031

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

2032

* 1000)

1450

return dbus.UInt64(self.approval_delay_milliseconds())

2033

1451

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

2034

1452

2035

1453

# ApprovalDuration - property

2036

@dbus_service_property(_interface,

2037

signature="t",

1454

@dbus_service_property(_interface, signature="t",

2038

1455

access="readwrite")

2039

1456

def ApprovalDuration_dbus_property(self, value=None):

2040

1457

if value is None: # get

2041

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

2042

* 1000)

1458

return dbus.UInt64(timedelta_to_milliseconds(

1459

self.approval_duration))

2043

1460

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

2044

1461

2045

1462

# Name - property

2046

@dbus_annotations(

2047

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

2048

1463

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

2049

1464

def Name_dbus_property(self):

2050

1465

return dbus.String(self.name)

2051

2052

# KeyID - property

2053

@dbus_annotations(

2054

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

2055

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

2056

def KeyID_dbus_property(self):

2057

return dbus.String(self.key_id)

2058

1466

2059

1467

# Fingerprint - property

2060

@dbus_annotations(

2061

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

2062

1468

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

2063

1469

def Fingerprint_dbus_property(self):

2064

1470

return dbus.String(self.fingerprint)

2065

1471

2066

1472

# Host - property

2067

@dbus_service_property(_interface,

2068

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2069

1474

access="readwrite")

2070

1475

def Host_dbus_property(self, value=None):

2071

1476

if value is None: # get

2072

1477

return dbus.String(self.host)

2073

self.host = str(value)

2074

1478

self.host = unicode(value)

1479

2075

1480

# Created - property

2076

@dbus_annotations(

2077

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

2078

1481

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

2079

1482

def Created_dbus_property(self):

2080

1483

return datetime_to_dbus(self.created)

2081

1484

2082

1485

# LastEnabled - property

2083

1486

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

2084

1487

def LastEnabled_dbus_property(self):

2085

1488

return datetime_to_dbus(self.last_enabled)

2086

1489

2087

1490

# Enabled - property

2088

@dbus_service_property(_interface,

2089

signature="b",

1491

@dbus_service_property(_interface, signature="b",

2090

1492

access="readwrite")

2091

1493

def Enabled_dbus_property(self, value=None):

2092

1494

if value is None: # get

2095

1497

self.enable()

2096

1498

else:

2097

1499

self.disable()

2098

1500

2099

1501

# LastCheckedOK - property

2100

@dbus_service_property(_interface,

2101

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2102

1503

access="readwrite")

2103

1504

def LastCheckedOK_dbus_property(self, value=None):

2104

1505

if value is not None:

2105

1506

self.checked_ok()

2106

1507

return

2107

1508

return datetime_to_dbus(self.last_checked_ok)

2108

1509

2109

1510

# LastCheckerStatus - property

2110

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

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

2111

1513

def LastCheckerStatus_dbus_property(self):

2112

1514

return dbus.Int16(self.last_checker_status)

2113

1515

2114

1516

# Expires - property

2115

1517

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

2116

1518

def Expires_dbus_property(self):

2117

1519

return datetime_to_dbus(self.expires)

2118

1520

2119

1521

# LastApprovalRequest - property

2120

1522

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

2121

1523

def LastApprovalRequest_dbus_property(self):

2122

1524

return datetime_to_dbus(self.last_approval_request)

2123

1525

2124

1526

# Timeout - property

2125

@dbus_service_property(_interface,

2126

signature="t",

1527

@dbus_service_property(_interface, signature="t",

2127

1528

access="readwrite")

2128

1529

def Timeout_dbus_property(self, value=None):

2129

1530

if value is None: # get

2130

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

2131

old_timeout = self.timeout

1531

return dbus.UInt64(self.timeout_milliseconds())

2132

1532

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

2133

# Reschedule disabling

1533

# Reschedule timeout

2134

1534

if self.enabled:

2135

1535

now = datetime.datetime.utcnow()

2136

self.expires += self.timeout - old_timeout

2137

if self.expires <= now:

1536

time_to_die = timedelta_to_milliseconds(

1537

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

1538

if time_to_die <= 0:

2138

1539

# The timeout has passed

2139

1540

self.disable()

2140

1541

else:

1542

self.expires = (now +

1543

datetime.timedelta(milliseconds =

1544

time_to_die))

2141

1545

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

2142

1546

is None):

2143

1547

return

2144

GLib.source_remove(self.disable_initiator_tag)

2145

self.disable_initiator_tag = GLib.timeout_add(

2146

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

2147

self.disable)

2148

1548

gobject.source_remove(self.disable_initiator_tag)

1549

self.disable_initiator_tag = (gobject.timeout_add

1550

(time_to_die,

1551

self.disable))

1552

2149

1553

# ExtendedTimeout - property

2150

@dbus_service_property(_interface,

2151

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2152

1555

access="readwrite")

2153

1556

def ExtendedTimeout_dbus_property(self, value=None):

2154

1557

if value is None: # get

2155

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

2156

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2157

1559

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

2158

1560

2159

1561

# Interval - property

2160

@dbus_service_property(_interface,

2161

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2162

1563

access="readwrite")

2163

1564

def Interval_dbus_property(self, value=None):

2164

1565

if value is None: # get

2165

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

1566

return dbus.UInt64(self.interval_milliseconds())

2166

1567

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

2167

1568

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

2168

1569

return

2169

1570

if self.enabled:

2170

1571

# Reschedule checker run

2171

GLib.source_remove(self.checker_initiator_tag)

2172

self.checker_initiator_tag = GLib.timeout_add(

2173

value, self.start_checker)

2174

self.start_checker() # Start one now, too

2175

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2176

1577

# Checker - property

2177

@dbus_service_property(_interface,

2178

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2179

1579

access="readwrite")

2180

1580

def Checker_dbus_property(self, value=None):

2181

1581

if value is None: # get

2182

1582

return dbus.String(self.checker_command)

2183

self.checker_command = str(value)

2184

1583

self.checker_command = unicode(value)

1584

2185

1585

# CheckerRunning - property

2186

@dbus_service_property(_interface,

2187

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2188

1587

access="readwrite")

2189

1588

def CheckerRunning_dbus_property(self, value=None):

2190

1589

if value is None: # get

2193

1592

self.start_checker()

2194

1593

else:

2195

1594

self.stop_checker()

2196

1595

2197

1596

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

2201

1597

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

2202

1598

def ObjectPath_dbus_property(self):

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2205

1601

# Secret = property

2206

@dbus_annotations(

2207

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

2208

"invalidates"})

2209

@dbus_service_property(_interface,

2210

signature="ay",

2211

access="write",

2212

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2213

1604

def Secret_dbus_property(self, value):

2214

self.secret = bytes(value)

2215

1605

self.secret = str(value)

1606

2216

1607

del _interface

2217

1608

2218

1609

2219

class ProxyClient:

2220

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

1610

class ProxyClient(object):

1611

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

2221

1612

self._pipe = child_pipe

2222

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

1613

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

2223

1614

if not self._pipe.recv():

2224

raise KeyError(key_id or fpr)

2225

1615

raise KeyError()

1616

2226

1617

def __getattribute__(self, name):

2227

1618

if name == '_pipe':

2228

1619

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

2231

1622

if data[0] == 'data':

2232

1623

return data[1]

2233

1624

if data[0] == 'function':

2234

2235

1625

def func(*args, **kwargs):

2236

1626

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

2237

1627

return self._pipe.recv()[1]

2238

2239

1628

return func

2240

1629

2241

1630

def __setattr__(self, name, value):

2242

1631

if name == '_pipe':

2243

1632

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

2246

1635

2247

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2248

1637

"""A class to handle client connections.

2249

1638

2250

1639

Instantiated once for each connection to handle it.

2251

1640

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

2252

1641

2253

1642

def handle(self):

2254

1643

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

2255

1644

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

2256

str(self.client_address))

1645

unicode(self.client_address))

2257

1646

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

2258

1647

self.server.child_pipe.fileno())

2259

2260

session = gnutls.ClientSession(self.request)

2261

2262

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

2263

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

2264

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

2265

# "+DHE-DSS"))

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2266

1663

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

2267

1664

priority = self.server.gnutls_priority

2268

1665

if priority is None:

2269

1666

priority = "NORMAL"

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2274

1671

# Start communication using the Mandos protocol

2275

1672

# Get protocol number

2276

1673

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

2277

1674

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

2278

1675

try:

2279

1676

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

2280

raise RuntimeError(line)

1677

raise RuntimeError

2281

1678

except (ValueError, IndexError, RuntimeError) as error:

2282

1679

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

2283

1680

return

2284

1681

2285

1682

# Start GnuTLS connection

2286

1683

try:

2287

1684

session.handshake()

2288

except gnutls.Error as error:

1685

except gnutls.errors.GNUTLSError as error:

2289

1686

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

2290

1687

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

2291

1688

# established. Just abandon the request.

2292

1689

return

2293

1690

logger.debug("Handshake succeeded")

2294

1691

2295

1692

approval_required = False

2296

1693

try:

2297

if gnutls.has_rawpk:

2298

fpr = b""

2299

try:

2300

key_id = self.key_id(

2301

self.peer_certificate(session))

2302

except (TypeError, gnutls.Error) as error:

2303

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

2304

return

2305

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

2306

2307

else:

2308

key_id = b""

2309

try:

2310

fpr = self.fingerprint(

2311

self.peer_certificate(session))

2312

except (TypeError, gnutls.Error) as error:

2313

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

2314

return

2315

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

2316

2317

try:

2318

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2319

1705

self.client_address)

2320

1706

except KeyError:

2321

1707

return

2322

1708

2323

1709

if client.approval_delay:

2324

1710

delay = client.approval_delay

2325

1711

client.approvals_pending += 1

2326

1712

approval_required = True

2327

1713

2328

1714

while True:

2329

1715

if not client.enabled:

2330

1716

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

2331

client.name)

1717

client.name)

2332

1718

if self.server.use_dbus:

2333

1719

# Emit D-Bus signal

2334

1720

client.Rejected("Disabled")

2335

1721

return

2336

1722

2337

1723

if client.approved or not client.approval_delay:

2338

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2339

1725

break

2340

1726

elif client.approved is None:

2341

1727

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

2343

1729

if self.server.use_dbus:

2344

1730

# Emit D-Bus signal

2345

1731

client.NeedApproval(

2346

client.approval_delay.total_seconds()

2347

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2348

1734

else:

2349

1735

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

2350

1736

client.name)

2352

1738

# Emit D-Bus signal

2353

1739

client.Rejected("Denied")

2354

1740

return

2355

2356

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2357

1743

time = datetime.datetime.now()

2358

1744

client.changedstate.acquire()

2359

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

1745

(client.changedstate.wait

1746

(float(client.timedelta_to_milliseconds(delay)

1747

/ 1000)))

2360

1748

client.changedstate.release()

2361

1749

time2 = datetime.datetime.now()

2362

1750

if (time2 - time) >= delay:

2372

1760

break

2373

1761

else:

2374

1762

delay -= time2 - time

2375

2376

try:

2377

session.send(client.secret)

2378

except gnutls.Error as error:

2379

logger.warning("gnutls send failed",

2380

exc_info=error)

2381

return

2382

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

2383

1777

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

2384

1778

# bump the timeout using extended_timeout

2385

1779

client.bump_timeout(client.extended_timeout)

2386

1780

if self.server.use_dbus:

2387

1781

# Emit D-Bus signal

2388

1782

client.GotSecret()

2389

1783

2390

1784

finally:

2391

1785

if approval_required:

2392

1786

client.approvals_pending -= 1

2393

1787

try:

2394

1788

session.bye()

2395

except gnutls.Error as error:

1789

except gnutls.errors.GNUTLSError as error:

2396

1790

logger.warning("GnuTLS bye failed",

2397

1791

exc_info=error)

2398

1792

2399

1793

@staticmethod

2400

1794

def peer_certificate(session):

2401

"Return the peer's certificate as a bytestring"

2402

try:

2403

cert_type = gnutls.certificate_type_get2(session._c_object,

2404

gnutls.CTYPE_PEERS)

2405

except AttributeError:

2406

cert_type = gnutls.certificate_type_get(session._c_object)

2407

if gnutls.has_rawpk:

2408

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2409

else:

2410

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2411

# If not a valid certificate type...

2412

if cert_type not in valid_cert_types:

2413

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

2414

valid_cert_types)

2415

# ...return invalid data

2416

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2417

1802

list_size = ctypes.c_uint(1)

2418

cert_list = (gnutls.certificate_get_peers

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2419

1805

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

2420

1806

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

2421

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

1807

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

1808

" certificate")

2422

1809

if list_size.value == 0:

2423

1810

return None

2424

1811

cert = cert_list[0]

2425

1812

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

2426

2427

@staticmethod

2428

def key_id(certificate):

2429

"Convert a certificate bytestring to a hexdigit key ID"

2430

# New GnuTLS "datum" with the public key

2431

datum = gnutls.datum_t(

2432

ctypes.cast(ctypes.c_char_p(certificate),

2433

ctypes.POINTER(ctypes.c_ubyte)),

2434

ctypes.c_uint(len(certificate)))

2435

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

2436

# New empty GnuTLS certificate

2437

pubkey = gnutls.pubkey_t()

2438

gnutls.pubkey_init(ctypes.byref(pubkey))

2439

# Import the raw public key into the certificate

2440

gnutls.pubkey_import(pubkey,

2441

ctypes.byref(datum),

2442

gnutls.X509_FMT_DER)

2443

# New buffer for the key ID

2444

buf = ctypes.create_string_buffer(32)

2445

buf_len = ctypes.c_size_t(len(buf))

2446

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

2447

gnutls.pubkey_get_key_id(pubkey,

2448

gnutls.KEYID_USE_SHA256,

2449

ctypes.cast(ctypes.byref(buf),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.byref(buf_len))

2452

# Deinit the certificate

2453

gnutls.pubkey_deinit(pubkey)

2454

2455

# Convert the buffer to a Python bytestring

2456

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

2457

# Convert the bytestring to hexadecimal notation

2458

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

2459

return hex_key_id

2460

1813

2461

1814

@staticmethod

2462

1815

def fingerprint(openpgp):

2463

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2464

1817

# New GnuTLS "datum" with the OpenPGP public key

2465

datum = gnutls.datum_t(

2466

ctypes.cast(ctypes.c_char_p(openpgp),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2469

1823

# New empty GnuTLS certificate

2470

crt = gnutls.openpgp_crt_t()

2471

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2472

1827

# Import the OpenPGP public key into the certificate

2473

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

2474

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2475

1832

# Verify the self signature in the key

2476

1833

crtverify = ctypes.c_uint()

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2479

1837

if crtverify.value != 0:

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2483

1841

# New buffer for the fingerprint

2484

1842

buf = ctypes.create_string_buffer(20)

2485

1843

buf_len = ctypes.c_size_t()

2486

1844

# Get the fingerprint from the certificate into the buffer

2487

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

2488

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2489

1848

# Deinit the certificate

2490

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2491

1850

# Convert the buffer to a Python bytestring

2492

1851

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

2493

1852

# Convert the bytestring to hexadecimal notation

2495

1854

return hex_fpr

2496

1855

2497

1856

2498

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2499

1858

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

2500

2501

1859

def sub_process_main(self, request, address):

2502

1860

try:

2503

1861

self.finish_request(request, address)

2504

1862

except Exception:

2505

1863

self.handle_error(request, address)

2506

1864

self.close_request(request)

2507

1865

2508

1866

def process_request(self, request, address):

2509

1867

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

2510

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

2511

args=(request, address))

1868

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

1869

args = (request, address))

2512

1870

proc.start()

2513

1871

return proc

2514

1872

2515

1873

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2517

1875

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

2518

2519

1876

def process_request(self, request, client_address):

2520

1877

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

2521

1878

2522

1879

This function creates a new pipe in self.pipe

2523

1880

"""

2524

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2525

1882

2526

1883

proc = MultiprocessingMixIn.process_request(self, request,

2527

1884

client_address)

2528

1885

self.child_pipe.close()

2529

1886

self.add_pipe(parent_pipe, proc)

2530

1887

2531

1888

def add_pipe(self, parent_pipe, proc):

2532

1889

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

2533

raise NotImplementedError()

1890

raise NotImplementedError

2534

1891

2535

1892

2536

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2537

socketserver.TCPServer):

1894

socketserver.TCPServer, object):

2538

1895

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

2539

1896

2540

1897

Attributes:

2541

1898

enabled: Boolean; whether this server is activated yet

2542

1899

interface: None or a network interface name (string)

2543

1900

use_ipv6: Boolean; to use IPv6 or not

2544

1901

"""

2545

2546

1902

def __init__(self, server_address, RequestHandlerClass,

2547

interface=None,

2548

use_ipv6=True,

2549

socketfd=None):

2550

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

2551

creating a new one with socket.socket().

2552

"""

1903

interface=None, use_ipv6=True):

2553

1904

self.interface = interface

2554

1905

if use_ipv6:

2555

1906

self.address_family = socket.AF_INET6

2556

if socketfd is not None:

2557

# Save the file descriptor

2558

self.socketfd = socketfd

2559

# Save the original socket.socket() function

2560

self.socket_socket = socket.socket

2561

2562

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

2563

#

2564

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

2565

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

2566

# patching socket.socket.)

2567

#

2568

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

2569

@functools.wraps(socket.socket)

2570

def socket_wrapper(*args, **kwargs):

2571

# Restore original function so subsequent calls are

2572

# not affected.

2573

socket.socket = self.socket_socket

2574

del self.socket_socket

2575

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

2576

# saved file descriptor.

2577

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

2578

# Replace socket.socket() function with wrapper

2579

socket.socket = socket_wrapper

2580

# The socketserver.TCPServer.__init__ will call

2581

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

2582

# socket_wrapper(), if socketfd was set.

2583

1907

socketserver.TCPServer.__init__(self, server_address,

2584

1908

RequestHandlerClass)

2585

2586

1909

def server_bind(self):

2587

1910

"""This overrides the normal server_bind() function

2588

1911

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

2589

1912

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

2590

global SO_BINDTODEVICE

2591

1913

if self.interface is not None:

2592

1914

if SO_BINDTODEVICE is None:

2593

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

2594

# common enough.

2595

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

2596

SO_BINDTODEVICE = 25

2597

try:

2598

self.socket.setsockopt(

2599

socket.SOL_SOCKET, SO_BINDTODEVICE,

2600

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

2601

except socket.error as error:

2602

if error.errno == errno.EPERM:

2603

logger.error("No permission to bind to"

2604

" interface %s", self.interface)

2605

elif error.errno == errno.ENOPROTOOPT:

2606

logger.error("SO_BINDTODEVICE not available;"

2607

" cannot bind to interface %s",

2608

self.interface)

2609

elif error.errno == errno.ENODEV:

2610

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

2611

" cannot bind", self.interface)

2612

else:

2613

raise

1915

logger.error("SO_BINDTODEVICE does not exist;"

1916

" cannot bind to interface %s",

1917

self.interface)

1918

else:

1919

try:

1920

self.socket.setsockopt(socket.SOL_SOCKET,

1921

SO_BINDTODEVICE,

1922

str(self.interface

1923

+ '\0'))

1924

except socket.error as error:

1925

if error[0] == errno.EPERM:

1926

logger.error("No permission to"

1927

" bind to interface %s",

1928

self.interface)

1929

elif error[0] == errno.ENOPROTOOPT:

1930

logger.error("SO_BINDTODEVICE not available;"

1931

" cannot bind to interface %s",

1932

self.interface)

1933

else:

1934

raise

2614

1935

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

2615

1936

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

2618

1937

if not self.server_address[0]:

2619

1938

if self.address_family == socket.AF_INET6:

2620

any_address = "::" # in6addr_any

1939

any_address = "::" # in6addr_any

2621

1940

else:

2622

any_address = "0.0.0.0" # INADDR_ANY

1941

any_address = socket.INADDR_ANY

2623

1942

self.server_address = (any_address,

2624

1943

self.server_address[1])

2625

1944

elif not self.server_address[1]:

2626

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

1945

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

1946

0)

2627

1947

# if self.interface:

2628

1948

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

2629

1949

# 0, # port

2635

1955

2636

1956

class MandosServer(IPv6_TCPServer):

2637

1957

"""Mandos server.

2638

1958

2639

1959

Attributes:

2640

1960

clients: set of Client objects

2641

1961

gnutls_priority GnuTLS priority string

2642

1962

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

2643

2644

Assumes a GLib.MainLoop event loop.

1963

1964

Assumes a gobject.MainLoop event loop.

2645

1965

"""

2646

2647

1966

def __init__(self, server_address, RequestHandlerClass,

2648

interface=None,

2649

use_ipv6=True,

2650

clients=None,

2651

gnutls_priority=None,

2652

use_dbus=True,

2653

socketfd=None):

1967

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

1968

gnutls_priority=None, use_dbus=True):

2654

1969

self.enabled = False

2655

1970

self.clients = clients

2656

1971

if self.clients is None:

2659

1974

self.gnutls_priority = gnutls_priority

2660

1975

IPv6_TCPServer.__init__(self, server_address,

2661

1976

RequestHandlerClass,

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

1977

interface = interface,

1978

use_ipv6 = use_ipv6)

2666

1979

def server_activate(self):

2667

1980

if self.enabled:

2668

1981

return socketserver.TCPServer.server_activate(self)

2669

1982

2670

1983

def enable(self):

2671

1984

self.enabled = True

2672

1985

2673

1986

def add_pipe(self, parent_pipe, proc):

2674

1987

# Call "handle_ipc" for both data and EOF events

2675

GLib.io_add_watch(

2676

parent_pipe.fileno(),

2677

GLib.IO_IN | GLib.IO_HUP,

2678

functools.partial(self.handle_ipc,

2679

parent_pipe=parent_pipe,

2680

proc=proc))

2681

2682

def handle_ipc(self, source, condition,

2683

parent_pipe=None,

2684

proc=None,

2685

client_object=None):

1988

gobject.io_add_watch(parent_pipe.fileno(),

1989

gobject.IO_IN | gobject.IO_HUP,

1990

functools.partial(self.handle_ipc,

1991

parent_pipe =

1992

parent_pipe,

1993

proc = proc))

1994

1995

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

1996

proc = None, client_object=None):

2686

1997

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

2687

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

1998

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

2688

1999

# Wait for other process to exit

2689

2000

proc.join()

2690

2001

return False

2691

2002

2692

2003

# Read a request from the child

2693

2004

request = parent_pipe.recv()

2694

2005

command = request[0]

2695

2006

2696

2007

if command == 'init':

2697

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

2698

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

2699

address = request[3]

2700

2701

for c in self.clients.values():

2702

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2703

continue

2704

if key_id and c.key_id == key_id:

2705

client = c

2706

break

2707

if fpr and c.fingerprint == fpr:

2008

fpr = request[1]

2009

address = request[2]

2010

2011

for c in self.clients.itervalues():

2012

if c.fingerprint == fpr:

2708

2013

client = c

2709

2014

break

2710

2015

else:

2711

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

2712

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

2016

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

2017

"dress: %s", fpr, address)

2713

2018

if self.use_dbus:

2714

2019

# Emit D-Bus signal

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

2020

mandos_dbus_service.ClientNotFound(fpr,

2716

2021

address[0])

2717

2022

parent_pipe.send(False)

2718

2023

return False

2719

2720

GLib.io_add_watch(

2721

parent_pipe.fileno(),

2722

GLib.IO_IN | GLib.IO_HUP,

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc,

2726

client_object=client))

2024

2025

gobject.io_add_watch(parent_pipe.fileno(),

2026

gobject.IO_IN | gobject.IO_HUP,

2027

functools.partial(self.handle_ipc,

2028

parent_pipe =

2029

parent_pipe,

2030

proc = proc,

2031

client_object =

2032

client))

2727

2033

parent_pipe.send(True)

2728

2034

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

2729

2035

# same fileno

2732

2038

funcname = request[1]

2733

2039

args = request[2]

2734

2040

kwargs = request[3]

2735

2041

2736

2042

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

2737

2043

funcname)(*args,

2738

**kwargs)))

2739

2044

**kwargs)))

2045

2740

2046

if command == 'getattr':

2741

2047

attrname = request[1]

2742

if isinstance(client_object.__getattribute__(attrname),

2743

collections.Callable):

2744

parent_pipe.send(('function', ))

2048

if callable(client_object.__getattribute__(attrname)):

2049

parent_pipe.send(('function',))

2745

2050

else:

2746

parent_pipe.send((

2747

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

2748

2051

parent_pipe.send(('data', client_object

2052

.__getattribute__(attrname)))

2053

2749

2054

if command == 'setattr':

2750

2055

attrname = request[1]

2751

2056

value = request[2]

2752

2057

setattr(client_object, attrname, value)

2753

2058

2754

2059

return True

2755

2060

2756

2061

2757

def rfc3339_duration_to_delta(duration):

2758

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

2759

2760

>>> rfc3339_duration_to_delta("P7D")

2761

datetime.timedelta(7)

2762

>>> rfc3339_duration_to_delta("PT60S")

2763

datetime.timedelta(0, 60)

2764

>>> rfc3339_duration_to_delta("PT60M")

2765

datetime.timedelta(0, 3600)

2766

>>> rfc3339_duration_to_delta("PT24H")

2767

datetime.timedelta(1)

2768

>>> rfc3339_duration_to_delta("P1W")

2769

datetime.timedelta(7)

2770

>>> rfc3339_duration_to_delta("PT5M30S")

2771

datetime.timedelta(0, 330)

2772

>>> rfc3339_duration_to_delta("P1DT3M20S")

2773

datetime.timedelta(1, 200)

2774

"""

2775

2776

# Parsing an RFC 3339 duration with regular expressions is not

2777

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

2778

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

2779

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

2780

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

2781

# avoid excessive use of external libraries.

2782

2783

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

2784

Token = collections.namedtuple("Token", (

2785

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

2786

# a "group" containing digits

2787

"value", # datetime.timedelta or None

2788

"followers")) # Tokens valid after this token

2789

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

2790

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

2791

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

2792

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

2793

datetime.timedelta(seconds=1),

2794

frozenset((token_end, )))

2795

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

2796

datetime.timedelta(minutes=1),

2797

frozenset((token_second, token_end)))

2798

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

2799

datetime.timedelta(hours=1),

2800

frozenset((token_minute, token_end)))

2801

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

2802

None,

2803

frozenset((token_hour, token_minute,

2804

token_second)))

2805

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

2806

datetime.timedelta(days=1),

2807

frozenset((token_time, token_end)))

2808

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

2809

datetime.timedelta(weeks=4),

2810

frozenset((token_day, token_end)))

2811

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

2812

datetime.timedelta(weeks=52),

2813

frozenset((token_month, token_end)))

2814

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

2815

datetime.timedelta(weeks=1),

2816

frozenset((token_end, )))

2817

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

2818

frozenset((token_year, token_month,

2819

token_day, token_time,

2820

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2824

found_token = None

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2829

# Loop until end token is found

2830

while found_token is not token_end:

2831

# Search for any currently valid tokens

2832

for token in followers:

2833

match = token.regexp.match(s)

2834

if match is not None:

2835

# Token found

2836

if token.value is not None:

2837

# Value found, parse digits

2838

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

2839

# Add to value so far

2840

value += factor * token.value

2841

# Strip token from string

2842

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

2843

# Go to found token

2844

found_token = token

2845

# Set valid next tokens

2846

followers = found_token.followers

2847

break

2848

else:

2849

# No currently valid tokens were found

2850

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

2851

.format(duration))

2852

# End token found

2853

return value

2854

2855

2856

2062

def string_to_delta(interval):

2857

2063

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

2858

2064

2859

2065

>>> string_to_delta('7d')

2860

2066

datetime.timedelta(7)

2861

2067

>>> string_to_delta('60s')

2869

2075

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

2870

2076

datetime.timedelta(0, 330)

2871

2077

"""

2872

2873

try:

2874

return rfc3339_duration_to_delta(interval)

2875

except ValueError:

2876

pass

2877

2878

2078

timevalue = datetime.timedelta(0)

2879

2079

for s in interval.split():

2880

2080

try:

2881

suffix = s[-1]

2081

suffix = unicode(s[-1])

2882

2082

value = int(s[:-1])

2883

2083

if suffix == "d":

2884

2084

delta = datetime.timedelta(value)

2891

2091

elif suffix == "w":

2892

2092

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

2893

2093

else:

2894

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

2895

except IndexError as e:

2094

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

2095

.format(suffix))

2096

except (ValueError, IndexError) as e:

2896

2097

raise ValueError(*(e.args))

2897

2098

timevalue += delta

2898

2099

return timevalue

2899

2100

2900

2101

2901

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

2102

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

2902

2103

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

2903

2104

2904

2105

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

2905

2106

if os.fork():

2906

2107

sys.exit()

2914

2115

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

2915

2116

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

2916

2117

raise OSError(errno.ENODEV,

2917

"{} not a character device"

2118

"{0} not a character device"

2918

2119

.format(os.devnull))

2919

2120

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

2920

2121

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

2924

2125

2925

2126

2926

2127

def main():

2927

2128

2928

2129

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

2929

2130

# Parsing of options, both command line and config file

2930

2131

2931

2132

parser = argparse.ArgumentParser()

2932

2133

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

2933

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

2134

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

2934

2135

help="show version number and exit")

2935

2136

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

2936

2137

help="Bind to interface IF")

2942

2143

help="Run self-test")

2943

2144

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

2944

2145

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

2945

" to terminal", default=None)

2146

" to terminal")

2946

2147

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

2947

2148

help="Debug level for stdout output")

2948

2149

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

2955

2156

" files")

2956

2157

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

2957

2158

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

2958

" system bus interface", default=None)

2159

" system bus interface")

2959

2160

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

2960

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

2961

default=None)

2161

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

2962

2162

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

2963

2163

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

2964

" state", default=None)

2965

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

2966

help="Specify a file descriptor to a network"

2967

" socket to use instead of creating one")

2164

" state")

2968

2165

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

2969

2166

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

2970

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

2971

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

2972

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

2973

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

2974

default=None)

2975

2167

2976

2168

options = parser.parse_args()

2977

2169

2978

2170

if options.check:

2979

2171

import doctest

2980

fail_count, test_count = doctest.testmod()

2981

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

2982

2172

doctest.testmod()

2173

sys.exit()

2174

2983

2175

# Default values for config file for server-global settings

2984

if gnutls.has_rawpk:

2985

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

2986

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

2987

else:

2988

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

2989

":+SIGN-DSA-SHA256")

2990

server_defaults = {"interface": "",

2991

"address": "",

2992

"port": "",

2993

"debug": "False",

2994

"priority": priority,

2995

"servicename": "Mandos",

2996

"use_dbus": "True",

2997

"use_ipv6": "True",

2998

"debuglevel": "",

2999

"restore": "True",

3000

"socket": "",

3001

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

3002

"foreground": "False",

3003

"zeroconf": "True",

3004

}

3005

del priority

3006

2176

server_defaults = { "interface": "",

2177

"address": "",

2178

"port": "",

2179

"debug": "False",

2180

"priority":

2181

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

2182

"servicename": "Mandos",

2183

"use_dbus": "True",

2184

"use_ipv6": "True",

2185

"debuglevel": "",

2186

"restore": "True",

2187

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

2188

}

2189

3007

2190

# Parse config file for server-global settings

3008

server_config = configparser.ConfigParser(server_defaults)

2191

server_config = configparser.SafeConfigParser(server_defaults)

3009

2192

del server_defaults

3010

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

3011

# Convert the ConfigParser object to a dict

2193

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

2194

"mandos.conf"))

2195

# Convert the SafeConfigParser object to a dict

3012

2196

server_settings = server_config.defaults()

3013

2197

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

3014

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

3015

"foreground", "zeroconf"):

2198

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

3016

2199

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

3017

2200

option)

3018

2201

if server_settings["port"]:

3019

2202

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

3020

2203

"port")

3021

if server_settings["socket"]:

3022

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

3023

"socket")

3024

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

3025

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

3026

# happen with a supplied network socket.

3027

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

3028

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

3029

["socket"])

3030

2204

del server_config

3031

2205

3032

2206

# Override the settings from the config file with command line

3033

2207

# options, if set.

3034

2208

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

3035

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

3036

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

3037

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

2209

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

2210

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

2211

"statedir"):

3038

2212

value = getattr(options, option)

3039

2213

if value is not None:

3040

2214

server_settings[option] = value

3041

2215

del options

3042

2216

# Force all strings to be unicode

3043

2217

for option in server_settings.keys():

3044

if isinstance(server_settings[option], bytes):

3045

server_settings[option] = (server_settings[option]

3046

.decode("utf-8"))

3047

# Force all boolean options to be boolean

3048

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

3049

"foreground", "zeroconf"):

3050

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

3051

# Debug implies foreground

3052

if server_settings["debug"]:

3053

server_settings["foreground"] = True

2218

if type(server_settings[option]) is str:

2219

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

3054

2220

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

3055

2221

3056

2222

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

3057

3058

if (not server_settings["zeroconf"]

3059

and not (server_settings["port"]

3060

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

3061

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

3062

2223

3063

2224

# For convenience

3064

2225

debug = server_settings["debug"]

3065

2226

debuglevel = server_settings["debuglevel"]

3067

2228

use_ipv6 = server_settings["use_ipv6"]

3068

2229

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

3069

2230

stored_state_file)

3070

foreground = server_settings["foreground"]

3071

zeroconf = server_settings["zeroconf"]

3072

2231

3073

2232

if debug:

3074

2233

initlogger(debug, logging.DEBUG)

3075

2234

else:

3078

2237

else:

3079

2238

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

3080

2239

initlogger(debug, level)

3081

2240

3082

2241

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

3083

syslogger.setFormatter(

3084

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

3085

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

3086

server_settings["servicename"])))

3087

2242

syslogger.setFormatter(logging.Formatter

2243

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

2244

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

2245

.format(server_settings

2246

["servicename"])))

2247

3088

2248

# Parse config file with clients

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2249

client_config = configparser.SafeConfigParser(Client

2250

.client_defaults)

3090

2251

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

3091

2252

"clients.conf"))

3092

2253

3093

2254

global mandos_dbus_service

3094

2255

mandos_dbus_service = None

3095

3096

socketfd = None

3097

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

3098

socketfd = server_settings["socket"]

3099

tcp_server = MandosServer(

3100

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

3101

ClientHandler,

3102

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

3103

use_ipv6=use_ipv6,

3104

gnutls_priority=server_settings["priority"],

3105

use_dbus=use_dbus,

3106

socketfd=socketfd)

3107

if not foreground:

3108

pidfilename = "/run/mandos.pid"

3109

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

3110

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

3111

pidfile = None

2256

2257

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

2258

server_settings["port"]),

2259

ClientHandler,

2260

interface=(server_settings["interface"]

2261

or None),

2262

use_ipv6=use_ipv6,

2263

gnutls_priority=

2264

server_settings["priority"],

2265

use_dbus=use_dbus)

2266

if not debug:

2267

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

3112

2268

try:

3113

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

2269

pidfile = open(pidfilename, "w")

3114

2270

except IOError as e:

3115

2271

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

3116

2272

exc_info=e)

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

2273

2274

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

3121

2275

try:

3122

2276

uid = pwd.getpwnam(name).pw_uid

3123

gid = pwd.getpwnam(group).pw_gid

2277

gid = pwd.getpwnam(name).pw_gid

3124

2278

break

3125

2279

except KeyError:

3126

2280

continue

3130

2284

try:

3131

2285

os.setgid(gid)

3132

2286

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

3136

2287

except OSError as error:

3137

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

3138

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

3139

if error.errno != errno.EPERM:

3140

raise

3141

2288

if error[0] != errno.EPERM:

2289

raise error

2290

3142

2291

if debug:

3143

2292

# Enable all possible GnuTLS debugging

3144

2293

3145

2294

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

3146

2295

# - GnuTLS manual

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2296

gnutls.library.functions.gnutls_global_set_log_level(11)

2297

2298

@gnutls.library.types.gnutls_log_func

3150

2299

def debug_gnutls(level, string):

3151

2300

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

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2301

2302

(gnutls.library.functions

2303

.gnutls_global_set_log_function(debug_gnutls))

2304

3155

2305

# Redirect stdin so all checkers get /dev/null

3156

2306

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

3157

2307

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

3158

2308

if null > 2:

3159

2309

os.close(null)

3160

2310

3161

2311

# Need to fork before connecting to D-Bus

3162

if not foreground:

2312

if not debug:

3163

2313

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

3164

2314

daemon()

3165

3166

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

3167

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

3168

# need to inform GLib that threads will be used.

3169

GLib.threads_init()

3170

2315

2316

gobject.threads_init()

2317

3171

2318

global main_loop

3172

2319

# From the Avahi example code

3173

2320

DBusGMainLoop(set_as_default=True)

3174

main_loop = GLib.MainLoop()

2321

main_loop = gobject.MainLoop()

3175

2322

bus = dbus.SystemBus()

3176

2323

# End of Avahi example code

3177

2324

if use_dbus:

3178

2325

try:

3179

2326

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

3180

bus,

3181

do_not_queue=True)

3182

old_bus_name = dbus.service.BusName(

3183

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

3184

do_not_queue=True)

3185

except dbus.exceptions.DBusException as e:

2327

bus, do_not_queue=True)

2328

old_bus_name = (dbus.service.BusName

2329

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

2330

do_not_queue=True))

2331

except dbus.exceptions.NameExistsException as e:

3186

2332

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

3187

2333

use_dbus = False

3188

2334

server_settings["use_dbus"] = False

3189

2335

tcp_server.use_dbus = False

3190

if zeroconf:

3191

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3192

service = AvahiServiceToSyslog(

3193

name=server_settings["servicename"],

3194

servicetype="_mandos._tcp",

3195

protocol=protocol,

3196

bus=bus)

3197

if server_settings["interface"]:

3198

service.interface = if_nametoindex(

3199

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

3200

2336

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2337

service = AvahiServiceToSyslog(name =

2338

server_settings["servicename"],

2339

servicetype = "_mandos._tcp",

2340

protocol = protocol, bus = bus)

2341

if server_settings["interface"]:

2342

service.interface = (if_nametoindex

2343

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

2344

3201

2345

global multiprocessing_manager

3202

2346

multiprocessing_manager = multiprocessing.Manager()

3203

2347

3204

2348

client_class = Client

3205

2349

if use_dbus:

3206

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

3207

2350

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

2351

3208

2352

client_settings = Client.config_parser(client_config)

3209

2353

old_client_settings = {}

3210

2354

clients_data = {}

3211

3212

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

3213

global wnull

3214

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

3215

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

3216

# mode

3217

if debug or not foreground:

3218

wnull.close()

3219

2355

3220

2356

# Get client data and settings from last running state.

3221

2357

if server_settings["restore"]:

3222

2358

try:

3223

2359

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

3224

if sys.version_info.major == 2:

3225

clients_data, old_client_settings = pickle.load(

3226

stored_state)

3227

else:

3228

bytes_clients_data, bytes_old_client_settings = (

3229

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

3230

# Fix bytes to strings

3231

# clients_data

3232

# .keys()

3233

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

3234

if isinstance(key, bytes)

3235

else key): value

3236

for key, value in

3237

bytes_clients_data.items()}

3238

del bytes_clients_data

3239

for key in clients_data:

3240

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

3241

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

3242

for k, v in

3243

clients_data[key].items()}

3244

clients_data[key] = value

3245

# .client_structure

3246

value["client_structure"] = [

3247

(s.decode("utf-8")

3248

if isinstance(s, bytes)

3249

else s) for s in

3250

value["client_structure"]]

3251

# .name & .host

3252

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

3253

if isinstance(value[k], bytes):

3254

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

3255

if "key_id" not in value:

3256

value["key_id"] = ""

3257

elif "fingerprint" not in value:

3258

value["fingerprint"] = ""

3259

# old_client_settings

3260

# .keys()

3261

old_client_settings = {

3262

(key.decode("utf-8")

3263

if isinstance(key, bytes)

3264

else key): value

3265

for key, value in

3266

bytes_old_client_settings.items()}

3267

del bytes_old_client_settings

3268

# .host

3269

for value in old_client_settings.values():

3270

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

3271

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

3272

.decode("utf-8"))

2360

clients_data, old_client_settings = (pickle.load

2361

(stored_state))

3273

2362

os.remove(stored_state_path)

3274

2363

except IOError as e:

3275

2364

if e.errno == errno.ENOENT:

3276

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

3277

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

2365

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

2366

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

3278

2367

else:

3279

2368

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

3280

2369

exc_info=e)

3281

2370

raise

3282

2371

except EOFError as e:

3283

2372

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

3284

"EOFError:",

3285

exc_info=e)

3286

2373

"EOFError:", exc_info=e)

2374

3287

2375

with PGPEngine() as pgp:

3288

for client_name, client in clients_data.items():

3289

# Skip removed clients

3290

if client_name not in client_settings:

3291

continue

3292

2376

for client_name, client in clients_data.iteritems():

3293

2377

# Decide which value to use after restoring saved state.

3294

2378

# We have three different values: Old config file,

3295

2379

# new config file, and saved state.

3300

2384

# For each value in new config, check if it

3301

2385

# differs from the old config value (Except for

3302

2386

# the "secret" attribute)

3303

if (name != "secret"

3304

and (value !=

3305

old_client_settings[client_name][name])):

2387

if (name != "secret" and

2388

value != old_client_settings[client_name]

2389

[name]):

3306

2390

client[name] = value

3307

2391

except KeyError:

3308

2392

pass

3309

2393

3310

2394

# Clients who has passed its expire date can still be

3311

# enabled if its last checker was successful. A Client

2395

# enabled if its last checker was successful. Clients

3312

2396

# whose checker succeeded before we stored its state is

3313

2397

# assumed to have successfully run all checkers during

3314

2398

# downtime.

3316

2400

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

3317

2401

if not client["last_checked_ok"]:

3318

2402

logger.warning(

3319

"disabling client {} - Client never "

3320

"performed a successful checker".format(

3321

client_name))

2403

"disabling client {0} - Client never "

2404

"performed a successful checker"

2405

.format(client_name))

3322

2406

client["enabled"] = False

3323

2407

elif client["last_checker_status"] != 0:

3324

2408

logger.warning(

3325

"disabling client {} - Client last"

3326

" checker failed with error code"

3327

" {}".format(

3328

client_name,

3329

client["last_checker_status"]))

2409

"disabling client {0} - Client "

2410

"last checker failed with error code {1}"

2411

.format(client_name,

2412

client["last_checker_status"]))

3330

2413

client["enabled"] = False

3331

2414

else:

3332

client["expires"] = (

3333

datetime.datetime.utcnow()

3334

+ client["timeout"])

2415

client["expires"] = (datetime.datetime

2416

.utcnow()

2417

+ client["timeout"])

3335

2418

logger.debug("Last checker succeeded,"

3336

" keeping {} enabled".format(

3337

client_name))

2419

" keeping {0} enabled"

2420

.format(client_name))

3338

2421

try:

3339

client["secret"] = pgp.decrypt(

3340

client["encrypted_secret"],

3341

client_settings[client_name]["secret"])

2422

client["secret"] = (

2423

pgp.decrypt(client["encrypted_secret"],

2424

client_settings[client_name]

2425

["secret"]))

3342

2426

except PGPError:

3343

2427

# If decryption fails, we use secret from new settings

3344

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

3345

client_name))

3346

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

3347

["secret"])

3348

2428

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

2429

.format(client_name))

2430

client["secret"] = (

2431

client_settings[client_name]["secret"])

2432

3349

2433

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

3350

2434

for client_name in (set(old_client_settings)

3351

2435

- set(client_settings)):

3353

2437

for client_name in (set(client_settings)

3354

2438

- set(old_client_settings)):

3355

2439

clients_data[client_name] = client_settings[client_name]

3356

2440

3357

2441

# Create all client objects

3358

for client_name, client in clients_data.items():

2442

for client_name, client in clients_data.iteritems():

3359

2443

tcp_server.clients[client_name] = client_class(

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2444

name = client_name, settings = client)

2445

3364

2446

if not tcp_server.clients:

3365

2447

logger.warning("No clients defined")

3366

3367

if not foreground:

3368

if pidfile is not None:

3369

pid = os.getpid()

3370

try:

3371

with pidfile:

3372

print(pid, file=pidfile)

3373

except IOError:

3374

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

3375

pidfilename, pid)

3376

del pidfile

2448

2449

if not debug:

2450

try:

2451

with pidfile:

2452

pid = os.getpid()

2453

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

2454

del pidfile

2455

except IOError:

2456

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

2457

pidfilename, pid)

2458

except NameError:

2459

# "pidfile" was never created

2460

pass

3377

2461

del pidfilename

3378

3379

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

3380

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3381

lambda: main_loop.quit() and False)

3382

2462

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

2463

2464

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

2465

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

2466

3383

2467

if use_dbus:

3384

3385

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2468

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

2469

"se.bsnet.fukt.Mandos"})

2470

class MandosDBusService(DBusObjectWithProperties):

3388

2471

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

3389

3390

2472

def __init__(self):

3391

2473

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

3392

3393

2474

_interface = "se.recompile.Mandos"

3394

2475

2476

@dbus_interface_annotations(_interface)

2477

def _foo(self):

2478

return { "org.freedesktop.DBus.Property"

2479

".EmitsChangedSignal":

2480

"false"}

2481

3395

2482

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

3396

2483

def ClientAdded(self, objpath):

3397

2484

"D-Bus signal"

3398

2485

pass

3399

2486

3400

2487

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

3401

def ClientNotFound(self, key_id, address):

2488

def ClientNotFound(self, fingerprint, address):

3402

2489

"D-Bus signal"

3403

2490

pass

3404

3405

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

3406

"true"})

2491

3407

2492

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

3408

2493

def ClientRemoved(self, objpath, name):

3409

2494

"D-Bus signal"

3410

2495

pass

3411

3412

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

3413

"true"})

2496

3414

2497

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

3415

2498

def GetAllClients(self):

3416

2499

"D-Bus method"

3417

return dbus.Array(c.dbus_object_path for c in

3418

tcp_server.clients.values())

3419

3420

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

3421

"true"})

2500

return dbus.Array(c.dbus_object_path

2501

for c in

2502

tcp_server.clients.itervalues())

2503

3422

2504

@dbus.service.method(_interface,

3423

2505

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

3424

2506

def GetAllClientsWithProperties(self):

3425

2507

"D-Bus method"

3426

2508

return dbus.Dictionary(

3427

{c.dbus_object_path: c.GetAll(

3428

"se.recompile.Mandos.Client")

3429

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

2509

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

2510

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

3430

2511

signature="oa{sv}")

3431

2512

3432

2513

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

3433

2514

def RemoveClient(self, object_path):

3434

2515

"D-Bus method"

3435

for c in tcp_server.clients.values():

2516

for c in tcp_server.clients.itervalues():

3436

2517

if c.dbus_object_path == object_path:

3437

2518

del tcp_server.clients[c.name]

3438

2519

c.remove_from_connection()

3439

# Don't signal the disabling

2520

# Don't signal anything except ClientRemoved

3440

2521

c.disable(quiet=True)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2522

# Emit D-Bus signal

2523

self.ClientRemoved(object_path, c.name)

3443

2524

return

3444

2525

raise KeyError(object_path)

3445

2526

3446

2527

del _interface

3447

3448

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3449

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

3450

def GetManagedObjects(self):

3451

"""D-Bus method"""

3452

return dbus.Dictionary(

3453

{client.dbus_object_path:

3454

dbus.Dictionary(

3455

{interface: client.GetAll(interface)

3456

for interface in

3457

client._get_all_interface_names()})

3458

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

3459

3460

def client_added_signal(self, client):

3461

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

3462

if use_dbus:

3463

# New standard signal

3464

self.InterfacesAdded(

3465

client.dbus_object_path,

3466

dbus.Dictionary(

3467

{interface: client.GetAll(interface)

3468

for interface in

3469

client._get_all_interface_names()}))

3470

# Old signal

3471

self.ClientAdded(client.dbus_object_path)

3472

3473

def client_removed_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesRemoved(

3478

client.dbus_object_path,

3479

client._get_all_interface_names())

3480

# Old signal

3481

self.ClientRemoved(client.dbus_object_path,

3482

client.name)

3483

2528

3484

2529

mandos_dbus_service = MandosDBusService()

3485

3486

# Save modules to variables to exempt the modules from being

3487

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

3488

mp = multiprocessing

3489

wn = wnull

3490

2530

3491

2531

def cleanup():

3492

2532

"Cleanup function; run on exit"

3493

if zeroconf:

3494

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2533

service.cleanup()

2534

2535

multiprocessing.active_children()

3498

2536

if not (tcp_server.clients or client_settings):

3499

2537

return

3500

2538

3501

2539

# Store client before exiting. Secrets are encrypted with key

3502

2540

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

3503

2541

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

3504

2542

clients = {}

3505

2543

with PGPEngine() as pgp:

3506

for client in tcp_server.clients.values():

2544

for client in tcp_server.clients.itervalues():

3507

2545

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

3508

2546

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

3509

2547

key)

3510

2548

client_dict = {}

3511

2549

3512

2550

# A list of attributes that can not be pickled

3513

2551

# + secret.

3514

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

3515

"checker", "server_settings"}

3516

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

3517

.Object):

2552

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

2553

"checker"))

2554

for name, typ in (inspect.getmembers

2555

(dbus.service.Object)):

3518

2556

exclude.add(name)

3519

2557

3520

2558

client_dict["encrypted_secret"] = (client

3521

2559

.encrypted_secret)

3522

2560

for attr in client.client_structure:

3523

2561

if attr not in exclude:

3524

2562

client_dict[attr] = getattr(client, attr)

3525

2563

3526

2564

clients[client.name] = client_dict

3527

2565

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

3528

2566

3529

2567

try:

3530

with tempfile.NamedTemporaryFile(

3531

mode='wb',

3532

suffix=".pickle",

3533

prefix='clients-',

3534

dir=os.path.dirname(stored_state_path),

3535

delete=False) as stored_state:

3536

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

3537

protocol=2)

3538

tempname = stored_state.name

2568

with (tempfile.NamedTemporaryFile

2569

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

2570

dir=os.path.dirname(stored_state_path),

2571

delete=False)) as stored_state:

2572

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

2573

tempname=stored_state.name

3539

2574

os.rename(tempname, stored_state_path)

3540

2575

except (IOError, OSError) as e:

3541

2576

if not debug:

3544

2579

except NameError:

3545

2580

pass

3546

2581

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

3547

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

2582

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

3548

2583

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

3549

2584

else:

3550

2585

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

3551

2586

exc_info=e)

3552

raise

3553

2587

raise e

2588

3554

2589

# Delete all clients, and settings from config

3555

2590

while tcp_server.clients:

3556

2591

name, client = tcp_server.clients.popitem()

3557

2592

if use_dbus:

3558

2593

client.remove_from_connection()

3559

# Don't signal the disabling

2594

# Don't signal anything except ClientRemoved

3560

2595

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

3562

2596

if use_dbus:

3563

mandos_dbus_service.client_removed_signal(client)

2597

# Emit D-Bus signal

2598

mandos_dbus_service.ClientRemoved(client

2599

.dbus_object_path,

2600

client.name)

3564

2601

client_settings.clear()

3565

2602

3566

2603

atexit.register(cleanup)

3567

3568

for client in tcp_server.clients.values():

2604

2605

for client in tcp_server.clients.itervalues():

3569

2606

if use_dbus:

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2607

# Emit D-Bus signal

2608

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3572

2609

# Need to initiate checking of clients

3573

2610

if client.enabled:

3574

2611

client.init_checker()

3575

2612

3576

2613

tcp_server.enable()

3577

2614

tcp_server.server_activate()

3578

2615

3579

2616

# Find out what port we got

3580

if zeroconf:

3581

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

2617

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

3582

2618

if use_ipv6:

3583

2619

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

3584

2620

" flowinfo %d, scope_id %d",

3586

2622

else: # IPv4

3587

2623

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

3588

2624

*tcp_server.socket.getsockname())

3589

3590

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

3591

2625

2626

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

2627

3592

2628

try:

3593

if zeroconf:

3594

# From the Avahi example code

3595

try:

3596

service.activate()

3597

except dbus.exceptions.DBusException as error:

3598

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

3599

cleanup()

3600

sys.exit(1)

3601

# End of Avahi example code

3602

3603

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

3604

lambda *args, **kwargs:

3605

(tcp_server.handle_request

3606

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

3607

2629

# From the Avahi example code

2630

try:

2631

service.activate()

2632

except dbus.exceptions.DBusException as error:

2633

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

2634

cleanup()

2635

sys.exit(1)

2636

# End of Avahi example code

2637

2638

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

2639

lambda *args, **kwargs:

2640

(tcp_server.handle_request

2641

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

2642

3608

2643

logger.debug("Starting main loop")

3609

2644

main_loop.run()

3610

2645

except AvahiError as error:

3619

2654

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

3620

2655

cleanup()

3621

2656

3622

3623

2657

if __name__ == '__main__':

3624

2658

main()