/mandos/trunk : revision 890

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

14

15

16

#

17

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

18

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

19

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

23

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

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

# GNU General Public License for more details.

26

#

26

#

27

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

28

# along with this program. If not, see

29

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

30

#

30

#

31

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

32

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

38

46

import socket

39

47

import argparse

40

48

import datetime

41

49

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

49

54

import sys

50

55

import re

51

56

import os

60

65

import struct

61

66

import fcntl

62

67

import functools

63

import cPickle as pickle

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

64

72

import multiprocessing

65

73

import types

66

74

import binascii

67

75

import tempfile

76

import itertools

77

import collections

78

import codecs

68

79

69

80

import dbus

70

81

import dbus.service

71

import gobject

72

import avahi

82

from gi.repository import GLib

73

83

from dbus.mainloop.glib import DBusGMainLoop

74

84

import ctypes

75

85

import ctypes.util

76

86

import xml.dom.minidom

77

87

import inspect

78

import GnuPGInterface

79

88

89

# Try to find the value of SO_BINDTODEVICE:

80

90

try:

91

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

92

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

81

93

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

82

94

except AttributeError:

83

95

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

84

98

from IN import SO_BINDTODEVICE

85

99

except ImportError:

86

SO_BINDTODEVICE = None

87

88

version = "1.5.2"

100

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

101

# Try running the C preprocessor:

102

try:

103

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

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

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

109

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

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.13"

89

118

stored_state_file = "clients.pickle"

90

119

91

120

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

121

syslogger = None

95

122

96

123

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

100

126

except (OSError, AttributeError):

127

101

128

def if_nametoindex(interface):

102

129

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

103

130

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

104

131

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

105

132

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

133

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

134

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

110

135

return interface_index

111

136

112

137

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

113

154

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

114

155

"""init logger and add loglevel"""

115

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

160

address="/dev/log"))

116

161

syslogger.setFormatter(logging.Formatter

117

162

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

118

163

' %(message)s'))

119

164

logger.addHandler(syslogger)

120

165

121

166

if debug:

122

167

console = logging.StreamHandler()

123

168

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

135

180

136

181

class PGPEngine(object):

137

182

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

183

138

184

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

185

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

147

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

'--force-mdc',

200

'--quiet']

201

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

202

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

203

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

204

148

205

def __enter__(self):

149

206

return self

150

151

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

207

208

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

152

209

self._cleanup()

153

210

return False

154

211

155

212

def __del__(self):

156

213

self._cleanup()

157

214

158

215

def _cleanup(self):

159

216

if self.tempdir is not None:

160

217

# Delete contents of tempdir

161

218

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

162

topdown = False):

219

topdown=False):

163

220

for filename in files:

164

221

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

165

222

for dirname in dirs:

167

224

# Remove tempdir

168

225

os.rmdir(self.tempdir)

169

226

self.tempdir = None

170

227

171

228

def password_encode(self, password):

172

229

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

173

230

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

174

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

175

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

238

176

239

def encrypt(self, data, password):

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin=subprocess.PIPE,

250

stdout=subprocess.PIPE,

251

stderr=subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

raise PGPError(err)

191

255

return ciphertext

192

256

193

257

def decrypt(self, data, password):

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir=self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin=subprocess.PIPE,

268

stdout=subprocess.PIPE,

269

stderr=subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

raise PGPError(err)

208

273

return decrypted_plaintext

209

274

210

275

276

# Pretend that we have an Avahi module

277

class Avahi(object):

278

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

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

def string_array_to_txt_array(self, t):

290

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

291

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

292

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

293

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

294

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

295

SERVER_INVALID = 0 # avahi-common/defs.h

296

SERVER_REGISTERING = 1 # avahi-common/defs.h

297

SERVER_RUNNING = 2 # avahi-common/defs.h

298

SERVER_COLLISION = 3 # avahi-common/defs.h

299

SERVER_FAILURE = 4 # avahi-common/defs.h

300

avahi = Avahi()

301

211

302

212

303

class AvahiError(Exception):

213

304

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

214

305

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

306

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

307

**kwargs)

308

218

309

219

310

class AvahiServiceError(AvahiError):

220

311

pass

221

312

313

222

314

class AvahiGroupError(AvahiError):

223

315

pass

224

316

225

317

226

318

class AvahiService(object):

227

319

"""An Avahi (Zeroconf) service.

228

320

229

321

Attributes:

230

322

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

231

323

Used to optionally bind to the specified interface.

232

324

name: string; Example: 'Mandos'

233

325

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

234

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

326

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

235

327

port: integer; what port to announce

236

328

TXT: list of strings; TXT record for the service

237

329

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

243

335

server: D-Bus Server

244

336

bus: dbus.SystemBus()

245

337

"""

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

250

350

self.interface = interface

251

351

self.name = name

252

352

self.type = servicetype

261

361

self.server = None

262

362

self.bus = bus

263

363

self.entry_group_state_changed_match = None

264

def rename(self):

364

365

def rename(self, remove=True):

265

366

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

266

367

if self.rename_count >= self.max_renames:

267

368

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

268

369

" after %i retries, exiting.",

269

370

self.rename_count)

270

371

raise AvahiServiceError("Too many renames")

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

273

375

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

274

376

self.name)

275

self.remove()

377

if remove:

378

self.remove()

276

379

try:

277

380

self.add()

278

381

except dbus.exceptions.DBusException as error:

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

283

391

def remove(self):

284

392

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

285

393

if self.entry_group_state_changed_match is not None:

287

395

self.entry_group_state_changed_match = None

288

396

if self.group is not None:

289

397

self.group.Reset()

398

290

399

def add(self):

291

400

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

292

401

self.remove()

309

418

dbus.UInt16(self.port),

310

419

avahi.string_array_to_txt_array(self.TXT))

311

420

self.group.Commit()

421

312

422

def entry_group_state_changed(self, state, error):

313

423

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

314

424

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

315

425

316

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

317

427

logger.debug("Zeroconf service established.")

318

428

elif state == avahi.ENTRY_GROUP_COLLISION:

320

430

self.rename()

321

431

elif state == avahi.ENTRY_GROUP_FAILURE:

322

432

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

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

433

str(error))

434

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

435

326

436

def cleanup(self):

327

437

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

328

438

if self.group is not None:

333

443

pass

334

444

self.group = None

335

445

self.remove()

446

336

447

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

337

448

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

338

449

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

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

346

456

if state in bad_states:

347

457

if bad_states[state] is not None:

348

458

if error is None:

351

461

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

352

462

self.cleanup()

353

463

elif state == avahi.SERVER_RUNNING:

354

self.add()

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

355

476

else:

356

477

if error is None:

357

478

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

358

479

else:

359

480

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

481

360

482

def activate(self):

361

483

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

362

484

if self.server is None:

366

488

follow_name_owner_changes=True),

367

489

avahi.DBUS_INTERFACE_SERVER)

368

490

self.server.connect_to_signal("StateChanged",

369

self.server_state_changed)

491

self.server_state_changed)

370

492

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

371

493

494

372

495

class AvahiServiceToSyslog(AvahiService):

373

def rename(self):

496

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

374

497

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

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

380

502

return ret

381

503

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

504

505

# Pretend that we have a GnuTLS module

506

class GnuTLS(object):

507

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

508

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

509

510

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

511

if library is None:

512

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

513

_library = ctypes.cdll.LoadLibrary(library)

514

del library

515

_need_version = b"3.3.0"

516

517

def __init__(self):

518

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

519

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

520

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

521

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

522

.format(self._need_version))

523

524

# Unless otherwise indicated, the constants and types below are

525

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

526

527

# Constants

528

E_SUCCESS = 0

529

E_INTERRUPTED = -52

530

E_AGAIN = -28

531

CRT_OPENPGP = 2

532

CLIENT = 2

533

SHUT_RDWR = 0

534

CRD_CERTIFICATE = 1

535

E_NO_CERTIFICATE_FOUND = -49

536

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

537

538

# Types

539

class session_int(ctypes.Structure):

540

_fields_ = []

541

session_t = ctypes.POINTER(session_int)

542

543

class certificate_credentials_st(ctypes.Structure):

544

_fields_ = []

545

certificate_credentials_t = ctypes.POINTER(

546

certificate_credentials_st)

547

certificate_type_t = ctypes.c_int

548

549

class datum_t(ctypes.Structure):

550

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

551

('size', ctypes.c_uint)]

552

553

class openpgp_crt_int(ctypes.Structure):

554

_fields_ = []

555

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

556

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

557

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

558

credentials_type_t = ctypes.c_int

559

transport_ptr_t = ctypes.c_void_p

560

close_request_t = ctypes.c_int

561

562

# Exceptions

563

class Error(Exception):

564

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

565

# exception might be raised from within GnuTLS.__init__,

566

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

567

# global variable has happened.

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = GnuTLS.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials(object):

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession(object):

593

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

594

self._c_object = gnutls.session_t()

595

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

596

gnutls.set_default_priority(self._c_object)

597

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

598

gnutls.handshake_set_private_extensions(self._c_object,

599

True)

600

self.socket = socket

601

if credentials is None:

602

credentials = gnutls.Credentials()

603

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

604

ctypes.cast(credentials._c_object,

605

ctypes.c_void_p))

606

self.credentials = credentials

607

608

def __del__(self):

609

gnutls.deinit(self._c_object)

610

611

def handshake(self):

612

return gnutls.handshake(self._c_object)

613

614

def send(self, data):

615

data = bytes(data)

616

data_len = len(data)

617

while data_len > 0:

618

data_len -= gnutls.record_send(self._c_object,

619

data[-data_len:],

620

data_len)

621

622

def bye(self):

623

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

624

625

# Error handling functions

626

def _error_code(result):

627

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

628

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

629

if result >= 0:

630

return result

631

if result == gnutls.E_NO_CERTIFICATE_FOUND:

632

raise gnutls.CertificateSecurityError(code=result)

633

raise gnutls.Error(code=result)

634

635

def _retry_on_error(result, func, arguments):

636

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

637

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

638

while result < 0:

639

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

640

return _error_code(result)

641

result = func(*arguments)

642

return result

643

644

# Unless otherwise indicated, the function declarations below are

645

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

646

647

# Functions

648

priority_set_direct = _library.gnutls_priority_set_direct

649

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

650

ctypes.POINTER(ctypes.c_char_p)]

651

priority_set_direct.restype = _error_code

652

653

init = _library.gnutls_init

654

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

655

init.restype = _error_code

656

657

set_default_priority = _library.gnutls_set_default_priority

658

set_default_priority.argtypes = [session_t]

659

set_default_priority.restype = _error_code

660

661

record_send = _library.gnutls_record_send

662

record_send.argtypes = [session_t, ctypes.c_void_p,

663

ctypes.c_size_t]

664

record_send.restype = ctypes.c_ssize_t

665

record_send.errcheck = _retry_on_error

666

667

certificate_allocate_credentials = (

668

_library.gnutls_certificate_allocate_credentials)

669

certificate_allocate_credentials.argtypes = [

670

ctypes.POINTER(certificate_credentials_t)]

671

certificate_allocate_credentials.restype = _error_code

672

673

certificate_free_credentials = (

674

_library.gnutls_certificate_free_credentials)

675

certificate_free_credentials.argtypes = [

676

certificate_credentials_t]

677

certificate_free_credentials.restype = None

678

679

handshake_set_private_extensions = (

680

_library.gnutls_handshake_set_private_extensions)

681

handshake_set_private_extensions.argtypes = [session_t,

682

ctypes.c_int]

683

handshake_set_private_extensions.restype = None

684

685

credentials_set = _library.gnutls_credentials_set

