/mandos/trunk : revision 237.4.116

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This 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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

# 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

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

import SocketServer as socketserver

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

38

47

import socket

39

48

import argparse

40

49

import datetime

41

50

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

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

49

55

import sys

50

56

import re

51

57

import os

60

66

import struct

61

67

import fcntl

62

68

import functools

63

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

64

73

import multiprocessing

65

74

import types

66

75

import binascii

67

76

import tempfile

77

import itertools

78

import collections

79

import codecs

68

80

69

81

import dbus

70

82

import dbus.service

71

import gobject

72

import avahi

83

from gi.repository import GLib

73

84

from dbus.mainloop.glib import DBusGMainLoop

74

85

import ctypes

75

86

import ctypes.util

76

87

import xml.dom.minidom

77

88

import inspect

78

import GnuPGInterface

79

89

90

# Try to find the value of SO_BINDTODEVICE:

80

91

try:

92

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

93

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

81

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

82

95

except AttributeError:

83

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

84

99

from IN import SO_BINDTODEVICE

85

100

except ImportError:

86

SO_BINDTODEVICE = None

87

88

version = "1.5.2"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.5"

89

119

stored_state_file = "clients.pickle"

90

120

91

121

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

122

syslogger = None

95

123

96

124

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

100

127

except (OSError, AttributeError):

128

101

129

def if_nametoindex(interface):

102

130

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

103

131

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

104

132

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

105

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

134

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

135

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

110

136

return interface_index

111

137

112

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

113

155

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

114

156

"""init logger and add loglevel"""

115

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

116

162

syslogger.setFormatter(logging.Formatter

117

163

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

118

164

' %(message)s'))

119

165

logger.addHandler(syslogger)

120

166

121

167

if debug:

122

168

console = logging.StreamHandler()

123

169

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

135

181

136

182

class PGPEngine(object):

137

183

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

184

138

185

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

148

206

def __enter__(self):

149

207

return self

150

151

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

208

209

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

152

210

self._cleanup()

153

211

return False

154

212

155

213

def __del__(self):

156

214

self._cleanup()

157

215

158

216

def _cleanup(self):

159

217

if self.tempdir is not None:

160

218

# Delete contents of tempdir

161

219

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

162

topdown = False):

220

topdown=False):

163

221

for filename in files:

164

222

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

165

223

for dirname in dirs:

167

225

# Remove tempdir

168

226

os.rmdir(self.tempdir)

169

227

self.tempdir = None

170

228

171

229

def password_encode(self, password):

172

230

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

173

231

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

174

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

175

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

176

240

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

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

191

256

return ciphertext

192

257

193

258

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

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

208

274

return decrypted_plaintext

209

275

210

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

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 = super(AvahiServiceToSyslog, self).rename(*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

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version(b"3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version(b"3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

815

816

388

817

class Client(object):

389

818

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

390

819

391

820

Attributes:

392

821

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

393

822

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

394

823

approval_duration: datetime.timedelta(); Duration of one approval

395

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

396

to see if the client lives.

397

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

824

checker: multiprocessing.Process(); a running checker process used

825

to see if the client lives. 'None' if no process is

826

running.

827

checker_callback_tag: a GLib event source tag, or None

399

828

checker_command: string; External command which is run to check

400

829

if client lives. %() expansions are done at

401

830

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

402

831

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

403

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

404

833

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

405

834

client_structure: Object describing what attributes a client has

406

835

and is used for storing the client at exit

407

836

current_checker_command: string; current running checker_command

408

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

409

838

enabled: bool()

410

839

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

411

uniquely identify the client

840

uniquely identify an OpenPGP client

841

key_id: string (64 hexadecimal digits); used to uniquely identify

842

a client using raw public keys

412

843

host: string; available for use by the checker command

413

844

interval: datetime.timedelta(); How often to start a new checker

414

845

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

415

846

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

416

847

last_checker_status: integer between 0 and 255 reflecting exit

417

848

status of last checker. -1 reflects crashed

418

checker, or None.

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

419

852

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

420

853

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

421

854

D-Bus identifiers

426

859

runtime_expansions: Allowed attributes for runtime expansion.

427

860

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

428

861

disabled, or None

862

server_settings: The server_settings dict from main()

429

863

"""

430

864

431

865

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

866

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

867

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

868

"last_approval_request", "last_checked_ok",

434

869

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

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

460

881

461

882

@staticmethod

462

883

def config_parser(config):

470

891

for client_name in config.sections():

471

892

section = dict(config.items(client_name))

472

893

client = settings[client_name] = {}

473

894

474

895

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

475

896

# Reformat values from string types to Python types

476

897

client["approved_by_default"] = config.getboolean(

477

898

client_name, "approved_by_default")

478

899

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

479

900

"enabled")

480

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

client["key_id"] = (section.get("key_id", "").upper()

906

.replace(" ", ""))

481

907

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

482

908

.replace(" ", ""))

483

909

if "secret" in section:

484

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

910

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

911

.encode("utf-8"),

912

"base64")

485

913

elif "secfile" in section:

486

914

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

487

915

(section["secfile"])),

488

916

"rb") as secfile:

489

917

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

490

918

else:

491

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

492

% section)

919

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

920

.format(section))

493

921

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

494

922

client["extended_timeout"] = string_to_delta(

495

923

section["extended_timeout"])

501

929

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

502

930

client["last_approval_request"] = None

503

931

client["last_checked_ok"] = None

504

client["last_checker_status"] = None

505

932

client["last_checker_status"] = -2

933

506

934

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

935

936

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

513

937

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

514

941

# adding all client settings

515

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

516

943

setattr(self, setting, value)

517

944

518

945

if self.enabled:

519

946

if not hasattr(self, "last_enabled"):

520

947

self.last_enabled = datetime.datetime.utcnow()

524

951

else:

525

952

self.last_enabled = None

526

953

self.expires = None

527

954

528

955

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

956

logger.debug(" Key ID: %s", self.key_id)

532

957

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

533

958

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

534

959

datetime.datetime.utcnow())

541

966

self.current_checker_command = None

542

967

self.approved = None

543

968

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

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

549

973

if not attr.startswith("_")]

550

974

self.client_structure.append("client_structure")

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

975

976

for name, t in inspect.getmembers(

977

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

556

978

if not name.startswith("_"):

557

979

self.client_structure.append(name)

558

980

559

981

# Send notice to process children that client state has changed

560

982

def send_changedstate(self):

561

983

with self.changedstate:

562

984

self.changedstate.notify_all()

563

985

564

986

def enable(self):

565

987

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

566

988

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

567

989

# Already enabled

568

990

return

569

self.send_changedstate()

570

991

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

571

992

self.enabled = True

572

993

self.last_enabled = datetime.datetime.utcnow()

573

994

self.init_checker()

574

995

self.send_changedstate()

996

575

997

def disable(self, quiet=True):

576

998

"""Disable this client."""

577

999

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

578

1000

return False

579

1001

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

1002

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

583

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

584

gobject.source_remove(self.disable_initiator_tag)

1003

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

1004

GLib.source_remove(self.disable_initiator_tag)

585

1005

self.disable_initiator_tag = None

586

1006

self.expires = None

587

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

588

gobject.source_remove(self.checker_initiator_tag)

1007

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

1008

GLib.source_remove(self.checker_initiator_tag)

589

1009

self.checker_initiator_tag = None

590

1010

self.stop_checker()

591

1011

self.enabled = False

592

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

1012

if not quiet:

1013

self.send_changedstate()

1014

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

593

1015

return False

594

1016

595

1017

def __del__(self):

596

1018

self.disable()

597

1019

598

1020

def init_checker(self):

599

1021

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

600

1022

# and every interval from then on.

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

1023

if self.checker_initiator_tag is not None:

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

604

1028

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

1029

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

608

1033

# Also start a new checker *right now*.

609

1034

self.start_checker()

610

611

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

612

1038

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

1039

# Read return code from connection (see call_pipe)

1040

returncode = connection.recv()

1041

connection.close()

1042

self.checker.join()

613

1043

self.checker_callback_tag = None

614

1044

self.checker = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1045

1046

if returncode >= 0:

1047

self.last_checker_status = returncode

1048

self.last_checker_signal = None

617

1049

if self.last_checker_status == 0:

618

1050

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

619

1051

vars(self))

620

1052

self.checked_ok()

621

1053

else:

622

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

623

vars(self))

1054

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

624

1055

else:

625

1056

self.last_checker_status = -1

1057

self.last_checker_signal = -returncode

626

1058

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

627

1059

vars(self))

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

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

633

alive and well.

634

"""

1060

return False

1061

1062

def checked_ok(self):

1063

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

1064

self.last_checked_ok = datetime.datetime.utcnow()

1065

self.last_checker_status = 0

1066

self.last_checker_signal = None

1067

self.bump_timeout()

1068

1069

def bump_timeout(self, timeout=None):

1070

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

635

1071

if timeout is None:

636

1072

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

638

1073

if self.disable_initiator_tag is not None:

639

gobject.source_remove(self.disable_initiator_tag)

1074

GLib.source_remove(self.disable_initiator_tag)

1075

self.disable_initiator_tag = None

640

1076

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1077

self.disable_initiator_tag = GLib.timeout_add(

1078

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

644

1079

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

645

1080

646

1081

def need_approval(self):

647

1082

self.last_approval_request = datetime.datetime.utcnow()

648

1083

649

1084

def start_checker(self):

650

1085

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

651

1086

652

1087

If a checker already exists, leave it running and do

653

1088

nothing."""

654

1089

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

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

1090

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

1091

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

1092

# would inevitably timeout, since no checker would get a

1093

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

659

1094

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

660

1095

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

661

1096

# should be.

662

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

self.current_checker_command)

1097

1098

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

1099

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

1100

self.checker.join()

1101

self.checker = None

676

1102

# Start a new checker if needed

677

1103

if self.checker is None:

1104

# Escape attributes for the shell

1105

escaped_attrs = {

1106

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

1107

for attr in self.runtime_expansions}

678

1108

try:

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

1109

command = self.checker_command % escaped_attrs

1110

except TypeError as error:

1111

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

1112

self.checker_command,

1113

exc_info=error)

1114

return True # Try again later

697

1115

self.current_checker_command = command

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

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

720

error)

721

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

1116

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

1117

self.name)

1118

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

1119

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

1120

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

1121

# always replaced by /dev/null.)

1122

# The exception is when not debugging but nevertheless

1123

# running in the foreground; use the previously

1124

# created wnull.

1125

popen_args = {"close_fds": True,

1126

"shell": True,

1127

"cwd": "/"}

1128

if (not self.server_settings["debug"]

1129

and self.server_settings["foreground"]):

1130

popen_args.update({"stdout": wnull,

1131

"stderr": wnull})

1132

pipe = multiprocessing.Pipe(duplex=False)

1133

self.checker = multiprocessing.Process(

1134

target=call_pipe,

1135

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

1136

kwargs=popen_args)

1137

self.checker.start()

1138

self.checker_callback_tag = GLib.io_add_watch(

1139

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

1140

self.checker_callback, pipe[0], command)

1141

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

722

1142

return True

723

1143

724

1144

def stop_checker(self):

725

1145

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

726

1146

if self.checker_callback_tag:

727

gobject.source_remove(self.checker_callback_tag)

1147

GLib.source_remove(self.checker_callback_tag)

728

1148

self.checker_callback_tag = None

729

1149

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

730

1150

return

731

1151

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

732

try:

733

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

734

#time.sleep(0.5)

735

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

736

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

737

except OSError as error:

738

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

739

raise

1152

self.checker.terminate()

740

1153

self.checker = None

741

1154

742

1155

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1156

def dbus_service_property(dbus_interface,

1157

signature="v",

1158

access="readwrite",

1159

byte_arrays=False):

745

1160

"""Decorators for marking methods of a DBusObjectWithProperties to

746

1161

become properties on the D-Bus.

747

1162

748

1163

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

749

1164

and with one argument by "Set".

750

1165

751

1166

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

752

1167

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

753

1168

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

756

1171

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

757

1172

if byte_arrays and signature != "ay":

758

1173

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

759

" signature %r" % signature)

1174

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

1175

760

1176

def decorator(func):

761

1177

func._dbus_is_property = True

762

1178

func._dbus_interface = dbus_interface

765

1181

func._dbus_name = func.__name__

766

1182

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

767

1183

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

768

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

return func

1184

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1185

return func

1186

1187

return decorator

1188

1189

1190

def dbus_interface_annotations(dbus_interface):

1191

"""Decorator for marking functions returning interface annotations

1192

1193

Usage:

1194

1195

@dbus_interface_annotations("org.example.Interface")

1196

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

1197

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

1198

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

1199

"false"}

1200

"""

1201

1202

def decorator(func):

1203

func._dbus_is_interface = True

1204

func._dbus_interface = dbus_interface

1205

func._dbus_name = dbus_interface

1206

return func

1207

1208

return decorator

1209

1210

1211

def dbus_annotations(annotations):

1212

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

1213

Usage:

1214

1215

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

1216

"org.freedesktop.DBus.Property."

1217

"EmitsChangedSignal": "false"})

