/mandos/trunk : revision 921

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 program is free software: you can redistribute it and/or modify

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

78

import collections

79

import codecs

71

80

72

81

import dbus

73

82

import dbus.service

74

import gobject

75

import avahi

83

from gi.repository import GLib

76

84

from dbus.mainloop.glib import DBusGMainLoop

77

85

import ctypes

78

86

import ctypes.util

79

87

import xml.dom.minidom

80

88

import inspect

81

import GnuPGInterface

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.16"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

186

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

151

206

def __enter__(self):

152

207

return self

153

154

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

208

209

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

155

210

self._cleanup()

156

211

return False

157

212

158

213

def __del__(self):

159

214

self._cleanup()

160

215

161

216

def _cleanup(self):

162

217

if self.tempdir is not None:

163

218

# Delete contents of tempdir

164

219

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

165

topdown = False):

220

topdown=False):

166

221

for filename in files:

167

222

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

168

223

for dirname in dirs:

170

225

# Remove tempdir

171

226

os.rmdir(self.tempdir)

172

227

self.tempdir = None

173

228

174

229

def password_encode(self, password):

175

230

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

176

231

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

177

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

178

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

179

240

def encrypt(self, data, password):

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

194

256

return ciphertext

195

257

196

258

def decrypt(self, data, password):

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

211

274

return decrypted_plaintext

212

275

213

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

It is instantiated once, and simulates having an Avahi module."""

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

214

304

class AvahiError(Exception):

215

305

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

216

306

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

307

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

308

**kwargs)

309

220

310

221

311

class AvahiServiceError(AvahiError):

222

312

pass

223

313

314

224

315

class AvahiGroupError(AvahiError):

225

316

pass

226

317

227

318

228

319

class AvahiService(object):

229

320

"""An Avahi (Zeroconf) service.

230

321

231

322

Attributes:

232

323

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

233

324

Used to optionally bind to the specified interface.

234

325

name: string; Example: 'Mandos'

235

326

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

236

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

327

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

237

328

port: integer; what port to announce

238

329

TXT: list of strings; TXT record for the service

239

330

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

245

336

server: D-Bus Server

246

337

bus: dbus.SystemBus()

247

338

"""

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

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

253

351

self.interface = interface

254

352

self.name = name

255

353

self.type = servicetype

264

362

self.server = None

265

363

self.bus = bus

266

364

self.entry_group_state_changed_match = None

267

268

def rename(self):

365

366

def rename(self, remove=True):

269

367

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

270

368

if self.rename_count >= self.max_renames:

271

369

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

272

370

" after %i retries, exiting.",

273

371

self.rename_count)

274

372

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

277

376

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

278

377

self.name)

279

self.remove()

378

if remove:

379

self.remove()

280

380

try:

281

381

self.add()

282

382

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

288

392

def remove(self):

289

393

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

290

394

if self.entry_group_state_changed_match is not None:

292

396

self.entry_group_state_changed_match = None

293

397

if self.group is not None:

294

398

self.group.Reset()

295

399

296

400

def add(self):

297

401

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

298

402

self.remove()

315

419

dbus.UInt16(self.port),

316

420

avahi.string_array_to_txt_array(self.TXT))

317

421

self.group.Commit()

318

422

319

423

def entry_group_state_changed(self, state, error):

320

424

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

321

425

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

322

426

323

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

324

428

logger.debug("Zeroconf service established.")

325

429

elif state == avahi.ENTRY_GROUP_COLLISION:

327

431

self.rename()

328

432

elif state == avahi.ENTRY_GROUP_FAILURE:

329

433

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

330

unicode(error))

331

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

332

.format(error))

333

434

str(error))

435

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

436

334

437

def cleanup(self):

335

438

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

336

439

if self.group is not None:

341

444

pass

342

445

self.group = None

343

446

self.remove()

344

447

345

448

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

346

449

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

347

450

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

355

457

if state in bad_states:

356

458

if bad_states[state] is not None:

357

459

if error is None:

360

462

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

361

463

self.cleanup()

362

464

elif state == avahi.SERVER_RUNNING:

363

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

364

477

else:

365

478

if error is None:

366

479

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

367

480

else:

368

481

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

369

482

370

483

def activate(self):

371

484

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

372

485

if self.server is None:

376

489

follow_name_owner_changes=True),

377

490

avahi.DBUS_INTERFACE_SERVER)

378

491

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

492

self.server_state_changed)

380

493

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

381

494

495

382

496

class AvahiServiceToSyslog(AvahiService):

383

def rename(self):

497

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

384

498

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

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

499

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

500

**kwargs)

501

syslogger.setFormatter(logging.Formatter(

502

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

503

.format(self.name)))

390

504

return ret

391

505

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

506

507

# Pretend that we have a GnuTLS module

508

class GnuTLS(object):

509

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

510

It is instantiated once, and simulates having a GnuTLS module."""

511

512

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

513

if library is None:

514

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

515

_library = ctypes.cdll.LoadLibrary(library)

516

del library

517

_need_version = b"3.3.0"

518

519

def __init__(self):

520

# Need to use "self" here, since this method is called before

521

# the assignment to the "gnutls" global variable happens.

522

if self.check_version(self._need_version) is None:

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CLIENT = 2

535

SHUT_RDWR = 0

536

CRD_CERTIFICATE = 1

537

E_NO_CERTIFICATE_FOUND = -49

538

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

539

540

# Types

541

class session_int(ctypes.Structure):

542

_fields_ = []

543

session_t = ctypes.POINTER(session_int)

544

545

class certificate_credentials_st(ctypes.Structure):

546

_fields_ = []

547

certificate_credentials_t = ctypes.POINTER(

548

certificate_credentials_st)

549

certificate_type_t = ctypes.c_int

550

551

class datum_t(ctypes.Structure):

552

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

553

('size', ctypes.c_uint)]

554

555

class openpgp_crt_int(ctypes.Structure):

556

_fields_ = []

557

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

558

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

559

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

560

credentials_type_t = ctypes.c_int

561

transport_ptr_t = ctypes.c_void_p

562

close_request_t = ctypes.c_int

563

564

# Exceptions

565

class Error(Exception):

566

# We need to use the class name "GnuTLS" here, since this

567

# exception might be raised from within GnuTLS.__init__,

568

# which is called before the assignment to the "gnutls"

569

# global variable has happened.

570

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

571

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

572

# code is passed, convert it to a string with

573

# gnutls.strerror()

574

self.code = code

575

if message is None and code is not None:

576

message = GnuTLS.strerror(code)

577

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

578

message, *args)

579

580

class CertificateSecurityError(Error):

581

pass

582

583

# Classes

584

class Credentials(object):

585

def __init__(self):

586

self._c_object = gnutls.certificate_credentials_t()

587

gnutls.certificate_allocate_credentials(

588

ctypes.byref(self._c_object))

589

self.type = gnutls.CRD_CERTIFICATE

590

591

def __del__(self):

592

gnutls.certificate_free_credentials(self._c_object)

593

594

class ClientSession(object):

595

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

596

self._c_object = gnutls.session_t()

597

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

598

gnutls.set_default_priority(self._c_object)

599

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

600

gnutls.handshake_set_private_extensions(self._c_object,

601

True)

602

self.socket = socket

603

if credentials is None:

604

credentials = gnutls.Credentials()

605

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

606

ctypes.cast(credentials._c_object,

607

ctypes.c_void_p))

608

self.credentials = credentials

609

610

def __del__(self):

611

gnutls.deinit(self._c_object)

612

613

def handshake(self):

614

return gnutls.handshake(self._c_object)

615

616

def send(self, data):

617

data = bytes(data)

618

data_len = len(data)

619

while data_len > 0:

620

data_len -= gnutls.record_send(self._c_object,

621

data[-data_len:],

622

data_len)

623

624

def bye(self):

625

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

626

627

# Error handling functions

628

def _error_code(result):

629

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

630

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

631

if result >= 0:

632

return result

633

if result == gnutls.E_NO_CERTIFICATE_FOUND:

634

raise gnutls.CertificateSecurityError(code=result)

635

raise gnutls.Error(code=result)

636

637

def _retry_on_error(result, func, arguments):

638

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

639

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

640

while result < 0:

641

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

642

return _error_code(result)

643

result = func(*arguments)

644

return result

645

646

# Unless otherwise indicated, the function declarations below are

647

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

648

649

# Functions

650

priority_set_direct = _library.gnutls_priority_set_direct

651

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

652

ctypes.POINTER(ctypes.c_char_p)]

653

priority_set_direct.restype = _error_code

654

655

init = _library.gnutls_init

656

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

657

init.restype = _error_code

658

659

set_default_priority = _library.gnutls_set_default_priority

660

set_default_priority.argtypes = [session_t]

661

set_default_priority.restype = _error_code

662

663

record_send = _library.gnutls_record_send

664

record_send.argtypes = [session_t, ctypes.c_void_p,

665

ctypes.c_size_t]

666

record_send.restype = ctypes.c_ssize_t

667

record_send.errcheck = _retry_on_error

668

669

certificate_allocate_credentials = (

670

_library.gnutls_certificate_allocate_credentials)

671

certificate_allocate_credentials.argtypes = [

672

ctypes.POINTER(certificate_credentials_t)]

673

certificate_allocate_credentials.restype = _error_code

674

675

certificate_free_credentials = (

676

_library.gnutls_certificate_free_credentials)

677

certificate_free_credentials.argtypes = [

678

certificate_credentials_t]

679

certificate_free_credentials.restype = None

680

681

handshake_set_private_extensions = (

682

_library.gnutls_handshake_set_private_extensions)

683

handshake_set_private_extensions.argtypes = [session_t,

684

ctypes.c_int]

685

handshake_set_private_extensions.restype = None

686

687

credentials_set = _library.gnutls_credentials_set

688

credentials_set.argtypes = [session_t, credentials_type_t,

689

ctypes.c_void_p]

690

credentials_set.restype = _error_code

691

692

strerror = _library.gnutls_strerror

693

strerror.argtypes = [ctypes.c_int]

694

strerror.restype = ctypes.c_char_p

695

696

certificate_type_get = _library.gnutls_certificate_type_get

697

certificate_type_get.argtypes = [session_t]

698

certificate_type_get.restype = _error_code

699

700

certificate_get_peers = _library.gnutls_certificate_get_peers

701

certificate_get_peers.argtypes = [session_t,

702

ctypes.POINTER(ctypes.c_uint)]

703

certificate_get_peers.restype = ctypes.POINTER(datum_t)

704

705

global_set_log_level = _library.gnutls_global_set_log_level

706

global_set_log_level.argtypes = [ctypes.c_int]

707

global_set_log_level.restype = None

708

709

global_set_log_function = _library.gnutls_global_set_log_function

710

global_set_log_function.argtypes = [log_func]

711

global_set_log_function.restype = None

712

713

deinit = _library.gnutls_deinit

714

deinit.argtypes = [session_t]

715

deinit.restype = None

716

717

handshake = _library.gnutls_handshake

718

handshake.argtypes = [session_t]

719

handshake.restype = _error_code

720

handshake.errcheck = _retry_on_error

721

722

transport_set_ptr = _library.gnutls_transport_set_ptr

723

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

724

transport_set_ptr.restype = None

725

726

bye = _library.gnutls_bye

727

bye.argtypes = [session_t, close_request_t]

728

bye.restype = _error_code

729

bye.errcheck = _retry_on_error

730

731

check_version = _library.gnutls_check_version

732

check_version.argtypes = [ctypes.c_char_p]

733

check_version.restype = ctypes.c_char_p

734

735

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

736

737

openpgp_crt_init = _library.gnutls_openpgp_crt_init

738

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

739

openpgp_crt_init.restype = _error_code

740

741

openpgp_crt_import = _library.gnutls_openpgp_crt_import

742

openpgp_crt_import.argtypes = [openpgp_crt_t,

743

ctypes.POINTER(datum_t),

744

openpgp_crt_fmt_t]

745

openpgp_crt_import.restype = _error_code

746

747

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

