/mandos/release : revision 237.7.475

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

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

212

303

213

304

class AvahiError(Exception):

214

305

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

215

306

self.value = value

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

307

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

308

**kwargs)

309

219

310

220

311

class AvahiServiceError(AvahiError):

221

312

pass

222

313

314

223

315

class AvahiGroupError(AvahiError):

224

316

pass

225

317

226

318

227

319

class AvahiService(object):

228

320

"""An Avahi (Zeroconf) service.

229

321

230

322

Attributes:

231

323

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

232

324

Used to optionally bind to the specified interface.

233

325

name: string; Example: 'Mandos'

234

326

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

235

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

327

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

236

328

port: integer; what port to announce

237

329

TXT: list of strings; TXT record for the service

238

330

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

244

336

server: D-Bus Server

245

337

bus: dbus.SystemBus()

246

338

"""

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

def rename(self):

365

366

def rename(self, remove=True):

266

367

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

267

368

if self.rename_count >= self.max_renames:

268

369

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

269

370

" after %i retries, exiting.",

270

371

self.rename_count)

271

372

raise AvahiServiceError("Too many renames")

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

274

376

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

275

377

self.name)

276

self.remove()

378

if remove:

379

self.remove()

277

380

try:

278

381

self.add()

279

382

except dbus.exceptions.DBusException as error:

280

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

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

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

284

392

def remove(self):

285

393

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

286

394

if self.entry_group_state_changed_match is not None:

288

396

self.entry_group_state_changed_match = None

289

397

if self.group is not None:

290

398

self.group.Reset()

399

291

400

def add(self):

292

401

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

293

402

self.remove()

310

419

dbus.UInt16(self.port),

311

420

avahi.string_array_to_txt_array(self.TXT))

312

421

self.group.Commit()

422

313

423

def entry_group_state_changed(self, state, error):

314

424

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

315

425

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

316

426

317

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

318

428

logger.debug("Zeroconf service established.")

319

429

elif state == avahi.ENTRY_GROUP_COLLISION:

321

431

self.rename()

322

432

elif state == avahi.ENTRY_GROUP_FAILURE:

323

433

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

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

434

str(error))

435

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

436

327

437

def cleanup(self):

328

438

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

329

439

if self.group is not None:

334

444

pass

335

445

self.group = None

336

446

self.remove()

447

337

448

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

338

449

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

339

450

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

340

bad_states = { avahi.SERVER_INVALID:

341

"Zeroconf server invalid",

342

avahi.SERVER_REGISTERING: None,

343

avahi.SERVER_COLLISION:

344

"Zeroconf server name collision",

345

avahi.SERVER_FAILURE:

346

"Zeroconf server failure" }

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

}

347

457

if state in bad_states:

348

458

if bad_states[state] is not None:

349

459

if error is None:

352

462

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

353

463

self.cleanup()

354

464

elif state == avahi.SERVER_RUNNING:

355

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)

356

477

else:

357

478

if error is None:

358

479

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

359

480

else:

360

481

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

482

361

483

def activate(self):

362

484

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

363

485

if self.server is None:

367

489

follow_name_owner_changes=True),

368

490

avahi.DBUS_INTERFACE_SERVER)

369

491

self.server.connect_to_signal("StateChanged",

370

self.server_state_changed)

492

self.server_state_changed)

371

493

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

372

494

495

373

496

class AvahiServiceToSyslog(AvahiService):

374

def rename(self):

497

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

375

498

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

376

ret = AvahiService.rename(self)

377

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

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

381

503

return ret

382

504

383

def timedelta_to_milliseconds(td):

384

"Convert a datetime.timedelta() to milliseconds"

385

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

386

+ (td.seconds * 1000)

387

+ (td.microseconds // 1000))

388

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

779

389

780

class Client(object):

390

781

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

391

782

392

783

Attributes:

393

784

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

394

785

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

396

787

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

397

788

to see if the client lives.

398

789

'None' if no process is running.

399

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

400

791

checker_command: string; External command which is run to check

401

792

if client lives. %() expansions are done at

402

793

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

403

794

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

404

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

405

796

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

406

797

client_structure: Object describing what attributes a client has

407

798

and is used for storing the client at exit

408

799

current_checker_command: string; current running checker_command

409

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

410

801

enabled: bool()

411

802

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

412

803

uniquely identify the client

417

808

last_checker_status: integer between 0 and 255 reflecting exit

418

809

status of last checker. -1 reflects crashed

419

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

420

813

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

421

814

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

422

815

D-Bus identifiers

427

820

runtime_expansions: Allowed attributes for runtime expansion.

428

821

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

429

822

disabled, or None

823

server_settings: The server_settings dict from main()

430

824

"""

431

825

432

826

runtime_expansions = ("approval_delay", "approval_duration",

433

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

434

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

827

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

828

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

829

"last_approval_request", "last_checked_ok",

435

830

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

436

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

437

"extended_timeout": "15m",

438

"interval": "2m",

439

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

440

"host": "",

441

"approval_delay": "0s",

442

"approval_duration": "1s",

443

"approved_by_default": "True",

444

"enabled": "True",

445

}

446

447

def timeout_milliseconds(self):

448

"Return the 'timeout' attribute in milliseconds"

449

return timedelta_to_milliseconds(self.timeout)

450

451

def extended_timeout_milliseconds(self):

452

"Return the 'extended_timeout' attribute in milliseconds"

453

return timedelta_to_milliseconds(self.extended_timeout)

454

455

def interval_milliseconds(self):

456

"Return the 'interval' attribute in milliseconds"

457

return timedelta_to_milliseconds(self.interval)

458

459

def approval_delay_milliseconds(self):

460

return timedelta_to_milliseconds(self.approval_delay)

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

}

461

842

462

843

@staticmethod

463

844

def config_parser(config):

471

852

for client_name in config.sections():

472

853

section = dict(config.items(client_name))

473

854

client = settings[client_name] = {}

474

855

475

856

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

476

857

# Reformat values from string types to Python types

477

858

client["approved_by_default"] = config.getboolean(

478

859

client_name, "approved_by_default")

479

860

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

480

861

"enabled")

481

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

482

866

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

483

867

.replace(" ", ""))

484

868

if "secret" in section:

485

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

869

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

870

.encode("utf-8"),

871

"base64")

486

872

elif "secfile" in section:

487

873

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

488

874

(section["secfile"])),

489

875

"rb") as secfile:

490

876

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

491

877

else:

492

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

493

% section)

878

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

879

.format(section))

494

880

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

495

881

client["extended_timeout"] = string_to_delta(

496

882

section["extended_timeout"])

503

889

client["last_approval_request"] = None

504

890

client["last_checked_ok"] = None

505

891

client["last_checker_status"] = -2

506

892

507

893

return settings

508

509

510

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

511

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

512

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

513

attribute."""

894

895

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

514

896

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

515

900

# adding all client settings

516

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

517

902

setattr(self, setting, value)

518

903

519

904

if self.enabled:

520

905

if not hasattr(self, "last_enabled"):

521

906

self.last_enabled = datetime.datetime.utcnow()

525

910

else:

526

911

self.last_enabled = None

527

912

self.expires = None

528

913

529

914

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

530

# Uppercase and remove spaces from fingerprint for later

531

# comparison purposes with return value from the fingerprint()

532

# function

533

915

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

534

916

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

535

917

datetime.datetime.utcnow())

542

924

self.current_checker_command = None

543

925

self.approved = None

544

926

self.approvals_pending = 0

545

self.changedstate = (multiprocessing_manager

546

.Condition(multiprocessing_manager

547

.Lock()))

548

self.client_structure = [attr for attr in

549

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

550

931

if not attr.startswith("_")]

551

932

self.client_structure.append("client_structure")

552

553

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

554

lambda obj:

555

isinstance(obj,

556

property)):

933