1218

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

1219

access="r")

1220

def Property_dbus_property(self):

1221

return dbus.Boolean(False)

1222

1223

See also the DBusObjectWithAnnotations class.

1224

"""

1225

1226

def decorator(func):

1227

func._dbus_annotations = annotations

1228

return func

1229

770

1230

return decorator

771

1231

772

1232

773

1233

class DBusPropertyException(dbus.exceptions.DBusException):

774

1234

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

775

1235

"""

776

def __unicode__(self):

777

return unicode(str(self))

1236

pass

778

1237

779

1238

780

1239

class DBusPropertyAccessException(DBusPropertyException):

789

1248

pass

790

1249

791

1250

792

class DBusObjectWithProperties(dbus.service.Object):

1251

class DBusObjectWithAnnotations(dbus.service.Object):

1252

"""A D-Bus object with annotations.

1253

1254

Classes inheriting from this can use the dbus_annotations

1255

decorator to add annotations to methods or signals.

1256

"""

1257

1258

@staticmethod

1259

def _is_dbus_thing(thing):

1260

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

1261

1262

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

1263

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

1264

"""

1265

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

1266

False)

1267

1268

def _get_all_dbus_things(self, thing):

1269

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

1270

"""

1271

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

1272

athing.__get__(self))

1273

for cls in self.__class__.__mro__

1274

for name, athing in

1275

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

1276

1277

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1278

out_signature="s",

1279

path_keyword='object_path',

1280

connection_keyword='connection')

1281

def Introspect(self, object_path, connection):

1282

"""Overloading of standard D-Bus method.

1283

1284

Inserts annotation tags on methods and signals.

1285

"""

1286

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

1287

connection)

1288

try:

1289

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

1290

1291

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

1292

# Add annotation tags

1293

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

1294

for tag in if_tag.getElementsByTagName(typ):

1295

annots = dict()

1296

for name, prop in (self.

1297

_get_all_dbus_things(typ)):

1298

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

1299

and prop._dbus_interface

1300

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

1301

annots.update(getattr(

1302

prop, "_dbus_annotations", {}))

1303

for name, value in annots.items():

1304

ann_tag = document.createElement(

1305

"annotation")

1306

ann_tag.setAttribute("name", name)

1307

ann_tag.setAttribute("value", value)

1308

tag.appendChild(ann_tag)

1309

# Add interface annotation tags

1310

for annotation, value in dict(

1311

itertools.chain.from_iterable(

1312

annotations().items()

1313

for name, annotations

1314

in self._get_all_dbus_things("interface")

1315

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

1316

)).items():

1317

ann_tag = document.createElement("annotation")

1318

ann_tag.setAttribute("name", annotation)

1319

ann_tag.setAttribute("value", value)

1320

if_tag.appendChild(ann_tag)

1321

# Fix argument name for the Introspect method itself

1322

if (if_tag.getAttribute("name")

1323

== dbus.INTROSPECTABLE_IFACE):

1324

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

1325

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

1326

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

1327

if (arg.getAttribute("direction")

1328

== "out"):

1329

arg.setAttribute("name",

1330

"xml_data")

1331

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

1332

document.unlink()

1333

except (AttributeError, xml.dom.DOMException,

1334

xml.parsers.expat.ExpatError) as error:

1335

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

1336

exc_info=error)

1337

return xmlstring

1338

1339

1340

class DBusObjectWithProperties(DBusObjectWithAnnotations):

793

1341

"""A D-Bus object with properties.

794

1342

795

1343

Classes inheriting from this can use the dbus_service_property

796

1344

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

797

1345

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

798

1346

"""

799

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

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

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

1347

812

1348

def _get_dbus_property(self, interface_name, property_name):

813

1349

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

814

1350

property with the specified name and interface.

815

1351

"""

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1352

for cls in self.__class__.__mro__:

1353

for name, value in inspect.getmembers(

1354

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

819

1355

if (value._dbus_name == property_name

820

1356

and value._dbus_interface == interface_name):

821

1357

return value.__get__(self)

822

1358

823

1359

# No such property

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

1360

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

1361

self.dbus_object_path, interface_name, property_name))

1362

1363

@classmethod

1364

def _get_all_interface_names(cls):

1365

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

1366

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

1367

"_dbus_interface", None)

1368

for x in (inspect.getmro(cls))

1369

for attr in dir(x))

1370

if name is not None)

1371

1372

@dbus.service.method(dbus.PROPERTIES_IFACE,

1373

in_signature="ss",

829

1374

out_signature="v")

830

1375

def Get(self, interface_name, property_name):

831

1376

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

837

1382

if not hasattr(value, "variant_level"):

838

1383

return value

839

1384

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

840

1385

841

1386

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

842

1387

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

843

1388

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

849

1394

# The byte_arrays option is not supported yet on

850

1395

# signatures other than "ay".

851

1396

if prop._dbus_signature != "ay":

852

raise ValueError

1397

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

1398

"'ay' signature {!r}"

1399

.format(prop._dbus_signature))

853

1400

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

854

1401

for byte in value))

855

1402

prop(value)

856

857

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

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="s",

858

1406

out_signature="a{sv}")

859

1407

def GetAll(self, interface_name):

860

1408

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

861

1409

standard.

862

1410

863

1411

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

864

1412

"""

865

1413

properties = {}

866

for name, prop in self._get_all_dbus_properties():

1414

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

867

1415

if (interface_name

868

1416

and interface_name != prop._dbus_interface):

869

1417

# Interface non-empty but did not match

875

1423

if not hasattr(value, "variant_level"):

876

1424

properties[name] = value

877

1425

continue

878

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

879

value.variant_level+1)

1426

properties[name] = type(value)(

1427

value, variant_level=value.variant_level + 1)

880

1428

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

881

1429

1430

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

1431

def PropertiesChanged(self, interface_name, changed_properties,

1432

invalidated_properties):

1433

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

1434

standard.

1435

"""

1436

pass

1437

882

1438

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

883

1439

out_signature="s",

884

1440

path_keyword='object_path',

885

1441

connection_keyword='connection')

886

1442

def Introspect(self, object_path, connection):

887

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

1443

"""Overloading of standard D-Bus method.

1444

1445

Inserts property tags and interface annotation tags.

888

1446

"""

889

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

890

connection)

1447

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1448

object_path,

1449

connection)

891

1450

try:

892

1451

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

1452

893

1453

def make_tag(document, name, prop):

894

1454

e = document.createElement("property")

895

1455

e.setAttribute("name", name)

896

1456

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

897

1457

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

898

1458

return e

1459

899

1460

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

1461

# Add property tags

900

1462

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

901

1463

for name, prop

902

in self._get_all_dbus_properties()

1464

in self._get_all_dbus_things("property")

903

1465

if prop._dbus_interface

904

1466

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

905

1467

if_tag.appendChild(tag)

1468

# Add annotation tags for properties

1469

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

1470

annots = dict()

1471

for name, prop in self._get_all_dbus_things(

1472

"property"):

1473

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

1474

and prop._dbus_interface

1475

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

1476

annots.update(getattr(

1477

prop, "_dbus_annotations", {}))

1478

for name, value in annots.items():

1479

ann_tag = document.createElement(

1480

"annotation")

1481

ann_tag.setAttribute("name", name)

1482

ann_tag.setAttribute("value", value)

1483

tag.appendChild(ann_tag)

906

1484

# Add the names to the return values for the

907

1485

# "org.freedesktop.DBus.Properties" methods

908

1486

if (if_tag.getAttribute("name")

923

1501

except (AttributeError, xml.dom.DOMException,

924

1502

xml.parsers.expat.ExpatError) as error:

925

1503

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

926

error)

927

return xmlstring

928

929

930

def datetime_to_dbus (dt, variant_level=0):

1504

exc_info=error)

1505

return xmlstring

1506

1507

1508

try:

1509

dbus.OBJECT_MANAGER_IFACE

1510

except AttributeError:

1511

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

1512

1513

1514

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1515

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

1516

1517

Classes inheriting from this exposes the standard

1518

GetManagedObjects call and the InterfacesAdded and

1519

InterfacesRemoved signals on the standard

1520

"org.freedesktop.DBus.ObjectManager" interface.

1521

1522

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

1523

manually.

1524

"""

1525

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1526

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

1527

def GetManagedObjects(self):

1528

"""This function must be overridden"""

1529

raise NotImplementedError()

1530

1531

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1532

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

1533

def InterfacesAdded(self, object_path, interfaces_and_properties):

1534

pass

1535

1536

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

1537

def InterfacesRemoved(self, object_path, interfaces):

1538

pass

1539

1540

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1541

out_signature="s",

1542

path_keyword='object_path',

1543

connection_keyword='connection')

1544

def Introspect(self, object_path, connection):

1545

"""Overloading of standard D-Bus method.

1546

1547

Override return argument name of GetManagedObjects to be

1548

"objpath_interfaces_and_properties"

1549

"""

1550

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1551

object_path,

1552

connection)

1553

try:

1554

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

1555

1556

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

1557

# Fix argument name for the GetManagedObjects method

1558

if (if_tag.getAttribute("name")

1559

== dbus.OBJECT_MANAGER_IFACE):

1560

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

1561

if (cn.getAttribute("name")

1562

== "GetManagedObjects"):

1563

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

1564

if (arg.getAttribute("direction")

1565

== "out"):

1566

arg.setAttribute(

1567

"name",

1568

"objpath_interfaces"

1569

"_and_properties")

1570

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

1571

document.unlink()

1572

except (AttributeError, xml.dom.DOMException,

1573

xml.parsers.expat.ExpatError) as error:

1574

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

1575

exc_info=error)

1576

return xmlstring

1577

1578

1579

def datetime_to_dbus(dt, variant_level=0):

931

1580

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

932

1581

if dt is None:

933

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

1582

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

1583

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

1584

1585

1586

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1587

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

1588

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

1589

interface names according to the "alt_interface_names" mapping.

1590

Usage:

1591

1592

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

1593

"net.example.AlternateInterface"})

1594

class SampleDBusObject(dbus.service.Object):

1595

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

1596

def SampleDBusMethod():

1597

pass

1598

1599

The above "SampleDBusMethod" on "SampleDBusObject" will be

1600

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

1601

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

1602

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

1603

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

1604

1605

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

1606

(from DBusObjectWithProperties) and interfaces (from the

1607

dbus_interface_annotations decorator).

942

1608

"""

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

1609

1610

def wrapper(cls):

1611

for orig_interface_name, alt_interface_name in (

1612

alt_interface_names.items()):

1613

attr = {}

1614

interface_names = set()

1615

# Go though all attributes of the class

1616

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

950

1617

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

951

1618

# with the wrong interface name

952

1619

if (not hasattr(attribute, "_dbus_interface")

953

or not attribute._dbus_interface

954

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

1620

or not attribute._dbus_interface.startswith(

1621

orig_interface_name)):

955

1622

continue

956

1623

# Create an alternate D-Bus interface name based on

957

1624

# the current name

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1625

alt_interface = attribute._dbus_interface.replace(

1626

orig_interface_name, alt_interface_name)

1627

interface_names.add(alt_interface)

961

1628

# Is this a D-Bus signal?

962

1629

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

963

# Extract the original non-method function by

964

# black magic

965

nonmethod_func = (dict(

1630

# Extract the original non-method undecorated

1631

# function by black magic

1632

if sys.version_info.major == 2:

1633

nonmethod_func = (dict(

966

1634

zip(attribute.func_code.co_freevars,

967

attribute.__closure__))["func"]

968

.cell_contents)

1635

attribute.__closure__))

1636

["func"].cell_contents)

1637

else:

1638

nonmethod_func = (dict(

1639

zip(attribute.__code__.co_freevars,

1640

attribute.__closure__))

1641

["func"].cell_contents)

969

1642

# Create a new, but exactly alike, function

970

1643

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

971

1644

# with the alternate D-Bus interface name

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

nonmethod_func.func_closure)))

1645

new_function = copy_function(nonmethod_func)

1646

new_function = (dbus.service.signal(

1647

alt_interface,

1648

attribute._dbus_signature)(new_function))

1649

# Copy annotations, if any

1650

try:

1651

new_function._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1653

except AttributeError:

1654

pass

1655

981

1656

# Define a creator of a function to call both the

982

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

983

# signals gets sent when the function is called

1657

# original and alternate functions, so both the

1658

# original and alternate signals gets sent when

1659

# the function is called

984

1660

def fixscope(func1, func2):

985

1661

"""This function is a scope container to pass