686

credentials_set.argtypes = [session_t, credentials_type_t,

687

ctypes.c_void_p]

688

credentials_set.restype = _error_code

689

690

strerror = _library.gnutls_strerror

691

strerror.argtypes = [ctypes.c_int]

692

strerror.restype = ctypes.c_char_p

693

694

certificate_type_get = _library.gnutls_certificate_type_get

695

certificate_type_get.argtypes = [session_t]

696

certificate_type_get.restype = _error_code

697

698

certificate_get_peers = _library.gnutls_certificate_get_peers

699

certificate_get_peers.argtypes = [session_t,

700

ctypes.POINTER(ctypes.c_uint)]

701

certificate_get_peers.restype = ctypes.POINTER(datum_t)

702

703

global_set_log_level = _library.gnutls_global_set_log_level

704

global_set_log_level.argtypes = [ctypes.c_int]

705

global_set_log_level.restype = None

706

707

global_set_log_function = _library.gnutls_global_set_log_function

708

global_set_log_function.argtypes = [log_func]

709

global_set_log_function.restype = None

710

711

deinit = _library.gnutls_deinit

712

deinit.argtypes = [session_t]

713

deinit.restype = None

714

715

handshake = _library.gnutls_handshake

716

handshake.argtypes = [session_t]

717

handshake.restype = _error_code

718

handshake.errcheck = _retry_on_error

719

720

transport_set_ptr = _library.gnutls_transport_set_ptr

721

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

722

transport_set_ptr.restype = None

723

724

bye = _library.gnutls_bye

725

bye.argtypes = [session_t, close_request_t]

726

bye.restype = _error_code

727

bye.errcheck = _retry_on_error

728

729

check_version = _library.gnutls_check_version

730

check_version.argtypes = [ctypes.c_char_p]

731

check_version.restype = ctypes.c_char_p

732

733

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

734

735

openpgp_crt_init = _library.gnutls_openpgp_crt_init

736

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

737

openpgp_crt_init.restype = _error_code

738

739

openpgp_crt_import = _library.gnutls_openpgp_crt_import

740

openpgp_crt_import.argtypes = [openpgp_crt_t,

741

ctypes.POINTER(datum_t),

742

openpgp_crt_fmt_t]

743

openpgp_crt_import.restype = _error_code

744

745

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

746

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

747

ctypes.POINTER(ctypes.c_uint)]

748

openpgp_crt_verify_self.restype = _error_code

749

750

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

751

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

752

openpgp_crt_deinit.restype = None

753

754

openpgp_crt_get_fingerprint = (

755

_library.gnutls_openpgp_crt_get_fingerprint)

756

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

757

ctypes.c_void_p,

758

ctypes.POINTER(

759

ctypes.c_size_t)]

760

openpgp_crt_get_fingerprint.restype = _error_code

761

762

# Remove non-public functions

763

del _error_code, _retry_on_error

764

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

765

gnutls = GnuTLS()

766

767

768

def call_pipe(connection, # : multiprocessing.Connection

769

func, *args, **kwargs):

770

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

771

772

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

773

return value on the provided multiprocessing.Connection.

774

"""

775

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

776

connection.close()

777

778

388

779

class Client(object):

389

780

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

390

781

391

782

Attributes:

392

783

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

393

784

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

395

786

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

396

787

to see if the client lives.

397

788

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

789

checker_callback_tag: a GLib event source tag, or None

399

790

checker_command: string; External command which is run to check

400

791

if client lives. %() expansions are done at

401

792

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

402

793

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

403

checker_initiator_tag: a gobject event source tag, or None

794

checker_initiator_tag: a GLib event source tag, or None

404

795

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

405

796

client_structure: Object describing what attributes a client has

406

797

and is used for storing the client at exit

407

798

current_checker_command: string; current running checker_command

408

disable_initiator_tag: a gobject event source tag, or None

799

disable_initiator_tag: a GLib event source tag, or None

409

800

enabled: bool()

410

801

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

411

802

uniquely identify the client

416

807

last_checker_status: integer between 0 and 255 reflecting exit

417

808

status of last checker. -1 reflects crashed

418

809

checker, -2 means no checker completed yet.

810

last_checker_signal: The signal which killed the last checker, if

811

last_checker_status is -1

419

812

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

420

813

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

421

814

D-Bus identifiers

426

819

runtime_expansions: Allowed attributes for runtime expansion.

427

820

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

428

821

disabled, or None

822

server_settings: The server_settings dict from main()

429

823

"""

430

824

431

825

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

826

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

827

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

828

"last_approval_request", "last_checked_ok",

434

829

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

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

830

client_defaults = {

831

"timeout": "PT5M",

832

"extended_timeout": "PT15M",

833

"interval": "PT2M",

834

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

835

"host": "",

836

"approval_delay": "PT0S",

837

"approval_duration": "PT1S",

838

"approved_by_default": "True",

839

"enabled": "True",

840

}

460

841

461

842

@staticmethod

462

843

def config_parser(config):

470

851

for client_name in config.sections():

471

852

section = dict(config.items(client_name))

472

853

client = settings[client_name] = {}

473

854

474

855

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

475

856

# Reformat values from string types to Python types

476

857

client["approved_by_default"] = config.getboolean(

477

858

client_name, "approved_by_default")

478

859

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

479

860

"enabled")

480

861

862

# Uppercase and remove spaces from fingerprint for later

863

# comparison purposes with return value from the

864

# fingerprint() function

481

865

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

482

866

.replace(" ", ""))

483

867

if "secret" in section:

484

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

868

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

869

.encode("utf-8"),

870

"base64")

485

871

elif "secfile" in section:

486

872

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

487

873

(section["secfile"])),

488

874

"rb") as secfile:

489

875

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

490

876

else:

491

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

492

% section)

877

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

878

.format(section))

493

879

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

494

880

client["extended_timeout"] = string_to_delta(

495

881

section["extended_timeout"])

502

888

client["last_approval_request"] = None

503

889

client["last_checked_ok"] = None

504

890

client["last_checker_status"] = -2

505

891

506

892

return settings

507

508

509

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

510

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

511

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

512

attribute."""

893

894

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

513

895

self.name = name

896

if server_settings is None:

897

server_settings = {}

898

self.server_settings = server_settings

514

899

# adding all client settings

515

for setting, value in settings.iteritems():

900

for setting, value in settings.items():

516

901

setattr(self, setting, value)

517

902

518

903

if self.enabled:

519

904

if not hasattr(self, "last_enabled"):

520

905

self.last_enabled = datetime.datetime.utcnow()

524

909

else:

525

910

self.last_enabled = None

526

911

self.expires = None

527

912

528

913

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

532

914

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

533

915

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

534

916

datetime.datetime.utcnow())

541

923

self.current_checker_command = None

542

924

self.approved = None

543

925

self.approvals_pending = 0

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

926

self.changedstate = multiprocessing_manager.Condition(

927

multiprocessing_manager.Lock())

928

self.client_structure = [attr

929

for attr in self.__dict__.keys()

549

930

if not attr.startswith("_")]

550

931

self.client_structure.append("client_structure")

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

932

933

for name, t in inspect.getmembers(

934

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

556

935

if not name.startswith("_"):

557

936

self.client_structure.append(name)

558

937

559

938

# Send notice to process children that client state has changed

560

939

def send_changedstate(self):

561

940

with self.changedstate:

562

941

self.changedstate.notify_all()

563

942

564

943

def enable(self):

565

944

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

566

945

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

567

946

# Already enabled

568

947

return

569

self.send_changedstate()

570

948

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

571

949

self.enabled = True

572

950

self.last_enabled = datetime.datetime.utcnow()

573

951

self.init_checker()

574

952

self.send_changedstate()

953

575

954

def disable(self, quiet=True):

576

955

"""Disable this client."""

577

956

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

578

957

return False

579

958

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

959

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

583

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

584

gobject.source_remove(self.disable_initiator_tag)

960

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

961

GLib.source_remove(self.disable_initiator_tag)

585

962

self.disable_initiator_tag = None

586

963

self.expires = None

587

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

588

gobject.source_remove(self.checker_initiator_tag)

964

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

965

GLib.source_remove(self.checker_initiator_tag)

589

966

self.checker_initiator_tag = None

590

967

self.stop_checker()

591

968

self.enabled = False

592

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

969

if not quiet:

970

self.send_changedstate()

971

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

593

972

return False

594

973

595

974

def __del__(self):

596

975

self.disable()

597

976

598

977

def init_checker(self):

599

978

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

600

979

# and every interval from then on.

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

980

if self.checker_initiator_tag is not None:

981

GLib.source_remove(self.checker_initiator_tag)

982

self.checker_initiator_tag = GLib.timeout_add(

983

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

984

self.start_checker)

604

985

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

986

if self.disable_initiator_tag is not None:

987

GLib.source_remove(self.disable_initiator_tag)

988

self.disable_initiator_tag = GLib.timeout_add(

989

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

608

990

# Also start a new checker *right now*.

609

991

self.start_checker()

610

611

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

992

993

def checker_callback(self, source, condition, connection,

994

command):

612

995

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

613

996

self.checker_callback_tag = None

614

997

self.checker = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

998

# Read return code from connection (see call_pipe)

999

returncode = connection.recv()

1000

connection.close()

1001

1002

if returncode >= 0:

1003

self.last_checker_status = returncode

1004

self.last_checker_signal = None

617

1005

if self.last_checker_status == 0:

618

1006

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

619

1007

vars(self))

620

1008

self.checked_ok()

621

1009

else:

622

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

623

vars(self))

1010

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

624

1011

else:

625

1012

self.last_checker_status = -1

1013

self.last_checker_signal = -returncode

626

1014

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

627

1015

vars(self))

628

1016

return False

1017

629

1018

def checked_ok(self):

630

1019

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

631

1020

self.last_checked_ok = datetime.datetime.utcnow()

632

1021

self.last_checker_status = 0

1022

self.last_checker_signal = None

633

1023

self.bump_timeout()

634

1024

635

1025

def bump_timeout(self, timeout=None):

636

1026

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

637

1027

if timeout is None:

638

1028

timeout = self.timeout

639

1029

if self.disable_initiator_tag is not None:

640

gobject.source_remove(self.disable_initiator_tag)

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = None

641

1032

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

642

self.disable_initiator_tag = (gobject.timeout_add

643

(timedelta_to_milliseconds

644

(timeout), self.disable))

1033

self.disable_initiator_tag = GLib.timeout_add(

1034

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

645

1035

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

646

1036

647

1037

def need_approval(self):

648

1038

self.last_approval_request = datetime.datetime.utcnow()

649

1039

650

1040

def start_checker(self):

651

1041

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

652

1042

653

1043

If a checker already exists, leave it running and do

654

1044

nothing."""

655

1045

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

656

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

657

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

658

# client would inevitably timeout, since no checker would get

659

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

1046

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

1047

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

1048

# would inevitably timeout, since no checker would get a

1049

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

660

1050

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

661

1051

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

662

1052

# should be.

663

664

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

665

try:

666

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

667

except (AttributeError, OSError) as error:

668

if (isinstance(error, OSError)

669

and error.errno != errno.ECHILD):

670

raise error

671

else:

672

if pid:

673

logger.warning("Checker was a zombie")

674

gobject.source_remove(self.checker_callback_tag)

675

self.checker_callback(pid, status,

676

self.current_checker_command)

1053

1054

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

1055

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

1056

self.checker.join()

1057

self.checker = None

677

1058

# Start a new checker if needed

678

1059

if self.checker is None:

1060

# Escape attributes for the shell

1061

escaped_attrs = {

1062

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

1063

for attr in self.runtime_expansions}