748

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

749

ctypes.POINTER(ctypes.c_uint)]

750

openpgp_crt_verify_self.restype = _error_code

751

752

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

753

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

754

openpgp_crt_deinit.restype = None

755

756

openpgp_crt_get_fingerprint = (

757

_library.gnutls_openpgp_crt_get_fingerprint)

758

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

759

ctypes.c_void_p,

760

ctypes.POINTER(

761

ctypes.c_size_t)]

762

openpgp_crt_get_fingerprint.restype = _error_code

763

764

# Remove non-public functions

765

del _error_code, _retry_on_error

766

# Create the global "gnutls" object, simulating a module

767

gnutls = GnuTLS()

768

769

770

def call_pipe(connection, # : multiprocessing.Connection

771

func, *args, **kwargs):

772

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

773

774

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

775

return value on the provided multiprocessing.Connection.

776

"""

777

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

778

connection.close()

779

397

780

398

781

class Client(object):

399

782

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

400

783

401

784

Attributes:

402

785

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

403

786

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

405

788

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

406

789

to see if the client lives.

407

790

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

791

checker_callback_tag: a GLib event source tag, or None

409

792

checker_command: string; External command which is run to check

410

793

if client lives. %() expansions are done at

411

794

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

412

795

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

413

checker_initiator_tag: a gobject event source tag, or None

796

checker_initiator_tag: a GLib event source tag, or None

414

797

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

415

798

client_structure: Object describing what attributes a client has

416

799

and is used for storing the client at exit

417

800

current_checker_command: string; current running checker_command

418

disable_initiator_tag: a gobject event source tag, or None

801

disable_initiator_tag: a GLib event source tag, or None

419

802

enabled: bool()

420

803

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

421

804

uniquely identify the client

426

809

last_checker_status: integer between 0 and 255 reflecting exit

427

810

status of last checker. -1 reflects crashed

428

811

checker, -2 means no checker completed yet.

812

last_checker_signal: The signal which killed the last checker, if

813

last_checker_status is -1

429

814

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

430

815

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

431

816

D-Bus identifiers

436

821

runtime_expansions: Allowed attributes for runtime expansion.

437

822

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

438

823

disabled, or None

824

server_settings: The server_settings dict from main()

439

825

"""

440

826

441

827

runtime_expansions = ("approval_delay", "approval_duration",

442

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

443

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

828

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

829

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

830

"last_approval_request", "last_checked_ok",

444

831

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

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

832

client_defaults = {

833

"timeout": "PT5M",

834

"extended_timeout": "PT15M",

835

"interval": "PT2M",

836

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

837

"host": "",

838

"approval_delay": "PT0S",

839

"approval_duration": "PT1S",

840

"approved_by_default": "True",

841

"enabled": "True",

842

}

843

471

844

@staticmethod

472

845

def config_parser(config):

473

846

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

480

853

for client_name in config.sections():

481

854

section = dict(config.items(client_name))

482

855

client = settings[client_name] = {}

483

856

484

857

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

485

858

# Reformat values from string types to Python types

486

859

client["approved_by_default"] = config.getboolean(

487

860

client_name, "approved_by_default")

488

861

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

489

862

"enabled")

490

863

864

# Uppercase and remove spaces from fingerprint for later

865

# comparison purposes with return value from the

866

# fingerprint() function

491

867

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

492

868

.replace(" ", ""))

493

869

if "secret" in section:

494

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

870

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

871

.encode("utf-8"),

872

"base64")

495

873

elif "secfile" in section:

496

874

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

497

875

(section["secfile"])),

498

876

"rb") as secfile:

499

877

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

500

878

else:

501

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

879

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

502

880

.format(section))

503

881

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

504

882

client["extended_timeout"] = string_to_delta(

512

890

client["last_approval_request"] = None

513

891

client["last_checked_ok"] = None

514

892

client["last_checker_status"] = -2

515

893

516

894

return settings

517

518

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

895

896

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

519

897

self.name = name

898

if server_settings is None:

899

server_settings = {}

900

self.server_settings = server_settings

520

901

# adding all client settings

521

for setting, value in settings.iteritems():

902

for setting, value in settings.items():

522

903

setattr(self, setting, value)

523

904

524

905

if self.enabled:

525

906

if not hasattr(self, "last_enabled"):

526

907

self.last_enabled = datetime.datetime.utcnow()

530

911

else:

531

912

self.last_enabled = None

532

913

self.expires = None

533

914

534

915

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

538

916

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

539

917

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

540

918

datetime.datetime.utcnow())

541

919

542

920

# attributes specific for this server instance

543

921

self.checker = None

544

922

self.checker_initiator_tag = None

547

925

self.current_checker_command = None

548

926

self.approved = None

549

927

self.approvals_pending = 0

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

928

self.changedstate = multiprocessing_manager.Condition(

929

multiprocessing_manager.Lock())

930

self.client_structure = [attr

931

for attr in self.__dict__.keys()

555

932

if not attr.startswith("_")]

556

933

self.client_structure.append("client_structure")

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

934

935

for name, t in inspect.getmembers(

936

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

562

937

if not name.startswith("_"):

563

938

self.client_structure.append(name)

564

939

565

940

# Send notice to process children that client state has changed

566

941

def send_changedstate(self):

567

942

with self.changedstate:

568

943

self.changedstate.notify_all()

569

944

570

945

def enable(self):

571

946

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

572

947

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

577

952

self.last_enabled = datetime.datetime.utcnow()

578

953

self.init_checker()

579

954

self.send_changedstate()

580

955

581

956

def disable(self, quiet=True):

582

957

"""Disable this client."""

583

958

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

585

960

if not quiet:

586

961

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

587

962

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

588

gobject.source_remove(self.disable_initiator_tag)

963

GLib.source_remove(self.disable_initiator_tag)

589

964

self.disable_initiator_tag = None

590

965

self.expires = None

591

966

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

592

gobject.source_remove(self.checker_initiator_tag)

967

GLib.source_remove(self.checker_initiator_tag)

593

968

self.checker_initiator_tag = None

594

969

self.stop_checker()

595

970

self.enabled = False

596

971

if not quiet:

597

972

self.send_changedstate()

598

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

973

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

599

974

return False

600

975

601

976

def __del__(self):

602

977

self.disable()

603

978

604

979

def init_checker(self):

605

980

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

606

981

# and every interval from then on.

607

982

if self.checker_initiator_tag is not None:

608

gobject.source_remove(self.checker_initiator_tag)

609

self.checker_initiator_tag = (gobject.timeout_add

610

(self.interval_milliseconds(),

611

self.start_checker))

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

985

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

986

self.start_checker)

612

987

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

613

988

if self.disable_initiator_tag is not None:

614

gobject.source_remove(self.disable_initiator_tag)

615

self.disable_initiator_tag = (gobject.timeout_add

616

(self.timeout_milliseconds(),

617

self.disable))

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

991

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

618

992

# Also start a new checker *right now*.

619

993

self.start_checker()

620

621

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

994

995

def checker_callback(self, source, condition, connection,

996

command):

622

997

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

623

998

self.checker_callback_tag = None

624

999

self.checker = None

625

if os.WIFEXITED(condition):

626

self.last_checker_status = os.WEXITSTATUS(condition)

1000

# Read return code from connection (see call_pipe)

1001

returncode = connection.recv()

1002

connection.close()

1003

1004

if returncode >= 0:

1005

self.last_checker_status = returncode

1006

self.last_checker_signal = None

627

1007

if self.last_checker_status == 0:

628

1008

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

629

1009

vars(self))

630

1010

self.checked_ok()

631

1011

else:

632

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

633

vars(self))

1012

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

634

1013

else:

635

1014

self.last_checker_status = -1

1015

self.last_checker_signal = -returncode

636

1016

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

637

1017

vars(self))

638

1018

return False

1019

639

1020

def checked_ok(self):

640

1021

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

641

1022

self.last_checked_ok = datetime.datetime.utcnow()

642

1023

self.last_checker_status = 0

1024

self.last_checker_signal = None

643

1025

self.bump_timeout()

644

1026

645

1027

def bump_timeout(self, timeout=None):

646

1028

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

647

1029

if timeout is None:

648

1030

timeout = self.timeout

649

1031

if self.disable_initiator_tag is not None:

650

gobject.source_remove(self.disable_initiator_tag)

1032

GLib.source_remove(self.disable_initiator_tag)

651

1033

self.disable_initiator_tag = None

652

1034

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

653

self.disable_initiator_tag = (gobject.timeout_add

654

(timedelta_to_milliseconds

655

(timeout), self.disable))

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

656

1037

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

657

1038

658

1039

def need_approval(self):

659

1040

self.last_approval_request = datetime.datetime.utcnow()

660

1041

661

1042

def start_checker(self):

662

1043

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

663

1044

664

1045

If a checker already exists, leave it running and do

665

1046

nothing."""

666

1047

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

671

1052

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

672

1053

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

673

1054

# should be.

674

675

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

676

try:

677

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

678

except (AttributeError, OSError) as error:

679

if (isinstance(error, OSError)

680

and error.errno != errno.ECHILD):

681

raise error

682

else:

683

if pid:

684

logger.warning("Checker was a zombie")

685

gobject.source_remove(self.checker_callback_tag)

686

self.checker_callback(pid, status,

687

self.current_checker_command)

1055

1056

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

1057

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

1058

self.checker.join()

1059

self.checker = None

688

1060

# Start a new checker if needed

689

1061

if self.checker is None:

1062

# Escape attributes for the shell

1063

escaped_attrs = {

1064

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

1065

for attr in self.runtime_expansions}

690

1066

try:

691

# In case checker_command has exactly one % operator

692

command = self.checker_command % self.host

693

except TypeError:

694

# Escape attributes for the shell

695

escaped_attrs = dict(

696

(attr,

697

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

698

errors=

699

'replace')))

700

for attr in

701

self.runtime_expansions)

702

703

try:

704

command = self.checker_command % escaped_attrs

705

except TypeError as error:

706

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

707

self.checker_command, exc_info=error)

708

return True # Try again later

1067

command = self.checker_command % escaped_attrs

1068

except TypeError as error:

1069

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

1070

self.checker_command,

1071

exc_info=error)

1072

return True # Try again later

709

1073

self.current_checker_command = command

710

try:

711

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

712

command, self.name)

713

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

714

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

715

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

716

# always replaced by /dev/null.)

717

self.checker = subprocess.Popen(command,

718

close_fds=True,

719

shell=True, cwd="/")

720

self.checker_callback_tag = (gobject.child_watch_add

721

(self.checker.pid,

722

self.checker_callback,

723

data=command))

724

# The checker may have completed before the gobject

725

# watch was added. Check for this.

726

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

727

if pid:

728

gobject.source_remove(self.checker_callback_tag)

729

self.checker_callback(pid, status, command)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

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

1074

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

1075

self.name)

1076

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

1077

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

1078

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

1079

# always replaced by /dev/null.)

1080

# The exception is when not debugging but nevertheless

1081

# running in the foreground; use the previously

1082

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

1086

if (not self.server_settings["debug"]

1087

and self.server_settings["foreground"]):

1088

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

1091

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

1095

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

1098

self.checker_callback, pipe[0], command)

1099

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

734

1100

return True

735

1101

736

1102

def stop_checker(self):

737

1103

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

738

1104

if self.checker_callback_tag:

739

gobject.source_remove(self.checker_callback_tag)

1105

GLib.source_remove(self.checker_callback_tag)

740

1106

self.checker_callback_tag = None

741

1107

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

742

1108

return

743

1109

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

744

try:

745

self.checker.terminate()

746

#time.sleep(0.5)

747

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

748

# self.checker.kill()

749

except OSError as error:

750

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

751

raise

1110

self.checker.terminate()

752

1111

self.checker = None

753

1112

754

1113

755

def dbus_service_property(dbus_interface, signature="v",

756

access="readwrite", byte_arrays=False):

1114

def dbus_service_property(dbus_interface,

1115

signature="v",

1116

access="readwrite",

1117

byte_arrays=False):

757

1118

"""Decorators for marking methods of a DBusObjectWithProperties to

