/mandos/trunk : revision 561.1.1

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

37

import SocketServer as socketserver

47

38

import socket

48

39

import argparse

49

40

import datetime

50

41

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

55

49

import sys

56

50

import re

57

51

import os

66

60

import struct

67

61

import fcntl

68

62

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

63

import cPickle as pickle

73

64

import multiprocessing

74

65

import types

75

66

import binascii

76

67

import tempfile

77

68

import itertools

78

import collections

79

import codecs

80

69

81

70

import dbus

82

71

import dbus.service

83

from gi.repository import GLib

72

import gobject

73

import avahi

84

74

from dbus.mainloop.glib import DBusGMainLoop

85

75

import ctypes

86

76

import ctypes.util

87

77

import xml.dom.minidom

88

78

import inspect

79

import GnuPGInterface

89

80

90

# Try to find the value of SO_BINDTODEVICE:

91

81

try:

92

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

93

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

94

82

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

83

except AttributeError:

96

84

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

85

from IN import SO_BINDTODEVICE

100

86

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.18"

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

119

90

stored_state_file = "clients.pickle"

120

91

121

92

logger = logging.getLogger()

122

syslogger = None

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

123

96

124

97

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

127

101

except (OSError, AttributeError):

128

129

102

def if_nametoindex(interface):

130

103

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

131

104

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

132

105

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

133

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

136

111

return interface_index

137

112

138

113

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

114

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

156

115

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

116

162

117

syslogger.setFormatter(logging.Formatter

163

118

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

164

119

' %(message)s'))

165

120

logger.addHandler(syslogger)

166

121

167

122

if debug:

168

123

console = logging.StreamHandler()

169

124

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

181

136

182

137

class PGPEngine(object):

183

138

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

184

185

139

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

186

141

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

206

149

def __enter__(self):

207

150

return self

208

209

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

151

152

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

210

153

self._cleanup()

211

154

return False

212

155

213

156

def __del__(self):

214

157

self._cleanup()

215

158

216

159

def _cleanup(self):

217

160

if self.tempdir is not None:

218

161

# Delete contents of tempdir

219

162

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

220

topdown=False):

163

topdown = False):

221

164

for filename in files:

222

165

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

223

166

for dirname in dirs:

225

168

# Remove tempdir

226

169

os.rmdir(self.tempdir)

227

170

self.tempdir = None

228

171

229

172

def password_encode(self, password):

230

173

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

231

174

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

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

175

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

176

240

177

def encrypt(self, data, password):

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

178

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

179

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

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

256

192

return ciphertext

257

193

258

194

def decrypt(self, data, password):

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

195

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

196

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

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

274

209

return decrypted_plaintext

275

210

276

211

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

212

304

213

class AvahiError(Exception):

305

214

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

306

215

self.value = value

307

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

308

**kwargs)

309

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

310

219

311

220

class AvahiServiceError(AvahiError):

312

221

pass

313

222

314

315

223

class AvahiGroupError(AvahiError):

316

224

pass

317

225

318

226

319

227

class AvahiService(object):

320

228

"""An Avahi (Zeroconf) service.

321

229

322

230

Attributes:

323

231

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

324

232

Used to optionally bind to the specified interface.

325

233

name: string; Example: 'Mandos'

326

234

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

327

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

235

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

328

236

port: integer; what port to announce

329

237

TXT: list of strings; TXT record for the service

330

238

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

336

244

server: D-Bus Server

337

245

bus: dbus.SystemBus()

338

246

"""

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

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

351

251

self.interface = interface

352

252

self.name = name

353

253

self.type = servicetype

362

262

self.server = None

363

263

self.bus = bus

364

264

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

265

def rename(self):

367

266

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

368

267

if self.rename_count >= self.max_renames:

369

268

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

370

269

" after %i retries, exiting.",

371

270

self.rename_count)

372

271

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

376

274

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

377

275

self.name)

378

if remove:

379

self.remove()

276

self.remove()

380

277

try:

381

278

self.add()

382

279

except dbus.exceptions.DBusException as error:

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

280

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

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

392

284

def remove(self):

393

285

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

394

286

if self.entry_group_state_changed_match is not None:

396

288

self.entry_group_state_changed_match = None

397

289

if self.group is not None:

398

290

self.group.Reset()

399

400

291

def add(self):

401

292

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

402

293

self.remove()

419

310

dbus.UInt16(self.port),

420

311

avahi.string_array_to_txt_array(self.TXT))

421

312

self.group.Commit()

422

423

313

def entry_group_state_changed(self, state, error):

424

314

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

425

315

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

426

316

427

317

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

318

logger.debug("Zeroconf service established.")

429

319

elif state == avahi.ENTRY_GROUP_COLLISION:

431

321

self.rename()

432

322

elif state == avahi.ENTRY_GROUP_FAILURE:

433

323

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

434

str(error))

435

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

436

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

437

327

def cleanup(self):

438

328

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

439

329

if self.group is not None:

444

334

pass

445

335

self.group = None

446

336

self.remove()

447

448

337

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

449

338

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

450

339

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

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

}

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

457

347

if state in bad_states:

458

348

if bad_states[state] is not None:

459

349

if error is None:

462

352

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

463

353

self.cleanup()

464

354

elif state == avahi.SERVER_RUNNING:

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)

355

self.add()

477

356

else:

478

357

if error is None:

479

358

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

480

359

else:

481

360

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

482

483

361

def activate(self):

484

362

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

485

363

if self.server is None:

489

367

follow_name_owner_changes=True),

490

368

avahi.DBUS_INTERFACE_SERVER)

491

369

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

370

self.server_state_changed)

493

371

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

494

372

495

496

373

class AvahiServiceToSyslog(AvahiService):

497

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

374

def rename(self):

498

375

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

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

376

ret = AvahiService.rename(self)

377

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

% self.name))

503

381

return ret

504

382

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

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

780

389

class Client(object):

781

390

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

782

391

783

392

Attributes:

784

393

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

785

394

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

787

396

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

788

397

to see if the client lives.

789

398

'None' if no process is running.

790

checker_callback_tag: a GLib event source tag, or None

399

checker_callback_tag: a gobject event source tag, or None

791

400

checker_command: string; External command which is run to check

792

401

if client lives. %() expansions are done at

793

402

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

794

403

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

795

checker_initiator_tag: a GLib event source tag, or None

404

checker_initiator_tag: a gobject event source tag, or None

796

405

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

797

406

client_structure: Object describing what attributes a client has

798

407

and is used for storing the client at exit

799

408

current_checker_command: string; current running checker_command

800

disable_initiator_tag: a GLib event source tag, or None

409

disable_initiator_tag: a gobject event source tag, or None

801

410

enabled: bool()

802

411

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

803

412

uniquely identify the client

808

417

last_checker_status: integer between 0 and 255 reflecting exit

809

418

status of last checker. -1 reflects crashed

810

419

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

813

420

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

814

421

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

815

422

D-Bus identifiers

820

427

runtime_expansions: Allowed attributes for runtime expansion.

821

428

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

822

429

disabled, or None

823

server_settings: The server_settings dict from main()

824

430

"""

825

431

826

432

runtime_expansions = ("approval_delay", "approval_duration",

827

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

828

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

829

"last_approval_request", "last_checked_ok",

433

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

434

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

830

435

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

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

}

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)

842

461

843

462

@staticmethod

844

463

def config_parser(config):

852

471

for client_name in config.sections():

853

472

section = dict(config.items(client_name))

854

473

client = settings[client_name] = {}

855

474

856

475

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

857

476

# Reformat values from string types to Python types

858

477

client["approved_by_default"] = config.getboolean(

859

478

client_name, "approved_by_default")

860

479

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

861

480

"enabled")

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

481

866

482

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

867

483

.replace(" ", ""))

868

484

if "secret" in section:

869

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

870

.encode("utf-8"),

871

"base64")

485

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

872

486

elif "secfile" in section:

873

487

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

874

488

(section["secfile"])),

875

489

"rb") as secfile:

876

490

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

877

491

else:

878

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

879

.format(section))

492

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

493

% section)

880

494

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

881

495

client["extended_timeout"] = string_to_delta(

882

496

section["extended_timeout"])

889

503

client["last_approval_request"] = None

890

504

client["last_checked_ok"] = None

891

505

client["last_checker_status"] = -2

892

506

893

507

return settings

894

895

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

508

509

510

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

511

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

512

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

513

attribute."""

896

514

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

900

515

# adding all client settings

901

for setting, value in settings.items():

516

for setting, value in settings.iteritems():

902

517

setattr(self, setting, value)

903

518

904

