/mandos/release : revision 292

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

14

15

16

#

17

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

18

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

19

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

23

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

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

# GNU General Public License for more details.

26

#

26

#

27

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

28

# along with this program. If not, see

29

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

30

#

30

#

31

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

32

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

37

import SocketServer as socketserver

46

38

import socket

47

39

import argparse

48

40

import datetime

49

41

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

54

49

import sys

55

50

import re

56

51

import os

65

60

import struct

66

61

import fcntl

67

62

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

63

import cPickle as pickle

72

64

import multiprocessing

73

65

import types

74

66

import binascii

75

67

import tempfile

76

import itertools

77

import collections

78

import codecs

79

68

80

69

import dbus

81

70

import dbus.service

82

from gi.repository import GLib

71

import gobject

72

import avahi

83

73

from dbus.mainloop.glib import DBusGMainLoop

84

74

import ctypes

85

75

import ctypes.util

86

76

import xml.dom.minidom

87

77

import inspect

78

import GnuPGInterface

88

79

89

# Try to find the value of SO_BINDTODEVICE:

90

80

try:

91

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

92

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

93

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

82

except AttributeError:

95

83

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

84

from IN import SO_BINDTODEVICE

99

85

except ImportError:

100

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

101

# Try running the C preprocessor:

102

try:

103

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

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

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

109

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

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.13"

86

SO_BINDTODEVICE = None

87

88

version = "1.5.0"

118

89

stored_state_file = "clients.pickle"

119

90

120

91

logger = logging.getLogger()

121

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

122

95

123

96

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

126

100

except (OSError, AttributeError):

127

128

101

def if_nametoindex(interface):

129

102

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

130

103

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

131

104

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

132

105

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

133

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

134

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

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

135

110

return interface_index

136

111

137

112

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

154

113

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

155

114

"""init logger and add loglevel"""

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

160

address="/dev/log"))

115

161

116

syslogger.setFormatter(logging.Formatter

162

117

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

163

118

' %(message)s'))

164

119

logger.addHandler(syslogger)

165

120

166

121

if debug:

167

122

console = logging.StreamHandler()

168

123

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

180

135

181

136

class PGPEngine(object):

182

137

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

183

184

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

185

140

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

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

'--force-mdc',

200

'--quiet']

201

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

202

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

203

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

204

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

205

148

def __enter__(self):

206

149

return self

207

208

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

150

151

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

209

152

self._cleanup()

210

153

return False

211

154

212

155

def __del__(self):

213

156

self._cleanup()

214

157

215

158

def _cleanup(self):

216

159

if self.tempdir is not None:

217

160

# Delete contents of tempdir

218

161

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

219

topdown=False):

162

topdown = False):

220

163

for filename in files:

221

164

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

222

165

for dirname in dirs:

224

167

# Remove tempdir

225

168

os.rmdir(self.tempdir)

226

169

self.tempdir = None

227

170

228

171

def password_encode(self, password):

229

172

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

230

173

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

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

238

174

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

175

239

176

def encrypt(self, data, password):

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin=subprocess.PIPE,

250

stdout=subprocess.PIPE,

251

stderr=subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

raise PGPError(err)

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

255

191

return ciphertext

256

192

257

193

def decrypt(self, data, password):

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir=self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin=subprocess.PIPE,

268

stdout=subprocess.PIPE,

269

stderr=subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

raise PGPError(err)

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

273

208

return decrypted_plaintext

274

209

275

210

276

# Pretend that we have an Avahi module

277

class Avahi(object):

278

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

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

def string_array_to_txt_array(self, t):

290

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

291

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

292

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

293

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

294

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

295

SERVER_INVALID = 0 # avahi-common/defs.h

296

SERVER_REGISTERING = 1 # avahi-common/defs.h

297

SERVER_RUNNING = 2 # avahi-common/defs.h

298

SERVER_COLLISION = 3 # avahi-common/defs.h

299

SERVER_FAILURE = 4 # avahi-common/defs.h

300

avahi = Avahi()

301

302

211

303

212

class AvahiError(Exception):

304

213

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

305

214

self.value = value

306

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

307

**kwargs)

308

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

309

218

310

219

class AvahiServiceError(AvahiError):

311

220

pass

312

221

313

314

222

class AvahiGroupError(AvahiError):

315

223

pass

316

224

317

225

318

226

class AvahiService(object):

319

227

"""An Avahi (Zeroconf) service.

320

228

321

229

Attributes:

322

230

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

323

231

Used to optionally bind to the specified interface.

324

232

name: string; Example: 'Mandos'

325

233

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

326

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

234

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

327

235

port: integer; what port to announce

328

236

TXT: list of strings; TXT record for the service

329

237

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

335

243

server: D-Bus Server

336

244

bus: dbus.SystemBus()

337

245

"""

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

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

350

250

self.interface = interface

351

251

self.name = name

352

252

self.type = servicetype

361

261

self.server = None

362

262

self.bus = bus

363

263

self.entry_group_state_changed_match = None

364

365

def rename(self, remove=True):

264

def rename(self):

366

265

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

367

266

if self.rename_count >= self.max_renames:

368

267

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

369

268

" after %i retries, exiting.",

370

269

self.rename_count)

371

270

raise AvahiServiceError("Too many renames")

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

375

273

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

376

274

self.name)

377

if remove:

378

self.remove()

275

self.remove()

379

276

try:

380

277

self.add()

381

278

except dbus.exceptions.DBusException as error:

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

391

283

def remove(self):

392

284

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

393

285

if self.entry_group_state_changed_match is not None:

395

287

self.entry_group_state_changed_match = None

396

288

if self.group is not None:

397

289

self.group.Reset()

398

399

290

def add(self):

400

291

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

401

292

self.remove()

418

309

dbus.UInt16(self.port),

419

310

avahi.string_array_to_txt_array(self.TXT))

420

311

self.group.Commit()

421

422

312

def entry_group_state_changed(self, state, error):

423

313

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

424

314

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

425

315

426

316

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

317

logger.debug("Zeroconf service established.")

428

318

elif state == avahi.ENTRY_GROUP_COLLISION:

430

320

self.rename()

431

321

elif state == avahi.ENTRY_GROUP_FAILURE:

432

322

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

433

str(error))

434

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

435

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

436

326

def cleanup(self):

437

327

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

438

328

if self.group is not None:

443

333

pass

444

334

self.group = None

445

335

self.remove()

446

447

336

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

448

337

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

449

338

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

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

456

346

if state in bad_states:

457

347

if bad_states[state] is not None:

458

348

if error is None:

461

351

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

462

352

self.cleanup()

463

353

elif state == avahi.SERVER_RUNNING:

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

354

self.add()

476

355

else:

477

356

if error is None:

478

357

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

479

358

else:

480

359

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

481

482

360

def activate(self):

483

361

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

484

362

if self.server is None:

488

366

follow_name_owner_changes=True),

489

367

avahi.DBUS_INTERFACE_SERVER)

490

368

self.server.connect_to_signal("StateChanged",

491

self.server_state_changed)

369

self.server_state_changed)

492

370

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

493

371

494

495

372

class AvahiServiceToSyslog(AvahiService):

496

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

373

def rename(self):

497

374

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

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

502

380

return ret

503

381

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

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

779

388

class Client(object):

780

389

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

781

390

782

391

Attributes:

783

392

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

784

393

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

786

395

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

787

396

to see if the client lives.

788

397

'None' if no process is running.

789

checker_callback_tag: a GLib event source tag, or None

398

checker_callback_tag: a gobject event source tag, or None

790

399

checker_command: string; External command which is run to check

791

400

if client lives. %() expansions are done at

792

401

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

793

402

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

794

checker_initiator_tag: a GLib event source tag, or None

403

checker_initiator_tag: a gobject event source tag, or None

795

404

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

796

405

client_structure: Object describing what attributes a client has

797

406

and is used for storing the client at exit

798

407

current_checker_command: string; current running checker_command

799

disable_initiator_tag: a GLib event source tag, or None

408

disable_initiator_tag: a gobject event source tag, or None

800

409

enabled: bool()

801

410

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

802

411

uniquely identify the client

806

415

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

807

416

last_checker_status: integer between 0 and 255 reflecting exit

808

417

status of last checker. -1 reflects crashed

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

418

checker, or None.

812

419

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

813

420

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

814

421

D-Bus identifiers

815

422

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

816

423

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

817

424

until this client is disabled

818

extended_timeout: extra long timeout when secret has been sent

425

extended_timeout: extra long timeout when password has been sent

819

426

runtime_expansions: Allowed attributes for runtime expansion.

820

427

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

821

428

disabled, or None

822

server_settings: The server_settings dict from main()

823

429

"""

824

430

825

431

runtime_expansions = ("approval_delay", "approval_duration",

826

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

827

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

828

"last_approval_request", "last_checked_ok",

432

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

433

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

829

434

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

830

client_defaults = {

831

"timeout": "PT5M",

832

"extended_timeout": "PT15M",

833

"interval": "PT2M",

834

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

835

"host": "",

836

"approval_delay": "PT0S",

837

"approval_duration": "PT1S",

838

"approved_by_default": "True",

839

"enabled": "True",

840

}

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)

841

460

842

461

@staticmethod

843

462

def config_parser(config):

851

470

for client_name in config.sections():

852

471

section = dict(config.items(client_name))

853

472

client = settings[client_name] = {}

854

473

855

474

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

856

475

# Reformat values from string types to Python types

857

476

client["approved_by_default"] = config.getboolean(

858

477

client_name, "approved_by_default")

859

478

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

860

479

"enabled")

861

862

# Uppercase and remove spaces from fingerprint for later

863

# comparison purposes with return value from the

864

# fingerprint() function

480

865

481

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

866

482

.replace(" ", ""))

867

483

if "secret" in section:

868

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

869

.encode("utf-8"),

870

"base64")

484

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

871

485

elif "secfile" in section:

872

486

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

873

487

(section["secfile"])),

874

488

"rb") as secfile:

875

489

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

876

490

else:

877

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

878

.format(section))

491

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

492

% section)

879

493

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

880

494

client["extended_timeout"] = string_to_delta(

881

495

section["extended_timeout"])

887

501

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

888

502

client["last_approval_request"] = None

889

503

client["last_checked_ok"] = None

890

client["last_checker_status"] = -2

891

504

client["last_checker_status"] = None

505

892

506

return settings

893

894

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

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

895

513

self.name = name

896

if server_settings is None:

897

server_settings = {}

898

self.server_settings = server_settings

899

514

# adding all client settings

900

for setting, value in settings.items():

515

for setting, value in settings.iteritems():

901

516

setattr(self, setting, value)

902

517

903

518

if self.enabled:

904

519

if not hasattr(self, "last_enabled"):

905

520

self.last_enabled = datetime.datetime.utcnow()

909

524

else:

910

525

self.last_enabled = None

911

526

self.expires = None

912

527

913

528

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

914

532

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

915

533

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

916

534

datetime.datetime.utcnow())

923

541

self.current_checker_command = None

924

542

self.approved = None

925

543

self.approvals_pending = 0

926

self.changedstate = multiprocessing_manager.Condition(

927

multiprocessing_manager.Lock())

928

self.client_structure = [attr

929

for attr in self.__dict__.keys()

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

930

549

if not attr.startswith("_")]

931

550

self.client_structure.append("client_structure")

932

933

for name, t in inspect.getmembers(

934

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

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

935

556

if not name.startswith("_"):

936

557

self.client_structure.append(name)

937

558

938

559

# Send notice to process children that client state has changed

939

560

def send_changedstate(self):

940

561

with self.changedstate:

941

562

self.changedstate.notify_all()

942

563

943

564

def enable(self):

944

565

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

945

566

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

946

567

# Already enabled

947

568

return

569

self.send_changedstate()

948

570

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

949

571

self.enabled = True

950

572

self.last_enabled = datetime.datetime.utcnow()

951

573

self.init_checker()

952

self.send_changedstate()

953

574

954

575

def disable(self, quiet=True):

955

576

"""Disable this client."""

956

577

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

957

578

return False

958

579

if not quiet:

580

self.send_changedstate()

581

if not quiet:

959

582

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

960

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

961

GLib.source_remove(self.disable_initiator_tag)

583

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

584

gobject.source_remove(self.disable_initiator_tag)

962

585

self.disable_initiator_tag = None

963

586

self.expires = None

964

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

965

GLib.source_remove(self.checker_initiator_tag)

587

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

588

gobject.source_remove(self.checker_initiator_tag)

966

589

self.checker_initiator_tag = None

967

590

self.stop_checker()

968

591

self.enabled = False

969

if not quiet:

970

self.send_changedstate()

971

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

592

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

972

593

return False

973

594

974

595

def __del__(self):

975

596

self.disable()

976

597

977

598

def init_checker(self):

978

599

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

979

600

# and every interval from then on.

980

if self.checker_initiator_tag is not None:

981

GLib.source_remove(self.checker_initiator_tag)

982

self.checker_initiator_tag = GLib.timeout_add(

983

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

984

self.start_checker)

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

985

604

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

986

if self.disable_initiator_tag is not None:

987

GLib.source_remove(self.disable_initiator_tag)

988

self.disable_initiator_tag = GLib.timeout_add(

989

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

990

608

# Also start a new checker *right now*.

991

609

self.start_checker()

992

993

def checker_callback(self, source, condition, connection,

994

command):

610

611

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

995

612

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

996

613

self.checker_callback_tag = None

997

614

self.checker = None

998

# Read return code from connection (see call_pipe)

999

returncode = connection.recv()

1000

connection.close()

1001

1002

if returncode >= 0:

1003

self.last_checker_status = returncode

1004

self.last_checker_signal = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1005

617

if self.last_checker_status == 0:

1006

618

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

1007

619

vars(self))

1008

620

self.checked_ok()

1009

621

else:

1010

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

622

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

623

vars(self))

1011

624

else:

1012

625

self.last_checker_status = -1

1013

self.last_checker_signal = -returncode

1014

626

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

1015

627

vars(self))

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

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

"""