758

1119

become properties on the D-Bus.

759

1120

760

1121

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

761

1122

and with one argument by "Set".

762

1123

763

1124

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

764

1125

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

765

1126

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

768

1129

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

769

1130

if byte_arrays and signature != "ay":

770

1131

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

771

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

1132

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

1133

772

1134

def decorator(func):

773

1135

func._dbus_is_property = True

774

1136

func._dbus_interface = dbus_interface

777

1139

func._dbus_name = func.__name__

778

1140

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

779

1141

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

780

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

781

1143

return func

1144

782

1145

return decorator

783

1146

784

1147

785

1148

def dbus_interface_annotations(dbus_interface):

786

1149

"""Decorator for marking functions returning interface annotations

787

1150

788

1151

Usage:

789

1152

790

1153

@dbus_interface_annotations("org.example.Interface")

791

1154

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

792

1155

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

793

1156

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

794

1157

"false"}

795

1158

"""

1159

796

1160

def decorator(func):

797

1161

func._dbus_is_interface = True

798

1162

func._dbus_interface = dbus_interface

799

1163

func._dbus_name = dbus_interface

800

1164

return func

1165

801

1166

return decorator

802

1167

803

1168

804

1169

def dbus_annotations(annotations):

805

1170

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

806

1171

Usage:

807

1172

1173

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

1174

"org.freedesktop.DBus.Property."

1175

"EmitsChangedSignal": "false"})

808

1176

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

809

1177

access="r")

810

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

811

"org.freedesktop.DBus.Property."

812

"EmitsChangedSignal": "false"})

813

1178

def Property_dbus_property(self):

814

1179

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

815

1182

"""

1183

816

1184

def decorator(func):

817

1185

func._dbus_annotations = annotations

818

1186

return func

1187

819

1188

return decorator

820

1189

821

1190

822

1191

class DBusPropertyException(dbus.exceptions.DBusException):

823

1192

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

824

1193

"""

825

def __unicode__(self):

826

return unicode(str(self))

1194

pass

827

1195

828

1196

829

1197

class DBusPropertyAccessException(DBusPropertyException):

838

1206

pass

839

1207

840

1208

841

class DBusObjectWithProperties(dbus.service.Object):

842

"""A D-Bus object with properties.

843

844

Classes inheriting from this can use the dbus_service_property

845

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

846

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

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

847

1214

"""

848

1215

849

1216

@staticmethod

850

1217

def _is_dbus_thing(thing):

851

1218

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

852

1219

853

1220

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

854

1221

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

855

1222

"""

856

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

1223

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

857

1224

False)

858

1225

859

1226

def _get_all_dbus_things(self, thing):

860

1227

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

861

1228

"""

862

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

863

name),

1229

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

864

1230

athing.__get__(self))

865

1231

for cls in self.__class__.__mro__

866

1232

for name, athing in

867

inspect.getmembers(cls,

868

self._is_dbus_thing(thing)))

869

1233

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

1234

1235

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1236

out_signature="s",

1237

path_keyword='object_path',

1238

connection_keyword='connection')

1239

def Introspect(self, object_path, connection):

1240

"""Overloading of standard D-Bus method.

1241

1242

Inserts annotation tags on methods and signals.

1243

"""

1244

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

1245

connection)

1246

try:

1247

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

1248

1249

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

1250

# Add annotation tags

1251

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

1252

for tag in if_tag.getElementsByTagName(typ):

1253

annots = dict()

1254

for name, prop in (self.

1255

_get_all_dbus_things(typ)):

1256

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

1257

and prop._dbus_interface

1258

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

1259

annots.update(getattr(

1260

prop, "_dbus_annotations", {}))

1261

for name, value in annots.items():

1262

ann_tag = document.createElement(

1263

"annotation")

1264

ann_tag.setAttribute("name", name)

1265

ann_tag.setAttribute("value", value)

1266

tag.appendChild(ann_tag)

1267

# Add interface annotation tags

1268

for annotation, value in dict(

1269

itertools.chain.from_iterable(

1270

annotations().items()

1271

for name, annotations

1272

in self._get_all_dbus_things("interface")

1273

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

1274

)).items():

1275

ann_tag = document.createElement("annotation")

1276

ann_tag.setAttribute("name", annotation)

1277

ann_tag.setAttribute("value", value)

1278

if_tag.appendChild(ann_tag)

1279

# Fix argument name for the Introspect method itself

1280

if (if_tag.getAttribute("name")

1281

== dbus.INTROSPECTABLE_IFACE):

1282

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

1283

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

1284

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

1285

if (arg.getAttribute("direction")

1286

== "out"):

1287

arg.setAttribute("name",

1288

"xml_data")

1289

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

1290

document.unlink()

1291

except (AttributeError, xml.dom.DOMException,

1292

xml.parsers.expat.ExpatError) as error:

1293

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

1294

exc_info=error)

1295

return xmlstring

1296

1297

1298

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1299

"""A D-Bus object with properties.

1300

1301

Classes inheriting from this can use the dbus_service_property

1302

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

1303

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

1304

"""

1305

870

1306

def _get_dbus_property(self, interface_name, property_name):

871

1307

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

872

1308

property with the specified name and interface.

873

1309

"""

874

for cls in self.__class__.__mro__:

875

for name, value in (inspect.getmembers

876

(cls,

877

self._is_dbus_thing("property"))):

1310

for cls in self.__class__.__mro__:

1311

for name, value in inspect.getmembers(

1312

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

878

1313

if (value._dbus_name == property_name

879

1314

and value._dbus_interface == interface_name):

880

1315

return value.__get__(self)

881

1316

882

1317

# No such property

883

raise DBusPropertyNotFound(self.dbus_object_path + ":"

884

+ interface_name + "."

885

+ property_name)

886

887

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

1318

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

1319

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

1330

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

in_signature="ss",

888

1332

out_signature="v")

889

1333

def Get(self, interface_name, property_name):

890

1334

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

896

1340

if not hasattr(value, "variant_level"):

897

1341

return value

898

1342

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

899

1343

900

1344

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

901

1345

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

902

1346

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

908

1352

# The byte_arrays option is not supported yet on

909

1353

# signatures other than "ay".

910

1354

if prop._dbus_signature != "ay":

911

raise ValueError

1355

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

1356

"'ay' signature {!r}"

1357

.format(prop._dbus_signature))

912

1358

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

913

1359

for byte in value))

914

1360

prop(value)

915

916

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

1361

1362

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

in_signature="s",

917

1364

out_signature="a{sv}")

918

1365

def GetAll(self, interface_name):

919

1366

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

920

1367

standard.

921

1368

922

1369

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

923

1370

"""

924

1371

properties = {}

934

1381

if not hasattr(value, "variant_level"):

935

1382

properties[name] = value

936

1383

continue

937

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

938

value.variant_level+1)

1384

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

939

1386

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

940

1387

1388

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

1389

def PropertiesChanged(self, interface_name, changed_properties,

1390

invalidated_properties):

1391

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

1392

standard.

1393

"""

1394

pass

1395

941

1396

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

942

1397

out_signature="s",

943

1398

path_keyword='object_path',

944

1399

connection_keyword='connection')

945

1400

def Introspect(self, object_path, connection):

946

1401

"""Overloading of standard D-Bus method.

947

1402

948

1403

Inserts property tags and interface annotation tags.

949

1404

"""

950

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

951

connection)

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

952

1408

try:

953

1409

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

1410

954

1411

def make_tag(document, name, prop):

955

1412

e = document.createElement("property")

956

1413

e.setAttribute("name", name)

957

1414

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

958

1415

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

959

1416

return e

1417

960

1418

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

961

1419

# Add property tags

962

1420

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

965

1423

if prop._dbus_interface

966

1424

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

967

1425

if_tag.appendChild(tag)

968

# Add annotation tags

969

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

970

for tag in if_tag.getElementsByTagName(typ):

971

annots = dict()

972

for name, prop in (self.

973

_get_all_dbus_things(typ)):

974

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

975

and prop._dbus_interface

976

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

977

annots.update(getattr

978

(prop,

979

"_dbus_annotations",

980

{}))

981

for name, value in annots.iteritems():

982

ann_tag = document.createElement(

983

"annotation")

984

ann_tag.setAttribute("name", name)

985

ann_tag.setAttribute("value", value)

986

tag.appendChild(ann_tag)

987

# Add interface annotation tags

988

for annotation, value in dict(

989

itertools.chain.from_iterable(

990

annotations().iteritems()

991

for name, annotations in

992

self._get_all_dbus_things("interface")

993

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

994

)).iteritems():

995

ann_tag = document.createElement("annotation")

996

ann_tag.setAttribute("name", annotation)

997

ann_tag.setAttribute("value", value)

998

if_tag.appendChild(ann_tag)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

999

1442

# Add the names to the return values for the

1000

1443

# "org.freedesktop.DBus.Properties" methods

1001

1444

if (if_tag.getAttribute("name")

1020

1463

return xmlstring

1021

1464

1022

1465

1023

def datetime_to_dbus (dt, variant_level=0):

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1537

def datetime_to_dbus(dt, variant_level=0):

1024

1538

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

1025

1539

if dt is None:

1026

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

1027

return dbus.String(dt.isoformat(),

1028

variant_level=variant_level)

1540

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

1541

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

1029

1542

1030

1543

1031

1544

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1033

1546

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

1034

1547

interface names according to the "alt_interface_names" mapping.

1035

1548

Usage:

1036

1037

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

1038

"net.example.AlternateInterface"})

1549

1550

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

1551

"net.example.AlternateInterface"})

1039

1552

class SampleDBusObject(dbus.service.Object):

1040

1553

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

1041

1554

def SampleDBusMethod():

1042

1555

pass

1043

1556

1044

1557

The above "SampleDBusMethod" on "SampleDBusObject" will be

1045

1558

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

1046

1559

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

1047

1560

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

1048

1561

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

1049

1562

1050

1563

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

1051

1564

(from DBusObjectWithProperties) and interfaces (from the

1052

1565

dbus_interface_annotations decorator).

1053

1566

"""

1567

1054

1568

def wrapper(cls):

1055

1569

for orig_interface_name, alt_interface_name in (

1056

alt_interface_names.iteritems()):

1570

alt_interface_names.items()):

1057

1571

attr = {}

1058

1572

interface_names = set()

1059

1573

# Go though all attributes of the class

1061

1575

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

1062

1576

# with the wrong interface name

1063

1577

if (not hasattr(attribute, "_dbus_interface")

1064

or not attribute._dbus_interface

1065

.startswith(orig_interface_name)):

1578

or not attribute._dbus_interface.startswith(

1579

orig_interface_name)):

1066

1580

continue

1067

1581

# Create an alternate D-Bus interface name based on

1068

1582

# the current name

1069

alt_interface = (attribute._dbus_interface

1070

.replace(orig_interface_name,

1071

alt_interface_name))

1583

alt_interface = attribute._dbus_interface.replace(

1584

orig_interface_name, alt_interface_name)

1072

1585

interface_names.add(alt_interface)

1073

1586

# Is this a D-Bus signal?

1074

1587

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

1075

# Extract the original non-method function by

1076

# black magic

1077

nonmethod_func = (dict(

1588

# Extract the original non-method undecorated

1589

# function by black magic

1590

if sys.version_info.major == 2:

1591

nonmethod_func = (dict(

1078

1592

zip(attribute.func_code.co_freevars,

1079

attribute.__closure__))["func"]

1080

.cell_contents)

1593

attribute.__closure__))

1594

["func"].cell_contents)

1595

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1081

1600

# Create a new, but exactly alike, function

1082

1601

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

1083

1602

# with the alternate D-Bus interface name

1084

new_function = (dbus.service.signal

1085

(alt_interface,

1086

attribute._dbus_signature)

1087

(types.FunctionType(

1088

nonmethod_func.func_code,

1089

nonmethod_func.func_globals,

1090

nonmethod_func.func_name,

1091

nonmethod_func.func_defaults,

1092

nonmethod_func.func_closure)))