986

1662

func1 and func2 to the "call_both" function

987

1663

outside of its arguments"""

1664

1665

@functools.wraps(func2)

988

1666

def call_both(*args, **kwargs):

989

1667

"""This function will emit two D-Bus

990

1668

signals by calling func1 and func2"""

991

1669

func1(*args, **kwargs)

992

1670

func2(*args, **kwargs)

1671

# Make wrapper function look like a D-Bus

1672

# signal

1673

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

1674

if name.startswith("_dbus_"):

1675

setattr(call_both, name, attr)

1676

993

1677

return call_both

994

1678

# Create the "call_both" function and add it to

995

1679

# the class

996

attr[attrname] = fixscope(attribute,

997

new_function)

1680

attr[attrname] = fixscope(attribute, new_function)

998

1681

# Is this a D-Bus method?

999

1682

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

1000

1683

# Create a new, but exactly alike, function

1001

1684

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

1002

1685

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

1003

1686

# to the class.

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

attribute.func_closure)))

1687

attr[attrname] = (

1688

dbus.service.method(

1689

alt_interface,

1690

attribute._dbus_in_signature,

1691

attribute._dbus_out_signature)

1692

(copy_function(attribute)))

1693

# Copy annotations, if any

1694

try:

1695

attr[attrname]._dbus_annotations = dict(

1696

attribute._dbus_annotations)

1697

except AttributeError:

1698

pass

1014

1699

# Is this a D-Bus property?

1015

1700

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

1016

1701

# Create a new, but exactly alike, function

1017

1702

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

1018

1703

# property with the alternate D-Bus interface

1019

1704

# name. Add it to the class.

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

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

1034

1035

1705

attr[attrname] = (dbus_service_property(

1706

alt_interface, attribute._dbus_signature,

1707

attribute._dbus_access,

1708

attribute._dbus_get_args_options

1709

["byte_arrays"])

1710

(copy_function(attribute)))

1711

# Copy annotations, if any

1712

try:

1713

attr[attrname]._dbus_annotations = dict(

1714

attribute._dbus_annotations)

1715

except AttributeError:

1716

pass

1717

# Is this a D-Bus interface?

1718

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

1719

# Create a new, but exactly alike, function

1720

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

1721

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

1722

# to the class.

1723

attr[attrname] = (

1724

dbus_interface_annotations(alt_interface)

1725

(copy_function(attribute)))

1726

if deprecate:

1727

# Deprecate all alternate interfaces

1728

iname = "_AlternateDBusNames_interface_annotation{}"

1729

for interface_name in interface_names:

1730

1731

@dbus_interface_annotations(interface_name)

1732

def func(self):

1733

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

1734

"true"}

1735

# Find an unused name

1736

for aname in (iname.format(i)

1737

for i in itertools.count()):

1738

if aname not in attr:

1739

attr[aname] = func

1740

break

1741

if interface_names:

1742

# Replace the class with a new subclass of it with

1743

# methods, signals, etc. as created above.

1744

if sys.version_info.major == 2:

1745

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

1746

(cls, ), attr)

1747

else:

1748

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

1749

(cls, ), attr)

1750

return cls

1751

1752

return wrapper

1753

1754

1755

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

1756

"se.bsnet.fukt.Mandos"})

1036

1757

class ClientDBus(Client, DBusObjectWithProperties):

1037

1758

"""A Client class using D-Bus

1038

1759

1039

1760

Attributes:

1040

1761

dbus_object_path: dbus.ObjectPath

1041

1762

bus: dbus.SystemBus()

1042

1763

"""

1043

1764

1044

1765

runtime_expansions = (Client.runtime_expansions

1045

+ ("dbus_object_path",))

1046

1766

+ ("dbus_object_path", ))

1767

1768

_interface = "se.recompile.Mandos.Client"

1769

1047

1770

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

1048

1049

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

1771

1772

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

1050

1773

self.bus = bus

1051

1774

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

1052

1775

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

1053

1776

# the D-Bus

1054

client_object_name = unicode(self.name).translate(

1777

client_object_name = str(self.name).translate(

1055

1778

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

1056

1779

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

1057

self.dbus_object_path = (dbus.ObjectPath

1058

("/clients/" + client_object_name))

1780

self.dbus_object_path = dbus.ObjectPath(

1781

"/clients/" + client_object_name)

1059

1782

DBusObjectWithProperties.__init__(self, self.bus,

1060

1783

self.dbus_object_path)

1061

1062

def notifychangeproperty(transform_func,

1063

dbus_name, type_func=lambda x: x,

1064

variant_level=1):

1784

1785

def notifychangeproperty(transform_func, dbus_name,

1786

type_func=lambda x: x,

1787

variant_level=1,

1788

invalidate_only=False,

1789

_interface=_interface):

1065

1790

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

1066

1791

its changes to DBus.

1067

1792

1068

1793

transform_fun: Function that takes a value and a variant_level

1069

1794

and transforms it to a D-Bus type.

1070

1795

dbus_name: D-Bus name of the variable

1072

1797

to the D-Bus. Default: no transform

1073

1798

variant_level: D-Bus variant level. Default: 1

1074

1799

"""

1075

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

1800

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

1801

1076

1802

def setter(self, value):

1077

1803

if hasattr(self, "dbus_object_path"):

1078

1804

if (not hasattr(self, attrname) or

1079

1805

type_func(getattr(self, attrname, None))

1080

1806

!= type_func(value)):

1081

dbus_value = transform_func(type_func(value),

1082

variant_level

1083

=variant_level)

1084

self.PropertyChanged(dbus.String(dbus_name),

1085

dbus_value)

1807

if invalidate_only:

1808

self.PropertiesChanged(

1809

_interface, dbus.Dictionary(),

1810

dbus.Array((dbus_name, )))

1811

else:

1812

dbus_value = transform_func(

1813

type_func(value),

1814

variant_level=variant_level)

1815

self.PropertyChanged(dbus.String(dbus_name),

1816

dbus_value)

1817

self.PropertiesChanged(

1818

_interface,

1819

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

1820

dbus_value}),

1821

dbus.Array())

1086

1822

setattr(self, attrname, value)

1087

1823

1088

1824

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

1089

1090

1825

1091

1826

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1092

1827

approvals_pending = notifychangeproperty(dbus.Boolean,

1093

1828

"ApprovalPending",

1094

type_func = bool)

1829

type_func=bool)

1095

1830

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

1096

1831

last_enabled = notifychangeproperty(datetime_to_dbus,

1097

1832

"LastEnabled")

1098

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

1099

type_func = lambda checker:

1100

checker is not None)

1833

checker = notifychangeproperty(

1834

dbus.Boolean, "CheckerRunning",

1835

type_func=lambda checker: checker is not None)

1101

1836

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1102

1837

"LastCheckedOK")

1838

last_checker_status = notifychangeproperty(dbus.Int16,

1839

"LastCheckerStatus")

1103

1840

last_approval_request = notifychangeproperty(

1104

1841

datetime_to_dbus, "LastApprovalRequest")

1105

1842

approved_by_default = notifychangeproperty(dbus.Boolean,

1106

1843

"ApprovedByDefault")

1107

approval_delay = notifychangeproperty(dbus.UInt64,

1108

"ApprovalDelay",

1109

type_func =

1110

timedelta_to_milliseconds)

1844

approval_delay = notifychangeproperty(

1845

dbus.UInt64, "ApprovalDelay",

1846

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

1111

1847

approval_duration = notifychangeproperty(

1112

1848

dbus.UInt64, "ApprovalDuration",

1113

type_func = timedelta_to_milliseconds)

1849

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

1114

1850

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

1115

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

1116

type_func =

1117

timedelta_to_milliseconds)

1851

timeout = notifychangeproperty(

1852

dbus.UInt64, "Timeout",

1853

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

1118

1854

extended_timeout = notifychangeproperty(

1119

1855

dbus.UInt64, "ExtendedTimeout",

1120

type_func = timedelta_to_milliseconds)

1121

interval = notifychangeproperty(dbus.UInt64,

1122

"Interval",

1123

type_func =

1124

timedelta_to_milliseconds)

1856

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

1857

interval = notifychangeproperty(

1858

dbus.UInt64, "Interval",

1859

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

1125

1860

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

1126

1861

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

1862

invalidate_only=True)

1863

1127

1864

del notifychangeproperty

1128

1865

1129

1866

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

1130

1867

try:

1131

1868

self.remove_from_connection()

1134

1871

if hasattr(DBusObjectWithProperties, "__del__"):

1135

1872

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

1136

1873

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

1137

1138

def checker_callback(self, pid, condition, command,

1139

*args, **kwargs):

1140

self.checker_callback_tag = None

1141

self.checker = None

1142

if os.WIFEXITED(condition):

1143

exitstatus = os.WEXITSTATUS(condition)

1874

1875

def checker_callback(self, source, condition,

1876

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

1877

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

1878

connection, command, *args,

1879

**kwargs)

1880

exitstatus = self.last_checker_status

1881

if exitstatus >= 0:

1144

1882

# Emit D-Bus signal

1145

1883

self.CheckerCompleted(dbus.Int16(exitstatus),

1146

dbus.Int64(condition),

1884

# This is specific to GNU libC

1885

dbus.Int64(exitstatus << 8),

1147

1886

dbus.String(command))

1148

1887

else:

1149

1888

# Emit D-Bus signal

1150

1889

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

1151

dbus.Int64(condition),

1890

dbus.Int64(

1891

# This is specific to GNU libC

1892

(exitstatus << 8)

1893

| self.last_checker_signal),

1152

1894

dbus.String(command))

1153

1154

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

1155

*args, **kwargs)

1156

1895

return ret

1896

1157

1897

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

1158

old_checker = self.checker

1159

if self.checker is not None:

1160

old_checker_pid = self.checker.pid

1161

else:

1162

old_checker_pid = None

1898

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

1163

1899

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

1164

1900

# Only if new checker process was started

1165

1901

if (self.checker is not None

1167

1903

# Emit D-Bus signal

1168

1904

self.CheckerStarted(self.current_checker_command)

1169

1905

return r

1170

1906

1171

1907

def _reset_approved(self):

1172

1908

self.approved = None

1173

1909

return False

1174

1910

1175

1911

def approve(self, value=True):

1176

self.send_changedstate()

1177

1912

self.approved = value

1178

gobject.timeout_add(timedelta_to_milliseconds

1179

(self.approval_duration),

1180

self._reset_approved)

1181

1182

1183

## D-Bus methods, signals & properties

1184

_interface = "se.recompile.Mandos.Client"

1185

1186

## Signals

1187

1913

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

1914

* 1000), self._reset_approved)

1915

self.send_changedstate()

1916

1917

# D-Bus methods, signals & properties

1918

1919

# Interfaces

1920

1921

# Signals

1922

1188

1923

# CheckerCompleted - signal

1189

1924

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

1190

1925

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

1191

1926

"D-Bus signal"

1192

1927

pass

1193

1928

1194

1929

# CheckerStarted - signal

1195

1930

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

1196

1931

def CheckerStarted(self, command):

1197

1932

"D-Bus signal"

1198

1933

pass

1199

1934

1200

1935

# PropertyChanged - signal

1936

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

1201

1937

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

1202

1938

def PropertyChanged(self, property, value):

1203

1939

"D-Bus signal"

1204

1940

pass

1205

1941

1206

1942

# GotSecret - signal

1207

1943

@dbus.service.signal(_interface)

1208

1944

def GotSecret(self):

1211

1947

server to mandos-client

1212

1948