679

1064

try:

680

# In case checker_command has exactly one % operator

681

command = self.checker_command % self.host

682

except TypeError:

683

# Escape attributes for the shell

684

escaped_attrs = dict(

685

(attr,

686

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

687

errors=

688

'replace')))

689

for attr in

690

self.runtime_expansions)

691

692

try:

693

command = self.checker_command % escaped_attrs

694

except TypeError as error:

695

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

696

' %s', self.checker_command, error)

697

return True # Try again later

1065

command = self.checker_command % escaped_attrs

1066

except TypeError as error:

1067

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

1068

self.checker_command,

1069

exc_info=error)

1070

return True # Try again later

698

1071

self.current_checker_command = command

699

try:

700

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

701

command, self.name)

702

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

703

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

704

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

705

# always replaced by /dev/null.)

706

self.checker = subprocess.Popen(command,

707

close_fds=True,

708

shell=True, cwd="/")

709

self.checker_callback_tag = (gobject.child_watch_add

710

(self.checker.pid,

711

self.checker_callback,

712

data=command))

713

# The checker may have completed before the gobject

714

# watch was added. Check for this.

715

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

716

if pid:

717

gobject.source_remove(self.checker_callback_tag)

718

self.checker_callback(pid, status, command)

719

except OSError as error:

720

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

721

error)

722

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

1072

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

1073

self.name)

1074

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

1075

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

1076

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

1077

# always replaced by /dev/null.)

1078

# The exception is when not debugging but nevertheless

1079

# running in the foreground; use the previously

1080

# created wnull.

1081

popen_args = {"close_fds": True,

1082

"shell": True,

1083

"cwd": "/"}

1084

if (not self.server_settings["debug"]

1085

and self.server_settings["foreground"]):

1086

popen_args.update({"stdout": wnull,

1087

"stderr": wnull})

1088

pipe = multiprocessing.Pipe(duplex=False)

1089

self.checker = multiprocessing.Process(

1090

target=call_pipe,

1091

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

1092

kwargs=popen_args)

1093

self.checker.start()

1094

self.checker_callback_tag = GLib.io_add_watch(

1095

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

1096

self.checker_callback, pipe[0], command)

1097

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

723

1098

return True

724

1099

725

1100

def stop_checker(self):

726

1101

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

727

1102

if self.checker_callback_tag:

728

gobject.source_remove(self.checker_callback_tag)

1103

GLib.source_remove(self.checker_callback_tag)

729

1104

self.checker_callback_tag = None

730

1105

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

731

1106

return

732

1107

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

733

try:

734

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

735

#time.sleep(0.5)

736

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

737

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

738

except OSError as error:

739

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

740

raise

1108

self.checker.terminate()

741

1109

self.checker = None

742

1110

743

1111

744

def dbus_service_property(dbus_interface, signature="v",

745

access="readwrite", byte_arrays=False):

1112

def dbus_service_property(dbus_interface,

1113

signature="v",

1114

access="readwrite",

1115

byte_arrays=False):

746

1116

"""Decorators for marking methods of a DBusObjectWithProperties to

747

1117

become properties on the D-Bus.

748

1118

749

1119

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

750

1120

and with one argument by "Set".

751

1121

752

1122

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

753

1123

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

754

1124

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

757

1127

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

758

1128

if byte_arrays and signature != "ay":

759

1129

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

760

" signature %r" % signature)

1130

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

1131

761

1132

def decorator(func):

762

1133

func._dbus_is_property = True

763

1134

func._dbus_interface = dbus_interface

766

1137

func._dbus_name = func.__name__

767

1138

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

768

1139

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

769

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

770

return func

1140

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1141

return func

1142

1143

return decorator

1144

1145

1146

def dbus_interface_annotations(dbus_interface):

1147

"""Decorator for marking functions returning interface annotations

1148

1149

Usage:

1150

1151

@dbus_interface_annotations("org.example.Interface")

1152

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

1153

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

1154

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

1155

"false"}

1156

"""

1157

1158

def decorator(func):

1159

func._dbus_is_interface = True

1160

func._dbus_interface = dbus_interface

1161

func._dbus_name = dbus_interface

1162

return func

1163

1164

return decorator

1165

1166

1167

def dbus_annotations(annotations):

1168

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

1169

Usage:

1170

1171

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

1172

"org.freedesktop.DBus.Property."

1173

"EmitsChangedSignal": "false"})

1174

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

1175

access="r")

1176

def Property_dbus_property(self):

1177

return dbus.Boolean(False)

1178

1179

See also the DBusObjectWithAnnotations class.

1180

"""

1181

1182

def decorator(func):

1183

func._dbus_annotations = annotations

1184

return func

1185

771

1186

return decorator

772

1187

773

1188

774

1189

class DBusPropertyException(dbus.exceptions.DBusException):

775

1190

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

776

1191

"""

777

def __unicode__(self):

778

return unicode(str(self))

1192

pass

779

1193

780

1194

781

1195

class DBusPropertyAccessException(DBusPropertyException):

790

1204

pass

791

1205

792

1206

793

class DBusObjectWithProperties(dbus.service.Object):

1207

class DBusObjectWithAnnotations(dbus.service.Object):

1208

"""A D-Bus object with annotations.

1209

1210

Classes inheriting from this can use the dbus_annotations

1211

decorator to add annotations to methods or signals.

1212

"""

1213

1214

@staticmethod

1215

def _is_dbus_thing(thing):

1216

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

1217

1218

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

1219

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

1220

"""

1221

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

1222

False)

1223

1224

def _get_all_dbus_things(self, thing):

1225

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

1226

"""

1227

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

1228

athing.__get__(self))

1229

for cls in self.__class__.__mro__

1230

for name, athing in

1231

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

1232

1233

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1234

out_signature="s",

1235

path_keyword='object_path',

1236

connection_keyword='connection')

1237

def Introspect(self, object_path, connection):

1238

"""Overloading of standard D-Bus method.

1239

1240

Inserts annotation tags on methods and signals.

1241

"""

1242

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

1243

connection)

1244

try:

1245

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

1246

1247

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

1248

# Add annotation tags

1249

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

1250

for tag in if_tag.getElementsByTagName(typ):

1251

annots = dict()

1252

for name, prop in (self.

1253

_get_all_dbus_things(typ)):

1254

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

1255

and prop._dbus_interface

1256

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

1257

annots.update(getattr(

1258

prop, "_dbus_annotations", {}))

1259

for name, value in annots.items():

1260

ann_tag = document.createElement(

1261

"annotation")

1262

ann_tag.setAttribute("name", name)

1263

ann_tag.setAttribute("value", value)

1264

tag.appendChild(ann_tag)

1265

# Add interface annotation tags

1266

for annotation, value in dict(

1267

itertools.chain.from_iterable(

1268

annotations().items()

1269

for name, annotations

1270

in self._get_all_dbus_things("interface")

1271

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

1272

)).items():

1273

ann_tag = document.createElement("annotation")

1274

ann_tag.setAttribute("name", annotation)

1275

ann_tag.setAttribute("value", value)

1276

if_tag.appendChild(ann_tag)

1277

# Fix argument name for the Introspect method itself

1278

if (if_tag.getAttribute("name")

1279

== dbus.INTROSPECTABLE_IFACE):

1280

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

1281

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

1282

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

1283

if (arg.getAttribute("direction")

1284

== "out"):

1285

arg.setAttribute("name",

1286

"xml_data")

1287

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

1288

document.unlink()

1289

except (AttributeError, xml.dom.DOMException,

1290

xml.parsers.expat.ExpatError) as error:

1291

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

1292

exc_info=error)

1293

return xmlstring

1294

1295

1296

class DBusObjectWithProperties(DBusObjectWithAnnotations):

794

1297

"""A D-Bus object with properties.

795

1298

796

1299

Classes inheriting from this can use the dbus_service_property

797

1300

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

798

1301

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

799

1302

"""

800

801

@staticmethod

802

def _is_dbus_property(obj):

803

return getattr(obj, "_dbus_is_property", False)

804

805

def _get_all_dbus_properties(self):

806

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

807

"""

808

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

809

for cls in self.__class__.__mro__

810

for name, prop in

811

inspect.getmembers(cls, self._is_dbus_property))

812

1303

813

1304

def _get_dbus_property(self, interface_name, property_name):

814

1305

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

815

1306

property with the specified name and interface.

816

1307

"""

817

for cls in self.__class__.__mro__:

818

for name, value in (inspect.getmembers

819

(cls, self._is_dbus_property)):

1308

for cls in self.__class__.__mro__:

1309

for name, value in inspect.getmembers(

1310

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

820

1311

if (value._dbus_name == property_name

821

1312

and value._dbus_interface == interface_name):

822

1313

return value.__get__(self)

823

1314

824

1315

# No such property

825

raise DBusPropertyNotFound(self.dbus_object_path + ":"

826

+ interface_name + "."

827

+ property_name)

828

829

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

1316

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

1317

self.dbus_object_path, interface_name, property_name))

1318

1319

@classmethod

1320

def _get_all_interface_names(cls):

1321

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

1322

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

1323

"_dbus_interface", None)

1324

for x in (inspect.getmro(cls))

1325

for attr in dir(x))

1326

if name is not None)

1327

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

in_signature="ss",

830

1330

out_signature="v")

831

1331

def Get(self, interface_name, property_name):

832

1332

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

838

1338

if not hasattr(value, "variant_level"):

839

1339

return value

840

1340

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

841

1341

842

1342

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

843

1343

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

844

1344

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

850

1350

# The byte_arrays option is not supported yet on

851

1351

# signatures other than "ay".

852

1352

if prop._dbus_signature != "ay":

853

raise ValueError

1353

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

1354

"'ay' signature {!r}"

1355

.format(prop._dbus_signature))

854

1356

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

855

1357

for byte in value))

856

1358

prop(value)

857

858

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

1359

1360

@dbus.service.method(dbus.PROPERTIES_IFACE,

1361

in_signature="s",

859

1362

out_signature="a{sv}")

860

1363

def GetAll(self, interface_name):

861

1364

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

862

1365

standard.

863

1366

864

1367

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

865

1368

"""

866

1369

properties = {}

867

for name, prop in self._get_all_dbus_properties():

1370

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

868

1371

if (interface_name

869

1372

and interface_name != prop._dbus_interface):

870

1373

# Interface non-empty but did not match

876

1379

if not hasattr(value, "variant_level"):

877

1380

properties[name] = value

878

1381

continue

879

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

880

value.variant_level+1)

1382

properties[name] = type(value)(

1383

value, variant_level=value.variant_level + 1)

881

1384

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

882

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

883

1394

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

884

1395

out_signature="s",

885

1396

path_keyword='object_path',

886

1397

connection_keyword='connection')

887

1398

def Introspect(self, object_path, connection):

888

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

1399

"""Overloading of standard D-Bus method.

1400

1401

Inserts property tags and interface annotation tags.

889

1402

"""

890

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

891

connection)

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

892

1406

try:

893

1407

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

1408

894

1409

def make_tag(document, name, prop):

895

1410

e = document.createElement("property")

896

1411

e.setAttribute("name", name)

897

1412

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

898

1413

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

899

1414

return e

1415

900

1416

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

1417

# Add property tags

901

1418

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

902

1419

for name, prop

903

in self._get_all_dbus_properties()

1420

in self._get_all_dbus_things("property")

904

1421

if prop._dbus_interface

905

1422

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

906

1423

if_tag.appendChild(tag)

1424

# Add annotation tags for properties

1425

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

1426

annots = dict()

1427

for name, prop in self._get_all_dbus_things(

1428

"property"):

1429

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