519

if self.enabled:

905

520

if not hasattr(self, "last_enabled"):

906

521

self.last_enabled = datetime.datetime.utcnow()

910

525

else:

911

526

self.last_enabled = None

912

527

self.expires = None

913

528

914

529

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

915

533

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

916

534

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

917

535

datetime.datetime.utcnow())

924

542

self.current_checker_command = None

925

543

self.approved = None

926

544

self.approvals_pending = 0

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

545

self.changedstate = (multiprocessing_manager

546

.Condition(multiprocessing_manager

547

.Lock()))

548

self.client_structure = [attr for attr in

549

self.__dict__.iterkeys()

931

550

if not attr.startswith("_")]

932

551

self.client_structure.append("client_structure")

933

934

for name, t in inspect.getmembers(

935

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

552

553

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

554

lambda obj:

555

isinstance(obj,

556

property)):

936

557

if not name.startswith("_"):

937

558

self.client_structure.append(name)

938

559

939

560

# Send notice to process children that client state has changed

940

561

def send_changedstate(self):

941

562

with self.changedstate:

942

563

self.changedstate.notify_all()

943

564

944

565

def enable(self):

945

566

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

946

567

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

947

568

# Already enabled

948

569

return

570

self.send_changedstate()

949

571

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

950

572

self.enabled = True

951

573

self.last_enabled = datetime.datetime.utcnow()

952

574

self.init_checker()

953

self.send_changedstate()

954

575

955

576

def disable(self, quiet=True):

956

577

"""Disable this client."""

957

578

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

958

579

return False

959

580

if not quiet:

581

self.send_changedstate()

582

if not quiet:

960

583

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

961

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

962

GLib.source_remove(self.disable_initiator_tag)

584

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

585

gobject.source_remove(self.disable_initiator_tag)

963

586

self.disable_initiator_tag = None

964

587

self.expires = None

965

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

966

GLib.source_remove(self.checker_initiator_tag)

588

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

589

gobject.source_remove(self.checker_initiator_tag)

967

590

self.checker_initiator_tag = None

968

591

self.stop_checker()

969

592

self.enabled = False

970

if not quiet:

971

self.send_changedstate()

972

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

593

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

973

594

return False

974

595

975

596

def __del__(self):

976

597

self.disable()

977

598

978

599

def init_checker(self):

979

600

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

980

601

# and every interval from then on.

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)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

self.start_checker))

986

605

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

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)

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

self.disable))

991

609

# Also start a new checker *right now*.

992

610

self.start_checker()

993

994

def checker_callback(self, source, condition, connection,

995

command):

611

612

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

996

613

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

997

614

self.checker_callback_tag = None

998

615

self.checker = None

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

616

if os.WIFEXITED(condition):

617

self.last_checker_status = os.WEXITSTATUS(condition)

1006

618

if self.last_checker_status == 0:

1007

619

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

1008

620

vars(self))

1009

621

self.checked_ok()

1010

622

else:

1011

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

623

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

624

vars(self))

1012

625

else:

1013

626

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

1015

627

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

1016

628

vars(self))

1017

return False

1018

629

1019

630

def checked_ok(self):

1020

631

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

1021

632

self.last_checked_ok = datetime.datetime.utcnow()

1022

633

self.last_checker_status = 0

1023

self.last_checker_signal = None

1024

634

self.bump_timeout()

1025

635

1026

636

def bump_timeout(self, timeout=None):

1027

637

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

1028

638

if timeout is None:

1029

639

timeout = self.timeout

1030

640

if self.disable_initiator_tag is not None:

1031

GLib.source_remove(self.disable_initiator_tag)

1032

self.disable_initiator_tag = None

641

gobject.source_remove(self.disable_initiator_tag)

1033

642

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

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1036

646

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

1037

647

1038

648

def need_approval(self):

1039

649

self.last_approval_request = datetime.datetime.utcnow()

1040

650

1041

651

def start_checker(self):

1042

652

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

1043

653

1044

654

If a checker already exists, leave it running and do

1045

655

nothing."""

1046

656

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

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

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

1051

661

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

1052

662

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

1053

663

# should be.

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

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)

1059

678

# Start a new checker if needed

1060

679

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}

1065

680

try:

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

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

' %s', self.checker_command, error)

698

return True # Try again later

1072

699

self.current_checker_command = command

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

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

self.checker = subprocess.Popen(command,

708

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

720

except OSError as error:

721

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

722

error)

723

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

1099

724

return True

1100

725

1101

726

def stop_checker(self):

1102

727

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

1103

728

if self.checker_callback_tag:

1104

GLib.source_remove(self.checker_callback_tag)

729

gobject.source_remove(self.checker_callback_tag)

1105

730

self.checker_callback_tag = None

1106

731

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

1107

732

return

1108

733

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

1109

self.checker.terminate()

734

try:

735

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

736

#time.sleep(0.5)

737

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

738

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

739

except OSError as error:

740

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

741

raise

1110

742

self.checker = None

1111

743

1112

744

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1117

747

"""Decorators for marking methods of a DBusObjectWithProperties to

1118

748

become properties on the D-Bus.

1119

749

1120

750

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

1121

751

and with one argument by "Set".

1122

752

1123

753

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

1124

754

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

1125

755

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

1128

758

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

1129

759

if byte_arrays and signature != "ay":

1130

760

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

1131

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

1132

761

" signature %r" % signature)

1133

762

def decorator(func):

1134

763

func._dbus_is_property = True

1135

764

func._dbus_interface = dbus_interface

1138

767

func._dbus_name = func.__name__

1139

768

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

1140

769

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

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

771

return func

1143

1144

772

return decorator

1145

773

1146

774

1147

775

def dbus_interface_annotations(dbus_interface):

1148

"""Decorator for marking functions returning interface annotations

1149

776

"""Decorator for marking functions returning interface annotations.

777

1150

778

Usage:

1151

779

1152

780

@dbus_interface_annotations("org.example.Interface")

1153

781

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

1154

782

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

1155

783

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

1156

784

"false"}

1157

785

"""

1158

1159

786

def decorator(func):

1160

787

func._dbus_is_interface = True

1161

788

func._dbus_interface = dbus_interface

1162

789

func._dbus_name = dbus_interface

1163

790

return func

1164

1165

791

return decorator

1166

792

1167

793

1168

794

def dbus_annotations(annotations):

1169

795

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

1170

796

Usage:

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

797

1175

798

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

1176

799

access="r")

800

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

801

"org.freedesktop.DBus.Property."

802

"EmitsChangedSignal": "false"})

1177

803

def Property_dbus_property(self):

1178

804

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

1181

805

"""

1182

1183

806

def decorator(func):

1184

807

func._dbus_annotations = annotations

1185

808

return func

1186

1187

809

return decorator

1188

810

1189

811

1190

812

class DBusPropertyException(dbus.exceptions.DBusException):

1191

813

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

1192

814

"""

1193

pass

815

def __unicode__(self):

816

return unicode(str(self))

1194

817

1195

818

1196

819

class DBusPropertyAccessException(DBusPropertyException):

1205

828

pass

1206

829

1207

830

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.

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.

1213

837

"""

1214

838

1215

839

@staticmethod

1216

840

def _is_dbus_thing(thing):

1217

841

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

1218

842

1219

843

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

1220

844

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

1221

845

"""

1222

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

846

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

1223

847

False)

1224

848

1225

849

def _get_all_dbus_things(self, thing):

1226

850

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

1227

851

"""

1228

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

852

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

853

name),

1229

854

athing.__get__(self))

1230

855

for cls in self.__class__.__mro__

1231

856

for name, athing in

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

857

inspect.getmembers(cls,

858

self._is_dbus_thing(thing)))

859

1305

860

def _get_dbus_property(self, interface_name, property_name):

1306

861

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

1307

862

property with the specified name and interface.

1308

863

"""

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

864

for cls in self.__class__.__mro__:

865

for name, value in (inspect.getmembers

866

(cls,

867

self._is_dbus_thing("property"))):

1312

868

if (value._dbus_name == property_name

1313

869

and value._dbus_interface == interface_name):

1314

870

return value.__get__(self)

1315

871

1316

872

# No such property

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

873

raise DBusPropertyNotFound(self.dbus_object_path + ":"

874

+ interface_name + "."

875

+ property_name)

876

877

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

1331

878

out_signature="v")

1332

879

def Get(self, interface_name, property_name):

1333

880

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

1339

886

if not hasattr(value, "variant_level"):

1340

887

return value

1341

888

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

1342

889

1343

890

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

1344

891

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

1345

892

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

1351

898

# The byte_arrays option is not supported yet on

1352

899

# signatures other than "ay".

1353

900

if prop._dbus_signature != "ay":

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

901

raise ValueError

1357

902

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

1358

903

for byte in value))

1359

904

prop(value)

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

905

906

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

1363

907

out_signature="a{sv}")

1364

908

def GetAll(self, interface_name):

1365

909

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

1366

910

standard.

1367

911

1368

912

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

1369

913

"""

