/mandos/trunk : revision 887

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

import SocketServer as socketserver

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

38

46

import socket

39

47

import argparse

40

48

import datetime

41

49

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

49

54

import sys

50

55

import re

51

56

import os

60

65

import struct

61

66

import fcntl

62

67

import functools

63

import cPickle as pickle

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

64

72

import multiprocessing

65

73

import types

66

74

import binascii

67

75

import tempfile

76

import itertools

77

import collections

78

import codecs

68

79

69

80

import dbus

70

81

import dbus.service

71

import gobject

72

import avahi

82

from gi.repository import GLib

73

83

from dbus.mainloop.glib import DBusGMainLoop

74

84

import ctypes

75

85

import ctypes.util

76

86

import xml.dom.minidom

77

87

import inspect

78

import GnuPGInterface

79

88

89

# Try to find the value of SO_BINDTODEVICE:

80

90

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:

81

93

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

82

94

except AttributeError:

83

95

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

84

98

from IN import SO_BINDTODEVICE

85

99

except ImportError:

86

SO_BINDTODEVICE = None

87

88

version = "1.4.1"

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"

89

118

stored_state_file = "clients.pickle"

90

119

91

120

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

121

syslogger = None

95

122

96

123

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

100

126

except (OSError, AttributeError):

127

101

128

def if_nametoindex(interface):

102

129

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

103

130

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

104

131

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

105

132

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

133

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

134

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

110

135

return interface_index

111

136

112

137

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

113

154

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

114

155

"""init logger and add loglevel"""

115

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

160

address="/dev/log"))

116

161

syslogger.setFormatter(logging.Formatter

117

162

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

118

163

' %(message)s'))

119

164

logger.addHandler(syslogger)

120

165

121

166

if debug:

122

167

console = logging.StreamHandler()

123

168

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

135

180

136

181

class PGPEngine(object):

137

182

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

183

138

184

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

185

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

147

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

148

205

def __enter__(self):

149

206

return self

150

151

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

207

208

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

152

209

self._cleanup()

153

210

return False

154

211

155

212

def __del__(self):

156

213

self._cleanup()

157

214

158

215

def _cleanup(self):

159

216

if self.tempdir is not None:

160

217

# Delete contents of tempdir

161

218

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

162

topdown = False):

219

topdown=False):

163

220

for filename in files:

164

221

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

165

222

for dirname in dirs:

167

224

# Remove tempdir

168

225

os.rmdir(self.tempdir)

169

226

self.tempdir = None

170

227

171

228

def password_encode(self, password):

172

229

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

173

230

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

174

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

175

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

176

239

def encrypt(self, data, password):

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

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)

191

255

return ciphertext

192

256

193

257

def decrypt(self, data, password):

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

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)

208

273

return decrypted_plaintext

209

274

210

275

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

211

302

212

303

class AvahiError(Exception):

213

304

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

214

305

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

306

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

307

**kwargs)

308

218

309

219

310

class AvahiServiceError(AvahiError):

220

311

pass

221

312

313

222

314

class AvahiGroupError(AvahiError):

223

315

pass

224

316

225

317

226

318

class AvahiService(object):

227

319

"""An Avahi (Zeroconf) service.

228

320

229

321

Attributes:

230

322

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

231

323

Used to optionally bind to the specified interface.

232

324

name: string; Example: 'Mandos'

233

325

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

234

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

326

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

235

327

port: integer; what port to announce

236

328

TXT: list of strings; TXT record for the service

237

329

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

243

335

server: D-Bus Server

244

336

bus: dbus.SystemBus()

245

337

"""

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

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

250

350

self.interface = interface

251

351

self.name = name

252

352

self.type = servicetype

261

361

self.server = None

262

362

self.bus = bus

263

363

self.entry_group_state_changed_match = None

264

def rename(self):

364

365

def rename(self, remove=True):

265

366

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

266

367

if self.rename_count >= self.max_renames:

267

368

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

268

369

" after %i retries, exiting.",

269

370

self.rename_count)

270

371

raise AvahiServiceError("Too many renames")

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

273

375

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

274

376

self.name)

275

self.remove()

377

if remove:

378

self.remove()

276

379

try:

277

380

self.add()

278

381

except dbus.exceptions.DBusException as error:

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

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

283

391

def remove(self):

284

392

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

285

393

if self.entry_group_state_changed_match is not None:

287

395

self.entry_group_state_changed_match = None

288

396

if self.group is not None:

289

397

self.group.Reset()

398

290

399

def add(self):

291

400

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

292

401

self.remove()

309

418

dbus.UInt16(self.port),

310

419

avahi.string_array_to_txt_array(self.TXT))

311

420

self.group.Commit()

421

312

422

def entry_group_state_changed(self, state, error):

313

423

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

314

424

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

315

425

316

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

317

427

logger.debug("Zeroconf service established.")

318

428

elif state == avahi.ENTRY_GROUP_COLLISION:

320

430

self.rename()

321

431

elif state == avahi.ENTRY_GROUP_FAILURE:

322

432

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

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

433

str(error))

434

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

435

326

436

def cleanup(self):

327

437

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

328

438

if self.group is not None:

333

443

pass

334

444

self.group = None

335

445

self.remove()

446

336

447

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

337

448

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

338

449

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

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

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

}

346

456

if state in bad_states:

347

457

if bad_states[state] is not None:

348

458

if error is None:

351

461

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

352

462

self.cleanup()

353

463

elif state == avahi.SERVER_RUNNING:

354

self.add()

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

476

else:

356

477

if error is None:

357

478

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

358

479

else:

359

480

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

481

360

482

def activate(self):

361

483

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

362

484

if self.server is None:

366

488

follow_name_owner_changes=True),

367

489

avahi.DBUS_INTERFACE_SERVER)

368

490

self.server.connect_to_signal("StateChanged",

369

self.server_state_changed)

491

self.server_state_changed)

370

492

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

371

493

494

372

495

class AvahiServiceToSyslog(AvahiService):

373

def rename(self):

496

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

374

497

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

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

380

502

return ret

381

503

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

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

388

779

class Client(object):

389

780

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

390

781

391

782

Attributes:

392

783

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

393

784

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

395

786

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

396

787

to see if the client lives.

397

788

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

789

checker_callback_tag: a GLib event source tag, or None

399

790

checker_command: string; External command which is run to check

400

791

if client lives. %() expansions are done at

401

792

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

402

793

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

403

checker_initiator_tag: a gobject event source tag, or None

794

checker_initiator_tag: a GLib event source tag, or None

404

795

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

405

796

client_structure: Object describing what attributes a client has

406

797

and is used for storing the client at exit

407

798

current_checker_command: string; current running checker_command

408

disable_initiator_tag: a gobject event source tag, or None

799

disable_initiator_tag: a GLib event source tag, or None

409

800

enabled: bool()

410

801

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

411

802

uniquely identify the client

415

806

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

416

807

last_checker_status: integer between 0 and 255 reflecting exit

417

808

status of last checker. -1 reflects crashed

418

checker, or None.

809

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

419

812

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

420

813

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

421

814

D-Bus identifiers

422

815

secret: bytestring; sent verbatim (over TLS) to client

423

816

timeout: datetime.timedelta(); How long from last_checked_ok

424

817

until this client is disabled

425

extended_timeout: extra long timeout when password has been sent

818

extended_timeout: extra long timeout when secret has been sent

426

819

runtime_expansions: Allowed attributes for runtime expansion.

427

820

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

428

821

disabled, or None

822

server_settings: The server_settings dict from main()

429

823

"""

430

824

431

825

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

826

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

827

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

828

"last_approval_request", "last_checked_ok",

434

829

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

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

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

}

460

841

461

842

@staticmethod

462

843

def config_parser(config):

470

851

for client_name in config.sections():

471

852

section = dict(config.items(client_name))

472

853

client = settings[client_name] = {}

473

854

474

855

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

475

856

# Reformat values from string types to Python types

476

857

client["approved_by_default"] = config.getboolean(

477

858

client_name, "approved_by_default")

478

859

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

479

860

"enabled")

480

861

862

# Uppercase and remove spaces from fingerprint for later

863

# comparison purposes with return value from the

864

# fingerprint() function

481

865

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

482

866

.replace(" ", ""))

483

867

if "secret" in section:

484

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

868

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

869

.encode("utf-8"),

870

"base64")

485

871

elif "secfile" in section:

486

872

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

487

873

(section["secfile"])),

488

874

"rb") as secfile:

489

875

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

490

876

else:

491

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

492

% section)

877

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

878

.format(section))

493

879

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

494

880

client["extended_timeout"] = string_to_delta(

495

881

section["extended_timeout"])

501

887

client["checker_command"] = section["checker"]

502

888

client["last_approval_request"] = None

503

889

client["last_checked_ok"] = None

504

client["last_checker_status"] = None

505

890

client["last_checker_status"] = -2

891

506

892

return settings

507

508

509

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

510

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

511

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

512

attribute."""

893

894

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

513

895

self.name = name

896

if server_settings is None:

897

server_settings = {}

898

self.server_settings = server_settings

514

899

# adding all client settings

515

for setting, value in settings.iteritems():

900

for setting, value in settings.items():

516

901

setattr(self, setting, value)

517

902

518

903

if self.enabled:

519

904

if not hasattr(self, "last_enabled"):

520

905

self.last_enabled = datetime.datetime.utcnow()

524

909

else:

525

910

self.last_enabled = None

526

911

self.expires = None

527

912

528

913

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

532

914

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

533

915

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

534

916

datetime.datetime.utcnow())

541

923

self.current_checker_command = None

542

924

self.approved = None

543

925

self.approvals_pending = 0

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

926

self.changedstate = multiprocessing_manager.Condition(

927

multiprocessing_manager.Lock())

