/mandos/trunk : revision 564

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

#

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

19

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

23

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

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

# GNU General Public License for more details.

26

#

26

#

27

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

28

# along with this program. If not, see

29

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

30

#

30

#

31

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

32

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

37

import SocketServer as socketserver

46

38

import socket

47

39

import argparse

48

40

import datetime

49

41

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

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

54

49

import sys

55

50

import re

56

51

import os

65

60

import struct

66

61

import fcntl

67

62

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

63

import cPickle as pickle

72

64

import multiprocessing

73

65

import types

74

66

import binascii

75

67

import tempfile

76

68

import itertools

77

import collections

78

import codecs

79

69

80

70

import dbus

81

71

import dbus.service

82

from gi.repository import GLib

72

import gobject

73

import avahi

83

74

from dbus.mainloop.glib import DBusGMainLoop

84

75

import ctypes

85

76

import ctypes.util

86

77

import xml.dom.minidom

87

78

import inspect

79

import GnuPGInterface

88

80

89

# Try to find the value of SO_BINDTODEVICE:

90

81

try:

91

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

92

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

93

82

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

83

except AttributeError:

95

84

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

85

from IN import SO_BINDTODEVICE

99

86

except ImportError:

100

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

101

# Try running the C preprocessor:

102

try:

103

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

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

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

109

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

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.13"

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

118

90

stored_state_file = "clients.pickle"

119

91

120

92

logger = logging.getLogger()

121

syslogger = None

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

122

96

123

97

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

126

101

except (OSError, AttributeError):

127

128

102

def if_nametoindex(interface):

129

103

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

130

104

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

131

105

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

132

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

133

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

134

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]

135

111

return interface_index

136

112

137

113

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

154

114

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

155

115

"""init logger and add loglevel"""

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

160

address="/dev/log"))

116

161

117

syslogger.setFormatter(logging.Formatter

162

118

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

163

119

' %(message)s'))

164

120

logger.addHandler(syslogger)

165

121

166

122

if debug:

167

123

console = logging.StreamHandler()

168

124

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

180

136

181

137

class PGPEngine(object):

182

138

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

183

184

139

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

185

141

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

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

'--force-mdc',

200

'--quiet']

201

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

202

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

203

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

204

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

205

149

def __enter__(self):

206

150

return self

207

208

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

151

152

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

209

153

self._cleanup()

210

154

return False

211

155

212

156

def __del__(self):

213

157

self._cleanup()

214

158

215

159

def _cleanup(self):

216

160

if self.tempdir is not None:

217

161

# Delete contents of tempdir

218

162

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

219

topdown=False):

163

topdown = False):

220

164

for filename in files:

221

165

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

222

166

for dirname in dirs:

224

168

# Remove tempdir

225

169

os.rmdir(self.tempdir)

226

170

self.tempdir = None

227

171

228

172

def password_encode(self, password):

229

173

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

230

174

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

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

238

175

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

176

239

177

def encrypt(self, data, password):

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin=subprocess.PIPE,

250

stdout=subprocess.PIPE,

251

stderr=subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

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

255

192

return ciphertext

256

193

257

194

def decrypt(self, data, password):

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir=self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin=subprocess.PIPE,

268

stdout=subprocess.PIPE,

269

stderr=subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

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

273

209

return decrypted_plaintext

274

210

275

211

276

# Pretend that we have an Avahi module

277

class Avahi(object):

278

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

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

def string_array_to_txt_array(self, t):

290

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

291

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

292

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

293

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

294

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

295

SERVER_INVALID = 0 # avahi-common/defs.h

296

SERVER_REGISTERING = 1 # avahi-common/defs.h

297

SERVER_RUNNING = 2 # avahi-common/defs.h

298

SERVER_COLLISION = 3 # avahi-common/defs.h

299

SERVER_FAILURE = 4 # avahi-common/defs.h

300

avahi = Avahi()

301

302

212

303

213

class AvahiError(Exception):

304

214

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

305

215

self.value = value

306

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

307

**kwargs)

308

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

309

219

310

220

class AvahiServiceError(AvahiError):

311

221

pass

312

222

313

314

223

class AvahiGroupError(AvahiError):

315

224

pass

316

225

317

226

318

227

class AvahiService(object):

319

228

"""An Avahi (Zeroconf) service.

320

229

321

230

Attributes:

322

231

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

323

232

Used to optionally bind to the specified interface.

324

233

name: string; Example: 'Mandos'

325

234

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

326

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

235

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

327

236

port: integer; what port to announce

328

237

TXT: list of strings; TXT record for the service

329

238

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

335

244

server: D-Bus Server

336

245

bus: dbus.SystemBus()

337

246

"""

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

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

350

251

self.interface = interface

351

252

self.name = name

352

253

self.type = servicetype

361

262

self.server = None

362

263

self.bus = bus

363

264

self.entry_group_state_changed_match = None

364

365

def rename(self, remove=True):

265

def rename(self):

366

266

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

367

267

if self.rename_count >= self.max_renames:

368

268

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

369

269

" after %i retries, exiting.",

370

270

self.rename_count)

371

271

raise AvahiServiceError("Too many renames")

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

375

274

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

376

275

self.name)

377

if remove:

378

self.remove()

276

self.remove()

379

277

try:

380

278

self.add()

381

279

except dbus.exceptions.DBusException as error:

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

280

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

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

391

284

def remove(self):

392

285

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

393

286

if self.entry_group_state_changed_match is not None:

395

288

self.entry_group_state_changed_match = None

396

289

if self.group is not None:

397

290

self.group.Reset()

398

399

291

def add(self):

400

292

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

401

293

self.remove()

418

310

dbus.UInt16(self.port),

419

311

avahi.string_array_to_txt_array(self.TXT))

420

312

self.group.Commit()

421

422

313

def entry_group_state_changed(self, state, error):

423

314

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

424

315

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

425

316

426

317

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

318

logger.debug("Zeroconf service established.")

428

319

elif state == avahi.ENTRY_GROUP_COLLISION:

430

321

self.rename()

431

322

elif state == avahi.ENTRY_GROUP_FAILURE:

432

323

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

433

str(error))

434

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

435

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

436

327

def cleanup(self):

437

328

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

438

329

if self.group is not None:

443

334

pass

444

335

self.group = None

445

336

self.remove()

446

447

337

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

448

338

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

449

339

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

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

456

347

if state in bad_states:

457

348

if bad_states[state] is not None:

458

349

if error is None:

461

352

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

462

353

self.cleanup()

463

354

elif state == avahi.SERVER_RUNNING:

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

355

self.add()

476

356

else:

477

357

if error is None:

478

358

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

479

359

else:

480

360

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

481

482

361

def activate(self):

483

362

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

484

363

if self.server is None:

488

367

follow_name_owner_changes=True),

489

368

avahi.DBUS_INTERFACE_SERVER)

490

369

self.server.connect_to_signal("StateChanged",

491

self.server_state_changed)

370

self.server_state_changed)

492

371

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

493

372

494

495

373

class AvahiServiceToSyslog(AvahiService):

496

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

374

def rename(self):

497

375

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

498

ret = AvahiService.rename(self, *args, **kwargs)

499

syslogger.setFormatter(logging.Formatter(

500

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

501

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

502

381

return ret

503

382

504

505

# Pretend that we have a GnuTLS module

506

class GnuTLS(object):

507

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

508

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

509

510

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

511

if library is None:

512

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

513

_library = ctypes.cdll.LoadLibrary(library)

514

del library

515

_need_version = b"3.3.0"

516

517

def __init__(self):

518

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

519

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

520

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

521

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

522

.format(self._need_version))

523

524

# Unless otherwise indicated, the constants and types below are

525

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

526

527

# Constants

528

E_SUCCESS = 0

529

E_INTERRUPTED = -52

530

E_AGAIN = -28

531

CRT_OPENPGP = 2

532

CLIENT = 2

533

SHUT_RDWR = 0

534

CRD_CERTIFICATE = 1

535

E_NO_CERTIFICATE_FOUND = -49

536

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

537

538

# Types

539

class session_int(ctypes.Structure):

540

_fields_ = []

541

session_t = ctypes.POINTER(session_int)

542

543

class certificate_credentials_st(ctypes.Structure):

544

_fields_ = []

545

certificate_credentials_t = ctypes.POINTER(

546

certificate_credentials_st)

547

certificate_type_t = ctypes.c_int

548

549

class datum_t(ctypes.Structure):

550

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

551

('size', ctypes.c_uint)]

552

553

class openpgp_crt_int(ctypes.Structure):

554

_fields_ = []

555

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

556

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

557

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

558

credentials_type_t = ctypes.c_int

559

transport_ptr_t = ctypes.c_void_p

560

close_request_t = ctypes.c_int

561

562

# Exceptions

563

class Error(Exception):

564

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

565

# exception might be raised from within GnuTLS.__init__,

566

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

567

# global variable has happened.

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = GnuTLS.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials(object):

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession(object):

593

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

594

self._c_object = gnutls.session_t()

595

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

596

gnutls.set_default_priority(self._c_object)

597

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

598

gnutls.handshake_set_private_extensions(self._c_object,

599

True)

600

self.socket = socket

601

if credentials is None:

602

credentials = gnutls.Credentials()

603

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

604

ctypes.cast(credentials._c_object,

605

ctypes.c_void_p))

606

self.credentials = credentials

607

608

def __del__(self):

609

gnutls.deinit(self._c_object)

610

611

def handshake(self):

612

return gnutls.handshake(self._c_object)

613

614

def send(self, data):

615

data = bytes(data)

616

data_len = len(data)

617

while data_len > 0:

618

data_len -= gnutls.record_send(self._c_object,

619

data[-data_len:],

620

data_len)

621

622

def bye(self):

623

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

624

625

# Error handling functions

626

def _error_code(result):

627

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

628

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

629

if result >= 0:

630

return result

631

if result == gnutls.E_NO_CERTIFICATE_FOUND:

632

raise gnutls.CertificateSecurityError(code=result)

633

raise gnutls.Error(code=result)

634

635

def _retry_on_error(result, func, arguments):

636

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

637

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

638

while result < 0:

639

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

640

return _error_code(result)

641

result = func(*arguments)

642

return result

643

644

# Unless otherwise indicated, the function declarations below are

645

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

646

647

# Functions

648

priority_set_direct = _library.gnutls_priority_set_direct

649

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

650

ctypes.POINTER(ctypes.c_char_p)]

651

priority_set_direct.restype = _error_code

652

653

init = _library.gnutls_init

654

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

655

init.restype = _error_code

656

657

set_default_priority = _library.gnutls_set_default_priority

658

set_default_priority.argtypes = [session_t]

659

set_default_priority.restype = _error_code

660

661

record_send = _library.gnutls_record_send

662

record_send.argtypes = [session_t, ctypes.c_void_p,

663

ctypes.c_size_t]

664

record_send.restype = ctypes.c_ssize_t

665

record_send.errcheck = _retry_on_error

666

667

certificate_allocate_credentials = (

668

_library.gnutls_certificate_allocate_credentials)

669

certificate_allocate_credentials.argtypes = [

670

ctypes.POINTER(certificate_credentials_t)]

671

certificate_allocate_credentials.restype = _error_code

672

673

certificate_free_credentials = (

674

_library.gnutls_certificate_free_credentials)

675

certificate_free_credentials.argtypes = [

676

certificate_credentials_t]

677

certificate_free_credentials.restype = None

678

679

handshake_set_private_extensions = (

680

_library.gnutls_handshake_set_private_extensions)

681

handshake_set_private_extensions.argtypes = [session_t,

682

ctypes.c_int]

683

handshake_set_private_extensions.restype = None

684

685

credentials_set = _library.gnutls_credentials_set

686

credentials_set.argtypes = [session_t, credentials_type_t,

687

ctypes.c_void_p]

688

credentials_set.restype = _error_code

689

690

strerror = _library.gnutls_strerror

691

strerror.argtypes = [ctypes.c_int]

692

strerror.restype = ctypes.c_char_p

693

694

certificate_type_get = _library.gnutls_certificate_type_get

695

certificate_type_get.argtypes = [session_t]

696

certificate_type_get.restype = _error_code

697

698

certificate_get_peers = _library.gnutls_certificate_get_peers

699

certificate_get_peers.argtypes = [session_t,

700

ctypes.POINTER(ctypes.c_uint)]

701

certificate_get_peers.restype = ctypes.POINTER(datum_t)

702

703

global_set_log_level = _library.gnutls_global_set_log_level

704

global_set_log_level.argtypes = [ctypes.c_int]

705

global_set_log_level.restype = None

706

707

global_set_log_function = _library.gnutls_global_set_log_function

708

global_set_log_function.argtypes = [log_func]

709

global_set_log_function.restype = None