1430

and prop._dbus_interface

1431

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

1432

annots.update(getattr(

1433

prop, "_dbus_annotations", {}))

1434

for name, value in annots.items():

1435

ann_tag = document.createElement(

1436

"annotation")

1437

ann_tag.setAttribute("name", name)

1438

ann_tag.setAttribute("value", value)

1439

tag.appendChild(ann_tag)

907

1440

# Add the names to the return values for the

908

1441

# "org.freedesktop.DBus.Properties" methods

909

1442

if (if_tag.getAttribute("name")

924

1457

except (AttributeError, xml.dom.DOMException,

925

1458

xml.parsers.expat.ExpatError) as error:

926

1459

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

927

error)

928

return xmlstring

929

930

931

def datetime_to_dbus (dt, variant_level=0):

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

932

1536

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

933

1537

if dt is None:

934

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

935

return dbus.String(dt.isoformat(),

936

variant_level=variant_level)

937

938

939

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

940

.__metaclass__):

941

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

942

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

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

943

1564

"""

944

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

945

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

946

# methods, signals, or properties in them

947

for base in (b for b in bases

948

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

949

# Go though all attributes of the base class

950

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

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

951

1573

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

952

1574

# with the wrong interface name

953

1575

if (not hasattr(attribute, "_dbus_interface")

954

or not attribute._dbus_interface

955

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

1576

or not attribute._dbus_interface.startswith(

1577

orig_interface_name)):

956

1578

continue

957

1579

# Create an alternate D-Bus interface name based on

958

1580

# the current name

959

alt_interface = (attribute._dbus_interface

960

.replace("se.recompile.Mandos",

961

"se.bsnet.fukt.Mandos"))

1581

alt_interface = attribute._dbus_interface.replace(

1582

orig_interface_name, alt_interface_name)

1583

interface_names.add(alt_interface)

962

1584

# Is this a D-Bus signal?

963

1585

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

964

# Extract the original non-method function by

965

# black magic

966

nonmethod_func = (dict(

1586

# Extract the original non-method undecorated

1587

# function by black magic

1588

if sys.version_info.major == 2:

1589

nonmethod_func = (dict(

967

1590

zip(attribute.func_code.co_freevars,

968

attribute.__closure__))["func"]

969

.cell_contents)

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)

970

1598

# Create a new, but exactly alike, function

971

1599

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

972

1600

# with the alternate D-Bus interface name

973

new_function = (dbus.service.signal

974

(alt_interface,

975

attribute._dbus_signature)

976

(types.FunctionType(

977

nonmethod_func.func_code,

978

nonmethod_func.func_globals,

979

nonmethod_func.func_name,

980

nonmethod_func.func_defaults,

981

nonmethod_func.func_closure)))

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

982

1612

# Define a creator of a function to call both the

983

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

984

# signals gets sent when the function is called

1613

# original and alternate functions, so both the

1614

# original and alternate signals gets sent when

1615

# the function is called

985

1616

def fixscope(func1, func2):

986

1617

"""This function is a scope container to pass

987

1618

func1 and func2 to the "call_both" function

988

1619

outside of its arguments"""

1620

1621

@functools.wraps(func2)

989

1622

def call_both(*args, **kwargs):

990

1623

"""This function will emit two D-Bus

991

1624

signals by calling func1 and func2"""

992

1625

func1(*args, **kwargs)

993

1626

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

994

1633

return call_both

995

1634

# Create the "call_both" function and add it to

996

1635

# the class

997

attr[attrname] = fixscope(attribute,

998

new_function)

1636

attr[attrname] = fixscope(attribute, new_function)

999

1637

# Is this a D-Bus method?

1000

1638

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

1001

1639

# Create a new, but exactly alike, function

1002

1640

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

1003

1641

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

1004

1642

# to the class.

1005

attr[attrname] = (dbus.service.method

1006

(alt_interface,

1007

attribute._dbus_in_signature,

1008

attribute._dbus_out_signature)

1009

(types.FunctionType

1010

(attribute.func_code,

1011

attribute.func_globals,

1012

attribute.func_name,

1013

attribute.func_defaults,

1014

attribute.func_closure)))

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

1015

1655

# Is this a D-Bus property?

1016

1656

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

1017

1657

# Create a new, but exactly alike, function

1018

1658

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

1019

1659

# property with the alternate D-Bus interface

1020

1660

# name. Add it to the class.

1021

attr[attrname] = (dbus_service_property

1022

(alt_interface,

1023

attribute._dbus_signature,

1024

attribute._dbus_access,

1025

attribute

1026

._dbus_get_args_options

1027

["byte_arrays"])

1028

(types.FunctionType

1029

(attribute.func_code,

1030

attribute.func_globals,

1031

attribute.func_name,

1032

attribute.func_defaults,

1033

attribute.func_closure)))

1034

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

1035

1036

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

1037

1713

class ClientDBus(Client, DBusObjectWithProperties):

1038

1714

"""A Client class using D-Bus

1039

1715

1040

1716

Attributes:

1041

1717

dbus_object_path: dbus.ObjectPath

1042

1718

bus: dbus.SystemBus()

1043

1719

"""

1044

1720

1045

1721

runtime_expansions = (Client.runtime_expansions

1046

+ ("dbus_object_path",))

1047

1722

+ ("dbus_object_path", ))

1723

1724

_interface = "se.recompile.Mandos.Client"

1725

1048

1726

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

1049

1050

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

1727

1728

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

1051

1729

self.bus = bus

1052

1730

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

1053

1731

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

1054

1732

# the D-Bus

1055

client_object_name = unicode(self.name).translate(

1733

client_object_name = str(self.name).translate(

1056

1734

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

1057

1735

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

1058

self.dbus_object_path = (dbus.ObjectPath

1059

("/clients/" + client_object_name))

1736

self.dbus_object_path = dbus.ObjectPath(

1737

"/clients/" + client_object_name)

1060

1738

DBusObjectWithProperties.__init__(self, self.bus,

1061

1739

self.dbus_object_path)

1062

1063

def notifychangeproperty(transform_func,

1064

dbus_name, type_func=lambda x: x,

1065

variant_level=1):

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

1066

1746

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

1067

1747

its changes to DBus.

1068

1748

1069

1749

transform_fun: Function that takes a value and a variant_level

1070

1750

and transforms it to a D-Bus type.

1071

1751

dbus_name: D-Bus name of the variable

1073

1753

to the D-Bus. Default: no transform

1074

1754

variant_level: D-Bus variant level. Default: 1

1075

1755

"""

1076

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

1756

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

1757

1077

1758

def setter(self, value):

1078

1759

if hasattr(self, "dbus_object_path"):

1079

1760

if (not hasattr(self, attrname) or

1080

1761

type_func(getattr(self, attrname, None))

1081

1762

!= type_func(value)):

1082

dbus_value = transform_func(type_func(value),

1083

variant_level

1084

=variant_level)

1085

self.PropertyChanged(dbus.String(dbus_name),

1086

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

1087

1778

setattr(self, attrname, value)

1088

1779

1089

1780

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

1090

1091

1781

1092

1782

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1093

1783

approvals_pending = notifychangeproperty(dbus.Boolean,

1094

1784

"ApprovalPending",

1095

type_func = bool)

1785

type_func=bool)

1096

1786

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

1097

1787

last_enabled = notifychangeproperty(datetime_to_dbus,

1098

1788

"LastEnabled")

1099

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

1100

type_func = lambda checker:

1101

checker is not None)

1789

checker = notifychangeproperty(

1790

dbus.Boolean, "CheckerRunning",

1791

type_func=lambda checker: checker is not None)

1102

1792

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1103

1793

"LastCheckedOK")

1104

1794

last_checker_status = notifychangeproperty(dbus.Int16,

1107

1797

datetime_to_dbus, "LastApprovalRequest")

1108

1798

approved_by_default = notifychangeproperty(dbus.Boolean,

1109

1799

"ApprovedByDefault")

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1800

approval_delay = notifychangeproperty(

1801

dbus.UInt64, "ApprovalDelay",

1802

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

1114

1803

approval_duration = notifychangeproperty(

1115

1804

dbus.UInt64, "ApprovalDuration",

1116

type_func = timedelta_to_milliseconds)

1805

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

1117

1806

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1807

timeout = notifychangeproperty(

1808

dbus.UInt64, "Timeout",

1809

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

1121

1810

extended_timeout = notifychangeproperty(

1122

1811

dbus.UInt64, "ExtendedTimeout",

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

timedelta_to_milliseconds)

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)

1128

1816

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

1129

1817

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

1818

invalidate_only=True)

1819

1130

1820

del notifychangeproperty

1131

1821

1132

1822

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

1133

1823

try:

1134

1824

self.remove_from_connection()

1137

1827

if hasattr(DBusObjectWithProperties, "__del__"):

1138

1828

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

1139

1829

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

1140

1141

def checker_callback(self, pid, condition, command,

1142

*args, **kwargs):

1143

self.checker_callback_tag = None

1144

self.checker = None

1145

if os.WIFEXITED(condition):

1146

exitstatus = os.WEXITSTATUS(condition)

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:

1147

1838

# Emit D-Bus signal

1148

1839

self.CheckerCompleted(dbus.Int16(exitstatus),

1149

dbus.Int64(condition),

1840

# This is specific to GNU libC

1841

dbus.Int64(exitstatus << 8),

1150

1842

dbus.String(command))

1151

1843

else:

1152

1844

# Emit D-Bus signal

1153

1845

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

1154

dbus.Int64(condition),

1846

dbus.Int64(

1847

# This is specific to GNU libC

1848

(exitstatus << 8)

1849

| self.last_checker_signal),

1155

1850

dbus.String(command))

1156

1157

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

1158

*args, **kwargs)

1159

1851

return ret

1852

1160

1853

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

1161

old_checker = self.checker

1162

if self.checker is not None:

1163

old_checker_pid = self.checker.pid

1164

else:

1165

old_checker_pid = None

1854

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

1166

1855

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

1167

1856

# Only if new checker process was started

1168

1857