1603

new_function = copy_function(nonmethod_func)

1604

new_function = (dbus.service.signal(

1605

alt_interface,

1606

attribute._dbus_signature)(new_function))

1093

1607

# Copy annotations, if any

1094

1608

try:

1095

new_function._dbus_annotations = (

1096

dict(attribute._dbus_annotations))

1609

new_function._dbus_annotations = dict(

1610

attribute._dbus_annotations)

1097

1611

except AttributeError:

1098

1612

pass

1613

1099

1614

# Define a creator of a function to call both the

1100

1615

# original and alternate functions, so both the

1101

1616

# original and alternate signals gets sent when

1104

1619

"""This function is a scope container to pass

1105

1620

func1 and func2 to the "call_both" function

1106

1621

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1107

1624

def call_both(*args, **kwargs):

1108

1625

"""This function will emit two D-Bus

1109

1626

signals by calling func1 and func2"""

1110

1627

func1(*args, **kwargs)

1111

1628

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1112

1635

return call_both

1113

1636

# Create the "call_both" function and add it to

1114

1637

# the class

1119

1642

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

1120

1643

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

1121

1644

# to the class.

1122

attr[attrname] = (dbus.service.method

1123

(alt_interface,

1124

attribute._dbus_in_signature,

1125

attribute._dbus_out_signature)

1126

(types.FunctionType

1127

(attribute.func_code,

1128

attribute.func_globals,

1129

attribute.func_name,

1130

attribute.func_defaults,

1131

attribute.func_closure)))

1645

attr[attrname] = (

1646

dbus.service.method(

1647

alt_interface,

1648

attribute._dbus_in_signature,

1649

attribute._dbus_out_signature)

1650

(copy_function(attribute)))

1132

1651

# Copy annotations, if any

1133

1652

try:

1134

attr[attrname]._dbus_annotations = (

1135

dict(attribute._dbus_annotations))

1653

attr[attrname]._dbus_annotations = dict(

1654

attribute._dbus_annotations)

1136

1655

except AttributeError:

1137

1656

pass

1138

1657

# Is this a D-Bus property?

1141

1660

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

1142

1661

# property with the alternate D-Bus interface

1143

1662

# name. Add it to the class.

1144

attr[attrname] = (dbus_service_property

1145

(alt_interface,

1146

attribute._dbus_signature,

1147

attribute._dbus_access,

1148

attribute

1149

._dbus_get_args_options

1150

["byte_arrays"])

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1663

attr[attrname] = (dbus_service_property(

1664

alt_interface, attribute._dbus_signature,

1665

attribute._dbus_access,

1666

attribute._dbus_get_args_options

1667

["byte_arrays"])

1668

(copy_function(attribute)))

1157

1669

# Copy annotations, if any

1158

1670

try:

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1671

attr[attrname]._dbus_annotations = dict(

1672

attribute._dbus_annotations)

1161

1673

except AttributeError:

1162

1674

pass

1163

1675

# Is this a D-Bus interface?

1166

1678

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

1167

1679

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

1168

1680

# to the class.

1169

attr[attrname] = (dbus_interface_annotations

1170

(alt_interface)

1171

(types.FunctionType

1172

(attribute.func_code,

1173

attribute.func_globals,

1174

attribute.func_name,

1175

attribute.func_defaults,

1176

attribute.func_closure)))

1681

attr[attrname] = (

1682

dbus_interface_annotations(alt_interface)

1683

(copy_function(attribute)))

1177

1684

if deprecate:

1178

1685

# Deprecate all alternate interfaces

1179

iname="_AlternateDBusNames_interface_annotation{0}"

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1180

1687

for interface_name in interface_names:

1688

1181

1689

@dbus_interface_annotations(interface_name)

1182

1690

def func(self):

1183

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

1184

"true" }

1691

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

1692

"true"}

1185

1693

# Find an unused name

1186

1694

for aname in (iname.format(i)

1187

1695

for i in itertools.count()):

1191

1699

if interface_names:

1192

1700

# Replace the class with a new subclass of it with

1193

1701

# methods, signals, etc. as created above.

1194

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

1195

(cls,), attr)

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1196

1708

return cls

1709

1197

1710

return wrapper

1198

1711

1199

1712

1200

1713

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

1201

"se.bsnet.fukt.Mandos"})

1714

"se.bsnet.fukt.Mandos"})

1202

1715

class ClientDBus(Client, DBusObjectWithProperties):

1203

1716

"""A Client class using D-Bus

1204

1717

1205

1718

Attributes:

1206

1719

dbus_object_path: dbus.ObjectPath

1207

1720

bus: dbus.SystemBus()

1208

1721

"""

1209

1722

1210

1723

runtime_expansions = (Client.runtime_expansions

1211

+ ("dbus_object_path",))

1212

1724

+ ("dbus_object_path", ))

1725

1726

_interface = "se.recompile.Mandos.Client"

1727

1213

1728

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

1214

1215

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

1729

1730

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

1216

1731

self.bus = bus

1217

1732

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

1218

1733

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

1219

1734

# the D-Bus

1220

client_object_name = unicode(self.name).translate(

1735

client_object_name = str(self.name).translate(

1221

1736

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

1222

1737

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

1223

self.dbus_object_path = (dbus.ObjectPath

1224

("/clients/" + client_object_name))

1738

self.dbus_object_path = dbus.ObjectPath(

1739

"/clients/" + client_object_name)

1225

1740

DBusObjectWithProperties.__init__(self, self.bus,

1226

1741

self.dbus_object_path)

1227

1228

def notifychangeproperty(transform_func,

1229

dbus_name, type_func=lambda x: x,

1230

variant_level=1):

1742

1743

def notifychangeproperty(transform_func, dbus_name,

1744

type_func=lambda x: x,

1745

variant_level=1,

1746

invalidate_only=False,

1747

_interface=_interface):

1231

1748

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

1232

1749

its changes to DBus.

1233

1750

1234

1751

transform_fun: Function that takes a value and a variant_level

1235

1752

and transforms it to a D-Bus type.

1236

1753

dbus_name: D-Bus name of the variable

1238

1755

to the D-Bus. Default: no transform

1239

1756

variant_level: D-Bus variant level. Default: 1

1240

1757

"""

1241

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

1758

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

1759

1242

1760

def setter(self, value):

1243

1761

if hasattr(self, "dbus_object_path"):

1244

1762

if (not hasattr(self, attrname) or

1245

1763

type_func(getattr(self, attrname, None))

1246

1764

!= type_func(value)):

1247

dbus_value = transform_func(type_func(value),

1248

variant_level

1249

=variant_level)

1250

self.PropertyChanged(dbus.String(dbus_name),

1251

dbus_value)

1765

if invalidate_only:

1766

self.PropertiesChanged(

1767

_interface, dbus.Dictionary(),

1768

dbus.Array((dbus_name, )))

1769

else:

1770

dbus_value = transform_func(

1771

type_func(value),

1772

variant_level=variant_level)

1773

self.PropertyChanged(dbus.String(dbus_name),

1774

dbus_value)

1775

self.PropertiesChanged(

1776

_interface,

1777

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

1778

dbus_value}),

1779

dbus.Array())

1252

1780

setattr(self, attrname, value)

1253

1781

1254

1782

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

1255

1783

1256

1784

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1257

1785

approvals_pending = notifychangeproperty(dbus.Boolean,

1258

1786

"ApprovalPending",

1259

type_func = bool)

1787

type_func=bool)

1260

1788

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

1261

1789

last_enabled = notifychangeproperty(datetime_to_dbus,

1262

1790

"LastEnabled")

1263

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

1264

type_func = lambda checker:

1265

checker is not None)

1791

checker = notifychangeproperty(

1792

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1266

1794

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1267

1795

"LastCheckedOK")

1268

1796

last_checker_status = notifychangeproperty(dbus.Int16,

1271

1799

datetime_to_dbus, "LastApprovalRequest")

1272

1800

approved_by_default = notifychangeproperty(dbus.Boolean,

1273

1801

"ApprovedByDefault")

1274

approval_delay = notifychangeproperty(dbus.UInt64,

1275

"ApprovalDelay",

1276

type_func =

1277

timedelta_to_milliseconds)

1802

approval_delay = notifychangeproperty(

1803

dbus.UInt64, "ApprovalDelay",

1804

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

1278

1805

approval_duration = notifychangeproperty(

1279

1806

dbus.UInt64, "ApprovalDuration",

1280

type_func = timedelta_to_milliseconds)

1807

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

1281

1808

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

1282

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

1283

type_func =

1284

timedelta_to_milliseconds)

1809

timeout = notifychangeproperty(

1810

dbus.UInt64, "Timeout",

1811

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

1285

1812

extended_timeout = notifychangeproperty(

1286

1813

dbus.UInt64, "ExtendedTimeout",

1287

type_func = timedelta_to_milliseconds)

1288

interval = notifychangeproperty(dbus.UInt64,

1289

"Interval",

1290

type_func =

1291

timedelta_to_milliseconds)

1814

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

1815

interval = notifychangeproperty(

1816

dbus.UInt64, "Interval",

1817

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

1292

1818

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

1293

1819

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

1820

invalidate_only=True)

1821

1294

1822

del notifychangeproperty

1295

1823

1296

1824

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

1297

1825

try:

1298

1826

self.remove_from_connection()

1301

1829

if hasattr(DBusObjectWithProperties, "__del__"):

1302

1830

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

1303

1831

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

1304

1305

def checker_callback(self, pid, condition, command,

1306

*args, **kwargs):

1307

self.checker_callback_tag = None

1308

self.checker = None

1309

if os.WIFEXITED(condition):

1310

exitstatus = os.WEXITSTATUS(condition)

1832

1833

def checker_callback(self, source, condition,

1834

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

1835

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

1836

connection, command, *args,

1837

**kwargs)

1838

exitstatus = self.last_checker_status

1839

if exitstatus >= 0:

1311

1840

# Emit D-Bus signal

1312

1841

self.CheckerCompleted(dbus.Int16(exitstatus),

1313

dbus.Int64(condition),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1314

1844

dbus.String(command))

1315

1845

else:

1316

1846

# Emit D-Bus signal

1317

1847

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

1318

dbus.Int64(condition),

1848

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1319

1852

dbus.String(command))

1320

1321

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

1322

*args, **kwargs)

1323

1853

return ret

1854

1324

1855

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

1325

old_checker = self.checker

1326

if self.checker is not None:

1327

old_checker_pid = self.checker.pid

1328

else:

1329

old_checker_pid = None

1856

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

1330

1857

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

1331

1858

# Only if new checker process was started

1332

1859

if (self.checker is not None

1334

1861

# Emit D-Bus signal

1335

1862

self.CheckerStarted(self.current_checker_command)

1336

1863

return r

1337

1864

1338

1865

def _reset_approved(self):

1339

1866

self.approved = None

1340

1867

return False

1341

1868

1342

1869

def approve(self, value=True):

1343

1870

self.approved = value

1344

gobject.timeout_add(timedelta_to_milliseconds

1345

(self.approval_duration),

1346

self._reset_approved)

1871

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

1872

* 1000), self._reset_approved)

1347

1873

self.send_changedstate()

1348

1349

## D-Bus methods, signals & properties

1350

_interface = "se.recompile.Mandos.Client"

1351

1352

## Interfaces

1353

1354

@dbus_interface_annotations(_interface)

1355

def _foo(self):

1356

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

1357

"false"}

1358

1359

## Signals

1360

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1361

1881

# CheckerCompleted - signal

1362

1882

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

1363

1883

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

1364

1884

"D-Bus signal"

1365

1885

pass

1366

1886

1367

1887

# CheckerStarted - signal

1368

1888

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

1369

1889

def CheckerStarted(self, command):

1370

1890

"D-Bus signal"

1371

1891

pass

1372

1892

1373

1893

# PropertyChanged - signal

1894

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

1374

1895

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

1375

1896

def PropertyChanged(self, property, value):

1376