710

711

deinit = _library.gnutls_deinit

712

deinit.argtypes = [session_t]

713

deinit.restype = None

714

715

handshake = _library.gnutls_handshake

716

handshake.argtypes = [session_t]

717

handshake.restype = _error_code

718

handshake.errcheck = _retry_on_error

719

720

transport_set_ptr = _library.gnutls_transport_set_ptr

721

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

722

transport_set_ptr.restype = None

723

724

bye = _library.gnutls_bye

725

bye.argtypes = [session_t, close_request_t]

726

bye.restype = _error_code

727

bye.errcheck = _retry_on_error

728

729

check_version = _library.gnutls_check_version

730

check_version.argtypes = [ctypes.c_char_p]

731

check_version.restype = ctypes.c_char_p

732

733

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

734

735

openpgp_crt_init = _library.gnutls_openpgp_crt_init

736

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

737

openpgp_crt_init.restype = _error_code

738

739

openpgp_crt_import = _library.gnutls_openpgp_crt_import

740

openpgp_crt_import.argtypes = [openpgp_crt_t,

741

ctypes.POINTER(datum_t),

742

openpgp_crt_fmt_t]

743

openpgp_crt_import.restype = _error_code

744

745

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

746

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

747

ctypes.POINTER(ctypes.c_uint)]

748

openpgp_crt_verify_self.restype = _error_code

749

750

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

751

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

752

openpgp_crt_deinit.restype = None

753

754

openpgp_crt_get_fingerprint = (

755

_library.gnutls_openpgp_crt_get_fingerprint)

756

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

757

ctypes.c_void_p,

758

ctypes.POINTER(

759

ctypes.c_size_t)]

760

openpgp_crt_get_fingerprint.restype = _error_code

761

762

# Remove non-public functions

763

del _error_code, _retry_on_error

764

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

765

gnutls = GnuTLS()

766

767

768

def call_pipe(connection, # : multiprocessing.Connection

769

func, *args, **kwargs):

770

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

771

772

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

773

return value on the provided multiprocessing.Connection.

774

"""

775

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

776

connection.close()

777

778

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

779

389

class Client(object):

780

390

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

781

391

782

392

Attributes:

783

393

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

784

394

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

786

396

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

787

397

to see if the client lives.

788

398

'None' if no process is running.

789

checker_callback_tag: a GLib event source tag, or None

399

checker_callback_tag: a gobject event source tag, or None

790

400

checker_command: string; External command which is run to check

791

401

if client lives. %() expansions are done at

792

402

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

793

403

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

794

checker_initiator_tag: a GLib event source tag, or None

404

checker_initiator_tag: a gobject event source tag, or None

795

405

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

796

406

client_structure: Object describing what attributes a client has

797

407

and is used for storing the client at exit

798

408

current_checker_command: string; current running checker_command

799

disable_initiator_tag: a GLib event source tag, or None

409

disable_initiator_tag: a gobject event source tag, or None

800

410

enabled: bool()

801

411

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

802

412

uniquely identify the client

807

417

last_checker_status: integer between 0 and 255 reflecting exit

808

418

status of last checker. -1 reflects crashed

809

419

checker, -2 means no checker completed yet.

810

last_checker_signal: The signal which killed the last checker, if

811

last_checker_status is -1

812

420

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

813

421

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

814

422

D-Bus identifiers

819

427

runtime_expansions: Allowed attributes for runtime expansion.

820

428

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

821

429

disabled, or None

822

server_settings: The server_settings dict from main()

823

430

"""

824

431

825

432

runtime_expansions = ("approval_delay", "approval_duration",

826

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

827

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

828

"last_approval_request", "last_checked_ok",

433

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

434

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

829

435

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

830

client_defaults = {

831

"timeout": "PT5M",

832

"extended_timeout": "PT15M",

833

"interval": "PT2M",

834

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

835

"host": "",

836

"approval_delay": "PT0S",

837

"approval_duration": "PT1S",

838

"approved_by_default": "True",

839

"enabled": "True",

840

}

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)

841

461

842

462

@staticmethod

843

463

def config_parser(config):

851

471

for client_name in config.sections():

852

472

section = dict(config.items(client_name))

853

473

client = settings[client_name] = {}

854

474

855

475

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

856

476

# Reformat values from string types to Python types

857

477

client["approved_by_default"] = config.getboolean(

858

478

client_name, "approved_by_default")

859

479

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

860

480

"enabled")

861

862

# Uppercase and remove spaces from fingerprint for later

863

# comparison purposes with return value from the

864

# fingerprint() function

481

865

482

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

866

483

.replace(" ", ""))

867

484

if "secret" in section:

868

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

869

.encode("utf-8"),

870

"base64")

485

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

871

486

elif "secfile" in section:

872

487

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

873

488

(section["secfile"])),

874

489

"rb") as secfile:

875

490

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

876

491

else:

877

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

878

.format(section))

492

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

493

% section)

879

494

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

880

495

client["extended_timeout"] = string_to_delta(

881

496

section["extended_timeout"])

888

503

client["last_approval_request"] = None

889

504

client["last_checked_ok"] = None

890

505

client["last_checker_status"] = -2

891

506

892

507

return settings

893

894

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

895

514

self.name = name

896

if server_settings is None:

897

server_settings = {}

898

self.server_settings = server_settings

899

515

# adding all client settings

900

for setting, value in settings.items():

516

for setting, value in settings.iteritems():

901

517

setattr(self, setting, value)

902

518

903

519

if self.enabled:

904

520

if not hasattr(self, "last_enabled"):

905

521

self.last_enabled = datetime.datetime.utcnow()

909

525

else:

910

526

self.last_enabled = None

911

527

self.expires = None

912

528

913

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

914

533

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

915

534

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

916

535

datetime.datetime.utcnow())

923

542

self.current_checker_command = None

924

543

self.approved = None

925

544

self.approvals_pending = 0

926

self.changedstate = multiprocessing_manager.Condition(

927

multiprocessing_manager.Lock())

928

self.client_structure = [attr

929

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

930

550

if not attr.startswith("_")]

931

551

self.client_structure.append("client_structure")

932

933

for name, t in inspect.getmembers(

934

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

935

557

if not name.startswith("_"):

936

558

self.client_structure.append(name)

937

559

938

560

# Send notice to process children that client state has changed

939

561

def send_changedstate(self):

940

562

with self.changedstate:

941

563

self.changedstate.notify_all()

942

564

943

565

def enable(self):

944

566

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

945

567

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

946

568

# Already enabled

947

569

return

570

self.send_changedstate()

948

571

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

949

572

self.enabled = True

950

573

self.last_enabled = datetime.datetime.utcnow()

951

574

self.init_checker()

952

self.send_changedstate()

953

575

954

576

def disable(self, quiet=True):

955

577

"""Disable this client."""

956

578

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

957

579

return False

958

580

if not quiet:

581

self.send_changedstate()

582

if not quiet:

959

583

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

960

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

961

GLib.source_remove(self.disable_initiator_tag)

584

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

585

gobject.source_remove(self.disable_initiator_tag)

962

586

self.disable_initiator_tag = None

963

587

self.expires = None

964

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

965

GLib.source_remove(self.checker_initiator_tag)

588

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

589

gobject.source_remove(self.checker_initiator_tag)

966

590

self.checker_initiator_tag = None

967

591

self.stop_checker()

968

592

self.enabled = False

969

if not quiet:

970

self.send_changedstate()

971

# 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

972

594

return False

973

595

974

596

def __del__(self):

975

597

self.disable()

976

598

977

599

def init_checker(self):

978

600

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

979

601

# and every interval from then on.

980

if self.checker_initiator_tag is not None:

981

GLib.source_remove(self.checker_initiator_tag)

982

self.checker_initiator_tag = GLib.timeout_add(

983

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

984

self.start_checker)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

self.start_checker))

985

605

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

986

if self.disable_initiator_tag is not None:

987

GLib.source_remove(self.disable_initiator_tag)

988

self.disable_initiator_tag = GLib.timeout_add(

989

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

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

self.disable))

990

609

# Also start a new checker *right now*.

991

610

self.start_checker()

992

993

def checker_callback(self, source, condition, connection,

994

command):

611

612

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

995

613

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

996

614

self.checker_callback_tag = None

997

615

self.checker = None

998

# Read return code from connection (see call_pipe)

999

returncode = connection.recv()

1000

connection.close()

1001

1002

if returncode >= 0:

1003

self.last_checker_status = returncode

1004

self.last_checker_signal = None

616

if os.WIFEXITED(condition):

617

self.last_checker_status = os.WEXITSTATUS(condition)

1005

618

if self.last_checker_status == 0:

1006

619

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

1007

620

vars(self))

1008

621

self.checked_ok()

1009

622

else:

1010

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

623

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

624

vars(self))

1011

625

else:

1012

626

self.last_checker_status = -1

1013

self.last_checker_signal = -returncode

1014

627

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

1015

628

vars(self))

1016

return False

1017

629

1018

630

def checked_ok(self):

1019

631

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

1020

632

self.last_checked_ok = datetime.datetime.utcnow()

1021

633

self.last_checker_status = 0

1022

self.last_checker_signal = None

1023

634

self.bump_timeout()

1024

635

1025

636

def bump_timeout(self, timeout=None):

1026

637

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

1027

638

if timeout is None:

1028

639

timeout = self.timeout

1029

640

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = None

641

gobject.source_remove(self.disable_initiator_tag)

1032

642

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

1033

self.disable_initiator_tag = GLib.timeout_add(

1034

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1035

646

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

1036

647

1037

648

def need_approval(self):

1038

649

self.last_approval_request = datetime.datetime.utcnow()

1039

650

1040

651

def start_checker(self):

1041

652

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

1042

653

1043

654

If a checker already exists, leave it running and do

1044

655

nothing."""

1045

656

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

1046

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

1047

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

1048

# would inevitably timeout, since no checker would get a

1049

# 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

1050

661

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

1051

662

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

1052

663

# should be.

1053

1054

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

1055

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

1056

self.checker.join()

1057

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)

1058

678

# Start a new checker if needed

1059

679

if self.checker is None:

1060

# Escape attributes for the shell

1061

escaped_attrs = {

1062

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

1063

for attr in self.runtime_expansions}

1064

680

try:

1065

command = self.checker_command % escaped_attrs

1066

except TypeError as error:

1067

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

1068

self.checker_command,

1069

exc_info=error)

1070

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

1071

699

self.current_checker_command = command

1072

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

1073

self.name)

1074

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

1075

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

1076

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

1077

# always replaced by /dev/null.)

1078

# The exception is when not debugging but nevertheless

1079

# running in the foreground; use the previously

1080

# created wnull.

1081

popen_args = {"close_fds": True,

1082

"shell": True,

1083

"cwd": "/"}

1084

if (not self.server_settings["debug"]

1085

and self.server_settings["foreground"]):

1086

popen_args.update({"stdout": wnull,

1087

"stderr": wnull})

1088

pipe = multiprocessing.Pipe(duplex=False)

1089

self.checker = multiprocessing.Process(

1090

target=call_pipe,

1091

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

1092

kwargs=popen_args)

1093

self.checker.start()

1094

self.checker_callback_tag = GLib.io_add_watch(

1095

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

1096

self.checker_callback, pipe[0], command)

1097

# 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

1098

724

return True

1099

725

1100

726

def stop_checker(self):

1101

727

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

1102

728

if self.checker_callback_tag:

1103

GLib.source_remove(self.checker_callback_tag)

729

gobject.source_remove(self.checker_callback_tag)

1104

730

self.checker_callback_tag = None

1105

731

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

1106

732

return

1107

733

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

1108

self.checker.terminate()

734

try:

735

self.checker.terminate()

736

#time.sleep(0.5)

737

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

738

# self.checker.kill()

739

except OSError as error:

740

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

741

raise

1109

742

self.checker = None

1110

743

1111

744

1112

def dbus_service_property(dbus_interface,

1113

signature="v",

1114

access="readwrite",

1115

byte_arrays=False):

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1116

747

"""Decorators for marking methods of a DBusObjectWithProperties to

1117

748

become properties on the D-Bus.

1118

749

1119

750

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

1120

751

and with one argument by "Set".

1121

752

1122

753

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

1123

754

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

1124

755

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

1127

758

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

1128

759

if byte_arrays and signature != "ay":

1129

760

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

1130

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

1131

761

" signature %r" % signature)

1132

762

def decorator(func):

1133

763

func._dbus_is_property = True

1134

764

func._dbus_interface = dbus_interface

1137

767

func._dbus_name = func.__name__

1138

768

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

1139

769

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

1140

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

771

return func

1142

1143

772

return decorator

1144

773

1145

774

1146

775

def dbus_interface_annotations(dbus_interface):

1147

