/mandos/release : revision 237.7.502

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

import SocketServer as socketserver

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

38

47

import socket

39

48

import argparse

40

49

import datetime

41

50

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

49

55

import sys

50

56

import re

51

57

import os

60

66

import struct

61

67

import fcntl

62

68

import functools

63

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

64

73

import multiprocessing

65

74

import types

66

75

import binascii

67

76

import tempfile

68

77

import itertools

78

import collections

79

import codecs

69

80

70

81

import dbus

71

82

import dbus.service

72

import gobject

73

import avahi

83

from gi.repository import GLib

74

84

from dbus.mainloop.glib import DBusGMainLoop

75

85

import ctypes

76

86

import ctypes.util

77

87

import xml.dom.minidom

78

88

import inspect

79

import GnuPGInterface

80

89

90

# Try to find the value of SO_BINDTODEVICE:

81

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:

82

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

83

95

except AttributeError:

84

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

85

99

from IN import SO_BINDTODEVICE

86

100

except ImportError:

87

SO_BINDTODEVICE = None

88

89

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.19"

90

119

stored_state_file = "clients.pickle"

91

120

92

121

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

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

114

155

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

115

156

"""init logger and add loglevel"""

116

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

117

162

syslogger.setFormatter(logging.Formatter

118

163

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

119

164

' %(message)s'))

120

165

logger.addHandler(syslogger)

121

166

122

167

if debug:

123

168

console = logging.StreamHandler()

124

169

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

136

181

137

182

class PGPEngine(object):

138

183

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

184

139

185

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

186

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

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

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

149

206

def __enter__(self):

150

207

return self

151

152

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

208

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

175

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

176

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

177

240

def encrypt(self, data, password):

178

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

179

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

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

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)

192

256

return ciphertext

193

257

194

258

def decrypt(self, data, password):

195

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

196

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

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

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)

209

274

return decrypted_plaintext

210

275

211

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

212

304

class AvahiError(Exception):

213

305

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

214

306

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

307

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

308

**kwargs)

309

218

310

219

311

class AvahiServiceError(AvahiError):

220

312

pass

221

313

314

222

315

class AvahiGroupError(AvahiError):

223

316

pass

224

317

225

318

226

319

class AvahiService(object):

227

320

"""An Avahi (Zeroconf) service.

228

321

229

322

Attributes:

230

323

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

231

324

Used to optionally bind to the specified interface.

232

325

name: string; Example: 'Mandos'

233

326

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

234

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

327

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

235

328

port: integer; what port to announce

236

329

TXT: list of strings; TXT record for the service

237

330

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

243

336

server: D-Bus Server

244

337

bus: dbus.SystemBus()

245

338

"""

246

247

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

248

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

249

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

250

protocol = avahi.PROTO_UNSPEC, bus = None):

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

251

351

self.interface = interface

252

352

self.name = name

253

353

self.type = servicetype

262

362

self.server = None

263

363

self.bus = bus

264

364

self.entry_group_state_changed_match = None

265

266

def rename(self):

365

366

def rename(self, remove=True):

267

367

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

268

368

if self.rename_count >= self.max_renames:

269

369

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

270

370

" after %i retries, exiting.",

271

371

self.rename_count)

272

372

raise AvahiServiceError("Too many renames")

273

self.name = unicode(self.server

274

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

275

376

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

276

377

self.name)

277

self.remove()

378

if remove:

379

self.remove()

278

380

try:

279

381

self.add()

280

382

except dbus.exceptions.DBusException as error:

281

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

282

self.cleanup()

283

os._exit(1)

284

self.rename_count += 1

285

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

286

392

def remove(self):

287

393

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

288

394

if self.entry_group_state_changed_match is not None:

290

396

self.entry_group_state_changed_match = None

291

397

if self.group is not None:

292

398

self.group.Reset()

293

399

294

400

def add(self):

295

401

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

296

402

self.remove()

313

419

dbus.UInt16(self.port),

314

420

avahi.string_array_to_txt_array(self.TXT))

315

421

self.group.Commit()

316

422

317

423

def entry_group_state_changed(self, state, error):

318

424

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

319

425

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

320

426

321

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

322

428

logger.debug("Zeroconf service established.")

323

429

elif state == avahi.ENTRY_GROUP_COLLISION:

325

431

self.rename()

326

432

elif state == avahi.ENTRY_GROUP_FAILURE:

327

433

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

328

unicode(error))

329

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

330

.format(error))

331

434

str(error))

435

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

436

332

437

def cleanup(self):

333

438

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

334

439

if self.group is not None:

339

444

pass

340

445

self.group = None

341

446

self.remove()

342

447

343

448

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

344

449

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

345

450

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

346

bad_states = { avahi.SERVER_INVALID:

347

"Zeroconf server invalid",

348

avahi.SERVER_REGISTERING: None,

349

avahi.SERVER_COLLISION:

350

"Zeroconf server name collision",

351

avahi.SERVER_FAILURE:

352

"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

}

353

457

if state in bad_states:

354

458

if bad_states[state] is not None:

355

459

if error is None:

358

462

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

359

463

self.cleanup()

360

464

elif state == avahi.SERVER_RUNNING:

361

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)

362

477

else:

363

478

if error is None:

364

479

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

365

480

else:

366

481

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

367

482

368

483

def activate(self):

369

484

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

370

485

if self.server is None:

374

489

follow_name_owner_changes=True),

375

490

avahi.DBUS_INTERFACE_SERVER)

376

491

self.server.connect_to_signal("StateChanged",

377

self.server_state_changed)

492

self.server_state_changed)

378

493

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

379

494

495

380

496

class AvahiServiceToSyslog(AvahiService):

381

def rename(self):

497

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

382

498

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

383

ret = AvahiService.rename(self)

384

syslogger.setFormatter(logging.Formatter

385

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

386

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

387

.format(self.name)))

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

388

503

return ret

389

504

390

def timedelta_to_milliseconds(td):

391

"Convert a datetime.timedelta() to milliseconds"

392

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

393

+ (td.seconds * 1000)

394