if (self.checker is not None

1170

1859

# Emit D-Bus signal

1171

1860

self.CheckerStarted(self.current_checker_command)

1172

1861

return r

1173

1862

1174

1863

def _reset_approved(self):

1175

1864

self.approved = None

1176

1865

return False

1177

1866

1178

1867

def approve(self, value=True):

1179

self.send_changedstate()

1180

1868

self.approved = value

1181

gobject.timeout_add(timedelta_to_milliseconds

1182

(self.approval_duration),

1183

self._reset_approved)

1184

1185

1186

## D-Bus methods, signals & properties

1187

_interface = "se.recompile.Mandos.Client"

1188

1189

## Signals

1190

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

1191

1879

# CheckerCompleted - signal

1192

1880

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

1193

1881

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

1194

1882

"D-Bus signal"

1195

1883

pass

1196

1884

1197

1885

# CheckerStarted - signal

1198

1886

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

1199

1887

def CheckerStarted(self, command):

1200

1888

"D-Bus signal"

1201

1889

pass

1202

1890

1203

1891

# PropertyChanged - signal

1892

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

1204

1893

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

1205

1894

def PropertyChanged(self, property, value):

1206

1895

"D-Bus signal"

1207

1896

pass

1208

1897

1209

1898

# GotSecret - signal

1210

1899

@dbus.service.signal(_interface)

1211

1900

def GotSecret(self):

1214

1903

server to mandos-client

1215

1904

"""

1216

1905

pass

1217

1906

1218

1907

# Rejected - signal

1219

1908

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

1220

1909

def Rejected(self, reason):

1221

1910

"D-Bus signal"

1222

1911

pass

1223

1912

1224

1913

# NeedApproval - signal

1225

1914

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

1226

1915

def NeedApproval(self, timeout, default):

1227

1916

"D-Bus signal"

1228

1917

return self.need_approval()

1229

1230

## Methods

1231

1918

1919

# Methods

1920

1232

1921

# Approve - method

1233

1922

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

1234

1923

def Approve(self, value):

1235

1924

self.approve(value)

1236

1925

1237

1926

# CheckedOK - method

1238

1927

@dbus.service.method(_interface)

1239

1928

def CheckedOK(self):

1240

1929

self.checked_ok()

1241

1930

1242

1931

# Enable - method

1932

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

1243

1933

@dbus.service.method(_interface)

1244

1934

def Enable(self):

1245

1935

"D-Bus method"

1246

1936

self.enable()

1247

1937

1248

1938

# StartChecker - method

1939

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

1249

1940

@dbus.service.method(_interface)

1250

1941

def StartChecker(self):

1251

1942

"D-Bus method"

1252

1943

self.start_checker()

1253

1944

1254

1945

# Disable - method

1946

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

1255

1947

@dbus.service.method(_interface)

1256

1948

def Disable(self):

1257

1949

"D-Bus method"

1258

1950

self.disable()

1259

1951

1260

1952

# StopChecker - method

1953

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

1261

1954

@dbus.service.method(_interface)

1262

1955

def StopChecker(self):

1263

1956

self.stop_checker()

1264

1265

## Properties

1266

1957

1958

# Properties

1959

1267

1960

# ApprovalPending - property

1268

1961

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

1269

1962

def ApprovalPending_dbus_property(self):

1270

1963

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

1271

1964

1272

1965

# ApprovedByDefault - property

1273

@dbus_service_property(_interface, signature="b",

1966

@dbus_service_property(_interface,

1967

signature="b",

1274

1968

access="readwrite")

1275

1969

def ApprovedByDefault_dbus_property(self, value=None):

1276

1970

if value is None: # get

1277

1971

return dbus.Boolean(self.approved_by_default)

1278

1972

self.approved_by_default = bool(value)

1279

1973

1280

1974

# ApprovalDelay - property

1281

@dbus_service_property(_interface, signature="t",

1975

@dbus_service_property(_interface,

1976

signature="t",

1282

1977

access="readwrite")

1283

1978

def ApprovalDelay_dbus_property(self, value=None):

1284

1979

if value is None: # get

1285

return dbus.UInt64(self.approval_delay_milliseconds())

1980

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

1981

* 1000)

1286

1982

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

1287

1983

1288

1984

# ApprovalDuration - property

1289

@dbus_service_property(_interface, signature="t",

1985

@dbus_service_property(_interface,

1986

signature="t",

1290

1987

access="readwrite")

1291

1988

def ApprovalDuration_dbus_property(self, value=None):

1292

1989

if value is None: # get

1293

return dbus.UInt64(timedelta_to_milliseconds(

1294

self.approval_duration))

1990

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

1991

* 1000)

1295

1992

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

1296

1993

1297

1994

# Name - property

1995

@dbus_annotations(

1996

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

1298

1997

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

1299

1998

def Name_dbus_property(self):

1300

1999

return dbus.String(self.name)

1301

2000

1302

2001

# Fingerprint - property

2002

@dbus_annotations(

2003

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

1303

2004

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

1304

2005

def Fingerprint_dbus_property(self):

1305

2006

return dbus.String(self.fingerprint)

1306

2007

1307

2008

# Host - property

1308

@dbus_service_property(_interface, signature="s",

2009

@dbus_service_property(_interface,

2010

signature="s",

1309

2011

access="readwrite")

1310

2012

def Host_dbus_property(self, value=None):

1311

2013

if value is None: # get

1312

2014

return dbus.String(self.host)

1313

self.host = unicode(value)

1314

2015

self.host = str(value)

2016

1315

2017

# Created - property

2018

@dbus_annotations(

2019

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

1316

2020

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

1317

2021

def Created_dbus_property(self):

1318

2022

return datetime_to_dbus(self.created)

1319

2023

1320

2024

# LastEnabled - property

1321

2025

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

1322

2026

def LastEnabled_dbus_property(self):

1323

2027

return datetime_to_dbus(self.last_enabled)

1324

2028

1325

2029

# Enabled - property

1326

@dbus_service_property(_interface, signature="b",

2030

@dbus_service_property(_interface,

2031

signature="b",

1327

2032

access="readwrite")

1328

2033

def Enabled_dbus_property(self, value=None):

1329

2034

if value is None: # get

1332

2037

self.enable()

1333

2038

else:

1334

2039

self.disable()

1335

2040

1336

2041

# LastCheckedOK - property

1337

@dbus_service_property(_interface, signature="s",

2042

@dbus_service_property(_interface,

2043

signature="s",

1338

2044

access="readwrite")

1339

2045

def LastCheckedOK_dbus_property(self, value=None):

1340

2046

if value is not None:

1341

2047

self.checked_ok()

1342

2048

return

1343

2049

return datetime_to_dbus(self.last_checked_ok)

1344

2050

1345

2051

# LastCheckerStatus - property

1346

@dbus_service_property(_interface, signature="n",

1347

access="read")

2052

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

1348

2053

def LastCheckerStatus_dbus_property(self):

1349

2054

return dbus.Int16(self.last_checker_status)

1350

2055

1351

2056

# Expires - property

1352

2057

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

1353

2058

def Expires_dbus_property(self):

1354

2059

return datetime_to_dbus(self.expires)

1355

2060

1356

2061

# LastApprovalRequest - property

1357

2062

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

1358

2063

def LastApprovalRequest_dbus_property(self):

1359

2064

return datetime_to_dbus(self.last_approval_request)

1360

2065

1361

2066

# Timeout - property

1362

@dbus_service_property(_interface, signature="t",

2067

@dbus_service_property(_interface,

2068

signature="t",

1363

2069

access="readwrite")

1364

2070

def Timeout_dbus_property(self, value=None):

1365

2071

if value is None: # get

1366

return dbus.UInt64(self.timeout_milliseconds())

2072

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

2073

old_timeout = self.timeout

1367

2074

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

1368

# Reschedule timeout

2075

# Reschedule disabling

1369

2076

if self.enabled:

1370

2077

now = datetime.datetime.utcnow()

1371

time_to_die = timedelta_to_milliseconds(

1372

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

1373

if time_to_die <= 0:

2078

self.expires += self.timeout - old_timeout

2079

if self.expires <= now:

1374

2080

# The timeout has passed

1375

2081

self.disable()

1376

2082

else:

1377

self.expires = (now +

1378

datetime.timedelta(milliseconds =

1379

time_to_die))

1380

2083

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

1381

2084

is None):

1382

2085

return

1383

gobject.source_remove(self.disable_initiator_tag)

1384

self.disable_initiator_tag = (gobject.timeout_add

1385

(time_to_die,

1386

self.disable))

1387

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

1388

2091

# ExtendedTimeout - property

1389

@dbus_service_property(_interface, signature="t",

2092

@dbus_service_property(_interface,

2093

signature="t",

1390

2094

access="readwrite")

1391

2095

def ExtendedTimeout_dbus_property(self, value=None):

1392

2096

if value is None: # get

1393

return dbus.UInt64(self.extended_timeout_milliseconds())

2097

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

2098

* 1000)

1394

2099

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

1395

2100

1396

2101

# Interval - property

1397

@dbus_service_property(_interface, signature="t",

2102

@dbus_service_property(_interface,

2103

signature="t",

1398

2104

access="readwrite")

1399

2105

def Interval_dbus_property(self, value=None):

1400

2106

if value is None: # get

1401

return dbus.UInt64(self.interval_milliseconds())

2107

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

1402

2108

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

1403

2109

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

1404

2110

return

1405

2111

if self.enabled:

1406

2112

# Reschedule checker run

1407

gobject.source_remove(self.checker_initiator_tag)

1408

self.checker_initiator_tag = (gobject.timeout_add

1409

(value, self.start_checker))

1410

self.start_checker() # Start one now, too

1411

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

1412

2118

# Checker - property

1413

@dbus_service_property(_interface, signature="s",

2119

@dbus_service_property(_interface,

2120

signature="s",

1414

2121

access="readwrite")

1415

2122

def Checker_dbus_property(self, value=None):

1416

2123

if value is None: # get

1417

2124

return dbus.String(self.checker_command)

1418

self.checker_command = unicode(value)

1419

2125

self.checker_command = str(value)

2126

1420

2127

# CheckerRunning - property

1421

@dbus_service_property(_interface, signature="b",

2128

@dbus_service_property(_interface,

2129

signature="b",

1422

2130

access="readwrite")

1423

2131

def CheckerRunning_dbus_property(self, value=None):

1424

2132

if value is None: # get

1427

2135

self.start_checker()

1428

2136

else:

1429

2137

self.stop_checker()

1430

2138

1431

2139

# ObjectPath - property

2140

@dbus_annotations(

2141

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

2142

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

1432

2143

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

1433

2144

def ObjectPath_dbus_property(self):

1434

return self.dbus_object_path # is already a dbus.ObjectPath

1435

2145

return self.dbus_object_path # is already a dbus.ObjectPath

2146

1436

2147

# Secret = property

1437

@dbus_service_property(_interface, signature="ay",

1438

access="write", byte_arrays=True)

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

2155

def Secret_dbus_property(self, value):

1440

self.secret = str(value)

1441

2156

self.secret = bytes(value)

2157

1442

2158

del _interface

1443

2159

1444

2160

1447

2163

self._pipe = child_pipe

1448

2164

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

1449

2165

if not self._pipe.recv():

1450

raise KeyError()

1451

2166

raise KeyError(fpr)

2167

1452

2168

def __getattribute__(self, name):

1453

2169

if name == '_pipe':

1454

2170

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

1457

2173

if data[0] == 'data':

1458

2174

return data[1]

1459

2175

if data[0] == 'function':

2176

1460

2177

def func(*args, **kwargs):

1461

2178

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

1462

2179

return self._pipe.recv()[1]

2180

1463

2181

return func

1464

2182

1465

2183

def __setattr__(self, name, value):

1466

2184

if name == '_pipe':

1467

2185

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

1468

2186

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

1469

2187

1470

2188

1471

class ClientDBusTransitional(ClientDBus):

1472

__metaclass__ = AlternateDBusNamesMetaclass

1473

1474

1475

2189

class ClientHandler(socketserver.BaseRequestHandler, object):

1476

2190

"""A class to handle client connections.

1477

2191

1478

2192

Instantiated once for each connection to handle it.

1479

2193

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

1480

2194

1481

2195

def handle(self):

1482

2196

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

1483

2197

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

1484

unicode(self.client_address))

2198

str(self.client_address))

1485

2199

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

1486

2200

self.server.child_pipe.fileno())

1487

1488

session = (gnutls.connection

1489

.ClientSession(self.request,

1490

gnutls.connection

1491

.X509Credentials()))

1492

1493

# Note: gnutls.connection.X509Credentials is really a

1494

# generic GnuTLS certificate credentials object so long as

1495

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

1496

# here despite using OpenPGP certificates.

1497

1498

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

1499

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

1500

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

1501

# "+DHE-DSS"))

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

1502

2208

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

1503

2209

priority = self.server.gnutls_priority

1504

2210

if priority is None:

1505

2211

priority = "NORMAL"

1506

(gnutls.library.functions

1507

.gnutls_priority_set_direct(session._c_object,

1508

priority, None))

1509

2212

gnutls.priority_set_direct(session._c_object,

2213

priority.encode("utf-8"),

2214

None)

2215

1510