"""

1213

1949

pass

1214

1950

1215

1951

# Rejected - signal

1216

1952

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

1217

1953

def Rejected(self, reason):

1218

1954

"D-Bus signal"

1219

1955

pass

1220

1956

1221

1957

# NeedApproval - signal

1222

1958

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

1223

1959

def NeedApproval(self, timeout, default):

1224

1960

"D-Bus signal"

1225

1961

return self.need_approval()

1226

1227

## Methods

1228

1962

1963

# Methods

1964

1229

1965

# Approve - method

1230

1966

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

1231

1967

def Approve(self, value):

1232

1968

self.approve(value)

1233

1969

1234

1970

# CheckedOK - method

1235

1971

@dbus.service.method(_interface)

1236

1972

def CheckedOK(self):

1237

1973

self.checked_ok()

1238

1974

1239

1975

# Enable - method

1976

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

1240

1977

@dbus.service.method(_interface)

1241

1978

def Enable(self):

1242

1979

"D-Bus method"

1243

1980

self.enable()

1244

1981

1245

1982

# StartChecker - method

1983

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

1246

1984

@dbus.service.method(_interface)

1247

1985

def StartChecker(self):

1248

1986

"D-Bus method"

1249

1987

self.start_checker()

1250

1988

1251

1989

# Disable - method

1990

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

1252

1991

@dbus.service.method(_interface)

1253

1992

def Disable(self):

1254

1993

"D-Bus method"

1255

1994

self.disable()

1256

1995

1257

1996

# StopChecker - method

1997

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

1258

1998

@dbus.service.method(_interface)

1259

1999

def StopChecker(self):

1260

2000

self.stop_checker()

1261

1262

## Properties

1263

2001

2002

# Properties

2003

1264

2004

# ApprovalPending - property

1265

2005

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

1266

2006

def ApprovalPending_dbus_property(self):

1267

2007

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

1268

2008

1269

2009

# ApprovedByDefault - property

1270

@dbus_service_property(_interface, signature="b",

2010

@dbus_service_property(_interface,

2011

signature="b",

1271

2012

access="readwrite")

1272

2013

def ApprovedByDefault_dbus_property(self, value=None):

1273

2014

if value is None: # get

1274

2015

return dbus.Boolean(self.approved_by_default)

1275

2016

self.approved_by_default = bool(value)

1276

2017

1277

2018

# ApprovalDelay - property

1278

@dbus_service_property(_interface, signature="t",

2019

@dbus_service_property(_interface,

2020

signature="t",

1279

2021

access="readwrite")

1280

2022

def ApprovalDelay_dbus_property(self, value=None):

1281

2023

if value is None: # get

1282

return dbus.UInt64(self.approval_delay_milliseconds())

2024

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

2025

* 1000)

1283

2026

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

1284

2027

1285

2028

# ApprovalDuration - property

1286

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1287

2031

access="readwrite")

1288

2032

def ApprovalDuration_dbus_property(self, value=None):

1289

2033

if value is None: # get

1290

return dbus.UInt64(timedelta_to_milliseconds(

1291

self.approval_duration))

2034

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

2035

* 1000)

1292

2036

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

1293

2037

1294

2038

# Name - property

2039

@dbus_annotations(

2040

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

1295

2041

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

1296

2042

def Name_dbus_property(self):

1297

2043

return dbus.String(self.name)

1298

2044

2045

# KeyID - property

2046

@dbus_annotations(

2047

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

2048

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

2049

def KeyID_dbus_property(self):

2050

return dbus.String(self.key_id)

2051

1299

2052

# Fingerprint - property

2053

@dbus_annotations(

2054

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

1300

2055

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

1301

2056

def Fingerprint_dbus_property(self):

1302

2057

return dbus.String(self.fingerprint)

1303

2058

1304

2059

# Host - property

1305

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1306

2062

access="readwrite")

1307

2063

def Host_dbus_property(self, value=None):

1308

2064

if value is None: # get

1309

2065

return dbus.String(self.host)

1310

self.host = unicode(value)

1311

2066

self.host = str(value)

2067

1312

2068

# Created - property

2069

@dbus_annotations(

2070

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

1313

2071

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

1314

2072

def Created_dbus_property(self):

1315

2073

return datetime_to_dbus(self.created)

1316

2074

1317

2075

# LastEnabled - property

1318

2076

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

1319

2077

def LastEnabled_dbus_property(self):

1320

2078

return datetime_to_dbus(self.last_enabled)

1321

2079

1322

2080

# Enabled - property

1323

@dbus_service_property(_interface, signature="b",

2081

@dbus_service_property(_interface,

2082

signature="b",

1324

2083

access="readwrite")

1325

2084

def Enabled_dbus_property(self, value=None):

1326

2085

if value is None: # get

1329

2088

self.enable()

1330

2089

else:

1331

2090

self.disable()

1332

2091

1333

2092

# LastCheckedOK - property

1334

@dbus_service_property(_interface, signature="s",

2093

@dbus_service_property(_interface,

2094

signature="s",

1335

2095

access="readwrite")

1336

2096

def LastCheckedOK_dbus_property(self, value=None):

1337

2097

if value is not None:

1338

2098

self.checked_ok()

1339

2099

return

1340

2100

return datetime_to_dbus(self.last_checked_ok)

1341

2101

2102

# LastCheckerStatus - property

2103

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

2104

def LastCheckerStatus_dbus_property(self):

2105

return dbus.Int16(self.last_checker_status)

2106

1342

2107

# Expires - property

1343

2108

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

1344

2109

def Expires_dbus_property(self):

1345

2110

return datetime_to_dbus(self.expires)

1346

2111

1347

2112

# LastApprovalRequest - property

1348

2113

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

1349

2114

def LastApprovalRequest_dbus_property(self):

1350

2115

return datetime_to_dbus(self.last_approval_request)

1351

2116

1352

2117

# Timeout - property

1353

@dbus_service_property(_interface, signature="t",

2118

@dbus_service_property(_interface,

2119

signature="t",

1354

2120

access="readwrite")

1355

2121

def Timeout_dbus_property(self, value=None):

1356

2122

if value is None: # get

1357

return dbus.UInt64(self.timeout_milliseconds())

2123

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

2124

old_timeout = self.timeout

1358

2125

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

1359

# Reschedule timeout

2126

# Reschedule disabling

1360

2127

if self.enabled:

1361

2128

now = datetime.datetime.utcnow()

1362

time_to_die = timedelta_to_milliseconds(

1363

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

1364

if time_to_die <= 0:

2129

self.expires += self.timeout - old_timeout

2130

if self.expires <= now:

1365

2131

# The timeout has passed

1366

2132

self.disable()

1367

2133

else:

1368

self.expires = (now +

1369

datetime.timedelta(milliseconds =

1370

time_to_die))

1371

2134

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

1372

2135

is None):

1373

2136

return

1374

gobject.source_remove(self.disable_initiator_tag)

1375

self.disable_initiator_tag = (gobject.timeout_add

1376

(time_to_die,

1377

self.disable))

1378

2137

GLib.source_remove(self.disable_initiator_tag)

2138

self.disable_initiator_tag = GLib.timeout_add(

2139

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

2140

self.disable)

2141

1379

2142

# ExtendedTimeout - property

1380

@dbus_service_property(_interface, signature="t",

2143

@dbus_service_property(_interface,

2144

signature="t",

1381

2145

access="readwrite")

1382

2146

def ExtendedTimeout_dbus_property(self, value=None):

1383

2147

if value is None: # get

1384

return dbus.UInt64(self.extended_timeout_milliseconds())

2148

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

2149

* 1000)

1385

2150

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

1386

2151

1387

2152

# Interval - property

1388

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1389

2155

access="readwrite")

1390

2156

def Interval_dbus_property(self, value=None):

1391

2157

if value is None: # get

1392

return dbus.UInt64(self.interval_milliseconds())

2158

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

1393

2159

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

1394

2160

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

1395

2161

return

1396

2162

if self.enabled:

1397

2163

# Reschedule checker run

1398

gobject.source_remove(self.checker_initiator_tag)

1399

self.checker_initiator_tag = (gobject.timeout_add

1400

(value, self.start_checker))

1401

self.start_checker() # Start one now, too

1402

2164

GLib.source_remove(self.checker_initiator_tag)

2165

self.checker_initiator_tag = GLib.timeout_add(

2166

value, self.start_checker)

2167

self.start_checker() # Start one now, too

2168

1403

2169

# Checker - property

1404

@dbus_service_property(_interface, signature="s",

2170

@dbus_service_property(_interface,

2171

signature="s",

1405

2172

access="readwrite")

1406

2173

def Checker_dbus_property(self, value=None):

1407

2174

if value is None: # get

1408

2175

return dbus.String(self.checker_command)

1409

self.checker_command = unicode(value)

1410

2176

self.checker_command = str(value)

2177

1411

2178

# CheckerRunning - property

1412

@dbus_service_property(_interface, signature="b",

2179

@dbus_service_property(_interface,

2180

signature="b",

1413

2181

access="readwrite")

1414

2182

def CheckerRunning_dbus_property(self, value=None):

1415

2183

if value is None: # get

1418

2186

self.start_checker()

1419

2187

else:

1420

2188

self.stop_checker()

1421

2189

1422

2190

# ObjectPath - property

2191

@dbus_annotations(

2192

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

2193

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

1423

2194

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

1424

2195

def ObjectPath_dbus_property(self):

1425

return self.dbus_object_path # is already a dbus.ObjectPath

1426

2196

return self.dbus_object_path # is already a dbus.ObjectPath

2197

1427

2198

# Secret = property

1428

@dbus_service_property(_interface, signature="ay",

1429

access="write", byte_arrays=True)

2199

@dbus_annotations(

2200

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

2201

"invalidates"})

2202

@dbus_service_property(_interface,

2203

signature="ay",

2204

access="write",

2205

byte_arrays=True)

1430

2206

def Secret_dbus_property(self, value):

1431

self.secret = str(value)

1432

2207

self.secret = bytes(value)

2208

1433

2209

del _interface

1434

2210

1435

2211

1436

2212

class ProxyClient(object):

1437

def __init__(self, child_pipe, fpr, address):

2213

def __init__(self, child_pipe, key_id, fpr, address):

1438

2214

self._pipe = child_pipe

1439

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

2215

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

1440

2216

if not self._pipe.recv():

1441

raise KeyError()

1442

2217

raise KeyError(key_id or fpr)

2218

1443

2219

def __getattribute__(self, name):

1444

2220

if name == '_pipe':

1445

2221

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

1448

2224

if data[0] == 'data':

1449

2225

return data[1]

1450

2226

if data[0] == 'function':

2227

1451

2228

def func(*args, **kwargs):

1452

2229

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

1453

2230

return self._pipe.recv()[1]

2231

1454

2232

return func

1455

2233

1456

2234

def __setattr__(self, name, value):

1457

2235

if name == '_pipe':

1458

2236

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

1459

2237

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

1460

2238

1461

2239

1462

class ClientDBusTransitional(ClientDBus):

1463

__metaclass__ = AlternateDBusNamesMetaclass

1464

1465

1466

2240

class ClientHandler(socketserver.BaseRequestHandler, object):

1467

2241

"""A class to handle client connections.

1468

2242

1469

2243

Instantiated once for each connection to handle it.

1470

2244

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

1471

2245

1472

2246

def handle(self):

1473

2247

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

1474

2248

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

1475

unicode(self.client_address))

2249

str(self.client_address))

1476

2250

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

1477

2251

self.server.child_pipe.fileno())

1478

1479

session = (gnutls.connection

1480

.ClientSession(self.request,

1481

gnutls.connection

1482

.X509Credentials()))

1483

1484

# Note: gnutls.connection.X509Credentials is really a

1485

# generic GnuTLS certificate credentials object so long as

1486

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

1487

# here despite using OpenPGP certificates.

1488

1489

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

1490

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

1491

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

1492

# "+DHE-DSS"))

2252

2253

session = gnutls.ClientSession(self.request)

2254

2255

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

2256

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

2257

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

2258

# "+DHE-DSS"))

1493

2259

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

1494

2260

priority = self.server.gnutls_priority

1495

2261

if priority is None:

1496

2262

priority = "NORMAL"

1497

(gnutls.library.functions

1498

.gnutls_priority_set_direct(session._c_object,

1499

priority, None))

1500

2263

gnutls.priority_set_direct(session._c_object,

2264

priority.encode("utf-8"),

2265

None)

2266

1501

2267

# Start communication using the Mandos protocol

1502

2268

# Get protocol number

1503

2269

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

1504

2270

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

1505

2271

try:

1506

2272

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

1507

raise RuntimeError

2273

raise RuntimeError(line)

1508

2274

except (ValueError, IndexError, RuntimeError) as error:

1509

2275

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

1510

2276

return

1511

2277

1512

2278

# Start GnuTLS connection

1513

2279

try:

1514

2280

session.handshake()

1515

except gnutls.errors.GNUTLSError as error:

2281

except gnutls.Error as error:

1516

2282

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

1517

2283

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

1518

2284

# established. Just abandon the request.

1519

2285

return

1520

2286