928

self.client_structure = [attr

929

for attr in self.__dict__.keys()

549

930

if not attr.startswith("_")]

550

931

self.client_structure.append("client_structure")

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

932

933

for name, t in inspect.getmembers(

934

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

556

935

if not name.startswith("_"):

557

936

self.client_structure.append(name)

558

937

559

938

# Send notice to process children that client state has changed

560

939

def send_changedstate(self):

561

940

with self.changedstate:

562

941

self.changedstate.notify_all()

563

942

564

943

def enable(self):

565

944

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

566

945

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

567

946

# Already enabled

568

947

return

569

self.send_changedstate()

570

948

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

571

949

self.enabled = True

572

950

self.last_enabled = datetime.datetime.utcnow()

573

951

self.init_checker()

574

952

self.send_changedstate()

953

575

954

def disable(self, quiet=True):

576

955

"""Disable this client."""

577

956

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

578

957

return False

579

958

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

959

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

583

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

584

gobject.source_remove(self.disable_initiator_tag)

960

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

961

GLib.source_remove(self.disable_initiator_tag)

585

962

self.disable_initiator_tag = None

586

963

self.expires = None

587

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

588

gobject.source_remove(self.checker_initiator_tag)

964

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

965

GLib.source_remove(self.checker_initiator_tag)

589

966

self.checker_initiator_tag = None

590

967

self.stop_checker()

591

968

self.enabled = False

592

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

969

if not quiet:

970

self.send_changedstate()

971

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

593

972

return False

594

973

595

974

def __del__(self):

596

975

self.disable()

597

976

598

977

def init_checker(self):

599

978

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

600

979

# and every interval from then on.

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

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)

604

985

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

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)

608

990

# Also start a new checker *right now*.

609

991

self.start_checker()

610

611

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

992

993

def checker_callback(self, source, condition, connection,

994

command):

612

995

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

613

996

self.checker_callback_tag = None

614

997

self.checker = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

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

617

1005

if self.last_checker_status == 0:

618

1006

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

619

1007

vars(self))

620

1008

self.checked_ok()

621

1009

else:

622

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

623

vars(self))

1010

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

624

1011

else:

625

1012

self.last_checker_status = -1

1013

self.last_checker_signal = -returncode

626

1014

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

627

1015

vars(self))

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

This should only be called when the client has been seen,

633

alive and well.

634

"""

1016

return False

1017

1018

def checked_ok(self):

1019

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

1020

self.last_checked_ok = datetime.datetime.utcnow()

1021

self.last_checker_status = 0

1022

self.last_checker_signal = None

1023

self.bump_timeout()

1024

1025

def bump_timeout(self, timeout=None):

1026

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

635

1027

if timeout is None:

636

1028

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

638

1029

if self.disable_initiator_tag is not None:

639

gobject.source_remove(self.disable_initiator_tag)

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = None

640

1032

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1033

self.disable_initiator_tag = GLib.timeout_add(

1034

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

644

1035

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

645

1036

646

1037

def need_approval(self):

647

1038

self.last_approval_request = datetime.datetime.utcnow()

648

1039

649

1040

def start_checker(self):

650

1041

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

651

1042

652

1043

If a checker already exists, leave it running and do

653

1044

nothing."""

654

1045

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

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

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

659

1050

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

660

1051

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

661

1052

# should be.

662

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

self.current_checker_command)

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

676

1058

# Start a new checker if needed

677

1059

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}

678

1064

try:

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

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

697

1071

self.current_checker_command = command

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

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

720

error)

721

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

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

722

1098

return True

723

1099

724

1100

def stop_checker(self):

725

1101

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

726

1102

if self.checker_callback_tag:

727

gobject.source_remove(self.checker_callback_tag)

1103

GLib.source_remove(self.checker_callback_tag)

728

1104

self.checker_callback_tag = None

729

1105

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

730

1106

return

731

1107

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

732

try:

733

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

734

#time.sleep(0.5)

735

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

736

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

737

except OSError as error:

738

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

739

raise

1108

self.checker.terminate()

740

1109

self.checker = None

741

1110

742

1111

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1112

def dbus_service_property(dbus_interface,

1113

signature="v",

1114

access="readwrite",

1115

byte_arrays=False):

745

1116

"""Decorators for marking methods of a DBusObjectWithProperties to

746

1117

become properties on the D-Bus.

747

1118

748

1119

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

749

1120

and with one argument by "Set".

750

1121

751

1122

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

752

1123

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

753

1124

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

756

1127

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

757

1128

if byte_arrays and signature != "ay":

758

1129

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

759

" signature %r" % signature)

1130

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

1131

760

1132

def decorator(func):

761

1133

func._dbus_is_property = True

762

1134

func._dbus_interface = dbus_interface

765

1137

func._dbus_name = func.__name__

766

1138

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

767

1139

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

768

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

return func

1140

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1141

return func

1142

1143

return decorator

1144

1145

1146

def dbus_interface_annotations(dbus_interface):

1147

"""Decorator for marking functions returning interface annotations

1148

1149

Usage:

1150

1151

@dbus_interface_annotations("org.example.Interface")

1152

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

1153

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

1154

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

1155

"false"}

1156

"""

1157

1158

def decorator(func):

1159

func._dbus_is_interface = True

1160

func._dbus_interface = dbus_interface

1161

func._dbus_name = dbus_interface

1162

return func

1163

1164

return decorator

1165

1166

1167

def dbus_annotations(annotations):

1168

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

1169

Usage:

1170

1171

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

1172

"org.freedesktop.DBus.Property."

1173

"EmitsChangedSignal": "false"})

1174

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

1175

access="r")

1176

def Property_dbus_property(self):

1177

return dbus.Boolean(False)

1178

1179

See also the DBusObjectWithAnnotations class.

1180

"""

1181

1182

def decorator(func):

1183

func._dbus_annotations = annotations

1184

return func

1185

770

1186

return decorator

771

1187

772

1188

773

1189

class DBusPropertyException(dbus.exceptions.DBusException):

774

1190

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

775

1191

"""

776

def __unicode__(self):

777

return unicode(str(self))

1192

pass

778

1193

779

1194

780

1195

class DBusPropertyAccessException(DBusPropertyException):

789

1204

pass

790

1205

791

1206

792

class DBusObjectWithProperties(dbus.service.Object):

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.

1212

"""

1213

1214

@staticmethod

1215

def _is_dbus_thing(thing):

1216

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

1217

1218

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

1219

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

1220

"""

1221

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

1222

False)

1223

1224

def _get_all_dbus_things(self, thing):

1225

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

1226

"""

1227

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

1228

athing.__get__(self))

1229

for cls in self.__class__.__mro__

1230

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

793

1297

"""A D-Bus object with properties.

794

1298

795

1299

Classes inheriting from this can use the dbus_service_property

796

1300

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

797

1301

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

798

1302

"""

799

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

return ((prop.__get__(self)._dbus_name, prop.__get__(self))

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

1303

812

1304

def _get_dbus_property(self, interface_name, property_name):

813

1305

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

814

1306

property with the specified name and interface.

815

1307

"""

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1308

for cls in self.__class__.__mro__:

1309

for name, value in inspect.getmembers(

1310

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

819

1311

if (value._dbus_name == property_name

820

1312

and value._dbus_interface == interface_name):

821

1313

return value.__get__(self)

822

1314

823

1315

# No such property

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

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

829

1330

out_signature="v")

830

1331

def Get(self, interface_name, property_name):

831

1332

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

837

1338

if not hasattr(value, "variant_level"):

838

1339

return value

839

1340

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

840

1341

841

1342

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

842

1343

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

843

1344

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

849

1350

# The byte_arrays option is not supported yet on

850

1351

# signatures other than "ay".

851

1352

if prop._dbus_signature != "ay":

852

raise ValueError

1353

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

1354

"'ay' signature {!r}"

1355

.format(prop._dbus_signature))

853

1356

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

854

1357

for byte in value))

855

1358

prop(value)

856

857

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

1359

1360

@dbus.service.method(dbus.PROPERTIES_IFACE,

1361

in_signature="s",

858

1362

out_signature="a{sv}")

859

1363

def GetAll(self, interface_name):

860

1364

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

861

1365

standard.

862

1366

863

1367

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

864

1368

"""

865

1369

properties = {}

866

for name, prop in self._get_all_dbus_properties():

1370

for name, prop in self._get_all_dbus_things("property"):

867

1371

if (interface_name

868

1372

and interface_name != prop._dbus_interface):

869

1373

# Interface non-empty but did not match

875

1379

if not hasattr(value, "variant_level"):

876

1380

properties[name] = value

877

1381

continue

878

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

879

value.variant_level+1)

1382

properties[name] = type(value)(

1383

value, variant_level=value.variant_level + 1)

880

1384

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

881

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

882

1394

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

883

1395

out_signature="s",

884

1396

path_keyword='object_path',

885

1397

connection_keyword='connection')

886

1398

def Introspect(self, object_path, connection):

887

"""Standard D-Bus method, overloaded to insert property tags.

1399

"""Overloading of standard D-Bus method.

1400

1401

Inserts property tags and interface annotation tags.

888

1402

"""

889

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

890

connection)

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

891

1406

try:

892

1407

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

1408

893

1409

def make_tag(document, name, prop):

894

1410

e = document.createElement("property")

895

1411

e.setAttribute("name", name)

896

1412

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

897

1413

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

898

1414

return e

1415

899

1416

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

1417

# Add property tags

900

1418

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

901

1419

for name, prop

902

in self._get_all_dbus_properties()

1420

in self._get_all_dbus_things("property")

903

1421

if prop._dbus_interface

904

1422

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

905

1423

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)

906

1440

# Add the names to the return values for the

907

1441

# "org.freedesktop.DBus.Properties" methods

908

1442

if (if_tag.getAttribute("name")

923

1457

except (AttributeError, xml.dom.DOMException,

924

1458

xml.parsers.expat.ExpatError) as error:

925

1459

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

926

error)

927

return xmlstring

928

929

930

def datetime_to_dbus (dt, variant_level=0):

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

931

1535

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

932

1536

if dt is None:

933

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

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

942

1563

"""

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

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