1027

635

if timeout is None:

1028

636

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

1029

638

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = None

639

gobject.source_remove(self.disable_initiator_tag)

1032

640

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

1033

self.disable_initiator_tag = GLib.timeout_add(

1034

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1035

644

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

1036

645

1037

646

def need_approval(self):

1038

647

self.last_approval_request = datetime.datetime.utcnow()

1039

648

1040

649

def start_checker(self):

1041

650

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

1042

651

1043

652

If a checker already exists, leave it running and do

1044

653

nothing."""

1045

654

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

1046

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

1047

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

1048

# would inevitably timeout, since no checker would get a

1049

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

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

1050

659

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

1051

660

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

1052

661

# should be.

1053

1054

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

1055

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

1056

self.checker.join()

1057

self.checker = None

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)

1058

676

# Start a new checker if needed

1059

677

if self.checker is None:

1060

# Escape attributes for the shell

1061

escaped_attrs = {

1062

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

1063

for attr in self.runtime_expansions}

1064

678

try:

1065

command = self.checker_command % escaped_attrs

1066

except TypeError as error:

1067

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

1068

self.checker_command,

1069

exc_info=error)

1070

return True # Try again later

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

1071

697

self.current_checker_command = command

1072

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

1073

self.name)

1074

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

1075

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

1076

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

1077

# always replaced by /dev/null.)

1078

# The exception is when not debugging but nevertheless

1079

# running in the foreground; use the previously

1080

# created wnull.

1081

popen_args = {"close_fds": True,

1082

"shell": True,

1083

"cwd": "/"}

1084

if (not self.server_settings["debug"]

1085

and self.server_settings["foreground"]):

1086

popen_args.update({"stdout": wnull,

1087

"stderr": wnull})

1088

pipe = multiprocessing.Pipe(duplex=False)

1089

self.checker = multiprocessing.Process(

1090

target=call_pipe,

1091

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

1092

kwargs=popen_args)

1093

self.checker.start()

1094

self.checker_callback_tag = GLib.io_add_watch(

1095

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

1096

self.checker_callback, pipe[0], command)

1097

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

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

1098

722

return True

1099

723

1100

724

def stop_checker(self):

1101

725

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

1102

726

if self.checker_callback_tag:

1103

GLib.source_remove(self.checker_callback_tag)

727

gobject.source_remove(self.checker_callback_tag)

1104

728

self.checker_callback_tag = None

1105

729

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

1106

730

return

1107

731

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

1108

self.checker.terminate()

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

1109

740

self.checker = None

1110

741

1111

742

1112

def dbus_service_property(dbus_interface,

1113

signature="v",

1114

access="readwrite",

1115

byte_arrays=False):

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1116

745

"""Decorators for marking methods of a DBusObjectWithProperties to

1117

746

become properties on the D-Bus.

1118

747

1119

748

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

1120

749

and with one argument by "Set".

1121

750

1122

751

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

1123

752

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

1124

753

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

1127

756

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

1128

757

if byte_arrays and signature != "ay":

1129

758

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

1130

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

1131

759

" signature %r" % signature)

1132

760

def decorator(func):

1133

761

func._dbus_is_property = True

1134

762

func._dbus_interface = dbus_interface

1137

765

func._dbus_name = func.__name__

1138

766

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

1139

767

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

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

768

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

return func

1186

770

return decorator

1187

771

1188

772

1189

773

class DBusPropertyException(dbus.exceptions.DBusException):

1190

774

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

1191

775

"""

1192

pass

776

def __unicode__(self):

777

return unicode(str(self))

1193

778

1194

779

1195

780

class DBusPropertyAccessException(DBusPropertyException):

1204

789

pass

1205

790

1206

791

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

792

class DBusObjectWithProperties(dbus.service.Object):

1297

793

"""A D-Bus object with properties.

1298

794

1299

795

Classes inheriting from this can use the dbus_service_property

1300

796

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

1301

797

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

1302

798

"""

1303

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

1304

812

def _get_dbus_property(self, interface_name, property_name):

1305

813

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

1306

814

property with the specified name and interface.

1307

815

"""

1308

for cls in self.__class__.__mro__:

1309

for name, value in inspect.getmembers(

1310

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

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1311

819

if (value._dbus_name == property_name

1312

820

and value._dbus_interface == interface_name):

1313

821

return value.__get__(self)

1314

822

1315

823

# No such property

1316

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

1317

self.dbus_object_path, interface_name, property_name))

1318

1319

@classmethod

1320

def _get_all_interface_names(cls):

1321

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

1322

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

1323

"_dbus_interface", None)

1324

for x in (inspect.getmro(cls))

1325

for attr in dir(x))

1326

if name is not None)

1327

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

in_signature="ss",

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

1330

829

out_signature="v")

1331

830

def Get(self, interface_name, property_name):

1332

831

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

1338

837

if not hasattr(value, "variant_level"):

1339

838

return value

1340

839

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

1341

840

1342

841

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

1343

842

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

1344

843

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

1350

849

# The byte_arrays option is not supported yet on

1351

850

# signatures other than "ay".

1352

851

if prop._dbus_signature != "ay":

1353

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

1354

"'ay' signature {!r}"

1355

.format(prop._dbus_signature))

852

raise ValueError

1356

853

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

1357

854

for byte in value))

1358

855

prop(value)

1359

1360

@dbus.service.method(dbus.PROPERTIES_IFACE,

1361

in_signature="s",

856

857

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

1362

858

out_signature="a{sv}")

1363

859

def GetAll(self, interface_name):

1364

860

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

1365

861

standard.

1366

862

1367

863

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

1368

864

"""

1369

865

properties = {}

1370

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

866

for name, prop in self._get_all_dbus_properties():

1371

867

if (interface_name

1372

868

and interface_name != prop._dbus_interface):

1373

869

# Interface non-empty but did not match

1379

875

if not hasattr(value, "variant_level"):

1380

876

properties[name] = value

1381

877

continue

1382

properties[name] = type(value)(

1383

value, variant_level=value.variant_level + 1)

878

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

879

value.variant_level+1)

1384

880

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

1385

1386

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

1387

def PropertiesChanged(self, interface_name, changed_properties,

1388

invalidated_properties):

1389

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

1390

standard.

1391

"""

1392

pass

1393

881

1394

882

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1395

883

out_signature="s",

1396

884

path_keyword='object_path',

1397

885

connection_keyword='connection')

1398

886

def Introspect(self, object_path, connection):

1399

"""Overloading of standard D-Bus method.

1400

1401

Inserts property tags and interface annotation tags.

887

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

1402

888

"""

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

889

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

890

connection)

1406

891

try:

1407

892

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

1408

1409

893

def make_tag(document, name, prop):

1410

894

e = document.createElement("property")

1411

895

e.setAttribute("name", name)

1412

896

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

1413

897

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

1414

898

return e

1415

1416

899

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

1417

# Add property tags

1418

900

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

1419

901

for name, prop

1420

in self._get_all_dbus_things("property")

902

in self._get_all_dbus_properties()

1421

903

if prop._dbus_interface

1422

904

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

1423

905

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)

1440

906

# Add the names to the return values for the

1441

907

# "org.freedesktop.DBus.Properties" methods

1442

908

if (if_tag.getAttribute("name")

1457

923

except (AttributeError, xml.dom.DOMException,

1458

924

xml.parsers.expat.ExpatError) as error:

1459

925

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

1460

exc_info=error)

1461

return xmlstring

1462

1463

1464

try:

1465

dbus.OBJECT_MANAGER_IFACE

1466

except AttributeError:

1467

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

1468

1469

1470

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1471

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

1472

1473

Classes inheriting from this exposes the standard

1474

GetManagedObjects call and the InterfacesAdded and

1475

InterfacesRemoved signals on the standard

1476

"org.freedesktop.DBus.ObjectManager" interface.

1477

1478

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

1479

manually.

1480

"""

1481

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1482

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

1483

def GetManagedObjects(self):

1484

"""This function must be overridden"""

1485

raise NotImplementedError()

1486

1487

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1488

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

1489

def InterfacesAdded(self, object_path, interfaces_and_properties):

1490

pass

1491

1492

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

1493

def InterfacesRemoved(self, object_path, interfaces):

1494

pass

1495

1496

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1497

out_signature="s",

1498

path_keyword='object_path',

1499

connection_keyword='connection')

1500

def Introspect(self, object_path, connection):

1501

"""Overloading of standard D-Bus method.

1502

1503

Override return argument name of GetManagedObjects to be

1504

"objpath_interfaces_and_properties"

1505