+ (td.microseconds // 1000))

505

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

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

520

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

521

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

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

# exception might be raised from within GnuTLS.__init__,

567

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

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

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

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

778

395

779

396

780

class Client(object):

397

781

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

398

782

399

783

Attributes:

400

784

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

401

785

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

403

787

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

404

788

to see if the client lives.

405

789

'None' if no process is running.

406

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

407

791

checker_command: string; External command which is run to check

408

792

if client lives. %() expansions are done at

409

793

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

410

794

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

411

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

412

796

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

413

797

client_structure: Object describing what attributes a client has

414

798

and is used for storing the client at exit

415

799

current_checker_command: string; current running checker_command

416

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

417

801

enabled: bool()

418

802

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

419

803

uniquely identify the client

424

808

last_checker_status: integer between 0 and 255 reflecting exit

425

809

status of last checker. -1 reflects crashed

426

810

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

427

813

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

428

814

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

429

815

D-Bus identifiers

434

820

runtime_expansions: Allowed attributes for runtime expansion.

435

821

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

436

822

disabled, or None

823

server_settings: The server_settings dict from main()

437

824

"""

438

825

439

826

runtime_expansions = ("approval_delay", "approval_duration",

440

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

441

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

827

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

828

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

829

"last_approval_request", "last_checked_ok",

442

830

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

443

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

444

"extended_timeout": "15m",

445

"interval": "2m",

446

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

447

"host": "",

448

"approval_delay": "0s",

449

"approval_duration": "1s",

450

"approved_by_default": "True",

451

"enabled": "True",

452

}

453

454

def timeout_milliseconds(self):

455

"Return the 'timeout' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.timeout)

457

458

def extended_timeout_milliseconds(self):

459

"Return the 'extended_timeout' attribute in milliseconds"

460

return timedelta_to_milliseconds(self.extended_timeout)

461

462

def interval_milliseconds(self):

463

"Return the 'interval' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.interval)

465

466

def approval_delay_milliseconds(self):

467

return timedelta_to_milliseconds(self.approval_delay)

468

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

469

843

@staticmethod

470

844

def config_parser(config):

471

845

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

478

852

for client_name in config.sections():

479

853

section = dict(config.items(client_name))

480

854

client = settings[client_name] = {}

481

855

482

856

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

483

857

# Reformat values from string types to Python types

484

858

client["approved_by_default"] = config.getboolean(

485

859

client_name, "approved_by_default")

486

860

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

487

861

"enabled")

488

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

489

866

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

490

867

.replace(" ", ""))

491

868

if "secret" in section:

492

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

869

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

870

.encode("utf-8"),

871

"base64")

493

872

elif "secfile" in section:

494

873

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

495

874

(section["secfile"])),

496

875

"rb") as secfile:

497

876

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

498

877

else:

499

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

878

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

500

879

.format(section))

501

880

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

502

881

client["extended_timeout"] = string_to_delta(

510

889

client["last_approval_request"] = None

511

890

client["last_checked_ok"] = None

512

891

client["last_checker_status"] = -2

513

892

514

893

return settings

515

516

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

894

895

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

517

896

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

518

900

# adding all client settings

519

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

520

902

setattr(self, setting, value)

521

903

522

904

if self.enabled:

523

905

if not hasattr(self, "last_enabled"):

524

906

self.last_enabled = datetime.datetime.utcnow()

528

910

else:

529

911

self.last_enabled = None

530

912

self.expires = None

531

913

532

914

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

533

# Uppercase and remove spaces from fingerprint for later

534

# comparison purposes with return value from the fingerprint()

535

# function

536

915

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

537

916

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

538

917

datetime.datetime.utcnow())

539

918

540

919

# attributes specific for this server instance

541

920

self.checker = None

542

921

self.checker_initiator_tag = None

545

924

self.current_checker_command = None

546

925

self.approved = None

547

926

self.approvals_pending = 0

548

self.changedstate = (multiprocessing_manager

549

.Condition(multiprocessing_manager

550

.Lock()))

551

self.client_structure = [attr for attr in

552

self.__dict__.iterkeys()

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

553

931

if not attr.startswith("_")]

554

932

self.client_structure.append("client_structure")

555

556

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

557

lambda obj:

558

isinstance(obj,

559

property)):

933

934

for name, t in inspect.getmembers(

935

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

560

936

if not name.startswith("_"):

561

937

self.client_structure.append(name)

562

938

563

939

# Send notice to process children that client state has changed

564

940

def send_changedstate(self):

565

941

with self.changedstate:

566

942

self.changedstate.notify_all()

567

943

568

944

def enable(self):

569

945

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

570

946

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

571

947

# Already enabled

572

948

return

573

self.send_changedstate()

574

949

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

575

950

self.enabled = True

576

951

self.last_enabled = datetime.datetime.utcnow()

577

952

self.init_checker()

578

953

self.send_changedstate()

954

579

955

def disable(self, quiet=True):

580

956

"""Disable this client."""

581

957

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

582

958

return False

583

959

if not quiet:

584

self.send_changedstate()

585

if not quiet:

586

960

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

587

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

588

gobject.source_remove(self.disable_initiator_tag)

961

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

962

GLib.source_remove(self.disable_initiator_tag)

589

963

self.disable_initiator_tag = None

590

964

self.expires = None

591

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

592

gobject.source_remove(self.checker_initiator_tag)

965

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

966

GLib.source_remove(self.checker_initiator_tag)

593

967

self.checker_initiator_tag = None

594

968

self.stop_checker()

595

969

self.enabled = False

596

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

970

if not quiet:

971

self.send_changedstate()

972

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

597

973

return False

598

974

599

975

def __del__(self):

600

976

self.disable()

601

977

602

978

def init_checker(self):

603

979

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

604

980

# and every interval from then on.

605

self.checker_initiator_tag = (gobject.timeout_add

606

(self.interval_milliseconds(),

607

self.start_checker))

981

if self.checker_initiator_tag is not None:

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

608

986

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

609

self.disable_initiator_tag = (gobject.timeout_add

610

(self.timeout_milliseconds(),

611

self.disable))

987

if self.disable_initiator_tag is not None:

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

612

991

# Also start a new checker *right now*.

613

992

self.start_checker()

614

615

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

616

996

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

617

997

self.checker_callback_tag = None

618

998

self.checker = None

619

if os.WIFEXITED(condition):

620

self.last_checker_status = os.WEXITSTATUS(condition)

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

621

1006

if self.last_checker_status == 0:

622

1007

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

623

1008

vars(self))

624

1009

self.checked_ok()

625

1010

else:

626

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

627

vars(self))

1011

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

628

1012

else:

629

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

630

1015

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

631

1016

vars(self))

632

1017

return False

1018

633

1019

def checked_ok(self):

634

1020

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

635

1021

self.last_checked_ok = datetime.datetime.utcnow()

636

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

637

1024

self.bump_timeout()

638

1025

639

1026

def bump_timeout(self, timeout=None):

640

1027

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

641

1028

if timeout is None:

642

1029

timeout = self.timeout

643

1030

if self.disable_initiator_tag is not None:

644

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

1032

self.disable_initiator_tag = None

645

1033

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

646

self.disable_initiator_tag = (gobject.timeout_add

647

(timedelta_to_milliseconds

648

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

649

1036

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

650

1037

651

1038

def need_approval(self):

652

1039

self.last_approval_request = datetime.datetime.utcnow()

653

1040

654

1041

def start_checker(self):

655

1042

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

656

1043

657

1044

If a checker already exists, leave it running and do

658

1045

nothing."""

659

1046

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

660

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

661

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

662

# client would inevitably timeout, since no checker would get

663

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

1047

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

1048

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

1049

# would inevitably timeout, since no checker would get a

1050

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

664

1051

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

665

1052

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

666

1053

# should be.

667

668

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

669

try:

670

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

671

except (AttributeError, OSError) as error:

672

if (isinstance(error, OSError)

673

and error.errno != errno.ECHILD):

674

raise error

675

else:

676

if pid:

677

logger.warning("Checker was a zombie")

678

gobject.source_remove(self.checker_callback_tag)

679

self.checker_callback(pid, status,

680

self.current_checker_command)

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

681

1059

# Start a new checker if needed

682

1060

if self.checker is None:

1061

# Escape attributes for the shell

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

683

1065

try:

684

# In case checker_command has exactly one % operator

685

command = self.checker_command % self.host

686

except TypeError:

687

# Escape attributes for the shell

688

escaped_attrs = dict(

689

(attr,

690

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

691

errors=

692

'replace')))

693

for attr in

694

self.runtime_expansions)

695

696

try:

697

command = self.checker_command % escaped_attrs

698

except TypeError as error:

699

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

700

self.checker_command, exc_info=error)

701

return True # Try again later

1066

command = self.checker_command % escaped_attrs

1067

except TypeError as error:

1068

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

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

702

1072

self.current_checker_command = command

703

try:

704

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

705

command, self.name)

706

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

707

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

708

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

709

# always replaced by /dev/null.)

710

self.checker = subprocess.Popen(command,

711

close_fds=True,

712

shell=True, cwd="/")

713

self.checker_callback_tag = (gobject.child_watch_add

714

(self.checker.pid,

715

self.checker_callback,

716

data=command))

717

# The checker may have completed before the gobject

718

# watch was added. Check for this.

719

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

720

if pid:

721

gobject.source_remove(self.checker_callback_tag)

722

self.checker_callback(pid, status, command)

723

except OSError as error:

724

logger.error("Failed to start subprocess",

725

exc_info=error)

726

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

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

727

1099

return True

728

1100

729

1101

def stop_checker(self):

730

1102

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

731

1103

if self.checker_callback_tag:

732

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

733

1105

self.checker_callback_tag = None

734

1106

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

735

1107

return

736

1108

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

737

try:

738

self.checker.terminate()

739

#time.sleep(0.5)

740

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

741

# self.checker.kill()

742

except OSError as error:

743

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

744

raise

1109

self.checker.terminate()

745

1110

self.checker = None

746

1111

747

1112

748

def dbus_service_property(dbus_interface, signature="v",

749

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

750

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

751

1118

become properties on the D-Bus.

752

1119

753

1120

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

754

1121

and with one argument by "Set".

755

1122

756

1123

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

757

1124

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

758

1125

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

761

1128

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

762

1129

if byte_arrays and signature != "ay":

763

1130

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

764

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

1131

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

1132

765

1133

def decorator(func):

766

1134

func._dbus_is_property = True

767

1135

func._dbus_interface = dbus_interface

770

1138

func._dbus_name = func.__name__

771

1139

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

772

1140

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

773

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

774

1142

return func

1143

775

1144

return decorator

776

1145

777

1146

778

1147

def dbus_interface_annotations(dbus_interface):

779

1148

"""Decorator for marking functions returning interface annotations

780

1149

781

1150

Usage:

782

1151

783

1152

@dbus_interface_annotations("org.example.Interface")

784

1153

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

785

1154

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

786

1155

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

787

1156

"false"}

788

1157

"""

1158

789

1159

def decorator(func):

790

1160

func._dbus_is_interface = True

791

1161

func._dbus_interface = dbus_interface

792

1162

func._dbus_name = dbus_interface

793

1163

return func

1164

794

1165

return decorator

795

1166

796

1167

797

1168

def dbus_annotations(annotations):

798

1169

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

799

1170

Usage:

800

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

801

1175

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

802

1176

access="r")

803

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

804

"org.freedesktop.DBus.Property."

805

"EmitsChangedSignal": "false"})

806

1177

def Property_dbus_property(self):

807

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

808

1181

"""

1182

809

1183

def decorator(func):

810

1184

func._dbus_annotations = annotations

811

1185

return func

1186

812

1187

return decorator

813

1188

814

1189

815

1190

class DBusPropertyException(dbus.exceptions.DBusException):

816

1191

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

817

1192

"""

818

def __unicode__(self):

819

return unicode(str(self))

1193

pass

820

1194

821

1195

822

1196

class DBusPropertyAccessException(DBusPropertyException):

831

1205

pass

832

1206

833

1207

834

class DBusObjectWithProperties(dbus.service.Object):

835

"""A D-Bus object with properties.

836

837

Classes inheriting from this can use the dbus_service_property

838

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

839

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

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

840

1213

"""

841

1214

842

1215

@staticmethod

843

1216

def _is_dbus_thing(thing):

844

1217

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

845

1218

846

1219

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

847

1220

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

848