"""Decorator for marking functions returning interface annotations

1148

776

"""Decorator for marking functions returning interface annotations.

777

1149

778

Usage:

1150

779

1151

780

@dbus_interface_annotations("org.example.Interface")

1152

781

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

1153

782

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

1154

783

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

1155

784

"false"}

1156

785

"""

1157

1158

786

def decorator(func):

1159

787

func._dbus_is_interface = True

1160

788

func._dbus_interface = dbus_interface

1161

789

func._dbus_name = dbus_interface

1162

790

return func

1163

1164

791

return decorator

1165

792

1166

793

1167

794

def dbus_annotations(annotations):

1168

795

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

1169

796

Usage:

1170

1171

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

1172

"org.freedesktop.DBus.Property."

1173

"EmitsChangedSignal": "false"})

797

1174

798

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

1175

799

access="r")

800

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

801

"org.freedesktop.DBus.Property."

802

"EmitsChangedSignal": "false"})

1176

803

def Property_dbus_property(self):

1177

804

return dbus.Boolean(False)

1178

1179

See also the DBusObjectWithAnnotations class.

1180

805

"""

1181

1182

806

def decorator(func):

1183

807

func._dbus_annotations = annotations

1184

808

return func

1185

1186

809

return decorator

1187

810

1188

811

1189

812

class DBusPropertyException(dbus.exceptions.DBusException):

1190

813

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

1191

814

"""

1192

pass

815

def __unicode__(self):

816

return unicode(str(self))

1193

817

1194

818

1195

819

class DBusPropertyAccessException(DBusPropertyException):

1204

828

pass

1205

829

1206

830

1207

class DBusObjectWithAnnotations(dbus.service.Object):

1208

"""A D-Bus object with annotations.

1209

1210

Classes inheriting from this can use the dbus_annotations

1211

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.

1212

837

"""

1213

838

1214

839

@staticmethod

1215

840

def _is_dbus_thing(thing):

1216

841

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

1217

842

1218

843

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

1219

844

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

1220

845

"""

1221

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

846

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

1222

847

False)

1223

848

1224

849

def _get_all_dbus_things(self, thing):

1225

850

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

1226

851

"""

1227

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

852

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

853

name),

1228

854

athing.__get__(self))

1229

855

for cls in self.__class__.__mro__

1230

856

for name, athing in

1231

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

1232

1233

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1234

out_signature="s",

1235

path_keyword='object_path',

1236

connection_keyword='connection')

1237

def Introspect(self, object_path, connection):

1238

"""Overloading of standard D-Bus method.

1239

1240

Inserts annotation tags on methods and signals.

1241

"""

1242

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

1243

connection)

1244

try:

1245

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

1246

1247

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

1248

# Add annotation tags

1249

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

1250

for tag in if_tag.getElementsByTagName(typ):

1251

annots = dict()

1252

for name, prop in (self.

1253

_get_all_dbus_things(typ)):

1254

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

1255

and prop._dbus_interface

1256

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

1257

annots.update(getattr(

1258

prop, "_dbus_annotations", {}))

1259

for name, value in annots.items():

1260

ann_tag = document.createElement(

1261

"annotation")

1262

ann_tag.setAttribute("name", name)

1263

ann_tag.setAttribute("value", value)

1264

tag.appendChild(ann_tag)

1265

# Add interface annotation tags

1266

for annotation, value in dict(

1267

itertools.chain.from_iterable(

1268

annotations().items()

1269

for name, annotations

1270

in self._get_all_dbus_things("interface")

1271

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

1272

)).items():

1273

ann_tag = document.createElement("annotation")

1274

ann_tag.setAttribute("name", annotation)

1275

ann_tag.setAttribute("value", value)

1276

if_tag.appendChild(ann_tag)

1277

# Fix argument name for the Introspect method itself

1278

if (if_tag.getAttribute("name")

1279

== dbus.INTROSPECTABLE_IFACE):

1280

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

1281

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

1282

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

1283

if (arg.getAttribute("direction")

1284

== "out"):

1285

arg.setAttribute("name",

1286

"xml_data")

1287

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

1288

document.unlink()

1289

except (AttributeError, xml.dom.DOMException,

1290

xml.parsers.expat.ExpatError) as error:

1291

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

1292

exc_info=error)

1293

return xmlstring

1294

1295

1296

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1297

"""A D-Bus object with properties.

1298

1299

Classes inheriting from this can use the dbus_service_property

1300

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

1301

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

1302

"""

1303

857

inspect.getmembers(cls,

858

self._is_dbus_thing(thing)))

859

1304

860

def _get_dbus_property(self, interface_name, property_name):

1305

861

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

1306

862

property with the specified name and interface.

1307

863

"""

1308

for cls in self.__class__.__mro__:

1309

for name, value in inspect.getmembers(

1310

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

1311

868

if (value._dbus_name == property_name

1312

869

and value._dbus_interface == interface_name):

1313

870

return value.__get__(self)

1314

871

1315

872

# No such property

1316

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

1317

self.dbus_object_path, interface_name, property_name))

1318

1319

@classmethod

1320

def _get_all_interface_names(cls):

1321

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

1322

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

1323

"_dbus_interface", None)

1324

for x in (inspect.getmro(cls))

1325

for attr in dir(x))

1326

if name is not None)

1327

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

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

1330

878

out_signature="v")

1331

879

def Get(self, interface_name, property_name):

1332

880

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

1338

886

if not hasattr(value, "variant_level"):

1339

887

return value

1340

888

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

1341

889

1342

890

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

1343

891

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

1344

892

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

1350

898

# The byte_arrays option is not supported yet on

1351

899

# signatures other than "ay".

1352

900

if prop._dbus_signature != "ay":

1353

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

1354

"'ay' signature {!r}"

1355

.format(prop._dbus_signature))

901

raise ValueError

1356

902

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

1357

903

for byte in value))

1358

904

prop(value)

1359

1360

@dbus.service.method(dbus.PROPERTIES_IFACE,

1361

in_signature="s",

905

906

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

1362

907

out_signature="a{sv}")

1363

908

def GetAll(self, interface_name):

1364

909

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

1365

910

standard.

1366

911

1367

912

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

1368

913

"""

1369

914

properties = {}

1379

924

if not hasattr(value, "variant_level"):

1380

925

properties[name] = value

1381

926

continue

1382

properties[name] = type(value)(

1383

value, variant_level=value.variant_level + 1)

927

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

928

value.variant_level+1)

1384

929

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

1385

1386

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

1387

def PropertiesChanged(self, interface_name, changed_properties,

1388

invalidated_properties):

1389

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

1390

standard.

1391

"""

1392

pass

1393

930

1394

931

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1395

932

out_signature="s",

1396

933

path_keyword='object_path',

1397

934

connection_keyword='connection')

1398

935

def Introspect(self, object_path, connection):

1399

936

"""Overloading of standard D-Bus method.

1400

937

1401

938

Inserts property tags and interface annotation tags.

1402

939

"""

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

940

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

941

connection)

1406

942

try:

1407

943

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

1408

1409

944

def make_tag(document, name, prop):

1410

945

e = document.createElement("property")

1411

946

e.setAttribute("name", name)

1412

947

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

1413

948

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

1414

949

return e

1415

1416

950

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

1417

951

# Add property tags

1418

952

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

1421

955

if prop._dbus_interface

1422

956

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

1423

957

if_tag.appendChild(tag)

1424

# Add annotation tags for properties

1425

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

1426

annots = dict()

1427

for name, prop in self._get_all_dbus_things(

1428

"property"):

1429

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

1430

and prop._dbus_interface

1431

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

1432

annots.update(getattr(

1433

prop, "_dbus_annotations", {}))

1434

for name, value in annots.items():

1435

ann_tag = document.createElement(

1436

"annotation")

1437

ann_tag.setAttribute("name", name)

1438

ann_tag.setAttribute("value", value)

1439

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)

1440

989

# Add the names to the return values for the

1441

990

# "org.freedesktop.DBus.Properties" methods

1442

991

if (if_tag.getAttribute("name")

1457

1006

except (AttributeError, xml.dom.DOMException,

1458

1007

xml.parsers.expat.ExpatError) as error:

1459

1008

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

1460

exc_info=error)

1461

return xmlstring

1462

1463

try:

1464

dbus.OBJECT_MANAGER_IFACE

1465

except AttributeError:

1466

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

1467

1468

1469

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1470

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

1471

1472

Classes inheriting from this exposes the standard

1473

GetManagedObjects call and the InterfacesAdded and

1474

InterfacesRemoved signals on the standard

1475

"org.freedesktop.DBus.ObjectManager" interface.

1476

1477

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

1478

manually.

1479

"""

1480

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1481

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

1482

def GetManagedObjects(self):

1483

"""This function must be overridden"""

1484

raise NotImplementedError()

1485

1486

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1487

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

1488

def InterfacesAdded(self, object_path, interfaces_and_properties):

1489

pass

1490

1491

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

1492

def InterfacesRemoved(self, object_path, interfaces):

1493

pass

1494

1495

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1496

out_signature="s",

1497

path_keyword='object_path',

1498

connection_keyword='connection')

1499

def Introspect(self, object_path, connection):

1500

"""Overloading of standard D-Bus method.

1501

1502

Override return argument name of GetManagedObjects to be

1503

"objpath_interfaces_and_properties"

1504

"""

1505

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1506

object_path,

1507

connection)

1508

try:

1509

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

1510

1511

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

1512

# Fix argument name for the GetManagedObjects method

1513

if (if_tag.getAttribute("name")

1514

== dbus.OBJECT_MANAGER_IFACE):

1515

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

1516

if (cn.getAttribute("name")

1517

== "GetManagedObjects"):

1518

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

1519

if (arg.getAttribute("direction")

1520

== "out"):

1521

arg.setAttribute(

1522

"name",

1523

"objpath_interfaces"

1524

"_and_properties")

1525

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

1526

document.unlink()

1527

except (AttributeError, xml.dom.DOMException,

1528

xml.parsers.expat.ExpatError) as error:

1529

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

1530

exc_info=error)

1531

return xmlstring

1532

1533

1534

def datetime_to_dbus(dt, variant_level=0):

1009

error)

1010

return xmlstring

1011

1012

1013

def datetime_to_dbus (dt, variant_level=0):

1535

1014

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

1536

1015

if dt is None:

1537

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

1538

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

1539

1540

1541

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1542

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

1543

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

1544

interface names according to the "alt_interface_names" mapping.

1545

Usage:

1546

1547

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

1548

"net.example.AlternateInterface"})

1549

class SampleDBusObject(dbus.service.Object):

1550

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

1551

def SampleDBusMethod():

1552

pass

1553

1554

The above "SampleDBusMethod" on "SampleDBusObject" will be

1555

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

1556

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

1557

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

1558

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

1559

1560

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

1561

(from DBusObjectWithProperties) and interfaces (from the

1562

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.

1563

1025

"""

1564

1565

def wrapper(cls):

1566

for orig_interface_name, alt_interface_name in (

1567

alt_interface_names.items()):

1568

attr = {}

1569

interface_names = set()

1570

# Go though all attributes of the class

1571

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

1572

1034

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

1573

1035

# with the wrong interface name

1574

1036

if (not hasattr(attribute, "_dbus_interface")

1575

or not attribute._dbus_interface.startswith(

1576

orig_interface_name)):

1037

or not attribute._dbus_interface

1038

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

1577

1039

continue

1578

1040

# Create an alternate D-Bus interface name based on

1579

1041

# the current name

1580

alt_interface = attribute._dbus_interface.replace(

1581

orig_interface_name, alt_interface_name)

1582

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)

1583

1047

# Is this a D-Bus signal?

1584

1048

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

1585

# Extract the original non-method undecorated

1586

# function by black magic

1587

if sys.version_info.major == 2:

1588

nonmethod_func = (dict(

1049

# Extract the original non-method function by

1050

# black magic

1051

nonmethod_func = (dict(

1589

1052

zip(attribute.func_code.co_freevars,

1590

attribute.__closure__))

1591

["func"].cell_contents)

1592

else:

1593

nonmethod_func = (dict(

1594

zip(attribute.__code__.co_freevars,

1595

attribute.__closure__))

1596

["func"].cell_contents)

1053

attribute.__closure__))["func"]

1054

.cell_contents)

1597

1055

# Create a new, but exactly alike, function

1598

1056

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

1599

1057

# with the alternate D-Bus interface name

1600

new_function = copy_function(nonmethod_func)

1601