934

for name, t in inspect.getmembers(

935

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

557

936

if not name.startswith("_"):

558

937

self.client_structure.append(name)

559

938

560

939

# Send notice to process children that client state has changed

561

940

def send_changedstate(self):

562

941

with self.changedstate:

563

942

self.changedstate.notify_all()

564

943

565

944

def enable(self):

566

945

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

567

946

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

568

947

# Already enabled

569

948

return

570

self.send_changedstate()

571

949

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

572

950

self.enabled = True

573

951

self.last_enabled = datetime.datetime.utcnow()

574

952

self.init_checker()

575

953

self.send_changedstate()

954

576

955

def disable(self, quiet=True):

577

956

"""Disable this client."""

578

957

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

579

958

return False

580

959

if not quiet:

581

self.send_changedstate()

582

if not quiet:

583

960

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

584

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

585

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)

586

963

self.disable_initiator_tag = None

587

964

self.expires = None

588

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

589

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)

590

967

self.checker_initiator_tag = None

591

968

self.stop_checker()

592

969

self.enabled = False

593

# 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

594

973

return False

595

974

596

975

def __del__(self):

597

976

self.disable()

598

977

599

978

def init_checker(self):

600

979

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

601

980

# and every interval from then on.

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

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)

605

986

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

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

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)

609

991

# Also start a new checker *right now*.

610

992

self.start_checker()

611

612

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

613

996

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

614

997

self.checker_callback_tag = None

615

998

self.checker = None

616

if os.WIFEXITED(condition):

617

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

618

1006

if self.last_checker_status == 0:

619

1007

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

620

1008

vars(self))

621

1009

self.checked_ok()

622

1010

else:

623

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

624

vars(self))

1011

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

625

1012

else:

626

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

627

1015

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

628

1016

vars(self))

629

1017

return False

1018

630

1019

def checked_ok(self):

631

1020

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

632

1021

self.last_checked_ok = datetime.datetime.utcnow()

633

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

634

1024

self.bump_timeout()

635

1025

636

1026

def bump_timeout(self, timeout=None):

637

1027

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

638

1028

if timeout is None:

639

1029

timeout = self.timeout

640

1030

if self.disable_initiator_tag is not None:

641

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

1032

self.disable_initiator_tag = None

642

1033

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

646

1036

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

647

1037

648

1038

def need_approval(self):

649

1039

self.last_approval_request = datetime.datetime.utcnow()

650

1040

651

1041

def start_checker(self):

652

1042

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

653

1043

654

1044

If a checker already exists, leave it running and do

655

1045

nothing."""

656

1046

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

657

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

658

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

659

# client would inevitably timeout, since no checker would get

660

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

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

661

1051

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

662

1052

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

663

1053

# should be.

664

665

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

666

try:

667

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

668

except (AttributeError, OSError) as error:

669

if (isinstance(error, OSError)

670

and error.errno != errno.ECHILD):

671

raise error

672

else:

673

if pid:

674

logger.warning("Checker was a zombie")

675

gobject.source_remove(self.checker_callback_tag)

676

self.checker_callback(pid, status,

677

self.current_checker_command)

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

678

1059

# Start a new checker if needed

679

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}

680

1065

try:

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

self.checker_command, exc_info=error)

698

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

699

1072

self.current_checker_command = command

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

self.checker = subprocess.Popen(command,

708

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

720

except OSError as error:

721

logger.error("Failed to start subprocess",

722

exc_info=error)

723

# 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

724

1099

return True

725

1100

726

1101

def stop_checker(self):

727

1102

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

728

1103

if self.checker_callback_tag:

729

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

730

1105

self.checker_callback_tag = None

731

1106

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

732

1107

return

733

1108

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

734

try:

735

self.checker.terminate()

736

#time.sleep(0.5)

737

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

738

# self.checker.kill()

739

except OSError as error:

740

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

741

raise

1109

self.checker.terminate()

742

1110

self.checker = None

743

1111

744

1112

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

747

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

748

1118

become properties on the D-Bus.

749

1119

750

1120

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

751

1121

and with one argument by "Set".

752

1122

753

1123

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

754

1124

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

755

1125

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

758

1128

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

759

1129

if byte_arrays and signature != "ay":

760

1130

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

761

" signature %r" % signature)

1131

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

1132

762

1133

def decorator(func):

763

1134

func._dbus_is_property = True

764

1135

func._dbus_interface = dbus_interface

767

1138

func._dbus_name = func.__name__

768

1139

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

769

1140

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

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

771

1142

return func

1143

772

1144

return decorator

773

1145

774

1146

775

1147

def dbus_interface_annotations(dbus_interface):

776

"""Decorator for marking functions returning interface annotations.

777

1148

"""Decorator for marking functions returning interface annotations

1149

778

1150

Usage:

779

1151

780

1152

@dbus_interface_annotations("org.example.Interface")

781

1153

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

782

1154

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

783

1155

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

784

1156

"false"}

785

1157

"""

1158

786

1159

def decorator(func):

787

1160

func._dbus_is_interface = True

788

1161

func._dbus_interface = dbus_interface

789

1162

func._dbus_name = dbus_interface

790

1163

return func

1164

791

1165

return decorator

792

1166

793

1167

794

1168

def dbus_annotations(annotations):

795

1169

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

796

1170

Usage:

797

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

798

1175

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

799

1176

access="r")

800

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

801

"org.freedesktop.DBus.Property."

802

"EmitsChangedSignal": "false"})

803

1177

def Property_dbus_property(self):

804

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

805

1181

"""

1182

806

1183

def decorator(func):

807

1184

func._dbus_annotations = annotations

808

1185

return func

1186

809

1187

return decorator

810

1188

811

1189

812

1190

class DBusPropertyException(dbus.exceptions.DBusException):

813

1191

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

814

1192

"""

815

def __unicode__(self):

816

return unicode(str(self))

1193

pass

817

1194

818

1195

819

1196

class DBusPropertyAccessException(DBusPropertyException):

828

1205

pass

829

1206

830

1207

831

class DBusObjectWithProperties(dbus.service.Object):

832

"""A D-Bus object with properties.

833

834

Classes inheriting from this can use the dbus_service_property

835

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

836

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

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.

837

1213

"""

838

1214

839

1215

@staticmethod

840

1216

def _is_dbus_thing(thing):

841

1217

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

842

1218

843

1219

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

844

1220

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

845

1221

"""

846

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

1222

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

847

1223

False)

848

1224

849

1225

def _get_all_dbus_things(self, thing):

850

1226

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

851

1227

"""

852

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

853

name),

1228

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

854

1229

athing.__get__(self))

855

1230

for cls in self.__class__.__mro__

856

1231

for name, athing in

857

inspect.getmembers(cls,

858

self._is_dbus_thing(thing)))

859

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

860

1305

def _get_dbus_property(self, interface_name, property_name):

861

1306

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

862

1307

property with the specified name and interface.

863

1308

"""

864

for cls in self.__class__.__mro__:

865

for name, value in (inspect.getmembers

866

(cls,

867

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

868

1312

if (value._dbus_name == property_name

869

1313

and value._dbus_interface == interface_name):

870

1314

return value.__get__(self)

871

1315

872

1316

# No such property

873

raise DBusPropertyNotFound(self.dbus_object_path + ":"

874

+ interface_name + "."

875

+ property_name)

876

877

@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",

878

1331

out_signature="v")

879

1332

def Get(self, interface_name, property_name):

880

1333

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

886

1339

if not hasattr(value, "variant_level"):

887

1340

return value

888

1341

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

889

1342

890

1343

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

891

1344

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

892

1345

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

898

1351

# The byte_arrays option is not supported yet on

899

1352

# signatures other than "ay".

900

1353

if prop._dbus_signature != "ay":

901

raise ValueError

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

902

1357

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

903

1358

for byte in value))

904

1359

prop(value)

905

906

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

907

1363

out_signature="a{sv}")

908

1364

def GetAll(self, interface_name):

909

1365

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

910

1366

standard.

911

1367

912

1368

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

913

1369

"""