logger.debug("Handshake succeeded")

1521

2287

1522

2288

approval_required = False

1523

2289

try:

1524

try:

1525

fpr = self.fingerprint(self.peer_certificate

1526

(session))

1527

except (TypeError,

1528

gnutls.errors.GNUTLSError) as error:

1529

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

1530

return

1531

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

1532

1533

try:

1534

client = ProxyClient(child_pipe, fpr,

2290

if gnutls.has_rawpk:

2291

fpr = b""

2292

try:

2293

key_id = self.key_id(

2294

self.peer_certificate(session))

2295

except (TypeError, gnutls.Error) as error:

2296

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

2297

return

2298

logger.debug("Key ID: %s", key_id)

2299

2300

else:

2301

key_id = b""

2302

try:

2303

fpr = self.fingerprint(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

try:

2311

client = ProxyClient(child_pipe, key_id, fpr,

1535

2312

self.client_address)

1536

2313

except KeyError:

1537

2314

return

1538

2315

1539

2316

if client.approval_delay:

1540

2317

delay = client.approval_delay

1541

2318

client.approvals_pending += 1

1542

2319

approval_required = True

1543

2320

1544

2321

while True:

1545

2322

if not client.enabled:

1546

2323

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

1547

client.name)

2324

client.name)

1548

2325

if self.server.use_dbus:

1549

2326

# Emit D-Bus signal

1550

2327

client.Rejected("Disabled")

1551

2328

return

1552

2329

1553

2330

if client.approved or not client.approval_delay:

1554

#We are approved or approval is disabled

2331

# We are approved or approval is disabled

1555

2332

break

1556

2333

elif client.approved is None:

1557

2334

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

1559

2336

if self.server.use_dbus:

1560

2337

# Emit D-Bus signal

1561

2338

client.NeedApproval(

1562

client.approval_delay_milliseconds(),

1563

client.approved_by_default)

2339

client.approval_delay.total_seconds()

2340

* 1000, client.approved_by_default)

1564

2341

else:

1565

2342

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

1566

2343

client.name)

1568

2345

# Emit D-Bus signal

1569

2346

client.Rejected("Denied")

1570

2347

return

1571

1572

#wait until timeout or approved

2348

2349

# wait until timeout or approved

1573

2350

time = datetime.datetime.now()

1574

2351

client.changedstate.acquire()

1575

(client.changedstate.wait

1576

(float(client.timedelta_to_milliseconds(delay)

1577

/ 1000)))

2352

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

1578

2353

client.changedstate.release()

1579

2354

time2 = datetime.datetime.now()

1580

2355

if (time2 - time) >= delay:

1590

2365

break

1591

2366

else:

1592

2367

delay -= time2 - time

1593

1594

sent_size = 0

1595

while sent_size < len(client.secret):

1596

try:

1597

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

1598

except gnutls.errors.GNUTLSError as error:

1599

logger.warning("gnutls send failed")

1600

return

1601

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

1602

sent, len(client.secret)

1603

- (sent_size + sent))

1604

sent_size += sent

1605

2368

2369

try:

2370

session.send(client.secret)

2371

except gnutls.Error as error:

2372

logger.warning("gnutls send failed",

2373

exc_info=error)

2374

return

2375

1606

2376

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

1607

2377

# bump the timeout using extended_timeout

1608

client.checked_ok(client.extended_timeout)

2378

client.bump_timeout(client.extended_timeout)

1609

2379

if self.server.use_dbus:

1610

2380

# Emit D-Bus signal

1611

2381

client.GotSecret()

1612

2382

1613

2383

finally:

1614

2384

if approval_required:

1615

2385

client.approvals_pending -= 1

1616

2386

try:

1617

2387

session.bye()

1618

except gnutls.errors.GNUTLSError as error:

1619

logger.warning("GnuTLS bye failed")

1620

2388

except gnutls.Error as error:

2389

logger.warning("GnuTLS bye failed",

2390

exc_info=error)

2391

1621

2392

@staticmethod

1622

2393

def peer_certificate(session):

1623

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

1624

# If not an OpenPGP certificate...

1625

if (gnutls.library.functions

1626

.gnutls_certificate_type_get(session._c_object)

1627

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1628

# ...do the normal thing

1629

return session.peer_certificate

2394

"Return the peer's certificate as a bytestring"

2395

try:

2396

cert_type = gnutls.certificate_type_get2(session._c_object,

2397

gnutls.CTYPE_PEERS)

2398

except AttributeError:

2399

cert_type = gnutls.certificate_type_get(session._c_object)

2400

if gnutls.has_rawpk:

2401

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2402

else:

2403

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2404

# If not a valid certificate type...

2405

if cert_type not in valid_cert_types:

2406

logger.info("Cert type %r not in %r", cert_type,

2407

valid_cert_types)

2408

# ...return invalid data

2409

return b""

1630

2410

list_size = ctypes.c_uint(1)

1631

cert_list = (gnutls.library.functions

1632

.gnutls_certificate_get_peers

2411

cert_list = (gnutls.certificate_get_peers

1633

2412

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

1634

2413

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

1635

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

1636

" certificate")

2414

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

1637

2415

if list_size.value == 0:

1638

2416

return None

1639

2417

cert = cert_list[0]

1640

2418

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

1641

2419

2420

@staticmethod

2421

def key_id(certificate):

2422

"Convert a certificate bytestring to a hexdigit key ID"

2423

# New GnuTLS "datum" with the public key

2424

datum = gnutls.datum_t(

2425

ctypes.cast(ctypes.c_char_p(certificate),

2426

ctypes.POINTER(ctypes.c_ubyte)),

2427

ctypes.c_uint(len(certificate)))

2428

# XXX all these need to be created in the gnutls "module"

2429

# New empty GnuTLS certificate

2430

pubkey = gnutls.pubkey_t()

2431

gnutls.pubkey_init(ctypes.byref(pubkey))

2432

# Import the raw public key into the certificate

2433

gnutls.pubkey_import(pubkey,

2434

ctypes.byref(datum),

2435

gnutls.X509_FMT_DER)

2436

# New buffer for the key ID

2437

buf = ctypes.create_string_buffer(32)

2438

buf_len = ctypes.c_size_t(len(buf))

2439

# Get the key ID from the raw public key into the buffer

2440

gnutls.pubkey_get_key_id(pubkey,

2441

gnutls.KEYID_USE_SHA256,

2442

ctypes.cast(ctypes.byref(buf),

2443

ctypes.POINTER(ctypes.c_ubyte)),

2444

ctypes.byref(buf_len))

2445

# Deinit the certificate

2446

gnutls.pubkey_deinit(pubkey)

2447

2448

# Convert the buffer to a Python bytestring

2449

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

2450

# Convert the bytestring to hexadecimal notation

2451

hex_key_id = binascii.hexlify(key_id).upper()

2452

return hex_key_id

2453

1642

2454

@staticmethod

1643

2455

def fingerprint(openpgp):

1644

2456

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1645

2457

# New GnuTLS "datum" with the OpenPGP public key

1646

datum = (gnutls.library.types

1647

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

1648

ctypes.POINTER

1649

(ctypes.c_ubyte)),

1650

ctypes.c_uint(len(openpgp))))

2458

datum = gnutls.datum_t(

2459

ctypes.cast(ctypes.c_char_p(openpgp),

2460

ctypes.POINTER(ctypes.c_ubyte)),

2461

ctypes.c_uint(len(openpgp)))

1651

2462

# New empty GnuTLS certificate

1652

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1653

(gnutls.library.functions

1654

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2463

crt = gnutls.openpgp_crt_t()

2464

gnutls.openpgp_crt_init(ctypes.byref(crt))

1655

2465

# Import the OpenPGP public key into the certificate

1656

(gnutls.library.functions

1657

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

1658

gnutls.library.constants

1659

.GNUTLS_OPENPGP_FMT_RAW))

2466

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

2467

gnutls.OPENPGP_FMT_RAW)

1660

2468

# Verify the self signature in the key

1661

2469

crtverify = ctypes.c_uint()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_verify_self(crt, 0,

1664

ctypes.byref(crtverify)))

2470

gnutls.openpgp_crt_verify_self(crt, 0,

2471

ctypes.byref(crtverify))

1665

2472

if crtverify.value != 0:

1666

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1667

raise (gnutls.errors.CertificateSecurityError

1668

("Verify failed"))

2473

gnutls.openpgp_crt_deinit(crt)

2474

raise gnutls.CertificateSecurityError(code

2475

=crtverify.value)

1669

2476

# New buffer for the fingerprint

1670

2477

buf = ctypes.create_string_buffer(20)

1671

2478

buf_len = ctypes.c_size_t()

1672

2479

# Get the fingerprint from the certificate into the buffer

1673

(gnutls.library.functions

1674

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

1675

ctypes.byref(buf_len)))

2480

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

2481

ctypes.byref(buf_len))

1676

2482

# Deinit the certificate

1677

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

gnutls.openpgp_crt_deinit(crt)

1678

2484

# Convert the buffer to a Python bytestring

1679

2485

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

1680

2486

# Convert the bytestring to hexadecimal notation

1684

2490

1685

2491

class MultiprocessingMixIn(object):

1686

2492

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

2493

1687

2494

def sub_process_main(self, request, address):

1688

2495

try:

1689

2496

self.finish_request(request, address)

1690

2497

except Exception:

1691

2498

self.handle_error(request, address)

1692

2499

self.close_request(request)

1693

2500

1694

2501

def process_request(self, request, address):

1695

2502

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

1696

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

1697

args = (request,

1698

address))

2503

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

2504

args=(request, address))

1699

2505

proc.start()

1700

2506

return proc

1701

2507

1702

2508

1703

2509

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1704

2510

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

2511

1705

2512

def process_request(self, request, client_address):

1706

2513

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

1707

2514

1708

2515

This function creates a new pipe in self.pipe

1709

2516

"""

1710

2517

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1711

2518

1712

2519

proc = MultiprocessingMixIn.process_request(self, request,

1713

2520

client_address)

1714

2521

self.child_pipe.close()

1715

2522

self.add_pipe(parent_pipe, proc)

1716

2523

1717

2524

def add_pipe(self, parent_pipe, proc):

1718

2525

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

1719

raise NotImplementedError

2526

raise NotImplementedError()

1720

2527

1721

2528

1722

2529

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1723

2530

socketserver.TCPServer, object):

1724

2531

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

1725

2532

1726

2533

Attributes:

1727

2534

enabled: Boolean; whether this server is activated yet

1728

2535

interface: None or a network interface name (string)

1729

2536

use_ipv6: Boolean; to use IPv6 or not

1730

2537

"""

2538

1731

2539

def __init__(self, server_address, RequestHandlerClass,

1732

interface=None, use_ipv6=True):

2540

interface=None,

2541

use_ipv6=True,

2542

socketfd=None):

2543

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

2544

creating a new one with socket.socket().

2545

"""

1733

2546

self.interface = interface

1734

2547

if use_ipv6:

1735

2548

self.address_family = socket.AF_INET6

2549

if socketfd is not None:

2550

# Save the file descriptor

2551

self.socketfd = socketfd

2552

# Save the original socket.socket() function

2553

self.socket_socket = socket.socket

2554

2555

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

2556

#

2557

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

2558

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

2559

# patching socket.socket.)

2560

#

2561

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

2562

@functools.wraps(socket.socket)

2563

def socket_wrapper(*args, **kwargs):

2564

# Restore original function so subsequent calls are

2565

# not affected.

2566

socket.socket = self.socket_socket

2567

del self.socket_socket

2568

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

2569

# saved file descriptor.

2570

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

2571

# Replace socket.socket() function with wrapper

2572

socket.socket = socket_wrapper

2573

# The socketserver.TCPServer.__init__ will call

2574

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

2575

# socket_wrapper(), if socketfd was set.

1736

2576

socketserver.TCPServer.__init__(self, server_address,

1737

2577

RequestHandlerClass)

2578

1738

2579

def server_bind(self):

1739

2580

"""This overrides the normal server_bind() function

1740

2581

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

1741

2582

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

2583

global SO_BINDTODEVICE

1742

2584

if self.interface is not None:

1743

2585

if SO_BINDTODEVICE is None:

1744

logger.error("SO_BINDTODEVICE does not exist;"

1745

" cannot bind to interface %s",

1746

self.interface)

1747

else:

1748

try:

1749

self.socket.setsockopt(socket.SOL_SOCKET,

1750

SO_BINDTODEVICE,

1751

str(self.interface

1752

+ '\0'))

1753

except socket.error as error:

1754

if error[0] == errno.EPERM:

1755