1221

"""

849

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

1222

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

850

1223

False)

851

1224

852

1225

def _get_all_dbus_things(self, thing):

853

1226

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

854

1227

"""

855

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

856

name),

1228

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

857

1229

athing.__get__(self))

858

1230

for cls in self.__class__.__mro__

859

1231

for name, athing in

860

inspect.getmembers(cls,

861

self._is_dbus_thing(thing)))

862

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

863

1305

def _get_dbus_property(self, interface_name, property_name):

864

1306

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

865

1307

property with the specified name and interface.

866

1308

"""

867

for cls in self.__class__.__mro__:

868

for name, value in (inspect.getmembers

869

(cls,

870

self._is_dbus_thing("property"))):

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

871

1312

if (value._dbus_name == property_name

872

1313

and value._dbus_interface == interface_name):

873

1314

return value.__get__(self)

874

1315

875

1316

# No such property

876

raise DBusPropertyNotFound(self.dbus_object_path + ":"

877

+ interface_name + "."

878

+ property_name)

879

880

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

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

881

1331

out_signature="v")

882

1332

def Get(self, interface_name, property_name):

883

1333

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

889

1339

if not hasattr(value, "variant_level"):

890

1340

return value

891

1341

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

892

1342

893

1343

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

894

1344

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

895

1345

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

901

1351

# The byte_arrays option is not supported yet on

902

1352

# signatures other than "ay".

903

1353

if prop._dbus_signature != "ay":

904

raise ValueError

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

905

1357

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

906

1358

for byte in value))

907

1359

prop(value)

908

909

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

910

1363

out_signature="a{sv}")

911

1364

def GetAll(self, interface_name):

912

1365

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

913

1366

standard.

914

1367

915

1368

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

916

1369

"""

917

1370

properties = {}

927

1380

if not hasattr(value, "variant_level"):

928

1381

properties[name] = value

929

1382

continue

930

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

931

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

932

1385

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

933

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

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

1391

standard.

1392

"""

1393

pass

1394

934

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

935

1396

out_signature="s",

936

1397

path_keyword='object_path',

937

1398

connection_keyword='connection')

938

1399

def Introspect(self, object_path, connection):

939

1400

"""Overloading of standard D-Bus method.

940

1401

941

1402

Inserts property tags and interface annotation tags.

942

1403

"""

943

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

944

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

945

1407

try:

946

1408

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

1409

947

1410

def make_tag(document, name, prop):

948

1411

e = document.createElement("property")

949

1412

e.setAttribute("name", name)

950

1413

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

951

1414

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

952

1415

return e

1416

953

1417

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

954

1418

# Add property tags

955

1419

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

958

1422

if prop._dbus_interface

959

1423

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

960

1424

if_tag.appendChild(tag)

961

# Add annotation tags

962

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

963

for tag in if_tag.getElementsByTagName(typ):

964

annots = dict()

965

for name, prop in (self.

966

_get_all_dbus_things(typ)):

967

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

968

and prop._dbus_interface

969

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

970

annots.update(getattr

971

(prop,

972

"_dbus_annotations",

973

{}))

974

for name, value in annots.iteritems():

975

ann_tag = document.createElement(

976

"annotation")

977

ann_tag.setAttribute("name", name)

978

ann_tag.setAttribute("value", value)

979

tag.appendChild(ann_tag)

980

# Add interface annotation tags

981

for annotation, value in dict(

982

itertools.chain(

983

*(annotations().iteritems()

984

for name, annotations in

985

self._get_all_dbus_things("interface")

986

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

987

))).iteritems():

988

ann_tag = document.createElement("annotation")

989

ann_tag.setAttribute("name", annotation)

990

ann_tag.setAttribute("value", value)

991

if_tag.appendChild(ann_tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

992

1441

# Add the names to the return values for the

993

1442

# "org.freedesktop.DBus.Properties" methods

994

1443

if (if_tag.getAttribute("name")

1013

1462

return xmlstring

1014

1463

1015

1464

1016

def datetime_to_dbus (dt, variant_level=0):

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1536

def datetime_to_dbus(dt, variant_level=0):

1017

1537

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

1018

1538

if dt is None:

1019

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

1020

return dbus.String(dt.isoformat(),

1021

variant_level=variant_level)

1022

1023

1024

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1025

.__metaclass__):

1026

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

1027

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

1539

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

1540

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

1541

1542

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1544

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

1545

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

1546

interface names according to the "alt_interface_names" mapping.

1547

Usage:

1548

1549

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

1550

"net.example.AlternateInterface"})

1551

class SampleDBusObject(dbus.service.Object):

1552

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

1553

def SampleDBusMethod():

1554

pass

1555

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1557

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

1558

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

1559

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

1560

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

1561

1562

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

1563

(from DBusObjectWithProperties) and interfaces (from the

1564

dbus_interface_annotations decorator).

1028

1565

"""

1029

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

1030

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

1031

# methods, signals, or properties in them

1032

old_interface_names = []

1033

for base in (b for b in bases

1034

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

1035

# Go though all attributes of the base class

1036

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

1566

1567

def wrapper(cls):

1568

for orig_interface_name, alt_interface_name in (

1569

alt_interface_names.items()):

1570

attr = {}

1571

interface_names = set()

1572

# Go though all attributes of the class

1573

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

1037

1574

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

1038

1575

# with the wrong interface name

1039

1576

if (not hasattr(attribute, "_dbus_interface")

1040

or not attribute._dbus_interface

1041

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

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1042

1579

continue

1043

1580

# Create an alternate D-Bus interface name based on

1044

1581

# the current name

1045

alt_interface = (attribute._dbus_interface

1046

.replace("se.recompile.Mandos",

1047

"se.bsnet.fukt.Mandos"))

1048

if alt_interface != attribute._dbus_interface:

1049

old_interface_names.append(alt_interface)

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1584

interface_names.add(alt_interface)

1050

1585

# Is this a D-Bus signal?

1051

1586

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

1052

# Extract the original non-method function by

1053

# black magic

1054

nonmethod_func = (dict(

1587

# Extract the original non-method undecorated

1588

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1055

1591

zip(attribute.func_code.co_freevars,

1056

attribute.__closure__))["func"]

1057

.cell_contents)

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1058

1599

# Create a new, but exactly alike, function

1059

1600

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

1060

1601

# with the alternate D-Bus interface name

1061

new_function = (dbus.service.signal

1062

(alt_interface,

1063

attribute._dbus_signature)

1064

(types.FunctionType(

1065

nonmethod_func.func_code,

1066

nonmethod_func.func_globals,

1067

nonmethod_func.func_name,

1068

nonmethod_func.func_defaults,

1069

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1070

1606

# Copy annotations, if any

1071

1607

try:

1072

new_function._dbus_annotations = (

1073

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1074

1610

except AttributeError:

1075

1611

pass

1612

1076

1613

# Define a creator of a function to call both the

1077

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

1078

# signals gets sent when the function is called

1614

# original and alternate functions, so both the

1615

# original and alternate signals gets sent when

1616

# the function is called

1079

1617

def fixscope(func1, func2):

1080

1618

"""This function is a scope container to pass

1081

1619

func1 and func2 to the "call_both" function

1082

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1083

1623

def call_both(*args, **kwargs):

1084

1624

"""This function will emit two D-Bus

1085

1625

signals by calling func1 and func2"""

1086

1626

func1(*args, **kwargs)

1087

1627

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1088

1634

return call_both

1089

1635

# Create the "call_both" function and add it to

1090

1636

# the class

1091

attr[attrname] = fixscope(attribute,

1092

new_function)

1637

attr[attrname] = fixscope(attribute, new_function)

1093

1638

# Is this a D-Bus method?

1094

1639

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

1095

1640

# Create a new, but exactly alike, function

1096

1641

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

1097

1642

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

1098

1643

# to the class.

1099

attr[attrname] = (dbus.service.method

1100

(alt_interface,

1101

attribute._dbus_in_signature,

1102

attribute._dbus_out_signature)

1103

(types.FunctionType

1104

(attribute.func_code,

1105

attribute.func_globals,

1106

attribute.func_name,

1107

attribute.func_defaults,

1108

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1109

1650

# Copy annotations, if any

1110

1651

try:

1111

attr[attrname]._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1113

1654

except AttributeError:

1114

1655

pass

1115

1656

# Is this a D-Bus property?

1118

1659

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

1119

1660

# property with the alternate D-Bus interface

1120

1661

# name. Add it to the class.

1121

attr[attrname] = (dbus_service_property

1122

(alt_interface,

1123

attribute._dbus_signature,

1124

attribute._dbus_access,

1125

attribute

1126

._dbus_get_args_options

1127

["byte_arrays"])

1128

(types.FunctionType

1129

(attribute.func_code,

1130

attribute.func_globals,

1131

attribute.func_name,

1132

attribute.func_defaults,

1133

attribute.func_closure)))

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1134

1668

# Copy annotations, if any

1135

1669

try:

1136

attr[attrname]._dbus_annotations = (

1137

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1138

1672

except AttributeError:

1139

1673

pass

1140

1674

# Is this a D-Bus interface?

1143

1677

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

1144

1678

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

1145

1679

# to the class.

1146

attr[attrname] = (dbus_interface_annotations

1147

(alt_interface)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1154

# Deprecate all old interfaces

1155

iname="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1156

for old_interface_name in old_interface_names:

1157

@dbus_interface_annotations(old_interface_name)

1158

def func(self):

1159

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

1160

# Find an unused name

1161

for aname in (iname.format(i) for i in itertools.count()):

1162

if aname not in attr:

1163

attr[aname] = func

1164

break

1165

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

1166

1167

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1683

if deprecate:

1684

# Deprecate all alternate interfaces

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1686

for interface_name in interface_names:

1687

1688

@dbus_interface_annotations(interface_name)

1689

def func(self):

1690

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

1691

"true"}

1692

# Find an unused name

1693

for aname in (iname.format(i)

1694

for i in itertools.count()):

1695

if aname not in attr:

1696

attr[aname] = func

1697

break

1698

if interface_names:

1699

# Replace the class with a new subclass of it with

1700

# methods, signals, etc. as created above.

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1707

return cls

1708

1709

return wrapper

1710

1711

1712

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

1713

"se.bsnet.fukt.Mandos"})

1168

1714

class ClientDBus(Client, DBusObjectWithProperties):

1169

1715

"""A Client class using D-Bus

1170

1716

1171

1717

Attributes:

1172

1718

dbus_object_path: dbus.ObjectPath

1173

1719

bus: dbus.SystemBus()

1174

1720

"""

1175

1721

1176

1722

runtime_expansions = (Client.runtime_expansions

1177

+ ("dbus_object_path",))

1178

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1179

1727

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

1180

1181

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

1728

1729

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

1182

1730

self.bus = bus

1183

1731

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

1184

1732

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

1185

1733

# the D-Bus

1186

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1187

1735

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

1188

1736

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

1189

self.dbus_object_path = (dbus.ObjectPath

1190

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1191

1739

DBusObjectWithProperties.__init__(self, self.bus,

1192

1740

self.dbus_object_path)

1193

1194

def notifychangeproperty(transform_func,

1195

dbus_name, type_func=lambda x: x,

1196

variant_level=1):

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1197

1747

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

1198

1748

its changes to DBus.

1199

1749

1200

1750

transform_fun: Function that takes a value and a variant_level

1201

1751

and transforms it to a D-Bus type.

1202

1752

dbus_name: D-Bus name of the variable

1204

1754

to the D-Bus. Default: no transform

1205

1755

variant_level: D-Bus variant level. Default: 1

1206

1756

"""

1207

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

1757

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

1758

1208

1759

def setter(self, value):

1209

1760

if hasattr(self, "dbus_object_path"):

1210

1761

if (not hasattr(self, attrname) or

1211

1762

type_func(getattr(self, attrname, None))

1212

1763

!= type_func(value)):

1213

dbus_value = transform_func(type_func(value),

1214

variant_level

1215

=variant_level)

1216

self.PropertyChanged(dbus.String(dbus_name),

1217

dbus_value)

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1218

1779

setattr(self, attrname, value)

1219

1780

1220

1781

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

1221

1782

1222

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1223

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1224

1785

"ApprovalPending",

1225

type_func = bool)

1786

type_func=bool)

1226

1787

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

1227

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1228

1789

"LastEnabled")

1229

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

1230

type_func = lambda checker:

1231

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1232

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1233

1794

"LastCheckedOK")

1234

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1237

1798

datetime_to_dbus, "LastApprovalRequest")

1238

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1239

1800

"ApprovedByDefault")