1897

"D-Bus signal"

1377

1898

pass

1378

1899

1379

1900

# GotSecret - signal

1380

1901

@dbus.service.signal(_interface)

1381

1902

def GotSecret(self):

1384

1905

server to mandos-client

1385

1906

"""

1386

1907

pass

1387

1908

1388

1909

# Rejected - signal

1389

1910

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

1390

1911

def Rejected(self, reason):

1391

1912

"D-Bus signal"

1392

1913

pass

1393

1914

1394

1915

# NeedApproval - signal

1395

1916

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

1396

1917

def NeedApproval(self, timeout, default):

1397

1918

"D-Bus signal"

1398

1919

return self.need_approval()

1399

1400

## Methods

1401

1920

1921

# Methods

1922

1402

1923

# Approve - method

1403

1924

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

1404

1925

def Approve(self, value):

1405

1926

self.approve(value)

1406

1927

1407

1928

# CheckedOK - method

1408

1929

@dbus.service.method(_interface)

1409

1930

def CheckedOK(self):

1410

1931

self.checked_ok()

1411

1932

1412

1933

# Enable - method

1934

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

1413

1935

@dbus.service.method(_interface)

1414

1936

def Enable(self):

1415

1937

"D-Bus method"

1416

1938

self.enable()

1417

1939

1418

1940

# StartChecker - method

1941

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

1419

1942

@dbus.service.method(_interface)

1420

1943

def StartChecker(self):

1421

1944

"D-Bus method"

1422

1945

self.start_checker()

1423

1946

1424

1947

# Disable - method

1948

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

1425

1949

@dbus.service.method(_interface)

1426

1950

def Disable(self):

1427

1951

"D-Bus method"

1428

1952

self.disable()

1429

1953

1430

1954

# StopChecker - method

1955

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

1431

1956

@dbus.service.method(_interface)

1432

1957

def StopChecker(self):

1433

1958

self.stop_checker()

1434

1435

## Properties

1436

1959

1960

# Properties

1961

1437

1962

# ApprovalPending - property

1438

1963

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

1439

1964

def ApprovalPending_dbus_property(self):

1440

1965

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

1441

1966

1442

1967

# ApprovedByDefault - property

1443

@dbus_service_property(_interface, signature="b",

1968

@dbus_service_property(_interface,

1969

signature="b",

1444

1970

access="readwrite")

1445

1971

def ApprovedByDefault_dbus_property(self, value=None):

1446

1972

if value is None: # get

1447

1973

return dbus.Boolean(self.approved_by_default)

1448

1974

self.approved_by_default = bool(value)

1449

1975

1450

1976

# ApprovalDelay - property

1451

@dbus_service_property(_interface, signature="t",

1977

@dbus_service_property(_interface,

1978

signature="t",

1452

1979

access="readwrite")

1453

1980

def ApprovalDelay_dbus_property(self, value=None):

1454

1981

if value is None: # get

1455

return dbus.UInt64(self.approval_delay_milliseconds())

1982

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

1983

* 1000)

1456

1984

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

1457

1985

1458

1986

# ApprovalDuration - property

1459

@dbus_service_property(_interface, signature="t",

1987

@dbus_service_property(_interface,

1988

signature="t",

1460

1989

access="readwrite")

1461

1990

def ApprovalDuration_dbus_property(self, value=None):

1462

1991

if value is None: # get

1463

return dbus.UInt64(timedelta_to_milliseconds(

1464

self.approval_duration))

1992

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

1993

* 1000)

1465

1994

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

1466

1995

1467

1996

# Name - property

1997

@dbus_annotations(

1998

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

1468

1999

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

1469

2000

def Name_dbus_property(self):

1470

2001

return dbus.String(self.name)

1471

2002

1472

2003

# Fingerprint - property

2004

@dbus_annotations(

2005

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

1473

2006

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

1474

2007

def Fingerprint_dbus_property(self):

1475

2008

return dbus.String(self.fingerprint)

1476

2009

1477

2010

# Host - property

1478

@dbus_service_property(_interface, signature="s",

2011

@dbus_service_property(_interface,

2012

signature="s",

1479

2013

access="readwrite")

1480

2014

def Host_dbus_property(self, value=None):

1481

2015

if value is None: # get

1482

2016

return dbus.String(self.host)

1483

self.host = unicode(value)

1484

2017

self.host = str(value)

2018

1485

2019

# Created - property

2020

@dbus_annotations(

2021

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

1486

2022

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

1487

2023

def Created_dbus_property(self):

1488

2024

return datetime_to_dbus(self.created)

1489

2025

1490

2026

# LastEnabled - property

1491

2027

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

1492

2028

def LastEnabled_dbus_property(self):

1493

2029

return datetime_to_dbus(self.last_enabled)

1494

2030

1495

2031

# Enabled - property

1496

@dbus_service_property(_interface, signature="b",

2032

@dbus_service_property(_interface,

2033

signature="b",

1497

2034

access="readwrite")

1498

2035

def Enabled_dbus_property(self, value=None):

1499

2036

if value is None: # get

1502

2039

self.enable()

1503

2040

else:

1504

2041

self.disable()

1505

2042

1506

2043

# LastCheckedOK - property

1507

@dbus_service_property(_interface, signature="s",

2044

@dbus_service_property(_interface,

2045

signature="s",

1508

2046

access="readwrite")

1509

2047

def LastCheckedOK_dbus_property(self, value=None):

1510

2048

if value is not None:

1511

2049

self.checked_ok()

1512

2050

return

1513

2051

return datetime_to_dbus(self.last_checked_ok)

1514

2052

1515

2053

# LastCheckerStatus - property

1516

@dbus_service_property(_interface, signature="n",

1517

access="read")

2054

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

1518

2055

def LastCheckerStatus_dbus_property(self):

1519

2056

return dbus.Int16(self.last_checker_status)

1520

2057

1521

2058

# Expires - property

1522

2059

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

1523

2060

def Expires_dbus_property(self):

1524

2061

return datetime_to_dbus(self.expires)

1525

2062

1526

2063

# LastApprovalRequest - property

1527

2064

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

1528

2065

def LastApprovalRequest_dbus_property(self):

1529

2066

return datetime_to_dbus(self.last_approval_request)

1530

2067

1531

2068

# Timeout - property

1532

@dbus_service_property(_interface, signature="t",

2069

@dbus_service_property(_interface,

2070

signature="t",

1533

2071

access="readwrite")

1534

2072

def Timeout_dbus_property(self, value=None):

1535

2073

if value is None: # get

1536

return dbus.UInt64(self.timeout_milliseconds())

2074

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

1537

2075

old_timeout = self.timeout

1538

2076

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

1539

2077

# Reschedule disabling

1547

2085

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

1548

2086

is None):

1549

2087

return

1550

gobject.source_remove(self.disable_initiator_tag)

1551

self.disable_initiator_tag = (

1552

gobject.timeout_add(

1553

timedelta_to_milliseconds(self.expires - now),

1554

self.disable))

1555

2088

GLib.source_remove(self.disable_initiator_tag)

2089

self.disable_initiator_tag = GLib.timeout_add(

2090

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

2091

self.disable)

2092

1556

2093

# ExtendedTimeout - property

1557

@dbus_service_property(_interface, signature="t",

2094

@dbus_service_property(_interface,

2095

signature="t",

1558

2096

access="readwrite")

1559

2097

def ExtendedTimeout_dbus_property(self, value=None):

1560

2098

if value is None: # get

1561

return dbus.UInt64(self.extended_timeout_milliseconds())

2099

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

2100

* 1000)

1562

2101

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

1563

2102

1564

2103

# Interval - property

1565

@dbus_service_property(_interface, signature="t",

2104

@dbus_service_property(_interface,

2105

signature="t",

1566

2106

access="readwrite")

1567

2107

def Interval_dbus_property(self, value=None):

1568

2108

if value is None: # get

1569

return dbus.UInt64(self.interval_milliseconds())

2109

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

1570

2110

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

1571

2111

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

1572

2112

return

1573

2113

if self.enabled:

1574

2114

# Reschedule checker run

1575

gobject.source_remove(self.checker_initiator_tag)

1576

self.checker_initiator_tag = (gobject.timeout_add

1577

(value, self.start_checker))

1578

self.start_checker() # Start one now, too

1579

2115

GLib.source_remove(self.checker_initiator_tag)

2116

self.checker_initiator_tag = GLib.timeout_add(

2117

value, self.start_checker)

2118

self.start_checker() # Start one now, too

2119

1580

2120

# Checker - property

1581

@dbus_service_property(_interface, signature="s",

2121

@dbus_service_property(_interface,

2122

signature="s",

1582

2123

access="readwrite")

1583

2124

def Checker_dbus_property(self, value=None):

1584

2125

if value is None: # get

1585

2126

return dbus.String(self.checker_command)

1586

self.checker_command = unicode(value)

1587

2127

self.checker_command = str(value)

2128

1588

2129

# CheckerRunning - property

1589

@dbus_service_property(_interface, signature="b",

2130

@dbus_service_property(_interface,

2131

signature="b",

1590

2132

access="readwrite")

1591

2133

def CheckerRunning_dbus_property(self, value=None):

1592

2134

if value is None: # get

1595

2137

self.start_checker()

1596

2138

else:

1597

2139

self.stop_checker()

1598

2140

1599

2141

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

1600

2145

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

1601

2146

def ObjectPath_dbus_property(self):

1602

return self.dbus_object_path # is already a dbus.ObjectPath

1603

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1604

2149

# Secret = property

1605

@dbus_service_property(_interface, signature="ay",

1606

access="write", byte_arrays=True)

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

@dbus_service_property(_interface,

2154

signature="ay",

2155

access="write",

2156

byte_arrays=True)

1607

2157

def Secret_dbus_property(self, value):

1608

self.secret = str(value)

1609

2158

self.secret = bytes(value)

2159

1610

2160

del _interface

1611

2161

1612

2162

1615

2165

self._pipe = child_pipe

1616

2166

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

1617

2167

if not self._pipe.recv():

1618

raise KeyError()

1619

2168

raise KeyError(fpr)

2169

1620

2170

def __getattribute__(self, name):

1621

2171

if name == '_pipe':

1622

2172

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

1625

2175

if data[0] == 'data':

1626

2176

return data[1]

1627

2177

if data[0] == 'function':

2178

1628

2179

def func(*args, **kwargs):

1629

2180

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

1630

2181

return self._pipe.recv()[1]

2182

1631

2183

return func

1632

2184

1633

2185

def __setattr__(self, name, value):

1634

2186

if name == '_pipe':

1635

2187

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

1638

2190

1639

2191

class ClientHandler(socketserver.BaseRequestHandler, object):

1640

2192

"""A class to handle client connections.

1641

2193

1642

2194

Instantiated once for each connection to handle it.

1643

2195

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

1644

2196

1645

2197

def handle(self):

1646

2198

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

1647

2199

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

1648

unicode(self.client_address))

2200

str(self.client_address))

1649

2201

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

1650

2202

self.server.child_pipe.fileno())

1651

1652

session = (gnutls.connection

1653

.ClientSession(self.request,

1654

gnutls.connection

1655

.X509Credentials()))

1656

1657

# Note: gnutls.connection.X509Credentials is really a

1658

# generic GnuTLS certificate credentials object so long as

1659

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

1660

# here despite using OpenPGP certificates.

1661

1662

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

1663

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

1664

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

1665

# "+DHE-DSS"))

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

1666

2210

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

1667

2211

priority = self.server.gnutls_priority

1668

2212

if priority is None:

1669

2213

priority = "NORMAL"

1670

(gnutls.library.functions

1671

.gnutls_priority_set_direct(session._c_object,

1672

priority, None))

1673

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1674

2218

# Start communication using the Mandos protocol

1675

2219

# Get protocol number

1676

2220

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

1677

2221

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

1678

2222

try:

1679

2223

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

1680

raise RuntimeError

2224

raise RuntimeError(line)

1681

2225

except (ValueError, IndexError, RuntimeError) as error:

1682