logger.error("No permission to"

1756

" bind to interface %s",

1757

self.interface)

1758

elif error[0] == errno.ENOPROTOOPT:

1759

logger.error("SO_BINDTODEVICE not available;"

1760

" cannot bind to interface %s",

1761

self.interface)

1762

else:

1763

raise

2586

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

2587

# common enough.

2588

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

2589

SO_BINDTODEVICE = 25

2590

try:

2591

self.socket.setsockopt(

2592

socket.SOL_SOCKET, SO_BINDTODEVICE,

2593

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

2594

except socket.error as error:

2595

if error.errno == errno.EPERM:

2596

logger.error("No permission to bind to"

2597

" interface %s", self.interface)

2598

elif error.errno == errno.ENOPROTOOPT:

2599

logger.error("SO_BINDTODEVICE not available;"

2600

" cannot bind to interface %s",

2601

self.interface)

2602

elif error.errno == errno.ENODEV:

2603

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

2604

" cannot bind", self.interface)

2605

else:

2606

raise

1764

2607

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

1765

2608

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

2609

if self.server_address[1]:

2610

self.allow_reuse_address = True

1766

2611

if not self.server_address[0]:

1767

2612

if self.address_family == socket.AF_INET6:

1768

any_address = "::" # in6addr_any

2613

any_address = "::" # in6addr_any

1769

2614

else:

1770

any_address = socket.INADDR_ANY

2615

any_address = "0.0.0.0" # INADDR_ANY

1771

2616

self.server_address = (any_address,

1772

2617

self.server_address[1])

1773

2618

elif not self.server_address[1]:

1774

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

1775

0)

2619

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

1776

2620

# if self.interface:

1777

2621

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

1778

2622

# 0, # port

1784

2628

1785

2629

class MandosServer(IPv6_TCPServer):

1786

2630

"""Mandos server.

1787

2631

1788

2632

Attributes:

1789

2633

clients: set of Client objects

1790

2634

gnutls_priority GnuTLS priority string

1791

2635

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

1792

1793

Assumes a gobject.MainLoop event loop.

2636

2637

Assumes a GLib.MainLoop event loop.

1794

2638

"""

2639

1795

2640

def __init__(self, server_address, RequestHandlerClass,

1796

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

1797

gnutls_priority=None, use_dbus=True):

2641

interface=None,

2642

use_ipv6=True,

2643

clients=None,

2644

gnutls_priority=None,

2645

use_dbus=True,

2646

socketfd=None):

1798

2647

self.enabled = False

1799

2648

self.clients = clients

1800

2649

if self.clients is None:

1803

2652

self.gnutls_priority = gnutls_priority

1804

2653

IPv6_TCPServer.__init__(self, server_address,

1805

2654

RequestHandlerClass,

1806

interface = interface,

1807

use_ipv6 = use_ipv6)

2655

interface=interface,

2656

use_ipv6=use_ipv6,

2657

socketfd=socketfd)

2658

1808

2659

def server_activate(self):

1809

2660

if self.enabled:

1810

2661

return socketserver.TCPServer.server_activate(self)

1811

2662

1812

2663

def enable(self):

1813

2664

self.enabled = True

1814

2665

1815

2666

def add_pipe(self, parent_pipe, proc):

1816

2667

# Call "handle_ipc" for both data and EOF events

1817

gobject.io_add_watch(parent_pipe.fileno(),

1818

gobject.IO_IN | gobject.IO_HUP,

1819

functools.partial(self.handle_ipc,

1820

parent_pipe =

1821

parent_pipe,

1822

proc = proc))

1823

1824

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

1825

proc = None, client_object=None):

1826

condition_names = {

1827

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

1828

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

1829

# blocking).

1830

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

1831

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

1832

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

1833

# broken, usually for pipes and

1834

# sockets).

1835

}

1836

conditions_string = ' | '.join(name

1837

for cond, name in

1838

condition_names.iteritems()

1839

if cond & condition)

2668

GLib.io_add_watch(

2669

parent_pipe.fileno(),

2670

GLib.IO_IN | GLib.IO_HUP,

2671

functools.partial(self.handle_ipc,

2672

parent_pipe=parent_pipe,

2673

proc=proc))

2674

2675

def handle_ipc(self, source, condition,

2676

parent_pipe=None,

2677

proc=None,

2678

client_object=None):

1840

2679

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

1841

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

2680

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

1842

2681

# Wait for other process to exit

1843

2682

proc.join()

1844

2683

return False

1845

2684

1846

2685

# Read a request from the child

1847

2686

request = parent_pipe.recv()

1848

2687

command = request[0]

1849

2688

1850

2689

if command == 'init':

1851

fpr = request[1]

1852

address = request[2]

1853

1854

for c in self.clients.itervalues():

1855

if c.fingerprint == fpr:

2690

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

2691

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

2692

address = request[3]

2693

2694

for c in self.clients.values():

2695

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2696

continue

2697

if key_id and c.key_id == key_id:

2698

client = c

2699

break

2700

if fpr and c.fingerprint == fpr:

1856

2701

client = c

1857

2702

break

1858

2703

else:

1859

logger.info("Client not found for fingerprint: %s, ad"

1860

"dress: %s", fpr, address)

2704

logger.info("Client not found for key ID: %s, address"

2705

": %s", key_id or fpr, address)

1861

2706

if self.use_dbus:

1862

2707

# Emit D-Bus signal

1863

mandos_dbus_service.ClientNotFound(fpr,

2708

mandos_dbus_service.ClientNotFound(key_id or fpr,

1864

2709

address[0])

1865

2710

parent_pipe.send(False)

1866

2711

return False

1867

1868

gobject.io_add_watch(parent_pipe.fileno(),

1869

gobject.IO_IN | gobject.IO_HUP,

1870

functools.partial(self.handle_ipc,

1871

parent_pipe =

1872

parent_pipe,

1873

proc = proc,

1874

client_object =

1875

client))

2712

2713

GLib.io_add_watch(

2714

parent_pipe.fileno(),

2715

GLib.IO_IN | GLib.IO_HUP,

2716

functools.partial(self.handle_ipc,

2717

parent_pipe=parent_pipe,

2718

proc=proc,

2719

client_object=client))

1876

2720

parent_pipe.send(True)

1877

2721

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

1878

2722

# same fileno

1881

2725

funcname = request[1]

1882

2726

args = request[2]

1883

2727

kwargs = request[3]

1884

2728

1885

2729

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

1886

2730

funcname)(*args,

1887

**kwargs)))

1888

2731

**kwargs)))

2732

1889

2733

if command == 'getattr':

1890

2734

attrname = request[1]

1891

if callable(client_object.__getattribute__(attrname)):

1892

parent_pipe.send(('function',))

2735

if isinstance(client_object.__getattribute__(attrname),

2736

collections.Callable):

2737

parent_pipe.send(('function', ))

1893

2738

else:

1894

parent_pipe.send(('data', client_object

1895

.__getattribute__(attrname)))

1896

2739

parent_pipe.send((

2740

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

2741

1897

2742

if command == 'setattr':

1898

2743

attrname = request[1]

1899

2744

value = request[2]

1900

2745

setattr(client_object, attrname, value)

1901

2746

1902

2747

return True

1903

2748

1904

2749

2750

def rfc3339_duration_to_delta(duration):

2751

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

2752

2753

>>> rfc3339_duration_to_delta("P7D")

2754

datetime.timedelta(7)

2755

>>> rfc3339_duration_to_delta("PT60S")

2756

datetime.timedelta(0, 60)

2757

>>> rfc3339_duration_to_delta("PT60M")

2758

datetime.timedelta(0, 3600)

2759

>>> rfc3339_duration_to_delta("PT24H")

2760

datetime.timedelta(1)

2761

>>> rfc3339_duration_to_delta("P1W")

2762

datetime.timedelta(7)

2763

>>> rfc3339_duration_to_delta("PT5M30S")

2764

datetime.timedelta(0, 330)

2765

>>> rfc3339_duration_to_delta("P1DT3M20S")

2766

datetime.timedelta(1, 200)

2767

"""

2768

2769

# Parsing an RFC 3339 duration with regular expressions is not

2770

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

2771

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

2772

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

2773

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

2774

# avoid excessive use of external libraries.

2775

2776

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

2777

Token = collections.namedtuple("Token", (

2778

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

2779

# a "group" containing digits

2780

"value", # datetime.timedelta or None

2781

"followers")) # Tokens valid after this token

2782

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

2783

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

2784

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

2785

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

2786

datetime.timedelta(seconds=1),

2787

frozenset((token_end, )))

2788

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

2789

datetime.timedelta(minutes=1),

2790

frozenset((token_second, token_end)))

2791

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

2792

datetime.timedelta(hours=1),

2793

frozenset((token_minute, token_end)))

2794

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

2795

None,

2796

frozenset((token_hour, token_minute,

2797

token_second)))

2798

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

2799

datetime.timedelta(days=1),

2800

frozenset((token_time, token_end)))

2801

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

2802

datetime.timedelta(weeks=4),

2803

frozenset((token_day, token_end)))

2804

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

2805

datetime.timedelta(weeks=52),

2806

frozenset((token_month, token_end)))

2807

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

2808

datetime.timedelta(weeks=1),

2809

frozenset((token_end, )))

2810

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

2811

frozenset((token_year, token_month,

2812

token_day, token_time,

2813

token_week)))

2814

# Define starting values:

2815

# Value so far

2816

value = datetime.timedelta()

2817

found_token = None

2818

# Following valid tokens

2819

followers = frozenset((token_duration, ))

2820

# String left to parse

2821

s = duration

2822

# Loop until end token is found

2823

while found_token is not token_end:

2824

# Search for any currently valid tokens

2825

for token in followers:

2826

match = token.regexp.match(s)

2827

if match is not None:

2828

# Token found

2829

if token.value is not None:

2830

# Value found, parse digits

2831

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

2832

# Add to value so far

2833

value += factor * token.value

2834

# Strip token from string

2835

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

2836

# Go to found token

2837

found_token = token

2838

# Set valid next tokens

2839

followers = found_token.followers

2840

break

2841

else:

2842

# No currently valid tokens were found

2843

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

2844

.format(duration))

2845

# End token found

2846

return value

2847

2848

1905

2849

def string_to_delta(interval):

1906

2850

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

1907

2851

1908

2852

>>> string_to_delta('7d')

1909

2853

datetime.timedelta(7)

1910

2854

>>> string_to_delta('60s')

1918

2862

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

1919

2863

datetime.timedelta(0, 330)

1920

2864

"""

2865

2866

try:

2867

return rfc3339_duration_to_delta(interval)

2868

except ValueError:

2869

pass

2870

1921

2871

timevalue = datetime.timedelta(0)

1922

2872

for s in interval.split():

1923

2873

try:

1924

suffix = unicode(s[-1])

2874

suffix = s[-1]

1925

2875

value = int(s[:-1])

1926

2876

if suffix == "d":

1927

2877

delta = datetime.timedelta(value)

1934

2884

elif suffix == "w":

1935

2885

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

1936

2886

else:

1937

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

1938

except (ValueError, IndexError) as e:

2887

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

2888

except IndexError as e:

1939

2889

raise ValueError(*(e.args))

1940

2890

timevalue += delta

1941

2891

return timevalue

1942

2892

1943

2893

1944

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

2894

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

1945

2895

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

1946

2896

1947

2897

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

1948

2898

if os.fork():

1949

2899

sys.exit()

1954

2904

sys.exit()

1955

2905

if not noclose:

1956

2906

# Close all standard open file descriptors

1957

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

2907

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

1958

2908

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

1959

2909

raise OSError(errno.ENODEV,

1960

"%s not a character device"

1961

% os.path.devnull)

2910

"{} not a character device"

2911

.format(os.devnull))

1962

2912

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

1963

2913

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

1964

2914

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

1967

2917

1968

2918

1969

2919

def main():

1970

2920

1971

2921

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

1972

2922

# Parsing of options, both command line and config file

1973

2923

1974

2924

parser = argparse.ArgumentParser()

1975

2925

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

1976

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

2926

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

1977

2927

help="show version number and exit")

1978

2928

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

1979

2929

help="Bind to interface IF")

1985

2935

help="Run self-test")

1986

2936

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

1987

2937

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

1988

" to terminal")

2938

" to terminal", default=None)

1989

2939

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

1990

2940

help="Debug level for stdout output")

1991

2941

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

1998

2948

" files")

1999

2949

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

2000

2950

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

2001

" system bus interface")

2951

" system bus interface", default=None)

2002

2952

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

2003

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

2953

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