1370

914

properties = {}

1380

924

if not hasattr(value, "variant_level"):

1381

925

properties[name] = value

1382

926

continue

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

927

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

928

value.variant_level+1)

1385

929

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

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

930

1395

931

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1396

932

out_signature="s",

1397

933

path_keyword='object_path',

1398

934

connection_keyword='connection')

1399

935

def Introspect(self, object_path, connection):

1400

936

"""Overloading of standard D-Bus method.

1401

937

1402

938

Inserts property tags and interface annotation tags.

1403

939

"""

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

940

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

941

connection)

1407

942

try:

1408

943

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

1409

1410

944

def make_tag(document, name, prop):

1411

945

e = document.createElement("property")

1412

946

e.setAttribute("name", name)

1413

947

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

1414

948

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

1415

949

return e

1416

1417

950

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

1418

951

# Add property tags

1419

952

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

1422

955

if prop._dbus_interface

1423

956

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

1424

957

if_tag.appendChild(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)

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)

1441

989

# Add the names to the return values for the

1442

990

# "org.freedesktop.DBus.Properties" methods

1443

991

if (if_tag.getAttribute("name")

1458

1006

except (AttributeError, xml.dom.DOMException,

1459

1007

xml.parsers.expat.ExpatError) as error:

1460

1008

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

1461

exc_info=error)

1462

return xmlstring

1463

1464

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

1009

error)

1010

return xmlstring

1011

1012

1013

def datetime_to_dbus (dt, variant_level=0):

1537

1014

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

1538

1015

if dt is None:

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

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.

1565

1025

"""

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

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

1574

1034

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

1575

1035

# with the wrong interface name

1576

1036

if (not hasattr(attribute, "_dbus_interface")

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1037

or not attribute._dbus_interface

1038

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

1579

1039

continue

1580

1040

# Create an alternate D-Bus interface name based on

1581

1041

# the current name

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1584

interface_names.add(alt_interface)

1042

alt_interface = (attribute._dbus_interface

1043

.replace("se.recompile.Mandos",

1044

"se.bsnet.fukt.Mandos"))

1045

if alt_interface != attribute._dbus_interface:

1046

old_interface_names.append(alt_interface)

1585

1047

# Is this a D-Bus signal?

1586

1048

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

1587

# Extract the original non-method undecorated

1588

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1049

# Extract the original non-method function by

1050

# black magic

1051

nonmethod_func = (dict(

1591

1052

zip(attribute.func_code.co_freevars,

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)

1053

attribute.__closure__))["func"]

1054

.cell_contents)

1599

1055

# Create a new, but exactly alike, function

1600

1056

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

1601

1057

# with the alternate D-Bus interface name

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1058

new_function = (dbus.service.signal

1059

(alt_interface,

1060

attribute._dbus_signature)

1061

(types.FunctionType(

1062

nonmethod_func.func_code,

1063

nonmethod_func.func_globals,

1064

nonmethod_func.func_name,

1065

nonmethod_func.func_defaults,

1066

nonmethod_func.func_closure)))

1606

1067

# Copy annotations, if any

1607

1068

try:

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1069

new_function._dbus_annotations = (

1070

dict(attribute._dbus_annotations))

1610

1071

except AttributeError:

1611

1072

pass

1612

1613

1073

# Define a creator of a function to call both the

1614

# original and alternate functions, so both the

1615

# original and alternate signals gets sent when

1616

# the function is called

1074

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

1075

# signals gets sent when the function is called

1617

1076

def fixscope(func1, func2):

1618

1077

"""This function is a scope container to pass

1619

1078

func1 and func2 to the "call_both" function

1620

1079

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1623

1080

def call_both(*args, **kwargs):

1624

1081

"""This function will emit two D-Bus

1625

1082

signals by calling func1 and func2"""

1626

1083

func1(*args, **kwargs)

1627

1084

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

1634

1085

return call_both

1635

1086

# Create the "call_both" function and add it to

1636

1087

# the class

1637

attr[attrname] = fixscope(attribute, new_function)

1088

attr[attrname] = fixscope(attribute,

1089

new_function)

1638

1090

# Is this a D-Bus method?

1639

1091

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

1640

1092

# Create a new, but exactly alike, function

1641

1093

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

1642

1094

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

1643

1095

# to the class.

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1096

attr[attrname] = (dbus.service.method

1097

(alt_interface,

1098

attribute._dbus_in_signature,

1099

attribute._dbus_out_signature)

1100

(types.FunctionType

1101

(attribute.func_code,

1102

attribute.func_globals,

1103

attribute.func_name,

1104

attribute.func_defaults,

1105

attribute.func_closure)))

1650

1106

# Copy annotations, if any

1651

1107

try:

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1108

attr[attrname]._dbus_annotations = (

1109

dict(attribute._dbus_annotations))

1654

1110

except AttributeError:

1655

1111

pass

1656

1112

# Is this a D-Bus property?

1659

1115

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

1660

1116

# property with the alternate D-Bus interface

1661

1117

# name. Add it to the class.

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

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

1668

1131

# Copy annotations, if any

1669

1132

try:

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1133

attr[attrname]._dbus_annotations = (

1134

dict(attribute._dbus_annotations))

1672

1135

except AttributeError:

1673

1136

pass

1674

1137

# Is this a D-Bus interface?

1677

1140

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

1678

1141

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

1679

1142

# to the class.

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

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

1714

1166

class ClientDBus(Client, DBusObjectWithProperties):

1715

1167

"""A Client class using D-Bus

1716

1168

1717

1169

Attributes:

1718

1170

dbus_object_path: dbus.ObjectPath

1719

1171

bus: dbus.SystemBus()

1720

1172

"""

1721

1173

1722

1174

runtime_expansions = (Client.runtime_expansions

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1175

+ ("dbus_object_path",))

1176

1727

1177

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

1728

1729

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

1178

1179

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

1730

1180

self.bus = bus

1731

1181

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

1732

1182

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

1733

1183

# the D-Bus

1734