1240

approval_delay = notifychangeproperty(dbus.UInt64,

1241

"ApprovalDelay",

1242

type_func =

1243

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1244

1804

approval_duration = notifychangeproperty(

1245

1805

dbus.UInt64, "ApprovalDuration",

1246

type_func = timedelta_to_milliseconds)

1806

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

1247

1807

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

1248

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

1249

type_func =

1250

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1251

1811

extended_timeout = notifychangeproperty(

1252

1812

dbus.UInt64, "ExtendedTimeout",

1253

type_func = timedelta_to_milliseconds)

1254

interval = notifychangeproperty(dbus.UInt64,

1255

"Interval",

1256

type_func =

1257

timedelta_to_milliseconds)

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1258

1817

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

1259

1818

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

1819

invalidate_only=True)

1820

1260

1821

del notifychangeproperty

1261

1822

1262

1823

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

1263

1824

try:

1264

1825

self.remove_from_connection()

1267

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1268

1829

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

1269

1830

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

1270

1271

def checker_callback(self, pid, condition, command,

1272

*args, **kwargs):

1273

self.checker_callback_tag = None

1274

self.checker = None

1275

if os.WIFEXITED(condition):

1276

exitstatus = os.WEXITSTATUS(condition)

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1277

1839

# Emit D-Bus signal

1278

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1279

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1280

1843

dbus.String(command))

1281

1844

else:

1282

1845

# Emit D-Bus signal

1283

1846

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

1284

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1285

1851

dbus.String(command))

1286

1287

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

1288

*args, **kwargs)

1289

1852

return ret

1853

1290

1854

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

1291

old_checker = self.checker

1292

if self.checker is not None:

1293

old_checker_pid = self.checker.pid

1294

else:

1295

old_checker_pid = None

1855

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

1296

1856

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

1297

1857

# Only if new checker process was started

1298

1858

if (self.checker is not None

1300

1860

# Emit D-Bus signal

1301

1861

self.CheckerStarted(self.current_checker_command)

1302

1862

return r

1303

1863

1304

1864

def _reset_approved(self):

1305

1865

self.approved = None

1306

1866

return False

1307

1867

1308

1868

def approve(self, value=True):

1309

self.send_changedstate()

1310

1869

self.approved = value

1311

gobject.timeout_add(timedelta_to_milliseconds

1312

(self.approval_duration),

1313

self._reset_approved)

1314

1315

## D-Bus methods, signals & properties

1316

_interface = "se.recompile.Mandos.Client"

1317

1318

## Interfaces

1319

1320

@dbus_interface_annotations(_interface)

1321

def _foo(self):

1322

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

1323

"false"}

1324

1325

## Signals

1326

1870

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

1871

* 1000), self._reset_approved)

1872

self.send_changedstate()

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1327

1880

# CheckerCompleted - signal

1328

1881

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

1329

1882

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

1330

1883

"D-Bus signal"

1331

1884

pass

1332

1885

1333

1886

# CheckerStarted - signal

1334

1887

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

1335

1888

def CheckerStarted(self, command):

1336

1889

"D-Bus signal"

1337

1890

pass

1338

1891

1339

1892

# PropertyChanged - signal

1893

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

1340

1894

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

1341

1895

def PropertyChanged(self, property, value):

1342

1896

"D-Bus signal"

1343

1897

pass

1344

1898

1345

1899

# GotSecret - signal

1346

1900

@dbus.service.signal(_interface)

1347

1901

def GotSecret(self):

1350

1904

server to mandos-client

1351

1905