950

1572

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

951

1573

# with the wrong interface name

952

1574

if (not hasattr(attribute, "_dbus_interface")

953

or not attribute._dbus_interface

954

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

1575

or not attribute._dbus_interface.startswith(

1576

orig_interface_name)):

955

1577

continue

956

1578

# Create an alternate D-Bus interface name based on

957

1579

# the current name

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1580

alt_interface = attribute._dbus_interface.replace(

1581

orig_interface_name, alt_interface_name)

1582

interface_names.add(alt_interface)

961

1583

# Is this a D-Bus signal?

962

1584

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

963

# Extract the original non-method function by

964

# black magic

965

nonmethod_func = (dict(

1585

# Extract the original non-method undecorated

1586

# function by black magic

1587

if sys.version_info.major == 2:

1588

nonmethod_func = (dict(

966

1589

zip(attribute.func_code.co_freevars,

967

attribute.__closure__))["func"]

968

.cell_contents)

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)

969

1597

# Create a new, but exactly alike, function

970

1598

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

971

1599

# with the alternate D-Bus interface name

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

nonmethod_func.func_closure)))

1600

new_function = copy_function(nonmethod_func)

1601

new_function = (dbus.service.signal(

1602

alt_interface,

1603

attribute._dbus_signature)(new_function))

1604

# Copy annotations, if any

1605

try:

1606

new_function._dbus_annotations = dict(

1607

attribute._dbus_annotations)

1608

except AttributeError:

1609

pass

1610

981

1611

# Define a creator of a function to call both the

982

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

983

# signals gets sent when the function is called

1612

# original and alternate functions, so both the

1613

# original and alternate signals gets sent when

1614

# the function is called

984

1615

def fixscope(func1, func2):

985

1616

"""This function is a scope container to pass

986

1617

func1 and func2 to the "call_both" function

987

1618

outside of its arguments"""

1619

1620

@functools.wraps(func2)

988

1621

def call_both(*args, **kwargs):

989

1622

"""This function will emit two D-Bus

990

1623

signals by calling func1 and func2"""

991

1624

func1(*args, **kwargs)

992

1625

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

993

1632

return call_both

994

1633

# Create the "call_both" function and add it to

995

1634

# the class

996

attr[attrname] = fixscope(attribute,

997

new_function)

1635

attr[attrname] = fixscope(attribute, new_function)

998

1636

# Is this a D-Bus method?

999

1637

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

1000

1638

# Create a new, but exactly alike, function

1001

1639

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

1002

1640

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

1003

1641

# to the class.

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

attribute.func_closure)))

1642

attr[attrname] = (

1643

dbus.service.method(

1644

alt_interface,

1645

attribute._dbus_in_signature,

1646

attribute._dbus_out_signature)

1647

(copy_function(attribute)))

1648

# Copy annotations, if any

1649

try:

1650

attr[attrname]._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1652

except AttributeError:

1653

pass

1014

1654

# Is this a D-Bus property?

1015

1655

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

1016

1656

# Create a new, but exactly alike, function

1017

1657

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

1018

1658

# property with the alternate D-Bus interface

1019

1659

# name. Add it to the class.

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

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

1034

1035

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

1666

# Copy annotations, if any

1667

try:

1668

attr[attrname]._dbus_annotations = dict(

1669

attribute._dbus_annotations)

1670

except AttributeError:

1671

pass

1672

# Is this a D-Bus interface?

1673

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

1674

# Create a new, but exactly alike, function

1675

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

1676

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

1677

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

1036

1712

class ClientDBus(Client, DBusObjectWithProperties):

1037

1713

"""A Client class using D-Bus

1038

1714

1039

1715

Attributes:

1040

1716

dbus_object_path: dbus.ObjectPath

1041

1717

bus: dbus.SystemBus()

1042

1718

"""

1043

1719

1044

1720

runtime_expansions = (Client.runtime_expansions

1045

+ ("dbus_object_path",))

1046

1721

+ ("dbus_object_path", ))

1722

1723

_interface = "se.recompile.Mandos.Client"

1724

1047

1725

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

1048

1049

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

1726

1727

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

1050

1728

self.bus = bus

1051

1729

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

1052

self._approvals_pending = 0

1053

1054

self._approvals_pending = 0

1055

1730

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

1056

1731

# the D-Bus

1057