new_function = (dbus.service.signal(

1602

alt_interface,

1603

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

1604

1067

# Copy annotations, if any

1605

1068

try:

1606

new_function._dbus_annotations = dict(

1607

attribute._dbus_annotations)

1069

new_function._dbus_annotations = (

1070

dict(attribute._dbus_annotations))

1608

1071

except AttributeError:

1609

1072

pass

1610

1611

1073

# Define a creator of a function to call both the

1612

# original and alternate functions, so both the

1613

# original and alternate signals gets sent when

1614

# the function is called

1074

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

1075

# signals gets sent when the function is called

1615

1076

def fixscope(func1, func2):

1616

1077

"""This function is a scope container to pass

1617

1078

func1 and func2 to the "call_both" function

1618

1079

outside of its arguments"""

1619

1620

@functools.wraps(func2)

1621

1080

def call_both(*args, **kwargs):

1622

1081

"""This function will emit two D-Bus

1623

1082

signals by calling func1 and func2"""

1624

1083

func1(*args, **kwargs)

1625

1084

func2(*args, **kwargs)

1626

# Make wrapper function look like a D-Bus

1627

# signal

1628

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

1629

if name.startswith("_dbus_"):

1630

setattr(call_both, name, attr)

1631

1632

1085

return call_both

1633

1086

# Create the "call_both" function and add it to

1634

1087

# the class

1635

attr[attrname] = fixscope(attribute, new_function)

1088

attr[attrname] = fixscope(attribute,

1089

new_function)

1636

1090

# Is this a D-Bus method?

1637

1091

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

1638

1092

# Create a new, but exactly alike, function

1639

1093

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

1640

1094

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

1641

1095

# to the class.

1642

attr[attrname] = (

1643

dbus.service.method(

1644

alt_interface,

1645

attribute._dbus_in_signature,

1646

attribute._dbus_out_signature)

1647

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

1648

1106

# Copy annotations, if any

1649

1107

try:

1650

attr[attrname]._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1108

attr[attrname]._dbus_annotations = (

1109

dict(attribute._dbus_annotations))

1652

1110

except AttributeError:

1653

1111

pass

1654

1112

# Is this a D-Bus property?

1657

1115

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

1658

1116

# property with the alternate D-Bus interface

1659

1117

# name. Add it to the class.

1660

attr[attrname] = (dbus_service_property(

1661

alt_interface, attribute._dbus_signature,

1662

attribute._dbus_access,

1663

attribute._dbus_get_args_options

1664

["byte_arrays"])

1665

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

1666

1131

# Copy annotations, if any

1667

1132

try:

1668

attr[attrname]._dbus_annotations = dict(

1669

attribute._dbus_annotations)

1133

attr[attrname]._dbus_annotations = (

1134

dict(attribute._dbus_annotations))

1670

1135

except AttributeError:

1671

1136

pass

1672

1137

# Is this a D-Bus interface?

1675

1140

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

1676

1141

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

1677

1142

# to the class.

1678

attr[attrname] = (

1679

dbus_interface_annotations(alt_interface)

1680

(copy_function(attribute)))

1681

if deprecate:

1682

# Deprecate all alternate interfaces

1683

iname = "_AlternateDBusNames_interface_annotation{}"

1684

for interface_name in interface_names:

1685

1686

@dbus_interface_annotations(interface_name)

1687

def func(self):

1688

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

1689

"true"}

1690

# Find an unused name

1691

for aname in (iname.format(i)

1692

for i in itertools.count()):

1693

if aname not in attr:

1694

attr[aname] = func

1695

break

1696

if interface_names:

1697

# Replace the class with a new subclass of it with

1698

# methods, signals, etc. as created above.

1699

if sys.version_info.major == 2:

1700

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

1701

(cls, ), attr)

1702

else:

1703

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

1704

(cls, ), attr)

1705

return cls

1706

1707

return wrapper

1708

1709

1710

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

1711

"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

1712

1166

class ClientDBus(Client, DBusObjectWithProperties):

1713

1167

"""A Client class using D-Bus

1714

1168

1715

1169

Attributes:

1716

1170

dbus_object_path: dbus.ObjectPath

1717

1171

bus: dbus.SystemBus()

1718

1172

"""

1719

1173

1720

1174

runtime_expansions = (Client.runtime_expansions

1721

+ ("dbus_object_path", ))

1722

1723

_interface = "se.recompile.Mandos.Client"

1724

1175

+ ("dbus_object_path",))

1176

1725

1177

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

1726

1727

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

1178

1179

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

1728

1180

self.bus = bus

1729

1181

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

1730

1182

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

1731

1183

# the D-Bus

1732