"""

1506

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1507

object_path,

1508

connection)

1509

try:

1510

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

1511

1512

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

1513

# Fix argument name for the GetManagedObjects method

1514

if (if_tag.getAttribute("name")

1515

== dbus.OBJECT_MANAGER_IFACE):

1516

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

1517

if (cn.getAttribute("name")

1518

== "GetManagedObjects"):

1519

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

1520

if (arg.getAttribute("direction")

1521

== "out"):

1522

arg.setAttribute(

1523

"name",

1524

"objpath_interfaces"

1525

"_and_properties")

1526

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

1527

document.unlink()

1528

except (AttributeError, xml.dom.DOMException,

1529

xml.parsers.expat.ExpatError) as error:

1530

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

1531

exc_info=error)

1532

return xmlstring

1533

1534

1535

def datetime_to_dbus(dt, variant_level=0):

926

error)

927

return xmlstring

928

929

930

def datetime_to_dbus (dt, variant_level=0):

1536

931

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

1537

932

if dt is None:

1538

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

1539

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

1540

1541

1542

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1543

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

1544

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

1545

interface names according to the "alt_interface_names" mapping.

1546

Usage:

1547

1548

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

1549

"net.example.AlternateInterface"})

1550

class SampleDBusObject(dbus.service.Object):

1551

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

1552

def SampleDBusMethod():

1553

pass

1554

1555

The above "SampleDBusMethod" on "SampleDBusObject" will be

1556

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

1557

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

1558

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

1559

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

1560

1561

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

1562

(from DBusObjectWithProperties) and interfaces (from the

1563

dbus_interface_annotations decorator).

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.

1564

942

"""

1565

1566

def wrapper(cls):

1567

for orig_interface_name, alt_interface_name in (

1568

alt_interface_names.items()):

1569

attr = {}

1570

interface_names = set()

1571

# Go though all attributes of the class

1572

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

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

1573

950

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

1574

951

# with the wrong interface name

1575

952

if (not hasattr(attribute, "_dbus_interface")

1576

or not attribute._dbus_interface.startswith(

1577

orig_interface_name)):

953

or not attribute._dbus_interface

954

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

1578

955

continue

1579

956

# Create an alternate D-Bus interface name based on

1580

957

# the current name

1581

alt_interface = attribute._dbus_interface.replace(

1582

orig_interface_name, alt_interface_name)

1583

interface_names.add(alt_interface)

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1584

961

# Is this a D-Bus signal?

1585

962

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

1586

# Extract the original non-method undecorated

1587

# function by black magic

1588

if sys.version_info.major == 2:

1589

nonmethod_func = (dict(

963

# Extract the original non-method function by

964

# black magic

965

nonmethod_func = (dict(

1590

966

zip(attribute.func_code.co_freevars,

1591

attribute.__closure__))

1592

["func"].cell_contents)

1593

else:

1594

nonmethod_func = (dict(

1595

zip(attribute.__code__.co_freevars,

1596

attribute.__closure__))

1597

["func"].cell_contents)

967

attribute.__closure__))["func"]

968

.cell_contents)

1598

969

# Create a new, but exactly alike, function

1599

970

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

1600

971

# with the alternate D-Bus interface name

1601

new_function = copy_function(nonmethod_func)

1602

new_function = (dbus.service.signal(

1603

alt_interface,

1604

attribute._dbus_signature)(new_function))

1605

# Copy annotations, if any

1606

try:

1607

new_function._dbus_annotations = dict(

1608

attribute._dbus_annotations)

1609

except AttributeError:

1610

pass

1611

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

1612

981

# Define a creator of a function to call both the

1613

# original and alternate functions, so both the

1614

# original and alternate signals gets sent when

1615

# the function is called

982

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

983

# signals gets sent when the function is called

1616

984

def fixscope(func1, func2):

1617

985

"""This function is a scope container to pass

1618

986

func1 and func2 to the "call_both" function

1619

987

outside of its arguments"""

1620

1621

@functools.wraps(func2)

1622

988

def call_both(*args, **kwargs):

1623

989

"""This function will emit two D-Bus

1624

990

signals by calling func1 and func2"""

1625

991

func1(*args, **kwargs)

1626

992

func2(*args, **kwargs)

1627

# Make wrapper function look like a D-Bus

1628

# signal

1629

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

1630

if name.startswith("_dbus_"):

1631

setattr(call_both, name, attr)

1632

1633

993

return call_both

1634

994

# Create the "call_both" function and add it to

1635

995

# the class

1636

attr[attrname] = fixscope(attribute, new_function)

996

attr[attrname] = fixscope(attribute,

997

new_function)

1637

998

# Is this a D-Bus method?

1638

999

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

1639

1000

# Create a new, but exactly alike, function

1640

1001

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

1641

1002

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

1642

1003

# to the class.

1643

attr[attrname] = (

1644

dbus.service.method(

1645

alt_interface,

1646

attribute._dbus_in_signature,

1647

attribute._dbus_out_signature)

1648

(copy_function(attribute)))

1649

# Copy annotations, if any

1650

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1653

except AttributeError:

1654

pass

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

1655

1014

# Is this a D-Bus property?

1656

1015

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

1657

1016

# Create a new, but exactly alike, function

1658

1017

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

1659

1018

# property with the alternate D-Bus interface

1660

1019

# name. Add it to the class.

1661

attr[attrname] = (dbus_service_property(

1662

alt_interface, attribute._dbus_signature,

1663

attribute._dbus_access,

1664

attribute._dbus_get_args_options

1665

["byte_arrays"])

1666

(copy_function(attribute)))

1667

# Copy annotations, if any

1668

try:

1669

attr[attrname]._dbus_annotations = dict(

1670

attribute._dbus_annotations)

1671

except AttributeError:

1672

pass

1673

# Is this a D-Bus interface?

1674

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

1675

# Create a new, but exactly alike, function

1676

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

1677

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

1678

# to the class.

1679

attr[attrname] = (

1680

dbus_interface_annotations(alt_interface)

1681

(copy_function(attribute)))

1682

if deprecate:

1683

# Deprecate all alternate interfaces

1684

iname = "_AlternateDBusNames_interface_annotation{}"

1685

for interface_name in interface_names:

1686

1687

@dbus_interface_annotations(interface_name)

1688

def func(self):

1689

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

1690

"true"}

1691

# Find an unused name

1692

for aname in (iname.format(i)

1693

for i in itertools.count()):

1694

if aname not in attr:

1695

attr[aname] = func

1696

break

1697

if interface_names:

1698

# Replace the class with a new subclass of it with

1699

# methods, signals, etc. as created above.

1700

if sys.version_info.major == 2:

1701

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

1702

(cls, ), attr)

1703

else:

1704

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

1705

(cls, ), attr)

1706

return cls

1707

1708

return wrapper

1709

1710

1711

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

1712

"se.bsnet.fukt.Mandos"})

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

1713

1036

class ClientDBus(Client, DBusObjectWithProperties):

1714

1037

"""A Client class using D-Bus

1715

1038

1716

1039

Attributes:

1717

1040

dbus_object_path: dbus.ObjectPath

1718

1041

bus: dbus.SystemBus()

1719

1042

"""

1720

1043

1721

1044

runtime_expansions = (Client.runtime_expansions

1722

+ ("dbus_object_path", ))

1723

1724

_interface = "se.recompile.Mandos.Client"

1725

1045

+ ("dbus_object_path",))

1046

1726

1047

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

1727

1728

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

1048

1049

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

1729

1050

self.bus = bus

1730

1051

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

1052

self._approvals_pending = 0

1053

1054

self._approvals_pending = 0

1731

1055

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

1732

1056

# the D-Bus

1733