client_object_name = unicode(self.name).translate(

1732

client_object_name = str(self.name).translate(

1058

1733

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

1059

1734

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

1060

self.dbus_object_path = (dbus.ObjectPath

1061

("/clients/" + client_object_name))

1735

self.dbus_object_path = dbus.ObjectPath(

1736

"/clients/" + client_object_name)

1062

1737

DBusObjectWithProperties.__init__(self, self.bus,

1063

1738

self.dbus_object_path)

1064

1065

def notifychangeproperty(transform_func,

1066

dbus_name, type_func=lambda x: x,

1067

variant_level=1):

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

1068

1745

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

1069

1746

its changes to DBus.

1070

1747

1071

1748

transform_fun: Function that takes a value and a variant_level

1072

1749

and transforms it to a D-Bus type.

1073

1750

dbus_name: D-Bus name of the variable

1075

1752

to the D-Bus. Default: no transform

1076

1753

variant_level: D-Bus variant level. Default: 1

1077

1754

"""

1078

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

1755

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

1756

1079

1757

def setter(self, value):

1080

1758

if hasattr(self, "dbus_object_path"):

1081

1759

if (not hasattr(self, attrname) or

1082

1760

type_func(getattr(self, attrname, None))

1083

1761

!= type_func(value)):

1084

dbus_value = transform_func(type_func(value),

1085

variant_level

1086

=variant_level)

1087

self.PropertyChanged(dbus.String(dbus_name),

1088

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

1089

1777

setattr(self, attrname, value)

1090

1778

1091

1779

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

1092

1093

1780

1094

1781

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1095

1782

approvals_pending = notifychangeproperty(dbus.Boolean,

1096

1783

"ApprovalPending",

1097

type_func = bool)

1784

type_func=bool)

1098

1785

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

1099

1786

last_enabled = notifychangeproperty(datetime_to_dbus,

1100

1787

"LastEnabled")

1101

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

1102

type_func = lambda checker:

1103

checker is not None)

1788

checker = notifychangeproperty(

1789

dbus.Boolean, "CheckerRunning",

1790

type_func=lambda checker: checker is not None)

1104

1791

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1105

1792

"LastCheckedOK")

1793

last_checker_status = notifychangeproperty(dbus.Int16,

1794

"LastCheckerStatus")

1106

1795

last_approval_request = notifychangeproperty(

1107

1796

datetime_to_dbus, "LastApprovalRequest")

1108

1797

approved_by_default = notifychangeproperty(dbus.Boolean,

1109

1798

"ApprovedByDefault")

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1799

approval_delay = notifychangeproperty(

1800

dbus.UInt64, "ApprovalDelay",

1801

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

1114

1802

approval_duration = notifychangeproperty(

1115

1803

dbus.UInt64, "ApprovalDuration",

1116

type_func = timedelta_to_milliseconds)

1804

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

1117

1805

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1806

timeout = notifychangeproperty(

1807

dbus.UInt64, "Timeout",

1808

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

1121

1809

extended_timeout = notifychangeproperty(

1122

1810

dbus.UInt64, "ExtendedTimeout",

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

timedelta_to_milliseconds)

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)

1128

1815

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

1129

1816

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

1817

invalidate_only=True)

1818

1130

1819

del notifychangeproperty

1131

1820

1132

1821

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

1133

1822

try:

1134

1823

self.remove_from_connection()

1137

1826

if hasattr(DBusObjectWithProperties, "__del__"):

1138

1827

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

1139

1828

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

1140

1141

def checker_callback(self, pid, condition, command,

1142

*args, **kwargs):

1143

self.checker_callback_tag = None

1144

self.checker = None

1145

if os.WIFEXITED(condition):

1146

exitstatus = os.WEXITSTATUS(condition)

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:

1147

1837

# Emit D-Bus signal

1148

1838

self.CheckerCompleted(dbus.Int16(exitstatus),

1149

dbus.Int64(condition),

1839

# This is specific to GNU libC

1840

dbus.Int64(exitstatus << 8),

1150

1841

dbus.String(command))

1151

1842

else:

1152

1843

# Emit D-Bus signal

1153

1844

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

1154

dbus.Int64(condition),

1845

dbus.Int64(

1846

# This is specific to GNU libC

1847

(exitstatus << 8)

1848

| self.last_checker_signal),

1155

1849

dbus.String(command))

1156

1157

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

1158

*args, **kwargs)

1159

1850

return ret

1851

1160

1852

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

1161

old_checker = self.checker

1162

if self.checker is not None:

1163

old_checker_pid = self.checker.pid

1164

else:

1165

old_checker_pid = None

1853

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

1166

1854

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

1167

1855

# Only if new checker process was started

1168

1856

if (self.checker is not None

1170

1858

# Emit D-Bus signal

1171

1859

self.CheckerStarted(self.current_checker_command)

1172

1860

return r

1173

1861

1174

1862

def _reset_approved(self):

1175

1863

self.approved = None

1176

1864

return False

1177

1865

1178

1866

def approve(self, value=True):

1179

self.send_changedstate()

1180

1867

self.approved = value

1181

gobject.timeout_add(timedelta_to_milliseconds

1182

(self.approval_duration),

1183

self._reset_approved)

1184

1185

1186

## D-Bus methods, signals & properties

1187

_interface = "se.recompile.Mandos.Client"

1188

1189

## Signals

1190

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

1191

1878

# CheckerCompleted - signal

1192

1879

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

1193

1880

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

1194

1881

"D-Bus signal"

1195

1882

pass

1196

1883

1197

1884

# CheckerStarted - signal

1198

1885

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

1199

1886

def CheckerStarted(self, command):

1200

1887

"D-Bus signal"

1201

1888

pass

1202

1889

1203

1890

# PropertyChanged - signal

1891

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

1204

1892

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

1205

1893

def PropertyChanged(self, property, value):

1206

1894

"D-Bus signal"

1207

1895

pass

1208

1896

1209

1897

# GotSecret - signal

1210

1898

@dbus.service.signal(_interface)

1211

1899

def GotSecret(self):

1214

1902

server to mandos-client

1215

1903

"""

1216

1904

pass

1217

1905

1218

1906

# Rejected - signal

1219

1907

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

1220

1908

def Rejected(self, reason):

1221

1909

"D-Bus signal"

1222

1910

pass

1223

1911

1224

1912

# NeedApproval - signal

1225

1913

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

1226

1914

def NeedApproval(self, timeout, default):

1227

1915

"D-Bus signal"

1228

1916

return self.need_approval()

1229

1230

# NeRwequest - signal

1231

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

1232

def NewRequest(self, ip):

1233

"""D-Bus signal

1234

Is sent after a client request a password.

1235

"""

1236

pass

1237

1238

## Methods

1239

1917

1918

# Methods

1919

1240

1920

# Approve - method

1241

1921

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

1242

1922

def Approve(self, value):

1243

1923

self.approve(value)

1244

1924

1245

1925

# CheckedOK - method

1246

1926

@dbus.service.method(_interface)

1247

1927

def CheckedOK(self):

1248

1928

self.checked_ok()

1249

1929

1250

1930

# Enable - method

1931

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

1251

1932

@dbus.service.method(_interface)

1252

1933

def Enable(self):

1253

1934

"D-Bus method"

1254

1935

self.enable()

1255

1936

1256

1937

# StartChecker - method

1938

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

1257

1939

@dbus.service.method(_interface)

1258

1940

def StartChecker(self):

1259

1941

"D-Bus method"

1260

1942

self.start_checker()

1261

1943

1262

1944

# Disable - method

1945

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

1263

1946

@dbus.service.method(_interface)

1264

1947

def Disable(self):

1265

1948

"D-Bus method"

1266

1949

self.disable()

1267

1950

1268

1951

# StopChecker - method

1952

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

1269

1953

@dbus.service.method(_interface)

1270

1954

def StopChecker(self):

1271

1955

self.stop_checker()

1272

1273

## Properties

1274

1956

1957

# Properties

1958

1275

1959

# ApprovalPending - property

1276

1960

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

1277

1961

def ApprovalPending_dbus_property(self):

1278

1962

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

1279

1963

1280

1964

# ApprovedByDefault - property

1281

@dbus_service_property(_interface, signature="b",

1965

@dbus_service_property(_interface,

1966

signature="b",

1282

1967

access="readwrite")

1283

1968

def ApprovedByDefault_dbus_property(self, value=None):

1284

1969

if value is None: # get

1285

1970

return dbus.Boolean(self.approved_by_default)

1286

1971

self.approved_by_default = bool(value)

1287

1972

1288

1973

# ApprovalDelay - property

1289

@dbus_service_property(_interface, signature="t",

1974

@dbus_service_property(_interface,

1975

signature="t",

1290

1976

access="readwrite")

1291

1977

def ApprovalDelay_dbus_property(self, value=None):

1292

1978

if value is None: # get

1293

return dbus.UInt64(self.approval_delay_milliseconds())

1979

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

1980

* 1000)

1294

1981

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

1295

1982

1296

1983

# ApprovalDuration - property

1297

@dbus_service_property(_interface, signature="t",

1984

@dbus_service_property(_interface,

1985

signature="t",

1298

1986

access="readwrite")

1299

1987

def ApprovalDuration_dbus_property(self, value=None):

1300

1988

if value is None: # get

1301

return dbus.UInt64(timedelta_to_milliseconds(

1302

self.approval_duration))

1989

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

1990

* 1000)

1303

1991

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

1304

1992

1305

1993

# Name - property

1994

@dbus_annotations(

1995

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

1306

1996

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

1307

1997

def Name_dbus_property(self):

1308

1998

return dbus.String(self.name)

1309

1999

1310

2000

# Fingerprint - property

2001

@dbus_annotations(

2002

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

1311

2003

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

1312

2004

def Fingerprint_dbus_property(self):

1313

2005

return dbus.String(self.fingerprint)

1314

2006

1315

2007

# Host - property

1316

@dbus_service_property(_interface, signature="s",

2008

@dbus_service_property(_interface,

2009

signature="s",

1317

2010

access="readwrite")

1318

2011

def Host_dbus_property(self, value=None):

1319

2012

if value is None: # get

1320

2013

return dbus.String(self.host)

1321

self.host = unicode(value)

1322

2014

self.host = str(value)

2015

1323

2016

# Created - property

2017

@dbus_annotations(

2018

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

1324

2019

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

1325

2020

def Created_dbus_property(self):

1326

2021

return datetime_to_dbus(self.created)

1327

2022

1328

2023

# LastEnabled - property

1329

2024

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

1330

2025

def LastEnabled_dbus_property(self):

1331

2026

return datetime_to_dbus(self.last_enabled)

1332

2027

1333

2028

# Enabled - property

1334

@dbus_service_property(_interface, signature="b",

2029

@dbus_service_property(_interface,

2030

signature="b",

1335

2031

access="readwrite")

1336

2032

def Enabled_dbus_property(self, value=None):

1337

2033

if value is None: # get

1340

2036

self.enable()

1341

2037

else:

1342

2038

self.disable()

1343

2039

1344

2040

# LastCheckedOK - property

1345

@dbus_service_property(_interface, signature="s",

2041

@dbus_service_property(_interface,

2042

signature="s",

1346

2043

access="readwrite")

1347

2044

def LastCheckedOK_dbus_property(self, value=None):

1348

2045

if value is not None:

1349

2046

self.checked_ok()

1350

2047

return

1351

2048

return datetime_to_dbus(self.last_checked_ok)

1352

2049

2050

# LastCheckerStatus - property

2051

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

2052

def LastCheckerStatus_dbus_property(self):

2053

return dbus.Int16(self.last_checker_status)

2054

1353

2055

# Expires - property

1354

2056

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

1355

2057

def Expires_dbus_property(self):

1356

2058

return datetime_to_dbus(self.expires)

1357

2059

1358

2060

# LastApprovalRequest - property

1359

2061

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

1360

2062

def LastApprovalRequest_dbus_property(self):

1361

2063

return datetime_to_dbus(self.last_approval_request)

1362

2064

1363

2065

# Timeout - property

1364

@dbus_service_property(_interface, signature="t",

2066

@dbus_service_property(_interface,

2067

signature="t",

1365

2068

access="readwrite")

1366

2069

def Timeout_dbus_property(self, value=None):

1367

2070

if value is None: # get

1368

return dbus.UInt64(self.timeout_milliseconds())

2071

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

2072

old_timeout = self.timeout

1369

2073

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

1370

# Reschedule timeout

2074

# Reschedule disabling

1371

2075

if self.enabled:

1372

2076

now = datetime.datetime.utcnow()

1373

time_to_die = timedelta_to_milliseconds(

1374

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

1375

if time_to_die <= 0:

2077

self.expires += self.timeout - old_timeout

2078

if self.expires <= now:

1376

2079

# The timeout has passed

1377

2080

self.disable()

1378

2081

else:

1379

self.expires = (now +

1380

datetime.timedelta(milliseconds =

1381

time_to_die))

1382

2082

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

1383

2083

is None):

1384

2084

return

1385

gobject.source_remove(self.disable_initiator_tag)

1386

self.disable_initiator_tag = (gobject.timeout_add

1387

(time_to_die,

1388

self.disable))

1389

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

1390

2090

# ExtendedTimeout - property

1391

@dbus_service_property(_interface, signature="t",

2091

@dbus_service_property(_interface,

2092

signature="t",

1392

2093

access="readwrite")

1393

2094

def ExtendedTimeout_dbus_property(self, value=None):

1394

2095

if value is None: # get

1395

return dbus.UInt64(self.extended_timeout_milliseconds())

2096

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

2097

* 1000)

1396

2098

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

1397

2099

1398

2100

# Interval - property

1399

@dbus_service_property(_interface, signature="t",

2101

@dbus_service_property(_interface,

2102

signature="t",

1400

2103

access="readwrite")

1401

2104

def Interval_dbus_property(self, value=None):

1402

2105

if value is None: # get

1403

return dbus.UInt64(self.interval_milliseconds())

2106

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

1404

2107

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

1405

2108

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

1406

2109

return

1407

2110

if self.enabled:

1408

2111

# Reschedule checker run

1409

gobject.source_remove(self.checker_initiator_tag)

1410

self.checker_initiator_tag = (gobject.timeout_add

1411

(value, self.start_checker))

1412

self.start_checker() # Start one now, too

1413

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

1414

2117

# Checker - property

1415

@dbus_service_property(_interface, signature="s",

2118

@dbus_service_property(_interface,

2119

signature="s",

1416

2120

access="readwrite")

1417

2121

def Checker_dbus_property(self, value=None):

1418

2122

if value is None: # get

1419

2123

return dbus.String(self.checker_command)

1420

self.checker_command = unicode(value)

1421

2124

self.checker_command = str(value)

2125

1422

2126

# CheckerRunning - property

1423

@dbus_service_property(_interface, signature="b",

2127

@dbus_service_property(_interface,

2128

signature="b",

1424

2129

access="readwrite")

1425

2130

def CheckerRunning_dbus_property(self, value=None):

1426

2131

if value is None: # get

1429

2134

self.start_checker()

1430

2135

else:

1431

2136

self.stop_checker()

1432

2137

1433

2138

# ObjectPath - property

2139

@dbus_annotations(

2140

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

2141

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

1434

2142

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

1435

2143

def ObjectPath_dbus_property(self):

1436

return self.dbus_object_path # is already a dbus.ObjectPath

1437

2144

return self.dbus_object_path # is already a dbus.ObjectPath

2145

1438

2146

# Secret = property

1439

@dbus_service_property(_interface, signature="ay",

1440

access="write", byte_arrays=True)

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)

1441

2154

def Secret_dbus_property(self, value):

1442

self.secret = str(value)

1443

2155

self.secret = bytes(value)

2156

1444

2157

del _interface

1445

2158

1446

2159

1449

2162

self._pipe = child_pipe

1450

2163

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

1451

2164

if not self._pipe.recv():

1452

raise KeyError()

1453

2165

raise KeyError(fpr)

2166

1454

2167

def __getattribute__(self, name):

1455

2168

if name == '_pipe':

1456

2169

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

1459

2172

if data[0] == 'data':

1460

2173

return data[1]

1461

2174

if data[0] == 'function':

2175

1462

2176

def func(*args, **kwargs):

1463

2177

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

1464

2178

return self._pipe.recv()[1]

2179

1465

2180

return func

1466

2181

1467

2182

def __setattr__(self, name, value):

1468

2183

if name == '_pipe':

1469

2184

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

1470

2185

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

1471

2186

1472

2187

1473

class ClientDBusTransitional(ClientDBus):

1474

__metaclass__ = AlternateDBusNamesMetaclass

1475

1476

1477

2188

class ClientHandler(socketserver.BaseRequestHandler, object):

1478

2189

"""A class to handle client connections.

1479

2190

1480

2191

Instantiated once for each connection to handle it.

1481

2192

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

1482

2193

1483

2194

def handle(self):

1484

2195

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

1485

2196

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

1486

unicode(self.client_address))

2197

str(self.client_address))

1487

2198

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

1488

2199

self.server.child_pipe.fileno())

1489

1490

session = (gnutls.connection

1491

.ClientSession(self.request,

1492

gnutls.connection

1493

.X509Credentials()))

1494

1495

# Note: gnutls.connection.X509Credentials is really a

1496

# generic GnuTLS certificate credentials object so long as

1497

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

1498

# here despite using OpenPGP certificates.

1499

1500

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

1501

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

1502

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

1503

# "+DHE-DSS"))

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

1504

2207

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

1505

2208

priority = self.server.gnutls_priority

1506

2209

if priority is None:

1507

2210

priority = "NORMAL"

1508

(gnutls.library.functions

1509

.gnutls_priority_set_direct(session._c_object,

1510

priority, None))

1511

2211

gnutls.priority_set_direct(session._c_object,

2212

priority.encode("utf-8"),

2213

None)

2214

1512

2215

# Start communication using the Mandos protocol

1513

2216

# Get protocol number

1514

2217

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

1515

2218

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

1516

2219

try:

1517

2220

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

1518

raise RuntimeError

2221

raise RuntimeError(line)

1519

2222

except (ValueError, IndexError, RuntimeError) as error:

1520

2223

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

1521

2224

return

1522

2225

1523

2226

# Start GnuTLS connection

1524

2227

try:

1525

2228

session.handshake()

1526

except gnutls.errors.GNUTLSError as error:

2229

except gnutls.Error as error:

1527

2230

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

1528

2231

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

1529

2232

# established. Just abandon the request.

1530

2233

return

1531

2234

logger.debug("Handshake succeeded")

1532

2235

1533

2236

approval_required = False

1534

2237

try:

1535

2238

try:

1536

fpr = self.fingerprint(self.peer_certificate

1537

(session))

1538

except (TypeError,

1539

gnutls.errors.GNUTLSError) as error:

2239

fpr = self.fingerprint(

2240

self.peer_certificate(session))

2241

except (TypeError, gnutls.Error) as error:

1540

2242

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

1541

2243

return

1542

2244

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

1543

2245

1544

2246

try:

1545

2247

client = ProxyClient(child_pipe, fpr,

1546

2248

self.client_address)

1547

2249

except KeyError:

1548

2250

return

1549

1550

if self.server.use_dbus:

1551

# Emit D-Bus signal

1552

client.NewRequest(str(self.client_address))

1553

2251

1554

2252

if client.approval_delay:

1555

2253

delay = client.approval_delay

1556

2254

client.approvals_pending += 1

1557

2255

approval_required = True

1558

2256

1559

2257

while True:

1560

2258

if not client.enabled:

1561

2259

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

1562

client.name)

2260

client.name)

1563

2261

if self.server.use_dbus:

1564

2262

# Emit D-Bus signal

1565

2263

client.Rejected("Disabled")

1566

2264

return

1567

2265

1568

2266

if client.approved or not client.approval_delay:

1569

#We are approved or approval is disabled

2267

# We are approved or approval is disabled

1570

2268

break

1571

2269

elif client.approved is None:

1572

2270

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

1574

2272

if self.server.use_dbus:

1575

2273

# Emit D-Bus signal

1576

2274

client.NeedApproval(

1577

client.approval_delay_milliseconds(),

1578

client.approved_by_default)

2275

client.approval_delay.total_seconds()

2276

* 1000, client.approved_by_default)

1579

2277

else:

1580

2278

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

1581

2279

client.name)

1583

2281

# Emit D-Bus signal

1584

2282

client.Rejected("Denied")

1585

2283

return

1586

1587

#wait until timeout or approved

2284

2285

# wait until timeout or approved

1588

2286

time = datetime.datetime.now()

1589

2287

client.changedstate.acquire()

1590

(client.changedstate.wait

1591

(float(client.timedelta_to_milliseconds(delay)

1592

/ 1000)))

2288

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

1593

2289

client.changedstate.release()

1594

2290

time2 = datetime.datetime.now()

1595

2291

if (time2 - time) >= delay:

1605

2301

break

1606

2302

else:

1607

2303

delay -= time2 - time

1608

1609

sent_size = 0

1610

while sent_size < len(client.secret):

1611

try:

1612

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

1613

except gnutls.errors.GNUTLSError as error:

1614

logger.warning("gnutls send failed")

1615

return

1616

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

1617

sent, len(client.secret)

1618

- (sent_size + sent))

1619

sent_size += sent

1620

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

1621

2312

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

1622

2313

# bump the timeout using extended_timeout

1623

client.checked_ok(client.extended_timeout)

2314

client.bump_timeout(client.extended_timeout)

1624

2315

if self.server.use_dbus:

1625

2316

# Emit D-Bus signal

1626

2317

client.GotSecret()

1627

2318

1628

2319

finally:

1629

2320

if approval_required:

1630

2321

client.approvals_pending -= 1

1631

2322

try:

1632

2323

session.bye()

1633

except gnutls.errors.GNUTLSError as error:

1634

logger.warning("GnuTLS bye failed")

1635

2324

except gnutls.Error as error:

2325

logger.warning("GnuTLS bye failed",

2326

exc_info=error)

2327

1636

2328

@staticmethod

1637

2329

def peer_certificate(session):

1638

2330

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

1639

2331

# If not an OpenPGP certificate...

1640

if (gnutls.library.functions

1641

.gnutls_certificate_type_get(session._c_object)

1642

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1643

# ...do the normal thing

1644

return session.peer_certificate

2332

if (gnutls.certificate_type_get(session._c_object)

2333

!= gnutls.CRT_OPENPGP):

2334

# ...return invalid data

2335

return b""

1645

2336

list_size = ctypes.c_uint(1)

1646

cert_list = (gnutls.library.functions

1647

.gnutls_certificate_get_peers

2337

cert_list = (gnutls.certificate_get_peers

1648

2338

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

1649

2339

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

1650

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

1651

" certificate")

2340

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

1652

2341

if list_size.value == 0:

1653

2342

return None

1654

2343

cert = cert_list[0]

1655

2344

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

1656

2345

1657

2346

@staticmethod

1658

2347

def fingerprint(openpgp):

1659

2348

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1660

2349

# New GnuTLS "datum" with the OpenPGP public key

1661

datum = (gnutls.library.types

1662

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

1663

ctypes.POINTER

1664

(ctypes.c_ubyte)),

1665

ctypes.c_uint(len(openpgp))))

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

1666

2354

# New empty GnuTLS certificate

1667

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1668

(gnutls.library.functions

1669

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2355

crt = gnutls.openpgp_crt_t()

2356

gnutls.openpgp_crt_init(ctypes.byref(crt))

1670

2357

# Import the OpenPGP public key into the certificate

1671

(gnutls.library.functions

1672

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

1673

gnutls.library.constants

1674

.GNUTLS_OPENPGP_FMT_RAW))

2358

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

2359

gnutls.OPENPGP_FMT_RAW)

1675

2360

# Verify the self signature in the key

1676

2361

crtverify = ctypes.c_uint()

1677

(gnutls.library.functions

1678

.gnutls_openpgp_crt_verify_self(crt, 0,

1679

ctypes.byref(crtverify)))

2362

gnutls.openpgp_crt_verify_self(crt, 0,

2363

ctypes.byref(crtverify))

1680

2364

if crtverify.value != 0:

1681

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1682

raise (gnutls.errors.CertificateSecurityError

1683

("Verify failed"))

2365

gnutls.openpgp_crt_deinit(crt)

2366

raise gnutls.CertificateSecurityError("Verify failed")

1684

2367

# New buffer for the fingerprint

1685

2368

buf = ctypes.create_string_buffer(20)

1686

2369

buf_len = ctypes.c_size_t()

1687

2370

# Get the fingerprint from the certificate into the buffer

1688

(gnutls.library.functions

1689

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

1690

ctypes.byref(buf_len)))

2371

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

2372

ctypes.byref(buf_len))

1691

2373

# Deinit the certificate

1692

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2374

gnutls.openpgp_crt_deinit(crt)

1693

2375

# Convert the buffer to a Python bytestring

1694

2376

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

1695

2377

# Convert the bytestring to hexadecimal notation

1699

2381

1700

2382

class MultiprocessingMixIn(object):

1701

2383

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

2384

1702

2385

def sub_process_main(self, request, address):

1703

2386

try:

1704

2387

self.finish_request(request, address)

1705

2388

except Exception:

1706

2389

self.handle_error(request, address)

1707

2390

self.close_request(request)

1708

2391

1709

2392

def process_request(self, request, address):

1710

2393

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

1711

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

1712

args = (request,

1713

address))

2394

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

2395

args=(request, address))

1714

2396

proc.start()

1715

2397

return proc

1716

2398

1717

2399

1718

2400

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1719

2401

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

2402

1720

2403

def process_request(self, request, client_address):

1721

2404

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

1722

2405

1723

2406

This function creates a new pipe in self.pipe

1724

2407

"""

1725

2408

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1726

2409

1727

2410

proc = MultiprocessingMixIn.process_request(self, request,

1728

2411

client_address)

1729

2412

self.child_pipe.close()

1730

2413

self.add_pipe(parent_pipe, proc)

1731

2414

1732

2415

def add_pipe(self, parent_pipe, proc):

1733

2416

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

1734

raise NotImplementedError

2417

raise NotImplementedError()

1735

2418

1736

2419

1737

2420

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1738

2421

socketserver.TCPServer, object):

1739

2422

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

1740

2423

1741

2424

Attributes:

1742

2425

enabled: Boolean; whether this server is activated yet

1743

2426

interface: None or a network interface name (string)

1744

2427

use_ipv6: Boolean; to use IPv6 or not

1745

2428

"""

2429

1746

2430

def __init__(self, server_address, RequestHandlerClass,

1747

interface=None, use_ipv6=True):

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

"""

1748

2437

self.interface = interface

1749

2438

if use_ipv6:

1750

2439

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.

1751

2467

socketserver.TCPServer.__init__(self, server_address,

1752

2468

RequestHandlerClass)

2469

1753

2470

def server_bind(self):

1754

2471

"""This overrides the normal server_bind() function

1755

2472

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

1756

2473

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

2474

global SO_BINDTODEVICE

1757

2475

if self.interface is not None:

1758

2476

if SO_BINDTODEVICE is None:

1759

logger.error("SO_BINDTODEVICE does not exist;"

1760

" cannot bind to interface %s",

1761

self.interface)

1762

else:

1763

try:

1764

self.socket.setsockopt(socket.SOL_SOCKET,

1765

SO_BINDTODEVICE,

1766

str(self.interface

1767

+ '\0'))

1768

except socket.error as error:

1769

if error[0] == errno.EPERM:

1770

logger.error("No permission to"

1771

" bind to interface %s",

1772

self.interface)

1773

elif error[0] == errno.ENOPROTOOPT:

1774

logger.error("SO_BINDTODEVICE not available;"

1775

" cannot bind to interface %s",

1776

self.interface)

1777

else:

1778

raise

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

1779

2498

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

1780

2499

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

1781

2500

if not self.server_address[0]:

1782

2501

if self.address_family == socket.AF_INET6:

1783

any_address = "::" # in6addr_any

2502

any_address = "::" # in6addr_any

1784

2503

else:

1785

any_address = socket.INADDR_ANY

2504

any_address = "0.0.0.0" # INADDR_ANY

1786

2505

self.server_address = (any_address,

1787

2506

self.server_address[1])

1788

2507

elif not self.server_address[1]:

1789

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

1790

0)

2508

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

1791

2509

# if self.interface:

1792

2510

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

1793

2511

# 0, # port

1799

2517

1800

2518

class MandosServer(IPv6_TCPServer):

1801

2519

"""Mandos server.

1802

2520

1803

2521

Attributes:

1804

2522

clients: set of Client objects

1805

2523

gnutls_priority GnuTLS priority string

1806

2524

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

1807

1808

Assumes a gobject.MainLoop event loop.

2525

2526

Assumes a GLib.MainLoop event loop.

1809

2527

"""

2528

1810

2529

def __init__(self, server_address, RequestHandlerClass,

1811

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

1812

gnutls_priority=None, use_dbus=True):

2530

interface=None,

2531

use_ipv6=True,

2532

clients=None,

2533

gnutls_priority=None,

2534

use_dbus=True,

2535

socketfd=None):

1813

2536

self.enabled = False

1814

2537

self.clients = clients

1815

2538

if self.clients is None:

1818

2541

self.gnutls_priority = gnutls_priority

1819

2542

IPv6_TCPServer.__init__(self, server_address,

1820

2543

RequestHandlerClass,

1821

interface = interface,

1822

use_ipv6 = use_ipv6)

2544

interface=interface,

2545

use_ipv6=use_ipv6,

2546

socketfd=socketfd)

2547

1823

2548

def server_activate(self):

1824

2549

if self.enabled:

1825

2550

return socketserver.TCPServer.server_activate(self)

1826

2551

1827

2552

def enable(self):

1828

2553

self.enabled = True

1829

2554

1830

2555

def add_pipe(self, parent_pipe, proc):

1831

2556

# Call "handle_ipc" for both data and EOF events

1832

gobject.io_add_watch(parent_pipe.fileno(),

1833

gobject.IO_IN | gobject.IO_HUP,

1834

functools.partial(self.handle_ipc,

1835

parent_pipe =

1836

parent_pipe,

1837

proc = proc))

1838

1839

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

1840

proc = None, client_object=None):

1841

condition_names = {

1842

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

1843

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

1844

# blocking).

1845

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

1846

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

1847

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

1848

# broken, usually for pipes and

1849

# sockets).

1850

}

1851

conditions_string = ' | '.join(name

1852

for cond, name in

1853

condition_names.iteritems()

1854

if cond & condition)

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

1855

2568

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

1856

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

2569

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

1857

2570

# Wait for other process to exit

1858

2571

proc.join()

1859

2572

return False

1860

2573

1861

2574

# Read a request from the child

1862

2575

request = parent_pipe.recv()

1863

2576

command = request[0]

1864

2577

1865

2578

if command == 'init':

1866

2579

fpr = request[1]

1867

2580

address = request[2]

1868

1869

for c in self.clients.itervalues():

2581

2582

for c in self.clients.values():

1870

2583

if c.fingerprint == fpr:

1871

2584

client = c

1872

2585

break

1879

2592

address[0])

1880

2593

parent_pipe.send(False)

1881

2594

return False

1882

1883

gobject.io_add_watch(parent_pipe.fileno(),

1884

gobject.IO_IN | gobject.IO_HUP,

1885

functools.partial(self.handle_ipc,

1886

parent_pipe =

1887

parent_pipe,

1888

proc = proc,

1889

client_object =

1890

client))

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

1891

2603

parent_pipe.send(True)

1892

2604

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

1893

2605

# same fileno

1896

2608

funcname = request[1]

1897

2609

args = request[2]

1898

2610

kwargs = request[3]

1899

2611

1900

2612

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

1901

2613

funcname)(*args,

1902

**kwargs)))

1903

2614

**kwargs)))

2615

1904

2616

if command == 'getattr':

1905

2617

attrname = request[1]

1906

if callable(client_object.__getattribute__(attrname)):

1907

parent_pipe.send(('function',))

2618

if isinstance(client_object.__getattribute__(attrname),

2619

collections.Callable):

2620

parent_pipe.send(('function', ))

1908

2621

else:

1909

parent_pipe.send(('data', client_object

1910

.__getattribute__(attrname)))

1911

2622

parent_pipe.send((

2623

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

2624

1912

2625

if command == 'setattr':

1913

2626

attrname = request[1]

1914

2627

value = request[2]

1915

2628

setattr(client_object, attrname, value)

1916

2629

1917

2630

return True

1918

2631

1919

2632

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

1920

2732

def string_to_delta(interval):

1921

2733

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

1922

2734

1923

2735

>>> string_to_delta('7d')

1924

2736

datetime.timedelta(7)

1925

2737

>>> string_to_delta('60s')

1933

2745

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

1934

2746

datetime.timedelta(0, 330)

1935

2747

"""

2748

2749

try:

2750

return rfc3339_duration_to_delta(interval)

2751

except ValueError:

2752

pass

2753

1936

2754

timevalue = datetime.timedelta(0)

1937

2755

for s in interval.split():

1938

2756

try:

1939

suffix = unicode(s[-1])

2757

suffix = s[-1]

1940

2758

value = int(s[:-1])

1941

2759

if suffix == "d":

1942

2760

delta = datetime.timedelta(value)

1949

2767

elif suffix == "w":

1950

2768

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

1951

2769

else:

1952

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

1953

except (ValueError, IndexError) as e:

2770

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

2771

except IndexError as e:

1954

2772

raise ValueError(*(e.args))

1955

2773

timevalue += delta

1956

2774

return timevalue

1957

2775

1958

2776

1959

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

2777

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

1960

2778

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

1961

2779

1962

2780

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

1963

2781

if os.fork():

1964

2782

sys.exit()

1969

2787

sys.exit()

1970

2788

if not noclose:

1971

2789

# Close all standard open file descriptors

1972

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

2790

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

1973

2791

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

1974

2792

raise OSError(errno.ENODEV,

1975

"%s not a character device"

1976

% os.path.devnull)

2793

"{} not a character device"

2794

.format(os.devnull))

1977

2795

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

1978

2796

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

1979

2797

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

1982

2800

1983

2801

1984

2802

def main():

1985

2803

1986

2804

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

1987

2805

# Parsing of options, both command line and config file

1988

2806

1989

2807

parser = argparse.ArgumentParser()

1990

2808

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

1991

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

2809

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

1992

2810

help="show version number and exit")

1993

2811

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

1994

2812

help="Bind to interface IF")

2000

2818

help="Run self-test")

2001

2819

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

2002

2820

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

2003

" to terminal")

2821

" to terminal", default=None)

2004

2822

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

2005

2823

help="Debug level for stdout output")

2006

2824

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

2013

2831

" files")

2014

2832

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

2015

2833

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

2016

" system bus interface")

2834

" system bus interface", default=None)

2017

2835

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

2018

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

2836

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

2837

default=None)

2019

2838

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

2020

2839

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

2021

" state")

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