2216

# Start communication using the Mandos protocol

1511

2217

# Get protocol number

1512

2218

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

1513

2219

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

1514

2220

try:

1515

2221

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

1516

raise RuntimeError

2222

raise RuntimeError(line)

1517

2223

except (ValueError, IndexError, RuntimeError) as error:

1518

2224

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

1519

2225

return

1520

2226

1521

2227

# Start GnuTLS connection

1522

2228

try:

1523

2229

session.handshake()

1524

except gnutls.errors.GNUTLSError as error:

2230

except gnutls.Error as error:

1525

2231

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

1526

2232

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

1527

2233

# established. Just abandon the request.

1528

2234

return

1529

2235

logger.debug("Handshake succeeded")

1530

2236

1531

2237

approval_required = False

1532

2238

try:

1533

2239

try:

1534

fpr = self.fingerprint(self.peer_certificate

1535

(session))

1536

except (TypeError,

1537

gnutls.errors.GNUTLSError) as error:

2240

fpr = self.fingerprint(

2241

self.peer_certificate(session))

2242

except (TypeError, gnutls.Error) as error:

1538

2243

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

1539

2244

return

1540

2245

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

1541

2246

1542

2247

try:

1543

2248

client = ProxyClient(child_pipe, fpr,

1544

2249

self.client_address)

1545

2250

except KeyError:

1546

2251

return

1547

2252

1548

2253

if client.approval_delay:

1549

2254

delay = client.approval_delay

1550

2255

client.approvals_pending += 1

1551

2256

approval_required = True

1552

2257

1553

2258

while True:

1554

2259

if not client.enabled:

1555

2260

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

1556

client.name)

2261

client.name)

1557

2262

if self.server.use_dbus:

1558

2263

# Emit D-Bus signal

1559

2264

client.Rejected("Disabled")

1560

2265

return

1561

2266

1562

2267

if client.approved or not client.approval_delay:

1563

#We are approved or approval is disabled

2268

# We are approved or approval is disabled

1564

2269

break

1565

2270

elif client.approved is None:

1566

2271

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

1568

2273

if self.server.use_dbus:

1569

2274

# Emit D-Bus signal

1570

2275

client.NeedApproval(

1571

client.approval_delay_milliseconds(),

1572

client.approved_by_default)

2276

client.approval_delay.total_seconds()

2277

* 1000, client.approved_by_default)

1573

2278

else:

1574

2279

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

1575

2280

client.name)

1577

2282

# Emit D-Bus signal

1578

2283

client.Rejected("Denied")

1579

2284

return

1580

1581

#wait until timeout or approved

2285

2286

# wait until timeout or approved

1582

2287

time = datetime.datetime.now()

1583

2288

client.changedstate.acquire()

1584

(client.changedstate.wait

1585

(float(client.timedelta_to_milliseconds(delay)

1586

/ 1000)))

2289

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

1587

2290

client.changedstate.release()

1588

2291

time2 = datetime.datetime.now()

1589

2292

if (time2 - time) >= delay:

1599

2302

break

1600

2303

else:

1601

2304

delay -= time2 - time

1602

1603

sent_size = 0

1604

while sent_size < len(client.secret):

1605

try:

1606

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

1607

except gnutls.errors.GNUTLSError as error:

1608

logger.warning("gnutls send failed")

1609

return

1610

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

1611

sent, len(client.secret)

1612

- (sent_size + sent))

1613

sent_size += sent

1614

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

1615

2313

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

1616

2314

# bump the timeout using extended_timeout

1617

2315

client.bump_timeout(client.extended_timeout)

1618

2316

if self.server.use_dbus:

1619

2317

# Emit D-Bus signal

1620

2318

client.GotSecret()

1621

2319

1622

2320

finally:

1623

2321

if approval_required:

1624

2322

client.approvals_pending -= 1

1625

2323

try:

1626

2324

session.bye()

1627

except gnutls.errors.GNUTLSError as error:

1628

logger.warning("GnuTLS bye failed")

1629

2325

except gnutls.Error as error:

2326

logger.warning("GnuTLS bye failed",

2327

exc_info=error)

2328

1630

2329

@staticmethod

1631

2330

def peer_certificate(session):

1632

2331

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

1633

2332

# If not an OpenPGP certificate...

1634

if (gnutls.library.functions

1635

.gnutls_certificate_type_get(session._c_object)

1636

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1637

# ...do the normal thing

1638

return session.peer_certificate

2333

if (gnutls.certificate_type_get(session._c_object)

2334

!= gnutls.CRT_OPENPGP):

2335

# ...return invalid data

2336

return b""

1639

2337

list_size = ctypes.c_uint(1)

1640

cert_list = (gnutls.library.functions

1641

.gnutls_certificate_get_peers

2338

cert_list = (gnutls.certificate_get_peers

1642

2339

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

1643

2340

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

1644

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

1645

" certificate")

2341

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

1646

2342

if list_size.value == 0:

1647

2343

return None

1648

2344

cert = cert_list[0]

1649

2345

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

1650

2346

1651

2347

@staticmethod

1652

2348

def fingerprint(openpgp):

1653

2349

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1654

2350

# New GnuTLS "datum" with the OpenPGP public key

1655

datum = (gnutls.library.types

1656

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

1657

ctypes.POINTER

1658

(ctypes.c_ubyte)),

1659

ctypes.c_uint(len(openpgp))))

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

1660

2355

# New empty GnuTLS certificate

1661

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2356

crt = gnutls.openpgp_crt_t()

2357

gnutls.openpgp_crt_init(ctypes.byref(crt))

1664

2358

# Import the OpenPGP public key into the certificate

1665

(gnutls.library.functions

1666

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

1667

gnutls.library.constants

1668

.GNUTLS_OPENPGP_FMT_RAW))

2359

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

2360

gnutls.OPENPGP_FMT_RAW)

1669

2361

# Verify the self signature in the key

1670

2362

crtverify = ctypes.c_uint()

1671

(gnutls.library.functions

1672

.gnutls_openpgp_crt_verify_self(crt, 0,

1673

ctypes.byref(crtverify)))

2363

gnutls.openpgp_crt_verify_self(crt, 0,

2364

ctypes.byref(crtverify))

1674

2365

if crtverify.value != 0:

1675

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1676

raise (gnutls.errors.CertificateSecurityError

1677

("Verify failed"))

2366

gnutls.openpgp_crt_deinit(crt)

2367

raise gnutls.CertificateSecurityError("Verify failed")

1678

2368

# New buffer for the fingerprint

1679

2369

buf = ctypes.create_string_buffer(20)

1680

2370

buf_len = ctypes.c_size_t()

1681

2371

# Get the fingerprint from the certificate into the buffer

1682

(gnutls.library.functions

1683

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

1684

ctypes.byref(buf_len)))

2372

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

2373

ctypes.byref(buf_len))

1685

2374

# Deinit the certificate

1686

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2375

gnutls.openpgp_crt_deinit(crt)

1687

2376

# Convert the buffer to a Python bytestring

1688

2377

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

1689

2378

# Convert the bytestring to hexadecimal notation

1693

2382

1694

2383

class MultiprocessingMixIn(object):

1695

2384

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

2385

1696

2386

def sub_process_main(self, request, address):

1697

2387

try:

1698

2388

self.finish_request(request, address)

1699

2389

except Exception:

1700

2390

self.handle_error(request, address)

1701

2391

self.close_request(request)

1702

2392

1703

2393

def process_request(self, request, address):

1704

2394

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

1705

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

1706

args = (request,

1707

address))

2395

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

2396

args=(request, address))

1708

2397

proc.start()

1709

2398

return proc

1710

2399

1711

2400

1712

2401

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1713

2402

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

2403

1714

2404

def process_request(self, request, client_address):

1715

2405

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

1716

2406

1717

2407

This function creates a new pipe in self.pipe

1718

2408

"""

1719

2409

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1720

2410

1721

2411

proc = MultiprocessingMixIn.process_request(self, request,

1722

2412

client_address)

1723

2413

self.child_pipe.close()

1724

2414

self.add_pipe(parent_pipe, proc)

1725

2415

1726

2416

def add_pipe(self, parent_pipe, proc):

1727

2417

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

1728

raise NotImplementedError

2418

raise NotImplementedError()

1729

2419

1730

2420

1731

2421

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1732

2422

socketserver.TCPServer, object):

1733

2423

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

1734

2424

1735

2425

Attributes:

1736

2426

enabled: Boolean; whether this server is activated yet

1737

2427

interface: None or a network interface name (string)

1738

2428

use_ipv6: Boolean; to use IPv6 or not

1739

2429

"""

2430

1740

2431

def __init__(self, server_address, RequestHandlerClass,

1741

interface=None, use_ipv6=True):

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

"""

1742

2438

self.interface = interface

1743

2439

if use_ipv6:

1744

2440

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.

1745

2468

socketserver.TCPServer.__init__(self, server_address,

1746

2469

RequestHandlerClass)

2470

1747

2471

def server_bind(self):

1748

2472

"""This overrides the normal server_bind() function

1749

2473

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

1750

2474

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

2475

global SO_BINDTODEVICE

1751

2476

if self.interface is not None:

1752

2477

if SO_BINDTODEVICE is None:

1753

logger.error("SO_BINDTODEVICE does not exist;"

1754

" cannot bind to interface %s",

1755

self.interface)

1756

else:

1757

try:

1758

self.socket.setsockopt(socket.SOL_SOCKET,

1759

SO_BINDTODEVICE,

1760

str(self.interface

1761

+ '\0'))

1762

except socket.error as error:

1763

if error[0] == errno.EPERM:

1764

logger.error("No permission to"

1765

" bind to interface %s",

1766

self.interface)

1767

elif error[0] == errno.ENOPROTOOPT:

1768

logger.error("SO_BINDTODEVICE not available;"

1769

" cannot bind to interface %s",

1770

self.interface)

1771

else:

1772

raise

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

1773

2499

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

1774

2500

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

1775

2501

if not self.server_address[0]:

1776

2502

if self.address_family == socket.AF_INET6:

1777

any_address = "::" # in6addr_any

2503

any_address = "::" # in6addr_any

1778

2504

else:

1779

any_address = socket.INADDR_ANY

2505

any_address = "0.0.0.0" # INADDR_ANY

1780

2506

self.server_address = (any_address,

1781

2507

self.server_address[1])

1782

2508

elif not self.server_address[1]:

1783

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

1784

0)

2509

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

1785

2510

# if self.interface:

1786

2511

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

1787

2512

# 0, # port

1793

2518

1794

2519

class MandosServer(IPv6_TCPServer):

1795

2520

"""Mandos server.

1796

2521

1797

2522

Attributes:

1798

2523

clients: set of Client objects

1799

2524

gnutls_priority GnuTLS priority string

1800

2525

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

1801

1802

Assumes a gobject.MainLoop event loop.

2526

2527

Assumes a GLib.MainLoop event loop.

1803

2528

"""

2529

1804

2530

def __init__(self, server_address, RequestHandlerClass,

1805

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

1806

gnutls_priority=None, use_dbus=True):

2531

interface=None,

2532

use_ipv6=True,

2533

clients=None,

2534

gnutls_priority=None,

2535

use_dbus=True,

2536

socketfd=None):

1807

2537

self.enabled = False

1808

2538

self.clients = clients

1809

2539

if self.clients is None:

1812

2542

self.gnutls_priority = gnutls_priority

1813

2543

IPv6_TCPServer.__init__(self, server_address,

1814

2544

RequestHandlerClass,

1815

interface = interface,

1816

use_ipv6 = use_ipv6)

2545

interface=interface,

2546

use_ipv6=use_ipv6,