"""

1352

1906

pass

1353

1907

1354

1908

# Rejected - signal

1355

1909

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

1356

1910

def Rejected(self, reason):

1357

1911

"D-Bus signal"

1358

1912

pass

1359

1913

1360

1914

# NeedApproval - signal

1361

1915

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

1362

1916

def NeedApproval(self, timeout, default):

1363

1917

"D-Bus signal"

1364

1918

return self.need_approval()

1365

1366

## Methods

1367

1919

1920

# Methods

1921

1368

1922

# Approve - method

1369

1923

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

1370

1924

def Approve(self, value):

1371

1925

self.approve(value)

1372

1926

1373

1927

# CheckedOK - method

1374

1928

@dbus.service.method(_interface)

1375

1929

def CheckedOK(self):

1376

1930

self.checked_ok()

1377

1931

1378

1932

# Enable - method

1933

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

1379

1934

@dbus.service.method(_interface)

1380

1935

def Enable(self):

1381

1936

"D-Bus method"

1382

1937

self.enable()

1383

1938

1384

1939

# StartChecker - method

1940

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

1385

1941

@dbus.service.method(_interface)

1386

1942

def StartChecker(self):

1387

1943

"D-Bus method"

1388

1944

self.start_checker()

1389

1945

1390

1946

# Disable - method

1947

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

1391

1948

@dbus.service.method(_interface)

1392

1949

def Disable(self):

1393

1950

"D-Bus method"

1394

1951

self.disable()

1395

1952

1396

1953

# StopChecker - method

1954

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

1397

1955

@dbus.service.method(_interface)

1398

1956

def StopChecker(self):

1399

1957

self.stop_checker()

1400

1401

## Properties

1402

1958

1959

# Properties

1960

1403

1961

# ApprovalPending - property

1404

1962

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

1405

1963

def ApprovalPending_dbus_property(self):

1406

1964

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

1407

1965

1408

1966

# ApprovedByDefault - property

1409

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1410

1969

access="readwrite")

1411

1970

def ApprovedByDefault_dbus_property(self, value=None):

1412

1971

if value is None: # get

1413

1972

return dbus.Boolean(self.approved_by_default)

1414

1973

self.approved_by_default = bool(value)

1415

1974

1416

1975

# ApprovalDelay - property

1417

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1418

1978

access="readwrite")

1419

1979

def ApprovalDelay_dbus_property(self, value=None):

1420

1980

if value is None: # get

1421

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1422

1983

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

1423

1984

1424

1985

# ApprovalDuration - property

1425

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1426

1988

access="readwrite")

1427

1989

def ApprovalDuration_dbus_property(self, value=None):

1428

1990

if value is None: # get

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

1991

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

1992

* 1000)

1431

1993

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

1432

1994

1433

1995

# Name - property

1996

@dbus_annotations(

1997

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

1434

1998

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

1435

1999

def Name_dbus_property(self):

1436

2000

return dbus.String(self.name)

1437

2001

1438

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1439

2005

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

1440

2006

def Fingerprint_dbus_property(self):

1441

2007

return dbus.String(self.fingerprint)

1442

2008

1443

2009

# Host - property

1444

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1445

2012

access="readwrite")

1446

2013

def Host_dbus_property(self, value=None):

1447

2014

if value is None: # get

1448

2015

return dbus.String(self.host)

1449

self.host = unicode(value)

1450

2016

self.host = str(value)

2017

1451

2018

# Created - property

2019

@dbus_annotations(

2020

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

1452

2021

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

1453

2022

def Created_dbus_property(self):

1454

2023

return datetime_to_dbus(self.created)

1455

2024

1456

2025

# LastEnabled - property

1457

2026

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

1458

2027

def LastEnabled_dbus_property(self):

1459

2028

return datetime_to_dbus(self.last_enabled)

1460

2029

1461

2030

# Enabled - property

1462

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1463

2033

access="readwrite")

1464

2034

def Enabled_dbus_property(self, value=None):

1465

2035

if value is None: # get

1468

2038

self.enable()

1469

2039

else:

1470

2040

self.disable()

1471

2041

1472

2042

# LastCheckedOK - property

1473

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1474

2045

access="readwrite")

1475

2046

def LastCheckedOK_dbus_property(self, value=None):

1476

2047

if value is not None:

1477

2048

self.checked_ok()

1478

2049

return

1479

2050

return datetime_to_dbus(self.last_checked_ok)

1480

2051

1481

2052

# LastCheckerStatus - property

1482

@dbus_service_property(_interface, signature="n",

1483

access="read")

2053

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

1484

2054

def LastCheckerStatus_dbus_property(self):

1485

2055

return dbus.Int16(self.last_checker_status)

1486

2056

1487

2057

# Expires - property

1488

2058

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

1489

2059

def Expires_dbus_property(self):

1490

2060

return datetime_to_dbus(self.expires)

1491

2061

1492

2062

# LastApprovalRequest - property

1493

2063

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

1494

2064

def LastApprovalRequest_dbus_property(self):

1495

2065

return datetime_to_dbus(self.last_approval_request)

1496

2066

1497

2067

# Timeout - property

1498

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1499

2070

access="readwrite")

1500

2071

def Timeout_dbus_property(self, value=None):

1501

2072

if value is None: # get

1502

return dbus.UInt64(self.timeout_milliseconds())

2073

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

2074

old_timeout = self.timeout

1503

2075

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

1504

# Reschedule timeout

2076

# Reschedule disabling

1505

2077

if self.enabled:

1506

2078

now = datetime.datetime.utcnow()

1507

time_to_die = timedelta_to_milliseconds(

1508

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

1509

if time_to_die <= 0:

2079

self.expires += self.timeout - old_timeout

2080

if self.expires <= now:

1510

2081

# The timeout has passed

1511

2082

self.disable()

1512

2083

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

1516

2084

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

1517

2085

is None):

1518

2086

return

1519

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1523

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1524

2092

# ExtendedTimeout - property

1525

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1526

2095

access="readwrite")

1527

2096

def ExtendedTimeout_dbus_property(self, value=None):

1528

2097

if value is None: # get

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1530

2100

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

1531

2101

1532

2102

# Interval - property

1533

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1534

2105

access="readwrite")

1535

2106

def Interval_dbus_property(self, value=None):

1536

2107

if value is None: # get

1537

return dbus.UInt64(self.interval_milliseconds())

2108

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

1538

2109

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

1539

2110

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

1540

2111

return

1541

2112

if self.enabled:

1542

2113

# Reschedule checker run

1543

gobject.source_remove(self.checker_initiator_tag)

1544

self.checker_initiator_tag = (gobject.timeout_add

1545

(value, self.start_checker))

1546

self.start_checker() # Start one now, too

1547

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1548

2119

# Checker - property

1549

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1550

2122

access="readwrite")

1551

2123

def Checker_dbus_property(self, value=None):

1552

2124

if value is None: # get

1553

2125

return dbus.String(self.checker_command)

1554

self.checker_command = unicode(value)

1555

2126

self.checker_command = str(value)

2127

1556

2128

# CheckerRunning - property

1557

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1558

2131

access="readwrite")

1559

2132

def CheckerRunning_dbus_property(self, value=None):

1560

2133

if value is None: # get

1563

2136

self.start_checker()

1564

2137

else:

1565

2138

self.stop_checker()

1566

2139

1567

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1568

2144

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

1569

2145

def ObjectPath_dbus_property(self):

1570

return self.dbus_object_path # is already a dbus.ObjectPath

1571

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1572

2148

# Secret = property

1573

@dbus_service_property(_interface, signature="ay",

1574

access="write", byte_arrays=True)

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1575

2156

def Secret_dbus_property(self, value):

1576

self.secret = str(value)

1577

2157

self.secret = bytes(value)

2158

1578

2159

del _interface

1579

2160

1580

2161

1583

2164

self._pipe = child_pipe

1584

2165

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

1585

2166

if not self._pipe.recv():

1586

raise KeyError()

1587

2167

raise KeyError(fpr)

2168

1588

2169

def __getattribute__(self, name):

1589

2170

if name == '_pipe':

1590

2171

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

1593

2174

if data[0] == 'data':

1594

2175

return data[1]

1595

2176

if data[0] == 'function':

2177

1596

2178

def func(*args, **kwargs):

1597

2179

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

1598

2180

return self._pipe.recv()[1]

2181

1599

2182

return func

1600

2183

1601

2184

def __setattr__(self, name, value):

1602

2185

if name == '_pipe':

1603

2186

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

1604

2187

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

1605

2188

1606

2189

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

1611

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1612

2191

"""A class to handle client connections.

1613

2192

1614

2193

Instantiated once for each connection to handle it.

1615

2194

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

1616

2195

1617

2196

def handle(self):

1618

2197

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

1619

2198

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

1620

unicode(self.client_address))

2199

str(self.client_address))

1621

2200

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

1622

2201

self.server.child_pipe.fileno())

1623

1624

session = (gnutls.connection

1625

.ClientSession(self.request,

1626

gnutls.connection

1627

.X509Credentials()))

1628

1629

# Note: gnutls.connection.X509Credentials is really a

1630

# generic GnuTLS certificate credentials object so long as

1631

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

1632

# here despite using OpenPGP certificates.

1633

1634

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

1635

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

1636

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

1637

# "+DHE-DSS"))

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1638

2209

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

1639

2210

priority = self.server.gnutls_priority

1640

2211

if priority is None:

1641

2212

priority = "NORMAL"

1642

(gnutls.library.functions

1643

.gnutls_priority_set_direct(session._c_object,

1644

priority, None))

1645

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1646

2217

# Start communication using the Mandos protocol

1647

2218

# Get protocol number

1648

2219

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

1649

2220

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

1650

2221

try:

1651

2222

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

1652

raise RuntimeError

2223

raise RuntimeError(line)

1653

2224

except (ValueError, IndexError, RuntimeError) as error:

1654

2225

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

1655

2226

return

1656

2227

1657

2228

# Start GnuTLS connection

1658

2229

try:

1659

2230

session.handshake()

1660

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1661

2232

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

1662

2233

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

1663

2234

# established. Just abandon the request.

1664

2235

return

1665

2236

logger.debug("Handshake succeeded")

1666

2237

1667

2238

approval_required = False

1668

2239

try:

1669

2240

try:

1670

fpr = self.fingerprint(self.peer_certificate

1671

(session))

1672

except (TypeError,

1673

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1674

2244

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

1675

2245

return

1676

2246

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

1677

2247

1678

2248

try:

1679

2249

client = ProxyClient(child_pipe, fpr,

1680

2250

self.client_address)

1681

2251

except KeyError:

1682

2252

return

1683

2253

1684

2254

if client.approval_delay:

1685

2255

delay = client.approval_delay

1686

2256

client.approvals_pending += 1

1687

2257

approval_required = True

1688

2258

1689

2259

while True:

1690

2260

if not client.enabled:

1691

2261

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

1692

client.name)

2262

client.name)

1693

2263

if self.server.use_dbus:

1694

2264

# Emit D-Bus signal

1695

2265

client.Rejected("Disabled")

1696

2266

return

1697

2267

1698

2268

if client.approved or not client.approval_delay:

1699

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1700

2270

break

1701

2271

elif client.approved is None:

1702

2272

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

1704

2274

if self.server.use_dbus:

1705

2275

# Emit D-Bus signal

1706

2276

client.NeedApproval(

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1709

2279

else:

1710

2280

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

1711

2281

client.name)

1713

2283

# Emit D-Bus signal

1714

2284

client.Rejected("Denied")

1715