914

1370

properties = {}

924

1380

if not hasattr(value, "variant_level"):

925

1381

properties[name] = value

926

1382

continue

927

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

928

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

929

1385

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

930

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

931

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

932

1396

out_signature="s",

933

1397

path_keyword='object_path',

934

1398

connection_keyword='connection')

935

1399

def Introspect(self, object_path, connection):

936

1400

"""Overloading of standard D-Bus method.

937

1401

938

1402

Inserts property tags and interface annotation tags.

939

1403

"""

940

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

941

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

942

1407

try:

943

1408

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

1409

944

1410

def make_tag(document, name, prop):

945

1411

e = document.createElement("property")

946

1412

e.setAttribute("name", name)

947

1413

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

948

1414

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

949

1415

return e

1416

950

1417

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

951

1418

# Add property tags

952

1419

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

955

1422

if prop._dbus_interface

956

1423

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

957

1424

if_tag.appendChild(tag)

958

# Add annotation tags

959

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

960

for tag in if_tag.getElementsByTagName(typ):

961

annots = dict()

962

for name, prop in (self.

963

_get_all_dbus_things(typ)):

964

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

965

and prop._dbus_interface

966

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

967

annots.update(getattr

968

(prop,

969

"_dbus_annotations",

970

{}))

971

for name, value in annots.iteritems():

972

ann_tag = document.createElement(

973

"annotation")

974

ann_tag.setAttribute("name", name)

975

ann_tag.setAttribute("value", value)

976

tag.appendChild(ann_tag)

977

# Add interface annotation tags

978

for annotation, value in dict(

979

itertools.chain(

980

*(annotations().iteritems()

981

for name, annotations in

982

self._get_all_dbus_things("interface")

983

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

984

))).iteritems():

985

ann_tag = document.createElement("annotation")

986

ann_tag.setAttribute("name", annotation)

987

ann_tag.setAttribute("value", value)

988

if_tag.appendChild(ann_tag)

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)

989

1441

# Add the names to the return values for the

990

1442

# "org.freedesktop.DBus.Properties" methods

991

1443

if (if_tag.getAttribute("name")

1010

1462

return xmlstring

1011

1463

1012

1464

1013

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

1014

1537

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

1015

1538

if dt is None:

1016

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

1017

return dbus.String(dt.isoformat(),

1018

variant_level=variant_level)

1019

1020

1021

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1022

.__metaclass__):

1023

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

1024

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

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

1025

1565

"""

1026

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

1027

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

1028

# methods, signals, or properties in them

1029

old_interface_names = []

1030

for base in (b for b in bases

1031

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

1032

# Go though all attributes of the base class

1033

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

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

1034

1574

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

1035

1575

# with the wrong interface name

1036

1576

if (not hasattr(attribute, "_dbus_interface")

1037

or not attribute._dbus_interface

1038

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

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1039

1579

continue

1040

1580

# Create an alternate D-Bus interface name based on

1041

1581

# the current name

1042

alt_interface = (attribute._dbus_interface

1043

.replace("se.recompile.Mandos",

1044

"se.bsnet.fukt.Mandos"))

1045

if alt_interface != attribute._dbus_interface:

1046

old_interface_names.append(alt_interface)

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1584

interface_names.add(alt_interface)

1047

1585

# Is this a D-Bus signal?

1048

1586

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

1049

# Extract the original non-method function by

1050

# black magic

1051

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(

1052

1591

zip(attribute.func_code.co_freevars,

1053

attribute.__closure__))["func"]

1054

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

1055

1599

# Create a new, but exactly alike, function

1056

1600

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

1057

1601

# with the alternate D-Bus interface name

1058

new_function = (dbus.service.signal

1059

(alt_interface,

1060

attribute._dbus_signature)

1061

(types.FunctionType(

1062

nonmethod_func.func_code,

1063

nonmethod_func.func_globals,

1064

nonmethod_func.func_name,

1065

nonmethod_func.func_defaults,

1066

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1067

1606

# Copy annotations, if any

1068

1607

try:

1069

new_function._dbus_annotations = (

1070

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1071

1610

except AttributeError:

1072

1611

pass

1612

1073

1613

# Define a creator of a function to call both the

1074

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

1075

# 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

1076

1617

def fixscope(func1, func2):

1077

1618

"""This function is a scope container to pass

1078

1619

func1 and func2 to the "call_both" function

1079

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1080

1623

def call_both(*args, **kwargs):

1081

1624

"""This function will emit two D-Bus

1082

1625

signals by calling func1 and func2"""

1083

1626

func1(*args, **kwargs)

1084

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

1085

1634

return call_both

1086

1635

# Create the "call_both" function and add it to

1087

1636

# the class

1088

attr[attrname] = fixscope(attribute,

1089

new_function)

1637

attr[attrname] = fixscope(attribute, new_function)

1090

1638

# Is this a D-Bus method?

1091

1639

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

1092

1640

# Create a new, but exactly alike, function

1093

1641

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

1094

1642

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

1095

1643

# to the class.

1096