2226

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

1683

2227

return

1684

2228

1685

2229

# Start GnuTLS connection

1686

2230

try:

1687

2231

session.handshake()

1688

except gnutls.errors.GNUTLSError as error:

2232

except gnutls.Error as error:

1689

2233

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

1690

2234

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

1691

2235

# established. Just abandon the request.

1692

2236

return

1693

2237

logger.debug("Handshake succeeded")

1694

2238

1695

2239

approval_required = False

1696

2240

try:

1697

2241

try:

1698

fpr = self.fingerprint(self.peer_certificate

1699

(session))

1700

except (TypeError,

1701

gnutls.errors.GNUTLSError) as error:

2242

fpr = self.fingerprint(

2243

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1702

2245

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

1703

2246

return

1704

2247

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

1705

2248

1706

2249

try:

1707

2250

client = ProxyClient(child_pipe, fpr,

1708

2251

self.client_address)

1709

2252

except KeyError:

1710

2253

return

1711

2254

1712

2255

if client.approval_delay:

1713

2256

delay = client.approval_delay

1714

2257

client.approvals_pending += 1

1715

2258

approval_required = True

1716

2259

1717

2260

while True:

1718

2261

if not client.enabled:

1719

2262

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

1720

client.name)

2263

client.name)

1721

2264

if self.server.use_dbus:

1722

2265

# Emit D-Bus signal

1723

2266

client.Rejected("Disabled")

1724

2267

return

1725

2268

1726

2269

if client.approved or not client.approval_delay:

1727

#We are approved or approval is disabled

2270

# We are approved or approval is disabled

1728

2271

break

1729

2272

elif client.approved is None:

1730

2273

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

1732

2275

if self.server.use_dbus:

1733

2276

# Emit D-Bus signal

1734

2277

client.NeedApproval(

1735

client.approval_delay_milliseconds(),

1736

client.approved_by_default)

2278

client.approval_delay.total_seconds()

2279

* 1000, client.approved_by_default)

1737

2280

else:

1738

2281

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

1739

2282

client.name)

1741

2284

# Emit D-Bus signal

1742

2285

client.Rejected("Denied")

1743

2286

return

1744

1745

#wait until timeout or approved

2287

2288

# wait until timeout or approved

1746

2289

time = datetime.datetime.now()

1747

2290

client.changedstate.acquire()

1748

client.changedstate.wait(

1749

float(timedelta_to_milliseconds(delay)

1750

/ 1000))

2291

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

1751

2292

client.changedstate.release()

1752

2293

time2 = datetime.datetime.now()

1753

2294

if (time2 - time) >= delay:

1763

2304

break

1764

2305

else:

1765

2306

delay -= time2 - time

1766

1767

sent_size = 0

1768

while sent_size < len(client.secret):

1769

try:

1770

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

1771

except gnutls.errors.GNUTLSError as error:

1772

logger.warning("gnutls send failed",

1773

exc_info=error)

1774

return

1775

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

1776

sent, len(client.secret)

1777

- (sent_size + sent))

1778

sent_size += sent

1779

2307

2308

try:

2309

session.send(client.secret)

2310

except gnutls.Error as error:

2311

logger.warning("gnutls send failed",

2312

exc_info=error)

2313

return

2314

1780

2315

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

1781

2316

# bump the timeout using extended_timeout

1782

2317

client.bump_timeout(client.extended_timeout)

1783

2318

if self.server.use_dbus:

1784

2319

# Emit D-Bus signal

1785

2320

client.GotSecret()

1786

2321

1787

2322

finally:

1788

2323

if approval_required:

1789

2324

client.approvals_pending -= 1

1790

2325

try:

1791

2326

session.bye()

1792

except gnutls.errors.GNUTLSError as error:

2327

except gnutls.Error as error:

1793

2328

logger.warning("GnuTLS bye failed",

1794

2329

exc_info=error)

1795

2330

1796

2331

@staticmethod

1797

2332

def peer_certificate(session):

1798

2333

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

1799

2334

# If not an OpenPGP certificate...

1800

if (gnutls.library.functions

1801

.gnutls_certificate_type_get(session._c_object)

1802

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1803

# ...do the normal thing

1804

return session.peer_certificate

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

return b""

1805

2339

list_size = ctypes.c_uint(1)

1806

cert_list = (gnutls.library.functions

1807

.gnutls_certificate_get_peers

2340

cert_list = (gnutls.certificate_get_peers

1808

2341

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

1809

2342

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

1810

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

1811

" certificate")

2343

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

1812

2344

if list_size.value == 0:

1813

2345

return None

1814

2346

cert = cert_list[0]

1815

2347

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

1816

2348

1817

2349

@staticmethod

1818

2350

def fingerprint(openpgp):

1819

2351

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1820

2352

# New GnuTLS "datum" with the OpenPGP public key

1821

datum = (gnutls.library.types

1822

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

1823

ctypes.POINTER

1824

(ctypes.c_ubyte)),

1825

ctypes.c_uint(len(openpgp))))

2353

datum = gnutls.datum_t(

2354

ctypes.cast(ctypes.c_char_p(openpgp),

2355

ctypes.POINTER(ctypes.c_ubyte)),

2356

ctypes.c_uint(len(openpgp)))

1826

2357

# New empty GnuTLS certificate

1827

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1828

(gnutls.library.functions

1829

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2358

crt = gnutls.openpgp_crt_t()

2359

gnutls.openpgp_crt_init(ctypes.byref(crt))

1830

2360

# Import the OpenPGP public key into the certificate

1831

(gnutls.library.functions

1832

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

1833

gnutls.library.constants

1834

.GNUTLS_OPENPGP_FMT_RAW))

2361

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

2362

gnutls.OPENPGP_FMT_RAW)

1835

2363

# Verify the self signature in the key

1836

2364

crtverify = ctypes.c_uint()

1837

(gnutls.library.functions

1838

.gnutls_openpgp_crt_verify_self(crt, 0,

1839

ctypes.byref(crtverify)))

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1840

2367

if crtverify.value != 0:

1841

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1842

raise (gnutls.errors.CertificateSecurityError

1843

("Verify failed"))

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

1844

2370

# New buffer for the fingerprint

1845

2371

buf = ctypes.create_string_buffer(20)

1846

2372

buf_len = ctypes.c_size_t()

1847

2373

# Get the fingerprint from the certificate into the buffer

1848

(gnutls.library.functions

1849

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

1850

ctypes.byref(buf_len)))

2374

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

2375

ctypes.byref(buf_len))

1851

2376

# Deinit the certificate

1852

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1853

2378

# Convert the buffer to a Python bytestring

1854

2379

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

1855

2380

# Convert the bytestring to hexadecimal notation

1859

2384

1860

2385

class MultiprocessingMixIn(object):

1861

2386

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

2387

1862

2388

def sub_process_main(self, request, address):

1863

2389

try:

1864

2390

self.finish_request(request, address)

1865

2391

except Exception:

1866

2392

self.handle_error(request, address)

1867

2393

self.close_request(request)

1868

2394

1869

2395

def process_request(self, request, address):

1870

2396

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

1871

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

1872

args = (request, address))

2397

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

2398

args=(request, address))

1873

2399

proc.start()

1874

2400

return proc

1875

2401

1876

2402

1877

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1878

2404

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

2405

1879

2406

def process_request(self, request, client_address):

1880

2407

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

1881

2408

1882

2409

This function creates a new pipe in self.pipe

1883

2410

"""

1884

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1885

2412

1886

2413

proc = MultiprocessingMixIn.process_request(self, request,

1887

2414

client_address)

1888

2415

self.child_pipe.close()

1889

2416

self.add_pipe(parent_pipe, proc)

1890

2417

1891

2418

def add_pipe(self, parent_pipe, proc):

1892

2419

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

1893

raise NotImplementedError

2420

raise NotImplementedError()

1894

2421

1895

2422

1896

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1897

2424

socketserver.TCPServer, object):

1898

2425

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

1899

2426

1900

2427

Attributes:

1901

2428

enabled: Boolean; whether this server is activated yet

1902

2429

interface: None or a network interface name (string)

1903

2430

use_ipv6: Boolean; to use IPv6 or not

1904

2431

"""

2432

1905

2433

def __init__(self, server_address, RequestHandlerClass,

1906

interface=None, use_ipv6=True):

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

2437

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

2438

creating a new one with socket.socket().

2439

"""

1907

2440

self.interface = interface

1908

2441

if use_ipv6:

1909

2442

self.address_family = socket.AF_INET6

2443

if socketfd is not None:

2444

# Save the file descriptor

2445

self.socketfd = socketfd

2446

# Save the original socket.socket() function

2447

self.socket_socket = socket.socket

2448

2449

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

2450

#

2451

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

2452

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

2453

# patching socket.socket.)

2454

#

2455

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

2456

@functools.wraps(socket.socket)

2457

def socket_wrapper(*args, **kwargs):

2458

# Restore original function so subsequent calls are

2459

# not affected.

2460

socket.socket = self.socket_socket

2461

del self.socket_socket

2462

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

2463

# saved file descriptor.

2464

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

2465

# Replace socket.socket() function with wrapper

2466

socket.socket = socket_wrapper

2467

# The socketserver.TCPServer.__init__ will call

2468

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

2469

# socket_wrapper(), if socketfd was set.

1910

2470

socketserver.TCPServer.__init__(self, server_address,

1911

2471

RequestHandlerClass)

2472

1912

2473

def server_bind(self):

1913

2474

"""This overrides the normal server_bind() function

1914

2475

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

1915

2476

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

2477

global SO_BINDTODEVICE

1916

2478

if self.interface is not None:

1917

2479

if SO_BINDTODEVICE is None:

1918

logger.error("SO_BINDTODEVICE does not exist;"

1919

" cannot bind to interface %s",

1920

self.interface)

1921

else:

1922

try:

1923

self.socket.setsockopt(socket.SOL_SOCKET,

1924

SO_BINDTODEVICE,

1925

str(self.interface

1926

+ '\0'))

1927

except socket.error as error:

1928

if error[0] == errno.EPERM:

1929

logger.error("No permission to"

1930

" bind to interface %s",

1931

self.interface)

1932

elif error[0] == errno.ENOPROTOOPT:

1933

logger.error("SO_BINDTODEVICE not available;"

1934

" cannot bind to interface %s",

1935

self.interface)

1936

else:

1937

raise

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

1938

2501

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

1939

2502

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

1940

2503

if not self.server_address[0]:

1941

2504

if self.address_family == socket.AF_INET6:

1942

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

1943

2506

else:

1944

any_address = socket.INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

1945

2508

self.server_address = (any_address,

1946

2509

self.server_address[1])

1947

2510

elif not self.server_address[1]:

1948

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

1949

0)

2511

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

1950

2512

# if self.interface:

1951

2513

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

1952

2514

# 0, # port

1958

2520

1959

2521

class MandosServer(IPv6_TCPServer):

1960

2522

"""Mandos server.

1961

2523

1962

2524

Attributes:

1963

2525

clients: set of Client objects

1964

2526

gnutls_priority GnuTLS priority string

1965

2527

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

1966

1967

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

1968

2530

"""

2531

1969

2532

def __init__(self, server_address, RequestHandlerClass,

1970

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

1971

gnutls_priority=None, use_dbus=True):

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

1972

2539

self.enabled = False

1973

2540

self.clients = clients

1974

2541

if self.clients is None:

1977

2544

self.gnutls_priority = gnutls_priority

1978

2545

IPv6_TCPServer.__init__(self, server_address,

1979

2546

RequestHandlerClass,

1980

interface = interface,

1981

use_ipv6 = use_ipv6)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

1982

2551

def server_activate(self):

1983

2552

if self.enabled:

1984

2553

return socketserver.TCPServer.server_activate(self)

1985

2554

1986

2555

def enable(self):

1987

2556

self.enabled = True

1988

2557

1989

2558

def add_pipe(self, parent_pipe, proc):

1990

2559

# Call "handle_ipc" for both data and EOF events

1991