2022

2844

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

2023

2845

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

2024

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

2025

2852

options = parser.parse_args()

2026

2853

2027

2854

if options.check:

2028

2855

import doctest

2029

doctest.testmod()

2030

sys.exit()

2031

2856

fail_count, test_count = doctest.testmod()

2857

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

2858

2032

2859

# Default values for config file for server-global settings

2033

server_defaults = { "interface": "",

2034

"address": "",

2035

"port": "",

2036

"debug": "False",

2037

"priority":

2038

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

2039

"servicename": "Mandos",

2040

"use_dbus": "True",

2041

"use_ipv6": "True",

2042

"debuglevel": "",

2043

"restore": "True",

2044

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

2045

}

2046

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

2047

2878

# Parse config file for server-global settings

2048

2879

server_config = configparser.SafeConfigParser(server_defaults)

2049

2880

del server_defaults

2050

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

2051

"mandos.conf"))

2881

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

2052

2882

# Convert the SafeConfigParser object to a dict

2053

2883

server_settings = server_config.defaults()

2054

2884

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

2055

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

2885

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

2056

2886

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

2057

2887

option)

2058

2888

if server_settings["port"]:

2059

2889

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

2060

2890

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

2061

2900

del server_config

2062

2901

2063

2902

# Override the settings from the config file with command line