attr[attrname] = (dbus.service.method

1097

(alt_interface,

1098

attribute._dbus_in_signature,

1099

attribute._dbus_out_signature)

1100

(types.FunctionType

1101

(attribute.func_code,

1102

attribute.func_globals,

1103

attribute.func_name,

1104

attribute.func_defaults,

1105

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1106

1650

# Copy annotations, if any

1107

1651

try:

1108

attr[attrname]._dbus_annotations = (

1109

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1110

1654

except AttributeError:

1111

1655

pass

1112

1656

# Is this a D-Bus property?

1115

1659

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

1116

1660

# property with the alternate D-Bus interface

1117

1661

# name. Add it to the class.

1118

attr[attrname] = (dbus_service_property

1119

(alt_interface,

1120

attribute._dbus_signature,

1121

attribute._dbus_access,

1122

attribute

1123

._dbus_get_args_options

1124

["byte_arrays"])

1125

(types.FunctionType

1126

(attribute.func_code,

1127

attribute.func_globals,

1128

attribute.func_name,

1129

attribute.func_defaults,

1130

attribute.func_closure)))

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

1131

1668

# Copy annotations, if any

1132

1669

try:

1133

attr[attrname]._dbus_annotations = (

1134

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1135

1672

except AttributeError:

1136

1673

pass

1137

1674

# Is this a D-Bus interface?

1140

1677

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

1141

1678

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

1142

1679

# to the class.

1143

attr[attrname] = (dbus_interface_annotations

1144

(alt_interface)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1151

# Deprecate all old interfaces

1152

basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1153

for old_interface_name in old_interface_names:

1154

@dbus_interface_annotations(old_interface_name)

1155

def func(self):

1156

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

1157

# Find an unused name

1158

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

1159

itertools.count()):

1160

if aname not in attr:

1161

attr[aname] = func

1162

break

1163

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

1164

1165

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

1166

1714

class ClientDBus(Client, DBusObjectWithProperties):

1167

1715

"""A Client class using D-Bus

1168

1716

1169

1717

Attributes:

1170

1718

dbus_object_path: dbus.ObjectPath

1171

1719

bus: dbus.SystemBus()

1172

1720

"""

1173

1721

1174

1722

runtime_expansions = (Client.runtime_expansions

1175

+ ("dbus_object_path",))

1176

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1177

1727

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

1178

1179

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

1728

1729

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

1180

1730

self.bus = bus

1181

1731

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

1182

1732

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

1183

1733

# the D-Bus

1184

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1185

1735

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

1186

1736

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

1187

self.dbus_object_path = (dbus.ObjectPath

1188

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1189

1739

DBusObjectWithProperties.__init__(self, self.bus,

1190

1740

self.dbus_object_path)

1191

1192

def notifychangeproperty(transform_func,

1193

dbus_name, type_func=lambda x: x,

1194

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

1195

1747

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

1196

1748

its changes to DBus.

1197

1749

1198

1750

transform_fun: Function that takes a value and a variant_level

1199

1751

and transforms it to a D-Bus type.

1200

1752

dbus_name: D-Bus name of the variable

1202

1754

to the D-Bus. Default: no transform

1203

1755

variant_level: D-Bus variant level. Default: 1

1204

1756

"""

1205

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

1757

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

1758

1206

1759

def setter(self, value):

1207

1760

if hasattr(self, "dbus_object_path"):

1208

1761

if (not hasattr(self, attrname) or

1209

1762

type_func(getattr(self, attrname, None))

1210

1763

!= type_func(value)):

1211

dbus_value = transform_func(type_func(value),

1212

variant_level

1213

=variant_level)

1214

self.PropertyChanged(dbus.String(dbus_name),

1215

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

1216

1779

setattr(self, attrname, value)

1217

1780

1218

1781

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

1219

1220

1782

1221

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1222

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1223

1785

"ApprovalPending",

1224

type_func = bool)

1786

type_func=bool)

1225

1787

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

1226

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1227

1789

"LastEnabled")

1228

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

1229

type_func = lambda checker:

1230

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1231

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1232

1794

"LastCheckedOK")

1233

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1236

1798

datetime_to_dbus, "LastApprovalRequest")

1237

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1238

1800

"ApprovedByDefault")

1239

approval_delay = notifychangeproperty(dbus.UInt64,

1240

"ApprovalDelay",

1241

type_func =

1242

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1243

1804

approval_duration = notifychangeproperty(

1244

1805

dbus.UInt64, "ApprovalDuration",

1245

type_func = timedelta_to_milliseconds)

1806

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

1246

1807

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

1247

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

1248

type_func =

1249

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1250

1811

extended_timeout = notifychangeproperty(

1251

1812

dbus.UInt64, "ExtendedTimeout",

1252

type_func = timedelta_to_milliseconds)

1253

interval = notifychangeproperty(dbus.UInt64,

1254

"Interval",

1255

type_func =

1256

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)

1257

1817

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

1258

1818

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

1819

invalidate_only=True)

1820

1259

1821

del notifychangeproperty

1260

1822

1261

1823

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

1262

1824

try:

1263

1825

self.remove_from_connection()

1266

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1267

1829

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

1268

1830

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

1269

1270

def checker_callback(self, pid, condition, command,

1271

*args, **kwargs):

1272

self.checker_callback_tag = None

1273

self.checker = None

1274

if os.WIFEXITED(condition):

1275

exitstatus = os.WEXITSTATUS(condition)

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:

1276

1839

# Emit D-Bus signal

1277

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1278

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1279

1843

dbus.String(command))

1280

1844

else:

1281

1845

# Emit D-Bus signal

1282

1846

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

1283

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1284

1851

dbus.String(command))

1285

1286

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

1287

*args, **kwargs)

1288

1852

return ret

1853

1289

1854

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

1290

old_checker = self.checker

1291

if self.checker is not None:

1292

old_checker_pid = self.checker.pid

1293

else:

1294

old_checker_pid = None

1855

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

1295

1856

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

1296

1857

# Only if new checker process was started

1297

1858

if (self.checker is not None

1299

1860

# Emit D-Bus signal

1300

1861

self.CheckerStarted(self.current_checker_command)

1301

1862

return r

1302

1863

1303

1864

def _reset_approved(self):

1304

1865

self.approved = None

1305

1866

return False

1306

1867

1307

1868

def approve(self, value=True):

1308

self.send_changedstate()

1309

1869

self.approved = value

1310

gobject.timeout_add(timedelta_to_milliseconds

1311

(self.approval_duration),

1312

self._reset_approved)

1313

1314

1315

## D-Bus methods, signals & properties

1316

_interface = "se.recompile.Mandos.Client"

1317

1318

## Interfaces

1319

1320

@dbus_interface_annotations(_interface)

1321

def _foo(self):

1322

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

1323

"false"}

1324

1325

## Signals

1326

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

return

1746

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

1747

sent, len(client.secret)

1748

- (sent_size + sent))

1749

sent_size += sent

1750

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

1751

2314

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

1752

2315

# bump the timeout using extended_timeout

1753

2316

client.bump_timeout(client.extended_timeout)

1754

2317

if self.server.use_dbus:

1755

2318

# Emit D-Bus signal

1756

2319

client.GotSecret()

1757

2320

1758

2321

finally:

1759

2322

if approval_required:

1760

2323

client.approvals_pending -= 1

1761

2324

try:

1762

2325

session.bye()

1763

except gnutls.errors.GNUTLSError as error:

1764

logger.warning("GnuTLS bye failed")

1765

2326

except gnutls.Error as error:

2327

logger.warning("GnuTLS bye failed",

2328

exc_info=error)

2329

1766

2330

@staticmethod

1767

2331

def peer_certificate(session):

1768

2332

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

1769

2333

# If not an OpenPGP certificate...

1770

if (gnutls.library.functions

1771

.gnutls_certificate_type_get(session._c_object)

1772

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1773

# ...do the normal thing

1774

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1775

2338

list_size = ctypes.c_uint(1)

1776

cert_list = (gnutls.library.functions

1777

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1778

2340

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

1779

2341

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

1780

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

1781

" certificate")

2342

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

1782

2343

if list_size.value == 0:

1783

2344

return None

1784

2345

cert = cert_list[0]

1785

2346

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

1786

2347

1787

2348

@staticmethod

1788

2349

def fingerprint(openpgp):

1789

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1790

2351

# New GnuTLS "datum" with the OpenPGP public key

1791

datum = (gnutls.library.types

1792

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

1793

ctypes.POINTER

1794

(ctypes.c_ubyte)),

1795

ctypes.c_uint(len(openpgp))))

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

1796

2356

# New empty GnuTLS certificate

1797

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1798

(gnutls.library.functions

1799

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1800

2359

# Import the OpenPGP public key into the certificate

1801

(gnutls.library.functions

1802

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

1803

gnutls.library.constants

1804

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1805

2362

# Verify the self signature in the key

1806

2363

crtverify = ctypes.c_uint()

1807

(gnutls.library.functions

1808

.gnutls_openpgp_crt_verify_self(crt, 0,

1809

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1810

2366

if crtverify.value != 0:

1811

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1812

raise (gnutls.errors.CertificateSecurityError

1813

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1814

2369

# New buffer for the fingerprint

1815

2370

buf = ctypes.create_string_buffer(20)

1816

2371

buf_len = ctypes.c_size_t()

1817

2372

# Get the fingerprint from the certificate into the buffer

1818

(gnutls.library.functions

1819

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

1820

ctypes.byref(buf_len)))

2373

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

2374

ctypes.byref(buf_len))

1821

2375

# Deinit the certificate

1822

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

gnutls.openpgp_crt_deinit(crt)

1823

2377

# Convert the buffer to a Python bytestring

1824

2378

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

1825

2379

# Convert the bytestring to hexadecimal notation

1829

2383

1830

2384

class MultiprocessingMixIn(object):

1831

2385

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

2386

1832

2387

def sub_process_main(self, request, address):

1833

2388

try:

1834

2389

self.finish_request(request, address)

1835

2390

except Exception:

1836

2391

self.handle_error(request, address)

1837

2392

self.close_request(request)

1838

2393

1839

2394

def process_request(self, request, address):

1840

2395

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

1841

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

1842

args = (request,

1843

address))

2396

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

2397

args=(request, address))

1844

2398

proc.start()

1845

2399

return proc

1846

2400

1847

2401

1848

2402

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1849

2403

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

2404

1850

2405

def process_request(self, request, client_address):

1851

2406

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

1852

2407

1853

2408

This function creates a new pipe in self.pipe

1854

2409

"""

1855

2410

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1856

2411

1857

2412

proc = MultiprocessingMixIn.process_request(self, request,

1858

2413

client_address)

1859

2414

self.child_pipe.close()

1860

2415

self.add_pipe(parent_pipe, proc)

1861

2416

1862

2417

def add_pipe(self, parent_pipe, proc):

1863

2418

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

1864

raise NotImplementedError

2419

raise NotImplementedError()

1865

2420

1866

2421

1867

2422

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1868

2423

socketserver.TCPServer, object):

1869

2424

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

1870

2425

1871

2426

Attributes:

1872

2427

enabled: Boolean; whether this server is activated yet

1873

2428

interface: None or a network interface name (string)

1874

2429

use_ipv6: Boolean; to use IPv6 or not

1875

2430

"""

2431

1876

2432

def __init__(self, server_address, RequestHandlerClass,

1877

interface=None, use_ipv6=True):

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

2436

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

2437

creating a new one with socket.socket().

2438

"""

1878

2439

self.interface = interface

1879

2440

if use_ipv6:

1880

2441

self.address_family = socket.AF_INET6

2442

if socketfd is not None:

2443

# Save the file descriptor

2444

self.socketfd = socketfd

2445

# Save the original socket.socket() function

2446

self.socket_socket = socket.socket

2447

2448

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

2449

#

2450

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

2451

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

2452

# patching socket.socket.)

2453

#

2454

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

2455

@functools.wraps(socket.socket)

2456

def socket_wrapper(*args, **kwargs):

2457

# Restore original function so subsequent calls are

2458

# not affected.

2459

socket.socket = self.socket_socket

2460

del self.socket_socket

2461

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

2462

# saved file descriptor.

2463

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

2464

# Replace socket.socket() function with wrapper

2465

socket.socket = socket_wrapper

2466

# The socketserver.TCPServer.__init__ will call

2467

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

2468

# socket_wrapper(), if socketfd was set.

1881

2469

socketserver.TCPServer.__init__(self, server_address,

1882

2470

RequestHandlerClass)

2471

1883

2472

def server_bind(self):

1884

2473

"""This overrides the normal server_bind() function

1885

2474

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

1886

2475

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

2476

global SO_BINDTODEVICE

1887

2477

if self.interface is not None:

1888

2478

if SO_BINDTODEVICE is None:

1889

logger.error("SO_BINDTODEVICE does not exist;"

1890

" cannot bind to interface %s",

1891

self.interface)

1892

else:

1893

try:

1894

self.socket.setsockopt(socket.SOL_SOCKET,

1895

SO_BINDTODEVICE,

1896

str(self.interface

1897

+ '\0'))

1898

except socket.error as error:

1899

if error[0] == errno.EPERM:

1900

logger.error("No permission to"

1901

" bind to interface %s",

1902

self.interface)

1903

elif error[0] == errno.ENOPROTOOPT:

1904

logger.error("SO_BINDTODEVICE not available;"

1905

" cannot bind to interface %s",

1906

self.interface)

1907

else:

1908

raise

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1909

2500

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

1910

2501

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

1911

2502

if not self.server_address[0]:

1912

2503

if self.address_family == socket.AF_INET6:

1913

any_address = "::" # in6addr_any

2504

any_address = "::" # in6addr_any

1914

2505

else:

1915

any_address = socket.INADDR_ANY

2506

any_address = "0.0.0.0" # INADDR_ANY

1916

2507

self.server_address = (any_address,

1917

2508

self.server_address[1])

1918

2509

elif not self.server_address[1]:

1919

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

1920

0)

2510

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

1921

2511

# if self.interface:

1922

2512

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

1923

2513

# 0, # port

1929

2519

1930

2520

class MandosServer(IPv6_TCPServer):

1931

2521

"""Mandos server.

1932

2522

1933

2523

Attributes:

1934

2524

clients: set of Client objects

1935

2525

gnutls_priority GnuTLS priority string

1936

2526

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

1937

1938

Assumes a gobject.MainLoop event loop.

2527

2528

Assumes a GLib.MainLoop event loop.

1939

2529

"""

2530

1940

2531

def __init__(self, server_address, RequestHandlerClass,

1941

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

1942

gnutls_priority=None, use_dbus=True):

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

1943

2538

self.enabled = False

1944

2539

self.clients = clients

1945

2540

if self.clients is None:

1948

2543

self.gnutls_priority = gnutls_priority

1949

2544

IPv6_TCPServer.__init__(self, server_address,

1950

2545

RequestHandlerClass,

1951

interface = interface,

1952

use_ipv6 = use_ipv6)

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

1953

2550

def server_activate(self):

1954

2551

if self.enabled:

1955

2552

return socketserver.TCPServer.server_activate(self)

1956

2553

1957

2554

def enable(self):

1958

2555

self.enabled = True

1959

2556

1960

2557

def add_pipe(self, parent_pipe, proc):

1961

2558

# Call "handle_ipc" for both data and EOF events

1962

gobject.io_add_watch(parent_pipe.fileno(),

1963

gobject.IO_IN | gobject.IO_HUP,

1964

functools.partial(self.handle_ipc,

1965

parent_pipe =

1966

parent_pipe,

1967

proc = proc))

1968

1969

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

1970

proc = None, client_object=None):

1971

condition_names = {

1972

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

1973

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

1974

# blocking).

1975

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

1976

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

1977

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

1978

# broken, usually for pipes and

1979

# sockets).

1980

}

1981

conditions_string = ' | '.join(name

1982

for cond, name in

1983

condition_names.iteritems()

1984

if cond & condition)

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

1985

2570

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

1986

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

2571

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

1987

2572

# Wait for other process to exit

1988

2573

proc.join()

1989

2574

return False

1990

2575

1991

2576

# Read a request from the child

1992

2577

request = parent_pipe.recv()

1993

2578

command = request[0]

1994

2579

1995

2580

if command == 'init':

1996

fpr = request[1]

2581

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

1997

2582

address = request[2]

1998

1999

for c in self.clients.itervalues():

2583

2584

for c in self.clients.values():

2000

2585

if c.fingerprint == fpr:

2001

2586

client = c

2002

2587

break

2009

2594

address[0])

2010

2595

parent_pipe.send(False)

2011

2596

return False

2012

2013

gobject.io_add_watch(parent_pipe.fileno(),

2014

gobject.IO_IN | gobject.IO_HUP,

2015

functools.partial(self.handle_ipc,

2016

parent_pipe =

2017

parent_pipe,

2018

proc = proc,

2019

client_object =

2020

client))

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2021

2605

parent_pipe.send(True)

2022

2606

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

2023

2607

# same fileno

2026

2610

funcname = request[1]

2027

2611

args = request[2]

2028

2612

kwargs = request[3]

2029

2613

2030

2614

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

2031

2615

funcname)(*args,

2032

**kwargs)))

2033

2616

**kwargs)))

2617

2034

2618

if command == 'getattr':

2035

2619

attrname = request[1]

2036

if callable(client_object.__getattribute__(attrname)):

2037

parent_pipe.send(('function',))

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2038

2623

else:

2039

parent_pipe.send(('data', client_object

2040

.__getattribute__(attrname)))

2041

2624

parent_pipe.send((

2625

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

2626

2042

2627

if command == 'setattr':

2043

2628

attrname = request[1]

2044

2629

value = request[2]

2045

2630

setattr(client_object, attrname, value)

2046

2631

2047

2632

return True

2048

2633

2049

2634

2635

def rfc3339_duration_to_delta(duration):

2636

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

2637

2638

>>> rfc3339_duration_to_delta("P7D")

2639

datetime.timedelta(7)

2640

>>> rfc3339_duration_to_delta("PT60S")

2641

datetime.timedelta(0, 60)

2642

>>> rfc3339_duration_to_delta("PT60M")

2643

datetime.timedelta(0, 3600)

2644

>>> rfc3339_duration_to_delta("PT24H")

2645

datetime.timedelta(1)

2646

>>> rfc3339_duration_to_delta("P1W")

2647

datetime.timedelta(7)

2648

>>> rfc3339_duration_to_delta("PT5M30S")

2649

datetime.timedelta(0, 330)

2650

>>> rfc3339_duration_to_delta("P1DT3M20S")

2651

datetime.timedelta(1, 200)

2652

"""

2653

2654

# Parsing an RFC 3339 duration with regular expressions is not

2655

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

2656

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

2657

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

2658

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

2659

# avoid excessive use of external libraries.

2660

2661

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

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2667

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

2668

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

2669

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

2670

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

2671

datetime.timedelta(seconds=1),

2672

frozenset((token_end, )))

2673

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

2674

datetime.timedelta(minutes=1),

2675

frozenset((token_second, token_end)))

2676

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

2677

datetime.timedelta(hours=1),

2678

frozenset((token_minute, token_end)))

2679

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

2680

None,

2681

frozenset((token_hour, token_minute,

2682

token_second)))

2683

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

2684

datetime.timedelta(days=1),

2685

frozenset((token_time, token_end)))

2686

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

2687

datetime.timedelta(weeks=4),

2688

frozenset((token_day, token_end)))