client_object_name = str(self.name).translate(

1184

client_object_name = unicode(self.name).translate(

1733

1185

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

1734

1186

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

1735

self.dbus_object_path = dbus.ObjectPath(

1736

"/clients/" + client_object_name)

1187

self.dbus_object_path = (dbus.ObjectPath

1188

("/clients/" + client_object_name))

1737

1189

DBusObjectWithProperties.__init__(self, self.bus,

1738

1190

self.dbus_object_path)

1739

1740

def notifychangeproperty(transform_func, dbus_name,

1741

type_func=lambda x: x,

1742

variant_level=1,

1743

invalidate_only=False,

1744

_interface=_interface):

1191

1192

def notifychangeproperty(transform_func,

1193

dbus_name, type_func=lambda x: x,

1194

variant_level=1):

1745

1195

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

1746

1196

its changes to DBus.

1747

1197

1748

1198

transform_fun: Function that takes a value and a variant_level

1749

1199

and transforms it to a D-Bus type.

1750

1200

dbus_name: D-Bus name of the variable

1752

1202

to the D-Bus. Default: no transform

1753

1203

variant_level: D-Bus variant level. Default: 1

1754

1204

"""

1755

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

1756

1205

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

1757

1206

def setter(self, value):

1758

1207

if hasattr(self, "dbus_object_path"):

1759

1208

if (not hasattr(self, attrname) or

1760

1209

type_func(getattr(self, attrname, None))

1761

1210

!= type_func(value)):

1762

if invalidate_only:

1763

self.PropertiesChanged(

1764

_interface, dbus.Dictionary(),

1765

dbus.Array((dbus_name, )))

1766

else:

1767

dbus_value = transform_func(

1768

type_func(value),

1769

variant_level=variant_level)

1770

self.PropertyChanged(dbus.String(dbus_name),

1771

dbus_value)

1772

self.PropertiesChanged(

1773

_interface,

1774

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

1775

dbus_value}),

1776

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)

1777

1216

setattr(self, attrname, value)

1778

1217

1779

1218

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

1780

1219

1220

1781

1221

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1782

1222

approvals_pending = notifychangeproperty(dbus.Boolean,

1783

1223

"ApprovalPending",

1784

type_func=bool)

1224

type_func = bool)

1785

1225

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

1786

1226

last_enabled = notifychangeproperty(datetime_to_dbus,

1787

1227

"LastEnabled")

1788

checker = notifychangeproperty(

1789

dbus.Boolean, "CheckerRunning",

1790

type_func=lambda checker: checker is not None)

1228

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

1229

type_func = lambda checker:

1230

checker is not None)

1791

1231

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1792

1232

"LastCheckedOK")

1793

1233

last_checker_status = notifychangeproperty(dbus.Int16,

1796

1236

datetime_to_dbus, "LastApprovalRequest")

1797

1237

approved_by_default = notifychangeproperty(dbus.Boolean,

1798

1238

"ApprovedByDefault")

1799

approval_delay = notifychangeproperty(

1800

dbus.UInt64, "ApprovalDelay",

1801

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

1239

approval_delay = notifychangeproperty(dbus.UInt64,

1240

"ApprovalDelay",

1241

type_func =

1242

timedelta_to_milliseconds)

1802

1243

approval_duration = notifychangeproperty(

1803

1244

dbus.UInt64, "ApprovalDuration",

1804

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

1245

type_func = timedelta_to_milliseconds)

1805

1246

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

1806

timeout = notifychangeproperty(

1807

dbus.UInt64, "Timeout",

1808

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

1247

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

1248

type_func =

1249

timedelta_to_milliseconds)

1809

1250

extended_timeout = notifychangeproperty(

1810

1251

dbus.UInt64, "ExtendedTimeout",

1811

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

1812

interval = notifychangeproperty(

1813

dbus.UInt64, "Interval",

1814

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)

1815

1257

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

1816

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

1817

invalidate_only=True)

1818

1258

1819

1259

del notifychangeproperty

1820

1260

1821

1261

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

1822

1262

try:

1823

1263

self.remove_from_connection()

1826

1266

if hasattr(DBusObjectWithProperties, "__del__"):

1827

1267

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

1828

1268

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

1829

1830

def checker_callback(self, source, condition,

1831

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

1832

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

1833

connection, command, *args,

1834

**kwargs)

1835

exitstatus = self.last_checker_status

1836

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)

1837

1276

# Emit D-Bus signal

1838

1277

self.CheckerCompleted(dbus.Int16(exitstatus),

1839

# This is specific to GNU libC

1840

dbus.Int64(exitstatus << 8),

1278

dbus.Int64(condition),

1841

1279

dbus.String(command))

1842

1280

else:

1843

1281

# Emit D-Bus signal

1844

1282

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

1845

dbus.Int64(

1846

# This is specific to GNU libC

1847

(exitstatus << 8)

1848

| self.last_checker_signal),

1283

dbus.Int64(condition),

1849

1284

dbus.String(command))

1850

return ret

1851

1285

1286

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

1287

*args, **kwargs)

1288

1852

1289

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

1853

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

1854

1295

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

1855

1296

# Only if new checker process was started

1856

1297

if (self.checker is not None

1858

1299

# Emit D-Bus signal

1859

1300

self.CheckerStarted(self.current_checker_command)

1860

1301

return r

1861

1302

1862

1303

def _reset_approved(self):

1863

1304

self.approved = None

1864

1305

return False

1865

1306

1866

1307

def approve(self, value=True):

1308

self.send_changedstate()

1867

1309

self.approved = value

1868

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

1869

* 1000), self._reset_approved)

1870

self.send_changedstate()

1871

1872

# D-Bus methods, signals & properties

1873

1874

# Interfaces

1875

1876

# Signals

1877

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

1878

1327

# CheckerCompleted - signal

1879

1328

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

1880

1329

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

1881

1330

"D-Bus signal"

1882

1331

pass

1883

1332

1884

1333

# CheckerStarted - signal

1885

1334

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

1886

1335

def CheckerStarted(self, command):

1887

1336

"D-Bus signal"

1888

1337

pass

1889

1338

1890

1339

# PropertyChanged - signal

1891

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

1892

1340

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

1893

1341

def PropertyChanged(self, property, value):

1894

1342

"D-Bus signal"

1895

1343

pass

1896

1344

1897

1345

# GotSecret - signal

1898

1346

@dbus.service.signal(_interface)

1899

1347

def GotSecret(self):

1902

1350

server to mandos-client

1903

1351

"""

1904

1352

pass

1905

1353

1906

1354

# Rejected - signal

1907

1355

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

1908

1356

def Rejected(self, reason):

1909

1357

"D-Bus signal"

1910

1358

pass

1911

1359

1912

1360

# NeedApproval - signal

1913

1361

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

1914

1362

def NeedApproval(self, timeout, default):

1915

1363

"D-Bus signal"

1916

1364

return self.need_approval()

1917

1918

# Methods

1919

1365

1366

## Methods

1367

1920

1368

# Approve - method

1921

1369

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

1922

1370

def Approve(self, value):

1923

1371

self.approve(value)

1924

1372

1925

1373

# CheckedOK - method

1926

1374

@dbus.service.method(_interface)

1927

1375

def CheckedOK(self):

1928

1376

self.checked_ok()

1929

1377

1930

1378

# Enable - method

1931

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

1932

1379

@dbus.service.method(_interface)

1933

1380

def Enable(self):

1934

1381

"D-Bus method"

1935

1382

self.enable()

1936

1383

1937

1384

# StartChecker - method

1938

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

1939

1385

@dbus.service.method(_interface)

1940

1386

def StartChecker(self):

1941

1387

"D-Bus method"

1942

1388

self.start_checker()

1943

1389

1944

1390

# Disable - method

1945

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

1946

1391

@dbus.service.method(_interface)

1947

1392

def Disable(self):

1948

1393

"D-Bus method"

1949

1394

self.disable()

1950

1395

1951

1396

# StopChecker - method

1952

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

1953

1397

@dbus.service.method(_interface)

1954

1398

def StopChecker(self):

1955

1399

self.stop_checker()

1956

1957

# Properties

1958

1400

1401

## Properties

1402

1959

1403

# ApprovalPending - property

1960

1404

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

1961

1405

def ApprovalPending_dbus_property(self):

1962

1406

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

1963

1407

1964

1408

# ApprovedByDefault - property

1965

@dbus_service_property(_interface,

1966

signature="b",

1409

@dbus_service_property(_interface, signature="b",

1967

1410

access="readwrite")

1968

1411

def ApprovedByDefault_dbus_property(self, value=None):

1969

1412

if value is None: # get

1970

1413

return dbus.Boolean(self.approved_by_default)

1971

1414

self.approved_by_default = bool(value)

1972

1415

1973

1416

# ApprovalDelay - property

1974

@dbus_service_property(_interface,

1975

signature="t",

1417

@dbus_service_property(_interface, signature="t",

1976

1418

access="readwrite")

1977

1419

def ApprovalDelay_dbus_property(self, value=None):

1978

1420

if value is None: # get

1979

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

1980

* 1000)

1421

return dbus.UInt64(self.approval_delay_milliseconds())

1981

1422

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

1982

1423

1983

1424

# ApprovalDuration - property

1984

@dbus_service_property(_interface,

1985

signature="t",

1425

@dbus_service_property(_interface, signature="t",

1986

1426

access="readwrite")

1987

1427

def ApprovalDuration_dbus_property(self, value=None):

1988

1428

if value is None: # get

1989

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

1990

* 1000)

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

1991

1431

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

1992

1432

1993

1433

# Name - property

1994

@dbus_annotations(

1995

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

1996

1434

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

1997

1435

def Name_dbus_property(self):

1998

1436

return dbus.String(self.name)

1999

1437

2000

1438

# Fingerprint - property

2001

@dbus_annotations(

2002

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

2003

1439

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

2004

1440

def Fingerprint_dbus_property(self):

2005

1441

return dbus.String(self.fingerprint)

2006

1442

2007

1443

# Host - property

2008

@dbus_service_property(_interface,

2009

signature="s",

1444

@dbus_service_property(_interface, signature="s",

2010

1445

access="readwrite")

2011

1446

def Host_dbus_property(self, value=None):

2012

1447

if value is None: # get

2013

1448

return dbus.String(self.host)

2014

self.host = str(value)

2015

1449

self.host = unicode(value)

1450

2016

1451

# Created - property

2017

@dbus_annotations(

2018

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

2019

1452

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

2020

1453

def Created_dbus_property(self):

2021

1454

return datetime_to_dbus(self.created)

2022

1455

2023

1456

# LastEnabled - property

2024

1457

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

2025

1458

def LastEnabled_dbus_property(self):

2026

1459

return datetime_to_dbus(self.last_enabled)

2027

1460

2028

1461

# Enabled - property

2029

@dbus_service_property(_interface,

2030

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2031

1463

access="readwrite")

2032

1464

def Enabled_dbus_property(self, value=None):

2033

1465

if value is None: # get

2036

1468

self.enable()

2037

1469

else:

2038

1470

self.disable()

2039

1471

2040

1472

# LastCheckedOK - property

2041

@dbus_service_property(_interface,

2042

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2043

1474

access="readwrite")

2044

1475

def LastCheckedOK_dbus_property(self, value=None):

2045

1476

if value is not None:

2046

1477

self.checked_ok()

2047

1478

return

2048

1479

return datetime_to_dbus(self.last_checked_ok)

2049

1480

2050

1481

# LastCheckerStatus - property

2051

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

1482

@dbus_service_property(_interface, signature="n",

1483

access="read")

2052

1484

def LastCheckerStatus_dbus_property(self):

2053

1485

return dbus.Int16(self.last_checker_status)

2054

1486

2055

1487

# Expires - property

2056

1488

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

2057

1489

def Expires_dbus_property(self):

2058

1490

return datetime_to_dbus(self.expires)

2059

1491

2060

1492

# LastApprovalRequest - property

2061

1493

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

2062

1494

def LastApprovalRequest_dbus_property(self):

2063

1495

return datetime_to_dbus(self.last_approval_request)

2064

1496

2065

1497

# Timeout - property

2066

@dbus_service_property(_interface,

2067

signature="t",

1498

@dbus_service_property(_interface, signature="t",

2068

1499

access="readwrite")

2069

1500

def Timeout_dbus_property(self, value=None):

2070

1501

if value is None: # get

2071

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

2072

old_timeout = self.timeout

1502

return dbus.UInt64(self.timeout_milliseconds())

2073

1503

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

2074

# Reschedule disabling

1504

# Reschedule timeout

2075

1505

if self.enabled:

2076

1506

now = datetime.datetime.utcnow()

2077

self.expires += self.timeout - old_timeout

2078

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:

2079

1510

# The timeout has passed

2080

1511

self.disable()

2081

1512

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

2082

1516

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

2083

1517

is None):

2084

1518

return

2085

GLib.source_remove(self.disable_initiator_tag)

2086

self.disable_initiator_tag = GLib.timeout_add(

2087

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

2088

self.disable)

2089

1519

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1523

2090

1524

# ExtendedTimeout - property

2091

@dbus_service_property(_interface,

2092

signature="t",

1525

@dbus_service_property(_interface, signature="t",

2093

1526

access="readwrite")

2094

1527

def ExtendedTimeout_dbus_property(self, value=None):

2095

1528

if value is None: # get

2096

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

2097

* 1000)

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

1530

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

2099

1531

2100

1532

# Interval - property

2101

@dbus_service_property(_interface,

2102

signature="t",

1533

@dbus_service_property(_interface, signature="t",

2103

1534

access="readwrite")

2104

1535

def Interval_dbus_property(self, value=None):

2105

1536

if value is None: # get

2106

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

1537

return dbus.UInt64(self.interval_milliseconds())

2107

1538

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

2108

1539

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

2109

1540

return

2110

1541

if self.enabled:

2111

1542

# Reschedule checker run

2112

GLib.source_remove(self.checker_initiator_tag)

2113

self.checker_initiator_tag = GLib.timeout_add(

2114

value, self.start_checker)

2115

self.start_checker() # Start one now, too

2116

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

2117

1548

# Checker - property

2118

@dbus_service_property(_interface,

2119

signature="s",

1549

@dbus_service_property(_interface, signature="s",

2120

1550

access="readwrite")

2121

1551

def Checker_dbus_property(self, value=None):

2122

1552

if value is None: # get

2123

1553

return dbus.String(self.checker_command)

2124

self.checker_command = str(value)

2125

1554

self.checker_command = unicode(value)

1555

2126

1556

# CheckerRunning - property

2127

@dbus_service_property(_interface,

2128

signature="b",

1557

@dbus_service_property(_interface, signature="b",

2129

1558

access="readwrite")

2130

1559

def CheckerRunning_dbus_property(self, value=None):

2131

1560

if value is None: # get

2134

1563

self.start_checker()

2135

1564

else:

2136

1565

self.stop_checker()

2137

1566

2138

1567

# ObjectPath - property

2139

@dbus_annotations(

2140

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

2141

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

2142

1568

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

2143

1569

def ObjectPath_dbus_property(self):

2144

return self.dbus_object_path # is already a dbus.ObjectPath

2145

1570

return self.dbus_object_path # is already a dbus.ObjectPath

1571

2146

1572

# Secret = property

2147

@dbus_annotations(

2148

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

2149

"invalidates"})

2150

@dbus_service_property(_interface,

2151

signature="ay",

2152

access="write",

2153

byte_arrays=True)

1573

@dbus_service_property(_interface, signature="ay",

1574

access="write", byte_arrays=True)

2154

1575

def Secret_dbus_property(self, value):

2155

self.secret = bytes(value)

2156

1576

self.secret = str(value)

1577

2157

1578

del _interface

2158

1579

2159

1580

2162

1583

self._pipe = child_pipe

2163

1584

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

2164

1585

if not self._pipe.recv():

2165

raise KeyError(fpr)

2166

1586

raise KeyError()

1587

2167

1588

def __getattribute__(self, name):

2168

1589

if name == '_pipe':

2169

1590

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

2172

1593

if data[0] == 'data':

2173

1594

return data[1]

2174

1595

if data[0] == 'function':

2175

2176

1596

def func(*args, **kwargs):

2177

1597

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

2178

1598

return self._pipe.recv()[1]

2179

2180

1599

return func

2181

1600

2182

1601

def __setattr__(self, name, value):

2183

1602

if name == '_pipe':

2184

1603

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

2185

1604

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

2186

1605

2187

1606

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

2188

1611

class ClientHandler(socketserver.BaseRequestHandler, object):

2189

1612

"""A class to handle client connections.

2190

1613

2191

1614

Instantiated once for each connection to handle it.

2192

1615

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

2193

1616

2194

1617

def handle(self):

2195

1618

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

2196

1619

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

2197

str(self.client_address))

1620

unicode(self.client_address))

2198

1621

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

2199

1622

self.server.child_pipe.fileno())

2200

2201

session = gnutls.ClientSession(self.request)

2202

2203

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

2204

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

2205

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

2206

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

2207

1638

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

2208

1639

priority = self.server.gnutls_priority

2209

1640

if priority is None:

2210

1641

priority = "NORMAL"

2211

gnutls.priority_set_direct(session._c_object,

2212

priority.encode("utf-8"),

2213

None)

2214

1642

(gnutls.library.functions

1643

.gnutls_priority_set_direct(session._c_object,

1644

priority, None))

1645

2215

1646

# Start communication using the Mandos protocol

2216

1647

# Get protocol number

2217

1648

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

2218

1649

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

2219

1650

try:

2220

1651

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

2221

raise RuntimeError(line)

1652

raise RuntimeError

2222

1653

except (ValueError, IndexError, RuntimeError) as error:

2223

1654

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

2224

1655

return

2225

1656

2226

1657

# Start GnuTLS connection

2227

1658

try:

2228

1659

session.handshake()

2229

except gnutls.Error as error:

1660

except gnutls.errors.GNUTLSError as error:

2230

1661

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

2231

1662

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

2232

1663

# established. Just abandon the request.

2233

1664

return

2234

1665

logger.debug("Handshake succeeded")

2235

1666

2236

1667

approval_required = False

2237

1668

try:

2238

1669

try:

2239

fpr = self.fingerprint(

2240

self.peer_certificate(session))

2241

except (TypeError, gnutls.Error) as error:

1670

fpr = self.fingerprint(self.peer_certificate

1671

(session))

1672

except (TypeError,

1673

gnutls.errors.GNUTLSError) as error:

2242

1674

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

2243

1675

return

2244

1676

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

2245

1677

2246

1678

try:

2247

1679

client = ProxyClient(child_pipe, fpr,

2248

1680

self.client_address)

2249

1681

except KeyError:

2250

1682

return

2251

1683

2252

1684

if client.approval_delay:

2253

1685

delay = client.approval_delay

2254

1686

client.approvals_pending += 1

2255

1687

approval_required = True

2256

1688

2257

1689

while True:

2258

1690

if not client.enabled:

2259

1691

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

2260

client.name)

1692

client.name)

2261

1693

if self.server.use_dbus:

2262

1694

# Emit D-Bus signal

2263

1695

client.Rejected("Disabled")

2264

1696

return

2265

1697

2266

1698

if client.approved or not client.approval_delay:

2267

# We are approved or approval is disabled

1699

#We are approved or approval is disabled

2268

1700

break

2269

1701

elif client.approved is None:

2270

1702

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

2272

1704

if self.server.use_dbus:

2273

1705

# Emit D-Bus signal

2274

1706

client.NeedApproval(

2275

client.approval_delay.total_seconds()

2276

* 1000, client.approved_by_default)

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

2277

1709

else:

2278

1710

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

2279

1711

client.name)

2281

1713

# Emit D-Bus signal

2282

1714

client.Rejected("Denied")

2283

1715

return

2284

2285

# wait until timeout or approved

1716

1717

#wait until timeout or approved

2286

1718

time = datetime.datetime.now()

2287

1719

client.changedstate.acquire()

2288

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

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

2289

1723

client.changedstate.release()

2290

1724

time2 = datetime.datetime.now()

2291

1725

if (time2 - time) >= delay:

2301

1735

break

2302

1736

else:

2303

1737

delay -= time2 - time

2304

2305

try:

2306

session.send(client.secret)

2307

except gnutls.Error as error:

2308

logger.warning("gnutls send failed",

2309

exc_info=error)

2310

return

2311

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

2312

1751

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

2313

1752

# bump the timeout using extended_timeout

2314

1753

client.bump_timeout(client.extended_timeout)

2315

1754

if self.server.use_dbus:

2316

1755

# Emit D-Bus signal

2317

1756

client.GotSecret()

2318

1757

2319

1758

finally:

2320

1759

if approval_required:

2321

1760

client.approvals_pending -= 1

2322

1761

try:

2323

1762

session.bye()

2324

except gnutls.Error as error:

2325

logger.warning("GnuTLS bye failed",

2326

exc_info=error)

2327

1763

except gnutls.errors.GNUTLSError as error:

1764

logger.warning("GnuTLS bye failed")

1765

2328

1766

@staticmethod

2329

1767

def peer_certificate(session):

2330

1768

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

2331

1769

# If not an OpenPGP certificate...

2332

if (gnutls.certificate_type_get(session._c_object)

2333

!= gnutls.CRT_OPENPGP):

2334

# ...return invalid data

2335

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

2336

1775

list_size = ctypes.c_uint(1)

2337

cert_list = (gnutls.certificate_get_peers

1776

cert_list = (gnutls.library.functions

1777

.gnutls_certificate_get_peers

2338

1778

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

2339

1779

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

2340

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

1780

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

1781

" certificate")

2341

1782

if list_size.value == 0:

2342

1783

return None

2343

1784

cert = cert_list[0]

2344

1785

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

2345

1786

2346

1787

@staticmethod

2347

1788

def fingerprint(openpgp):

2348

1789

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2349

1790

# New GnuTLS "datum" with the OpenPGP public key

2350

datum = gnutls.datum_t(

2351

ctypes.cast(ctypes.c_char_p(openpgp),

2352

ctypes.POINTER(ctypes.c_ubyte)),

2353

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

2354

1796

# New empty GnuTLS certificate

2355

crt = gnutls.openpgp_crt_t()

2356

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

2357

1800

# Import the OpenPGP public key into the certificate

2358

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

2359

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

2360

1805

# Verify the self signature in the key

2361

1806

crtverify = ctypes.c_uint()

2362

gnutls.openpgp_crt_verify_self(crt, 0,

2363

ctypes.byref(crtverify))

1807

(gnutls.library.functions

1808

.gnutls_openpgp_crt_verify_self(crt, 0,

1809

ctypes.byref(crtverify)))

2364

1810

if crtverify.value != 0:

2365

gnutls.openpgp_crt_deinit(crt)

2366

raise gnutls.CertificateSecurityError("Verify failed")

1811

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1812

raise (gnutls.errors.CertificateSecurityError

1813

("Verify failed"))

2367

1814

# New buffer for the fingerprint

2368

1815

buf = ctypes.create_string_buffer(20)

2369

1816

buf_len = ctypes.c_size_t()

2370

1817

# Get the fingerprint from the certificate into the buffer

2371

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

2372

ctypes.byref(buf_len))

1818

(gnutls.library.functions

1819

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

1820

ctypes.byref(buf_len)))

2373

1821

# Deinit the certificate

2374

gnutls.openpgp_crt_deinit(crt)

1822

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2375

1823

# Convert the buffer to a Python bytestring

2376

1824

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

2377

1825

# Convert the bytestring to hexadecimal notation

2381

1829

2382

1830

class MultiprocessingMixIn(object):

2383

1831

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

2384

2385

1832

def sub_process_main(self, request, address):

2386

1833

try:

2387

1834

self.finish_request(request, address)

2388

1835

except Exception:

2389

1836

self.handle_error(request, address)

2390

1837

self.close_request(request)

2391

1838

2392

1839

def process_request(self, request, address):

2393

1840

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

2394

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

2395

args=(request, address))

1841

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

1842

args = (request,

1843

address))

2396

1844

proc.start()

2397

1845

return proc

2398

1846

2399

1847

2400

1848

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2401

1849

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

2402

2403

1850

def process_request(self, request, client_address):

2404

1851

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

2405

1852

2406

1853

This function creates a new pipe in self.pipe

2407

1854

"""

2408

1855

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2409

1856

2410

1857

proc = MultiprocessingMixIn.process_request(self, request,

2411

1858

client_address)

2412

1859

self.child_pipe.close()

2413

1860

self.add_pipe(parent_pipe, proc)

2414

1861

2415

1862

def add_pipe(self, parent_pipe, proc):

2416

1863

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

2417

raise NotImplementedError()

1864

raise NotImplementedError

2418

1865

2419

1866

2420

1867

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2421

1868

socketserver.TCPServer, object):

2422

1869

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

2423

1870

2424

1871

Attributes:

2425

1872

enabled: Boolean; whether this server is activated yet

2426

1873

interface: None or a network interface name (string)

2427

1874

use_ipv6: Boolean; to use IPv6 or not

2428

1875

"""

2429

2430

1876

def __init__(self, server_address, RequestHandlerClass,

2431

interface=None,

2432

use_ipv6=True,

2433

socketfd=None):

2434

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

2435

creating a new one with socket.socket().

2436

"""

1877

interface=None, use_ipv6=True):

2437

1878

self.interface = interface

2438

1879

if use_ipv6:

2439

1880

self.address_family = socket.AF_INET6

2440

if socketfd is not None:

2441

# Save the file descriptor

2442

self.socketfd = socketfd

2443

# Save the original socket.socket() function

2444

self.socket_socket = socket.socket

2445

2446

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

2447

#

2448

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

2449

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

2450

# patching socket.socket.)

2451

#

2452

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

2453

@functools.wraps(socket.socket)

2454

def socket_wrapper(*args, **kwargs):

2455

# Restore original function so subsequent calls are

2456

# not affected.

2457

socket.socket = self.socket_socket

2458

del self.socket_socket

2459

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

2460

# saved file descriptor.

2461

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

2462

# Replace socket.socket() function with wrapper

2463

socket.socket = socket_wrapper

2464

# The socketserver.TCPServer.__init__ will call

2465

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

2466

# socket_wrapper(), if socketfd was set.

2467

1881

socketserver.TCPServer.__init__(self, server_address,

2468

1882

RequestHandlerClass)

2469

2470

1883

def server_bind(self):

2471

1884

"""This overrides the normal server_bind() function

2472

1885

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

2473

1886

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

2474

global SO_BINDTODEVICE

2475

1887

if self.interface is not None:

2476

1888

if SO_BINDTODEVICE is None:

2477

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

2478

# common enough.

2479

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

2480

SO_BINDTODEVICE = 25

2481

try:

2482

self.socket.setsockopt(

2483

socket.SOL_SOCKET, SO_BINDTODEVICE,

2484

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

2485

except socket.error as error:

2486

if error.errno == errno.EPERM:

2487

logger.error("No permission to bind to"

2488

" interface %s", self.interface)

2489

elif error.errno == errno.ENOPROTOOPT:

2490

logger.error("SO_BINDTODEVICE not available;"

2491

" cannot bind to interface %s",

2492

self.interface)

2493

elif error.errno == errno.ENODEV:

2494

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

2495

" cannot bind", self.interface)

2496

else:

2497

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

2498

1909

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

2499

1910

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

2500

1911

if not self.server_address[0]:

2501

1912

if self.address_family == socket.AF_INET6:

2502

any_address = "::" # in6addr_any

1913

any_address = "::" # in6addr_any

2503

1914

else:

2504

any_address = "0.0.0.0" # INADDR_ANY

1915

any_address = socket.INADDR_ANY

2505

1916

self.server_address = (any_address,

2506

1917

self.server_address[1])

2507

1918

elif not self.server_address[1]:

2508

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

1919

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

1920

0)

2509

1921

# if self.interface:

2510

1922

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

2511

1923

# 0, # port

2517

1929

2518

1930

class MandosServer(IPv6_TCPServer):

2519

1931

"""Mandos server.

2520

1932

2521

1933

Attributes:

2522

1934

clients: set of Client objects

2523

1935

gnutls_priority GnuTLS priority string

2524

1936

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

2525

2526

Assumes a GLib.MainLoop event loop.

1937

1938

Assumes a gobject.MainLoop event loop.

2527

1939

"""

2528

2529

1940

def __init__(self, server_address, RequestHandlerClass,

2530

interface=None,

2531

use_ipv6=True,

2532

clients=None,

2533

gnutls_priority=None,

2534

use_dbus=True,

2535

socketfd=None):

1941

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

1942

gnutls_priority=None, use_dbus=True):

2536

1943

self.enabled = False

2537

1944

self.clients = clients

2538

1945

if self.clients is None:

2541

1948

self.gnutls_priority = gnutls_priority

2542

1949

IPv6_TCPServer.__init__(self, server_address,

2543

1950

RequestHandlerClass,

2544

interface=interface,

2545

use_ipv6=use_ipv6,

2546

socketfd=socketfd)

2547

1951

interface = interface,

1952

use_ipv6 = use_ipv6)

2548

1953

def server_activate(self):

2549

1954

if self.enabled:

2550

1955

return socketserver.TCPServer.server_activate(self)

2551

1956

2552

1957

def enable(self):

2553

1958

self.enabled = True

2554

1959

2555

1960

def add_pipe(self, parent_pipe, proc):

2556

1961

# Call "handle_ipc" for both data and EOF events

2557

GLib.io_add_watch(

2558

parent_pipe.fileno(),

2559

GLib.IO_IN | GLib.IO_HUP,

2560

functools.partial(self.handle_ipc,

2561

parent_pipe=parent_pipe,

2562

proc=proc))

2563

2564

def handle_ipc(self, source, condition,

2565

parent_pipe=None,

2566

proc=None,

2567

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)

2568

1985

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

2569

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

1986

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

2570

1987

# Wait for other process to exit

2571

1988

proc.join()

2572

1989

return False

2573

1990

2574

1991

# Read a request from the child

2575

1992

request = parent_pipe.recv()

2576

1993

command = request[0]

2577

1994

2578

1995

if command == 'init':

2579

1996

fpr = request[1]

2580

1997

address = request[2]

2581

2582

for c in self.clients.values():

1998

1999

for c in self.clients.itervalues():

2583

2000

if c.fingerprint == fpr:

2584

2001

client = c

2585

2002

break

2592

2009

address[0])

2593

2010

parent_pipe.send(False)

2594

2011

return False

2595

2596

GLib.io_add_watch(

2597

parent_pipe.fileno(),

2598

GLib.IO_IN | GLib.IO_HUP,

2599

functools.partial(self.handle_ipc,

2600

parent_pipe=parent_pipe,

2601

proc=proc,

2602

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

2603

2021

parent_pipe.send(True)

2604

2022

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

2605

2023

# same fileno

2608

2026

funcname = request[1]

2609

2027

args = request[2]

2610

2028

kwargs = request[3]

2611

2029

2612

2030

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

2613

2031

funcname)(*args,

2614

**kwargs)))

2615

2032

**kwargs)))

2033

2616

2034

if command == 'getattr':

2617

2035

attrname = request[1]

2618

if isinstance(client_object.__getattribute__(attrname),

2619

collections.Callable):

2620

parent_pipe.send(('function', ))

2036

if callable(client_object.__getattribute__(attrname)):

2037

parent_pipe.send(('function',))

2621

2038

else:

2622

parent_pipe.send((

2623

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

2624

2039

parent_pipe.send(('data', client_object

2040

.__getattribute__(attrname)))

2041

2625

2042

if command == 'setattr':

2626

2043

attrname = request[1]

2627

2044

value = request[2]

2628

2045

setattr(client_object, attrname, value)

2629

2046

2630

2047

return True

2631

2048

2632

2049

2633

def rfc3339_duration_to_delta(duration):

2634

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

2635

2636

>>> rfc3339_duration_to_delta("P7D")

2637

datetime.timedelta(7)

2638

>>> rfc3339_duration_to_delta("PT60S")

2639

datetime.timedelta(0, 60)

2640

>>> rfc3339_duration_to_delta("PT60M")

2641

datetime.timedelta(0, 3600)

2642

>>> rfc3339_duration_to_delta("PT24H")

2643

datetime.timedelta(1)

2644

>>> rfc3339_duration_to_delta("P1W")

2645

datetime.timedelta(7)

2646

>>> rfc3339_duration_to_delta("PT5M30S")

2647

datetime.timedelta(0, 330)

2648

>>> rfc3339_duration_to_delta("P1DT3M20S")

2649

datetime.timedelta(1, 200)

2650

"""

2651

2652

# Parsing an RFC 3339 duration with regular expressions is not

2653

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

2654

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

2655

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

2656

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

2657

# avoid excessive use of external libraries.

2658

2659

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

2660

Token = collections.namedtuple("Token", (

2661

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

2662

# a "group" containing digits

2663

"value", # datetime.timedelta or None

2664

"followers")) # Tokens valid after this token

2665

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

2666

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

2667

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

2668

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

2669

datetime.timedelta(seconds=1),

2670

frozenset((token_end, )))

2671

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

2672

datetime.timedelta(minutes=1),

2673

frozenset((token_second, token_end)))

2674

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

2675

datetime.timedelta(hours=1),

2676

frozenset((token_minute, token_end)))

2677

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

2678

None,

2679

frozenset((token_hour, token_minute,

2680

token_second)))

2681

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

2682

datetime.timedelta(days=1),

2683

frozenset((token_time, token_end)))

2684

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

2685

datetime.timedelta(weeks=4),

2686

frozenset((token_day, token_end)))

2687

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

2688

datetime.timedelta(weeks=52),

2689

frozenset((token_month, token_end)))

2690

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

2691

datetime.timedelta(weeks=1),

2692

frozenset((token_end, )))