client_object_name = str(self.name).translate(

1184

client_object_name = unicode(self.name).translate(

1735

1185

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

1736

1186

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

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1187

self.dbus_object_path = (dbus.ObjectPath

1188

("/clients/" + client_object_name))

1739

1189

DBusObjectWithProperties.__init__(self, self.bus,

1740

1190

self.dbus_object_path)

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

1191

1192

def notifychangeproperty(transform_func,

1193

dbus_name, type_func=lambda x: x,

1194

variant_level=1):

1747

1195

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

1748

1196

its changes to DBus.

1749

1197

1750

1198

transform_fun: Function that takes a value and a variant_level

1751

1199

and transforms it to a D-Bus type.

1752

1200

dbus_name: D-Bus name of the variable

1754

1202

to the D-Bus. Default: no transform

1755

1203

variant_level: D-Bus variant level. Default: 1

1756

1204

"""

1757

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

1758

1205

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

1759

1206

def setter(self, value):

1760

1207

if hasattr(self, "dbus_object_path"):

1761

1208

if (not hasattr(self, attrname) or

1762

1209

type_func(getattr(self, attrname, None))

1763

1210

!= type_func(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())

1211

dbus_value = transform_func(type_func(value),

1212

variant_level

1213

=variant_level)

1214

self.PropertyChanged(dbus.String(dbus_name),

1215

dbus_value)

1779

1216

setattr(self, attrname, value)

1780

1217

1781

1218

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

1782

1219

1220

1783

1221

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1784

1222

approvals_pending = notifychangeproperty(dbus.Boolean,

1785

1223

"ApprovalPending",

1786

type_func=bool)

1224

type_func = bool)

1787

1225

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

1788

1226

last_enabled = notifychangeproperty(datetime_to_dbus,

1789

1227

"LastEnabled")

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1228

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

1229

type_func = lambda checker:

1230

checker is not None)

1793

1231

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1794

1232

"LastCheckedOK")

1795

1233

last_checker_status = notifychangeproperty(dbus.Int16,

1798

1236

datetime_to_dbus, "LastApprovalRequest")

1799

1237

approved_by_default = notifychangeproperty(dbus.Boolean,

1800

1238

"ApprovedByDefault")

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1239

approval_delay = notifychangeproperty(dbus.UInt64,

1240

"ApprovalDelay",

1241

type_func =

1242

timedelta_to_milliseconds)

1804

1243

approval_duration = notifychangeproperty(

1805

1244

dbus.UInt64, "ApprovalDuration",

1806

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

1245

type_func = timedelta_to_milliseconds)

1807

1246

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

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1247

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

1248

type_func =

1249

timedelta_to_milliseconds)

1811

1250

extended_timeout = notifychangeproperty(

1812

1251

dbus.UInt64, "ExtendedTimeout",

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)

1252

type_func = timedelta_to_milliseconds)

1253

interval = notifychangeproperty(dbus.UInt64,

1254

"Interval",

1255

type_func =

1256

timedelta_to_milliseconds)

1817

1257

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

1818

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

1819

invalidate_only=True)

1820

1258

1821

1259

del notifychangeproperty

1822

1260

1823

1261

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

1824

1262

try:

1825

1263

self.remove_from_connection()

1828

1266

if hasattr(DBusObjectWithProperties, "__del__"):

1829

1267

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

1830

1268

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

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:

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)

1839

1276

# Emit D-Bus signal

1840

1277

self.CheckerCompleted(dbus.Int16(exitstatus),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1278

dbus.Int64(condition),

1843

1279

dbus.String(command))

1844

1280

else:

1845

1281

# Emit D-Bus signal

1846

1282

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

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1283

dbus.Int64(condition),

1851

1284

dbus.String(command))

1852

return ret

1853

1285

1286

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

1287

*args, **kwargs)

1288

1854

1289

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

1855

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

1290

old_checker = self.checker

1291

if self.checker is not None:

1292

old_checker_pid = self.checker.pid

1293

else:

1294

old_checker_pid = None

1856

1295

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

1857

1296

# Only if new checker process was started

1858

1297

if (self.checker is not None

1860

1299

# Emit D-Bus signal

1861

1300

self.CheckerStarted(self.current_checker_command)

1862

1301

return r

1863

1302

1864

1303

def _reset_approved(self):

1865

1304

self.approved = None

1866

1305

return False

1867

1306

1868

1307

def approve(self, value=True):

1308

self.send_changedstate()

1869

1309

self.approved = value

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

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

1880

1327

# CheckerCompleted - signal

1881

1328

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

1882

1329

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

1883

1330

"D-Bus signal"

1884

1331

pass

1885

1332

1886

1333

# CheckerStarted - signal

1887

1334

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

1888

1335

def CheckerStarted(self, command):

1889

1336

"D-Bus signal"

1890

1337

pass

1891

1338

1892

1339

# PropertyChanged - signal

1893

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

1894

1340

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

1895

1341

def PropertyChanged(self, property, value):

1896

1342

"D-Bus signal"

1897

1343

pass

1898

1344

1899

1345

# GotSecret - signal

1900

1346

@dbus.service.signal(_interface)

1901

1347

def GotSecret(self):

1904

1350

server to mandos-client

1905

1351

"""

1906

1352

pass

1907

1353

1908

1354

# Rejected - signal

1909

1355

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

1910

1356

def Rejected(self, reason):

1911

1357

"D-Bus signal"

1912

1358

pass

1913

1359

1914

1360

# NeedApproval - signal

1915

1361

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

1916

1362

def NeedApproval(self, timeout, default):

1917

1363

"D-Bus signal"

1918

1364

return self.need_approval()

1919

1920

# Methods

1921

1365

1366

## Methods

1367

1922

1368

# Approve - method

1923

1369

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

1924

1370

def Approve(self, value):

1925

1371

self.approve(value)

1926

1372

1927

1373

# CheckedOK - method

1928

1374

@dbus.service.method(_interface)

1929

1375

def CheckedOK(self):

1930

1376

self.checked_ok()

1931

1377

1932

1378

# Enable - method

1933

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

1934

1379

@dbus.service.method(_interface)

1935

1380

def Enable(self):

1936

1381

"D-Bus method"

1937

1382

self.enable()

1938

1383

1939

1384

# StartChecker - method

1940

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

1941

1385

@dbus.service.method(_interface)

1942

1386

def StartChecker(self):

1943

1387

"D-Bus method"

1944

1388

self.start_checker()

1945

1389

1946

1390

# Disable - method

1947

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

1948

1391

@dbus.service.method(_interface)

1949

1392

def Disable(self):

1950

1393

"D-Bus method"

1951

1394

self.disable()

1952

1395

1953

1396

# StopChecker - method

1954

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

1955

1397

@dbus.service.method(_interface)

1956

1398

def StopChecker(self):

1957

1399

self.stop_checker()

1958

1959

# Properties

1960

1400

1401

## Properties

1402

1961

1403

# ApprovalPending - property

1962

1404

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

1963

1405

def ApprovalPending_dbus_property(self):

1964

1406

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

1965

1407

1966

1408

# ApprovedByDefault - property

1967

@dbus_service_property(_interface,

1968

signature="b",

1409

@dbus_service_property(_interface, signature="b",

1969

1410

access="readwrite")

1970

1411

def ApprovedByDefault_dbus_property(self, value=None):

1971

1412

if value is None: # get

1972

1413

return dbus.Boolean(self.approved_by_default)

1973

1414

self.approved_by_default = bool(value)

1974

1415

1975

1416

# ApprovalDelay - property

1976

@dbus_service_property(_interface,

1977

signature="t",

1417

@dbus_service_property(_interface, signature="t",

1978

1418

access="readwrite")

1979

1419

def ApprovalDelay_dbus_property(self, value=None):

1980

1420

if value is None: # get

1981

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

1982

* 1000)

1421

return dbus.UInt64(self.approval_delay_milliseconds())

1983

1422

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

1984

1423

1985

1424

# ApprovalDuration - property

1986

@dbus_service_property(_interface,

1987

signature="t",

1425

@dbus_service_property(_interface, signature="t",

1988

1426

access="readwrite")

1989

1427

def ApprovalDuration_dbus_property(self, value=None):

1990

1428

if value is None: # get

1991

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

1992

* 1000)

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

1993

1431

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

1994

1432

1995

1433

# Name - property

1996

@dbus_annotations(

1997

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

1998

1434

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

1999

1435

def Name_dbus_property(self):

2000

1436

return dbus.String(self.name)

2001

1437

2002

1438

# Fingerprint - property

2003

@dbus_annotations(

2004

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

2005

1439

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

2006

1440

def Fingerprint_dbus_property(self):

2007

1441

return dbus.String(self.fingerprint)

2008

1442

2009

1443

# Host - property

2010

@dbus_service_property(_interface,

2011

signature="s",

1444

@dbus_service_property(_interface, signature="s",

2012

1445

access="readwrite")

2013

1446

def Host_dbus_property(self, value=None):

2014

1447

if value is None: # get

2015

1448

return dbus.String(self.host)

2016

self.host = str(value)

2017

1449

self.host = unicode(value)

1450

2018

1451

# Created - property

2019

@dbus_annotations(

2020

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

2021

1452

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

2022

1453

def Created_dbus_property(self):

2023

1454

return datetime_to_dbus(self.created)

2024

1455

2025

1456

# LastEnabled - property

2026

1457

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

2027

1458

def LastEnabled_dbus_property(self):

2028

1459

return datetime_to_dbus(self.last_enabled)

2029

1460

2030

1461

# Enabled - property

2031

@dbus_service_property(_interface,

2032

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2033

1463

access="readwrite")

2034

1464

def Enabled_dbus_property(self, value=None):

2035

1465

if value is None: # get

2038

1468

self.enable()

2039

1469

else:

2040

1470

self.disable()

2041

1471

2042

1472

# LastCheckedOK - property

2043

@dbus_service_property(_interface,

2044

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2045

1474

access="readwrite")

2046

1475

def LastCheckedOK_dbus_property(self, value=None):

2047

1476

if value is not None:

2048

1477

self.checked_ok()

2049

1478

return

2050

1479

return datetime_to_dbus(self.last_checked_ok)

2051

1480

2052

1481

# LastCheckerStatus - property

2053

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

1482

@dbus_service_property(_interface, signature="n",

1483

access="read")

2054

1484

def LastCheckerStatus_dbus_property(self):

2055

1485

return dbus.Int16(self.last_checker_status)

2056

1486

2057

1487

# Expires - property

2058

1488

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

2059

1489

def Expires_dbus_property(self):

2060

1490

return datetime_to_dbus(self.expires)

2061

1491

2062

1492

# LastApprovalRequest - property

2063

1493

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

2064

1494

def LastApprovalRequest_dbus_property(self):

2065

1495

return datetime_to_dbus(self.last_approval_request)

2066

1496

2067

1497

# Timeout - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1498

@dbus_service_property(_interface, signature="t",

2070

1499

access="readwrite")

2071

1500

def Timeout_dbus_property(self, value=None):

2072

1501

if value is None: # get

2073

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

2074

old_timeout = self.timeout

1502

return dbus.UInt64(self.timeout_milliseconds())

2075

1503

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

2076

# Reschedule disabling

1504

# Reschedule timeout

2077

1505

if self.enabled:

2078

1506

now = datetime.datetime.utcnow()

2079

self.expires += self.timeout - old_timeout

2080

if self.expires <= now:

1507

time_to_die = timedelta_to_milliseconds(

1508

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

1509

if time_to_die <= 0:

2081

1510

# The timeout has passed

2082

1511

self.disable()

2083

1512

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

2084

1516

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

2085

1517

is None):

2086

1518

return

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

1519

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1523

2092

1524

# ExtendedTimeout - property

2093

@dbus_service_property(_interface,

2094

signature="t",

1525

@dbus_service_property(_interface, signature="t",

2095

1526

access="readwrite")

2096

1527

def ExtendedTimeout_dbus_property(self, value=None):

2097

1528

if value is None: # get

2098

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

2099

* 1000)

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

2100

1530

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

2101

1531

2102

1532

# Interval - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1533

@dbus_service_property(_interface, signature="t",

2105

1534

access="readwrite")

2106

1535

def Interval_dbus_property(self, value=None):

2107

1536

if value is None: # get

2108

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

1537

return dbus.UInt64(self.interval_milliseconds())

2109

1538

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

2110

1539

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

2111

1540

return

2112

1541

if self.enabled:

2113

1542

# Reschedule checker run

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

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

2119

1548

# Checker - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1549

@dbus_service_property(_interface, signature="s",

2122

1550

access="readwrite")

2123

1551

def Checker_dbus_property(self, value=None):

2124

1552

if value is None: # get

2125

1553

return dbus.String(self.checker_command)

2126

self.checker_command = str(value)

2127

1554

self.checker_command = unicode(value)

1555

2128

1556

# CheckerRunning - property

2129

@dbus_service_property(_interface,

2130

signature="b",

1557

@dbus_service_property(_interface, signature="b",

2131

1558

access="readwrite")

2132

1559

def CheckerRunning_dbus_property(self, value=None):

2133

1560

if value is None: # get

2136

1563

self.start_checker()

2137

1564

else:

2138

1565

self.stop_checker()

2139

1566

2140

1567

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

2144

1568

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

2145

1569

def ObjectPath_dbus_property(self):

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1570

return self.dbus_object_path # is already a dbus.ObjectPath

1571

2148

1572

# Secret = property

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)

1573

@dbus_service_property(_interface, signature="ay",

1574

access="write", byte_arrays=True)

2156

1575

def Secret_dbus_property(self, value):

2157

self.secret = bytes(value)

2158

1576

self.secret = str(value)

1577

2159

1578

del _interface

2160

1579

2161

1580

2164

1583

self._pipe = child_pipe

2165

1584

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

2166

1585

if not self._pipe.recv():

2167

raise KeyError(fpr)

2168

1586

raise KeyError()

1587

2169

1588

def __getattribute__(self, name):

2170

1589

if name == '_pipe':

2171

1590

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

2174

1593

if data[0] == 'data':

2175

1594

return data[1]

2176

1595

if data[0] == 'function':

2177

2178

1596

def func(*args, **kwargs):

2179

1597

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

2180

1598

return self._pipe.recv()[1]

2181

2182

1599

return func

2183

1600

2184

1601

def __setattr__(self, name, value):

2185

1602

if name == '_pipe':

2186

1603

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

2187

1604

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

2188

1605

2189

1606

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

2190

1611

class ClientHandler(socketserver.BaseRequestHandler, object):

2191

1612

"""A class to handle client connections.

2192

1613

2193

1614

Instantiated once for each connection to handle it.

2194

1615

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

2195

1616

2196

1617

def handle(self):

2197

1618

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

2198

1619

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

2199

str(self.client_address))

1620

unicode(self.client_address))

2200

1621

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

2201

1622

self.server.child_pipe.fileno())

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

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

2209

1638

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

2210

1639

priority = self.server.gnutls_priority

2211

1640

if priority is None:

2212

1641

priority = "NORMAL"

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1642

(gnutls.library.functions

1643

.gnutls_priority_set_direct(session._c_object,

1644

priority, None))

1645

2217

1646

# Start communication using the Mandos protocol

2218

1647

# Get protocol number

2219

1648

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

2220

1649

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

2221

1650

try:

2222

1651

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

2223

raise RuntimeError(line)

1652

raise RuntimeError

2224

1653

except (ValueError, IndexError, RuntimeError) as error:

2225

1654

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

2226

1655

return

2227

1656

2228

1657

# Start GnuTLS connection

2229

1658

try:

2230

1659

session.handshake()

2231

except gnutls.Error as error:

1660

except gnutls.errors.GNUTLSError as error:

2232

1661

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

2233

1662

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

2234

1663

# established. Just abandon the request.

2235

1664

return

2236

1665

logger.debug("Handshake succeeded")

2237

1666

2238

1667

approval_required = False

2239

1668

try:

2240

1669

try:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1670

fpr = self.fingerprint(self.peer_certificate

1671

(session))

1672

except (TypeError,

1673

gnutls.errors.GNUTLSError) as error:

2244

1674

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

2245

1675

return

2246

1676

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

2247

1677

2248

1678

try:

2249

1679

client = ProxyClient(child_pipe, fpr,

2250

1680

self.client_address)

2251

1681

except KeyError:

2252

1682

return

2253

1683

2254

1684

if client.approval_delay:

2255

1685

delay = client.approval_delay

2256

1686

client.approvals_pending += 1

2257

1687

approval_required = True

2258

1688

2259

1689

while True:

2260

1690

if not client.enabled:

2261

1691

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

2262

client.name)

1692

client.name)

2263

1693

if self.server.use_dbus:

2264

1694

# Emit D-Bus signal

2265

1695

client.Rejected("Disabled")

2266

1696

return

2267

1697

2268

1698

if client.approved or not client.approval_delay:

2269

# We are approved or approval is disabled

1699

#We are approved or approval is disabled

2270

1700

break

2271

1701

elif client.approved is None:

2272

1702

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

2274

1704

if self.server.use_dbus:

2275

1705

# Emit D-Bus signal

2276

1706

client.NeedApproval(

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

2279

1709

else:

2280

1710

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

2281

1711

client.name)

2283

1713

# Emit D-Bus signal

2284

1714

client.Rejected("Denied")

2285

1715

return

2286

2287

# wait until timeout or approved

1716

1717

#wait until timeout or approved

2288

1718

time = datetime.datetime.now()

2289

1719

client.changedstate.acquire()

2290

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

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

2291

1723

client.changedstate.release()

2292

1724

time2 = datetime.datetime.now()

2293

1725

if (time2 - time) >= delay:

2303

1735

break

2304

1736

else:

2305

1737

delay -= time2 - time

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

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

2314

1751

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

2315

1752

# bump the timeout using extended_timeout

2316

1753

client.bump_timeout(client.extended_timeout)

2317

1754

if self.server.use_dbus:

2318

1755

# Emit D-Bus signal

2319

1756

client.GotSecret()

2320

1757

2321

1758

finally:

2322

1759

if approval_required:

2323

1760

client.approvals_pending -= 1

2324

1761

try:

2325

1762

session.bye()

2326

except gnutls.Error as error:

2327

logger.warning("GnuTLS bye failed",

2328

exc_info=error)

2329

1763

except gnutls.errors.GNUTLSError as error:

1764

logger.warning("GnuTLS bye failed")

1765

2330

1766

@staticmethod

2331

1767

def peer_certificate(session):

2332

1768

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

2333

1769

# If not an OpenPGP certificate...

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

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

2338

1775

list_size = ctypes.c_uint(1)

2339

cert_list = (gnutls.certificate_get_peers

1776

cert_list = (gnutls.library.functions

1777

.gnutls_certificate_get_peers

2340

1778

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

2341

1779

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

2342

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

1780

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

1781

" certificate")

2343

1782

if list_size.value == 0:

2344

1783

return None

2345

1784

cert = cert_list[0]

2346

1785

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

2347

1786

2348

1787

@staticmethod

2349

1788

def fingerprint(openpgp):

2350

1789

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2351

1790

# New GnuTLS "datum" with the OpenPGP public key

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

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

2356

1796

# New empty GnuTLS certificate

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1797

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1798

(gnutls.library.functions

1799

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2359

1800

# Import the OpenPGP public key into the certificate

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1801

(gnutls.library.functions

1802

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

1803

gnutls.library.constants

1804

.GNUTLS_OPENPGP_FMT_RAW))

2362

1805

# Verify the self signature in the key

2363

1806

crtverify = ctypes.c_uint()

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1807

(gnutls.library.functions

1808

.gnutls_openpgp_crt_verify_self(crt, 0,

1809

ctypes.byref(crtverify)))

2366

1810

if crtverify.value != 0:

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1811

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1812

raise (gnutls.errors.CertificateSecurityError

1813

("Verify failed"))

2369

1814

# New buffer for the fingerprint

2370

1815

buf = ctypes.create_string_buffer(20)

2371

1816

buf_len = ctypes.c_size_t()

2372

1817

# Get the fingerprint from the certificate into the buffer

2373

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

2374

ctypes.byref(buf_len))

1818

(gnutls.library.functions

1819

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

1820

ctypes.byref(buf_len)))

2375

1821

# Deinit the certificate

2376

gnutls.openpgp_crt_deinit(crt)

1822

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

1823

# Convert the buffer to a Python bytestring

2378

1824

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

2379

1825

# Convert the bytestring to hexadecimal notation

2383

1829

2384

1830

class MultiprocessingMixIn(object):

2385

1831

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

2386

2387

1832

def sub_process_main(self, request, address):

2388

1833

try:

2389

1834

self.finish_request(request, address)

2390

1835

except Exception:

2391

1836

self.handle_error(request, address)

2392

1837

self.close_request(request)

2393

1838

2394

1839

def process_request(self, request, address):

2395

1840

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

2396

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

2397

args=(request, address))

1841

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

1842

args = (request,

1843

address))

2398

1844

proc.start()

2399

1845

return proc

2400

1846

2401

1847

2402

1848

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2403

1849

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

2404

2405

1850

def process_request(self, request, client_address):

2406

1851

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

2407

1852

2408

1853

This function creates a new pipe in self.pipe

2409

1854

"""

2410

1855

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2411

1856

2412

1857

proc = MultiprocessingMixIn.process_request(self, request,

2413

1858

client_address)

2414

1859

self.child_pipe.close()

2415

1860

self.add_pipe(parent_pipe, proc)

2416

1861

2417

1862

def add_pipe(self, parent_pipe, proc):

2418

1863

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

2419

raise NotImplementedError()

1864

raise NotImplementedError

2420

1865

2421

1866

2422

1867

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2423

1868

socketserver.TCPServer, object):

2424

1869

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

2425

1870

2426

1871

Attributes:

2427

1872

enabled: Boolean; whether this server is activated yet

2428

1873

interface: None or a network interface name (string)

2429

1874

use_ipv6: Boolean; to use IPv6 or not

2430

1875

"""

2431

2432

1876

def __init__(self, server_address, RequestHandlerClass,

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

"""

1877

interface=None, use_ipv6=True):

2439

1878

self.interface = interface

2440

1879

if use_ipv6:

2441

1880

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.

2469

1881

socketserver.TCPServer.__init__(self, server_address,

2470

1882

RequestHandlerClass)

2471

2472

1883

def server_bind(self):

2473

1884

"""This overrides the normal server_bind() function

2474

1885

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

2475

1886

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

2476

global SO_BINDTODEVICE

2477

1887

if self.interface is not None:

2478

1888

if SO_BINDTODEVICE is None:

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

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

2500

1909

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

2501

1910

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

2502

1911

if not self.server_address[0]:

2503

1912

if self.address_family == socket.AF_INET6:

2504

any_address = "::" # in6addr_any

1913

any_address = "::" # in6addr_any

2505

1914

else:

2506

any_address = "0.0.0.0" # INADDR_ANY

1915

any_address = socket.INADDR_ANY

2507

1916

self.server_address = (any_address,

2508

1917

self.server_address[1])

2509

1918

elif not self.server_address[1]:

2510

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

1919

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

1920

0)

2511

1921

# if self.interface:

2512

1922

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

2513

1923

# 0, # port

2519

1929

2520

1930

class MandosServer(IPv6_TCPServer):

2521

1931

"""Mandos server.

2522

1932

2523

1933

Attributes:

2524

1934

clients: set of Client objects

2525

1935

gnutls_priority GnuTLS priority string

2526

1936

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

2527

2528

Assumes a GLib.MainLoop event loop.

1937

1938

Assumes a gobject.MainLoop event loop.

2529

1939

"""

2530

2531

1940

def __init__(self, server_address, RequestHandlerClass,

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

1941

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

1942

gnutls_priority=None, use_dbus=True):

2538

1943

self.enabled = False

2539

1944

self.clients = clients

2540

1945

if self.clients is None:

2543

1948

self.gnutls_priority = gnutls_priority

2544

1949

IPv6_TCPServer.__init__(self, server_address,

2545

1950

RequestHandlerClass,

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

1951

interface = interface,

1952

use_ipv6 = use_ipv6)

2550

1953

def server_activate(self):

2551

1954

if self.enabled:

2552

1955

return socketserver.TCPServer.server_activate(self)

2553

1956

2554

1957

def enable(self):

2555

1958

self.enabled = True

2556

1959

2557

1960

def add_pipe(self, parent_pipe, proc):

2558

1961

# Call "handle_ipc" for both data and EOF events

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

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)

2570

1985

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

2571

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

1986

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

2572

1987

# Wait for other process to exit

2573

1988

proc.join()

2574

1989

return False

2575

1990

2576

1991

# Read a request from the child

2577

1992

request = parent_pipe.recv()

2578

1993

command = request[0]

2579

1994

2580

1995

if command == 'init':

2581

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

1996

fpr = request[1]

2582

1997

address = request[2]

2583

2584

for c in self.clients.values():

1998

1999

for c in self.clients.itervalues():

2585

2000

if c.fingerprint == fpr:

2586

2001

client = c

2587

2002

break

2594

2009

address[0])

2595

2010

parent_pipe.send(False)

2596

2011

return False

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

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

2605

2021

parent_pipe.send(True)

2606

2022

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

2607

2023

# same fileno

2610

2026

funcname = request[1]

2611

2027

args = request[2]

2612

2028

kwargs = request[3]

2613

2029

2614

2030

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

2615

2031

funcname)(*args,

2616

**kwargs)))

2617

2032

**kwargs)))

2033

2618

2034

if command == 'getattr':

2619

2035

attrname = request[1]

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2036

if callable(client_object.__getattribute__(attrname)):

2037

parent_pipe.send(('function',))

2623

2038

else:

2624

parent_pipe.send((

2625

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

2626

2039

parent_pipe.send(('data', client_object

2040

.__getattribute__(attrname)))

2041

2627

2042

if command == 'setattr':

2628

2043

attrname = request[1]

2629

2044

value = request[2]

2630

2045

setattr(client_object, attrname, value)

2631

2046

2632

2047

return True

2633

2048

2634

2049

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

2734

2050

def string_to_delta(interval):

2735

2051

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

2736

2052

2737

2053

>>> string_to_delta('7d')

2738

2054

datetime.timedelta(7)

2739

2055

>>> string_to_delta('60s')

2747

2063

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

2748

2064

datetime.timedelta(0, 330)

2749

2065

"""

2750

2751

try:

2752

return rfc3339_duration_to_delta(interval)

2753

except ValueError:

2754

pass

2755

2756

2066

timevalue = datetime.timedelta(0)

2757

2067

for s in interval.split():

2758

2068

try:

2759

suffix = s[-1]

2069

suffix = unicode(s[-1])

2760

2070

value = int(s[:-1])

2761

2071

if suffix == "d":

2762

2072

delta = datetime.timedelta(value)

2769

2079

elif suffix == "w":

2770

2080

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

2771

2081

else:

2772

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

2773

except IndexError as e:

2082

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

2083

except (ValueError, IndexError) as e:

2774

2084

raise ValueError(*(e.args))

2775

2085

timevalue += delta

2776

2086

return timevalue

2777

2087

2778

2088

2779

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

2089

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

2780

2090

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

2781

2091

2782

2092

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

2783

2093

if os.fork():

2784

2094

sys.exit()

2792

2102

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

2793

2103

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

2794

2104

raise OSError(errno.ENODEV,

2795

"{} not a character device"

2796

.format(os.devnull))

2105

"%s not a character device"

2106

% os.devnull)

2797

2107

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

2798

2108

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

2799

2109

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

2802

2112

2803

2113

2804

2114

def main():

2805

2115

2806

2116

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

2807

2117

# Parsing of options, both command line and config file

2808

2118

2809

2119

parser = argparse.ArgumentParser()

2810

2120

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

2811

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

2121

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

2812

2122

help="show version number and exit")

2813

2123

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

2814

2124

help="Bind to interface IF")

2820

2130

help="Run self-test")

2821

2131

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

2822

2132

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

2823

" to terminal", default=None)