gobject.io_add_watch(parent_pipe.fileno(),

1992

gobject.IO_IN | gobject.IO_HUP,

1993

functools.partial(self.handle_ipc,

1994

parent_pipe =

1995

parent_pipe,

1996

proc = proc))

1997

1998

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

1999

proc = None, client_object=None):

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

2000

2571

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

2001

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

2572

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

2002

2573

# Wait for other process to exit

2003

2574

proc.join()

2004

2575

return False

2005

2576

2006

2577

# Read a request from the child

2007

2578

request = parent_pipe.recv()

2008

2579

command = request[0]

2009

2580

2010

2581

if command == 'init':

2011

fpr = request[1]

2582

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

2012

2583

address = request[2]

2013

2014

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2015

2586

if c.fingerprint == fpr:

2016

2587

client = c

2017

2588

break

2024

2595

address[0])

2025

2596

parent_pipe.send(False)

2026

2597

return False

2027

2028

gobject.io_add_watch(parent_pipe.fileno(),

2029

gobject.IO_IN | gobject.IO_HUP,

2030

functools.partial(self.handle_ipc,

2031

parent_pipe =

2032

parent_pipe,

2033

proc = proc,

2034

client_object =

2035

client))

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2036

2606

parent_pipe.send(True)

2037

2607

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

2038

2608

# same fileno

2041

2611

funcname = request[1]

2042

2612

args = request[2]

2043

2613

kwargs = request[3]

2044

2614

2045

2615

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

2046

2616

funcname)(*args,

2047

**kwargs)))

2048

2617

**kwargs)))

2618

2049

2619

if command == 'getattr':

2050

2620

attrname = request[1]

2051

if callable(client_object.__getattribute__(attrname)):

2052

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2053

2624

else:

2054

parent_pipe.send(('data', client_object

2055

.__getattribute__(attrname)))

2056

2625

parent_pipe.send((

2626

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

2627

2057

2628

if command == 'setattr':

2058

2629

attrname = request[1]

2059

2630

value = request[2]

2060

2631

setattr(client_object, attrname, value)

2061

2632

2062

2633

return True

2063

2634

2064

2635

2636

def rfc3339_duration_to_delta(duration):

2637

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

2638

2639

>>> rfc3339_duration_to_delta("P7D")

2640

datetime.timedelta(7)

2641

>>> rfc3339_duration_to_delta("PT60S")

2642

datetime.timedelta(0, 60)

2643

>>> rfc3339_duration_to_delta("PT60M")

2644

datetime.timedelta(0, 3600)

2645

>>> rfc3339_duration_to_delta("PT24H")

2646

datetime.timedelta(1)

2647

>>> rfc3339_duration_to_delta("P1W")

2648

datetime.timedelta(7)

2649

>>> rfc3339_duration_to_delta("PT5M30S")

2650

datetime.timedelta(0, 330)

2651

>>> rfc3339_duration_to_delta("P1DT3M20S")

2652

datetime.timedelta(1, 200)

2653

"""

2654

2655

# Parsing an RFC 3339 duration with regular expressions is not

2656

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

2657

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

2658

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

2659

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

2660

# avoid excessive use of external libraries.

2661

2662

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

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

2668

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

2669

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

2670

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

2671

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

2672

datetime.timedelta(seconds=1),

2673

frozenset((token_end, )))

2674

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

2675

datetime.timedelta(minutes=1),

2676

frozenset((token_second, token_end)))

2677

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

2678

datetime.timedelta(hours=1),

2679

frozenset((token_minute, token_end)))

2680

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

2681

None,

2682

frozenset((token_hour, token_minute,

2683

token_second)))

2684

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

2685

datetime.timedelta(days=1),

2686

frozenset((token_time, token_end)))

2687

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

2688

datetime.timedelta(weeks=4),

2689

frozenset((token_day, token_end)))

2690

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

2691

datetime.timedelta(weeks=52),

2692

frozenset((token_month, token_end)))

2693

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

2694

datetime.timedelta(weeks=1),

2695

frozenset((token_end, )))

2696

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

2697

frozenset((token_year, token_month,

2698

token_day, token_time,

2699

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2703

found_token = None

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2708

# Loop until end token is found

2709

while found_token is not token_end:

2710

# Search for any currently valid tokens

2711

for token in followers:

2712

match = token.regexp.match(s)

2713

if match is not None:

2714

# Token found

2715

if token.value is not None:

2716

# Value found, parse digits

2717

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

2718

# Add to value so far

2719

value += factor * token.value

2720

# Strip token from string

2721

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

2722

# Go to found token

2723

found_token = token

2724

# Set valid next tokens

2725

followers = found_token.followers

2726

break

2727

else:

2728

# No currently valid tokens were found

2729

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

2730

.format(duration))

2731

# End token found

2732

return value

2733

2734

2065

2735

def string_to_delta(interval):

2066

2736

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

2067

2737

2068

2738

>>> string_to_delta('7d')

2069

2739

datetime.timedelta(7)

2070

2740

>>> string_to_delta('60s')

2078

2748

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

2079

2749

datetime.timedelta(0, 330)

2080

2750

"""

2751

2752

try:

2753

return rfc3339_duration_to_delta(interval)

2754

except ValueError:

2755

pass

2756

2081

2757

timevalue = datetime.timedelta(0)

2082

2758

for s in interval.split():

2083

2759

try:

2084

suffix = unicode(s[-1])

2760

suffix = s[-1]

2085

2761

value = int(s[:-1])

2086

2762

if suffix == "d":

2087

2763

delta = datetime.timedelta(value)

2094

2770

elif suffix == "w":

2095

2771

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

2096

2772

else:

2097

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

2098

.format(suffix))

2099

except (ValueError, IndexError) as e:

2773

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

2774

except IndexError as e:

2100

2775

raise ValueError(*(e.args))

2101

2776

timevalue += delta

2102

2777

return timevalue

2103

2778

2104

2779

2105

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

2780

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

2106

2781

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

2107

2782

2108

2783

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

2109

2784

if os.fork():

2110

2785

sys.exit()

2118

2793

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

2119

2794

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

2120

2795

raise OSError(errno.ENODEV,

2121

"{0} not a character device"

2796

"{} not a character device"

2122

2797

.format(os.devnull))

2123

2798

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

2124

2799

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

2128

2803

2129

2804

2130

2805

def main():

2131

2806

2132

2807

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

2133

2808

# Parsing of options, both command line and config file

2134

2809

2135

2810

parser = argparse.ArgumentParser()

2136

2811

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

2137

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

2812

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

2138

2813

help="show version number and exit")

2139

2814

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

2140

2815

help="Bind to interface IF")

2146

2821

help="Run self-test")

2147

2822

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

2148

2823

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

2149

" to terminal")

2824

" to terminal", default=None)

2150

2825

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

2151

2826

help="Debug level for stdout output")

2152

2827

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

2159

2834

" files")

2160

2835

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

2161

2836

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

2162

" system bus interface")

2837

" system bus interface", default=None)

2163

2838

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

2164

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

2839

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

2840

default=None)

2165

2841

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

2166

2842

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

2167

" state")

2843

" state", default=None)

2844

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

2845

help="Specify a file descriptor to a network"

2846

" socket to use instead of creating one")

2168

2847

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

2169

2848

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

2170

2849

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

2850

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

2851

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

2852

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

2853

default=None)

2854

2171

2855

options = parser.parse_args()

2172

2856

2173

2857

if options.check:

2174

2858

import doctest

2175

doctest.testmod()

2176

sys.exit()

2177

2859

fail_count, test_count = doctest.testmod()

2860

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

2861

2178

2862

# Default values for config file for server-global settings

2179

server_defaults = { "interface": "",

2180

"address": "",

2181

"port": "",

2182

"debug": "False",

2183

"priority":

2184

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

2185

"servicename": "Mandos",

2186

"use_dbus": "True",

2187

"use_ipv6": "True",

2188

"debuglevel": "",

2189

"restore": "True",

2190

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

2191

}

2192

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2193

2881

# Parse config file for server-global settings

2194

2882

server_config = configparser.SafeConfigParser(server_defaults)

2195

2883

del server_defaults

2196

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

2197

"mandos.conf"))

2884

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

2198

2885

# Convert the SafeConfigParser object to a dict

2199

2886

server_settings = server_config.defaults()

2200

2887

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

2201

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

2888

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

2889

"foreground", "zeroconf"):

2202

2890

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

2203

2891

option)

2204

2892

if server_settings["port"]:

2205

2893

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

2206

2894

"port")

2895

if server_settings["socket"]:

2896

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

2897

"socket")

2898

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

2899

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

2900

# happen with a supplied network socket.

2901

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

2902

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

2903

["socket"])

2207

2904

del server_config

2208

2905

2209

2906

# Override the settings from the config file with command line

2210

2907

# options, if set.

2211

2908

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

2212

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

2213

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

2214

"statedir"):

2909

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

2910

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

2911

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

2215

2912

value = getattr(options, option)

2216

2913

if value is not None:

2217

2914

server_settings[option] = value

2218

2915

del options

2219

2916

# Force all strings to be unicode

2220

2917

for option in server_settings.keys():

2221

if type(server_settings[option]) is str:

2222

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

2918

if isinstance(server_settings[option], bytes):

2919

server_settings[option] = (server_settings[option]

2920

.decode("utf-8"))

2921

# Force all boolean options to be boolean

2922

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

2923

"foreground", "zeroconf"):

2924

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

2925

# Debug implies foreground

2926

if server_settings["debug"]:

2927

server_settings["foreground"] = True

2223

2928

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

2224

2929

2225

2930

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

2226

2931

2932

if (not server_settings["zeroconf"]

2933

and not (server_settings["port"]

2934

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

2935

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

2936

2227

2937

# For convenience

2228

2938

debug = server_settings["debug"]

2229

2939

debuglevel = server_settings["debuglevel"]

2231

2941

use_ipv6 = server_settings["use_ipv6"]

2232

2942

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

2233

2943

stored_state_file)

2234

2944

foreground = server_settings["foreground"]

2945

zeroconf = server_settings["zeroconf"]

2946

2235

2947

if debug:

2236

2948

initlogger(debug, logging.DEBUG)

2237

2949

else:

2240

2952

else:

2241

2953

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

2242

2954

initlogger(debug, level)

2243

2955

2244

2956

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

2245

syslogger.setFormatter(logging.Formatter

2246

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

2247

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

2248

.format(server_settings

2249

["servicename"])))

2250

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2251

2962

# Parse config file with clients

2252

2963

client_config = configparser.SafeConfigParser(Client

2253

2964

.client_defaults)

2254

2965

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

2255

2966

"clients.conf"))

2256

2967

2257

2968

global mandos_dbus_service

2258

2969

mandos_dbus_service = None

2259

2260

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

2261

server_settings["port"]),

2262

ClientHandler,

2263

interface=(server_settings["interface"]

2264

or None),

2265

use_ipv6=use_ipv6,

2266

gnutls_priority=

2267

server_settings["priority"],

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

2970

2971

socketfd = None

2972

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

2973

socketfd = server_settings["socket"]

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2982

if not foreground:

2983

pidfilename = "/run/mandos.pid"

2984

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

2985

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

2986

pidfile = None

2271

2987

try:

2272

pidfile = open(pidfilename, "w")

2988

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

2273

2989

except IOError as e:

2274

2990

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

2275

2991

exc_info=e)

2276

2277

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2278

2996

try:

2279

2997

uid = pwd.getpwnam(name).pw_uid

2280

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2281

2999

break

2282

3000

except KeyError:

2283

3001

continue

2287

3005

try:

2288

3006

os.setgid(gid)

2289

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2290

3011

except OSError as error:

2291

if error[0] != errno.EPERM:

2292

raise error

2293

3012

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

3013

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

3014

if error.errno != errno.EPERM:

3015

raise

3016

2294

3017

if debug:

2295

3018

# Enable all possible GnuTLS debugging

2296

3019

2297

3020

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

2298

3021

# - GnuTLS manual

2299