2954

default=None)

2004

2955

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

2005

2956

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

2006

" state")

2957

" state", default=None)

2958

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

2959

help="Specify a file descriptor to a network"

2960

" socket to use instead of creating one")

2007

2961

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

2008

2962

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

2009

2963

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

2964

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

2965

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

2966

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

2967

default=None)

2968

2010

2969

options = parser.parse_args()

2011

2970

2012

2971

if options.check:

2013

2972

import doctest

2014

doctest.testmod()

2015

sys.exit()

2016

2973

fail_count, test_count = doctest.testmod()

2974

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

2975

2017

2976

# Default values for config file for server-global settings

2018

server_defaults = { "interface": "",

2019

"address": "",

2020

"port": "",

2021

"debug": "False",

2022

"priority":

2023

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

2024

"servicename": "Mandos",

2025

"use_dbus": "True",

2026

"use_ipv6": "True",

2027

"debuglevel": "",

2028

"restore": "True",

2029

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

2030

}

2031

2977

if gnutls.has_rawpk:

2978

priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"

2979

":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")

2980

else:

2981

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

2982

":+SIGN-DSA-SHA256")

2983

server_defaults = {"interface": "",

2984

"address": "",

2985

"port": "",

2986

"debug": "False",

2987

"priority": priority,

2988

"servicename": "Mandos",

2989

"use_dbus": "True",

2990

"use_ipv6": "True",

2991

"debuglevel": "",

2992

"restore": "True",

2993

"socket": "",

2994

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

2995

"foreground": "False",

2996

"zeroconf": "True",

2997

}

2998

del priority

2999

2032

3000

# Parse config file for server-global settings

2033

3001

server_config = configparser.SafeConfigParser(server_defaults)

2034

3002

del server_defaults

2035

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

2036

"mandos.conf"))

3003

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

2037

3004

# Convert the SafeConfigParser object to a dict

2038

3005

server_settings = server_config.defaults()

2039

3006

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

2040

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

3007

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

3008

"foreground", "zeroconf"):

2041

3009

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

2042

3010

option)

2043

3011

if server_settings["port"]:

2044

3012

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

2045

3013

"port")

3014

if server_settings["socket"]:

3015

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

3016

"socket")

3017

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

3018

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

3019

# happen with a supplied network socket.

3020

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

3021

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

3022

["socket"])

2046

3023

del server_config

2047

3024

2048

3025

# Override the settings from the config file with command line

2049

3026

# options, if set.

2050

3027

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

2051

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

2052

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

2053

"statedir"):

3028

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

3029

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

3030

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

2054

3031

value = getattr(options, option)

2055

3032

if value is not None:

2056

3033

server_settings[option] = value

2057

3034

del options

2058

3035

# Force all strings to be unicode

2059

3036

for option in server_settings.keys():

2060

if type(server_settings[option]) is str:

2061

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

3037

if isinstance(server_settings[option], bytes):

3038

server_settings[option] = (server_settings[option]

3039

.decode("utf-8"))

3040

# Force all boolean options to be boolean

3041

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

3042

"foreground", "zeroconf"):

3043

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

3044

# Debug implies foreground

3045

if server_settings["debug"]:

3046

server_settings["foreground"] = True

2062

3047

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

2063

3048

2064

3049

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

2065

3050

3051

if (not server_settings["zeroconf"]

3052

and not (server_settings["port"]

3053

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

3054

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

3055

2066

3056

# For convenience

2067

3057

debug = server_settings["debug"]

2068

3058

debuglevel = server_settings["debuglevel"]

2070

3060

use_ipv6 = server_settings["use_ipv6"]

2071

3061

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

2072

3062

stored_state_file)

2073

3063

foreground = server_settings["foreground"]

3064

zeroconf = server_settings["zeroconf"]

3065

2074

3066

if debug:

2075

3067

initlogger(debug, logging.DEBUG)

2076

3068

else:

2079

3071

else:

2080

3072

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

2081

3073

initlogger(debug, level)

2082

3074

2083

3075

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

2084

syslogger.setFormatter(logging.Formatter

2085

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

2086

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

2087

% server_settings["servicename"]))

2088

3076

syslogger.setFormatter(

3077

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

3078

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

3079

server_settings["servicename"])))

3080

2089

3081

# Parse config file with clients

2090

3082

client_config = configparser.SafeConfigParser(Client

2091

3083

.client_defaults)

2092

3084

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

2093

3085

"clients.conf"))

2094

3086

2095

3087

global mandos_dbus_service

2096

3088

mandos_dbus_service = None

2097

2098

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

2099

server_settings["port"]),

2100

ClientHandler,

2101

interface=(server_settings["interface"]

2102

or None),

2103

use_ipv6=use_ipv6,

2104

gnutls_priority=

2105

server_settings["priority"],

2106

use_dbus=use_dbus)

2107

if not debug:

2108

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

2109

try:

2110

pidfile = open(pidfilename, "w")

2111

except IOError:

2112

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

2113

2114

try:

2115

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

2116

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

2117

except KeyError:

2118

try:

2119

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

2120

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

3089

3090

socketfd = None

3091

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

3092

socketfd = server_settings["socket"]

3093

tcp_server = MandosServer(

3094

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

3095

ClientHandler,

3096

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

3097

use_ipv6=use_ipv6,

3098

gnutls_priority=server_settings["priority"],

3099

use_dbus=use_dbus,

3100

socketfd=socketfd)

3101

if not foreground:

3102

pidfilename = "/run/mandos.pid"

3103

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

3104

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

3105

pidfile = None

3106

try:

3107

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

3108

except IOError as e:

3109

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

3110

exc_info=e)

3111

3112

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

3113

("mandos", "mandos"),

3114

("nobody", "nogroup")):

3115

try:

3116

uid = pwd.getpwnam(name).pw_uid

3117

gid = pwd.getpwnam(group).pw_gid

3118

break

2121

3119

except KeyError:

2122

try:

2123

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

2124

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

2125

except KeyError:

2126

uid = 65534

2127

gid = 65534

3120

continue

3121

else:

3122

uid = 65534

3123

gid = 65534

2128

3124

try:

2129

3125

os.setgid(gid)

2130

3126

os.setuid(uid)

3127

if debug:

3128

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

3129

gid))

2131

3130

except OSError as error:

2132

if error[0] != errno.EPERM:

2133

raise error

2134

3131

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

3132

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

3133

if error.errno != errno.EPERM:

3134

raise

3135

2135

3136

if debug:

2136

3137

# Enable all possible GnuTLS debugging

2137

3138

2138

3139

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

2139

3140

# - GnuTLS manual

2140

gnutls.library.functions.gnutls_global_set_log_level(11)

2141

2142

@gnutls.library.types.gnutls_log_func

3141

gnutls.global_set_log_level(11)

3142

3143

@gnutls.log_func

2143

3144

def debug_gnutls(level, string):

2144

3145

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

2145

2146

(gnutls.library.functions

2147

.gnutls_global_set_log_function(debug_gnutls))

2148

3146

3147

gnutls.global_set_log_function(debug_gnutls)

3148

2149

3149

# Redirect stdin so all checkers get /dev/null

2150

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

3150

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

2151

3151

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

2152

3152

if null > 2:

2153

3153

os.close(null)

2154

3154

2155

3155

# Need to fork before connecting to D-Bus

2156

if not debug:

3156

if not foreground:

2157

3157

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

2158

3158

daemon()

2159

2160

gobject.threads_init()

2161

3159

3160

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

3161

# to inform GLib that threads will be used.

3162

GLib.threads_init()

3163

2162

3164

global main_loop

2163

3165

# From the Avahi example code

2164

DBusGMainLoop(set_as_default=True )

2165

main_loop = gobject.MainLoop()

3166

DBusGMainLoop(set_as_default=True)

3167

main_loop = GLib.MainLoop()

2166

3168

bus = dbus.SystemBus()

2167

3169

# End of Avahi example code

2168

3170

if use_dbus:

2169

3171

try:

2170

3172

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

2171

bus, do_not_queue=True)

2172

old_bus_name = (dbus.service.BusName

2173

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

2174

do_not_queue=True))

2175

except dbus.exceptions.NameExistsException as e:

2176

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

3173

bus,

3174

do_not_queue=True)

3175

old_bus_name = dbus.service.BusName(

3176

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

3177

do_not_queue=True)

3178

except dbus.exceptions.DBusException as e:

3179

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

2177

3180

use_dbus = False

2178

3181

server_settings["use_dbus"] = False

2179

3182

tcp_server.use_dbus = False

2180

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2181

service = AvahiServiceToSyslog(name =

2182

server_settings["servicename"],

2183

servicetype = "_mandos._tcp",

2184

protocol = protocol, bus = bus)

2185

if server_settings["interface"]:

2186

service.interface = (if_nametoindex

2187

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

2188

3183

if zeroconf:

3184

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3185

service = AvahiServiceToSyslog(

3186

name=server_settings["servicename"],

3187

servicetype="_mandos._tcp",

3188

protocol=protocol,

3189

bus=bus)

3190

if server_settings["interface"]:

3191

service.interface = if_nametoindex(

3192

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

3193

2189

3194

global multiprocessing_manager

2190

3195

multiprocessing_manager = multiprocessing.Manager()

2191

3196

2192

3197

client_class = Client

2193

3198

if use_dbus:

2194

client_class = functools.partial(ClientDBusTransitional,

2195

bus = bus)

2196

3199

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

3200

2197

3201

client_settings = Client.config_parser(client_config)

2198

3202

old_client_settings = {}

2199

3203

clients_data = {}

2200

3204

3205

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

3206

global wnull

3207

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

3208

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

3209

# mode

3210

if debug or not foreground:

3211

wnull.close()

3212

2201

3213

# Get client data and settings from last running state.

2202

3214

if server_settings["restore"]:

2203

3215

try:

2204

3216

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

2205

clients_data, old_client_settings = (pickle.load

2206

(stored_state))

3217

if sys.version_info.major == 2:

3218

clients_data, old_client_settings = pickle.load(

3219

stored_state)

3220

else:

3221

bytes_clients_data, bytes_old_client_settings = (

3222

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

3223

# Fix bytes to strings

3224

# clients_data

3225

# .keys()

3226

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

3227

if isinstance(key, bytes)

3228

else key): value

3229

for key, value in

3230

bytes_clients_data.items()}

3231

del bytes_clients_data

3232

for key in clients_data:

3233

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

3234

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

3235

for k, v in

3236

clients_data[key].items()}

3237

clients_data[key] = value

3238

# .client_structure

3239

value["client_structure"] = [

3240

(s.decode("utf-8")

3241

if isinstance(s, bytes)

3242

else s) for s in

3243

value["client_structure"]]

3244

# .name & .host

3245

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

3246

if isinstance(value[k], bytes):

3247

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

3248

if "key_id" not in value:

3249

value["key_id"] = ""

3250

elif "fingerprint" not in value:

3251

value["fingerprint"] = ""

3252

# old_client_settings

3253

# .keys()

3254

old_client_settings = {

3255

(key.decode("utf-8")

3256

if isinstance(key, bytes)

3257

else key): value

3258

for key, value in

3259

bytes_old_client_settings.items()}

3260

del bytes_old_client_settings

3261

# .host

3262

for value in old_client_settings.values():

3263

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

3264

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

3265

.decode("utf-8"))

2207

3266

os.remove(stored_state_path)

2208

3267

except IOError as e:

2209

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

2210

.format(e))

2211

if e.errno != errno.ENOENT:

3268

if e.errno == errno.ENOENT:

3269

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

3270

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

3271

else:

3272

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

3273

exc_info=e)

2212

3274

raise

2213

3275

except EOFError as e:

2214

3276

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

2215

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

2216

3277

"EOFError:",

3278

exc_info=e)

3279

2217

3280

with PGPEngine() as pgp:

2218

for client_name, client in clients_data.iteritems():

3281

for client_name, client in clients_data.items():

3282

# Skip removed clients

3283

if client_name not in client_settings:

3284

continue

3285

2219

3286

# Decide which value to use after restoring saved state.

2220

3287

# We have three different values: Old config file,

2221

3288

# new config file, and saved state.

2226

3293

# For each value in new config, check if it

2227

3294

# differs from the old config value (Except for

2228

3295

# the "secret" attribute)

2229

if (name != "secret" and

2230

value != old_client_settings[client_name]

2231

[name]):

3296

if (name != "secret"

3297

and (value !=

3298

old_client_settings[client_name][name])):

2232

3299

client[name] = value

2233

3300

except KeyError:

2234

3301

pass

2235

3302