2133

" to terminal")

2824

2134

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

2825

2135

help="Debug level for stdout output")

2826

2136

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

2833

2143

" files")

2834

2144

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

2835

2145

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

2836

" system bus interface", default=None)

2146

" system bus interface")

2837

2147

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

2838

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

2839

default=None)

2148

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

2840

2149

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

2841

2150

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

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

2151

" state")

2846

2152

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

2847

2153

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

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

2154

2854

2155

options = parser.parse_args()

2855

2156

2856

2157

if options.check:

2857

2158

import doctest

2858

fail_count, test_count = doctest.testmod()

2859

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

2860

2159

doctest.testmod()

2160

sys.exit()

2161

2861

2162

# Default values for config file for server-global settings

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

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

2880

2177

# Parse config file for server-global settings

2881

2178

server_config = configparser.SafeConfigParser(server_defaults)

2882

2179

del server_defaults

2883

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

2180

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

2181

"mandos.conf"))

2884

2182

# Convert the SafeConfigParser object to a dict

2885

2183

server_settings = server_config.defaults()

2886

2184

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

2887

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

2888

"foreground", "zeroconf"):

2185

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

2889

2186

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

2890

2187

option)

2891

2188

if server_settings["port"]:

2892

2189

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

2893

2190

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

2903

2191