gnutls.library.functions.gnutls_global_set_log_level(11)

2300

2301

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2302

3025

def debug_gnutls(level, string):

2303

3026

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

2304

2305

(gnutls.library.functions

2306

.gnutls_global_set_log_function(debug_gnutls))

2307

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2308

3030

# Redirect stdin so all checkers get /dev/null

2309

3031

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

2310

3032

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

2311

3033

if null > 2:

2312

3034

os.close(null)

2313

3035

2314

3036

# Need to fork before connecting to D-Bus

2315

if not debug:

3037

if not foreground:

2316

3038

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

2317

3039

daemon()

2318

2319

gobject.threads_init()

2320

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2321

3045

global main_loop

2322

3046

# From the Avahi example code

2323

3047

DBusGMainLoop(set_as_default=True)

2324

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2325

3049

bus = dbus.SystemBus()

2326

3050

# End of Avahi example code

2327

3051

if use_dbus:

2328

3052

try:

2329

3053

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

2330

bus, do_not_queue=True)

2331

old_bus_name = (dbus.service.BusName

2332

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

2333

do_not_queue=True))

2334

except dbus.exceptions.NameExistsException as e:

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2335

3060

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

2336

3061

use_dbus = False

2337

3062

server_settings["use_dbus"] = False

2338

3063

tcp_server.use_dbus = False

2339

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2340

service = AvahiServiceToSyslog(name =

2341

server_settings["servicename"],

2342

servicetype = "_mandos._tcp",

2343

protocol = protocol, bus = bus)

2344

if server_settings["interface"]:

2345

service.interface = (if_nametoindex

2346

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

2347

3064

if zeroconf:

3065

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3066

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

3071

if server_settings["interface"]:

3072

service.interface = if_nametoindex(

3073

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

3074

2348

3075

global multiprocessing_manager

2349

3076

multiprocessing_manager = multiprocessing.Manager()

2350

3077

2351

3078

client_class = Client

2352

3079

if use_dbus:

2353

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

2354

3080

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

3081

2355

3082

client_settings = Client.config_parser(client_config)

2356

3083

old_client_settings = {}

2357

3084

clients_data = {}

2358

3085

3086

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

3087

global wnull

3088

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

3089

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

3090

# mode

3091

if debug or not foreground:

3092

wnull.close()

3093

2359

3094

# Get client data and settings from last running state.

2360

3095

if server_settings["restore"]:

2361

3096

try:

2362

3097

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

2363

clients_data, old_client_settings = (pickle.load

2364

(stored_state))

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

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

3141

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

3142

.decode("utf-8"))

2365

3143

os.remove(stored_state_path)

2366

3144

except IOError as e:

2367

3145

if e.errno == errno.ENOENT:

2368

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

2369

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

3146

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

3147

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

2370

3148

else:

2371

3149

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

2372

3150

exc_info=e)

2373

3151

raise

2374

3152

except EOFError as e:

2375

3153

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

2376

"EOFError:", exc_info=e)

2377

3154

"EOFError:",

3155

exc_info=e)

3156

2378

3157

with PGPEngine() as pgp:

2379

for client_name, client in clients_data.iteritems():

3158

for client_name, client in clients_data.items():

3159

# Skip removed clients

3160

if client_name not in client_settings:

3161

continue

3162

2380

3163

# Decide which value to use after restoring saved state.

2381

3164

# We have three different values: Old config file,

2382

3165

# new config file, and saved state.

2387

3170

# For each value in new config, check if it

2388

3171

# differs from the old config value (Except for

2389

3172

# the "secret" attribute)

2390

if (name != "secret" and

2391

value != old_client_settings[client_name]

2392

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2393

3176

client[name] = value

2394

3177

except KeyError:

2395

3178

pass

2396

3179

2397

3180

# Clients who has passed its expire date can still be

2398

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2399

3182

# whose checker succeeded before we stored its state is

2400

3183

# assumed to have successfully run all checkers during

2401

3184

# downtime.

2403

3186

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

2404

3187

if not client["last_checked_ok"]:

2405

3188

logger.warning(

2406

"disabling client {0} - Client never "

2407

"performed a successful checker"

2408

.format(client_name))

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2409

3192

client["enabled"] = False

2410

3193

elif client["last_checker_status"] != 0:

2411

3194

logger.warning(

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2414

.format(client_name,

2415

client["last_checker_status"]))

3195

"disabling client {} - Client last"

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2416

3200

client["enabled"] = False

2417

3201

else:

2418

client["expires"] = (datetime.datetime

2419

.utcnow()

2420

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2421

3205

logger.debug("Last checker succeeded,"

2422

" keeping {0} enabled"

2423

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2424

3208

try:

2425

client["secret"] = (

2426

pgp.decrypt(client["encrypted_secret"],

2427

client_settings[client_name]

2428

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2429

3212

except PGPError:

2430

3213

# If decryption fails, we use secret from new settings

2431

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

2432

.format(client_name))

2433

client["secret"] = (

2434

client_settings[client_name]["secret"])

2435

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2436

3219

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

2437

3220

for client_name in (set(old_client_settings)

2438

3221

- set(client_settings)):

2440

3223

for client_name in (set(client_settings)

2441

3224

- set(old_client_settings)):

2442

3225

clients_data[client_name] = client_settings[client_name]

2443

3226

2444

3227

# Create all client objects

2445

for client_name, client in clients_data.iteritems():

3228

for client_name, client in clients_data.items():

2446

3229

tcp_server.clients[client_name] = client_class(

2447

name = client_name, settings = client)

2448

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2449

3234

if not tcp_server.clients:

2450

3235

logger.warning("No clients defined")

2451

2452

if not debug:

2453

try:

2454

with pidfile:

2455

pid = os.getpid()

2456

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

2457

del pidfile

2458

except IOError:

2459

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

2460

pidfilename, pid)

2461

except NameError:

2462

# "pidfile" was never created

2463

pass

3236

3237

if not foreground:

3238

if pidfile is not None:

3239

pid = os.getpid()

3240

try:

3241

with pidfile:

3242

print(pid, file=pidfile)

3243

except IOError:

3244

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

3245

pidfilename, pid)

3246

del pidfile

2464

3247

del pidfilename

2465

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

2466

2467

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

2468

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

2469

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2470

3253

if use_dbus:

2471

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

2472

"se.bsnet.fukt.Mandos"})

2473

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2474

3258

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

3259

2475

3260

def __init__(self):

2476

3261

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

3262

2477

3263

_interface = "se.recompile.Mandos"

2478

2479

@dbus_interface_annotations(_interface)

2480

def _foo(self):

2481

return { "org.freedesktop.DBus.Property"

2482

".EmitsChangedSignal":

2483

"false"}

2484

3264

2485

3265

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

2486

3266

def ClientAdded(self, objpath):

2487

3267

"D-Bus signal"

2488

3268

pass

2489

3269

2490

3270

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

2491

3271

def ClientNotFound(self, fingerprint, address):

2492

3272

"D-Bus signal"

2493

3273

pass

2494

3274

3275

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

3276

"true"})

2495

3277

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

2496

3278

def ClientRemoved(self, objpath, name):

2497

3279

"D-Bus signal"

2498

3280

pass

2499

3281

3282

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

3283

"true"})

2500

3284

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

2501

3285

def GetAllClients(self):

2502

3286

"D-Bus method"

2503

return dbus.Array(c.dbus_object_path

2504

for c in

2505

tcp_server.clients.itervalues())

2506

3287

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2507

3292

@dbus.service.method(_interface,

2508

3293

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

2509

3294

def GetAllClientsWithProperties(self):

2510

3295

"D-Bus method"

2511

3296

return dbus.Dictionary(

2512

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

2513

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

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2514

3300

signature="oa{sv}")

2515

3301

2516

3302

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

2517

3303

def RemoveClient(self, object_path):

2518

3304

"D-Bus method"

2519

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2520

3306

if c.dbus_object_path == object_path:

2521

3307

del tcp_server.clients[c.name]

2522

3308

c.remove_from_connection()

2523

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2524

3310

c.disable(quiet=True)

2525

# Emit D-Bus signal

2526

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2527

3313

return

2528

3314

raise KeyError(object_path)

2529

3315

2530

3316

del _interface

2531

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2532

3354

mandos_dbus_service = MandosDBusService()

2533

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2534

3361

def cleanup():

2535

3362

"Cleanup function; run on exit"

2536

service.cleanup()

2537

2538

multiprocessing.active_children()

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2539

3368

if not (tcp_server.clients or client_settings):

2540

3369

return

2541

3370

2542

3371

# Store client before exiting. Secrets are encrypted with key

2543

3372

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

2544

3373

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

2545

3374

clients = {}

2546

3375

with PGPEngine() as pgp:

2547

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2548

3377

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

2549

3378

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

2550

3379

key)

2551

3380

client_dict = {}

2552

3381

2553

3382

# A list of attributes that can not be pickled

2554

3383

# + secret.

2555

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

2556

"checker"))

2557

for name, typ in (inspect.getmembers

2558

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2559

3388

exclude.add(name)

2560

3389

2561

3390

client_dict["encrypted_secret"] = (client

2562

3391

.encrypted_secret)

2563

3392

for attr in client.client_structure:

2564

3393

if attr not in exclude:

2565

3394

client_dict[attr] = getattr(client, attr)

2566

3395

2567

3396

clients[client.name] = client_dict

2568

3397

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

2569

3398

2570

3399

try:

2571

with (tempfile.NamedTemporaryFile

2572

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

2573

dir=os.path.dirname(stored_state_path),

2574

delete=False)) as stored_state:

2575

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

2576

tempname=stored_state.name

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2577

3409

os.rename(tempname, stored_state_path)

2578

3410

except (IOError, OSError) as e:

2579

3411

if not debug:

2582

3414

except NameError:

2583

3415

pass

2584

3416

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

2585

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

3417

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

2586

3418

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

2587

3419

else:

2588

3420

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

2589

3421

exc_info=e)

2590

raise e

2591

3422

raise

3423

2592

3424

# Delete all clients, and settings from config

2593

3425

while tcp_server.clients:

2594

3426

name, client = tcp_server.clients.popitem()

2595

3427

if use_dbus:

2596

3428

client.remove_from_connection()

2597

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2598

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2599

3432

if use_dbus:

2600

# Emit D-Bus signal

2601

mandos_dbus_service.ClientRemoved(client

2602

.dbus_object_path,

2603

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2604

3434

client_settings.clear()

2605

3435

2606

3436

atexit.register(cleanup)

2607

2608

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2609

3439

if use_dbus:

2610

# Emit D-Bus signal

2611

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2612

3442

# Need to initiate checking of clients

2613

3443

if client.enabled:

2614

3444

client.init_checker()

2615

3445

2616

3446

tcp_server.enable()

2617

3447

tcp_server.server_activate()

2618

3448

2619

3449

# Find out what port we got

2620

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

3450

if zeroconf:

3451

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

2621

3452

if use_ipv6:

2622

3453

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

2623

3454

" flowinfo %d, scope_id %d",

2625

3456

else: # IPv4

2626

3457

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

2627

3458

*tcp_server.socket.getsockname())

2628

2629

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

2630

3459

3460

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

3461

2631

3462

try:

2632

# From the Avahi example code

2633

try:

2634

service.activate()

2635

except dbus.exceptions.DBusException as error:

2636

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

2637

cleanup()

2638

sys.exit(1)

2639

# End of Avahi example code

2640

2641

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

2642

lambda *args, **kwargs:

2643

(tcp_server.handle_request

2644

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

2645

3463

if zeroconf:

3464

# From the Avahi example code

3465

try:

3466

service.activate()

3467

except dbus.exceptions.DBusException as error:

3468

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

3469

cleanup()

3470

sys.exit(1)

3471

# End of Avahi example code

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2646

3478

logger.debug("Starting main loop")

2647

3479

main_loop.run()

2648

3480

except AvahiError as error:

2657

3489

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

2658

3490

cleanup()

2659

3491

3492

2660

3493

if __name__ == '__main__':

2661

3494

main()