2064

2903

# options, if set.

2065

2904

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

2066

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

2067

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

2068

"statedir"):

2905

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

2906

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

2907

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

2069

2908

value = getattr(options, option)

2070

2909

if value is not None:

2071

2910

server_settings[option] = value

2072

2911

del options

2073

2912

# Force all strings to be unicode

2074

2913

for option in server_settings.keys():

2075

if type(server_settings[option]) is str:

2076

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

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

2077

2924

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

2078

2925

2079

2926

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

2080

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

2081

2933

# For convenience

2082

2934

debug = server_settings["debug"]

2083

2935

debuglevel = server_settings["debuglevel"]

2085

2937

use_ipv6 = server_settings["use_ipv6"]

2086

2938

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

2087

2939

stored_state_file)

2088

2940

foreground = server_settings["foreground"]

2941

zeroconf = server_settings["zeroconf"]

2942

2089

2943

if debug:

2090

2944

initlogger(debug, logging.DEBUG)

2091

2945

else:

2094

2948

else:

2095

2949

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

2096

2950

initlogger(debug, level)

2097

2951

2098

2952

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

2099

syslogger.setFormatter(logging.Formatter

2100

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

2101

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

2102

% server_settings["servicename"]))

2103

2953

syslogger.setFormatter(

2954

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

2955

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

2956

server_settings["servicename"])))