del server_config

2904

2192

2905

2193

# Override the settings from the config file with command line

2906

2194

# options, if set.

2907

2195

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

2908

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

2909

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

2910

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

2196

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

2197

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

2198

"statedir"):

2911

2199

value = getattr(options, option)

2912

2200

if value is not None:

2913

2201

server_settings[option] = value

2914

2202

del options

2915

2203

# Force all strings to be unicode

2916

2204

for option in server_settings.keys():

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

2205

if type(server_settings[option]) is str:

2206

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

2927

2207

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

2928

2208

2929

2209

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

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

2210

2936

2211

# For convenience

2937

2212

debug = server_settings["debug"]

2938

2213

debuglevel = server_settings["debuglevel"]

2940

2215

use_ipv6 = server_settings["use_ipv6"]

2941

2216

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

2942

2217

stored_state_file)

2943

foreground = server_settings["foreground"]

2944

zeroconf = server_settings["zeroconf"]

2945

2218

2946

2219

if debug:

2947

2220

initlogger(debug, logging.DEBUG)

2948

2221

else:

2951

2224

else:

2952

2225

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

2953

2226

initlogger(debug, level)

2954

2227

2955

2228

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

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2229

syslogger.setFormatter(logging.Formatter

2230

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

2231

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

2232

% server_settings["servicename"]))