2285

return

1716

1717

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1718

2288

time = datetime.datetime.now()

1719

2289

client.changedstate.acquire()

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

2290

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

1723

2291

client.changedstate.release()

1724

2292

time2 = datetime.datetime.now()

1725

2293

if (time2 - time) >= delay:

1735

2303

break

1736

2304

else:

1737

2305

delay -= time2 - time

1738

1739

sent_size = 0

1740

while sent_size < len(client.secret):

1741

try:

1742

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

1743

except gnutls.errors.GNUTLSError as error:

1744

logger.warning("gnutls send failed",

1745

exc_info=error)

1746

return

1747

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

1748

sent, len(client.secret)

1749

- (sent_size + sent))

1750

sent_size += sent

1751

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1752

2314

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

1753

2315

# bump the timeout using extended_timeout

1754

2316

client.bump_timeout(client.extended_timeout)

1755

2317

if self.server.use_dbus:

1756

2318

# Emit D-Bus signal

1757

2319

client.GotSecret()

1758

2320

1759

2321

finally:

1760

2322

if approval_required:

1761

2323

client.approvals_pending -= 1

1762

2324

try:

1763

2325

session.bye()

1764

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1765

2327

logger.warning("GnuTLS bye failed",

1766

2328

exc_info=error)

1767

2329

1768

2330

@staticmethod

1769

2331

def peer_certificate(session):

1770

2332

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

1771

2333

# If not an OpenPGP certificate...

1772

if (gnutls.library.functions

1773

.gnutls_certificate_type_get(session._c_object)

1774

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1775

# ...do the normal thing

1776

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1777

2338

list_size = ctypes.c_uint(1)

1778

cert_list = (gnutls.library.functions

1779

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1780

2340

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

1781

2341

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

1782

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

1783

" certificate")

2342

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

1784

2343

if list_size.value == 0:

1785

2344

return None

1786

2345

cert = cert_list[0]

1787

2346

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

1788

2347

1789

2348

@staticmethod

1790

2349

def fingerprint(openpgp):

1791

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1792

2351

# New GnuTLS "datum" with the OpenPGP public key

1793

datum = (gnutls.library.types

1794

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

1795

ctypes.POINTER

1796

(ctypes.c_ubyte)),

1797

ctypes.c_uint(len(openpgp))))

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1798

2356

# New empty GnuTLS certificate

1799

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1800

(gnutls.library.functions

1801

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1802

2359

# Import the OpenPGP public key into the certificate

1803

(gnutls.library.functions

1804

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

1805

gnutls.library.constants

1806

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1807

2362

# Verify the self signature in the key

1808

2363

crtverify = ctypes.c_uint()

1809

(gnutls.library.functions

1810

.gnutls_openpgp_crt_verify_self(crt, 0,

1811

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1812

2366

if crtverify.value != 0:

1813

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1814

raise (gnutls.errors.CertificateSecurityError

1815

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError(code

2369

=crtverify.value)

1816

2370

# New buffer for the fingerprint

1817

2371

buf = ctypes.create_string_buffer(20)

1818

2372

buf_len = ctypes.c_size_t()

1819

2373

# Get the fingerprint from the certificate into the buffer

1820

(gnutls.library.functions

1821

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

1822

ctypes.byref(buf_len)))

2374

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

2375

ctypes.byref(buf_len))

1823

2376

# Deinit the certificate

1824

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1825

2378

# Convert the buffer to a Python bytestring

1826

2379

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

1827

2380

# Convert the bytestring to hexadecimal notation

1831

2384

1832

2385

class MultiprocessingMixIn(object):

1833

2386

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

2387

1834

2388

def sub_process_main(self, request, address):

1835

2389

try:

1836

2390

self.finish_request(request, address)

1837

2391

except Exception:

1838

2392

self.handle_error(request, address)

1839

2393

self.close_request(request)

1840

2394

1841

2395

def process_request(self, request, address):

1842

2396

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

1843

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

1844

args = (request,

1845

address))

2397

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

2398

args=(request, address))

1846

2399

proc.start()

1847

2400

return proc

1848

2401

1849

2402

1850

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1851

2404

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

2405

1852

2406

def process_request(self, request, client_address):

1853

2407

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

1854

2408

1855

2409

This function creates a new pipe in self.pipe

1856

2410

"""

1857

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1858

2412

1859

2413

proc = MultiprocessingMixIn.process_request(self, request,

1860

2414

client_address)

1861

2415

self.child_pipe.close()

1862

2416

self.add_pipe(parent_pipe, proc)

1863

2417

1864

2418

def add_pipe(self, parent_pipe, proc):

1865

2419

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

1866

raise NotImplementedError

2420

raise NotImplementedError()

1867

2421

1868

2422

1869

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1870

2424

socketserver.TCPServer, object):

1871

2425

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

1872

2426

1873

2427

Attributes:

1874

2428

enabled: Boolean; whether this server is activated yet

1875

2429

interface: None or a network interface name (string)

1876

2430

use_ipv6: Boolean; to use IPv6 or not

1877

2431

"""

2432

1878

2433

def __init__(self, server_address, RequestHandlerClass,

1879

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

"""

1880

2440

self.interface = interface

1881

2441

if use_ipv6:

1882

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.

1883

2470

socketserver.TCPServer.__init__(self, server_address,

1884

2471

RequestHandlerClass)

2472

1885

2473

def server_bind(self):

1886

2474

"""This overrides the normal server_bind() function

1887

2475

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

1888

2476

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

2477

global SO_BINDTODEVICE

1889

2478

if self.interface is not None:

1890

2479

if SO_BINDTODEVICE is None:

1891

logger.error("SO_BINDTODEVICE does not exist;"

1892

" cannot bind to interface %s",

1893

self.interface)

1894

else:

1895

try:

1896

self.socket.setsockopt(socket.SOL_SOCKET,

1897

SO_BINDTODEVICE,

1898

str(self.interface

1899

+ '\0'))

1900

except socket.error as error:

1901

if error[0] == errno.EPERM:

1902

logger.error("No permission to"

1903

" bind to interface %s",

1904

self.interface)

1905

elif error[0] == errno.ENOPROTOOPT:

1906

logger.error("SO_BINDTODEVICE not available;"

1907

" cannot bind to interface %s",

1908

self.interface)

1909

else:

1910

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

1911

2501

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

1912

2502

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

1913

2503

if not self.server_address[0]:

1914

2504

if self.address_family == socket.AF_INET6:

1915

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

1916

2506

else:

1917

any_address = socket.INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

1918

2508

self.server_address = (any_address,

1919

2509

self.server_address[1])

1920

2510

elif not self.server_address[1]:

1921

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

1922

0)

2511

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

1923

2512

# if self.interface:

1924

2513

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

1925

2514

# 0, # port

1931

2520

1932

2521

class MandosServer(IPv6_TCPServer):

1933

2522

"""Mandos server.

1934

2523

1935

2524

Attributes:

1936

2525

clients: set of Client objects

1937

2526

gnutls_priority GnuTLS priority string

1938

2527

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

1939

1940

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

1941

2530

"""

2531

1942

2532

def __init__(self, server_address, RequestHandlerClass,

1943

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

1944

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

1945

2539

self.enabled = False

1946

2540

self.clients = clients

1947

2541

if self.clients is None:

1950

2544

self.gnutls_priority = gnutls_priority

1951

2545

IPv6_TCPServer.__init__(self, server_address,

1952

2546

RequestHandlerClass,

1953

interface = interface,

1954

use_ipv6 = use_ipv6)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

1955

2551

def server_activate(self):

1956

2552

if self.enabled:

1957

2553

return socketserver.TCPServer.server_activate(self)

1958

2554

1959

2555

def enable(self):

1960

2556

self.enabled = True

1961

2557

1962

2558

def add_pipe(self, parent_pipe, proc):

1963

2559

# Call "handle_ipc" for both data and EOF events

1964

gobject.io_add_watch(parent_pipe.fileno(),

1965

gobject.IO_IN | gobject.IO_HUP,

1966

functools.partial(self.handle_ipc,

1967

parent_pipe =

1968

parent_pipe,

1969

proc = proc))

1970

1971

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

1972

proc = None, client_object=None):

1973

condition_names = {

1974

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

1975

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

1976

# blocking).

1977

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

1978

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

1979

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

1980

# broken, usually for pipes and

1981

# sockets).

1982

}

1983

conditions_string = ' | '.join(name

1984

for cond, name in

1985

condition_names.iteritems()

1986

if cond & condition)

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

1987

2571

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

1988

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

2572

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

1989

2573

# Wait for other process to exit

1990

2574

proc.join()

1991

2575

return False

1992

2576

1993

2577

# Read a request from the child

1994

2578

request = parent_pipe.recv()

1995

2579

command = request[0]

1996

2580

1997

2581

if command == 'init':

1998

fpr = request[1]

2582

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

1999

2583

address = request[2]

2000

2001

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2002

2586

if c.fingerprint == fpr:

2003

2587

client = c

2004

2588

break

2011

2595

address[0])

2012

2596

parent_pipe.send(False)

2013

2597

return False

2014

2015