2693

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

2694

frozenset((token_year, token_month,

2695

token_day, token_time,

2696

token_week)))

2697

# Define starting values:

2698

# Value so far

2699

value = datetime.timedelta()

2700

found_token = None

2701

# Following valid tokens

2702

followers = frozenset((token_duration, ))

2703

# String left to parse

2704

s = duration

2705

# Loop until end token is found

2706

while found_token is not token_end:

2707

# Search for any currently valid tokens

2708

for token in followers:

2709

match = token.regexp.match(s)

2710

if match is not None:

2711

# Token found

2712

if token.value is not None:

2713

# Value found, parse digits

2714

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

2715

# Add to value so far

2716

value += factor * token.value

2717

# Strip token from string

2718

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

2719

# Go to found token

2720

found_token = token

2721

# Set valid next tokens

2722

followers = found_token.followers

2723

break

2724

else:

2725

# No currently valid tokens were found

2726

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

2727

.format(duration))

2728

# End token found

2729

return value

2730

2731

2732

2050

def string_to_delta(interval):

2733

2051

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

2734

2052

2735

2053

>>> string_to_delta('7d')

2736

2054

datetime.timedelta(7)

2737

2055

>>> string_to_delta('60s')

2745

2063

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

2746

2064

datetime.timedelta(0, 330)