2547

socketfd=socketfd)

2548

1817

2549

def server_activate(self):

1818

2550

if self.enabled:

1819

2551

return socketserver.TCPServer.server_activate(self)

1820

2552

1821

2553

def enable(self):

1822

2554

self.enabled = True

1823

2555

1824

2556

def add_pipe(self, parent_pipe, proc):

1825

2557

# Call "handle_ipc" for both data and EOF events

1826

gobject.io_add_watch(parent_pipe.fileno(),

1827

gobject.IO_IN | gobject.IO_HUP,

1828

functools.partial(self.handle_ipc,

1829

parent_pipe =

1830

parent_pipe,

1831

proc = proc))

1832

1833

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

1834

proc = None, client_object=None):

1835

condition_names = {

1836

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

1837

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

1838

# blocking).

1839

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

1840

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

1841

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

1842

# broken, usually for pipes and

1843

# sockets).

1844

}

1845

conditions_string = ' | '.join(name

1846

for cond, name in

1847

condition_names.iteritems()

1848

if cond & condition)

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

1849

2569

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

1850

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

2570

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

1851

2571

# Wait for other process to exit

1852

2572

proc.join()

1853

2573

return False

1854

2574

1855

2575

# Read a request from the child

1856

2576

request = parent_pipe.recv()

1857

2577

command = request[0]

1858

2578

1859

2579

if command == 'init':

1860

2580

fpr = request[1]

1861

2581

address = request[2]

1862

1863

for c in self.clients.itervalues():

2582

2583

for c in self.clients.values():

1864

2584

if c.fingerprint == fpr:

1865

2585

client = c

1866

2586

break

1873

2593

address[0])

1874

2594

parent_pipe.send(False)

1875

2595

return False

1876

1877

gobject.io_add_watch(parent_pipe.fileno(),

1878

gobject.IO_IN | gobject.IO_HUP,

1879

functools.partial(self.handle_ipc,

1880

parent_pipe =

1881

parent_pipe,

1882

proc = proc,

1883

client_object =

1884

client))

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

1885

2604

parent_pipe.send(True)

1886

2605

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

1887

2606

# same fileno

1890

2609

funcname = request[1]

1891

2610

args = request[2]

1892

2611

kwargs = request[3]

1893

2612

1894

2613

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

1895

2614

funcname)(*args,

1896

**kwargs)))

1897

2615

**kwargs)))

2616

1898

2617

if command == 'getattr':

1899

2618

attrname = request[1]

1900

if callable(client_object.__getattribute__(attrname)):

1901

parent_pipe.send(('function',))

2619

if isinstance(client_object.__getattribute__(attrname),

2620

collections.Callable):

2621

parent_pipe.send(('function', ))

1902

2622

else:

1903

parent_pipe.send(('data', client_object

1904

.__getattribute__(attrname)))

1905

2623