gobject.io_add_watch(parent_pipe.fileno(),

2016

gobject.IO_IN | gobject.IO_HUP,

2017

functools.partial(self.handle_ipc,

2018

parent_pipe =

2019

parent_pipe,

2020

proc = proc,

2021

client_object =

2022

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

2023

2606

parent_pipe.send(True)

2024

2607

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

2025

2608

# same fileno

2028

2611

funcname = request[1]

2029

2612

args = request[2]

2030

2613

kwargs = request[3]

2031

2614

2032

2615

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

2033

2616

funcname)(*args,

2034

**kwargs)))

2035

2617

**kwargs)))

2618

2036

2619

if command == 'getattr':

2037

2620

attrname = request[1]

2038

if callable(client_object.__getattribute__(attrname)):

2039

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2040

2624

else:

2041

parent_pipe.send(('data', client_object

2042

.__getattribute__(attrname)))

2043

2625

parent_pipe.send((

2626

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

2627

2044

2628

if command == 'setattr':

2045

2629

attrname = request[1]

2046

2630

value = request[2]

2047

2631

setattr(client_object, attrname, value)

2048

2632

2049

2633

return True

2050

2634

2051

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

2052

2735

def string_to_delta(interval):

2053

2736

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

2054

2737

2055

2738

>>> string_to_delta('7d')

2056

2739

datetime.timedelta(7)

2057

2740

>>> string_to_delta('60s')

2065

2748

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

2066

2749

datetime.timedelta(0, 330)

2067

2750

"""

2751

2752

try:

2753

return rfc3339_duration_to_delta(interval)

2754

except ValueError:

2755

pass

2756

2068

2757

timevalue = datetime.timedelta(0)

2069

2758

for s in interval.split():

2070

2759

try:

2071

suffix = unicode(s[-1])

2760

suffix = s[-1]

2072

2761

value = int(s[:-1])

2073

2762

if suffix == "d":

2074

2763

delta = datetime.timedelta(value)

2081

2770

elif suffix == "w":

2082

2771

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

2083

2772

else:

2084

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

2085

.format(suffix))

2086

except (ValueError, IndexError) as e:

2773

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

2774

except IndexError as e:

2087

2775

raise ValueError(*(e.args))

2088

2776

timevalue += delta

2089

2777

return timevalue

2090

2778

2091

2779

2092

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

2780

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

2093

2781

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

2094

2782

2095

2783

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

2096

2784

if os.fork():

2097

2785

sys.exit()

2105

2793

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

2106

2794

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

2107

2795

raise OSError(errno.ENODEV,

2108

"{0} not a character device"

2796

"{} not a character device"

2109

2797

.format(os.devnull))

2110

2798

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

2111

2799

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

2115

2803

2116

2804

2117

2805

def main():

2118

2806

2119

2807

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

2120

2808

# Parsing of options, both command line and config file

2121

2809

2122

2810

parser = argparse.ArgumentParser()

2123

2811

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

2124

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

2812

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

2125

2813

help="show version number and exit")

2126

2814

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

2127

2815

help="Bind to interface IF")

2133

2821

help="Run self-test")

2134

2822

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

2135

2823

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

2136

" to terminal")

2824

" to terminal", default=None)

2137

2825

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

2138

2826

help="Debug level for stdout output")

2139

2827

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

2146

2834

" files")

2147

2835

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

2148

2836

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

2149

" system bus interface")

2837

" system bus interface", default=None)

2150

2838

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

2151

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

2839

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

2840

default=None)

2152

2841

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

2153

2842

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

2154

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

2155

2847

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

2156

2848

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

2157

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

2158

2855

options = parser.parse_args()

2159

2856

2160

2857

if options.check:

2161

2858

import doctest

2162

doctest.testmod()

2163

sys.exit()

2164

2859

fail_count, test_count = doctest.testmod()

2860

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

2861

2165

2862

# Default values for config file for server-global settings

2166

server_defaults = { "interface": "",

2167

"address": "",

2168

"port": "",

2169

"debug": "False",

2170

"priority":

2171

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

2172

"servicename": "Mandos",

2173

"use_dbus": "True",

2174

"use_ipv6": "True",

2175

"debuglevel": "",

2176

"restore": "True",

2177

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

2178

}

2179

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

2180

2881

# Parse config file for server-global settings

2181

2882

server_config = configparser.SafeConfigParser(server_defaults)

2182

2883

del server_defaults

2183

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

2184

"mandos.conf"))

2884

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

2185

2885

# Convert the SafeConfigParser object to a dict

2186

2886

server_settings = server_config.defaults()

2187

2887

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

2188

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

2888

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

2889

"foreground", "zeroconf"):

2189

2890

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

2190

2891

option)

2191

2892

if server_settings["port"]:

2192

2893

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

2193

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

2194

2904

del server_config

2195

2905

2196

2906

# Override the settings from the config file with command line

2197

2907

# options, if set.

2198

2908

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

2199

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

2200

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

2201

"statedir"):

2909

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

2910

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

2911

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

2202

2912

value = getattr(options, option)

2203

2913

if value is not None:

2204

2914

server_settings[option] = value

2205

2915

del options

2206

2916

# Force all strings to be unicode

2207

2917

for option in server_settings.keys():

2208

if type(server_settings[option]) is str:

2209

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

2210

2928

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

2211

2929

2212

2930

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

2213

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

2214

2937

# For convenience

2215

2938

debug = server_settings["debug"]

2216

2939

debuglevel = server_settings["debuglevel"]

2218

2941

use_ipv6 = server_settings["use_ipv6"]

2219

2942

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

2220

2943

stored_state_file)

2221

2944

foreground = server_settings["foreground"]

2945

zeroconf = server_settings["zeroconf"]

2946

2222

2947

if debug:

2223

2948

initlogger(debug, logging.DEBUG)

2224

2949

else:

2227

2952

else:

2228

2953

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

2229

2954

initlogger(debug, level)

2230

2955

2231

2956

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

2232

syslogger.setFormatter(logging.Formatter

2233

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

2234

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

2235

.format(server_settings

2236

["servicename"])))

2237

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2238

2962

# Parse config file with clients

2239

2963

client_config = configparser.SafeConfigParser(Client

2240

2964

.client_defaults)

2241

2965

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

2242

2966

"clients.conf"))

2243

2967

2244

2968

global mandos_dbus_service

2245

2969

mandos_dbus_service = None

2246

2247

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

2248

server_settings["port"]),

2249

ClientHandler,

2250

interface=(server_settings["interface"]

2251

or None),

2252

use_ipv6=use_ipv6,

2253

gnutls_priority=

2254

server_settings["priority"],

2255

use_dbus=use_dbus)

2256

if not debug:

2257

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

2258

2987

try:

2259

pidfile = open(pidfilename, "w")

2988

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

2260

2989

except IOError as e:

2261

2990

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

2262

2991

exc_info=e)

2263

2264

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2265

2996

try:

2266

2997

uid = pwd.getpwnam(name).pw_uid

2267

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2268

2999

break

2269

3000

except KeyError:

2270

3001

continue

2274

3005

try:

2275

3006

os.setgid(gid)

2276

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2277

3011

except OSError as error:

2278

if error[0] != errno.EPERM:

2279

raise error

2280

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

2281

3017

if debug:

2282

3018

# Enable all possible GnuTLS debugging

2283

3019

2284

3020

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

2285

3021

# - GnuTLS manual

2286

gnutls.library.functions.gnutls_global_set_log_level(11)

2287

2288

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2289

3025

def debug_gnutls(level, string):

2290

3026

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

2291

2292

(gnutls.library.functions

2293

.gnutls_global_set_log_function(debug_gnutls))

2294

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2295

3030

# Redirect stdin so all checkers get /dev/null

2296

3031

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

2297

3032

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

2298

3033

if null > 2:

2299

3034

os.close(null)

2300

3035

2301

3036

# Need to fork before connecting to D-Bus

2302

if not debug:

3037

if not foreground:

2303

3038

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

2304

3039

daemon()

2305

2306

gobject.threads_init()

2307

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

2308

3045

global main_loop

2309

3046

# From the Avahi example code

2310

3047

DBusGMainLoop(set_as_default=True)

2311

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2312

3049

bus = dbus.SystemBus()

2313

3050

# End of Avahi example code

2314

3051

if use_dbus:

2315

3052

try:

2316

3053

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

2317

bus, do_not_queue=True)

2318

old_bus_name = (dbus.service.BusName

2319

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

2320

do_not_queue=True))

2321

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:

2322

3060

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

2323

3061

use_dbus = False

2324

3062

server_settings["use_dbus"] = False

2325

3063

tcp_server.use_dbus = False

2326

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2327

service = AvahiServiceToSyslog(name =

2328

server_settings["servicename"],

2329

servicetype = "_mandos._tcp",

2330

protocol = protocol, bus = bus)

2331

if server_settings["interface"]:

2332

service.interface = (if_nametoindex

2333

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

2334

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

2335

3075

global multiprocessing_manager

2336

3076

multiprocessing_manager = multiprocessing.Manager()

2337

3077

2338

3078

client_class = Client

2339

3079

if use_dbus:

2340

client_class = functools.partial(ClientDBusTransitional,

2341

bus = bus)

2342

3080

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

3081

2343

3082

client_settings = Client.config_parser(client_config)

2344

3083

old_client_settings = {}

2345

3084

clients_data = {}

2346

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

2347

3094

# Get client data and settings from last running state.

2348

3095

if server_settings["restore"]:

2349

3096

try:

2350

3097

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

2351

clients_data, old_client_settings = (pickle.load

2352

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

2353

3143

os.remove(stored_state_path)

2354

3144

except IOError as e:

2355

3145

if e.errno == errno.ENOENT:

2356

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

2357

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

3146

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

3147

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

2358

3148

else:

2359

3149

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

2360

3150

exc_info=e)

2361

3151

raise

2362

3152

except EOFError as e:

2363

3153

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

2364

"EOFError:", exc_info=e)

2365

3154

"EOFError:",

3155

exc_info=e)

3156

2366

3157

with PGPEngine() as pgp:

2367

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

2368

3163

# Decide which value to use after restoring saved state.

2369

3164

# We have three different values: Old config file,

2370

3165

# new config file, and saved state.

2375

3170

# For each value in new config, check if it

2376

3171

# differs from the old config value (Except for

2377

3172

# the "secret" attribute)

2378

if (name != "secret" and

2379

value != old_client_settings[client_name]

2380

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2381

3176

client[name] = value

2382

3177

except KeyError:

2383

3178

pass

2384

3179

2385

3180

# Clients who has passed its expire date can still be

2386

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2387

3182

# whose checker succeeded before we stored its state is

2388

3183

# assumed to have successfully run all checkers during

2389

3184

# downtime.

2391

3186

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

2392

3187

if not client["last_checked_ok"]:

2393

3188

logger.warning(

2394

"disabling client {0} - Client never "

2395

"performed a successful checker"

2396

.format(client_name))

3189

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2397

3192

client["enabled"] = False

2398

3193

elif client["last_checker_status"] != 0:

2399

3194

logger.warning(

2400

"disabling client {0} - Client "

2401

"last checker failed with error code {1}"

2402

.format(client_name,

2403

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

2404

3200

client["enabled"] = False

2405

3201

else:

2406

client["expires"] = (datetime.datetime

2407

.utcnow()

2408

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2409

3205

logger.debug("Last checker succeeded,"

2410

" keeping {0} enabled"

2411

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2412

3208

try:

2413

client["secret"] = (

2414

pgp.decrypt(client["encrypted_secret"],

2415

client_settings[client_name]

2416

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2417

3212

except PGPError:

2418

3213

# If decryption fails, we use secret from new settings

2419

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

2420

.format(client_name))

2421

client["secret"] = (

2422

client_settings[client_name]["secret"])

2423

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2424

3219

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

2425

3220

for client_name in (set(old_client_settings)

2426

3221

- set(client_settings)):

2428

3223

for client_name in (set(client_settings)

2429

3224

- set(old_client_settings)):

2430

3225

clients_data[client_name] = client_settings[client_name]

2431

3226

2432

3227

# Create all client objects

2433

for client_name, client in clients_data.iteritems():

3228

for client_name, client in clients_data.items():

2434

3229

tcp_server.clients[client_name] = client_class(

2435

name = client_name, settings = client)

2436

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2437

3234

if not tcp_server.clients:

2438

3235

logger.warning("No clients defined")

2439

2440

if not debug:

2441

try:

2442

with pidfile:

2443

pid = os.getpid()

2444

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

2445

del pidfile

2446

except IOError:

2447

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

2448

pidfilename, pid)

2449

except NameError:

2450

# "pidfile" was never created

2451

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

2452

3247

del pidfilename

2453

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

2454

2455

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

2456

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

2457

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

2458

3253

if use_dbus:

2459

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2460

3258

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

3259

2461

3260

def __init__(self):

2462

3261

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

3262

2463

3263

_interface = "se.recompile.Mandos"

2464

2465

@dbus_interface_annotations(_interface)

2466

def _foo(self):

2467

return { "org.freedesktop.DBus.Property"

2468

".EmitsChangedSignal":

2469

"false"}

2470

3264

2471

3265

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

2472

3266

def ClientAdded(self, objpath):

2473

3267

"D-Bus signal"

2474

3268

pass

2475

3269

2476

3270

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

2477

3271

def ClientNotFound(self, fingerprint, address):

2478

3272

"D-Bus signal"

2479

3273

pass

2480

3274

3275

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

3276

"true"})

2481

3277

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

2482

3278

def ClientRemoved(self, objpath, name):

2483

3279

"D-Bus signal"

2484

3280

pass

2485

3281

3282

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

3283

"true"})

2486

3284

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

2487

3285

def GetAllClients(self):

2488

3286

"D-Bus method"

2489

return dbus.Array(c.dbus_object_path

2490

for c in

2491

tcp_server.clients.itervalues())

2492

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

2493

3292

@dbus.service.method(_interface,

2494

3293

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

2495

3294

def GetAllClientsWithProperties(self):

2496

3295

"D-Bus method"

2497

3296

return dbus.Dictionary(

2498

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

2499

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()},

2500

3300

signature="oa{sv}")

2501

3301

2502

3302

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

2503

3303

def RemoveClient(self, object_path):

2504

3304

"D-Bus method"

2505

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2506

3306

if c.dbus_object_path == object_path:

2507

3307

del tcp_server.clients[c.name]

2508

3308

c.remove_from_connection()

2509

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2510

3310

c.disable(quiet=True)

2511

# Emit D-Bus signal

2512

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2513

3313

return

2514

3314

raise KeyError(object_path)

2515

3315

2516

3316

del _interface

2517

2518

class MandosDBusServiceTransitional(MandosDBusService):

2519

__metaclass__ = AlternateDBusNamesMetaclass

2520

mandos_dbus_service = MandosDBusServiceTransitional()

2521

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

3354

mandos_dbus_service = MandosDBusService()

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

2522

3361

def cleanup():

2523

3362

"Cleanup function; run on exit"

2524

service.cleanup()

2525

2526

multiprocessing.active_children()

3363

if zeroconf:

3364

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2527

3368

if not (tcp_server.clients or client_settings):

2528

3369

return

2529

3370

2530

3371

# Store client before exiting. Secrets are encrypted with key

2531

3372

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

2532

3373

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

2533

3374

clients = {}

2534

3375

with PGPEngine() as pgp:

2535

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2536

3377

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

2537

3378

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

2538

3379

key)

2539

3380

client_dict = {}

2540

3381

2541

3382

# A list of attributes that can not be pickled

2542

3383

# + secret.

2543

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

2544

"checker"))

2545

for name, typ in (inspect.getmembers

2546

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2547

3388

exclude.add(name)

2548

3389

2549

3390

client_dict["encrypted_secret"] = (client

2550

3391

.encrypted_secret)

2551

3392

for attr in client.client_structure:

2552

3393

if attr not in exclude:

2553

3394

client_dict[attr] = getattr(client, attr)

2554

3395

2555

3396

clients[client.name] = client_dict

2556

3397

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

2557

3398

2558

3399

try:

2559

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

2560

prefix="clients-",

2561

dir=os.path.dirname

2562

(stored_state_path))

2563

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

2564

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

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

2565

3409

os.rename(tempname, stored_state_path)

2566

3410

except (IOError, OSError) as e:

2567

3411

if not debug:

2570

3414

except NameError:

2571

3415

pass

2572

3416

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

2573

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

3417

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

2574

3418

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

2575

3419

else:

2576

3420

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

2577

3421

exc_info=e)

2578

raise e

2579

3422

raise

3423

2580

3424

# Delete all clients, and settings from config

2581

3425

while tcp_server.clients:

2582

3426

name, client = tcp_server.clients.popitem()

2583

3427

if use_dbus:

2584

3428

client.remove_from_connection()

2585

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2586

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2587

3432

if use_dbus:

2588

# Emit D-Bus signal

2589

mandos_dbus_service.ClientRemoved(client

2590

.dbus_object_path,

2591

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2592

3434

client_settings.clear()

2593

3435

2594

3436

atexit.register(cleanup)

2595

2596

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2597

3439

if use_dbus:

2598

# Emit D-Bus signal

2599

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2600

3442

# Need to initiate checking of clients

2601

3443

if client.enabled:

2602

3444

client.init_checker()

2603

3445

2604

3446

tcp_server.enable()

2605

3447

tcp_server.server_activate()

2606

3448

2607

3449

# Find out what port we got

2608

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

3450

if zeroconf:

3451

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

2609

3452

if use_ipv6:

2610

3453

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

2611

3454

" flowinfo %d, scope_id %d",

2613

3456

else: # IPv4

2614

3457

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

2615

3458

*tcp_server.socket.getsockname())

2616

2617

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

2618

3459

3460

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

3461

2619

3462

try:

2620

# From the Avahi example code

2621

try:

2622

service.activate()

2623

except dbus.exceptions.DBusException as error:

2624

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

2625

cleanup()

2626

sys.exit(1)

2627

# End of Avahi example code

2628

2629

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

2630

lambda *args, **kwargs:

2631

(tcp_server.handle_request

2632

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

2633

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

2634

3478

logger.debug("Starting main loop")

2635

3479

main_loop.run()

2636

3480

except AvahiError as error:

2645

3489

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

2646

3490

cleanup()

2647

3491

3492

2648

3493

if __name__ == '__main__':

2649

3494

main()