2957

2104

2958

# Parse config file with clients

2105

2959

client_config = configparser.SafeConfigParser(Client

2106

2960

.client_defaults)

2107

2961

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

2108

2962

"clients.conf"))

2109

2963

2110

2964

global mandos_dbus_service

2111

2965

mandos_dbus_service = None

2112

2113

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

2114

server_settings["port"]),

2115

ClientHandler,

2116

interface=(server_settings["interface"]

2117

or None),

2118

use_ipv6=use_ipv6,

2119

gnutls_priority=

2120

server_settings["priority"],

2121

use_dbus=use_dbus)

2122

if not debug:

2123

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

2124

try:

2125

pidfile = open(pidfilename, "w")

2126

except IOError:

2127

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

2128

2129

try:

2130

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

2131

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

2132

except KeyError:

2133

try:

2134

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

2135

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

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

2136

2996

except KeyError:

2137

try:

2138

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

2139

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

2140

except KeyError:

2141

uid = 65534

2142

gid = 65534

2997

continue

2998

else:

2999

uid = 65534

3000

gid = 65534

2143

3001

try:

2144

3002

os.setgid(gid)

2145

3003

os.setuid(uid)

3004

if debug:

3005

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

3006

gid))

2146

3007

except OSError as error:

2147

if error[0] != errno.EPERM:

2148

raise error

2149

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

2150

3013

if debug:

2151

3014

# Enable all possible GnuTLS debugging

2152

3015

2153

3016

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

2154

3017

# - GnuTLS manual

2155

gnutls.library.functions.gnutls_global_set_log_level(11)

2156

2157

@gnutls.library.types.gnutls_log_func

3018

gnutls.global_set_log_level(11)

3019

3020

@gnutls.log_func

2158

3021

def debug_gnutls(level, string):

2159

3022

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

2160

2161

(gnutls.library.functions

2162

.gnutls_global_set_log_function(debug_gnutls))

2163

3023

3024

gnutls.global_set_log_function(debug_gnutls)

3025

2164

3026

# Redirect stdin so all checkers get /dev/null

2165

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

3027

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

2166

3028

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

2167

3029

if null > 2:

2168

3030

os.close(null)

2169

3031

2170

3032

# Need to fork before connecting to D-Bus

2171

if not debug:

3033

if not foreground:

2172

3034

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

2173

3035

daemon()

2174

2175

gobject.threads_init()

2176

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

2177

3041

global main_loop

2178

3042

# From the Avahi example code

2179

DBusGMainLoop(set_as_default=True )

2180

main_loop = gobject.MainLoop()

3043

DBusGMainLoop(set_as_default=True)

3044

main_loop = GLib.MainLoop()

2181

3045

bus = dbus.SystemBus()

2182

3046

# End of Avahi example code

2183

3047

if use_dbus:

2184

3048

try:

2185

3049

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

2186

bus, do_not_queue=True)

2187

old_bus_name = (dbus.service.BusName

2188

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

2189

do_not_queue=True))

2190

except dbus.exceptions.NameExistsException as e:

2191

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

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)

2192

3057

use_dbus = False

2193

3058

server_settings["use_dbus"] = False

2194

3059

tcp_server.use_dbus = False

2195

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2196

service = AvahiServiceToSyslog(name =

2197

server_settings["servicename"],

2198

servicetype = "_mandos._tcp",

2199

protocol = protocol, bus = bus)

2200

if server_settings["interface"]:

2201

service.interface = (if_nametoindex

2202

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

2203

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

2204

3071

global multiprocessing_manager

2205

3072

multiprocessing_manager = multiprocessing.Manager()

2206

3073

2207

3074

client_class = Client

2208

3075

if use_dbus:

2209

client_class = functools.partial(ClientDBusTransitional,

2210

bus = bus)

2211

3076

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

3077

2212

3078

client_settings = Client.config_parser(client_config)

2213

3079

old_client_settings = {}

2214

3080

clients_data = {}

2215

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

2216

3090

# Get client data and settings from last running state.

2217

3091

if server_settings["restore"]:

2218

3092

try:

2219

3093

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

2220

clients_data, old_client_settings = (pickle.load

2221

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

2222

3139

os.remove(stored_state_path)

2223

3140

except IOError as e:

2224

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

2225

.format(e))

2226

if e.errno != errno.ENOENT:

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)

2227

3147

raise

2228

3148

except EOFError as e:

2229

3149

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

2230

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

2231

3150

"EOFError:",

3151

exc_info=e)

3152

2232

3153

with PGPEngine() as pgp:

2233

for client_name, client in clients_data.iteritems():

3154

for client_name, client in clients_data.items():

3155

# Skip removed clients

3156

if client_name not in client_settings:

3157

continue

3158

2234

3159

# Decide which value to use after restoring saved state.

2235

3160

# We have three different values: Old config file,

2236

3161

# new config file, and saved state.

2241

3166

# For each value in new config, check if it

2242

3167

# differs from the old config value (Except for

2243

3168

# the "secret" attribute)

2244

if (name != "secret" and

2245

value != old_client_settings[client_name]

2246

[name]):

3169

if (name != "secret"

3170

and (value !=

3171

old_client_settings[client_name][name])):

2247

3172

client[name] = value

2248

3173

except KeyError:

2249

3174

pass

2250

3175

2251

3176

# Clients who has passed its expire date can still be

2252

# enabled if its last checker was successful. Clients

2253

# whose checker failed before we stored its state is

2254

# assumed to have failed all checkers during downtime.

3177

# enabled if its last checker was successful. A Client

3178

# whose checker succeeded before we stored its state is

3179

# assumed to have successfully run all checkers during

3180

# downtime.

2255

3181

if client["enabled"]:

2256

3182

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

2257

3183

if not client["last_checked_ok"]:

2258

3184