parent_pipe.send((

2624

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

2625

1906

2626

if command == 'setattr':

1907

2627

attrname = request[1]

1908

2628

value = request[2]

1909

2629

setattr(client_object, attrname, value)

1910

2630

1911

2631

return True

1912

2632

1913

2633

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

1914

2733

def string_to_delta(interval):

1915

2734

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

1916

2735

1917

2736

>>> string_to_delta('7d')

1918

2737

datetime.timedelta(7)

1919

2738

>>> string_to_delta('60s')

1927

2746

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

1928

2747

datetime.timedelta(0, 330)

1929

2748

"""

2749

2750

try:

2751

return rfc3339_duration_to_delta(interval)

2752

except ValueError:

2753

pass

2754

1930

2755

timevalue = datetime.timedelta(0)

1931

2756

for s in interval.split():

1932

2757

try:

1933

suffix = unicode(s[-1])

2758

suffix = s[-1]

1934

2759

value = int(s[:-1])

1935

2760

if suffix == "d":

1936

2761

delta = datetime.timedelta(value)

1943

2768

elif suffix == "w":

1944

2769

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

1945

2770

else:

1946

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

1947

except (ValueError, IndexError) as e:

2771

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

2772

except IndexError as e:

1948

2773

raise ValueError(*(e.args))

1949

2774

timevalue += delta

1950

2775

return timevalue

1951

2776

1952

2777

1953

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

2778

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

1954

2779

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

1955

2780

1956

2781

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

1957

2782

if os.fork():

1958

2783

sys.exit()

1963

2788

sys.exit()

1964

2789

if not noclose:

1965

2790

# Close all standard open file descriptors

1966

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

2791

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

1967

2792

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

1968

2793

raise OSError(errno.ENODEV,

1969

"%s not a character device"

1970

% os.path.devnull)

2794

"{} not a character device"

2795

.format(os.devnull))

1971

2796

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

1972

2797

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

1973

2798

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

1976

2801

1977

2802

1978

2803

def main():

1979

2804

1980

2805

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

1981

2806

# Parsing of options, both command line and config file

1982

2807

1983

2808

parser = argparse.ArgumentParser()

1984

2809

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

1985

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

2810

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

1986

2811

help="show version number and exit")

1987

2812

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

1988

2813

help="Bind to interface IF")

1994

2819

help="Run self-test")

1995

2820

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

1996

2821

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

1997

" to terminal")

2822

" to terminal", default=None)

1998

2823

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

1999

2824

help="Debug level for stdout output")

2000

2825

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

2007

2832

" files")

2008

2833

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

2009

2834

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

2010

" system bus interface")

2835

" system bus interface", default=None)

2011

2836

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

2012

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

2837

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

2838

default=None)

2013

2839

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

2014

2840

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

2015

" state")

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

2016

2845

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

2017

2846

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

2018

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

2019

2853

options = parser.parse_args()

2020

2854

2021

2855

if options.check:

2022

2856

import doctest

2023

doctest.testmod()

2024

sys.exit()

2025

2857

fail_count, test_count = doctest.testmod()

2858

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

2859

2026

2860

# Default values for config file for server-global settings

2027

server_defaults = { "interface": "",

2028

"address": "",

2029

"port": "",

2030

"debug": "False",

2031

"priority":

2032

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

2033

"servicename": "Mandos",

2034

"use_dbus": "True",

2035

"use_ipv6": "True",

2036

"debuglevel": "",

2037

"restore": "True",

2038

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

2039

}

2040

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

2041

2879

# Parse config file for server-global settings

2042

2880

server_config = configparser.SafeConfigParser(server_defaults)

2043

2881

del server_defaults

2044

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

2045

"mandos.conf"))

2882

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

2046

2883

# Convert the SafeConfigParser object to a dict

2047

2884

server_settings = server_config.defaults()

2048

2885

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

2049

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

2886

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

2050

2887

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

2051

2888

option)

2052

2889

if server_settings["port"]:

2053

2890

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

2054

2891

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

2055

2901

del server_config

2056

2902

2057

2903

# Override the settings from the config file with command line

2058

2904

# options, if set.

2059

2905

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

2060

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

2061

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

2062

"statedir"):

2906

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

2907

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

2908

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

2063

2909

value = getattr(options, option)

2064

2910

if value is not None:

2065

2911

server_settings[option] = value

2066

2912

del options

2067

2913

# Force all strings to be unicode

2068

2914

for option in server_settings.keys():

2069

if type(server_settings[option]) is str:

2070

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

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

2071

2925

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

2072

2926

2073

2927

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

2074

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

2075

2934

# For convenience

2076

2935

debug = server_settings["debug"]

2077

2936

debuglevel = server_settings["debuglevel"]

2079

2938

use_ipv6 = server_settings["use_ipv6"]

2080

2939

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

2081

2940

stored_state_file)

2082

2941

foreground = server_settings["foreground"]

2942

zeroconf = server_settings["zeroconf"]

2943

2083

2944

if debug:

2084

2945

initlogger(debug, logging.DEBUG)

2085

2946

else:

2088

2949

else:

2089

2950

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

2090

2951

initlogger(debug, level)

2091

2952

2092

2953

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

2093

syslogger.setFormatter(logging.Formatter

2094

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

2095

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

2096

% server_settings["servicename"]))

2097

2954

syslogger.setFormatter(

2955

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

2956

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

2957

server_settings["servicename"])))

2958

2098

2959

# Parse config file with clients

2099

2960

client_config = configparser.SafeConfigParser(Client

2100

2961

.client_defaults)

2101

2962

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

2102

2963

"clients.conf"))

2103

2964

2104

2965

global mandos_dbus_service

2105

2966

mandos_dbus_service = None

2106

2107

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

2108

server_settings["port"]),

2109

ClientHandler,

2110

interface=(server_settings["interface"]

2111

or None),

2112

use_ipv6=use_ipv6,

2113

gnutls_priority=

2114

server_settings["priority"],

2115

use_dbus=use_dbus)

2116

if not debug:

2117

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

2118

try:

2119

pidfile = open(pidfilename, "w")

2120

except IOError:

2121

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

2122

2123

try:

2124

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

2125

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

2126

except KeyError:

2127

try:

2128

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

2129

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

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

2130

2997

except KeyError:

2131

try:

2132

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

2133

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

2134

except KeyError:

2135

uid = 65534

2136

gid = 65534

2998

continue

2999

else:

3000

uid = 65534

3001

gid = 65534

2137

3002

try:

2138

3003

os.setgid(gid)

2139

3004

os.setuid(uid)

3005

if debug:

3006

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

3007

gid))

2140

3008

except OSError as error:

2141

if error[0] != errno.EPERM:

2142

raise error

2143

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

2144

3014

if debug:

2145

3015

# Enable all possible GnuTLS debugging

2146

3016

2147

3017

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

2148

3018

# - GnuTLS manual

2149

gnutls.library.functions.gnutls_global_set_log_level(11)

2150

2151

@gnutls.library.types.gnutls_log_func

3019

gnutls.global_set_log_level(11)

3020

3021

@gnutls.log_func

2152

3022

def debug_gnutls(level, string):

2153

3023

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

2154

2155

(gnutls.library.functions

2156

.gnutls_global_set_log_function(debug_gnutls))

2157

3024

3025

gnutls.global_set_log_function(debug_gnutls)

3026

2158

3027

# Redirect stdin so all checkers get /dev/null

2159

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

3028

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

2160

3029

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

2161

3030

if null > 2:

2162

3031

os.close(null)

2163

3032

2164

3033

# Need to fork before connecting to D-Bus

2165

if not debug:

3034

if not foreground:

2166

3035

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

2167

3036

daemon()

2168

2169

gobject.threads_init()

2170

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

2171

3042

global main_loop

2172

3043

# From the Avahi example code

2173

DBusGMainLoop(set_as_default=True )

2174

main_loop = gobject.MainLoop()

3044

DBusGMainLoop(set_as_default=True)

3045

main_loop = GLib.MainLoop()

2175

3046

bus = dbus.SystemBus()

2176

3047

# End of Avahi example code

2177

3048

if use_dbus:

2178

3049

try:

2179

3050

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

2180

bus, do_not_queue=True)

2181

old_bus_name = (dbus.service.BusName

2182

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

2183

do_not_queue=True))

2184

except dbus.exceptions.NameExistsException as e:

2185

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

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

3058

use_dbus = False

2187

3059

server_settings["use_dbus"] = False

2188

3060

tcp_server.use_dbus = False

2189

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2190

service = AvahiServiceToSyslog(name =

2191

server_settings["servicename"],

2192

servicetype = "_mandos._tcp",

2193

protocol = protocol, bus = bus)

2194

if server_settings["interface"]:

2195

service.interface = (if_nametoindex

2196

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

2197

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

2198

3072

global multiprocessing_manager

2199

3073

multiprocessing_manager = multiprocessing.Manager()

2200

3074

2201

3075

client_class = Client

2202

3076

if use_dbus:

2203

client_class = functools.partial(ClientDBusTransitional,

2204

bus = bus)

2205

3077

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

3078

2206

3079

client_settings = Client.config_parser(client_config)

2207

3080

old_client_settings = {}

2208

3081

clients_data = {}

2209

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

2210

3091

# Get client data and settings from last running state.

2211

3092

if server_settings["restore"]:

2212

3093

try:

2213

3094

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

2214

clients_data, old_client_settings = (pickle.load

2215

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

2216

3140

os.remove(stored_state_path)

2217

3141

except IOError as e:

2218

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

2219

.format(e))

2220

if e.errno != errno.ENOENT:

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)

2221

3148

raise

2222

3149

except EOFError as e:

2223

3150

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

2224

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

2225

3151

"EOFError:",

3152

exc_info=e)

3153

2226

3154

with PGPEngine() as pgp:

2227

for client_name, client in clients_data.iteritems():

3155

for client_name, client in clients_data.items():

3156

# Skip removed clients

3157

if client_name not in client_settings:

3158

continue

3159

2228

3160

# Decide which value to use after restoring saved state.

2229

3161

# We have three different values: Old config file,

2230

3162

# new config file, and saved state.

2235

3167

# For each value in new config, check if it

2236

3168

# differs from the old config value (Except for

2237

3169

# the "secret" attribute)

2238

if (name != "secret" and

2239

value != old_client_settings[client_name]

2240

[name]):

3170

if (name != "secret"

3171

and (value !=

3172

old_client_settings[client_name][name])):

2241

3173

client[name] = value

2242

3174

except KeyError:

2243

3175

pass

2244

3176

2245

3177

# Clients who has passed its expire date can still be

2246

# enabled if its last checker was successful. Clients

3178

# enabled if its last checker was successful. A Client

2247

3179

# whose checker succeeded before we stored its state is

2248

3180

# assumed to have successfully run all checkers during

2249

3181

# downtime.

2251

3183

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

2252

3184

if not client["last_checked_ok"]:

2253

3185

logger.warning(

2254

"disabling client {0} - Client never "

2255

"performed a successful checker"

2256

.format(client_name))

3186

"disabling client {} - Client never "

3187

"performed a successful checker".format(

3188

client_name))

2257

3189

client["enabled"] = False

2258

3190

elif client["last_checker_status"] != 0:

2259

3191

logger.warning(

2260

"disabling client {0} - Client "

2261

"last checker failed with error code {1}"

2262

.format(client_name,

2263

client["last_checker_status"]))

3192

"disabling client {} - Client last"

3193

" checker failed with error code"

3194

" {}".format(

3195

client_name,

3196

client["last_checker_status"]))

2264

3197

client["enabled"] = False

2265

3198

else:

2266

client["expires"] = (datetime.datetime

2267

.utcnow()

2268

+ client["timeout"])

3199

client["expires"] = (

3200

datetime.datetime.utcnow()

3201

+ client["timeout"])

2269

3202

logger.debug("Last checker succeeded,"

2270

" keeping {0} enabled"

2271

.format(client_name))

3203

" keeping {} enabled".format(

3204

client_name))

2272

3205

try:

2273

client["secret"] = (

2274

pgp.decrypt(client["encrypted_secret"],

2275

client_settings[client_name]

2276

["secret"]))

3206

client["secret"] = pgp.decrypt(

3207

client["encrypted_secret"],

3208

client_settings[client_name]["secret"])

2277

3209

except PGPError:

2278

3210

# If decryption fails, we use secret from new settings

2279

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

2280

.format(client_name))

2281

client["secret"] = (

2282

client_settings[client_name]["secret"])

3211

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

3212

client_name))

3213

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

3214

["secret"])

2283

3215

2284

2285

3216

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

2286

3217

for client_name in (set(old_client_settings)

2287

3218

- set(client_settings)):

2291

3222

clients_data[client_name] = client_settings[client_name]

2292

3223

2293

3224

# Create all client objects

2294

for client_name, client in clients_data.iteritems():

3225

for client_name, client in clients_data.items():

2295

3226

tcp_server.clients[client_name] = client_class(

2296

name = client_name, settings = client)

2297

3227

name=client_name,

3228

settings=client,

3229

server_settings=server_settings)

3230

2298

3231

if not tcp_server.clients:

2299

3232

logger.warning("No clients defined")

2300

2301

if not debug:

2302

try:

2303

with pidfile:

2304

pid = os.getpid()

2305

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

2306

del pidfile

2307

except IOError:

2308

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

2309

pidfilename, pid)

2310

except NameError:

2311

# "pidfile" was never created

2312

pass

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

2313

3244

del pidfilename

2314

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

2315

2316

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

2317

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

2318

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

3250

if use_dbus:

2320

class MandosDBusService(dbus.service.Object):

3251

3252

@alternate_dbus_interfaces(

3253

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

3254

class MandosDBusService(DBusObjectWithObjectManager):

2321

3255

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

3256

2322

3257

def __init__(self):

2323

3258

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

3259

2324

3260

_interface = "se.recompile.Mandos"

2325

3261

2326

3262

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

2327

3263

def ClientAdded(self, objpath):

2328

3264

"D-Bus signal"

2329

3265

pass

2330

3266

2331

3267

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

2332

3268

def ClientNotFound(self, fingerprint, address):

2333

3269

"D-Bus signal"

2334

3270

pass

2335

3271

3272

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

3273

"true"})

2336

3274

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

2337

3275

def ClientRemoved(self, objpath, name):

2338

3276

"D-Bus signal"

2339

3277

pass

2340

3278

3279

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

3280

"true"})

2341

3281

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

2342

3282

def GetAllClients(self):

2343

3283

"D-Bus method"

2344

return dbus.Array(c.dbus_object_path

2345

for c in

2346

tcp_server.clients.itervalues())

2347

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

2348

3289

@dbus.service.method(_interface,

2349

3290

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

2350

3291

def GetAllClientsWithProperties(self):

2351

3292

"D-Bus method"

2352

3293

return dbus.Dictionary(

2353

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

2354

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

3294

{c.dbus_object_path: c.GetAll(

3295

"se.recompile.Mandos.Client")

3296

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

2355

3297

signature="oa{sv}")

2356

3298

2357

3299

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

2358

3300

def RemoveClient(self, object_path):

2359

3301

"D-Bus method"

2360

for c in tcp_server.clients.itervalues():

3302

for c in tcp_server.clients.values():

2361

3303

if c.dbus_object_path == object_path:

2362

3304

del tcp_server.clients[c.name]

2363

3305

c.remove_from_connection()

2364

# Don't signal anything except ClientRemoved

3306

# Don't signal the disabling

2365

3307

c.disable(quiet=True)

2366

# Emit D-Bus signal

2367

self.ClientRemoved(object_path, c.name)

3308

# Emit D-Bus signal for removal

3309

self.client_removed_signal(c)

2368

3310

return

2369

3311

raise KeyError(object_path)

2370

3312

2371

3313

del _interface

2372

2373

class MandosDBusServiceTransitional(MandosDBusService):

2374

__metaclass__ = AlternateDBusNamesMetaclass

2375

mandos_dbus_service = MandosDBusServiceTransitional()

2376

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

3358

def cleanup():

2378

3359

"Cleanup function; run on exit"

2379

service.cleanup()

2380

2381

multiprocessing.active_children()

3360

if zeroconf:

3361

service.cleanup()

3362

3363

mp.active_children()

3364

wn.close()

2382

3365

if not (tcp_server.clients or client_settings):

2383

3366

return

2384

3367

2385

3368

# Store client before exiting. Secrets are encrypted with key

2386

3369

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

2387

3370

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

2388

3371

clients = {}

2389

3372

with PGPEngine() as pgp:

2390

for client in tcp_server.clients.itervalues():

3373

for client in tcp_server.clients.values():

2391

3374

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

2392

3375

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

2393

3376

key)

2394

3377

client_dict = {}

2395

3378

2396

3379

# A list of attributes that can not be pickled

2397

3380

# + secret.

2398

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

2399

"checker"))

2400

for name, typ in (inspect.getmembers

2401

(dbus.service.Object)):

3381

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

3382

"checker", "server_settings"}

3383

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

3384

.Object):

2402

3385

exclude.add(name)

2403

3386

2404

3387

client_dict["encrypted_secret"] = (client

2405

3388

.encrypted_secret)

2406

3389

for attr in client.client_structure:

2407

3390

if attr not in exclude:

2408

3391

client_dict[attr] = getattr(client, attr)

2409

3392

2410

3393

clients[client.name] = client_dict

2411

3394

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

2412

3395

2413

3396

try:

2414

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

2415

prefix="clients-",

2416

dir=os.path.dirname

2417

(stored_state_path))

2418

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

2419

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

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

2420

3406

os.rename(tempname, stored_state_path)

2421

3407

except (IOError, OSError) as e:

2422

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

2423

.format(e))

2424

3408

if not debug:

2425

3409

try:

2426

3410

os.remove(tempname)

2427

3411

except NameError:

2428

3412

pass

2429

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

2430

errno.EEXIST)):

2431

raise e

2432

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

2433

3421

# Delete all clients, and settings from config

2434

3422

while tcp_server.clients:

2435

3423

name, client = tcp_server.clients.popitem()

2436

3424

if use_dbus:

2437

3425

client.remove_from_connection()

2438

# Don't signal anything except ClientRemoved

3426

# Don't signal the disabling

2439

3427

client.disable(quiet=True)

3428

# Emit D-Bus signal for removal

2440

3429

if use_dbus:

2441

# Emit D-Bus signal

2442

mandos_dbus_service.ClientRemoved(client

2443

.dbus_object_path,

2444

client.name)

3430

mandos_dbus_service.client_removed_signal(client)

2445

3431

client_settings.clear()

2446

3432

2447

3433

atexit.register(cleanup)

2448

2449

for client in tcp_server.clients.itervalues():

3434

3435

for client in tcp_server.clients.values():

2450

3436

if use_dbus:

2451

# Emit D-Bus signal

2452

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3437

# Emit D-Bus signal for adding

3438

mandos_dbus_service.client_added_signal(client)

2453

3439

# Need to initiate checking of clients

2454

3440

if client.enabled:

2455

3441

client.init_checker()

2456

3442

2457

3443

tcp_server.enable()

2458

3444

tcp_server.server_activate()

2459

3445

2460

3446

# Find out what port we got

2461

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

3447

if zeroconf:

3448

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

2462

3449

if use_ipv6:

2463

3450

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

2464

" flowinfo %d, scope_id %d"

2465

% tcp_server.socket.getsockname())

3451

" flowinfo %d, scope_id %d",

3452

*tcp_server.socket.getsockname())

2466

3453

else: # IPv4

2467

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

2468

% tcp_server.socket.getsockname())

2469

2470

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

2471

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

3459

try:

2473

# From the Avahi example code

2474

try:

2475

service.activate()

2476

except dbus.exceptions.DBusException as error:

2477

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

2478

cleanup()

2479

sys.exit(1)

2480

# End of Avahi example code

2481

2482

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

2483

lambda *args, **kwargs:

2484

(tcp_server.handle_request

2485

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

2486

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

2487

3475

logger.debug("Starting main loop")

2488

3476

main_loop.run()

2489

3477

except AvahiError as error:

2490

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

3478

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

2491

3479

cleanup()

2492

3480

sys.exit(1)

2493

3481

except KeyboardInterrupt:

2498

3486

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

2499

3487

cleanup()

2500

3488

3489

2501

3490

if __name__ == '__main__':

2502

3491

main()