2689

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

2690

datetime.timedelta(weeks=52),

2691

frozenset((token_month, token_end)))

2692

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

2693

datetime.timedelta(weeks=1),

2694

frozenset((token_end, )))

2695

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

2696

frozenset((token_year, token_month,

2697

token_day, token_time,

2698

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2702

found_token = None

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2707

# Loop until end token is found

2708

while found_token is not token_end:

2709

# Search for any currently valid tokens

2710

for token in followers:

2711

match = token.regexp.match(s)

2712

if match is not None:

2713

# Token found

2714

if token.value is not None:

2715

# Value found, parse digits

2716

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

2717

# Add to value so far

2718

value += factor * token.value

2719

# Strip token from string

2720

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

2721

# Go to found token

2722

found_token = token

2723

# Set valid next tokens

2724

followers = found_token.followers

2725

break

2726

else:

2727

# No currently valid tokens were found

2728

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

2729

.format(duration))

2730

# End token found

2731

return value

2732

2733

2050

2734

def string_to_delta(interval):

2051

2735

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

2052

2736

2053

2737

>>> string_to_delta('7d')

2054

2738

datetime.timedelta(7)

2055

2739

>>> string_to_delta('60s')

2063

2747

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

2064

2748

datetime.timedelta(0, 330)

2065

2749

"""

2750

2751

try:

2752

return rfc3339_duration_to_delta(interval)

2753

except ValueError:

2754

pass

2755

2066

2756

timevalue = datetime.timedelta(0)

2067

2757

for s in interval.split():

2068

2758

try:

2069

suffix = unicode(s[-1])

2759

suffix = s[-1]

2070

2760

value = int(s[:-1])

2071

2761

if suffix == "d":

2072

2762

delta = datetime.timedelta(value)

2079

2769

elif suffix == "w":

2080

2770

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

2081

2771

else:

2082

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

2083

except (ValueError, IndexError) as e:

2772

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

2773

except IndexError as e:

2084

2774

raise ValueError(*(e.args))

2085

2775

timevalue += delta

2086

2776

return timevalue

2087

2777

2088

2778

2089

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

2779

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

2090

2780

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

2091

2781

2092

2782

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

2093

2783

if os.fork():

2094

2784

sys.exit()

2102

2792

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

2103

2793

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

2104

2794

raise OSError(errno.ENODEV,

2105

"%s not a character device"

2106

% os.devnull)

2795

"{} not a character device"

2796

.format(os.devnull))

2107

2797

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

2108

2798

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

2109

2799

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

2112

2802

2113

2803

2114

2804

def main():

2115

2805

2116

2806

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

2117

2807

# Parsing of options, both command line and config file

2118

2808

2119

2809

parser = argparse.ArgumentParser()

2120

2810

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

2121

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

2811

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

2122

2812

help="show version number and exit")

2123

2813

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

2124

2814

help="Bind to interface IF")

2130

2820

help="Run self-test")

2131

2821

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

2132

2822

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

2133

" to terminal")

2823

" to terminal", default=None)

2134

2824

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

2135

2825

help="Debug level for stdout output")

2136

2826

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

2143

2833

" files")

2144

2834

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

2145

2835

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

2146

" system bus interface")

2836

" system bus interface", default=None)

2147

2837

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

2148

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

2838

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

2839

default=None)

2149

2840

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

2150

2841

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

2151

" state")

2842

" state", default=None)

2843

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

2844

help="Specify a file descriptor to a network"

2845

" socket to use instead of creating one")

2152

2846

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

2153

2847

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

2154

2848

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

2849

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

2850

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

2851

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

2852

default=None)

2853

2155

2854

options = parser.parse_args()

2156

2855

2157

2856

if options.check:

2158

2857

import doctest

2159

doctest.testmod()

2160

sys.exit()

2161

2858

fail_count, test_count = doctest.testmod()

2859

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

2860

2162

2861

# Default values for config file for server-global settings

2163

server_defaults = { "interface": "",

2164

"address": "",

2165

"port": "",

2166

"debug": "False",

2167

"priority":

2168

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

2169

"servicename": "Mandos",

2170

"use_dbus": "True",

2171

"use_ipv6": "True",

2172

"debuglevel": "",

2173

"restore": "True",

2174

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

2175

}

2176

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2177

2880

# Parse config file for server-global settings

2178

2881

server_config = configparser.SafeConfigParser(server_defaults)

2179

2882

del server_defaults

2180

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

2181

"mandos.conf"))

2883

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

2182

2884

# Convert the SafeConfigParser object to a dict

2183

2885

server_settings = server_config.defaults()

2184

2886

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

2185

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

2887

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

2888

"foreground", "zeroconf"):

2186

2889

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

2187

2890

option)

2188

2891

if server_settings["port"]:

2189

2892

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

2190

2893

"port")

2894

if server_settings["socket"]:

2895

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

2896

"socket")

2897

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

2898

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

2899

# happen with a supplied network socket.

2900

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

2901

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

2902

["socket"])

2191

2903

del server_config

2192

2904

2193

2905

# Override the settings from the config file with command line

2194

2906

# options, if set.

2195

2907

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

2196

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

2197

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

2198

"statedir"):

2908

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

2909

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

2910

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

2199

2911

value = getattr(options, option)

2200

2912

if value is not None:

2201

2913

server_settings[option] = value

2202

2914

del options

2203

2915

# Force all strings to be unicode

2204

2916

for option in server_settings.keys():

2205

if type(server_settings[option]) is str:

2206

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

2917

if isinstance(server_settings[option], bytes):

2918

server_settings[option] = (server_settings[option]

2919

.decode("utf-8"))

2920

# Force all boolean options to be boolean

2921

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

2922

"foreground", "zeroconf"):

2923

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

2924

# Debug implies foreground

2925

if server_settings["debug"]:

2926

server_settings["foreground"] = True

2207

2927

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

2208

2928

2209

2929

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

2210

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2211

2936

# For convenience

2212

2937

debug = server_settings["debug"]

2213

2938

debuglevel = server_settings["debuglevel"]

2215

2940

use_ipv6 = server_settings["use_ipv6"]

2216

2941

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

2217

2942

stored_state_file)

2218

2943

foreground = server_settings["foreground"]

2944

zeroconf = server_settings["zeroconf"]

2945

2219

2946

if debug:

2220

2947

initlogger(debug, logging.DEBUG)

2221

2948

else:

2224

2951

else:

2225

2952

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

2226

2953

initlogger(debug, level)

2227

2954

2228

2955

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

2229

syslogger.setFormatter(logging.Formatter

2230

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

2231

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

2232

% server_settings["servicename"]))

2233

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2234

2961

# Parse config file with clients

2235

2962

client_config = configparser.SafeConfigParser(Client

2236

2963

.client_defaults)

2237

2964

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

2238

2965

"clients.conf"))

2239

2966

2240

2967

global mandos_dbus_service

2241

2968

mandos_dbus_service = None

2242

2243

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

2244

server_settings["port"]),

2245

ClientHandler,

2246

interface=(server_settings["interface"]

2247

or None),

2248

use_ipv6=use_ipv6,

2249

gnutls_priority=

2250

server_settings["priority"],

2251

use_dbus=use_dbus)

2252

if not debug:

2253

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

2969

2970

socketfd = None

2971

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

2972

socketfd = server_settings["socket"]

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2981

if not foreground:

2982

pidfilename = "/run/mandos.pid"

2983

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

2984

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

2985

pidfile = None

2254

2986

try:

2255

pidfile = open(pidfilename, "w")

2256

except IOError:

2257

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

2258

2259

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

2987

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

2988

except IOError as e:

2989

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

2990

exc_info=e)

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2260

2995

try:

2261

2996

uid = pwd.getpwnam(name).pw_uid

2262

gid = pwd.getpwnam(name).pw_gid

2997

gid = pwd.getpwnam(group).pw_gid

2263

2998

break

2264

2999

except KeyError:

2265

3000

continue

2269

3004

try:

2270

3005

os.setgid(gid)

2271

3006

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

2272

3010

except OSError as error:

2273

if error[0] != errno.EPERM:

2274

raise error

2275

3011

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

3012

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

3013

if error.errno != errno.EPERM:

3014

raise

3015

2276

3016

if debug:

2277

3017

# Enable all possible GnuTLS debugging

2278

3018

2279

3019

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

2280

3020

# - GnuTLS manual

2281

gnutls.library.functions.gnutls_global_set_log_level(11)

2282

2283

@gnutls.library.types.gnutls_log_func

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2284

3024

def debug_gnutls(level, string):

2285

3025

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

2286

2287

(gnutls.library.functions

2288

.gnutls_global_set_log_function(debug_gnutls))

2289

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2290

3029

# Redirect stdin so all checkers get /dev/null

2291

3030

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

2292

3031

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

2293

3032

if null > 2:

2294

3033

os.close(null)

2295

3034

2296

3035

# Need to fork before connecting to D-Bus

2297

if not debug:

3036

if not foreground:

2298

3037

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

2299

3038

daemon()

2300

2301

gobject.threads_init()

2302

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2303

3044

global main_loop

2304

3045

# From the Avahi example code

2305

3046

DBusGMainLoop(set_as_default=True)

2306

main_loop = gobject.MainLoop()

3047

main_loop = GLib.MainLoop()

2307

3048

bus = dbus.SystemBus()

2308

3049

# End of Avahi example code

2309

3050

if use_dbus:

2310

3051

try:

2311

3052

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

2312

bus, do_not_queue=True)

2313

old_bus_name = (dbus.service.BusName

2314

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

2315

do_not_queue=True))

2316

except dbus.exceptions.NameExistsException as e:

2317

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

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

3059

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

2318

3060

use_dbus = False

2319

3061

server_settings["use_dbus"] = False

2320

3062

tcp_server.use_dbus = False

2321

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2322

service = AvahiServiceToSyslog(name =

2323

server_settings["servicename"],

2324

servicetype = "_mandos._tcp",

2325

protocol = protocol, bus = bus)

2326

if server_settings["interface"]:

2327

service.interface = (if_nametoindex

2328

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

2329

3063

if zeroconf:

3064

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

3070

if server_settings["interface"]:

3071

service.interface = if_nametoindex(

3072

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

3073

2330

3074

global multiprocessing_manager

2331

3075

multiprocessing_manager = multiprocessing.Manager()

2332

3076

2333

3077

client_class = Client

2334

3078

if use_dbus:

2335

client_class = functools.partial(ClientDBusTransitional,

2336

bus = bus)

2337

3079

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

3080

2338

3081

client_settings = Client.config_parser(client_config)

2339

3082

old_client_settings = {}

2340

3083

clients_data = {}

2341

3084

3085

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

3086

global wnull

3087

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

3088

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

3089

# mode

3090

if debug or not foreground:

3091

wnull.close()

3092

2342

3093

# Get client data and settings from last running state.

2343

3094

if server_settings["restore"]:

2344

3095

try:

2345

3096

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

2346

clients_data, old_client_settings = (pickle.load

2347

(stored_state))

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2348

3142

os.remove(stored_state_path)

2349

3143

except IOError as e:

2350

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

2351

.format(e))

2352

if e.errno != errno.ENOENT:

3144

if e.errno == errno.ENOENT:

3145

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

3146

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

3147

else:

3148

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

3149

exc_info=e)

2353

3150

raise

2354

3151

except EOFError as e:

2355

3152

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

2356

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

2357

3153

"EOFError:",

3154

exc_info=e)

3155

2358

3156

with PGPEngine() as pgp:

2359

for client_name, client in clients_data.iteritems():

3157

for client_name, client in clients_data.items():

3158

# Skip removed clients

3159

if client_name not in client_settings:

3160

continue

3161

2360

3162

# Decide which value to use after restoring saved state.

2361

3163

# We have three different values: Old config file,

2362

3164

# new config file, and saved state.

2367

3169

# For each value in new config, check if it

2368

3170

# differs from the old config value (Except for

2369

3171

# the "secret" attribute)

2370

if (name != "secret" and

2371

value != old_client_settings[client_name]

2372

[name]):

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2373

3175

client[name] = value

2374

3176

except KeyError:

2375

3177

pass

2376

3178

2377

3179

# Clients who has passed its expire date can still be

2378

# enabled if its last checker was successful. Clients

3180

# enabled if its last checker was successful. A Client

2379

3181

# whose checker succeeded before we stored its state is

2380

3182

# assumed to have successfully run all checkers during

2381

3183

# downtime.

2383

3185

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

2384

3186

if not client["last_checked_ok"]:

2385

3187

logger.warning(

2386

"disabling client {0} - Client never "

2387

"performed a successful checker"

2388

.format(client_name))

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2389

3191

client["enabled"] = False

2390

3192

elif client["last_checker_status"] != 0:

2391

3193

logger.warning(

2392

"disabling client {0} - Client "

2393

"last checker failed with error code {1}"

2394

.format(client_name,

2395

client["last_checker_status"]))

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2396

3199

client["enabled"] = False

2397

3200

else:

2398

client["expires"] = (datetime.datetime

2399

.utcnow()

2400

+ client["timeout"])

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2401

3204

logger.debug("Last checker succeeded,"

2402

" keeping {0} enabled"

2403

.format(client_name))

3205

" keeping {} enabled".format(

3206

client_name))

2404

3207

try:

2405

client["secret"] = (

2406

pgp.decrypt(client["encrypted_secret"],

2407

client_settings[client_name]

2408

["secret"]))

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2409

3211

except PGPError:

2410

3212

# If decryption fails, we use secret from new settings

2411

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

2412

.format(client_name))

2413

client["secret"] = (

2414

client_settings[client_name]["secret"])

3213

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

3214

client_name))

3215

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

3216

["secret"])

2415

3217

2416

2417

3218

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

2418

3219

for client_name in (set(old_client_settings)

2419

3220

- set(client_settings)):

2423

3224

clients_data[client_name] = client_settings[client_name]

2424

3225

2425

3226

# Create all client objects

2426

for client_name, client in clients_data.iteritems():

3227

for client_name, client in clients_data.items():

2427

3228

tcp_server.clients[client_name] = client_class(

2428

name = client_name, settings = client)

2429

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2430

3233

if not tcp_server.clients:

2431

3234

logger.warning("No clients defined")

2432

2433

if not debug:

2434

try:

2435

with pidfile:

2436

pid = os.getpid()

2437

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

2438

del pidfile

2439

except IOError:

2440

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

2441

pidfilename, pid)

2442

except NameError:

2443

# "pidfile" was never created

2444

pass

3235

3236

if not foreground:

3237

if pidfile is not None:

3238

pid = os.getpid()

3239

try:

3240

with pidfile:

3241

print(pid, file=pidfile)

3242

except IOError:

3243

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

3244

pidfilename, pid)

3245

del pidfile

2445

3246

del pidfilename

2446

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

2447

2448

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

2449

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

2450

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2451

3252

if use_dbus:

2452

class MandosDBusService(DBusObjectWithProperties):

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2453

3257

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

3258

2454

3259

def __init__(self):

2455

3260

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

3261

2456

3262

_interface = "se.recompile.Mandos"

2457

2458

@dbus_interface_annotations(_interface)

2459

def _foo(self):

2460

return { "org.freedesktop.DBus.Property"

2461

".EmitsChangedSignal":

2462

"false"}

2463

3263

2464

3264

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

2465

3265

def ClientAdded(self, objpath):

2466

3266

"D-Bus signal"

2467

3267

pass

2468

3268

2469

3269

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

2470

3270

def ClientNotFound(self, fingerprint, address):

2471

3271

"D-Bus signal"

2472

3272

pass

2473

3273

3274

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

3275

"true"})

2474

3276

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

2475

3277

def ClientRemoved(self, objpath, name):

2476

3278

"D-Bus signal"

2477

3279

pass

2478

3280

3281

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

3282

"true"})

2479

3283

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

2480

3284

def GetAllClients(self):

2481

3285

"D-Bus method"

2482

return dbus.Array(c.dbus_object_path

2483

for c in

2484

tcp_server.clients.itervalues())

2485

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2486

3291

@dbus.service.method(_interface,

2487

3292

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

2488

3293

def GetAllClientsWithProperties(self):

2489

3294

"D-Bus method"

2490

3295

return dbus.Dictionary(

2491

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

2492

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

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2493

3299

signature="oa{sv}")

2494

3300

2495

3301

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

2496

3302

def RemoveClient(self, object_path):

2497

3303

"D-Bus method"

2498

for c in tcp_server.clients.itervalues():

3304

for c in tcp_server.clients.values():

2499

3305

if c.dbus_object_path == object_path:

2500

3306

del tcp_server.clients[c.name]

2501

3307

c.remove_from_connection()

2502

# Don't signal anything except ClientRemoved

3308

# Don't signal the disabling

2503

3309

c.disable(quiet=True)

2504

# Emit D-Bus signal

2505

self.ClientRemoved(object_path, c.name)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2506

3312

return

2507

3313

raise KeyError(object_path)

2508

3314

2509

3315

del _interface

2510

2511

class MandosDBusServiceTransitional(MandosDBusService):

2512

__metaclass__ = AlternateDBusNamesMetaclass

2513

mandos_dbus_service = MandosDBusServiceTransitional()

2514

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

3353

mandos_dbus_service = MandosDBusService()

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2515

3360

def cleanup():

2516

3361

"Cleanup function; run on exit"

2517

service.cleanup()

2518

2519

multiprocessing.active_children()

3362

if zeroconf:

3363

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2520

3367

if not (tcp_server.clients or client_settings):

2521

3368

return

2522

3369

2523

3370

# Store client before exiting. Secrets are encrypted with key

2524

3371

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

2525

3372

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

2526

3373

clients = {}

2527

3374

with PGPEngine() as pgp:

2528

for client in tcp_server.clients.itervalues():

3375

for client in tcp_server.clients.values():

2529

3376

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

2530

3377

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

2531

3378

key)

2532

3379

client_dict = {}

2533

3380

2534

3381

# A list of attributes that can not be pickled

2535

3382

# + secret.

2536

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

2537

"checker"))

2538

for name, typ in (inspect.getmembers

2539

(dbus.service.Object)):

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2540

3387

exclude.add(name)

2541

3388

2542

3389

client_dict["encrypted_secret"] = (client

2543

3390

.encrypted_secret)

2544

3391

for attr in client.client_structure:

2545

3392

if attr not in exclude:

2546

3393

client_dict[attr] = getattr(client, attr)

2547

3394

2548

3395

clients[client.name] = client_dict

2549

3396

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

2550

3397

2551

3398

try:

2552

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

2553

prefix="clients-",

2554

dir=os.path.dirname

2555

(stored_state_path))

2556

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

2557

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

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2558

3408

os.rename(tempname, stored_state_path)

2559

3409

except (IOError, OSError) as e:

2560

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

2561

.format(e))

2562

3410

if not debug:

2563

3411

try:

2564

3412

os.remove(tempname)

2565

3413

except NameError:

2566

3414

pass

2567

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

2568

errno.EEXIST)):

2569

raise e

2570

3415

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

3416

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

3417

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

3418

else:

3419

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

3420

exc_info=e)

3421

raise

3422

2571

3423

# Delete all clients, and settings from config

2572

3424

while tcp_server.clients:

2573

3425

name, client = tcp_server.clients.popitem()

2574

3426

if use_dbus:

2575

3427

client.remove_from_connection()

2576

# Don't signal anything except ClientRemoved

3428

# Don't signal the disabling

2577

3429

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

2578

3431

if use_dbus:

2579

# Emit D-Bus signal

2580

mandos_dbus_service.ClientRemoved(client

2581

.dbus_object_path,

2582

client.name)

3432

mandos_dbus_service.client_removed_signal(client)

2583

3433

client_settings.clear()

2584

3434

2585

3435

atexit.register(cleanup)

2586

2587

for client in tcp_server.clients.itervalues():

3436

3437

for client in tcp_server.clients.values():

2588

3438

if use_dbus:

2589

# Emit D-Bus signal

2590

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2591

3441

# Need to initiate checking of clients

2592

3442

if client.enabled:

2593

3443

client.init_checker()

2594

3444

2595

3445

tcp_server.enable()

2596

3446

tcp_server.server_activate()

2597

3447

2598

3448

# Find out what port we got

2599

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

3449

if zeroconf:

3450

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

2600

3451

if use_ipv6:

2601

3452

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

2602

" flowinfo %d, scope_id %d"

2603

% tcp_server.socket.getsockname())

3453

" flowinfo %d, scope_id %d",

3454

*tcp_server.socket.getsockname())

2604

3455

else: # IPv4

2605

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

2606

% tcp_server.socket.getsockname())

2607

2608

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

2609

3456

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

3457

*tcp_server.socket.getsockname())

3458

3459

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

3460

2610

3461

try:

2611

# From the Avahi example code

2612

try:

2613

service.activate()

2614

except dbus.exceptions.DBusException as error:

2615

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

2616

cleanup()

2617

sys.exit(1)

2618

# End of Avahi example code

2619

2620

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

2621

lambda *args, **kwargs:

2622

(tcp_server.handle_request

2623

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

2624

3462

if zeroconf:

3463

# From the Avahi example code

3464

try:

3465

service.activate()

3466

except dbus.exceptions.DBusException as error:

3467

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

3468

cleanup()

3469

sys.exit(1)

3470

# End of Avahi example code

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2625

3477

logger.debug("Starting main loop")

2626

3478

main_loop.run()

2627

3479

except AvahiError as error:

2636

3488

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

2637

3489

cleanup()

2638

3490

3491

2639

3492

if __name__ == '__main__':

2640

3493

main()