logger.warning(

2259

"disabling client {0} - Client never "

2260

"performed a successfull checker"

2261

.format(client["name"]))

3185

"disabling client {} - Client never "

3186

"performed a successful checker".format(

3187

client_name))

2262

3188

client["enabled"] = False

2263

3189

elif client["last_checker_status"] != 0:

2264

3190

logger.warning(

2265

"disabling client {0} - Client "

2266

"last checker failed with error code {1}"

2267

.format(client["name"],

2268

client["last_checker_status"]))

3191

"disabling client {} - Client last"

3192

" checker failed with error code"

3193

" {}".format(

3194

client_name,

3195

client["last_checker_status"]))

2269

3196

client["enabled"] = False

2270

3197

else:

2271

client["expires"] = (datetime.datetime

2272

.utcnow()

2273

+ client["timeout"])

3198

client["expires"] = (

3199

datetime.datetime.utcnow()

3200

+ client["timeout"])

2274

3201

logger.debug("Last checker succeeded,"

2275

" keeping {0} enabled"

2276

.format(client["name"]))

3202

" keeping {} enabled".format(

3203

client_name))

2277

3204

try:

2278

client["secret"] = (

2279

pgp.decrypt(client["encrypted_secret"],

2280

client_settings[client_name]

2281

["secret"]))

3205

client["secret"] = pgp.decrypt(

3206

client["encrypted_secret"],

3207

client_settings[client_name]["secret"])

2282

3208

except PGPError:

2283

3209

# If decryption fails, we use secret from new settings

2284

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

2285

.format(client_name))

2286

client["secret"] = (

2287

client_settings[client_name]["secret"])

3210

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

3211

client_name))

3212

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

3213

["secret"])

2288

3214

2289

2290

3215

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

2291

3216

for client_name in (set(old_client_settings)

2292

3217

- set(client_settings)):

2295

3220

- set(old_client_settings)):

2296

3221

clients_data[client_name] = client_settings[client_name]

2297

3222

2298

# Create clients all clients

2299

for client_name, client in clients_data.iteritems():

3223

# Create all client objects

3224

for client_name, client in clients_data.items():

2300

3225

tcp_server.clients[client_name] = client_class(

2301

name = client_name, settings = client)

2302

3226

name=client_name,

3227

settings=client,

3228

server_settings=server_settings)

3229

2303

3230

if not tcp_server.clients:

2304

3231

logger.warning("No clients defined")

2305

2306

if not debug:

2307

try:

2308

with pidfile:

2309

pid = os.getpid()

2310

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

2311

del pidfile

2312

except IOError:

2313

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

2314

pidfilename, pid)

2315

except NameError:

2316

# "pidfile" was never created

2317

pass

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

2318

3243

del pidfilename

2319

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

2320

2321

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

2322

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

2323

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

2324

3249

if use_dbus:

2325

class MandosDBusService(dbus.service.Object):

3250

3251

@alternate_dbus_interfaces(

3252

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

3253

class MandosDBusService(DBusObjectWithObjectManager):

2326

3254

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

3255

2327

3256

def __init__(self):

2328

3257

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

3258

2329

3259

_interface = "se.recompile.Mandos"

2330

3260

2331

3261

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

2332

3262

def ClientAdded(self, objpath):

2333

3263

"D-Bus signal"

2334

3264

pass

2335

3265

2336

3266

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

2337

3267

def ClientNotFound(self, fingerprint, address):

2338

3268

"D-Bus signal"

2339

3269

pass

2340

3270

3271

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

3272

"true"})

2341

3273

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

2342

3274

def ClientRemoved(self, objpath, name):

2343

3275

"D-Bus signal"

2344

3276

pass

2345

3277

3278

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

3279

"true"})

2346

3280

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

2347

3281

def GetAllClients(self):

2348

3282

"D-Bus method"

2349

return dbus.Array(c.dbus_object_path

2350

for c in

2351

tcp_server.clients.itervalues())

2352

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

2353

3288

@dbus.service.method(_interface,

2354

3289

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

2355

3290

def GetAllClientsWithProperties(self):

2356

3291

"D-Bus method"

2357

3292

return dbus.Dictionary(

2358

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

2359

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

3293

{c.dbus_object_path: c.GetAll(

3294

"se.recompile.Mandos.Client")

3295

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

2360

3296

signature="oa{sv}")

2361

3297

2362

3298

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

2363

3299

def RemoveClient(self, object_path):

2364

3300

"D-Bus method"

2365

for c in tcp_server.clients.itervalues():

3301

for c in tcp_server.clients.values():

2366

3302

if c.dbus_object_path == object_path:

2367

3303

del tcp_server.clients[c.name]

2368

3304

c.remove_from_connection()

2369

# Don't signal anything except ClientRemoved

3305

# Don't signal the disabling

2370

3306

c.disable(quiet=True)

2371

# Emit D-Bus signal

2372

self.ClientRemoved(object_path, c.name)

3307

# Emit D-Bus signal for removal

3308

self.client_removed_signal(c)

2373

3309

return

2374

3310

raise KeyError(object_path)

2375

3311

2376

3312

del _interface

2377

2378

class MandosDBusServiceTransitional(MandosDBusService):

2379

__metaclass__ = AlternateDBusNamesMetaclass

2380

mandos_dbus_service = MandosDBusServiceTransitional()

2381

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

2382

3357

def cleanup():

2383

3358

"Cleanup function; run on exit"

2384

service.cleanup()

2385

2386

multiprocessing.active_children()

3359

if zeroconf:

3360

service.cleanup()

3361

3362

mp.active_children()

3363

wn.close()

2387

3364

if not (tcp_server.clients or client_settings):

2388

3365

return

2389

3366

2390

3367

# Store client before exiting. Secrets are encrypted with key

2391

3368

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

2392

3369

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

2393

3370

clients = {}

2394

3371

with PGPEngine() as pgp:

2395

for client in tcp_server.clients.itervalues():

3372

for client in tcp_server.clients.values():

2396

3373

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

2397

3374

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

2398

3375

key)

2399

3376

client_dict = {}

2400

3377

2401

3378

# A list of attributes that can not be pickled

2402

3379

# + secret.

2403

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

2404

"checker"))

2405

for name, typ in (inspect.getmembers

2406

(dbus.service.Object)):

3380

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

3381

"checker", "server_settings"}

3382

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

3383

.Object):

2407

3384

exclude.add(name)

2408

3385

2409

3386

client_dict["encrypted_secret"] = (client

2410

3387

.encrypted_secret)

2411

3388

for attr in client.client_structure:

2412

3389

if attr not in exclude:

2413

3390

client_dict[attr] = getattr(client, attr)

2414

3391

2415

3392

clients[client.name] = client_dict

2416

3393

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

2417

3394

2418

3395

try:

2419

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

2420

prefix="clients-",

2421

dir=os.path.dirname

2422

(stored_state_path))

2423

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

2424

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

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

2425

3405

os.rename(tempname, stored_state_path)

2426

3406

except (IOError, OSError) as e:

2427

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

2428

.format(e))

2429

3407

if not debug:

2430

3408

try:

2431

3409

os.remove(tempname)

2432

3410

except NameError:

2433

3411

pass

2434

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

2435

errno.EEXIST)):

2436

raise e

2437

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

2438

3420

# Delete all clients, and settings from config

2439

3421

while tcp_server.clients:

2440

3422

name, client = tcp_server.clients.popitem()

2441

3423

if use_dbus:

2442

3424

client.remove_from_connection()

2443

# Don't signal anything except ClientRemoved

3425

# Don't signal the disabling

2444

3426

client.disable(quiet=True)

3427

# Emit D-Bus signal for removal

2445

3428

if use_dbus:

2446

# Emit D-Bus signal

2447

mandos_dbus_service.ClientRemoved(client

2448

.dbus_object_path,

2449

client.name)

3429

mandos_dbus_service.client_removed_signal(client)

2450

3430

client_settings.clear()

2451

3431

2452

3432

atexit.register(cleanup)

2453

2454

for client in tcp_server.clients.itervalues():

3433

3434

for client in tcp_server.clients.values():

2455

3435

if use_dbus:

2456

# Emit D-Bus signal

2457

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3436

# Emit D-Bus signal for adding

3437

mandos_dbus_service.client_added_signal(client)

2458

3438

# Need to initiate checking of clients

2459

3439

if client.enabled:

2460

3440

client.init_checker()

2461

3441

2462

3442

tcp_server.enable()

2463

3443

tcp_server.server_activate()

2464

3444

2465

3445

# Find out what port we got

2466

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

3446

if zeroconf:

3447

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

2467

3448

if use_ipv6:

2468

3449

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

2469

" flowinfo %d, scope_id %d"

2470

% tcp_server.socket.getsockname())

3450

" flowinfo %d, scope_id %d",

3451

*tcp_server.socket.getsockname())

2471

3452

else: # IPv4

2472

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

2473

% tcp_server.socket.getsockname())

2474

2475

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

2476

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

2477

3458

try:

2478

# From the Avahi example code

2479

try:

2480

service.activate()

2481

except dbus.exceptions.DBusException as error:

2482

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

2483

cleanup()

2484

sys.exit(1)

2485

# End of Avahi example code

2486

2487

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

2488

lambda *args, **kwargs:

2489

(tcp_server.handle_request

2490

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

2491

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

2492

3474

logger.debug("Starting main loop")

2493

3475

main_loop.run()

2494

3476

except AvahiError as error:

2495

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

3477

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

2496

3478

cleanup()

2497

3479

sys.exit(1)

2498

3480

except KeyboardInterrupt:

2503

3485

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

2504

3486

cleanup()

2505

3487

3488

2506

3489

if __name__ == '__main__':

2507

3490

main()