2233

2961

2234

# Parse config file with clients

2962

2235

client_config = configparser.SafeConfigParser(Client

2963

2236

.client_defaults)

2964

2237

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

2965

2238

"clients.conf"))

2966

2239

2967

2240

global mandos_dbus_service

2968

2241

mandos_dbus_service = None

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

2986

try:

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

2995

try:

2996

uid = pwd.getpwnam(name).pw_uid

2997

gid = pwd.getpwnam(group).pw_gid

2998

break

2242

2243

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

2244

server_settings["port"]),

2245

ClientHandler,

2246

interface=(server_settings["interface"]

2247

or None),

2248

use_ipv6=use_ipv6,

2249

gnutls_priority=

2250

server_settings["priority"],

2251

use_dbus=use_dbus)

2252

if not debug:

2253

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

2254

try:

2255

pidfile = open(pidfilename, "w")

2256

except IOError:

2257

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

2258

2259

try:

2260

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

2261

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

2262

except KeyError:

2263

try:

2264

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

2265

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

2999

2266

except KeyError:

3000

continue

3001

else:

3002

uid = 65534

3003

gid = 65534

2267

try:

2268

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

2269

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

2270

except KeyError:

2271

uid = 65534

2272

gid = 65534

3004

2273

try:

3005

2274

os.setgid(gid)

3006

2275

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

3010

2276

except OSError as error:

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

2277

if error[0] != errno.EPERM:

2278

raise error

2279

3016

2280

if debug:

3017

2281

# Enable all possible GnuTLS debugging

3018

2282

3019

2283

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

3020

2284

# - GnuTLS manual

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2285

gnutls.library.functions.gnutls_global_set_log_level(11)

2286

2287

@gnutls.library.types.gnutls_log_func

3024

2288

def debug_gnutls(level, string):

3025

2289

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

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2290

2291

(gnutls.library.functions

2292

.gnutls_global_set_log_function(debug_gnutls))

2293

3029

2294

# Redirect stdin so all checkers get /dev/null

3030

2295

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

3031

2296

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

3032

2297

if null > 2:

3033

2298

os.close(null)

3034

2299

3035

2300

# Need to fork before connecting to D-Bus

3036

if not foreground:

2301

if not debug:

3037

2302

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

3038

2303

daemon()

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

2304

2305

gobject.threads_init()

2306

3044

2307

global main_loop

3045

2308

# From the Avahi example code

3046

2309

DBusGMainLoop(set_as_default=True)

3047

main_loop = GLib.MainLoop()

2310

main_loop = gobject.MainLoop()

3048

2311

bus = dbus.SystemBus()

3049

2312

# End of Avahi example code

3050

2313

if use_dbus:

3051

2314

try:

3052

2315

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

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)

2316

bus, do_not_queue=True)

2317

old_bus_name = (dbus.service.BusName

2318

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

2319

do_not_queue=True))

2320

except dbus.exceptions.NameExistsException as e:

2321

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

3060

2322

use_dbus = False

3061

2323

server_settings["use_dbus"] = False

3062

2324

tcp_server.use_dbus = False

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

2325

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2326

service = AvahiServiceToSyslog(name =

2327

server_settings["servicename"],

2328

servicetype = "_mandos._tcp",

2329

protocol = protocol, bus = bus)

2330

if server_settings["interface"]:

2331

service.interface = (if_nametoindex

2332

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

2333

3074

2334

global multiprocessing_manager

3075

2335

multiprocessing_manager = multiprocessing.Manager()

3076

2336

3077

2337

client_class = Client

3078

2338

if use_dbus:

3079

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

3080

2339

client_class = functools.partial(ClientDBusTransitional,

2340

bus = bus)

2341

3081

2342

client_settings = Client.config_parser(client_config)

3082

2343

old_client_settings = {}

3083

2344

clients_data = {}

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

2345

3093

2346

# Get client data and settings from last running state.

3094

2347

if server_settings["restore"]:

3095

2348

try:

3096

2349

with open(stored_state_path, "rb") as 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"))

2350

clients_data, old_client_settings = (pickle.load

2351

(stored_state))

3142

2352

os.remove(stored_state_path)

3143

2353

except IOError as e:

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)

2354

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

2355

.format(e))

2356

if e.errno != errno.ENOENT:

3150

2357

raise

3151

2358

except EOFError as e:

3152

2359

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

3153

"EOFError:",

3154

exc_info=e)

3155

2360

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

2361

3156

2362

with PGPEngine() as pgp:

3157

for client_name, client in clients_data.items():

3158

# Skip removed clients

3159

if client_name not in client_settings:

3160

continue

3161

2363

for client_name, client in clients_data.iteritems():

3162

2364

# Decide which value to use after restoring saved state.

3163

2365

# We have three different values: Old config file,

3164

2366

# new config file, and saved state.

3169

2371

# For each value in new config, check if it

3170

2372

# differs from the old config value (Except for

3171

2373

# the "secret" attribute)

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2374

if (name != "secret" and

2375

value != old_client_settings[client_name]

2376

[name]):

3175

2377

client[name] = value

3176

2378

except KeyError:

3177

2379

pass

3178

2380

3179

2381

# Clients who has passed its expire date can still be

3180

# enabled if its last checker was successful. A Client

2382

# enabled if its last checker was successful. Clients

3181

2383

# whose checker succeeded before we stored its state is

3182

2384

# assumed to have successfully run all checkers during

3183

2385

# downtime.

3185

2387

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

3186

2388

if not client["last_checked_ok"]:

3187

2389