client_object_name = str(self.name).translate(

1057

client_object_name = unicode(self.name).translate(

1734

1058

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

1735

1059

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

1736

self.dbus_object_path = dbus.ObjectPath(

1737

"/clients/" + client_object_name)

1060

self.dbus_object_path = (dbus.ObjectPath

1061

("/clients/" + client_object_name))

1738

1062

DBusObjectWithProperties.__init__(self, self.bus,

1739

1063

self.dbus_object_path)

1740

1741

def notifychangeproperty(transform_func, dbus_name,

1742

type_func=lambda x: x,

1743

variant_level=1,

1744

invalidate_only=False,

1745

_interface=_interface):

1064

1065

def notifychangeproperty(transform_func,

1066

dbus_name, type_func=lambda x: x,

1067

variant_level=1):

1746

1068

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

1747

1069

its changes to DBus.

1748

1070

1749

1071

transform_fun: Function that takes a value and a variant_level

1750

1072

and transforms it to a D-Bus type.

1751

1073

dbus_name: D-Bus name of the variable

1753

1075

to the D-Bus. Default: no transform

1754

1076

variant_level: D-Bus variant level. Default: 1

1755

1077

"""

1756

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

1757

1078

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

1758

1079

def setter(self, value):

1759

1080

if hasattr(self, "dbus_object_path"):

1760

1081

if (not hasattr(self, attrname) or

1761

1082

type_func(getattr(self, attrname, None))

1762

1083

!= type_func(value)):

1763

if invalidate_only:

1764

self.PropertiesChanged(

1765

_interface, dbus.Dictionary(),

1766

dbus.Array((dbus_name, )))

1767

else:

1768

dbus_value = transform_func(

1769

type_func(value),

1770

variant_level=variant_level)

1771

self.PropertyChanged(dbus.String(dbus_name),

1772

dbus_value)

1773

self.PropertiesChanged(

1774

_interface,

1775

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

1776

dbus_value}),

1777

dbus.Array())

1084

dbus_value = transform_func(type_func(value),

1085

variant_level

1086

=variant_level)

1087

self.PropertyChanged(dbus.String(dbus_name),

1088

dbus_value)

1778

1089

setattr(self, attrname, value)

1779

1090

1780

1091

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

1781

1092

1093

1782

1094

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1783

1095

approvals_pending = notifychangeproperty(dbus.Boolean,

1784

1096

"ApprovalPending",

1785

type_func=bool)

1097

type_func = bool)

1786

1098

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

1787

1099

last_enabled = notifychangeproperty(datetime_to_dbus,

1788

1100

"LastEnabled")

1789

checker = notifychangeproperty(

1790

dbus.Boolean, "CheckerRunning",

1791

type_func=lambda checker: checker is not None)

1101

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

1102

type_func = lambda checker:

1103

checker is not None)

1792

1104

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1793

1105

"LastCheckedOK")

1794

last_checker_status = notifychangeproperty(dbus.Int16,

1795

"LastCheckerStatus")

1796

1106

last_approval_request = notifychangeproperty(

1797

1107

datetime_to_dbus, "LastApprovalRequest")

1798

1108

approved_by_default = notifychangeproperty(dbus.Boolean,

1799

1109

"ApprovedByDefault")

1800

approval_delay = notifychangeproperty(

1801

dbus.UInt64, "ApprovalDelay",

1802

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

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1803

1114

approval_duration = notifychangeproperty(

1804

1115

dbus.UInt64, "ApprovalDuration",

1805

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

1116

type_func = timedelta_to_milliseconds)

1806

1117

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

1807

timeout = notifychangeproperty(

1808

dbus.UInt64, "Timeout",

1809

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1810

1121

extended_timeout = notifychangeproperty(

1811

1122

dbus.UInt64, "ExtendedTimeout",

1812

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

1813

interval = notifychangeproperty(

1814

dbus.UInt64, "Interval",

1815

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

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

timedelta_to_milliseconds)

1816

1128

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

1817

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

1818

invalidate_only=True)

1819

1129

1820

1130

del notifychangeproperty

1821

1131

1822

1132

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

1823

1133

try:

1824

1134

self.remove_from_connection()

1827

1137

if hasattr(DBusObjectWithProperties, "__del__"):

1828

1138

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

1829

1139

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

1830

1831

def checker_callback(self, source, condition,

1832

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

1833

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

1834

connection, command, *args,

1835

**kwargs)

1836

exitstatus = self.last_checker_status

1837

if exitstatus >= 0:

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)

1838

1147

# Emit D-Bus signal

1839

1148

self.CheckerCompleted(dbus.Int16(exitstatus),

1840

# This is specific to GNU libC

1841

dbus.Int64(exitstatus << 8),

1149

dbus.Int64(condition),

1842

1150

dbus.String(command))

1843

1151

else:

1844

1152

# Emit D-Bus signal

1845

1153

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

1846

dbus.Int64(

1847

# This is specific to GNU libC

1848

(exitstatus << 8)

1849

| self.last_checker_signal),

1154

dbus.Int64(condition),

1850

1155

dbus.String(command))

1851

return ret

1852

1156

1157

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

1158

*args, **kwargs)

1159

1853

1160

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

1854

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

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

1855

1166

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

1856

1167

# Only if new checker process was started

1857

1168

if (self.checker is not None

1859

1170

# Emit D-Bus signal

1860

1171

self.CheckerStarted(self.current_checker_command)

1861

1172

return r

1862

1173

1863

1174

def _reset_approved(self):

1864

1175

self.approved = None

1865

1176

return False

1866

1177

1867

1178

def approve(self, value=True):

1179

self.send_changedstate()

1868

1180

self.approved = value

1869

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

1870

* 1000), self._reset_approved)

1871

self.send_changedstate()

1872

1873

# D-Bus methods, signals & properties

1874

1875

# Interfaces

1876

1877

# Signals

1878

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

1879

1191

# CheckerCompleted - signal

1880

1192

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

1881

1193

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

1882

1194

"D-Bus signal"

1883

1195

pass

1884

1196

1885

1197

# CheckerStarted - signal

1886

1198

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

1887

1199

def CheckerStarted(self, command):

1888

1200

"D-Bus signal"

1889

1201

pass

1890

1202

1891

1203

# PropertyChanged - signal

1892

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

1893

1204

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

1894

1205

def PropertyChanged(self, property, value):

1895

1206

"D-Bus signal"

1896

1207

pass

1897

1208

1898

1209

# GotSecret - signal

1899

1210

@dbus.service.signal(_interface)

1900

1211

def GotSecret(self):

1903

1214

server to mandos-client

1904

1215

"""

1905

1216

pass

1906

1217

1907

1218

# Rejected - signal

1908

1219

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

1909

1220

def Rejected(self, reason):

1910

1221

"D-Bus signal"

1911

1222

pass

1912

1223

1913

1224

# NeedApproval - signal

1914

1225

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

1915

1226

def NeedApproval(self, timeout, default):

1916

1227

"D-Bus signal"

1917

1228

return self.need_approval()

1918

1919

# Methods

1920

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

1921

1240

# Approve - method

1922

1241

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

1923

1242

def Approve(self, value):

1924

1243

self.approve(value)

1925

1244

1926

1245

# CheckedOK - method

1927

1246

@dbus.service.method(_interface)

1928

1247

def CheckedOK(self):

1929

1248

self.checked_ok()

1930

1249

1931

1250

# Enable - method

1932

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

1933

1251

@dbus.service.method(_interface)

1934

1252

def Enable(self):

1935

1253

"D-Bus method"

1936

1254

self.enable()

1937

1255

1938

1256

# StartChecker - method

1939

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

1940

1257

@dbus.service.method(_interface)

1941

1258

def StartChecker(self):

1942

1259

"D-Bus method"

1943

1260

self.start_checker()

1944

1261

1945

1262

# Disable - method

1946

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

1947

1263

@dbus.service.method(_interface)

1948

1264

def Disable(self):

1949

1265

"D-Bus method"

1950

1266

self.disable()

1951

1267

1952

1268

# StopChecker - method

1953

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

1954

1269

@dbus.service.method(_interface)

1955

1270

def StopChecker(self):

1956

1271

self.stop_checker()

1957

1958

# Properties

1959

1272

1273

## Properties

1274

1960

1275

# ApprovalPending - property

1961

1276

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

1962

1277

def ApprovalPending_dbus_property(self):

1963

1278

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

1964

1279

1965

1280

# ApprovedByDefault - property

1966

@dbus_service_property(_interface,

1967

signature="b",

1281

@dbus_service_property(_interface, signature="b",

1968

1282

access="readwrite")

1969

1283

def ApprovedByDefault_dbus_property(self, value=None):

1970

1284

if value is None: # get

1971

1285

return dbus.Boolean(self.approved_by_default)

1972

1286

self.approved_by_default = bool(value)

1973

1287

1974

1288

# ApprovalDelay - property

1975

@dbus_service_property(_interface,

1976

signature="t",

1289

@dbus_service_property(_interface, signature="t",

1977

1290

access="readwrite")

1978

1291

def ApprovalDelay_dbus_property(self, value=None):

1979

1292

if value is None: # get

1980

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

1981

* 1000)

1293

return dbus.UInt64(self.approval_delay_milliseconds())

1982

1294

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

1983

1295

1984

1296

# ApprovalDuration - property

1985

@dbus_service_property(_interface,

1986

signature="t",

1297

@dbus_service_property(_interface, signature="t",

1987

1298

access="readwrite")

1988

1299

def ApprovalDuration_dbus_property(self, value=None):

1989

1300

if value is None: # get

1990

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

1991

* 1000)

1301

return dbus.UInt64(timedelta_to_milliseconds(

1302

self.approval_duration))

1992

1303

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

1993

1304

1994

1305

# Name - property

1995

@dbus_annotations(

1996

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

1997

1306

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

1998

1307

def Name_dbus_property(self):

1999

1308

return dbus.String(self.name)

2000

1309

2001

1310

# Fingerprint - property

2002

@dbus_annotations(

2003

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

2004

1311

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

2005

1312

def Fingerprint_dbus_property(self):

2006

1313

return dbus.String(self.fingerprint)

2007

1314

2008

1315

# Host - property

2009

@dbus_service_property(_interface,

2010

signature="s",

1316

@dbus_service_property(_interface, signature="s",

2011

1317

access="readwrite")

2012

1318

def Host_dbus_property(self, value=None):

2013

1319

if value is None: # get

2014

1320

return dbus.String(self.host)

2015

self.host = str(value)

2016

1321

self.host = unicode(value)

1322

2017

1323

# Created - property

2018

@dbus_annotations(

2019

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

2020

1324

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

2021

1325

def Created_dbus_property(self):

2022

1326

return datetime_to_dbus(self.created)

2023

1327

2024

1328

# LastEnabled - property

2025

1329

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

2026

1330

def LastEnabled_dbus_property(self):

2027

1331

return datetime_to_dbus(self.last_enabled)

2028

1332

2029

1333

# Enabled - property

2030

@dbus_service_property(_interface,

2031

signature="b",

1334

@dbus_service_property(_interface, signature="b",

2032

1335

access="readwrite")

2033

1336

def Enabled_dbus_property(self, value=None):

2034

1337

if value is None: # get

2037

1340

self.enable()

2038

1341

else:

2039

1342

self.disable()

2040

1343

2041

1344

# LastCheckedOK - property

2042

@dbus_service_property(_interface,

2043

signature="s",

1345

@dbus_service_property(_interface, signature="s",

2044

1346

access="readwrite")

2045

1347

def LastCheckedOK_dbus_property(self, value=None):

2046

1348

if value is not None:

2047

1349

self.checked_ok()

2048

1350

return

2049

1351

return datetime_to_dbus(self.last_checked_ok)

2050

2051

# LastCheckerStatus - property

2052

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

2053

def LastCheckerStatus_dbus_property(self):

2054

return dbus.Int16(self.last_checker_status)

2055

1352

2056

1353

# Expires - property

2057

1354

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

2058

1355

def Expires_dbus_property(self):

2059

1356

return datetime_to_dbus(self.expires)

2060

1357

2061

1358

# LastApprovalRequest - property

2062

1359

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

2063

1360

def LastApprovalRequest_dbus_property(self):

2064

1361

return datetime_to_dbus(self.last_approval_request)

2065

1362

2066

1363

# Timeout - property

2067

@dbus_service_property(_interface,

2068

signature="t",

1364

@dbus_service_property(_interface, signature="t",

2069

1365

access="readwrite")

2070

1366

def Timeout_dbus_property(self, value=None):

2071

1367

if value is None: # get

2072

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

2073

old_timeout = self.timeout

1368

return dbus.UInt64(self.timeout_milliseconds())

2074

1369

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

2075

# Reschedule disabling

1370

# Reschedule timeout

2076

1371

if self.enabled:

2077

1372

now = datetime.datetime.utcnow()

2078

self.expires += self.timeout - old_timeout

2079

if self.expires <= now:

1373

time_to_die = timedelta_to_milliseconds(

1374

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

1375

if time_to_die <= 0:

2080

1376

# The timeout has passed

2081

1377

self.disable()

2082

1378

else:

1379

self.expires = (now +

1380

datetime.timedelta(milliseconds =

1381

time_to_die))

2083

1382

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

2084

1383

is None):

2085

1384

return

2086

GLib.source_remove(self.disable_initiator_tag)

2087

self.disable_initiator_tag = GLib.timeout_add(

2088

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

2089

self.disable)

2090

1385

gobject.source_remove(self.disable_initiator_tag)

1386

self.disable_initiator_tag = (gobject.timeout_add

1387

(time_to_die,

1388

self.disable))

1389

2091

1390

# ExtendedTimeout - property

2092

@dbus_service_property(_interface,

2093

signature="t",

1391

@dbus_service_property(_interface, signature="t",

2094

1392

access="readwrite")

2095

1393

def ExtendedTimeout_dbus_property(self, value=None):

2096

1394

if value is None: # get

2097

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

2098

* 1000)

1395

return dbus.UInt64(self.extended_timeout_milliseconds())

2099

1396

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

2100

1397

2101

1398

# Interval - property

2102

@dbus_service_property(_interface,

2103

signature="t",

1399

@dbus_service_property(_interface, signature="t",

2104

1400

access="readwrite")

2105

1401

def Interval_dbus_property(self, value=None):

2106

1402

if value is None: # get

2107

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

1403

return dbus.UInt64(self.interval_milliseconds())

2108

1404

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

2109

1405

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

2110

1406

return

2111

1407

if self.enabled:

2112

1408

# Reschedule checker run

2113

GLib.source_remove(self.checker_initiator_tag)

2114

self.checker_initiator_tag = GLib.timeout_add(

2115

value, self.start_checker)

2116

self.start_checker() # Start one now, too

2117

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

2118

1414

# Checker - property

2119

@dbus_service_property(_interface,

2120

signature="s",

1415

@dbus_service_property(_interface, signature="s",

2121

1416

access="readwrite")

2122

1417

def Checker_dbus_property(self, value=None):

2123

1418

if value is None: # get

2124

1419

return dbus.String(self.checker_command)

2125

self.checker_command = str(value)

2126

1420

self.checker_command = unicode(value)

1421

2127

1422

# CheckerRunning - property

2128

@dbus_service_property(_interface,

2129

signature="b",

1423

@dbus_service_property(_interface, signature="b",

2130

1424

access="readwrite")

2131

1425

def CheckerRunning_dbus_property(self, value=None):

2132

1426

if value is None: # get

2135

1429

self.start_checker()

2136

1430

else:

2137

1431

self.stop_checker()

2138

1432

2139

1433

# ObjectPath - property

2140

@dbus_annotations(

2141

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

2142

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

2143

1434

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

2144

1435

def ObjectPath_dbus_property(self):

2145

return self.dbus_object_path # is already a dbus.ObjectPath

2146

1436

return self.dbus_object_path # is already a dbus.ObjectPath

1437

2147

1438

# Secret = property

2148

@dbus_annotations(

2149

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

2150

"invalidates"})

2151

@dbus_service_property(_interface,

2152

signature="ay",

2153

access="write",

2154

byte_arrays=True)

1439

@dbus_service_property(_interface, signature="ay",

1440

access="write", byte_arrays=True)

2155

1441

def Secret_dbus_property(self, value):

2156

self.secret = bytes(value)

2157

1442

self.secret = str(value)

1443

2158

1444

del _interface

2159

1445

2160

1446

2163

1449

self._pipe = child_pipe

2164

1450

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

2165

1451

if not self._pipe.recv():

2166

raise KeyError(fpr)

2167

1452

raise KeyError()

1453

2168

1454

def __getattribute__(self, name):

2169

1455

if name == '_pipe':

2170

1456

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

2173

1459

if data[0] == 'data':

2174

1460

return data[1]

2175

1461

if data[0] == 'function':

2176

2177

1462

def func(*args, **kwargs):

2178

1463

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

2179

1464

return self._pipe.recv()[1]

2180

2181

1465

return func

2182

1466

2183

1467

def __setattr__(self, name, value):

2184

1468

if name == '_pipe':

2185

1469

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

2186

1470

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

2187

1471

2188

1472

1473

class ClientDBusTransitional(ClientDBus):

1474

__metaclass__ = AlternateDBusNamesMetaclass

1475

1476

2189

1477

class ClientHandler(socketserver.BaseRequestHandler, object):

2190

1478

"""A class to handle client connections.

2191

1479

2192

1480

Instantiated once for each connection to handle it.

2193

1481

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

2194

1482

2195

1483

def handle(self):

2196

1484

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

2197

1485

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

2198

str(self.client_address))

1486

unicode(self.client_address))

2199

1487

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

2200

1488

self.server.child_pipe.fileno())

2201

2202

session = gnutls.ClientSession(self.request)

2203

2204

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

2205

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

2206

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

2207

# "+DHE-DSS"))

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

2208

1504

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

2209

1505

priority = self.server.gnutls_priority

2210

1506

if priority is None:

2211

1507

priority = "NORMAL"

2212

gnutls.priority_set_direct(session._c_object,

2213

priority.encode("utf-8"),

2214

None)

2215

1508

(gnutls.library.functions

1509

.gnutls_priority_set_direct(session._c_object,

1510

priority, None))

1511

2216

1512

# Start communication using the Mandos protocol

2217

1513

# Get protocol number

2218

1514

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

2219

1515

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

2220

1516

try:

2221

1517

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

2222

raise RuntimeError(line)

1518

raise RuntimeError

2223

1519

except (ValueError, IndexError, RuntimeError) as error:

2224

1520

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

2225

1521

return

2226

1522

2227

1523

# Start GnuTLS connection

2228

1524

try:

2229

1525

session.handshake()

2230

except gnutls.Error as error:

1526

except gnutls.errors.GNUTLSError as error:

2231

1527

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

2232

1528

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

2233

1529

# established. Just abandon the request.

2234

1530

return

2235

1531

logger.debug("Handshake succeeded")

2236

1532

2237

1533

approval_required = False

2238

1534

try:

2239

1535

try:

2240

fpr = self.fingerprint(

2241

self.peer_certificate(session))

2242

except (TypeError, gnutls.Error) as error:

1536

fpr = self.fingerprint(self.peer_certificate

1537

(session))

1538

except (TypeError,

1539

gnutls.errors.GNUTLSError) as error:

2243

1540

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

2244

1541

return

2245

1542

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

2246

1543

2247

1544

try:

2248

1545

client = ProxyClient(child_pipe, fpr,

2249

1546

self.client_address)

2250

1547

except KeyError:

2251

1548

return

2252

1549

1550

if self.server.use_dbus:

1551

# Emit D-Bus signal

1552

client.NewRequest(str(self.client_address))

1553

2253

1554

if client.approval_delay:

2254

1555

delay = client.approval_delay

2255

1556

client.approvals_pending += 1

2256

1557

approval_required = True

2257

1558

2258

1559

while True:

2259

1560

if not client.enabled:

2260

1561

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

2261

client.name)

1562

client.name)

2262

1563

if self.server.use_dbus:

2263

1564

# Emit D-Bus signal

2264

1565

client.Rejected("Disabled")

2265

1566

return

2266

1567

2267

1568

if client.approved or not client.approval_delay:

2268

# We are approved or approval is disabled

1569

#We are approved or approval is disabled

2269

1570

break

2270

1571

elif client.approved is None:

2271

1572

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

2273

1574

if self.server.use_dbus:

2274

1575

# Emit D-Bus signal

2275

1576

client.NeedApproval(

2276

client.approval_delay.total_seconds()

2277

* 1000, client.approved_by_default)

1577

client.approval_delay_milliseconds(),

1578

client.approved_by_default)

2278

1579

else:

2279

1580

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

2280

1581

client.name)

2282

1583

# Emit D-Bus signal

2283

1584

client.Rejected("Denied")

2284

1585

return

2285

2286

# wait until timeout or approved

1586

1587

#wait until timeout or approved

2287

1588

time = datetime.datetime.now()

2288

1589

client.changedstate.acquire()

2289

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

1590

(client.changedstate.wait

1591

(float(client.timedelta_to_milliseconds(delay)

1592

/ 1000)))

2290

1593

client.changedstate.release()

2291

1594

time2 = datetime.datetime.now()

2292

1595

if (time2 - time) >= delay:

2302

1605

break

2303

1606

else:

2304

1607

delay -= time2 - time

2305

2306

try:

2307

session.send(client.secret)

2308

except gnutls.Error as error:

2309

logger.warning("gnutls send failed",

2310

exc_info=error)

2311

return

2312

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

2313

1621

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

2314

1622

# bump the timeout using extended_timeout

2315

client.bump_timeout(client.extended_timeout)

1623

client.checked_ok(client.extended_timeout)

2316

1624

if self.server.use_dbus:

2317

1625

# Emit D-Bus signal

2318

1626

client.GotSecret()

2319

1627

2320

1628

finally:

2321

1629

if approval_required:

2322

1630

client.approvals_pending -= 1

2323

1631

try:

2324

1632

session.bye()

2325

except gnutls.Error as error:

2326

logger.warning("GnuTLS bye failed",

2327

exc_info=error)

2328

1633

except gnutls.errors.GNUTLSError as error:

1634

logger.warning("GnuTLS bye failed")

1635

2329

1636

@staticmethod

2330

1637

def peer_certificate(session):

2331

1638

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

2332

1639

# If not an OpenPGP certificate...

2333

if (gnutls.certificate_type_get(session._c_object)

2334

!= gnutls.CRT_OPENPGP):

2335

# ...return invalid data

2336

return b""

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

2337

1645

list_size = ctypes.c_uint(1)

2338

cert_list = (gnutls.certificate_get_peers

1646

cert_list = (gnutls.library.functions

1647

.gnutls_certificate_get_peers

2339

1648

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

2340

1649

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

2341

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

1650

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

1651

" certificate")

2342

1652

if list_size.value == 0:

2343

1653

return None

2344

1654

cert = cert_list[0]

2345

1655

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

2346

1656

2347

1657

@staticmethod

2348

1658

def fingerprint(openpgp):

2349

1659

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2350

1660

# New GnuTLS "datum" with the OpenPGP public key

2351

datum = gnutls.datum_t(

2352

ctypes.cast(ctypes.c_char_p(openpgp),

2353

ctypes.POINTER(ctypes.c_ubyte)),

2354

ctypes.c_uint(len(openpgp)))

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

2355

1666

# New empty GnuTLS certificate

2356

crt = gnutls.openpgp_crt_t()

2357

gnutls.openpgp_crt_init(ctypes.byref(crt))

1667

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1668

(gnutls.library.functions

1669

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2358

1670

# Import the OpenPGP public key into the certificate

2359

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

2360

gnutls.OPENPGP_FMT_RAW)

1671

(gnutls.library.functions

1672

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

1673

gnutls.library.constants

1674

.GNUTLS_OPENPGP_FMT_RAW))

2361

1675

# Verify the self signature in the key

2362

1676

crtverify = ctypes.c_uint()

2363

gnutls.openpgp_crt_verify_self(crt, 0,

2364

ctypes.byref(crtverify))

1677

(gnutls.library.functions

1678

.gnutls_openpgp_crt_verify_self(crt, 0,

1679

ctypes.byref(crtverify)))

2365

1680

if crtverify.value != 0:

2366

gnutls.openpgp_crt_deinit(crt)

2367

raise gnutls.CertificateSecurityError("Verify failed")

1681

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1682

raise (gnutls.errors.CertificateSecurityError

1683

("Verify failed"))

2368

1684

# New buffer for the fingerprint

2369

1685

buf = ctypes.create_string_buffer(20)

2370

1686

buf_len = ctypes.c_size_t()

2371

1687

# Get the fingerprint from the certificate into the buffer

2372

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

2373

ctypes.byref(buf_len))

1688

(gnutls.library.functions

1689

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

1690

ctypes.byref(buf_len)))

2374

1691

# Deinit the certificate

2375

gnutls.openpgp_crt_deinit(crt)

1692

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

1693

# Convert the buffer to a Python bytestring

2377

1694

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

2378

1695

# Convert the bytestring to hexadecimal notation

2382

1699

2383

1700

class MultiprocessingMixIn(object):

2384

1701

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

2385

2386

1702

def sub_process_main(self, request, address):

2387

1703

try:

2388

1704

self.finish_request(request, address)

2389

1705

except Exception:

2390

1706

self.handle_error(request, address)

2391

1707

self.close_request(request)

2392

1708

2393

1709

def process_request(self, request, address):

2394

1710

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

2395

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

2396

args=(request, address))

1711

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

1712

args = (request,

1713

address))

2397

1714

proc.start()

2398

1715

return proc

2399

1716

2400

1717

2401

1718

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2402

1719

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

2403

2404

1720

def process_request(self, request, client_address):

2405

1721

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

2406

1722

2407

1723

This function creates a new pipe in self.pipe

2408

1724

"""

2409

1725

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2410

1726

2411

1727

proc = MultiprocessingMixIn.process_request(self, request,

2412

1728

client_address)

2413

1729

self.child_pipe.close()

2414

1730

self.add_pipe(parent_pipe, proc)

2415

1731

2416

1732

def add_pipe(self, parent_pipe, proc):

2417

1733

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

2418

raise NotImplementedError()

1734

raise NotImplementedError

2419

1735

2420

1736

2421

1737

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2422

1738

socketserver.TCPServer, object):

2423

1739

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

2424

1740

2425

1741

Attributes:

2426

1742

enabled: Boolean; whether this server is activated yet

2427

1743

interface: None or a network interface name (string)

2428

1744

use_ipv6: Boolean; to use IPv6 or not

2429

1745

"""

2430

2431

1746

def __init__(self, server_address, RequestHandlerClass,

2432

interface=None,

2433

use_ipv6=True,

2434

socketfd=None):

2435

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

2436

creating a new one with socket.socket().

2437

"""

1747

interface=None, use_ipv6=True):

2438

1748

self.interface = interface

2439

1749

if use_ipv6:

2440

1750

self.address_family = socket.AF_INET6

2441

if socketfd is not None:

2442

# Save the file descriptor

2443

self.socketfd = socketfd

2444

# Save the original socket.socket() function

2445

self.socket_socket = socket.socket

2446

2447

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

2448

#

2449

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

2450

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

2451

# patching socket.socket.)

2452

#

2453

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

2454

@functools.wraps(socket.socket)

2455

def socket_wrapper(*args, **kwargs):

2456

# Restore original function so subsequent calls are

2457

# not affected.

2458

socket.socket = self.socket_socket

2459

del self.socket_socket

2460

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

2461

# saved file descriptor.

2462

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

2463

# Replace socket.socket() function with wrapper

2464

socket.socket = socket_wrapper

2465

# The socketserver.TCPServer.__init__ will call

2466

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

2467

# socket_wrapper(), if socketfd was set.

2468

1751

socketserver.TCPServer.__init__(self, server_address,

2469

1752

RequestHandlerClass)

2470

2471

1753

def server_bind(self):

2472

1754

"""This overrides the normal server_bind() function

2473

1755

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

2474

1756

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

2475

global SO_BINDTODEVICE

2476

1757

if self.interface is not None:

2477

1758

if SO_BINDTODEVICE is None:

2478

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

2479

# common enough.

2480

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

2481

SO_BINDTODEVICE = 25

2482

try:

2483

self.socket.setsockopt(

2484

socket.SOL_SOCKET, SO_BINDTODEVICE,

2485

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

2486

except socket.error as error:

2487

if error.errno == errno.EPERM:

2488

logger.error("No permission to bind to"

2489

" interface %s", self.interface)

2490

elif error.errno == errno.ENOPROTOOPT:

2491

logger.error("SO_BINDTODEVICE not available;"

2492

" cannot bind to interface %s",

2493

self.interface)

2494

elif error.errno == errno.ENODEV:

2495

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

2496

" cannot bind", self.interface)

2497

else:

2498

raise

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

2499

1779

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

2500

1780

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

2501

1781

if not self.server_address[0]:

2502

1782

if self.address_family == socket.AF_INET6:

2503

any_address = "::" # in6addr_any

1783

any_address = "::" # in6addr_any

2504

1784

else:

2505

any_address = "0.0.0.0" # INADDR_ANY

1785

any_address = socket.INADDR_ANY

2506

1786

self.server_address = (any_address,

2507

1787

self.server_address[1])

2508

1788

elif not self.server_address[1]:

2509

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

1789

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

1790

0)

2510

1791

# if self.interface:

2511

1792

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

2512

1793

# 0, # port

2518

1799

2519

1800

class MandosServer(IPv6_TCPServer):

2520

1801

"""Mandos server.

2521

1802

2522

1803

Attributes:

2523

1804

clients: set of Client objects

2524

1805

gnutls_priority GnuTLS priority string

2525

1806

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

2526

2527

Assumes a GLib.MainLoop event loop.

1807

1808

Assumes a gobject.MainLoop event loop.

2528

1809

"""

2529

2530

1810

def __init__(self, server_address, RequestHandlerClass,

2531

interface=None,

2532

use_ipv6=True,

2533

clients=None,

2534

gnutls_priority=None,

2535

use_dbus=True,

2536

socketfd=None):

1811

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

1812

gnutls_priority=None, use_dbus=True):

2537

1813

self.enabled = False

2538

1814

self.clients = clients

2539

1815

if self.clients is None:

2542

1818

self.gnutls_priority = gnutls_priority

2543

1819

IPv6_TCPServer.__init__(self, server_address,

2544

1820

RequestHandlerClass,

2545

interface=interface,

2546

use_ipv6=use_ipv6,

2547

socketfd=socketfd)

2548

1821

interface = interface,

1822

use_ipv6 = use_ipv6)

2549

1823

def server_activate(self):

2550

1824

if self.enabled:

2551

1825

return socketserver.TCPServer.server_activate(self)

2552

1826

2553

1827

def enable(self):

2554

1828

self.enabled = True

2555

1829

2556

1830

def add_pipe(self, parent_pipe, proc):

2557

1831

# Call "handle_ipc" for both data and EOF events

2558

GLib.io_add_watch(

2559

parent_pipe.fileno(),

2560

GLib.IO_IN | GLib.IO_HUP,

2561

functools.partial(self.handle_ipc,

2562

parent_pipe=parent_pipe,

2563

proc=proc))

2564

2565

def handle_ipc(self, source, condition,

2566

parent_pipe=None,

2567

proc=None,

2568

client_object=None):

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)

2569

1855

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

2570

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

1856

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

2571

1857

# Wait for other process to exit

2572

1858

proc.join()

2573

1859

return False

2574

1860

2575

1861

# Read a request from the child

2576

1862

request = parent_pipe.recv()

2577

1863

command = request[0]

2578

1864

2579

1865

if command == 'init':

2580

1866

fpr = request[1]

2581

1867

address = request[2]

2582

2583

for c in self.clients.values():

1868

1869

for c in self.clients.itervalues():

2584

1870

if c.fingerprint == fpr:

2585

1871

client = c

2586

1872

break

2593

1879

address[0])

2594

1880

parent_pipe.send(False)

2595

1881

return False

2596

2597

GLib.io_add_watch(

2598

parent_pipe.fileno(),

2599

GLib.IO_IN | GLib.IO_HUP,

2600

functools.partial(self.handle_ipc,

2601

parent_pipe=parent_pipe,

2602

proc=proc,

2603

client_object=client))

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

2604

1891

parent_pipe.send(True)

2605

1892

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

2606

1893

# same fileno

2609

1896

funcname = request[1]

2610

1897

args = request[2]

2611

1898

kwargs = request[3]

2612

1899

2613

1900

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

2614

1901

funcname)(*args,

2615

**kwargs)))

2616

1902

**kwargs)))

1903

2617

1904

if command == 'getattr':

2618

1905

attrname = request[1]

2619

if isinstance(client_object.__getattribute__(attrname),

2620

collections.Callable):

2621

parent_pipe.send(('function', ))

1906

if callable(client_object.__getattribute__(attrname)):

1907

parent_pipe.send(('function',))

2622

1908

else:

2623

parent_pipe.send((

2624

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

2625

1909

parent_pipe.send(('data', client_object

1910

.__getattribute__(attrname)))

1911

2626

1912

if command == 'setattr':

2627

1913

attrname = request[1]

2628

1914

value = request[2]

2629

1915

setattr(client_object, attrname, value)

2630

1916

2631

1917

return True

2632

1918

2633

1919

2634

def rfc3339_duration_to_delta(duration):

2635

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

2636

2637

>>> rfc3339_duration_to_delta("P7D")

2638

datetime.timedelta(7)

2639

>>> rfc3339_duration_to_delta("PT60S")

2640

datetime.timedelta(0, 60)

2641

>>> rfc3339_duration_to_delta("PT60M")

2642

datetime.timedelta(0, 3600)

2643

>>> rfc3339_duration_to_delta("PT24H")

2644

datetime.timedelta(1)

2645

>>> rfc3339_duration_to_delta("P1W")

2646

datetime.timedelta(7)

2647

>>> rfc3339_duration_to_delta("PT5M30S")

2648

datetime.timedelta(0, 330)

2649

>>> rfc3339_duration_to_delta("P1DT3M20S")

2650

datetime.timedelta(1, 200)

2651

"""

2652

2653

# Parsing an RFC 3339 duration with regular expressions is not

2654

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

2655

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

2656

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

2657

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

2658

# avoid excessive use of external libraries.

2659

2660

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

2661

Token = collections.namedtuple("Token", (

2662

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

2663

# a "group" containing digits

2664

"value", # datetime.timedelta or None

2665

"followers")) # Tokens valid after this token

2666

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

2667

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

2668

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

2669

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

2670

datetime.timedelta(seconds=1),

2671

frozenset((token_end, )))

2672

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

2673

datetime.timedelta(minutes=1),

2674

frozenset((token_second, token_end)))

2675

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

2676

datetime.timedelta(hours=1),

2677

frozenset((token_minute, token_end)))

2678

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

2679

None,

2680

frozenset((token_hour, token_minute,

2681

token_second)))

2682

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

2683

datetime.timedelta(days=1),

2684

frozenset((token_time, token_end)))

2685

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

2686

datetime.timedelta(weeks=4),

2687

frozenset((token_day, token_end)))

2688

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

2689

datetime.timedelta(weeks=52),

2690

frozenset((token_month, token_end)))

2691

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

2692

datetime.timedelta(weeks=1),

2693

frozenset((token_end, )))

2694

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

2695

frozenset((token_year, token_month,

2696

token_day, token_time,

2697

token_week)))

2698

# Define starting values:

2699

# Value so far

2700

value = datetime.timedelta()

2701

found_token = None

2702

# Following valid tokens

2703

followers = frozenset((token_duration, ))

2704

# String left to parse

2705

s = duration

2706

# Loop until end token is found

2707

while found_token is not token_end:

2708

# Search for any currently valid tokens

2709

for token in followers:

2710

match = token.regexp.match(s)

2711

if match is not None:

2712

# Token found

2713

if token.value is not None:

2714

# Value found, parse digits

2715

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

2716

# Add to value so far

2717

value += factor * token.value

2718

# Strip token from string

2719

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

2720

# Go to found token

2721

found_token = token

2722

# Set valid next tokens

2723

followers = found_token.followers

2724

break

2725

else:

2726

# No currently valid tokens were found

2727

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

2728

.format(duration))

2729

# End token found

2730

return value

2731

2732

2733

1920

def string_to_delta(interval):

2734

1921

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

2735

1922

2736

1923

>>> string_to_delta('7d')

2737

1924

datetime.timedelta(7)

2738

1925

>>> string_to_delta('60s')

2746

1933

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

2747

1934

datetime.timedelta(0, 330)

2748

1935

"""

2749

2750

try:

2751

return rfc3339_duration_to_delta(interval)

2752

except ValueError:

2753

pass

2754

2755

1936

timevalue = datetime.timedelta(0)

2756

1937

for s in interval.split():

2757

1938

try:

2758

suffix = s[-1]

1939

suffix = unicode(s[-1])

2759

1940

value = int(s[:-1])

2760

1941

if suffix == "d":

2761

1942

delta = datetime.timedelta(value)

2768

1949

elif suffix == "w":

2769

1950

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

2770

1951

else:

2771

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

2772

except IndexError as e:

1952

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

1953

except (ValueError, IndexError) as e:

2773

1954

raise ValueError(*(e.args))

2774

1955

timevalue += delta

2775

1956

return timevalue

2776

1957

2777

1958

2778

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

1959

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

2779

1960

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

2780

1961

2781

1962

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

2782

1963

if os.fork():

2783

1964

sys.exit()

2788

1969

sys.exit()

2789

1970

if not noclose:

2790

1971

# Close all standard open file descriptors

2791

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

1972

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

2792

1973

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

2793

1974

raise OSError(errno.ENODEV,

2794

"{} not a character device"

2795

.format(os.devnull))

1975

"%s not a character device"

1976

% os.path.devnull)

2796

1977

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

2797

1978

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

2798

1979

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

2801

1982

2802

1983

2803

1984

def main():

2804

1985

2805

1986

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

2806

1987

# Parsing of options, both command line and config file

2807

1988

2808

1989

parser = argparse.ArgumentParser()

2809

1990

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

2810

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

1991

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

2811

1992

help="show version number and exit")

2812

1993

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

2813

1994

help="Bind to interface IF")

2819

2000

help="Run self-test")

2820

2001

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

2821

2002

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

2822

" to terminal", default=None)

2003

" to terminal")

2823

2004

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

2824

2005

help="Debug level for stdout output")

2825

2006

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

2832

2013

" files")

2833

2014

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

2834

2015

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

2835

" system bus interface", default=None)

2016

" system bus interface")

2836

2017

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

2837

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

2838

default=None)

2018

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

2839

2019

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

2840

2020

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

2841

" state", default=None)

2842

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

2843

help="Specify a file descriptor to a network"

2844

" socket to use instead of creating one")

2021

" state")

2845

2022

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

2846

2023

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

2847

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

2848

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

2849

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

2850

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

2851

default=None)

2852

2024

2853

2025

options = parser.parse_args()

2854

2026

2855

2027

if options.check:

2856

2028

import doctest

2857

fail_count, test_count = doctest.testmod()

2858

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

2859

2029

doctest.testmod()

2030

sys.exit()

2031

2860

2032

# Default values for config file for server-global settings

2861

server_defaults = {"interface": "",

2862

"address": "",

2863

"port": "",

2864

"debug": "False",

2865

"priority":

2866

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

2867

":+SIGN-DSA-SHA256",

2868

"servicename": "Mandos",

2869

"use_dbus": "True",

2870

"use_ipv6": "True",

2871

"debuglevel": "",

2872

"restore": "True",

2873

"socket": "",

2874

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

2875

"foreground": "False",

2876

"zeroconf": "True",

2877

}

2878

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

2879

2047

# Parse config file for server-global settings

2880

2048

server_config = configparser.SafeConfigParser(server_defaults)

2881

2049

del server_defaults

2882

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

2050

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

2051

"mandos.conf"))

2883

2052

# Convert the SafeConfigParser object to a dict

2884

2053

server_settings = server_config.defaults()

2885

2054

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

2886

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

2055

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

2887

2056

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

2888

2057

option)

2889

2058

if server_settings["port"]:

2890

2059

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

2891

2060

"port")

2892

if server_settings["socket"]:

2893

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

2894

"socket")

2895

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

2896

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

2897

# happen with a supplied network socket.

2898

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

2899

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

2900

["socket"])

2901

2061

del server_config

2902

2062

2903

2063

# Override the settings from the config file with command line

2904

2064

# options, if set.

2905

2065

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

2906

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

2907

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

2908

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

2066

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

2067

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

2068

"statedir"):

2909

2069

value = getattr(options, option)

2910

2070

if value is not None:

2911

2071

server_settings[option] = value

2912

2072

del options

2913

2073

# Force all strings to be unicode

2914

2074

for option in server_settings.keys():

2915

if isinstance(server_settings[option], bytes):

2916

server_settings[option] = (server_settings[option]

2917

.decode("utf-8"))

2918

# Force all boolean options to be boolean

2919

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

2920

"foreground", "zeroconf"):

2921

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

2922

# Debug implies foreground

2923

if server_settings["debug"]:

2924

server_settings["foreground"] = True

2075

if type(server_settings[option]) is str:

2076

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

2925

2077

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

2926

2078

2927

2079

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

2928

2929

if (not server_settings["zeroconf"]

2930

and not (server_settings["port"]

2931

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

2932

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

2933

2080

2934

2081

# For convenience

2935

2082

debug = server_settings["debug"]

2936

2083

debuglevel = server_settings["debuglevel"]

2938

2085

use_ipv6 = server_settings["use_ipv6"]

2939

2086

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

2940

2087

stored_state_file)

2941

foreground = server_settings["foreground"]

2942

zeroconf = server_settings["zeroconf"]

2943

2088

2944

2089

if debug:

2945

2090

initlogger(debug, logging.DEBUG)

2946

2091

else:

2949

2094

else:

2950

2095

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

2951

2096

initlogger(debug, level)

2952

2097

2953

2098

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

2954

syslogger.setFormatter(

2955

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

2956

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

2957

server_settings["servicename"])))

2958

2099

syslogger.setFormatter(logging.Formatter

2100

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

2101

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

2102

% server_settings["servicename"]))

2103

2959

2104

# Parse config file with clients

2960

2105

client_config = configparser.SafeConfigParser(Client

2961

2106

.client_defaults)

2962

2107

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

2963

2108

"clients.conf"))

2964

2109

2965

2110

global mandos_dbus_service

2966

2111

mandos_dbus_service = None

2967

2968

socketfd = None

2969

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

2970

socketfd = server_settings["socket"]

2971

tcp_server = MandosServer(

2972

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

2973

ClientHandler,

2974

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

2975

use_ipv6=use_ipv6,

2976

gnutls_priority=server_settings["priority"],

2977

use_dbus=use_dbus,

2978

socketfd=socketfd)

2979

if not foreground:

2980

pidfilename = "/run/mandos.pid"

2981

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

2982

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

2983

pidfile = None

2984

try:

2985

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

2986

except IOError as e:

2987

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

2988

exc_info=e)

2989

2990

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

2991

("mandos", "mandos"),

2992

("nobody", "nogroup")):

2993

try:

2994

uid = pwd.getpwnam(name).pw_uid

2995

gid = pwd.getpwnam(group).pw_gid

2996

break

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

2997

2136

except KeyError:

2998

continue

2999

else:

3000

uid = 65534

3001

gid = 65534

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

3002

2143

try:

3003

2144

os.setgid(gid)

3004

2145

os.setuid(uid)

3005

if debug:

3006

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

3007

gid))

3008

2146

except OSError as error:

3009

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

3010

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

3011

if error.errno != errno.EPERM:

3012

raise

3013

2147

if error[0] != errno.EPERM:

2148

raise error

2149

3014

2150

if debug:

3015

2151

# Enable all possible GnuTLS debugging

3016

2152

3017

2153

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

3018

2154

# - GnuTLS manual

3019

gnutls.global_set_log_level(11)

3020

3021

@gnutls.log_func

2155

gnutls.library.functions.gnutls_global_set_log_level(11)

2156

2157

@gnutls.library.types.gnutls_log_func

3022

2158

def debug_gnutls(level, string):

3023

2159

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

3024

3025

gnutls.global_set_log_function(debug_gnutls)

3026

2160

2161

(gnutls.library.functions

2162

.gnutls_global_set_log_function(debug_gnutls))

2163

3027

2164

# Redirect stdin so all checkers get /dev/null

3028

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

2165

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

3029

2166

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

3030

2167

if null > 2:

3031

2168

os.close(null)

3032

2169

3033

2170

# Need to fork before connecting to D-Bus

3034

if not foreground:

2171

if not debug:

3035

2172

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

3036

2173

daemon()

3037

3038

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

3039

# to inform GLib that threads will be used.

3040

GLib.threads_init()

3041

2174

2175

gobject.threads_init()

2176

3042

2177

global main_loop

3043

2178

# From the Avahi example code

3044

DBusGMainLoop(set_as_default=True)

3045

main_loop = GLib.MainLoop()

2179

DBusGMainLoop(set_as_default=True )

2180

main_loop = gobject.MainLoop()

3046

2181

bus = dbus.SystemBus()

3047

2182

# End of Avahi example code

3048

2183

if use_dbus:

3049

2184

try:

3050

2185

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

3051

bus,

3052

do_not_queue=True)

3053

old_bus_name = dbus.service.BusName(

3054

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

3055

do_not_queue=True)

3056

except dbus.exceptions.DBusException as e:

3057

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

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

3058

2192

use_dbus = False

3059

2193

server_settings["use_dbus"] = False

3060

2194

tcp_server.use_dbus = False

3061

if zeroconf:

3062

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3063

service = AvahiServiceToSyslog(

3064

name=server_settings["servicename"],

3065

servicetype="_mandos._tcp",

3066

protocol=protocol,

3067

bus=bus)

3068

if server_settings["interface"]:

3069

service.interface = if_nametoindex(

3070

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

3071

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

3072

2204

global multiprocessing_manager

3073

2205

multiprocessing_manager = multiprocessing.Manager()

3074

2206

3075

2207

client_class = Client

3076

2208

if use_dbus:

3077

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

3078

2209

client_class = functools.partial(ClientDBusTransitional,

2210

bus = bus)

2211

3079

2212

client_settings = Client.config_parser(client_config)

3080

2213

old_client_settings = {}

3081

2214

clients_data = {}

3082

3083

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

3084

global wnull

3085

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

3086

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

3087

# mode

3088

if debug or not foreground:

3089

wnull.close()

3090

2215

3091

2216

# Get client data and settings from last running state.

3092

2217

if server_settings["restore"]:

3093

2218

try:

3094

2219

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

3095

if sys.version_info.major == 2:

3096

clients_data, old_client_settings = pickle.load(

3097

stored_state)

3098

else:

3099

bytes_clients_data, bytes_old_client_settings = (

3100

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

3101

# Fix bytes to strings

3102

# clients_data

3103

# .keys()

3104

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

3105

if isinstance(key, bytes)

3106

else key): value

3107

for key, value in

3108

bytes_clients_data.items()}

3109

del bytes_clients_data

3110

for key in clients_data:

3111

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

3112

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

3113

for k, v in

3114

clients_data[key].items()}

3115

clients_data[key] = value

3116

# .client_structure

3117

value["client_structure"] = [

3118

(s.decode("utf-8")

3119

if isinstance(s, bytes)

3120

else s) for s in

3121

value["client_structure"]]

3122

# .name & .host

3123

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

3124

if isinstance(value[k], bytes):

3125

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

3126

# old_client_settings

3127

# .keys()

3128

old_client_settings = {

3129

(key.decode("utf-8")

3130

if isinstance(key, bytes)

3131

else key): value

3132

for key, value in

3133

bytes_old_client_settings.items()}

3134

del bytes_old_client_settings

3135

# .host

3136

for value in old_client_settings.values():

3137

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

3138

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

3139

.decode("utf-8"))

2220

clients_data, old_client_settings = (pickle.load

2221

(stored_state))

3140

2222

os.remove(stored_state_path)

3141

2223

except IOError as e:

3142

if e.errno == errno.ENOENT:

3143

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

3144

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

3145

else:

3146

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

3147

exc_info=e)

2224

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

2225

.format(e))

2226

if e.errno != errno.ENOENT:

3148

2227

raise

3149

2228

except EOFError as e:

3150

2229

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

3151

"EOFError:",

3152

exc_info=e)

3153

2230

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

2231

3154

2232

with PGPEngine() as pgp:

3155

for client_name, client in clients_data.items():

3156

# Skip removed clients

3157

if client_name not in client_settings:

3158

continue

3159

2233

for client_name, client in clients_data.iteritems():

3160

2234

# Decide which value to use after restoring saved state.

3161

2235

# We have three different values: Old config file,

3162

2236

# new config file, and saved state.

3167

2241

# For each value in new config, check if it

3168

2242

# differs from the old config value (Except for

3169

2243

# the "secret" attribute)

3170

if (name != "secret"

3171

and (value !=

3172

old_client_settings[client_name][name])):

2244

if (name != "secret" and

2245

value != old_client_settings[client_name]

2246

[name]):

3173

2247

client[name] = value

3174

2248

except KeyError:

3175

2249

pass

3176

2250

3177

2251

# Clients who has passed its expire date can still be

3178

# enabled if its last checker was successful. A Client

3179

# whose checker succeeded before we stored its state is

3180

# assumed to have successfully run all checkers during

3181

# downtime.

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.

3182

2255

if client["enabled"]:

3183

2256

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

3184

2257

if not client["last_checked_ok"]:

3185

2258

logger.warning(

3186

"disabling client {} - Client never "

3187

"performed a successful checker".format(

3188

client_name))

2259

"disabling client {0} - Client never "

2260

"performed a successfull checker"

2261

.format(client["name"]))

3189

2262

client["enabled"] = False

3190

2263

elif client["last_checker_status"] != 0:

3191

2264

logger.warning(

3192

"disabling client {} - Client last"

3193

" checker failed with error code"

3194

" {}".format(

3195

client_name,

3196

client["last_checker_status"]))

2265

"disabling client {0} - Client "

2266

"last checker failed with error code {1}"

2267

.format(client["name"],

2268

client["last_checker_status"]))

3197

2269

client["enabled"] = False

3198

2270

else:

3199

client["expires"] = (

3200

datetime.datetime.utcnow()

3201

+ client["timeout"])

2271

client["expires"] = (datetime.datetime

2272

.utcnow()

2273

+ client["timeout"])

3202

2274

logger.debug("Last checker succeeded,"

3203

" keeping {} enabled".format(

3204

client_name))

2275

" keeping {0} enabled"

2276

.format(client["name"]))

3205

2277

try:

3206

client["secret"] = pgp.decrypt(

3207

client["encrypted_secret"],

3208

client_settings[client_name]["secret"])

2278

client["secret"] = (

2279

pgp.decrypt(client["encrypted_secret"],

2280

client_settings[client_name]

2281

["secret"]))

3209

2282

except PGPError:

3210

2283

# If decryption fails, we use secret from new settings

3211

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

3212

client_name))

3213

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

3214

["secret"])

2284

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

2285

.format(client_name))

2286

client["secret"] = (

2287

client_settings[client_name]["secret"])

3215

2288

2289

3216

2290

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

3217

2291

for client_name in (set(old_client_settings)

3218

2292

- set(client_settings)):

3221

2295

- set(old_client_settings)):

3222

2296

clients_data[client_name] = client_settings[client_name]

3223

2297

3224

# Create all client objects

3225

for client_name, client in clients_data.items():

2298

# Create clients all clients

2299

for client_name, client in clients_data.iteritems():

3226

2300

tcp_server.clients[client_name] = client_class(

3227

name=client_name,

3228

settings=client,

3229

server_settings=server_settings)

3230

2301

name = client_name, settings = client)

2302

3231

2303

if not tcp_server.clients:

3232

2304

logger.warning("No clients defined")

3233

3234

if not foreground:

3235

if pidfile is not None:

3236

pid = os.getpid()

3237

try:

3238

with pidfile:

3239

print(pid, file=pidfile)

3240

except IOError:

3241

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

3242

pidfilename, pid)

3243

del pidfile

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

3244

2318

del pidfilename

3245

3246

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

3247

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3248

lambda: main_loop.quit() and False)

3249

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

3250

2324

if use_dbus:

3251

3252

@alternate_dbus_interfaces(

3253

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

3254

class MandosDBusService(DBusObjectWithObjectManager):

2325

class MandosDBusService(dbus.service.Object):

3255

2326

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

3256

3257

2327

def __init__(self):

3258

2328

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

3259

3260

2329

_interface = "se.recompile.Mandos"

3261

2330

3262

2331

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

3263

2332

def ClientAdded(self, objpath):

3264

2333

"D-Bus signal"

3265

2334

pass

3266

2335

3267

2336

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

3268

2337

def ClientNotFound(self, fingerprint, address):

3269

2338

"D-Bus signal"

3270

2339

pass

3271

3272

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

3273

"true"})

2340

3274

2341

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

3275

2342

def ClientRemoved(self, objpath, name):

3276

2343

"D-Bus signal"

3277

2344

pass

3278

3279

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

3280

"true"})

2345

3281

2346

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

3282

2347

def GetAllClients(self):

3283

2348

"D-Bus method"

3284

return dbus.Array(c.dbus_object_path for c in

3285

tcp_server.clients.values())

3286

3287

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

3288

"true"})

2349

return dbus.Array(c.dbus_object_path

2350

for c in

2351

tcp_server.clients.itervalues())

2352

3289

2353

@dbus.service.method(_interface,

3290

2354

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

3291

2355

def GetAllClientsWithProperties(self):

3292

2356

"D-Bus method"

3293

2357

return dbus.Dictionary(

3294

{c.dbus_object_path: c.GetAll(

3295

"se.recompile.Mandos.Client")

3296

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

2358

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

2359

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

3297

2360

signature="oa{sv}")

3298

2361

3299

2362

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

3300

2363

def RemoveClient(self, object_path):

3301

2364

"D-Bus method"

3302

for c in tcp_server.clients.values():

2365

for c in tcp_server.clients.itervalues():

3303

2366

if c.dbus_object_path == object_path:

3304

2367

del tcp_server.clients[c.name]

3305

2368

c.remove_from_connection()

3306

# Don't signal the disabling

2369

# Don't signal anything except ClientRemoved

3307

2370

c.disable(quiet=True)

3308

# Emit D-Bus signal for removal

3309

self.client_removed_signal(c)

2371

# Emit D-Bus signal

2372

self.ClientRemoved(object_path, c.name)

3310

2373

return

3311

2374

raise KeyError(object_path)

3312

2375

3313

2376

del _interface

3314

3315

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3316

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

3317

def GetManagedObjects(self):

3318

"""D-Bus method"""

3319

return dbus.Dictionary(

3320

{client.dbus_object_path:

3321

dbus.Dictionary(

3322

{interface: client.GetAll(interface)

3323

for interface in

3324

client._get_all_interface_names()})

3325

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

3326

3327

def client_added_signal(self, client):

3328

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

3329

if use_dbus:

3330

# New standard signal

3331

self.InterfacesAdded(

3332

client.dbus_object_path,

3333

dbus.Dictionary(

3334

{interface: client.GetAll(interface)

3335

for interface in

3336

client._get_all_interface_names()}))

3337

# Old signal

3338

self.ClientAdded(client.dbus_object_path)

3339

3340

def client_removed_signal(self, client):

3341

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

3342

if use_dbus:

3343

# New standard signal

3344

self.InterfacesRemoved(

3345

client.dbus_object_path,

3346

client._get_all_interface_names())

3347

# Old signal

3348

self.ClientRemoved(client.dbus_object_path,

3349

client.name)

3350

3351

mandos_dbus_service = MandosDBusService()

3352

3353

# Save modules to variables to exempt the modules from being

3354

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

3355

mp = multiprocessing

3356

wn = wnull

3357

2377

2378

class MandosDBusServiceTransitional(MandosDBusService):

2379

__metaclass__ = AlternateDBusNamesMetaclass

2380

mandos_dbus_service = MandosDBusServiceTransitional()

2381

3358

2382

def cleanup():

3359

2383

"Cleanup function; run on exit"

3360

if zeroconf:

3361

service.cleanup()

3362

3363

mp.active_children()

3364

wn.close()

2384

service.cleanup()

2385

2386

multiprocessing.active_children()

3365

2387

if not (tcp_server.clients or client_settings):

3366

2388

return

3367

2389

3368

2390

# Store client before exiting. Secrets are encrypted with key

3369

2391

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

3370

2392

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

3371

2393

clients = {}

3372

2394

with PGPEngine() as pgp:

3373

for client in tcp_server.clients.values():

2395

for client in tcp_server.clients.itervalues():

3374

2396

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

3375

2397

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

3376

2398

key)

3377

2399

client_dict = {}

3378

2400

3379

2401

# A list of attributes that can not be pickled

3380

2402

# + secret.

3381

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

3382

"checker", "server_settings"}

3383

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

3384

.Object):

2403

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

2404

"checker"))

2405

for name, typ in (inspect.getmembers

2406

(dbus.service.Object)):

3385

2407

exclude.add(name)

3386

2408

3387

2409

client_dict["encrypted_secret"] = (client

3388

2410

.encrypted_secret)

3389

2411

for attr in client.client_structure:

3390

2412

if attr not in exclude:

3391

2413

client_dict[attr] = getattr(client, attr)

3392

2414

3393

2415

clients[client.name] = client_dict

3394

2416

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

3395

2417

3396

2418

try:

3397

with tempfile.NamedTemporaryFile(

3398

mode='wb',

3399

suffix=".pickle",

3400

prefix='clients-',

3401

dir=os.path.dirname(stored_state_path),

3402

delete=False) as stored_state:

3403

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

3404

protocol=2)

3405

tempname = stored_state.name

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)

3406

2425

os.rename(tempname, stored_state_path)

3407

2426

except (IOError, OSError) as e:

2427

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

2428

.format(e))

3408

2429

if not debug:

3409

2430

try:

3410

2431

os.remove(tempname)

3411

2432

except NameError:

3412

2433

pass

3413

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

3414

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

3415

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

3416

else:

3417

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

3418

exc_info=e)

3419

raise

3420

2434

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

2435

errno.EEXIST)):

2436

raise e

2437

3421

2438

# Delete all clients, and settings from config

3422

2439

while tcp_server.clients:

3423

2440

name, client = tcp_server.clients.popitem()

3424

2441

if use_dbus:

3425

2442

client.remove_from_connection()

3426

# Don't signal the disabling

2443

# Don't signal anything except ClientRemoved

3427

2444

client.disable(quiet=True)

3428

# Emit D-Bus signal for removal

3429

2445

if use_dbus:

3430

mandos_dbus_service.client_removed_signal(client)

2446

# Emit D-Bus signal

2447

mandos_dbus_service.ClientRemoved(client

2448

.dbus_object_path,

2449

client.name)

3431

2450

client_settings.clear()

3432

2451

3433

2452

atexit.register(cleanup)

3434

3435

for client in tcp_server.clients.values():

2453

2454

for client in tcp_server.clients.itervalues():

3436

2455

if use_dbus:

3437

# Emit D-Bus signal for adding

3438

mandos_dbus_service.client_added_signal(client)

2456

# Emit D-Bus signal

2457

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3439

2458

# Need to initiate checking of clients

3440

2459

if client.enabled:

3441

2460

client.init_checker()

3442

2461

3443

2462

tcp_server.enable()

3444

2463

tcp_server.server_activate()

3445

2464

3446

2465

# Find out what port we got

3447

if zeroconf:

3448

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

2466

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

3449

2467

if use_ipv6:

3450

2468

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

3451

" flowinfo %d, scope_id %d",

3452

*tcp_server.socket.getsockname())

2469

" flowinfo %d, scope_id %d"

2470

% tcp_server.socket.getsockname())

3453

2471

else: # IPv4

3454

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

3455

*tcp_server.socket.getsockname())

3456

3457

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

3458

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

3459

2477

try:

3460

if zeroconf:

3461

# From the Avahi example code

3462

try:

3463

service.activate()

3464

except dbus.exceptions.DBusException as error:

3465

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

3466

cleanup()

3467

sys.exit(1)

3468

# End of Avahi example code

3469

3470

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

3471

lambda *args, **kwargs:

3472

(tcp_server.handle_request

3473

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

3474

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

3475

2492

logger.debug("Starting main loop")

3476

2493

main_loop.run()

3477

2494

except AvahiError as error:

3478

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

2495

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

3479

2496

cleanup()

3480

2497

sys.exit(1)

3481

2498

except KeyboardInterrupt:

3486

2503

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

3487

2504

cleanup()

3488

2505

3489

3490

2506

if __name__ == '__main__':

3491

2507

main()