2236

3303

# Clients who has passed its expire date can still be

2237

# enabled if its last checker was successful. Clients

3304

# enabled if its last checker was successful. A Client

2238

3305

# whose checker succeeded before we stored its state is

2239

3306

# assumed to have successfully run all checkers during

2240

3307

# downtime.

2242

3309

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

2243

3310

if not client["last_checked_ok"]:

2244

3311

logger.warning(

2245

"disabling client {0} - Client never "

2246

"performed a successful checker"

2247

.format(client_name))

3312

"disabling client {} - Client never "

3313

"performed a successful checker".format(

3314

client_name))

2248

3315

client["enabled"] = False

2249

3316

elif client["last_checker_status"] != 0:

2250

3317

logger.warning(

2251

"disabling client {0} - Client "

2252

"last checker failed with error code {1}"

2253

.format(client_name,

2254

client["last_checker_status"]))

3318

"disabling client {} - Client last"

3319

" checker failed with error code"

3320

" {}".format(

3321

client_name,

3322

client["last_checker_status"]))

2255

3323

client["enabled"] = False

2256

3324

else:

2257

client["expires"] = (datetime.datetime

2258

.utcnow()

2259

+ client["timeout"])

3325

client["expires"] = (

3326

datetime.datetime.utcnow()

3327

+ client["timeout"])

2260

3328

logger.debug("Last checker succeeded,"

2261

" keeping {0} enabled"

2262

.format(client_name))

3329

" keeping {} enabled".format(

3330

client_name))

2263

3331

try:

2264

client["secret"] = (

2265

pgp.decrypt(client["encrypted_secret"],

2266

client_settings[client_name]

2267

["secret"]))

3332

client["secret"] = pgp.decrypt(

3333

client["encrypted_secret"],

3334

client_settings[client_name]["secret"])

2268

3335

except PGPError:

2269

3336

# If decryption fails, we use secret from new settings

2270

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

2271

.format(client_name))

2272

client["secret"] = (

2273

client_settings[client_name]["secret"])

3337

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

3338

client_name))

3339

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

3340

["secret"])

2274

3341

2275

2276

3342

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

2277

3343

for client_name in (set(old_client_settings)

2278

3344

- set(client_settings)):

2282

3348

clients_data[client_name] = client_settings[client_name]

2283

3349

2284

3350

# Create all client objects

2285

for client_name, client in clients_data.iteritems():

3351

for client_name, client in clients_data.items():

2286

3352

tcp_server.clients[client_name] = client_class(

2287

name = client_name, settings = client)

2288

3353

name=client_name,

3354

settings=client,

3355

server_settings=server_settings)

3356

2289

3357

if not tcp_server.clients:

2290

3358

logger.warning("No clients defined")

2291

2292

if not debug:

2293

try:

2294

with pidfile:

2295

pid = os.getpid()

2296

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

2297

del pidfile

2298

except IOError:

2299

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

2300

pidfilename, pid)

2301

except NameError:

2302

# "pidfile" was never created

2303

pass

3359

3360

if not foreground:

3361

if pidfile is not None:

3362

pid = os.getpid()

3363

try:

3364

with pidfile:

3365

print(pid, file=pidfile)

3366

except IOError:

3367

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

3368

pidfilename, pid)

3369

del pidfile

2304

3370

del pidfilename

2305

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

2306

2307

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

2308

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

2309

3371

3372

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

3373

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3374

lambda: main_loop.quit() and False)

3375

2310

3376

if use_dbus:

2311

class MandosDBusService(dbus.service.Object):

3377

3378

@alternate_dbus_interfaces(

3379

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

3380

class MandosDBusService(DBusObjectWithObjectManager):

2312

3381

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

3382

2313

3383

def __init__(self):

2314

3384

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

3385

2315

3386

_interface = "se.recompile.Mandos"

2316

3387

2317

3388

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

2318

3389

def ClientAdded(self, objpath):

2319

3390

"D-Bus signal"

2320

3391

pass

2321

3392

2322

3393

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

2323

def ClientNotFound(self, fingerprint, address):

3394

def ClientNotFound(self, key_id, address):

2324

3395

"D-Bus signal"

2325

3396

pass

2326

3397

3398

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

3399

"true"})

2327

3400

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

2328

3401

def ClientRemoved(self, objpath, name):

2329

3402

"D-Bus signal"

2330

3403

pass

2331

3404

3405

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

3406

"true"})

2332

3407

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

2333

3408

def GetAllClients(self):

2334

3409

"D-Bus method"

2335

return dbus.Array(c.dbus_object_path

2336

for c in

2337

tcp_server.clients.itervalues())

2338

3410

return dbus.Array(c.dbus_object_path for c in

3411

tcp_server.clients.values())

3412

3413

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

3414

"true"})

2339

3415

@dbus.service.method(_interface,

2340

3416

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

2341

3417

def GetAllClientsWithProperties(self):

2342

3418

"D-Bus method"

2343

3419

return dbus.Dictionary(

2344

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

2345

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

3420

{c.dbus_object_path: c.GetAll(

3421

"se.recompile.Mandos.Client")

3422

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

2346

3423

signature="oa{sv}")

2347

3424

2348

3425

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

2349

3426

def RemoveClient(self, object_path):

2350

3427

"D-Bus method"

2351

for c in tcp_server.clients.itervalues():

3428

for c in tcp_server.clients.values():

2352

3429

if c.dbus_object_path == object_path:

2353

3430

del tcp_server.clients[c.name]

2354

3431

c.remove_from_connection()

2355

# Don't signal anything except ClientRemoved

3432

# Don't signal the disabling

2356

3433

c.disable(quiet=True)

2357

# Emit D-Bus signal

2358

self.ClientRemoved(object_path, c.name)

3434

# Emit D-Bus signal for removal

3435

self.client_removed_signal(c)

2359

3436

return

2360

3437

raise KeyError(object_path)

2361

3438

2362

3439

del _interface

2363

2364

class MandosDBusServiceTransitional(MandosDBusService):

2365

__metaclass__ = AlternateDBusNamesMetaclass

2366

mandos_dbus_service = MandosDBusServiceTransitional()

2367

3440

3441

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3442

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

3443

def GetManagedObjects(self):

3444

"""D-Bus method"""

3445

return dbus.Dictionary(

3446

{client.dbus_object_path:

3447

dbus.Dictionary(

3448

{interface: client.GetAll(interface)

3449

for interface in

3450

client._get_all_interface_names()})

3451

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

3452

3453

def client_added_signal(self, client):

3454

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

3455

if use_dbus:

3456

# New standard signal

3457

self.InterfacesAdded(

3458

client.dbus_object_path,

3459

dbus.Dictionary(

3460

{interface: client.GetAll(interface)

3461

for interface in

3462

client._get_all_interface_names()}))

3463

# Old signal

3464

self.ClientAdded(client.dbus_object_path)

3465

3466

def client_removed_signal(self, client):

3467

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

3468

if use_dbus:

3469

# New standard signal

3470

self.InterfacesRemoved(

3471

client.dbus_object_path,

3472

client._get_all_interface_names())

3473

# Old signal

3474

self.ClientRemoved(client.dbus_object_path,

3475

client.name)

3476

3477

mandos_dbus_service = MandosDBusService()

3478

3479

# Save modules to variables to exempt the modules from being

3480

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

3481

mp = multiprocessing

3482

wn = wnull

3483

2368

3484

def cleanup():

2369

3485

"Cleanup function; run on exit"

2370

service.cleanup()

2371

2372

multiprocessing.active_children()

3486

if zeroconf:

3487

service.cleanup()

3488

3489

mp.active_children()

3490

wn.close()

2373

3491

if not (tcp_server.clients or client_settings):

2374

3492

return

2375

3493

2376

3494

# Store client before exiting. Secrets are encrypted with key

2377

3495

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

2378

3496

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

2379

3497

clients = {}

2380

3498

with PGPEngine() as pgp:

2381

for client in tcp_server.clients.itervalues():

3499

for client in tcp_server.clients.values():

2382

3500

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

2383

3501

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

2384

3502

key)

2385

3503

client_dict = {}

2386

3504

2387

3505

# A list of attributes that can not be pickled

2388

3506

# + secret.

2389

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

2390

"checker"))

2391

for name, typ in (inspect.getmembers

2392

(dbus.service.Object)):

3507

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

3508

"checker", "server_settings"}

3509

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

3510

.Object):

2393

3511

exclude.add(name)

2394

3512

2395

3513

client_dict["encrypted_secret"] = (client

2396

3514

.encrypted_secret)

2397

3515

for attr in client.client_structure:

2398

3516

if attr not in exclude:

2399

3517

client_dict[attr] = getattr(client, attr)

2400

3518

2401

3519

clients[client.name] = client_dict

2402

3520

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

2403

3521

2404

3522

try:

2405

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

2406

prefix="clients-",

2407

dir=os.path.dirname

2408

(stored_state_path))

2409

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

2410

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

3523

with tempfile.NamedTemporaryFile(

3524

mode='wb',

3525

suffix=".pickle",

3526

prefix='clients-',

3527

dir=os.path.dirname(stored_state_path),

3528

delete=False) as stored_state:

3529

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

3530

protocol=2)

3531

tempname = stored_state.name

2411

3532

os.rename(tempname, stored_state_path)

2412

3533

except (IOError, OSError) as e:

2413

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

2414

.format(e))

2415

3534

if not debug:

2416

3535

try:

2417

3536

os.remove(tempname)

2418

3537

except NameError:

2419

3538

pass

2420

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

2421

errno.EEXIST)):

2422

raise e

2423

3539

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

3540

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

3541

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

3542

else:

3543

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

3544

exc_info=e)

3545

raise

3546

2424

3547

# Delete all clients, and settings from config

2425

3548

while tcp_server.clients:

2426

3549

name, client = tcp_server.clients.popitem()

2427

3550

if use_dbus:

2428

3551

client.remove_from_connection()

2429

# Don't signal anything except ClientRemoved

3552

# Don't signal the disabling

2430

3553

client.disable(quiet=True)

3554

# Emit D-Bus signal for removal

2431

3555

if use_dbus:

2432

# Emit D-Bus signal

2433

mandos_dbus_service.ClientRemoved(client

2434

.dbus_object_path,

2435

client.name)

3556

mandos_dbus_service.client_removed_signal(client)

2436

3557

client_settings.clear()

2437

3558

2438

3559

atexit.register(cleanup)

2439

2440

for client in tcp_server.clients.itervalues():

3560

3561

for client in tcp_server.clients.values():

2441

3562

if use_dbus:

2442

# Emit D-Bus signal

2443

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3563

# Emit D-Bus signal for adding

3564

mandos_dbus_service.client_added_signal(client)

2444

3565

# Need to initiate checking of clients

2445

3566

if client.enabled:

2446

3567

client.init_checker()

2447

3568

2448

3569

tcp_server.enable()

2449

3570

tcp_server.server_activate()

2450

3571

2451

3572

# Find out what port we got

2452

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

3573

if zeroconf:

3574

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

2453

3575

if use_ipv6:

2454

3576

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

2455

" flowinfo %d, scope_id %d"

2456

% tcp_server.socket.getsockname())

3577

" flowinfo %d, scope_id %d",

3578

*tcp_server.socket.getsockname())

2457

3579

else: # IPv4

2458

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

2459

% tcp_server.socket.getsockname())

2460

2461

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

2462

3580

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

3581

*tcp_server.socket.getsockname())

3582

3583

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

3584

2463

3585

try:

2464

# From the Avahi example code

2465

try:

2466

service.activate()

2467

except dbus.exceptions.DBusException as error:

2468

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

2469

cleanup()

2470

sys.exit(1)

2471

# End of Avahi example code

2472

2473

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

2474

lambda *args, **kwargs:

2475

(tcp_server.handle_request

2476

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

2477

3586

if zeroconf:

3587

# From the Avahi example code

3588

try:

3589

service.activate()

3590

except dbus.exceptions.DBusException as error:

3591

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

3592

cleanup()

3593

sys.exit(1)

3594

# End of Avahi example code

3595

3596

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

3597

lambda *args, **kwargs:

3598

(tcp_server.handle_request

3599

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

3600

2478

3601

logger.debug("Starting main loop")

2479

3602

main_loop.run()

2480

3603

except AvahiError as error:

2481

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

3604

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

2482

3605

cleanup()

2483

3606

sys.exit(1)

2484

3607

except KeyboardInterrupt:

2489

3612

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

2490

3613

cleanup()

2491

3614

3615

2492

3616

if __name__ == '__main__':

2493

3617

main()