2747

2065

"""

2748

2749

try:

2750

return rfc3339_duration_to_delta(interval)

2751

except ValueError:

2752

pass

2753

2754

2066

timevalue = datetime.timedelta(0)

2755

2067

for s in interval.split():

2756

2068

try:

2757

suffix = s[-1]

2069

suffix = unicode(s[-1])

2758

2070

value = int(s[:-1])

2759

2071

if suffix == "d":

2760

2072

delta = datetime.timedelta(value)

2767

2079

elif suffix == "w":

2768

2080

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

2769

2081

else:

2770

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

2771

except IndexError as e:

2082

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

2083

except (ValueError, IndexError) as e:

2772

2084

raise ValueError(*(e.args))

2773

2085

timevalue += delta

2774

2086

return timevalue

2775

2087

2776

2088

2777

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

2089

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

2778

2090

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

2779

2091

2780

2092

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

2781

2093

if os.fork():

2782

2094

sys.exit()

2790

2102

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

2791

2103

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

2792

2104

raise OSError(errno.ENODEV,

2793

"{} not a character device"

2794

.format(os.devnull))

2105

"%s not a character device"

2106

% os.devnull)

2795

2107

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

2796

2108

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

2797

2109

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

2800

2112

2801

2113

2802

2114

def main():

2803

2115

2804

2116

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

2805

2117

# Parsing of options, both command line and config file

2806

2118

2807

2119

parser = argparse.ArgumentParser()

2808

2120

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

2809

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

2121

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

2810

2122

help="show version number and exit")

2811

2123

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

2812

2124

help="Bind to interface IF")

2818

2130

help="Run self-test")

2819

2131

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

2820

2132

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

2821

" to terminal", default=None)

2133

" to terminal")

2822

2134

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

2823

2135

help="Debug level for stdout output")

2824

2136

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

2831

2143

" files")

2832

2144

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

2833

2145

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

2834

" system bus interface", default=None)

2146

" system bus interface")

2835

2147

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

2836

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

2837

default=None)

2148

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

2838

2149

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

2839

2150

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

2840

" state", default=None)

2841

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

2842

help="Specify a file descriptor to a network"

2843

" socket to use instead of creating one")

2151

" state")

2844

2152

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

2845

2153

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

2846

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

2847

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

2848

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

2849

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

2850

default=None)

2851

2154

2852

2155

options = parser.parse_args()

2853

2156

2854

2157

if options.check:

2855

2158

import doctest

2856

fail_count, test_count = doctest.testmod()

2857

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

2858

2159

doctest.testmod()

2160

sys.exit()

2161

2859

2162

# Default values for config file for server-global settings

2860

server_defaults = {"interface": "",

2861

"address": "",

2862

"port": "",

2863

"debug": "False",

2864

"priority":

2865

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

2866

":+SIGN-DSA-SHA256",

2867

"servicename": "Mandos",

2868

"use_dbus": "True",

2869

"use_ipv6": "True",

2870

"debuglevel": "",

2871

"restore": "True",

2872

"socket": "",

2873

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

2874

"foreground": "False",

2875

"zeroconf": "True",

2876

}

2877

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

2878

2177

# Parse config file for server-global settings

2879

2178

server_config = configparser.SafeConfigParser(server_defaults)

2880

2179

del server_defaults

2881

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

2180

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

2181

"mandos.conf"))

2882

2182

# Convert the SafeConfigParser object to a dict

2883

2183

server_settings = server_config.defaults()

2884

2184

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

2885

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

2185

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

2886

2186

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

2887

2187

option)

2888

2188

if server_settings["port"]:

2889

2189

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

2890

2190

"port")

2891

if server_settings["socket"]:

2892

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

2893

"socket")

2894

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

2895

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

2896

# happen with a supplied network socket.

2897

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

2898

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

2899

["socket"])

2900

2191

del server_config

2901

2192

2902

2193

# Override the settings from the config file with command line

2903

2194

# options, if set.

2904

2195

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

2905

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

2906

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

2907

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

2196

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

2197

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

2198

"statedir"):

2908

2199

value = getattr(options, option)

2909

2200

if value is not None:

2910

2201

server_settings[option] = value

2911

2202

del options

2912

2203

# Force all strings to be unicode

2913

2204

for option in server_settings.keys():

2914

if isinstance(server_settings[option], bytes):

2915

server_settings[option] = (server_settings[option]

2916

.decode("utf-8"))

2917

# Force all boolean options to be boolean

2918

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

2919

"foreground", "zeroconf"):

2920

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

2921

# Debug implies foreground

2922

if server_settings["debug"]:

2923

server_settings["foreground"] = True

2205

if type(server_settings[option]) is str:

2206

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

2924

2207

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

2925

2208

2926

2209

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

2927

2928

if (not server_settings["zeroconf"]

2929

and not (server_settings["port"]

2930

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

2931

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

2932

2210

2933

2211

# For convenience

2934

2212

debug = server_settings["debug"]

2935

2213

debuglevel = server_settings["debuglevel"]

2937

2215

use_ipv6 = server_settings["use_ipv6"]

2938

2216

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

2939

2217

stored_state_file)

2940

foreground = server_settings["foreground"]

2941

zeroconf = server_settings["zeroconf"]

2942

2218

2943

2219

if debug:

2944

2220

initlogger(debug, logging.DEBUG)

2945

2221

else:

2948

2224

else:

2949

2225

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

2950

2226

initlogger(debug, level)

2951

2227

2952

2228

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

2953

syslogger.setFormatter(

2954

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

2955

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

2956

server_settings["servicename"])))

2957

2229

syslogger.setFormatter(logging.Formatter

2230

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

2231

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

2232

% server_settings["servicename"]))

2233

2958

2234

# Parse config file with clients

2959

2235

client_config = configparser.SafeConfigParser(Client

2960

2236

.client_defaults)

2961

2237

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

2962

2238

"clients.conf"))

2963

2239

2964

2240

global mandos_dbus_service

2965

2241

mandos_dbus_service = None

2966

2967

socketfd = None

2968

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

2969

socketfd = server_settings["socket"]

2970

tcp_server = MandosServer(

2971

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

2972

ClientHandler,

2973

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

2974

use_ipv6=use_ipv6,

2975

gnutls_priority=server_settings["priority"],

2976

use_dbus=use_dbus,

2977

socketfd=socketfd)

2978

if not foreground:

2979

pidfilename = "/run/mandos.pid"

2980

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

2981

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

2982

pidfile = None

2983

try:

2984

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

2985

except IOError as e:

2986

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

2987

exc_info=e)

2988

2989

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

2990

("mandos", "mandos"),

2991

("nobody", "nogroup")):

2992

try:

2993

uid = pwd.getpwnam(name).pw_uid

2994

gid = pwd.getpwnam(group).pw_gid

2995

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

2996

2266

except KeyError:

2997

continue

2998

else:

2999

uid = 65534

3000

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

3001

2273

try:

3002

2274

os.setgid(gid)

3003

2275

os.setuid(uid)

3004

if debug:

3005

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

3006

gid))

3007

2276

except OSError as error:

3008

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

3009

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

3010

if error.errno != errno.EPERM:

3011

raise

3012

2277

if error[0] != errno.EPERM:

2278

raise error

2279

3013

2280

if debug:

3014

2281

# Enable all possible GnuTLS debugging

3015

2282

3016

2283

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

3017

2284

# - GnuTLS manual

3018

gnutls.global_set_log_level(11)

3019

3020

@gnutls.log_func

2285

gnutls.library.functions.gnutls_global_set_log_level(11)

2286

2287

@gnutls.library.types.gnutls_log_func

3021

2288

def debug_gnutls(level, string):

3022

2289

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

3023

3024

gnutls.global_set_log_function(debug_gnutls)

3025

2290

2291

(gnutls.library.functions

2292

.gnutls_global_set_log_function(debug_gnutls))

2293

3026

2294

# Redirect stdin so all checkers get /dev/null

3027

2295

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

3028

2296

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

3029

2297

if null > 2:

3030

2298

os.close(null)

3031

2299

3032

2300

# Need to fork before connecting to D-Bus

3033

if not foreground:

2301

if not debug:

3034

2302

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

3035

2303

daemon()

3036

3037

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

3038

# to inform GLib that threads will be used.

3039

GLib.threads_init()

3040

2304

2305

gobject.threads_init()

2306

3041

2307

global main_loop

3042

2308

# From the Avahi example code

3043

2309

DBusGMainLoop(set_as_default=True)

3044

main_loop = GLib.MainLoop()

2310

main_loop = gobject.MainLoop()

3045

2311

bus = dbus.SystemBus()

3046

2312

# End of Avahi example code

3047

2313

if use_dbus:

3048

2314

try:

3049

2315

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

3050

bus,

3051

do_not_queue=True)

3052

old_bus_name = dbus.service.BusName(

3053

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

3054

do_not_queue=True)

3055

except dbus.exceptions.DBusException as e:

3056

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

3057

2322

use_dbus = False

3058

2323

server_settings["use_dbus"] = False

3059

2324

tcp_server.use_dbus = False

3060

if zeroconf:

3061

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3062

service = AvahiServiceToSyslog(

3063

name=server_settings["servicename"],

3064

servicetype="_mandos._tcp",

3065

protocol=protocol,

3066

bus=bus)

3067

if server_settings["interface"]:

3068

service.interface = if_nametoindex(

3069

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

3070

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

3071

2334

global multiprocessing_manager

3072

2335

multiprocessing_manager = multiprocessing.Manager()

3073

2336

3074

2337

client_class = Client

3075

2338

if use_dbus:

3076

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

3077

2339

client_class = functools.partial(ClientDBusTransitional,

2340

bus = bus)

2341

3078

2342

client_settings = Client.config_parser(client_config)

3079

2343

old_client_settings = {}

3080

2344

clients_data = {}

3081

3082

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

3083

global wnull

3084

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

3085

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

3086

# mode

3087

if debug or not foreground:

3088

wnull.close()

3089

2345

3090

2346

# Get client data and settings from last running state.

3091

2347

if server_settings["restore"]:

3092

2348

try:

3093

2349

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

3094

if sys.version_info.major == 2:

3095

clients_data, old_client_settings = pickle.load(

3096

stored_state)

3097

else:

3098

bytes_clients_data, bytes_old_client_settings = (

3099

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

3100

# Fix bytes to strings

3101

# clients_data

3102

# .keys()

3103

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

3104

if isinstance(key, bytes)

3105

else key): value

3106

for key, value in

3107

bytes_clients_data.items()}

3108

del bytes_clients_data

3109

for key in clients_data:

3110

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

3111

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

3112

for k, v in

3113

clients_data[key].items()}

3114

clients_data[key] = value

3115

# .client_structure

3116

value["client_structure"] = [

3117

(s.decode("utf-8")

3118

if isinstance(s, bytes)

3119

else s) for s in

3120

value["client_structure"]]

3121

# .name & .host

3122

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

3123

if isinstance(value[k], bytes):

3124

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

3125

# old_client_settings

3126

# .keys()

3127

old_client_settings = {

3128

(key.decode("utf-8")

3129

if isinstance(key, bytes)

3130

else key): value

3131

for key, value in

3132

bytes_old_client_settings.items()}

3133

del bytes_old_client_settings

3134

# .host

3135

for value in old_client_settings.values():

3136

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

3137

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

3138

.decode("utf-8"))

2350

clients_data, old_client_settings = (pickle.load

2351

(stored_state))

3139

2352

os.remove(stored_state_path)

3140

2353

except IOError as e:

3141

if e.errno == errno.ENOENT:

3142

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

3143

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

3144

else:

3145

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

3146

exc_info=e)

2354

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

2355

.format(e))

2356

if e.errno != errno.ENOENT:

3147

2357

raise

3148

2358

except EOFError as e:

3149

2359

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

3150

"EOFError:",

3151

exc_info=e)

3152

2360

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

2361

3153

2362

with PGPEngine() as pgp:

3154

for client_name, client in clients_data.items():

3155

# Skip removed clients

3156

if client_name not in client_settings:

3157

continue

3158

2363

for client_name, client in clients_data.iteritems():

3159

2364

# Decide which value to use after restoring saved state.

3160

2365

# We have three different values: Old config file,

3161

2366

# new config file, and saved state.

3166

2371

# For each value in new config, check if it

3167

2372

# differs from the old config value (Except for

3168

2373

# the "secret" attribute)

3169

if (name != "secret"

3170

and (value !=

3171

old_client_settings[client_name][name])):

2374

if (name != "secret" and

2375

value != old_client_settings[client_name]

2376

[name]):

3172

2377

client[name] = value

3173

2378

except KeyError:

3174

2379

pass

3175

2380

3176

2381

# Clients who has passed its expire date can still be

3177

# enabled if its last checker was successful. A Client

2382

# enabled if its last checker was successful. Clients

3178

2383

# whose checker succeeded before we stored its state is

3179

2384

# assumed to have successfully run all checkers during

3180

2385

# downtime.

3182

2387

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

3183

2388

if not client["last_checked_ok"]:

3184

2389

logger.warning(

3185

"disabling client {} - Client never "

3186

"performed a successful checker".format(

3187

client_name))

2390

"disabling client {0} - Client never "

2391

"performed a successful checker"

2392

.format(client_name))

3188

2393

client["enabled"] = False

3189

2394

elif client["last_checker_status"] != 0:

3190

2395

logger.warning(

3191

"disabling client {} - Client last"

3192

" checker failed with error code"

3193

" {}".format(

3194

client_name,

3195

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

3196

2400

client["enabled"] = False

3197

2401

else:

3198

client["expires"] = (

3199

datetime.datetime.utcnow()

3200

+ client["timeout"])

2402

client["expires"] = (datetime.datetime

2403

.utcnow()

2404

+ client["timeout"])

3201

2405

logger.debug("Last checker succeeded,"

3202

" keeping {} enabled".format(

3203

client_name))

2406

" keeping {0} enabled"

2407

.format(client_name))

3204

2408

try:

3205

client["secret"] = pgp.decrypt(

3206

client["encrypted_secret"],

3207

client_settings[client_name]["secret"])

2409

client["secret"] = (

2410

pgp.decrypt(client["encrypted_secret"],

2411

client_settings[client_name]

2412

["secret"]))

3208

2413

except PGPError:

3209

2414

# If decryption fails, we use secret from new settings

3210

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

3211

client_name))

3212

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

3213

["secret"])

2415

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

2416

.format(client_name))

2417

client["secret"] = (

2418

client_settings[client_name]["secret"])

3214

2419

2420

3215

2421

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

3216

2422

for client_name in (set(old_client_settings)

3217

2423

- set(client_settings)):

3221

2427

clients_data[client_name] = client_settings[client_name]

3222

2428

3223

2429

# Create all client objects

3224

for client_name, client in clients_data.items():

2430

for client_name, client in clients_data.iteritems():

3225

2431

tcp_server.clients[client_name] = client_class(

3226

name=client_name,

3227

settings=client,

3228

server_settings=server_settings)

3229

2432

name = client_name, settings = client)

2433

3230

2434

if not tcp_server.clients:

3231

2435

logger.warning("No clients defined")

3232

3233

if not foreground:

3234

if pidfile is not None:

3235

pid = os.getpid()

3236

try:

3237

with pidfile:

3238

print(pid, file=pidfile)

3239

except IOError:

3240

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

3241

pidfilename, pid)

3242

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

3243

2449

del pidfilename

3244

3245

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

3246

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3247

lambda: main_loop.quit() and False)

3248

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

3249

2455

if use_dbus:

3250

3251

@alternate_dbus_interfaces(

3252

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

3253

class MandosDBusService(DBusObjectWithObjectManager):

2456

class MandosDBusService(DBusObjectWithProperties):

3254

2457

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

3255

3256

2458

def __init__(self):

3257

2459

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

3258

3259

2460

_interface = "se.recompile.Mandos"

3260

2461

2462

@dbus_interface_annotations(_interface)

2463

def _foo(self):

2464

return { "org.freedesktop.DBus.Property"

2465

".EmitsChangedSignal":

2466

"false"}

2467

3261

2468

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

3262

2469

def ClientAdded(self, objpath):

3263

2470

"D-Bus signal"

3264

2471

pass

3265

2472

3266

2473

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

3267

2474

def ClientNotFound(self, fingerprint, address):

3268

2475

"D-Bus signal"

3269

2476

pass

3270

3271

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

3272

"true"})

2477

3273

2478

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

3274

2479

def ClientRemoved(self, objpath, name):

3275

2480

"D-Bus signal"

3276

2481

pass

3277

3278

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

3279

"true"})

2482

3280

2483

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

3281

2484

def GetAllClients(self):

3282

2485

"D-Bus method"

3283

return dbus.Array(c.dbus_object_path for c in

3284

tcp_server.clients.values())

3285

3286

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

3287

"true"})

2486

return dbus.Array(c.dbus_object_path

2487

for c in

2488

tcp_server.clients.itervalues())

2489

3288

2490

@dbus.service.method(_interface,

3289

2491

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

3290

2492

def GetAllClientsWithProperties(self):

3291

2493

"D-Bus method"

3292

2494

return dbus.Dictionary(

3293

{c.dbus_object_path: c.GetAll(

3294

"se.recompile.Mandos.Client")

3295

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

2495

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

2496

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

3296

2497

signature="oa{sv}")

3297

2498

3298

2499

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

3299

2500

def RemoveClient(self, object_path):

3300

2501

"D-Bus method"

3301

for c in tcp_server.clients.values():

2502

for c in tcp_server.clients.itervalues():

3302

2503

if c.dbus_object_path == object_path:

3303

2504

del tcp_server.clients[c.name]

3304

2505

c.remove_from_connection()

3305

# Don't signal the disabling

2506

# Don't signal anything except ClientRemoved

3306

2507

c.disable(quiet=True)

3307

# Emit D-Bus signal for removal

3308

self.client_removed_signal(c)

2508

# Emit D-Bus signal

2509

self.ClientRemoved(object_path, c.name)

3309

2510

return

3310

2511

raise KeyError(object_path)

3311

2512

3312

2513

del _interface

3313

3314

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3315

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

3316

def GetManagedObjects(self):

3317

"""D-Bus method"""

3318

return dbus.Dictionary(

3319

{client.dbus_object_path:

3320

dbus.Dictionary(

3321

{interface: client.GetAll(interface)

3322

for interface in

3323

client._get_all_interface_names()})

3324

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

3325

3326

def client_added_signal(self, client):

3327

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

3328

if use_dbus:

3329

# New standard signal

3330

self.InterfacesAdded(

3331

client.dbus_object_path,

3332

dbus.Dictionary(

3333

{interface: client.GetAll(interface)

3334

for interface in

3335

client._get_all_interface_names()}))

3336

# Old signal

3337

self.ClientAdded(client.dbus_object_path)

3338

3339

def client_removed_signal(self, client):

3340

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

3341

if use_dbus:

3342

# New standard signal

3343

self.InterfacesRemoved(

3344

client.dbus_object_path,

3345

client._get_all_interface_names())

3346

# Old signal

3347

self.ClientRemoved(client.dbus_object_path,

3348

client.name)

3349

3350

mandos_dbus_service = MandosDBusService()

3351

3352

# Save modules to variables to exempt the modules from being

3353

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

3354

mp = multiprocessing

3355

wn = wnull

3356

2514

2515

class MandosDBusServiceTransitional(MandosDBusService):

2516

__metaclass__ = AlternateDBusNamesMetaclass

2517

mandos_dbus_service = MandosDBusServiceTransitional()

2518

3357

2519

def cleanup():

3358

2520

"Cleanup function; run on exit"

3359

if zeroconf:

3360

service.cleanup()

3361

3362

mp.active_children()

3363

wn.close()

2521

service.cleanup()

2522

2523

multiprocessing.active_children()

3364

2524

if not (tcp_server.clients or client_settings):

3365

2525

return

3366

2526

3367

2527

# Store client before exiting. Secrets are encrypted with key

3368

2528

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

3369

2529

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

3370

2530

clients = {}

3371

2531

with PGPEngine() as pgp:

3372

for client in tcp_server.clients.values():

2532

for client in tcp_server.clients.itervalues():

3373

2533

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

3374

2534

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

3375

2535

key)

3376

2536

client_dict = {}

3377

2537

3378

2538

# A list of attributes that can not be pickled

3379

2539

# + secret.

3380

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

3381

"checker", "server_settings"}

3382

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

3383

.Object):

2540

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

2541

"checker"))

2542

for name, typ in (inspect.getmembers

2543

(dbus.service.Object)):

3384

2544

exclude.add(name)

3385

2545

3386

2546

client_dict["encrypted_secret"] = (client

3387

2547

.encrypted_secret)

3388

2548

for attr in client.client_structure:

3389

2549

if attr not in exclude:

3390

2550

client_dict[attr] = getattr(client, attr)

3391

2551

3392

2552

clients[client.name] = client_dict

3393

2553

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

3394

2554

3395

2555

try:

3396

with tempfile.NamedTemporaryFile(

3397

mode='wb',

3398

suffix=".pickle",

3399

prefix='clients-',

3400

dir=os.path.dirname(stored_state_path),

3401

delete=False) as stored_state:

3402

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

3403

protocol=2)

3404

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)

3405

2562

os.rename(tempname, stored_state_path)

3406

2563

except (IOError, OSError) as e:

2564

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

2565

.format(e))

3407

2566

if not debug:

3408

2567

try:

3409

2568

os.remove(tempname)

3410

2569

except NameError:

3411

2570

pass

3412

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

3413

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

3414

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

3415

else:

3416

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

3417

exc_info=e)

3418

raise

3419

2571

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

2572

errno.EEXIST)):

2573

raise e

2574

3420

2575

# Delete all clients, and settings from config

3421

2576

while tcp_server.clients:

3422

2577

name, client = tcp_server.clients.popitem()

3423

2578

if use_dbus:

3424

2579

client.remove_from_connection()

3425

# Don't signal the disabling

2580

# Don't signal anything except ClientRemoved

3426

2581

client.disable(quiet=True)

3427

# Emit D-Bus signal for removal

3428

2582

if use_dbus:

3429

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)

3430

2587

client_settings.clear()

3431

2588

3432

2589

atexit.register(cleanup)

3433

3434

for client in tcp_server.clients.values():

2590

2591

for client in tcp_server.clients.itervalues():

3435

2592

if use_dbus:

3436

# Emit D-Bus signal for adding

3437

mandos_dbus_service.client_added_signal(client)

2593

# Emit D-Bus signal

2594

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3438

2595

# Need to initiate checking of clients

3439

2596

if client.enabled:

3440

2597

client.init_checker()

3441

2598

3442

2599

tcp_server.enable()

3443

2600

tcp_server.server_activate()

3444

2601

3445

2602

# Find out what port we got

3446

if zeroconf:

3447

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

2603

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

3448

2604

if use_ipv6:

3449

2605

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

3450

" flowinfo %d, scope_id %d",

3451

*tcp_server.socket.getsockname())

2606

" flowinfo %d, scope_id %d"

2607

% tcp_server.socket.getsockname())

3452

2608

else: # IPv4

3453

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

3454

*tcp_server.socket.getsockname())

3455

3456

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

3457

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

3458

2614

try:

3459

if zeroconf:

3460

# From the Avahi example code

3461

try:

3462

service.activate()

3463

except dbus.exceptions.DBusException as error:

3464

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

3465

cleanup()

3466

sys.exit(1)

3467

# End of Avahi example code

3468

3469

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

3470

lambda *args, **kwargs:

3471

(tcp_server.handle_request

3472

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

3473

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

3474

2629

logger.debug("Starting main loop")

3475

2630

main_loop.run()

3476

2631

except AvahiError as error:

3477

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

2632

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

3478

2633

cleanup()

3479

2634

sys.exit(1)

3480

2635

except KeyboardInterrupt:

3485

2640

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

3486

2641

cleanup()

3487

2642

3488

3489

2643

if __name__ == '__main__':

3490

2644

main()