logger.warning(

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2390

"disabling client {0} - Client never "

2391

"performed a successful checker"

2392

.format(client_name))

3191

2393

client["enabled"] = False

3192

2394

elif client["last_checker_status"] != 0:

3193

2395

logger.warning(

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2396

"disabling client {0} - Client "

2397

"last checker failed with error code {1}"

2398

.format(client_name,

2399

client["last_checker_status"]))

3199

2400

client["enabled"] = False

3200

2401

else:

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2402

client["expires"] = (datetime.datetime

2403

.utcnow()

2404

+ client["timeout"])

3204

2405

logger.debug("Last checker succeeded,"

3205

" keeping {} enabled".format(

3206

client_name))

2406

" keeping {0} enabled"

2407

.format(client_name))

3207

2408

try:

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2409

client["secret"] = (

2410

pgp.decrypt(client["encrypted_secret"],

2411

client_settings[client_name]

2412

["secret"]))

3211

2413

except PGPError:

3212

2414

# If decryption fails, we use secret from new settings

3213

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

3214

client_name))

3215

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

3216

["secret"])

2415

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

2416

.format(client_name))

2417

client["secret"] = (

2418

client_settings[client_name]["secret"])

3217

2419

2420

3218

2421

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

3219

2422

for client_name in (set(old_client_settings)

3220

2423

- set(client_settings)):

3224

2427

clients_data[client_name] = client_settings[client_name]

3225

2428

3226

2429

# Create all client objects

3227

for client_name, client in clients_data.items():

2430

for client_name, client in clients_data.iteritems():

3228

2431

tcp_server.clients[client_name] = client_class(

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2432

name = client_name, settings = client)

2433

3233

2434

if not tcp_server.clients:

3234

2435

logger.warning("No clients defined")

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

2436

2437

if not debug:

2438

try:

2439

with pidfile:

2440

pid = os.getpid()

2441

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

2442

del pidfile

2443

except IOError:

2444

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

2445

pidfilename, pid)

2446

except NameError:

2447

# "pidfile" was never created

2448

pass

3246

2449

del pidfilename

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

2450

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

2451

2452

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

2453

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

2454

3252

2455

if use_dbus:

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2456

class MandosDBusService(DBusObjectWithProperties):

3257

2457

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

3258

3259

2458

def __init__(self):

3260

2459

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

3261

3262

2460

_interface = "se.recompile.Mandos"

3263

2461

2462

@dbus_interface_annotations(_interface)

2463

def _foo(self):

2464

return { "org.freedesktop.DBus.Property"

2465

".EmitsChangedSignal":

2466

"false"}

2467

3264

2468

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

3265

2469

def ClientAdded(self, objpath):

3266

2470

"D-Bus signal"

3267

2471

pass

3268

2472

3269

2473

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

3270

2474

def ClientNotFound(self, fingerprint, address):

3271

2475

"D-Bus signal"

3272

2476

pass

3273

3274

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

3275

"true"})

2477

3276

2478

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

3277

2479

def ClientRemoved(self, objpath, name):

3278

2480

"D-Bus signal"

3279

2481

pass

3280

3281

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

3282

"true"})

2482

3283

2483

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

3284

2484

def GetAllClients(self):

3285

2485

"D-Bus method"

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

return dbus.Array(c.dbus_object_path

2487

for c in

2488

tcp_server.clients.itervalues())

2489

3291

2490

@dbus.service.method(_interface,

3292

2491

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

3293

2492

def GetAllClientsWithProperties(self):

3294

2493

"D-Bus method"

3295

2494

return dbus.Dictionary(

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2495

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

2496

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

3299

2497

signature="oa{sv}")

3300

2498

3301

2499

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

3302

2500

def RemoveClient(self, object_path):

3303

2501

"D-Bus method"

3304

for c in tcp_server.clients.values():

2502

for c in tcp_server.clients.itervalues():

3305

2503

if c.dbus_object_path == object_path:

3306

2504

del tcp_server.clients[c.name]

3307

2505

c.remove_from_connection()

3308

# Don't signal the disabling

2506

# Don't signal anything except ClientRemoved

3309

2507

c.disable(quiet=True)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2508

# Emit D-Bus signal

2509

self.ClientRemoved(object_path, c.name)

3312

2510

return

3313

2511

raise KeyError(object_path)

3314

2512

3315

2513

del _interface

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

2514

2515

class MandosDBusServiceTransitional(MandosDBusService):

2516

__metaclass__ = AlternateDBusNamesMetaclass

2517

mandos_dbus_service = MandosDBusServiceTransitional()

2518

3360

2519

def cleanup():

3361

2520

"Cleanup function; run on exit"

3362

if zeroconf:

3363

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2521

service.cleanup()

2522

2523

multiprocessing.active_children()

3367

2524

if not (tcp_server.clients or client_settings):

3368

2525

return

3369

2526

3370

2527

# Store client before exiting. Secrets are encrypted with key

3371

2528

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

3372

2529

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

3373

2530

clients = {}

3374

2531

with PGPEngine() as pgp:

3375

for client in tcp_server.clients.values():

2532

for client in tcp_server.clients.itervalues():

3376

2533

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

3377

2534

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

3378

2535

key)

3379

2536

client_dict = {}

3380

2537

3381

2538

# A list of attributes that can not be pickled

3382

2539

# + secret.

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2540

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

2541

"checker"))

2542

for name, typ in (inspect.getmembers

2543

(dbus.service.Object)):

3387

2544

exclude.add(name)

3388

2545

3389

2546

client_dict["encrypted_secret"] = (client

3390

2547

.encrypted_secret)

3391

2548

for attr in client.client_structure:

3392

2549

if attr not in exclude:

3393

2550

client_dict[attr] = getattr(client, attr)

3394

2551

3395

2552

clients[client.name] = client_dict

3396

2553

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

3397

2554

3398

2555

try:

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

2556

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

2557

prefix="clients-",

2558

dir=os.path.dirname

2559

(stored_state_path))

2560

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

2561

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

3408

2562

os.rename(tempname, stored_state_path)

3409

2563

except (IOError, OSError) as e:

2564

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

2565

.format(e))

3410

2566

if not debug:

3411

2567

try:

3412

2568

os.remove(tempname)

3413

2569

except NameError:

3414

2570

pass

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

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

2572

errno.EEXIST)):

2573

raise e

2574

3423

2575

# Delete all clients, and settings from config

3424

2576

while tcp_server.clients:

3425

2577

name, client = tcp_server.clients.popitem()

3426

2578

if use_dbus:

3427

2579

client.remove_from_connection()

3428

# Don't signal the disabling

2580

# Don't signal anything except ClientRemoved

3429

2581

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

3431

2582

if use_dbus:

3432

mandos_dbus_service.client_removed_signal(client)

2583

# Emit D-Bus signal

2584

mandos_dbus_service.ClientRemoved(client

2585

.dbus_object_path,

2586

client.name)

3433

2587

client_settings.clear()

3434

2588

3435

2589

atexit.register(cleanup)

3436

3437

for client in tcp_server.clients.values():

2590

2591

for client in tcp_server.clients.itervalues():

3438

2592

if use_dbus:

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2593

# Emit D-Bus signal

2594

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3441

2595

# Need to initiate checking of clients

3442

2596

if client.enabled:

3443

2597

client.init_checker()

3444

2598

3445

2599

tcp_server.enable()

3446

2600

tcp_server.server_activate()

3447

2601

3448

2602

# Find out what port we got

3449

if zeroconf:

3450

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

2603

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

3451

2604

if use_ipv6:

3452

2605

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

3453

" flowinfo %d, scope_id %d",

3454

*tcp_server.socket.getsockname())

2606

" flowinfo %d, scope_id %d"

2607

% tcp_server.socket.getsockname())

3455

2608

else: # IPv4

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

2609

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

2610

% tcp_server.socket.getsockname())

2611

2612

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

2613

3461

2614

try:

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

2615

# From the Avahi example code

2616

try:

2617

service.activate()

2618

except dbus.exceptions.DBusException as error:

2619

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

2620

cleanup()

2621

sys.exit(1)

2622

# End of Avahi example code

2623

2624

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

2625

lambda *args, **kwargs:

2626

(tcp_server.handle_request

2627

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

2628

3477

2629

logger.debug("Starting main loop")

3478

2630

main_loop.run()

3479

2631

except AvahiError as error:

3480

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

2632

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

3481

2633

cleanup()

3482

2634

sys.exit(1)

3483

2635

except KeyboardInterrupt:

3488

2640

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

3489

2641

cleanup()

3490

2642

3491

3492

2643

if __name__ == '__main__':

3493

2644

main()