/mandos/trunk : revision 975

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

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

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

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, 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

avahi = Avahi()

302

211

303

212

304

class AvahiError(Exception):

213

305

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

214

306

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

307

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

308

**kwargs)

309

218

310

219

311

class AvahiServiceError(AvahiError):

220

312

pass

221

313

314

222

315

class AvahiGroupError(AvahiError):

223

316

pass

224

317

225

318

226

319

class AvahiService(object):

227

320

"""An Avahi (Zeroconf) service.

228

321

229

322

Attributes:

230

323

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

231

324

Used to optionally bind to the specified interface.

232

325

name: string; Example: 'Mandos'

233

326

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

234

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

327

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

235

328

port: integer; what port to announce

236

329

TXT: list of strings; TXT record for the service

237

330

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

243

336

server: D-Bus Server

244

337

bus: dbus.SystemBus()

245

338

"""

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

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

250

351

self.interface = interface

251

352

self.name = name

252

353

self.type = servicetype

261

362

self.server = None

262

363

self.bus = bus

263

364

self.entry_group_state_changed_match = None

264

def rename(self):

365

366

def rename(self, remove=True):

265

367

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

266

368

if self.rename_count >= self.max_renames:

267

369

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

268

370

" after %i retries, exiting.",

269

371

self.rename_count)

270

372

raise AvahiServiceError("Too many renames")

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

273

376

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

274

377

self.name)

275

self.remove()

378

if remove:

379

self.remove()

276

380

try:

277

381

self.add()

278

382

except dbus.exceptions.DBusException as error:

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

283

392

def remove(self):

284

393

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

285

394

if self.entry_group_state_changed_match is not None:

287

396

self.entry_group_state_changed_match = None

288

397

if self.group is not None:

289

398

self.group.Reset()

399

290

400

def add(self):

291

401

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

292

402

self.remove()

309

419

dbus.UInt16(self.port),

310

420

avahi.string_array_to_txt_array(self.TXT))

311

421

self.group.Commit()

422

312

423

def entry_group_state_changed(self, state, error):

313

424

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

314

425

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

315

426

316

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

317

428

logger.debug("Zeroconf service established.")

318

429

elif state == avahi.ENTRY_GROUP_COLLISION:

320

431

self.rename()

321

432

elif state == avahi.ENTRY_GROUP_FAILURE:

322

433

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

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

434

str(error))

435

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

436

326

437

def cleanup(self):

327

438

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

328

439

if self.group is not None:

333

444

pass

334

445

self.group = None

335

446

self.remove()

447

336

448

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

337

449

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

338

450

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

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

346

457

if state in bad_states:

347

458

if bad_states[state] is not None:

348

459

if error is None:

351

462

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

352

463

self.cleanup()

353

464

elif state == avahi.SERVER_RUNNING:

354

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

355

477

else:

356

478

if error is None:

357

479

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

358

480

else:

359

481

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

482

360

483

def activate(self):

361

484

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

362

485

if self.server is None:

366

489

follow_name_owner_changes=True),

367

490

avahi.DBUS_INTERFACE_SERVER)

368

491

self.server.connect_to_signal("StateChanged",

369

self.server_state_changed)

492

self.server_state_changed)

370

493

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

371

494

495

372

496

class AvahiServiceToSyslog(AvahiService):

373

def rename(self):

497

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

374

498

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

499

ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

380

503

return ret

381

504

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

505

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

_tls_rawpk_version = b"3.6.6"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CRT_RAWPK = 3

535

CLIENT = 2

536

SHUT_RDWR = 0

537

CRD_CERTIFICATE = 1

538

E_NO_CERTIFICATE_FOUND = -49

539

X509_FMT_DER = 0

540

NO_TICKETS = 1<<10

541

ENABLE_RAWPK = 1<<18

542

CTYPE_PEERS = 3

543

KEYID_USE_SHA256 = 1 # gnutls/x509.h

544

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

545

546

# Types

547

class session_int(ctypes.Structure):

548

_fields_ = []

549

session_t = ctypes.POINTER(session_int)

550

551

class certificate_credentials_st(ctypes.Structure):

552

_fields_ = []

553

certificate_credentials_t = ctypes.POINTER(

554

certificate_credentials_st)

555

certificate_type_t = ctypes.c_int

556

557

class datum_t(ctypes.Structure):

558

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

559

('size', ctypes.c_uint)]

560

561

class openpgp_crt_int(ctypes.Structure):

562

_fields_ = []

563

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

564

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

565

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

566

credentials_type_t = ctypes.c_int

567

transport_ptr_t = ctypes.c_void_p

568

close_request_t = ctypes.c_int

569

570

# Exceptions

571

class Error(Exception):

572

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

573

# exception might be raised from within GnuTLS.__init__,

574

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

575

# global variable has happened.

576

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

577

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

578

# code is passed, convert it to a string with

579

# gnutls.strerror()

580

self.code = code

581

if message is None and code is not None:

582

message = GnuTLS.strerror(code)

583

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

584

message, *args)

585

586

class CertificateSecurityError(Error):

587

pass

588

589

# Classes

590

class Credentials(object):

591

def __init__(self):

592

self._c_object = gnutls.certificate_credentials_t()

593

gnutls.certificate_allocate_credentials(

594

ctypes.byref(self._c_object))

595

self.type = gnutls.CRD_CERTIFICATE

596

597

def __del__(self):

598

gnutls.certificate_free_credentials(self._c_object)

599

600

class ClientSession(object):

601

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

602

self._c_object = gnutls.session_t()

603

gnutls_flags = gnutls.CLIENT

604

if gnutls.check_version("3.5.6"):

605

gnutls_flags |= gnutls.NO_TICKETS

606

if gnutls.has_rawpk:

607

gnutls_flags |= gnutls.ENABLE_RAWPK

608

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

609

del gnutls_flags

610

gnutls.set_default_priority(self._c_object)

611

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

612

gnutls.handshake_set_private_extensions(self._c_object,

613

True)

614

self.socket = socket

615

if credentials is None:

616

credentials = gnutls.Credentials()

617

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

618

ctypes.cast(credentials._c_object,

619

ctypes.c_void_p))

620

self.credentials = credentials

621

622

def __del__(self):

623

gnutls.deinit(self._c_object)

624

625

def handshake(self):

626

return gnutls.handshake(self._c_object)

627

628

def send(self, data):

629

data = bytes(data)

630

data_len = len(data)

631

while data_len > 0:

632

data_len -= gnutls.record_send(self._c_object,

633

data[-data_len:],

634

data_len)

635

636

def bye(self):

637

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

638

639

# Error handling functions

640

def _error_code(result):

641

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

642

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

643

if result >= 0:

644

return result

645

if result == gnutls.E_NO_CERTIFICATE_FOUND:

646

raise gnutls.CertificateSecurityError(code=result)

647

raise gnutls.Error(code=result)

648

649

def _retry_on_error(result, func, arguments):

650

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

651

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

652

while result < 0:

653

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

654

return _error_code(result)

655

result = func(*arguments)

656

return result

657

658

# Unless otherwise indicated, the function declarations below are

659

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

660

661

# Functions

662

priority_set_direct = _library.gnutls_priority_set_direct

663

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

664

ctypes.POINTER(ctypes.c_char_p)]

665

priority_set_direct.restype = _error_code

666

667

init = _library.gnutls_init

668

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

669

init.restype = _error_code

670

671

set_default_priority = _library.gnutls_set_default_priority

672

set_default_priority.argtypes = [session_t]

673

set_default_priority.restype = _error_code

674

675

record_send = _library.gnutls_record_send

676

record_send.argtypes = [session_t, ctypes.c_void_p,

677

ctypes.c_size_t]

678

record_send.restype = ctypes.c_ssize_t

679

record_send.errcheck = _retry_on_error

680

681

certificate_allocate_credentials = (

682

_library.gnutls_certificate_allocate_credentials)

683

certificate_allocate_credentials.argtypes = [

684

ctypes.POINTER(certificate_credentials_t)]

685

certificate_allocate_credentials.restype = _error_code

686

687

certificate_free_credentials = (

688

_library.gnutls_certificate_free_credentials)

689

certificate_free_credentials.argtypes = [

690

certificate_credentials_t]

691

certificate_free_credentials.restype = None

692

693

handshake_set_private_extensions = (

694

_library.gnutls_handshake_set_private_extensions)

695

handshake_set_private_extensions.argtypes = [session_t,

696

ctypes.c_int]

697

handshake_set_private_extensions.restype = None

698

699

credentials_set = _library.gnutls_credentials_set

700

credentials_set.argtypes = [session_t, credentials_type_t,

701

ctypes.c_void_p]

702

credentials_set.restype = _error_code

703

704

strerror = _library.gnutls_strerror

705

strerror.argtypes = [ctypes.c_int]

706

strerror.restype = ctypes.c_char_p

707

708

certificate_type_get = _library.gnutls_certificate_type_get

709

certificate_type_get.argtypes = [session_t]

710

certificate_type_get.restype = _error_code

711

712

certificate_get_peers = _library.gnutls_certificate_get_peers

713

certificate_get_peers.argtypes = [session_t,

714

ctypes.POINTER(ctypes.c_uint)]

715

certificate_get_peers.restype = ctypes.POINTER(datum_t)

716

717

global_set_log_level = _library.gnutls_global_set_log_level

718

global_set_log_level.argtypes = [ctypes.c_int]

719

global_set_log_level.restype = None

720

721

global_set_log_function = _library.gnutls_global_set_log_function

722

global_set_log_function.argtypes = [log_func]

723

global_set_log_function.restype = None

724

725

deinit = _library.gnutls_deinit

726

deinit.argtypes = [session_t]

727

deinit.restype = None

728

729

handshake = _library.gnutls_handshake

730

handshake.argtypes = [session_t]

731

handshake.restype = _error_code

732

handshake.errcheck = _retry_on_error

733

734

transport_set_ptr = _library.gnutls_transport_set_ptr

735

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

736

transport_set_ptr.restype = None

737

738

bye = _library.gnutls_bye

739

bye.argtypes = [session_t, close_request_t]

740

bye.restype = _error_code

741

bye.errcheck = _retry_on_error

742

743

check_version = _library.gnutls_check_version

744

check_version.argtypes = [ctypes.c_char_p]

745

check_version.restype = ctypes.c_char_p

746

747

has_rawpk = bool(check_version(_tls_rawpk_version))

748

749

if has_rawpk:

750

# Types

751

class pubkey_st(ctypes.Structure):

752

_fields = []

753

pubkey_t = ctypes.POINTER(pubkey_st)

754

755

x509_crt_fmt_t = ctypes.c_int

756

757

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

758

pubkey_init = _library.gnutls_pubkey_init

759

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

760

pubkey_init.restype = _error_code

761

762

pubkey_import = _library.gnutls_pubkey_import

763

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

764

x509_crt_fmt_t]

765

pubkey_import.restype = _error_code

766

767

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

768

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

769

ctypes.POINTER(ctypes.c_ubyte),

770

ctypes.POINTER(ctypes.c_size_t)]

771

pubkey_get_key_id.restype = _error_code

772

773

pubkey_deinit = _library.gnutls_pubkey_deinit

774

pubkey_deinit.argtypes = [pubkey_t]

775

pubkey_deinit.restype = None

776

else:

777

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

778

779

openpgp_crt_init = _library.gnutls_openpgp_crt_init

780

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

781

openpgp_crt_init.restype = _error_code

782

783

openpgp_crt_import = _library.gnutls_openpgp_crt_import

784

openpgp_crt_import.argtypes = [openpgp_crt_t,

785

ctypes.POINTER(datum_t),

786

openpgp_crt_fmt_t]

787

openpgp_crt_import.restype = _error_code

788

789

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

790

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

791

ctypes.POINTER(ctypes.c_uint)]

792

openpgp_crt_verify_self.restype = _error_code

793

794

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

795

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

796

openpgp_crt_deinit.restype = None

797

798

openpgp_crt_get_fingerprint = (

799

_library.gnutls_openpgp_crt_get_fingerprint)

800

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

801

ctypes.c_void_p,

802

ctypes.POINTER(

803

ctypes.c_size_t)]

804

openpgp_crt_get_fingerprint.restype = _error_code

805

806

if check_version("3.6.4"):

807

certificate_type_get2 = _library.gnutls_certificate_type_get2

808

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

809

certificate_type_get2.restype = _error_code

810

811

# Remove non-public functions

812

del _error_code, _retry_on_error

813

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

814

gnutls = GnuTLS()

815

816

817

def call_pipe(connection, # : multiprocessing.Connection

818

func, *args, **kwargs):

819

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

820

821

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

822

return value on the provided multiprocessing.Connection.

823

"""

824

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

825

connection.close()

826

827

388

828

class Client(object):

389

829

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

390

830

391

831

Attributes:

392

832

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

393

833

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

395

835

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

396

836

to see if the client lives.

397

837

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

838

checker_callback_tag: a GLib event source tag, or None

399

839

checker_command: string; External command which is run to check

400

840

if client lives. %() expansions are done at

401

841

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

402

842

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

403

checker_initiator_tag: a gobject event source tag, or None

843

checker_initiator_tag: a GLib event source tag, or None

404

844

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

405

845

client_structure: Object describing what attributes a client has

406

846

and is used for storing the client at exit

407

847

current_checker_command: string; current running checker_command

408

disable_initiator_tag: a gobject event source tag, or None

848

disable_initiator_tag: a GLib event source tag, or None

409

849

enabled: bool()

410

850

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

411

uniquely identify the client

851

uniquely identify an OpenPGP client

852

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

853

a client using raw public keys

412

854

host: string; available for use by the checker command

413

855

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

414

856

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

416

858

last_checker_status: integer between 0 and 255 reflecting exit

417

859

status of last checker. -1 reflects crashed

418

860

checker, -2 means no checker completed yet.

861

last_checker_signal: The signal which killed the last checker, if

862

last_checker_status is -1

419

863

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

420

864

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

421

865

D-Bus identifiers

426

870

runtime_expansions: Allowed attributes for runtime expansion.

427

871

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

428

872

disabled, or None

873

server_settings: The server_settings dict from main()

429

874

"""

430

875

431

876

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

877

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

878

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

879

"last_approval_request", "last_checked_ok",

434

880

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

881

client_defaults = {

882

"timeout": "PT5M",

883

"extended_timeout": "PT15M",

884

"interval": "PT2M",

885

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

886

"host": "",

887

"approval_delay": "PT0S",

888

"approval_duration": "PT1S",

889

"approved_by_default": "True",

890

"enabled": "True",

891

}

460

892

461

893

@staticmethod

462

894

def config_parser(config):

470

902

for client_name in config.sections():

471

903

section = dict(config.items(client_name))

472

904

client = settings[client_name] = {}

473

905

474

906

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

475

907

# Reformat values from string types to Python types

476

908

client["approved_by_default"] = config.getboolean(

477

909

client_name, "approved_by_default")

478

910

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

479

911

"enabled")

480

912

913

# Uppercase and remove spaces from key_id and fingerprint

914

# for later comparison purposes with return value from the

915

# key_id() and fingerprint() functions

916

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

917

.replace(" ", ""))

481

918

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

482

919

.replace(" ", ""))

483

920

if "secret" in section:

484

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

921

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

922

.encode("utf-8"),

923

"base64")

485

924

elif "secfile" in section:

486

925

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

487

926

(section["secfile"])),

488

927

"rb") as secfile:

489

928

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

490

929

else:

491

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

492

% section)

930

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

931

.format(section))

493

932

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

494

933

client["extended_timeout"] = string_to_delta(

495

934

section["extended_timeout"])

502

941

client["last_approval_request"] = None

503

942

client["last_checked_ok"] = None

504

943

client["last_checker_status"] = -2

505

944

506

945

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

946

947

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

513

948

self.name = name

949

if server_settings is None:

950

server_settings = {}

951

self.server_settings = server_settings

514

952

# adding all client settings

515

for setting, value in settings.iteritems():

953

for setting, value in settings.items():

516

954

setattr(self, setting, value)

517

955

518

956

if self.enabled:

519

957

if not hasattr(self, "last_enabled"):

520

958

self.last_enabled = datetime.datetime.utcnow()

524

962

else:

525

963

self.last_enabled = None

526

964

self.expires = None

527

965

528

966

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

967

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

532

968

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

533

969

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

534

970

datetime.datetime.utcnow())

541

977

self.current_checker_command = None

542

978

self.approved = None

543

979

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

980

self.changedstate = multiprocessing_manager.Condition(

981

multiprocessing_manager.Lock())

982

self.client_structure = [attr

983

for attr in self.__dict__.keys()

549

984

if not attr.startswith("_")]

550

985

self.client_structure.append("client_structure")

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

986

987

for name, t in inspect.getmembers(

988

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

556

989

if not name.startswith("_"):

557

990

self.client_structure.append(name)

558

991

559

992

# Send notice to process children that client state has changed

560

993

def send_changedstate(self):

561

994

with self.changedstate:

562

995

self.changedstate.notify_all()

563

996

564

997

def enable(self):

565

998

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

566

999

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

567

1000

# Already enabled

568

1001

return

569

self.send_changedstate()

570

1002

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

571

1003

self.enabled = True

572

1004

self.last_enabled = datetime.datetime.utcnow()

573

1005

self.init_checker()

574

1006

self.send_changedstate()

1007

575

1008

def disable(self, quiet=True):

576

1009

"""Disable this client."""

577

1010

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

578

1011

return False

579

1012

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

1013

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

583

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

584

gobject.source_remove(self.disable_initiator_tag)

1014

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

1015

GLib.source_remove(self.disable_initiator_tag)

585

1016

self.disable_initiator_tag = None

586

1017

self.expires = None

587

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

588

gobject.source_remove(self.checker_initiator_tag)

1018

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

1019

GLib.source_remove(self.checker_initiator_tag)

589

1020

self.checker_initiator_tag = None

590

1021

self.stop_checker()

591

1022

self.enabled = False

592

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

1023

if not quiet:

1024

self.send_changedstate()

1025

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

593

1026

return False

594

1027

595

1028

def __del__(self):

596

1029

self.disable()

597

1030

598

1031

def init_checker(self):

599

1032

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

600

1033

# and every interval from then on.

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

1034

if self.checker_initiator_tag is not None:

1035

GLib.source_remove(self.checker_initiator_tag)

1036

self.checker_initiator_tag = GLib.timeout_add(

1037

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

1038

self.start_checker)

604

1039

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

1040

if self.disable_initiator_tag is not None:

1041

GLib.source_remove(self.disable_initiator_tag)

1042

self.disable_initiator_tag = GLib.timeout_add(

1043

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

608

1044

# Also start a new checker *right now*.

609

1045

self.start_checker()

610

611

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

1046

1047

def checker_callback(self, source, condition, connection,

1048

command):

612

1049

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

613

1050

self.checker_callback_tag = None

614

1051

self.checker = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1052

# Read return code from connection (see call_pipe)

1053

returncode = connection.recv()

1054

connection.close()

1055

1056

if returncode >= 0:

1057

self.last_checker_status = returncode

1058

self.last_checker_signal = None

617

1059

if self.last_checker_status == 0:

618

1060

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

619

1061

vars(self))

620

1062

self.checked_ok()

621

1063

else:

622

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

623

vars(self))

1064

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

624

1065

else:

625

1066

self.last_checker_status = -1

1067

self.last_checker_signal = -returncode

626

1068

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

627

1069

vars(self))

628

1070

return False

1071

629

1072

def checked_ok(self):

630

1073

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

631

1074

self.last_checked_ok = datetime.datetime.utcnow()

632

1075

self.last_checker_status = 0

1076

self.last_checker_signal = None

633

1077

self.bump_timeout()

634

1078

635

1079

def bump_timeout(self, timeout=None):

636

1080

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

637

1081

if timeout is None:

638

1082

timeout = self.timeout

639

1083

if self.disable_initiator_tag is not None:

640

gobject.source_remove(self.disable_initiator_tag)

1084

GLib.source_remove(self.disable_initiator_tag)

1085

self.disable_initiator_tag = None

641

1086

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

642

self.disable_initiator_tag = (gobject.timeout_add

643

(timedelta_to_milliseconds

644

(timeout), self.disable))

1087

self.disable_initiator_tag = GLib.timeout_add(

1088

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

645

1089

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

646

1090

647

1091

def need_approval(self):

648

1092

self.last_approval_request = datetime.datetime.utcnow()

649

1093

650

1094

def start_checker(self):

651

1095

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

652

1096

653

1097

If a checker already exists, leave it running and do

654

1098

nothing."""

655

1099

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

656

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

657

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

658

# client would inevitably timeout, since no checker would get

659

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

1100

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

1101

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

1102

# would inevitably timeout, since no checker would get a

1103

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

660

1104

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

661

1105

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

662

1106

# should be.

663

664

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

665

try:

666

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

667

except (AttributeError, OSError) as error:

668

if (isinstance(error, OSError)

669

and error.errno != errno.ECHILD):

670

raise error

671

else:

672

if pid:

673

logger.warning("Checker was a zombie")

674

gobject.source_remove(self.checker_callback_tag)

675

self.checker_callback(pid, status,

676

self.current_checker_command)

1107

1108

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

1109

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

1110

self.checker.join()

1111

self.checker = None

677

1112

# Start a new checker if needed

678

1113

if self.checker is None:

1114

# Escape attributes for the shell

1115

escaped_attrs = {

1116

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

1117

for attr in self.runtime_expansions}

679

1118

try:

680

# In case checker_command has exactly one % operator

681

command = self.checker_command % self.host

682

except TypeError:

683

# Escape attributes for the shell

684

escaped_attrs = dict(

685

(attr,

686

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

687

errors=

688

'replace')))

689

for attr in

690

self.runtime_expansions)

691

692

try:

693

command = self.checker_command % escaped_attrs

694

except TypeError as error:

695

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

696

' %s', self.checker_command, error)

697

return True # Try again later

1119

command = self.checker_command % escaped_attrs

1120

except TypeError as error:

1121

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

1122

self.checker_command,

1123

exc_info=error)

1124

return True # Try again later

698

1125

self.current_checker_command = command

699

try:

700

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

701

command, self.name)

702

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

703

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

704

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

705

# always replaced by /dev/null.)

706

self.checker = subprocess.Popen(command,

707

close_fds=True,

708

shell=True, cwd="/")

709

self.checker_callback_tag = (gobject.child_watch_add

710

(self.checker.pid,

711

self.checker_callback,

712

data=command))

713

# The checker may have completed before the gobject

714

# watch was added. Check for this.

715

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

716

if pid:

717

gobject.source_remove(self.checker_callback_tag)

718

self.checker_callback(pid, status, command)

719

except OSError as error:

720

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

721

error)

722

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

1126

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

1127

self.name)

1128

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

1129

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

1130

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

1131

# always replaced by /dev/null.)

1132

# The exception is when not debugging but nevertheless

1133

# running in the foreground; use the previously

1134

# created wnull.

1135

popen_args = {"close_fds": True,

1136

"shell": True,

1137

"cwd": "/"}

1138

if (not self.server_settings["debug"]

1139

and self.server_settings["foreground"]):

1140

popen_args.update({"stdout": wnull,

1141

"stderr": wnull})

1142

pipe = multiprocessing.Pipe(duplex=False)

1143

self.checker = multiprocessing.Process(

1144

target=call_pipe,

1145

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

1146

kwargs=popen_args)

1147

self.checker.start()

1148

self.checker_callback_tag = GLib.io_add_watch(

1149

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

1150

self.checker_callback, pipe[0], command)

1151

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

723

1152

return True

724

1153

725

1154

def stop_checker(self):

726

1155

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

727

1156

if self.checker_callback_tag:

728

gobject.source_remove(self.checker_callback_tag)

1157

GLib.source_remove(self.checker_callback_tag)

729

1158

self.checker_callback_tag = None

730

1159

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

731

1160

return

732

1161

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

733

try:

734

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

735

#time.sleep(0.5)

736

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

737

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

738

except OSError as error:

739

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

740

raise

1162

self.checker.terminate()

741

1163

self.checker = None

742

1164

743

1165

744

def dbus_service_property(dbus_interface, signature="v",

745

access="readwrite", byte_arrays=False):

1166

def dbus_service_property(dbus_interface,

1167

signature="v",

1168

access="readwrite",

1169

byte_arrays=False):

746

1170

"""Decorators for marking methods of a DBusObjectWithProperties to

747

1171

become properties on the D-Bus.

748

1172

749

1173

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

750

1174

and with one argument by "Set".

751

1175

752

1176

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

753

1177

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

754

1178

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

757

1181

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

758

1182

if byte_arrays and signature != "ay":

759

1183

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

760

" signature %r" % signature)

1184

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

1185

761

1186

def decorator(func):

762

1187

func._dbus_is_property = True

763

1188

func._dbus_interface = dbus_interface

766

1191

func._dbus_name = func.__name__

767

1192

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

768

1193

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

769

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

770

return func

1194

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1195

return func

1196

1197

return decorator

1198

1199

1200

def dbus_interface_annotations(dbus_interface):

1201

"""Decorator for marking functions returning interface annotations

1202

1203

Usage:

1204

1205

@dbus_interface_annotations("org.example.Interface")

1206

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

1207

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

1208

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

1209

"false"}

1210

"""

1211

1212

def decorator(func):

1213

func._dbus_is_interface = True

1214

func._dbus_interface = dbus_interface

1215

func._dbus_name = dbus_interface

1216

return func

1217

1218

return decorator

1219

1220

1221

def dbus_annotations(annotations):

1222

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

1223

Usage:

1224

1225

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

1226

"org.freedesktop.DBus.Property."

1227

"EmitsChangedSignal": "false"})

1228

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

1229

access="r")

1230

def Property_dbus_property(self):

1231

return dbus.Boolean(False)

1232

1233

See also the DBusObjectWithAnnotations class.

1234

"""

1235

1236

def decorator(func):

1237

func._dbus_annotations = annotations

1238

return func

1239

771

1240

return decorator

772

1241

773

1242

774

1243

class DBusPropertyException(dbus.exceptions.DBusException):

775

1244

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

776

1245

"""

777

def __unicode__(self):

778

return unicode(str(self))

1246

pass

779

1247

780

1248

781

1249

class DBusPropertyAccessException(DBusPropertyException):

790

1258

pass

791

1259

792

1260

793

class DBusObjectWithProperties(dbus.service.Object):

1261

class DBusObjectWithAnnotations(dbus.service.Object):

1262

"""A D-Bus object with annotations.

1263

1264

Classes inheriting from this can use the dbus_annotations

1265

decorator to add annotations to methods or signals.

1266

"""

1267

1268

@staticmethod

1269

def _is_dbus_thing(thing):

1270

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

1271

1272

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

1273

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

1274

"""

1275

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

1276

False)

1277

1278

def _get_all_dbus_things(self, thing):

1279

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

1280

"""

1281

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

1282

athing.__get__(self))

1283

for cls in self.__class__.__mro__

1284

for name, athing in

1285

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

1286

1287

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1288

out_signature="s",

1289

path_keyword='object_path',

1290

connection_keyword='connection')

1291

def Introspect(self, object_path, connection):

1292

"""Overloading of standard D-Bus method.

1293

1294

Inserts annotation tags on methods and signals.

1295

"""

1296

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

1297

connection)

1298

try:

1299

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

1300

1301

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

1302

# Add annotation tags

1303

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

1304

for tag in if_tag.getElementsByTagName(typ):

1305

annots = dict()

1306

for name, prop in (self.

1307

_get_all_dbus_things(typ)):

1308

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

1309

and prop._dbus_interface

1310

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

1311

annots.update(getattr(

1312

prop, "_dbus_annotations", {}))

1313

for name, value in annots.items():

1314

ann_tag = document.createElement(

1315

"annotation")

1316

ann_tag.setAttribute("name", name)

1317

ann_tag.setAttribute("value", value)

1318

tag.appendChild(ann_tag)

1319

# Add interface annotation tags

1320

for annotation, value in dict(

1321

itertools.chain.from_iterable(

1322

annotations().items()

1323

for name, annotations

1324

in self._get_all_dbus_things("interface")

1325

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

1326

)).items():

1327

ann_tag = document.createElement("annotation")

1328

ann_tag.setAttribute("name", annotation)

1329

ann_tag.setAttribute("value", value)

1330

if_tag.appendChild(ann_tag)

1331

# Fix argument name for the Introspect method itself

1332

if (if_tag.getAttribute("name")

1333

== dbus.INTROSPECTABLE_IFACE):

1334

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

1335

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

1336

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

1337

if (arg.getAttribute("direction")

1338

== "out"):

1339

arg.setAttribute("name",

1340

"xml_data")

1341

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

1342

document.unlink()

1343

except (AttributeError, xml.dom.DOMException,

1344

xml.parsers.expat.ExpatError) as error:

1345

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

1346

exc_info=error)

1347

return xmlstring

1348

1349

1350

class DBusObjectWithProperties(DBusObjectWithAnnotations):

794

1351

"""A D-Bus object with properties.

795

1352

796

1353

Classes inheriting from this can use the dbus_service_property

797

1354

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

798

1355

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

799

1356

"""

800

801

@staticmethod

802

def _is_dbus_property(obj):

803

return getattr(obj, "_dbus_is_property", False)

804

805

def _get_all_dbus_properties(self):

806

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

807

"""

808

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

809

for cls in self.__class__.__mro__

810

for name, prop in

811

inspect.getmembers(cls, self._is_dbus_property))

812

1357

813

1358

def _get_dbus_property(self, interface_name, property_name):

814

1359

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

815

1360

property with the specified name and interface.

816

1361

"""

817

for cls in self.__class__.__mro__:

818

for name, value in (inspect.getmembers

819

(cls, self._is_dbus_property)):

1362

for cls in self.__class__.__mro__:

1363

for name, value in inspect.getmembers(

1364

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

820

1365

if (value._dbus_name == property_name

821

1366

and value._dbus_interface == interface_name):

822

1367

return value.__get__(self)

823

1368

824

1369

# No such property

825

raise DBusPropertyNotFound(self.dbus_object_path + ":"

826

+ interface_name + "."

827

+ property_name)

828

829

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

1370

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

1371

self.dbus_object_path, interface_name, property_name))

1372

1373

@classmethod

1374

def _get_all_interface_names(cls):

1375

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

1376

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

1377

"_dbus_interface", None)

1378

for x in (inspect.getmro(cls))

1379

for attr in dir(x))

1380

if name is not None)

1381

1382

@dbus.service.method(dbus.PROPERTIES_IFACE,

1383

in_signature="ss",

830

1384

out_signature="v")

831

1385

def Get(self, interface_name, property_name):

832

1386

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

838

1392

if not hasattr(value, "variant_level"):

839

1393

return value

840

1394

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

841

1395

842

1396

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

843

1397

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

844

1398

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

850

1404

# The byte_arrays option is not supported yet on

851

1405

# signatures other than "ay".

852

1406

if prop._dbus_signature != "ay":

853

raise ValueError

1407

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

1408

"'ay' signature {!r}"

1409

.format(prop._dbus_signature))

854

1410

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

855

1411

for byte in value))

856

1412

prop(value)

857

858

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

1413

1414

@dbus.service.method(dbus.PROPERTIES_IFACE,

1415

in_signature="s",

859

1416

out_signature="a{sv}")

860

1417

def GetAll(self, interface_name):

861

1418

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

862

1419

standard.

863

1420

864

1421

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

865

1422

"""

866

1423

properties = {}

867

for name, prop in self._get_all_dbus_properties():

1424

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

868

1425

if (interface_name

869

1426

and interface_name != prop._dbus_interface):

870

1427

# Interface non-empty but did not match

876

1433

if not hasattr(value, "variant_level"):

877

1434

properties[name] = value

878

1435

continue

879

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

880

value.variant_level+1)

1436

properties[name] = type(value)(

1437

value, variant_level=value.variant_level + 1)

881

1438

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

882

1439

1440

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

1441

def PropertiesChanged(self, interface_name, changed_properties,

1442

invalidated_properties):

1443

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

1444

standard.

1445

"""

1446

pass

1447

883

1448

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

884

1449

out_signature="s",

885

1450

path_keyword='object_path',

886

1451

connection_keyword='connection')

887

1452

def Introspect(self, object_path, connection):

888

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

1453

"""Overloading of standard D-Bus method.

1454

1455

Inserts property tags and interface annotation tags.

889

1456

"""

890

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

891

connection)

1457

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1458

object_path,

1459

connection)

892

1460

try:

893

1461

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

1462

894

1463

def make_tag(document, name, prop):

895

1464

e = document.createElement("property")

896

1465

e.setAttribute("name", name)

897

1466

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

898

1467

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

899

1468

return e

1469

900

1470

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

1471

# Add property tags

901

1472

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

902

1473

for name, prop

903

in self._get_all_dbus_properties()

1474

in self._get_all_dbus_things("property")

904

1475

if prop._dbus_interface

905

1476

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

906

1477

if_tag.appendChild(tag)

1478

# Add annotation tags for properties

1479

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

1480

annots = dict()

1481

for name, prop in self._get_all_dbus_things(

1482

"property"):

1483

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

1484

and prop._dbus_interface

1485

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

1486

annots.update(getattr(

1487

prop, "_dbus_annotations", {}))

1488

for name, value in annots.items():

1489

ann_tag = document.createElement(

1490

"annotation")

1491

ann_tag.setAttribute("name", name)

1492

ann_tag.setAttribute("value", value)

1493

tag.appendChild(ann_tag)

907

1494

# Add the names to the return values for the

908

1495

# "org.freedesktop.DBus.Properties" methods

909

1496

if (if_tag.getAttribute("name")

924

1511

except (AttributeError, xml.dom.DOMException,

925

1512

xml.parsers.expat.ExpatError) as error:

926

1513

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

927

error)

928

return xmlstring

929

930

931

def datetime_to_dbus (dt, variant_level=0):

1514

exc_info=error)

1515

return xmlstring

1516

1517

1518

try:

1519

dbus.OBJECT_MANAGER_IFACE

1520

except AttributeError:

1521

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

1522

1523

1524

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1525

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

1526

1527

Classes inheriting from this exposes the standard

1528

GetManagedObjects call and the InterfacesAdded and

1529

InterfacesRemoved signals on the standard

1530

"org.freedesktop.DBus.ObjectManager" interface.

1531

1532

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

1533

manually.

1534

"""

1535

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def GetManagedObjects(self):

1538

"""This function must be overridden"""

1539

raise NotImplementedError()

1540

1541

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def InterfacesAdded(self, object_path, interfaces_and_properties):

1544

pass

1545

1546

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

1547

def InterfacesRemoved(self, object_path, interfaces):

1548

pass

1549

1550

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1551

out_signature="s",

1552

path_keyword='object_path',

1553

connection_keyword='connection')

1554

def Introspect(self, object_path, connection):

1555

"""Overloading of standard D-Bus method.

1556

1557

Override return argument name of GetManagedObjects to be

1558

"objpath_interfaces_and_properties"

1559

"""

1560

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1561

object_path,

1562

connection)

1563

try:

1564

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

1565

1566

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

1567

# Fix argument name for the GetManagedObjects method

1568

if (if_tag.getAttribute("name")

1569

== dbus.OBJECT_MANAGER_IFACE):

1570

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

1571

if (cn.getAttribute("name")

1572

== "GetManagedObjects"):

1573

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

1574

if (arg.getAttribute("direction")

1575

== "out"):

1576

arg.setAttribute(

1577

"name",

1578

"objpath_interfaces"

1579

"_and_properties")

1580

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

1581

document.unlink()

1582

except (AttributeError, xml.dom.DOMException,

1583

xml.parsers.expat.ExpatError) as error:

1584

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

1585

exc_info=error)

1586

return xmlstring

1587

1588

1589

def datetime_to_dbus(dt, variant_level=0):

932

1590

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

933

1591

if dt is None:

934

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

935

return dbus.String(dt.isoformat(),

936

variant_level=variant_level)

937

938

939

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

940

.__metaclass__):

941

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

942

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

1592

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

1593

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

1594

1595

1596

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1597

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

1598

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

1599

interface names according to the "alt_interface_names" mapping.

1600

Usage:

1601

1602

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

1603

"net.example.AlternateInterface"})

1604

class SampleDBusObject(dbus.service.Object):

1605

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

1606

def SampleDBusMethod():

1607

pass

1608

1609

The above "SampleDBusMethod" on "SampleDBusObject" will be

1610

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

1611

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

1612

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

1613

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

1614

1615

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

1616

(from DBusObjectWithProperties) and interfaces (from the

1617

dbus_interface_annotations decorator).

943

1618

"""

944

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

945

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

946

# methods, signals, or properties in them

947

for base in (b for b in bases

948

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

949

# Go though all attributes of the base class

950

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

1619

1620

def wrapper(cls):

1621

for orig_interface_name, alt_interface_name in (

1622

alt_interface_names.items()):

1623

attr = {}

1624

interface_names = set()

1625

# Go though all attributes of the class

1626

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

951

1627

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

952

1628

# with the wrong interface name

953

1629

if (not hasattr(attribute, "_dbus_interface")

954

or not attribute._dbus_interface

955

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

1630

or not attribute._dbus_interface.startswith(

1631

orig_interface_name)):

956

1632

continue

957

1633

# Create an alternate D-Bus interface name based on

958

1634

# the current name

959

alt_interface = (attribute._dbus_interface

960

.replace("se.recompile.Mandos",

961

"se.bsnet.fukt.Mandos"))

1635

alt_interface = attribute._dbus_interface.replace(

1636

orig_interface_name, alt_interface_name)

1637

interface_names.add(alt_interface)

962

1638

# Is this a D-Bus signal?

963

1639

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

964

# Extract the original non-method function by

965

# black magic

966

nonmethod_func = (dict(

1640

# Extract the original non-method undecorated

1641

# function by black magic

1642

if sys.version_info.major == 2:

1643

nonmethod_func = (dict(

967

1644

zip(attribute.func_code.co_freevars,

968

attribute.__closure__))["func"]

969

.cell_contents)

1645

attribute.__closure__))

1646

["func"].cell_contents)

1647

else:

1648

nonmethod_func = (dict(

1649

zip(attribute.__code__.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

970

1652

# Create a new, but exactly alike, function

971

1653

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

972

1654

# with the alternate D-Bus interface name

973

new_function = (dbus.service.signal

974

(alt_interface,

975

attribute._dbus_signature)

976

(types.FunctionType(

977

nonmethod_func.func_code,

978

nonmethod_func.func_globals,

979

nonmethod_func.func_name,

980

nonmethod_func.func_defaults,

981

nonmethod_func.func_closure)))

1655

new_function = copy_function(nonmethod_func)

1656

new_function = (dbus.service.signal(

1657

alt_interface,

1658

attribute._dbus_signature)(new_function))

1659

# Copy annotations, if any

1660

try:

1661

new_function._dbus_annotations = dict(

1662

attribute._dbus_annotations)

1663

except AttributeError:

1664

pass

1665

982

1666

# Define a creator of a function to call both the

983

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

984

# signals gets sent when the function is called

1667

# original and alternate functions, so both the

1668

# original and alternate signals gets sent when

1669

# the function is called

985

1670

def fixscope(func1, func2):

986

1671

"""This function is a scope container to pass

987

1672

func1 and func2 to the "call_both" function

988

1673

outside of its arguments"""

1674

1675

@functools.wraps(func2)

989

1676

def call_both(*args, **kwargs):

990

1677

"""This function will emit two D-Bus

991

1678

signals by calling func1 and func2"""

992

1679

func1(*args, **kwargs)

993

1680

func2(*args, **kwargs)

1681

# Make wrapper function look like a D-Bus

1682

# signal

1683

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

1684

if name.startswith("_dbus_"):

1685

setattr(call_both, name, attr)

1686

994

1687

return call_both

995

1688

# Create the "call_both" function and add it to

996

1689

# the class

997

attr[attrname] = fixscope(attribute,

998

new_function)

1690

attr[attrname] = fixscope(attribute, new_function)

999

1691

# Is this a D-Bus method?

1000

1692

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

1001

1693

# Create a new, but exactly alike, function

1002

1694

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

1003

1695

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

1004

1696

# to the class.

1005

attr[attrname] = (dbus.service.method

1006

(alt_interface,

1007

attribute._dbus_in_signature,

1008

attribute._dbus_out_signature)

1009

(types.FunctionType

1010

(attribute.func_code,

1011

attribute.func_globals,

1012

attribute.func_name,

1013

attribute.func_defaults,

1014

attribute.func_closure)))

1697

attr[attrname] = (

1698

dbus.service.method(

1699

alt_interface,

1700

attribute._dbus_in_signature,

1701

attribute._dbus_out_signature)

1702

(copy_function(attribute)))

1703

# Copy annotations, if any

1704

try:

1705

attr[attrname]._dbus_annotations = dict(

1706

attribute._dbus_annotations)

1707

except AttributeError:

1708

pass

1015

1709

# Is this a D-Bus property?

1016

1710

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

1017

1711

# Create a new, but exactly alike, function

1018

1712

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

1019

1713

# property with the alternate D-Bus interface

1020

1714

# name. Add it to the class.

1021

attr[attrname] = (dbus_service_property

1022

(alt_interface,

1023

attribute._dbus_signature,

1024

attribute._dbus_access,

1025

attribute

1026

._dbus_get_args_options

1027

["byte_arrays"])

1028

(types.FunctionType

1029

(attribute.func_code,

1030

attribute.func_globals,

1031

attribute.func_name,

1032

attribute.func_defaults,

1033

attribute.func_closure)))

1034

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

1035

1036

1715

attr[attrname] = (dbus_service_property(

1716

alt_interface, attribute._dbus_signature,

1717

attribute._dbus_access,

1718

attribute._dbus_get_args_options

1719

["byte_arrays"])

1720

(copy_function(attribute)))

1721

# Copy annotations, if any

1722

try:

1723

attr[attrname]._dbus_annotations = dict(

1724

attribute._dbus_annotations)

1725

except AttributeError:

1726

pass

1727

# Is this a D-Bus interface?

1728

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

1729

# Create a new, but exactly alike, function

1730

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

1731

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

1732

# to the class.

1733

attr[attrname] = (

1734

dbus_interface_annotations(alt_interface)

1735

(copy_function(attribute)))

1736

if deprecate:

1737

# Deprecate all alternate interfaces

1738

iname = "_AlternateDBusNames_interface_annotation{}"

1739

for interface_name in interface_names:

1740

1741

@dbus_interface_annotations(interface_name)

1742

def func(self):

1743

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

1744

"true"}

1745

# Find an unused name

1746

for aname in (iname.format(i)

1747

for i in itertools.count()):

1748

if aname not in attr:

1749

attr[aname] = func

1750

break

1751

if interface_names:

1752

# Replace the class with a new subclass of it with

1753

# methods, signals, etc. as created above.

1754

if sys.version_info.major == 2:

1755

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

1756

(cls, ), attr)

1757

else:

1758

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

1759

(cls, ), attr)

1760

return cls

1761

1762

return wrapper

1763

1764

1765

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

1766

"se.bsnet.fukt.Mandos"})

1037

1767

class ClientDBus(Client, DBusObjectWithProperties):

1038

1768

"""A Client class using D-Bus

1039

1769

1040

1770

Attributes:

1041

1771

dbus_object_path: dbus.ObjectPath

1042

1772

bus: dbus.SystemBus()

1043

1773

"""

1044

1774

1045

1775

runtime_expansions = (Client.runtime_expansions

1046

+ ("dbus_object_path",))

1047

1776

+ ("dbus_object_path", ))

1777

1778

_interface = "se.recompile.Mandos.Client"

1779

1048

1780

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

1049

1050

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

1781

1782

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

1051

1783

self.bus = bus

1052

1784

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

1053

1785

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

1054

1786

# the D-Bus

1055

client_object_name = unicode(self.name).translate(

1787

client_object_name = str(self.name).translate(

1056

1788

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

1057

1789

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

1058

self.dbus_object_path = (dbus.ObjectPath

1059

("/clients/" + client_object_name))

1790

self.dbus_object_path = dbus.ObjectPath(

1791

"/clients/" + client_object_name)

1060

1792

DBusObjectWithProperties.__init__(self, self.bus,

1061

1793

self.dbus_object_path)

1062

1063

def notifychangeproperty(transform_func,

1064

dbus_name, type_func=lambda x: x,

1065

variant_level=1):

1794

1795

def notifychangeproperty(transform_func, dbus_name,

1796

type_func=lambda x: x,

1797

variant_level=1,

1798

invalidate_only=False,

1799

_interface=_interface):

1066

1800

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

1067

1801

its changes to DBus.

1068

1802

1069

1803

transform_fun: Function that takes a value and a variant_level

1070

1804

and transforms it to a D-Bus type.

1071

1805

dbus_name: D-Bus name of the variable

1073

1807

to the D-Bus. Default: no transform

1074

1808

variant_level: D-Bus variant level. Default: 1

1075

1809

"""

1076

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

1810

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

1811

1077

1812

def setter(self, value):

1078

1813

if hasattr(self, "dbus_object_path"):

1079

1814

if (not hasattr(self, attrname) or

1080

1815

type_func(getattr(self, attrname, None))

1081

1816

!= type_func(value)):

1082

dbus_value = transform_func(type_func(value),

1083

variant_level

1084

=variant_level)

1085

self.PropertyChanged(dbus.String(dbus_name),

1086

dbus_value)

1817

if invalidate_only:

1818

self.PropertiesChanged(

1819

_interface, dbus.Dictionary(),

1820

dbus.Array((dbus_name, )))

1821

else:

1822

dbus_value = transform_func(

1823

type_func(value),

1824

variant_level=variant_level)

1825

self.PropertyChanged(dbus.String(dbus_name),

1826

dbus_value)

1827

self.PropertiesChanged(

1828

_interface,

1829

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

1830

dbus_value}),

1831

dbus.Array())

1087

1832

setattr(self, attrname, value)

1088

1833

1089

1834

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

1090

1091

1835

1092

1836

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1093

1837

approvals_pending = notifychangeproperty(dbus.Boolean,

1094

1838

"ApprovalPending",

1095

type_func = bool)

1839

type_func=bool)

1096

1840

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

1097

1841

last_enabled = notifychangeproperty(datetime_to_dbus,

1098

1842

"LastEnabled")

1099

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

1100

type_func = lambda checker:

1101

checker is not None)

1843

checker = notifychangeproperty(

1844

dbus.Boolean, "CheckerRunning",

1845

type_func=lambda checker: checker is not None)

1102

1846

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1103

1847

"LastCheckedOK")

1104

1848

last_checker_status = notifychangeproperty(dbus.Int16,

1107

1851

datetime_to_dbus, "LastApprovalRequest")

1108

1852

approved_by_default = notifychangeproperty(dbus.Boolean,

1109

1853

"ApprovedByDefault")

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1854

approval_delay = notifychangeproperty(

1855

dbus.UInt64, "ApprovalDelay",

1856

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

1114

1857

approval_duration = notifychangeproperty(

1115

1858

dbus.UInt64, "ApprovalDuration",

1116

type_func = timedelta_to_milliseconds)

1859

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

1117

1860

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1861

timeout = notifychangeproperty(

1862

dbus.UInt64, "Timeout",

1863

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

1121

1864

extended_timeout = notifychangeproperty(

1122

1865

dbus.UInt64, "ExtendedTimeout",

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

timedelta_to_milliseconds)

1866

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

1867

interval = notifychangeproperty(

1868

dbus.UInt64, "Interval",

1869

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

1128

1870

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

1129

1871

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

1872

invalidate_only=True)

1873

1130

1874

del notifychangeproperty

1131

1875

1132

1876

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

1133

1877

try:

1134

1878

self.remove_from_connection()

1137

1881

if hasattr(DBusObjectWithProperties, "__del__"):

1138

1882

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

1139

1883

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

1140

1141

def checker_callback(self, pid, condition, command,

1142

*args, **kwargs):

1143

self.checker_callback_tag = None

1144

self.checker = None

1145

if os.WIFEXITED(condition):

1146

exitstatus = os.WEXITSTATUS(condition)

1884

1885

def checker_callback(self, source, condition,

1886

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

1887

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

1888

connection, command, *args,

1889

**kwargs)

1890

exitstatus = self.last_checker_status

1891

if exitstatus >= 0:

1147

1892

# Emit D-Bus signal

1148

1893

self.CheckerCompleted(dbus.Int16(exitstatus),

1149

dbus.Int64(condition),

1894

# This is specific to GNU libC

1895

dbus.Int64(exitstatus << 8),

1150

1896

dbus.String(command))

1151

1897

else:

1152

1898

# Emit D-Bus signal

1153

1899

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

1154

dbus.Int64(condition),

1900

dbus.Int64(

1901

# This is specific to GNU libC

1902

(exitstatus << 8)

1903

| self.last_checker_signal),

1155

1904

dbus.String(command))

1156

1157

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

1158

*args, **kwargs)

1159

1905

return ret

1906

1160

1907

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

1161

old_checker = self.checker

1162

if self.checker is not None:

1163

old_checker_pid = self.checker.pid

1164

else:

1165

old_checker_pid = None

1908

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

1166

1909

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

1167

1910

# Only if new checker process was started

1168

1911

if (self.checker is not None

1170

1913

# Emit D-Bus signal

1171

1914

self.CheckerStarted(self.current_checker_command)

1172

1915

return r

1173

1916

1174

1917

def _reset_approved(self):

1175

1918

self.approved = None

1176

1919

return False

1177

1920

1178

1921

def approve(self, value=True):

1179

self.send_changedstate()

1180

1922

self.approved = value

1181

gobject.timeout_add(timedelta_to_milliseconds

1182

(self.approval_duration),

1183

self._reset_approved)

1184

1185

1186

## D-Bus methods, signals & properties

1187

_interface = "se.recompile.Mandos.Client"

1188

1189

## Signals

1190

1923

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

1924

* 1000), self._reset_approved)

1925

self.send_changedstate()

1926

1927

# D-Bus methods, signals & properties

1928

1929

# Interfaces

1930

1931

# Signals

1932

1191

1933

# CheckerCompleted - signal

1192

1934

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

1193

1935

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

1194

1936

"D-Bus signal"

1195

1937

pass

1196

1938

1197

1939

# CheckerStarted - signal

1198

1940

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

1199

1941

def CheckerStarted(self, command):

1200

1942

"D-Bus signal"

1201

1943

pass

1202

1944

1203

1945

# PropertyChanged - signal

1946

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

1204

1947

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

1205

1948

def PropertyChanged(self, property, value):

1206

1949

"D-Bus signal"

1207

1950

pass

1208

1951

1209

1952

# GotSecret - signal

1210

1953

@dbus.service.signal(_interface)

1211

1954

def GotSecret(self):

1214

1957

server to mandos-client

1215

1958

"""

1216

1959

pass

1217

1960

1218

1961

# Rejected - signal

1219

1962

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

1220

1963

def Rejected(self, reason):

1221

1964

"D-Bus signal"

1222

1965

pass

1223

1966

1224

1967

# NeedApproval - signal

1225

1968

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

1226

1969

def NeedApproval(self, timeout, default):

1227

1970

"D-Bus signal"

1228

1971

return self.need_approval()

1229

1230

## Methods

1231

1972

1973

# Methods

1974

1232

1975

# Approve - method

1233

1976

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

1234

1977

def Approve(self, value):

1235

1978

self.approve(value)

1236

1979

1237

1980

# CheckedOK - method

1238

1981

@dbus.service.method(_interface)

1239

1982

def CheckedOK(self):

1240

1983

self.checked_ok()

1241

1984

1242

1985

# Enable - method

1986

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

1243

1987

@dbus.service.method(_interface)

1244

1988

def Enable(self):

1245

1989

"D-Bus method"

1246

1990

self.enable()

1247

1991

1248

1992

# StartChecker - method

1993

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

1249

1994

@dbus.service.method(_interface)

1250

1995

def StartChecker(self):

1251

1996

"D-Bus method"

1252

1997

self.start_checker()

1253

1998

1254

1999

# Disable - method

2000

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

1255

2001

@dbus.service.method(_interface)

1256

2002

def Disable(self):

1257

2003

"D-Bus method"

1258

2004

self.disable()

1259

2005

1260

2006

# StopChecker - method

2007

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

1261

2008

@dbus.service.method(_interface)

1262

2009

def StopChecker(self):

1263

2010

self.stop_checker()

1264

1265

## Properties

1266

2011

2012

# Properties

2013

1267

2014

# ApprovalPending - property

1268

2015

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

1269

2016

def ApprovalPending_dbus_property(self):

1270

2017

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

1271

2018

1272

2019

# ApprovedByDefault - property

1273

@dbus_service_property(_interface, signature="b",

2020

@dbus_service_property(_interface,

2021

signature="b",

1274

2022

access="readwrite")

1275

2023

def ApprovedByDefault_dbus_property(self, value=None):

1276

2024

if value is None: # get

1277

2025

return dbus.Boolean(self.approved_by_default)

1278

2026

self.approved_by_default = bool(value)

1279

2027

1280

2028

# ApprovalDelay - property

1281

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1282

2031

access="readwrite")

1283

2032

def ApprovalDelay_dbus_property(self, value=None):

1284

2033

if value is None: # get

1285

return dbus.UInt64(self.approval_delay_milliseconds())

2034

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

2035

* 1000)

1286

2036

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

1287

2037

1288

2038

# ApprovalDuration - property

1289

@dbus_service_property(_interface, signature="t",

2039

@dbus_service_property(_interface,

2040

signature="t",

1290

2041

access="readwrite")

1291

2042

def ApprovalDuration_dbus_property(self, value=None):

1292

2043

if value is None: # get

1293

return dbus.UInt64(timedelta_to_milliseconds(

1294

self.approval_duration))

2044

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

2045

* 1000)

1295

2046

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

1296

2047

1297

2048

# Name - property

2049

@dbus_annotations(

2050

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

1298

2051

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

1299

2052

def Name_dbus_property(self):

1300

2053

return dbus.String(self.name)

1301

2054

2055

# KeyID - property

2056

@dbus_annotations(

2057

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

2058

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

2059

def KeyID_dbus_property(self):

2060

return dbus.String(self.key_id)

2061

1302

2062

# Fingerprint - property

2063

@dbus_annotations(

2064

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

1303

2065

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

1304

2066

def Fingerprint_dbus_property(self):

1305

2067

return dbus.String(self.fingerprint)

1306

2068

1307

2069

# Host - property

1308

@dbus_service_property(_interface, signature="s",

2070

@dbus_service_property(_interface,

2071

signature="s",

1309

2072

access="readwrite")

1310

2073

def Host_dbus_property(self, value=None):

1311

2074

if value is None: # get

1312

2075

return dbus.String(self.host)

1313

self.host = unicode(value)

1314

2076

self.host = str(value)

2077

1315

2078

# Created - property

2079

@dbus_annotations(

2080

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

1316

2081

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

1317

2082

def Created_dbus_property(self):

1318

2083

return datetime_to_dbus(self.created)

1319

2084

1320

2085

# LastEnabled - property

1321

2086

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

1322

2087

def LastEnabled_dbus_property(self):

1323

2088

return datetime_to_dbus(self.last_enabled)

1324

2089

1325

2090

# Enabled - property

1326

@dbus_service_property(_interface, signature="b",

2091

@dbus_service_property(_interface,

2092

signature="b",

1327

2093

access="readwrite")

1328

2094

def Enabled_dbus_property(self, value=None):

1329

2095

if value is None: # get

1332

2098

self.enable()

1333

2099

else:

1334

2100

self.disable()

1335

2101

1336

2102

# LastCheckedOK - property

1337

@dbus_service_property(_interface, signature="s",

2103

@dbus_service_property(_interface,

2104

signature="s",

1338

2105

access="readwrite")

1339

2106

def LastCheckedOK_dbus_property(self, value=None):

1340

2107

if value is not None:

1341

2108

self.checked_ok()

1342

2109

return

1343

2110

return datetime_to_dbus(self.last_checked_ok)

1344

2111

1345

2112

# LastCheckerStatus - property

1346

@dbus_service_property(_interface, signature="n",

1347

access="read")

2113

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

1348

2114

def LastCheckerStatus_dbus_property(self):

1349

2115

return dbus.Int16(self.last_checker_status)

1350

2116

1351

2117

# Expires - property

1352

2118

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

1353

2119

def Expires_dbus_property(self):

1354

2120

return datetime_to_dbus(self.expires)

1355

2121

1356

2122

# LastApprovalRequest - property

1357

2123

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

1358

2124

def LastApprovalRequest_dbus_property(self):

1359

2125

return datetime_to_dbus(self.last_approval_request)

1360

2126

1361

2127

# Timeout - property

1362

@dbus_service_property(_interface, signature="t",

2128

@dbus_service_property(_interface,

2129

signature="t",

1363

2130

access="readwrite")

1364

2131

def Timeout_dbus_property(self, value=None):

1365

2132

if value is None: # get

1366

return dbus.UInt64(self.timeout_milliseconds())

2133

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

2134

old_timeout = self.timeout

1367

2135

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

1368

# Reschedule timeout

2136

# Reschedule disabling

1369

2137

if self.enabled:

1370

2138

now = datetime.datetime.utcnow()

1371

time_to_die = timedelta_to_milliseconds(

1372

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

1373

if time_to_die <= 0:

2139

self.expires += self.timeout - old_timeout

2140

if self.expires <= now:

1374

2141

# The timeout has passed

1375

2142

self.disable()

1376

2143

else:

1377

self.expires = (now +

1378

datetime.timedelta(milliseconds =

1379

time_to_die))

1380

2144

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

1381

2145

is None):

1382

2146

return

1383

gobject.source_remove(self.disable_initiator_tag)

1384

self.disable_initiator_tag = (gobject.timeout_add

1385

(time_to_die,

1386

self.disable))

1387

2147

GLib.source_remove(self.disable_initiator_tag)

2148

self.disable_initiator_tag = GLib.timeout_add(

2149

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

2150

self.disable)

2151

1388

2152

# ExtendedTimeout - property

1389

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1390

2155

access="readwrite")

1391

2156

def ExtendedTimeout_dbus_property(self, value=None):

1392

2157

if value is None: # get

1393

return dbus.UInt64(self.extended_timeout_milliseconds())

2158

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

2159

* 1000)

1394

2160

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

1395

2161

1396

2162

# Interval - property

1397

@dbus_service_property(_interface, signature="t",

2163

@dbus_service_property(_interface,

2164

signature="t",

1398

2165

access="readwrite")

1399

2166

def Interval_dbus_property(self, value=None):

1400

2167

if value is None: # get

1401

return dbus.UInt64(self.interval_milliseconds())

2168

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

1402

2169

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

1403

2170

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

1404

2171

return

1405

2172

if self.enabled:

1406

2173

# Reschedule checker run

1407

gobject.source_remove(self.checker_initiator_tag)

1408

self.checker_initiator_tag = (gobject.timeout_add

1409

(value, self.start_checker))

1410

self.start_checker() # Start one now, too

1411

2174

GLib.source_remove(self.checker_initiator_tag)

2175

self.checker_initiator_tag = GLib.timeout_add(

2176

value, self.start_checker)

2177

self.start_checker() # Start one now, too

2178

1412

2179

# Checker - property

1413

@dbus_service_property(_interface, signature="s",

2180

@dbus_service_property(_interface,

2181

signature="s",

1414

2182

access="readwrite")

1415

2183

def Checker_dbus_property(self, value=None):

1416

2184

if value is None: # get

1417

2185

return dbus.String(self.checker_command)

1418

self.checker_command = unicode(value)

1419

2186

self.checker_command = str(value)

2187

1420

2188

# CheckerRunning - property

1421

@dbus_service_property(_interface, signature="b",

2189

@dbus_service_property(_interface,

2190

signature="b",

1422

2191

access="readwrite")

1423

2192

def CheckerRunning_dbus_property(self, value=None):

1424

2193

if value is None: # get

1427

2196

self.start_checker()

1428

2197

else:

1429

2198

self.stop_checker()

1430

2199

1431

2200

# ObjectPath - property

2201

@dbus_annotations(

2202

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

2203

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

1432

2204

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

1433

2205

def ObjectPath_dbus_property(self):

1434

return self.dbus_object_path # is already a dbus.ObjectPath

1435

2206

return self.dbus_object_path # is already a dbus.ObjectPath

2207

1436

2208

# Secret = property

1437

@dbus_service_property(_interface, signature="ay",

1438

access="write", byte_arrays=True)

2209

@dbus_annotations(

2210

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

2211

"invalidates"})

2212

@dbus_service_property(_interface,

2213

signature="ay",

2214

access="write",

2215

byte_arrays=True)

1439

2216

def Secret_dbus_property(self, value):

1440

self.secret = str(value)

1441

2217

self.secret = bytes(value)

2218

1442

2219

del _interface

1443

2220

1444

2221

1445

2222

class ProxyClient(object):

1446

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

2223

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

1447

2224

self._pipe = child_pipe

1448

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

2225

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

1449

2226

if not self._pipe.recv():

1450

raise KeyError()

1451

2227

raise KeyError(key_id or fpr)

2228

1452

2229

def __getattribute__(self, name):

1453

2230

if name == '_pipe':

1454

2231

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

1457

2234

if data[0] == 'data':

1458

2235

return data[1]

1459

2236

if data[0] == 'function':

2237

1460

2238

def func(*args, **kwargs):

1461

2239

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

1462

2240

return self._pipe.recv()[1]

2241

1463

2242

return func

1464

2243

1465

2244

def __setattr__(self, name, value):

1466

2245

if name == '_pipe':

1467

2246

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

1468

2247

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

1469

2248

1470

2249

1471

class ClientDBusTransitional(ClientDBus):

1472

__metaclass__ = AlternateDBusNamesMetaclass

1473

1474

1475

2250

class ClientHandler(socketserver.BaseRequestHandler, object):

1476

2251

"""A class to handle client connections.

1477

2252

1478

2253

Instantiated once for each connection to handle it.

1479

2254

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

1480

2255

1481

2256

def handle(self):

1482

2257

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

1483

2258

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

1484

unicode(self.client_address))

2259

str(self.client_address))

1485

2260

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

1486

2261

self.server.child_pipe.fileno())

1487

1488

session = (gnutls.connection

1489

.ClientSession(self.request,

1490

gnutls.connection

1491

.X509Credentials()))

1492

1493

# Note: gnutls.connection.X509Credentials is really a

1494

# generic GnuTLS certificate credentials object so long as

1495

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

1496

# here despite using OpenPGP certificates.

1497

1498

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

1499

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

1500

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

1501

# "+DHE-DSS"))

2262

2263

session = gnutls.ClientSession(self.request)

2264

2265

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

2266

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

2267

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

2268

# "+DHE-DSS"))

1502

2269

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

1503

2270

priority = self.server.gnutls_priority

1504

2271

if priority is None:

1505

2272

priority = "NORMAL"

1506

(gnutls.library.functions

1507

.gnutls_priority_set_direct(session._c_object,

1508

priority, None))

1509

2273

gnutls.priority_set_direct(session._c_object,

2274

priority.encode("utf-8"),

2275

None)

2276

1510

2277

# Start communication using the Mandos protocol

1511

2278

# Get protocol number

1512

2279

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

1513

2280

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

1514

2281

try:

1515

2282

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

1516

raise RuntimeError

2283

raise RuntimeError(line)

1517

2284

except (ValueError, IndexError, RuntimeError) as error:

1518

2285

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

1519

2286

return

1520

2287

1521

2288

# Start GnuTLS connection

1522

2289

try:

1523

2290

session.handshake()

1524

except gnutls.errors.GNUTLSError as error:

2291

except gnutls.Error as error:

1525

2292

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

1526

2293

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

1527

2294

# established. Just abandon the request.

1528

2295

return

1529

2296

logger.debug("Handshake succeeded")

1530

2297

1531

2298

approval_required = False

1532

2299

try:

1533

try:

1534

fpr = self.fingerprint(self.peer_certificate

1535

(session))

1536

except (TypeError,

1537

gnutls.errors.GNUTLSError) as error:

1538

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

1539

return

1540

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

1541

1542

try:

1543

client = ProxyClient(child_pipe, fpr,

2300

if gnutls.has_rawpk:

2301

fpr = ""

2302

try:

2303

key_id = self.key_id(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

else:

2311

key_id = ""

2312

try:

2313

fpr = self.fingerprint(

2314

self.peer_certificate(session))

2315

except (TypeError, gnutls.Error) as error:

2316

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

2317

return

2318

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

2319

2320

try:

2321

client = ProxyClient(child_pipe, key_id, fpr,

1544

2322

self.client_address)

1545

2323

except KeyError:

1546

2324

return

1547

2325

1548

2326

if client.approval_delay:

1549

2327

delay = client.approval_delay

1550

2328

client.approvals_pending += 1

1551

2329

approval_required = True

1552

2330

1553

2331

while True:

1554

2332

if not client.enabled:

1555

2333

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

1556

client.name)

2334

client.name)

1557

2335

if self.server.use_dbus:

1558

2336

# Emit D-Bus signal

1559

2337

client.Rejected("Disabled")

1560

2338

return

1561

2339

1562

2340

if client.approved or not client.approval_delay:

1563

#We are approved or approval is disabled

2341

# We are approved or approval is disabled

1564

2342

break

1565

2343

elif client.approved is None:

1566

2344

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

1568

2346

if self.server.use_dbus:

1569

2347

# Emit D-Bus signal

1570

2348

client.NeedApproval(

1571

client.approval_delay_milliseconds(),

1572

client.approved_by_default)

2349

client.approval_delay.total_seconds()

2350

* 1000, client.approved_by_default)

1573

2351

else:

1574

2352

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

1575

2353

client.name)

1577

2355

# Emit D-Bus signal

1578

2356

client.Rejected("Denied")

1579

2357

return

1580

1581

#wait until timeout or approved

2358

2359

# wait until timeout or approved

1582

2360

time = datetime.datetime.now()

1583

2361

client.changedstate.acquire()

1584

(client.changedstate.wait

1585

(float(client.timedelta_to_milliseconds(delay)

1586

/ 1000)))

2362

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

1587

2363

client.changedstate.release()

1588

2364

time2 = datetime.datetime.now()

1589

2365

if (time2 - time) >= delay:

1599

2375

break

1600

2376

else:

1601

2377

delay -= time2 - time

1602

1603

sent_size = 0

1604

while sent_size < len(client.secret):

1605

try:

1606

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

1607

except gnutls.errors.GNUTLSError as error:

1608

logger.warning("gnutls send failed")

1609

return

1610

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

1611

sent, len(client.secret)

1612

- (sent_size + sent))

1613

sent_size += sent

1614

2378

2379

try:

2380

session.send(client.secret)

2381

except gnutls.Error as error:

2382

logger.warning("gnutls send failed",

2383

exc_info=error)

2384

return

2385

1615

2386

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

1616

2387

# bump the timeout using extended_timeout

1617

2388

client.bump_timeout(client.extended_timeout)

1618

2389

if self.server.use_dbus:

1619

2390

# Emit D-Bus signal

1620

2391

client.GotSecret()

1621

2392

1622

2393

finally:

1623

2394

if approval_required:

1624

2395

client.approvals_pending -= 1

1625

2396

try:

1626

2397

session.bye()

1627

except gnutls.errors.GNUTLSError as error:

1628

logger.warning("GnuTLS bye failed")

1629

2398

except gnutls.Error as error:

2399

logger.warning("GnuTLS bye failed",

2400

exc_info=error)

2401

1630

2402

@staticmethod

1631

2403

def peer_certificate(session):

1632

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

1633

# If not an OpenPGP certificate...

1634

if (gnutls.library.functions

1635

.gnutls_certificate_type_get(session._c_object)

1636

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1637

# ...do the normal thing

1638

return session.peer_certificate

2404

"Return the peer's certificate as a bytestring"

2405

try:

2406

cert_type = gnutls.certificate_type_get2(session._c_object,

2407

gnutls.CTYPE_PEERS)

2408

except AttributeError:

2409

cert_type = gnutls.certificate_type_get(session._c_object)

2410

if gnutls.has_rawpk:

2411

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2412

else:

2413

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2414

# If not a valid certificate type...

2415

if cert_type not in valid_cert_types:

2416

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

2417

valid_cert_types)

2418

# ...return invalid data

2419

return b""

1639

2420

list_size = ctypes.c_uint(1)

1640

cert_list = (gnutls.library.functions

1641

.gnutls_certificate_get_peers

2421

cert_list = (gnutls.certificate_get_peers

1642

2422

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

1643

2423

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

1644

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

1645

" certificate")

2424

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

1646

2425

if list_size.value == 0:

1647

2426

return None

1648

2427

cert = cert_list[0]

1649

2428

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

1650

2429

2430

@staticmethod

2431

def key_id(certificate):

2432

"Convert a certificate bytestring to a hexdigit key ID"

2433

# New GnuTLS "datum" with the public key

2434

datum = gnutls.datum_t(

2435

ctypes.cast(ctypes.c_char_p(certificate),

2436

ctypes.POINTER(ctypes.c_ubyte)),

2437

ctypes.c_uint(len(certificate)))

2438

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

2439

# New empty GnuTLS certificate

2440

pubkey = gnutls.pubkey_t()

2441

gnutls.pubkey_init(ctypes.byref(pubkey))

2442

# Import the raw public key into the certificate

2443

gnutls.pubkey_import(pubkey,

2444

ctypes.byref(datum),

2445

gnutls.X509_FMT_DER)

2446

# New buffer for the key ID

2447

buf = ctypes.create_string_buffer(32)

2448

buf_len = ctypes.c_size_t(len(buf))

2449

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

2450

gnutls.pubkey_get_key_id(pubkey,

2451

gnutls.KEYID_USE_SHA256,

2452

ctypes.cast(ctypes.byref(buf),

2453

ctypes.POINTER(ctypes.c_ubyte)),

2454

ctypes.byref(buf_len))

2455

# Deinit the certificate

2456

gnutls.pubkey_deinit(pubkey)

2457

2458

# Convert the buffer to a Python bytestring

2459

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

2460

# Convert the bytestring to hexadecimal notation

2461

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

2462

return hex_key_id

2463

1651

2464

@staticmethod

1652

2465

def fingerprint(openpgp):

1653

2466

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1654

2467

# New GnuTLS "datum" with the OpenPGP public key

1655

datum = (gnutls.library.types

1656

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

1657

ctypes.POINTER

1658

(ctypes.c_ubyte)),

1659

ctypes.c_uint(len(openpgp))))

2468

datum = gnutls.datum_t(

2469

ctypes.cast(ctypes.c_char_p(openpgp),

2470

ctypes.POINTER(ctypes.c_ubyte)),

2471

ctypes.c_uint(len(openpgp)))

1660

2472

# New empty GnuTLS certificate

1661

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2473

crt = gnutls.openpgp_crt_t()

2474

gnutls.openpgp_crt_init(ctypes.byref(crt))

1664

2475

# Import the OpenPGP public key into the certificate

1665

(gnutls.library.functions

1666

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

1667

gnutls.library.constants

1668

.GNUTLS_OPENPGP_FMT_RAW))

2476

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

2477

gnutls.OPENPGP_FMT_RAW)

1669

2478

# Verify the self signature in the key

1670

2479

crtverify = ctypes.c_uint()

1671

(gnutls.library.functions

1672

.gnutls_openpgp_crt_verify_self(crt, 0,

1673

ctypes.byref(crtverify)))

2480

gnutls.openpgp_crt_verify_self(crt, 0,

2481

ctypes.byref(crtverify))

1674

2482

if crtverify.value != 0:

1675

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1676

raise (gnutls.errors.CertificateSecurityError

1677

("Verify failed"))

2483

gnutls.openpgp_crt_deinit(crt)

2484

raise gnutls.CertificateSecurityError(code

2485

=crtverify.value)

1678

2486

# New buffer for the fingerprint

1679

2487

buf = ctypes.create_string_buffer(20)

1680

2488

buf_len = ctypes.c_size_t()

1681

2489

# Get the fingerprint from the certificate into the buffer

1682

(gnutls.library.functions

1683

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

1684

ctypes.byref(buf_len)))

2490

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

2491

ctypes.byref(buf_len))

1685

2492

# Deinit the certificate

1686

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2493

gnutls.openpgp_crt_deinit(crt)

1687

2494

# Convert the buffer to a Python bytestring

1688

2495

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

1689

2496

# Convert the bytestring to hexadecimal notation

1693

2500

1694

2501

class MultiprocessingMixIn(object):

1695

2502

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

2503

1696

2504

def sub_process_main(self, request, address):

1697

2505

try:

1698

2506

self.finish_request(request, address)

1699

2507

except Exception:

1700

2508

self.handle_error(request, address)

1701

2509

self.close_request(request)

1702

2510

1703

2511

def process_request(self, request, address):

1704

2512

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

1705

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

1706

args = (request,

1707

address))

2513

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

2514

args=(request, address))

1708

2515

proc.start()

1709

2516

return proc

1710

2517

1711

2518

1712

2519

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1713

2520

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

2521

1714

2522

def process_request(self, request, client_address):

1715

2523

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

1716

2524

1717

2525

This function creates a new pipe in self.pipe

1718

2526

"""

1719

2527

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1720

2528

1721

2529

proc = MultiprocessingMixIn.process_request(self, request,

1722

2530

client_address)

1723

2531

self.child_pipe.close()

1724

2532

self.add_pipe(parent_pipe, proc)

1725

2533

1726

2534

def add_pipe(self, parent_pipe, proc):

1727

2535

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

1728

raise NotImplementedError

2536

raise NotImplementedError()

1729

2537

1730

2538

1731

2539

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1732

2540

socketserver.TCPServer, object):

1733

2541

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

1734

2542

1735

2543

Attributes:

1736

2544

enabled: Boolean; whether this server is activated yet

1737

2545

interface: None or a network interface name (string)

1738

2546

use_ipv6: Boolean; to use IPv6 or not

1739

2547

"""

2548

1740

2549

def __init__(self, server_address, RequestHandlerClass,

1741

interface=None, use_ipv6=True):

2550

interface=None,

2551

use_ipv6=True,

2552

socketfd=None):

2553

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

2554

creating a new one with socket.socket().

2555

"""

1742

2556

self.interface = interface

1743

2557

if use_ipv6:

1744

2558

self.address_family = socket.AF_INET6

2559

if socketfd is not None:

2560

# Save the file descriptor

2561

self.socketfd = socketfd

2562

# Save the original socket.socket() function

2563

self.socket_socket = socket.socket

2564

2565

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

2566

#

2567

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

2568

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

2569

# patching socket.socket.)

2570

#

2571

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

2572

@functools.wraps(socket.socket)

2573

def socket_wrapper(*args, **kwargs):

2574

# Restore original function so subsequent calls are

2575

# not affected.

2576

socket.socket = self.socket_socket

2577

del self.socket_socket

2578

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

2579

# saved file descriptor.

2580

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

2581

# Replace socket.socket() function with wrapper

2582

socket.socket = socket_wrapper

2583

# The socketserver.TCPServer.__init__ will call

2584

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

2585

# socket_wrapper(), if socketfd was set.

1745

2586

socketserver.TCPServer.__init__(self, server_address,

1746

2587

RequestHandlerClass)

2588

1747

2589

def server_bind(self):

1748

2590

"""This overrides the normal server_bind() function

1749

2591

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

1750

2592

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

2593

global SO_BINDTODEVICE

1751

2594

if self.interface is not None:

1752

2595

if SO_BINDTODEVICE is None:

1753

logger.error("SO_BINDTODEVICE does not exist;"

1754

" cannot bind to interface %s",

1755

self.interface)

1756

else:

1757

try:

1758

self.socket.setsockopt(socket.SOL_SOCKET,

1759

SO_BINDTODEVICE,

1760

str(self.interface

1761

+ '\0'))

1762

except socket.error as error:

1763

if error[0] == errno.EPERM:

1764

logger.error("No permission to"

1765

" bind to interface %s",

1766

self.interface)

1767

elif error[0] == errno.ENOPROTOOPT:

1768

logger.error("SO_BINDTODEVICE not available;"

1769

" cannot bind to interface %s",

1770

self.interface)

1771

else:

1772

raise

2596

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

2597

# common enough.

2598

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

2599

SO_BINDTODEVICE = 25

2600

try:

2601

self.socket.setsockopt(

2602

socket.SOL_SOCKET, SO_BINDTODEVICE,

2603

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

2604

except socket.error as error:

2605

if error.errno == errno.EPERM:

2606

logger.error("No permission to bind to"

2607

" interface %s", self.interface)

2608

elif error.errno == errno.ENOPROTOOPT:

2609

logger.error("SO_BINDTODEVICE not available;"

2610

" cannot bind to interface %s",

2611

self.interface)

2612

elif error.errno == errno.ENODEV:

2613

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

2614

" cannot bind", self.interface)

2615

else:

2616

raise

1773

2617

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

1774

2618

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

1775

2619

if not self.server_address[0]:

1776

2620

if self.address_family == socket.AF_INET6:

1777

any_address = "::" # in6addr_any

2621

any_address = "::" # in6addr_any

1778

2622

else:

1779

any_address = socket.INADDR_ANY

2623

any_address = "0.0.0.0" # INADDR_ANY

1780

2624

self.server_address = (any_address,

1781

2625

self.server_address[1])

1782

2626

elif not self.server_address[1]:

1783

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

1784

0)

2627

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

1785

2628

# if self.interface:

1786

2629

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

1787

2630

# 0, # port

1793

2636

1794

2637

class MandosServer(IPv6_TCPServer):

1795

2638

"""Mandos server.

1796

2639

1797

2640

Attributes:

1798

2641

clients: set of Client objects

1799

2642

gnutls_priority GnuTLS priority string

1800

2643

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

1801

1802

Assumes a gobject.MainLoop event loop.

2644

2645

Assumes a GLib.MainLoop event loop.

1803

2646

"""

2647

1804

2648

def __init__(self, server_address, RequestHandlerClass,

1805

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

1806

gnutls_priority=None, use_dbus=True):

2649

interface=None,

2650

use_ipv6=True,

2651

clients=None,

2652

gnutls_priority=None,

2653

use_dbus=True,

2654

socketfd=None):

1807

2655

self.enabled = False

1808

2656

self.clients = clients

1809

2657

if self.clients is None:

1812

2660

self.gnutls_priority = gnutls_priority

1813

2661

IPv6_TCPServer.__init__(self, server_address,

1814

2662

RequestHandlerClass,

1815

interface = interface,

1816

use_ipv6 = use_ipv6)

2663

interface=interface,

2664

use_ipv6=use_ipv6,

2665

socketfd=socketfd)

2666

1817

2667

def server_activate(self):

1818

2668

if self.enabled:

1819

2669

return socketserver.TCPServer.server_activate(self)

1820

2670

1821

2671

def enable(self):

1822

2672

self.enabled = True

1823

2673

1824

2674

def add_pipe(self, parent_pipe, proc):

1825

2675

# Call "handle_ipc" for both data and EOF events

1826

gobject.io_add_watch(parent_pipe.fileno(),

1827

gobject.IO_IN | gobject.IO_HUP,

1828

functools.partial(self.handle_ipc,

1829

parent_pipe =

1830

parent_pipe,

1831

proc = proc))

1832

1833

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

1834

proc = None, client_object=None):

1835

condition_names = {

1836

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

1837

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

1838

# blocking).

1839

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

1840

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

1841

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

1842

# broken, usually for pipes and

1843

# sockets).

1844

}

1845

conditions_string = ' | '.join(name

1846

for cond, name in

1847

condition_names.iteritems()

1848

if cond & condition)

2676

GLib.io_add_watch(

2677

parent_pipe.fileno(),

2678

GLib.IO_IN | GLib.IO_HUP,

2679

functools.partial(self.handle_ipc,

2680

parent_pipe=parent_pipe,

2681

proc=proc))

2682

2683

def handle_ipc(self, source, condition,

2684

parent_pipe=None,

2685

proc=None,

2686

client_object=None):

1849

2687

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

1850

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

2688

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

1851

2689

# Wait for other process to exit

1852

2690

proc.join()

1853

2691

return False

1854

2692

1855

2693

# Read a request from the child

1856

2694

request = parent_pipe.recv()

1857

2695

command = request[0]

1858

2696

1859

2697

if command == 'init':

1860

fpr = request[1]

1861

address = request[2]

1862

1863

for c in self.clients.itervalues():

1864

if c.fingerprint == fpr:

2698

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

2699

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

2700

address = request[3]

2701

2702

for c in self.clients.values():

2703

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2704

continue

2705

if key_id and c.key_id == key_id:

2706

client = c

2707

break

2708

if fpr and c.fingerprint == fpr:

1865

2709

client = c

1866

2710

break

1867

2711

else:

1868

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

1869

"dress: %s", fpr, address)

2712

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

2713

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

1870

2714

if self.use_dbus:

1871

2715

# Emit D-Bus signal

1872

mandos_dbus_service.ClientNotFound(fpr,

2716

mandos_dbus_service.ClientNotFound(key_id or fpr,

1873

2717

address[0])

1874

2718

parent_pipe.send(False)

1875

2719

return False

1876

1877

gobject.io_add_watch(parent_pipe.fileno(),

1878

gobject.IO_IN | gobject.IO_HUP,

1879

functools.partial(self.handle_ipc,

1880

parent_pipe =

1881

parent_pipe,

1882

proc = proc,

1883

client_object =

1884

client))

2720

2721

GLib.io_add_watch(

2722

parent_pipe.fileno(),

2723

GLib.IO_IN | GLib.IO_HUP,

2724

functools.partial(self.handle_ipc,

2725

parent_pipe=parent_pipe,

2726

proc=proc,

2727

client_object=client))

1885

2728

parent_pipe.send(True)

1886

2729

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

1887

2730

# same fileno

1890

2733

funcname = request[1]

1891

2734

args = request[2]

1892

2735

kwargs = request[3]

1893

2736

1894

2737

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

1895

2738

funcname)(*args,

1896

**kwargs)))

1897

2739

**kwargs)))

2740

1898

2741

if command == 'getattr':

1899

2742

attrname = request[1]

1900

if callable(client_object.__getattribute__(attrname)):

1901

parent_pipe.send(('function',))

2743

if isinstance(client_object.__getattribute__(attrname),

2744

collections.Callable):

2745

parent_pipe.send(('function', ))

1902

2746

else:

1903

parent_pipe.send(('data', client_object

1904

.__getattribute__(attrname)))

1905

2747

parent_pipe.send((

2748

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

2749

1906

2750

if command == 'setattr':

1907

2751

attrname = request[1]

1908

2752

value = request[2]

1909

2753

setattr(client_object, attrname, value)

1910

2754

1911

2755

return True

1912

2756

1913

2757

2758

def rfc3339_duration_to_delta(duration):

2759

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

2760

2761

>>> rfc3339_duration_to_delta("P7D")

2762

datetime.timedelta(7)

2763

>>> rfc3339_duration_to_delta("PT60S")

2764

datetime.timedelta(0, 60)

2765

>>> rfc3339_duration_to_delta("PT60M")

2766

datetime.timedelta(0, 3600)

2767

>>> rfc3339_duration_to_delta("PT24H")

2768

datetime.timedelta(1)

2769

>>> rfc3339_duration_to_delta("P1W")

2770

datetime.timedelta(7)

2771

>>> rfc3339_duration_to_delta("PT5M30S")

2772

datetime.timedelta(0, 330)

2773

>>> rfc3339_duration_to_delta("P1DT3M20S")

2774

datetime.timedelta(1, 200)

2775

"""

2776

2777

# Parsing an RFC 3339 duration with regular expressions is not

2778

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

2779

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

2780

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

2781

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

2782

# avoid excessive use of external libraries.

2783

2784

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

2785

Token = collections.namedtuple("Token", (

2786

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

2787

# a "group" containing digits

2788

"value", # datetime.timedelta or None

2789

"followers")) # Tokens valid after this token

2790

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

2791

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

2792

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

2793

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

2794

datetime.timedelta(seconds=1),

2795

frozenset((token_end, )))

2796

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

2797

datetime.timedelta(minutes=1),

2798

frozenset((token_second, token_end)))

2799

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

2800

datetime.timedelta(hours=1),

2801

frozenset((token_minute, token_end)))

2802

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

2803

None,

2804

frozenset((token_hour, token_minute,

2805

token_second)))

2806

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

2807

datetime.timedelta(days=1),

2808

frozenset((token_time, token_end)))

2809

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

2810

datetime.timedelta(weeks=4),

2811

frozenset((token_day, token_end)))

2812

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

2813

datetime.timedelta(weeks=52),

2814

frozenset((token_month, token_end)))

2815

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

2816

datetime.timedelta(weeks=1),

2817

frozenset((token_end, )))

2818

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

2819

frozenset((token_year, token_month,

2820

token_day, token_time,

2821

token_week)))

2822

# Define starting values:

2823

# Value so far

2824

value = datetime.timedelta()

2825

found_token = None

2826

# Following valid tokens

2827

followers = frozenset((token_duration, ))

2828

# String left to parse

2829

s = duration

2830

# Loop until end token is found

2831

while found_token is not token_end:

2832

# Search for any currently valid tokens

2833

for token in followers:

2834

match = token.regexp.match(s)

2835

if match is not None:

2836

# Token found

2837

if token.value is not None:

2838

# Value found, parse digits

2839

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

2840

# Add to value so far

2841

value += factor * token.value

2842

# Strip token from string

2843

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

2844

# Go to found token

2845

found_token = token

2846

# Set valid next tokens

2847

followers = found_token.followers

2848

break

2849

else:

2850

# No currently valid tokens were found

2851

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

2852

.format(duration))

2853

# End token found

2854

return value

2855

2856

1914

2857

def string_to_delta(interval):

1915

2858

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

1916

2859

1917

2860

>>> string_to_delta('7d')

1918

2861

datetime.timedelta(7)

1919

2862

>>> string_to_delta('60s')

1927

2870

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

1928

2871

datetime.timedelta(0, 330)

1929

2872

"""

2873

2874

try:

2875

return rfc3339_duration_to_delta(interval)

2876

except ValueError:

2877

pass

2878

1930

2879

timevalue = datetime.timedelta(0)

1931

2880

for s in interval.split():

1932

2881

try:

1933

suffix = unicode(s[-1])

2882

suffix = s[-1]

1934

2883

value = int(s[:-1])

1935

2884

if suffix == "d":

1936

2885

delta = datetime.timedelta(value)

1943

2892

elif suffix == "w":

1944

2893

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

1945

2894

else:

1946

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

1947

except (ValueError, IndexError) as e:

2895

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

2896

except IndexError as e:

1948

2897

raise ValueError(*(e.args))

1949

2898

timevalue += delta

1950

2899

return timevalue

1951

2900

1952

2901

1953

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

2902

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

1954

2903

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

1955

2904

1956

2905

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

1957

2906

if os.fork():

1958

2907

sys.exit()

1963

2912

sys.exit()

1964

2913

if not noclose:

1965

2914

# Close all standard open file descriptors

1966

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

2915

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

1967

2916

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

1968

2917

raise OSError(errno.ENODEV,

1969

"%s not a character device"

1970

% os.path.devnull)

2918

"{} not a character device"

2919

.format(os.devnull))

1971

2920

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

1972

2921

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

1973

2922

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

1976

2925

1977

2926

1978

2927

def main():

1979

2928

1980

2929

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

1981

2930

# Parsing of options, both command line and config file

1982

2931

1983

2932

parser = argparse.ArgumentParser()

1984

2933

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

1985

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

2934

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

1986

2935

help="show version number and exit")

1987

2936

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

1988

2937

help="Bind to interface IF")

1994

2943

help="Run self-test")

1995

2944

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

1996

2945

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

1997

" to terminal")

2946

" to terminal", default=None)

1998

2947

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

1999

2948

help="Debug level for stdout output")

2000

2949

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

2007

2956

" files")

2008

2957

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

2009

2958

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

2010

" system bus interface")

2959

" system bus interface", default=None)

2011

2960

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

2012

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

2961

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

2962

default=None)

2013

2963

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

2014

2964

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

2015

" state")

2965

" state", default=None)

2966

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

2967

help="Specify a file descriptor to a network"

2968

" socket to use instead of creating one")

2016

2969

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

2017

2970

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

2018

2971

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

2972

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

2973

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

2974

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

2975

default=None)

2976

2019

2977

options = parser.parse_args()

2020

2978

2021

2979

if options.check:

2022

2980

import doctest

2023

doctest.testmod()

2024

sys.exit()

2025

2981

fail_count, test_count = doctest.testmod()

2982

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

2983

2026

2984

# Default values for config file for server-global settings

2027

server_defaults = { "interface": "",

2028

"address": "",

2029

"port": "",

2030

"debug": "False",

2031

"priority":

2032

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

2033

"servicename": "Mandos",

2034

"use_dbus": "True",

2035

"use_ipv6": "True",

2036

"debuglevel": "",

2037

"restore": "True",

2038

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

2039

}

2040

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2041

3008

# Parse config file for server-global settings

2042

3009

server_config = configparser.SafeConfigParser(server_defaults)

2043

3010

del server_defaults

2044

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

2045

"mandos.conf"))

3011

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

2046

3012

# Convert the SafeConfigParser object to a dict

2047

3013

server_settings = server_config.defaults()

2048

3014

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

2049

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

3015

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

3016

"foreground", "zeroconf"):

2050

3017

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

2051

3018

option)

2052

3019

if server_settings["port"]:

2053

3020

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

2054

3021

"port")

3022

if server_settings["socket"]:

3023

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

3024

"socket")

3025

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

3026

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

3027

# happen with a supplied network socket.

3028

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

3029

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

3030

["socket"])

2055

3031

del server_config

2056

3032

2057

3033

# Override the settings from the config file with command line

2058

3034

# options, if set.

2059

3035

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

2060

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

2061

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

2062

"statedir"):

3036

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

3037

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

3038

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

2063

3039

value = getattr(options, option)

2064

3040

if value is not None:

2065

3041

server_settings[option] = value

2066

3042

del options

2067

3043

# Force all strings to be unicode

2068

3044

for option in server_settings.keys():

2069

if type(server_settings[option]) is str:

2070

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

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

3048

# Force all boolean options to be boolean

3049

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

3050

"foreground", "zeroconf"):

3051

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

3052

# Debug implies foreground

3053

if server_settings["debug"]:

3054

server_settings["foreground"] = True

2071

3055

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

2072

3056

2073

3057

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

2074

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2075

3064

# For convenience

2076

3065

debug = server_settings["debug"]

2077

3066

debuglevel = server_settings["debuglevel"]

2079

3068

use_ipv6 = server_settings["use_ipv6"]

2080

3069

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

2081

3070

stored_state_file)

2082

3071

foreground = server_settings["foreground"]

3072

zeroconf = server_settings["zeroconf"]

3073

2083

3074

if debug:

2084

3075

initlogger(debug, logging.DEBUG)

2085

3076

else:

2088

3079

else:

2089

3080

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

2090

3081

initlogger(debug, level)

2091

3082

2092

3083

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

2093

syslogger.setFormatter(logging.Formatter

2094

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

2095

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

2096

% server_settings["servicename"]))

2097

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2098

3089

# Parse config file with clients

2099

3090

client_config = configparser.SafeConfigParser(Client

2100

3091

.client_defaults)

2101

3092

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

2102

3093

"clients.conf"))

2103

3094

2104

3095

global mandos_dbus_service

2105

3096

mandos_dbus_service = None

2106

2107

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

2108

server_settings["port"]),

2109

ClientHandler,

2110

interface=(server_settings["interface"]

2111

or None),

2112

use_ipv6=use_ipv6,

2113

gnutls_priority=

2114

server_settings["priority"],

2115

use_dbus=use_dbus)

2116

if not debug:

2117

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

2118

try:

2119

pidfile = open(pidfilename, "w")

2120

except IOError:

2121

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

2122

2123

try:

2124

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

2125

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

2126

except KeyError:

2127

try:

2128

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

2129

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

3097

3098

socketfd = None

3099

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

3100

socketfd = server_settings["socket"]

3101

tcp_server = MandosServer(

3102

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

3103

ClientHandler,

3104

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

3105

use_ipv6=use_ipv6,

3106

gnutls_priority=server_settings["priority"],

3107

use_dbus=use_dbus,

3108

socketfd=socketfd)

3109

if not foreground:

3110

pidfilename = "/run/mandos.pid"

3111

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

3112

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

3113

pidfile = None

3114

try:

3115

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

3116

except IOError as e:

3117

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

3118

exc_info=e)

3119

3120

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

3121

("mandos", "mandos"),

3122

("nobody", "nogroup")):

3123

try:

3124

uid = pwd.getpwnam(name).pw_uid

3125

gid = pwd.getpwnam(group).pw_gid

3126

break

2130

3127

except KeyError:

2131

try:

2132

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

2133

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

2134

except KeyError:

2135

uid = 65534

2136

gid = 65534

3128

continue

3129

else:

3130

uid = 65534

3131

gid = 65534

2137

3132

try:

2138

3133

os.setgid(gid)

2139

3134

os.setuid(uid)

3135

if debug:

3136

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

3137

gid))

2140

3138

except OSError as error:

2141

if error[0] != errno.EPERM:

2142

raise error

2143

3139

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

3140

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

3141

if error.errno != errno.EPERM:

3142

raise

3143

2144

3144

if debug:

2145

3145

# Enable all possible GnuTLS debugging

2146

3146

2147

3147

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

2148

3148

# - GnuTLS manual

2149

gnutls.library.functions.gnutls_global_set_log_level(11)

2150

2151

@gnutls.library.types.gnutls_log_func

3149

gnutls.global_set_log_level(11)

3150

3151

@gnutls.log_func

2152

3152

def debug_gnutls(level, string):

2153

3153

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

2154

2155

(gnutls.library.functions

2156

.gnutls_global_set_log_function(debug_gnutls))

2157

3154

3155

gnutls.global_set_log_function(debug_gnutls)

3156

2158

3157

# Redirect stdin so all checkers get /dev/null

2159

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

3158

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

2160

3159

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

2161

3160

if null > 2:

2162

3161

os.close(null)

2163

3162

2164

3163

# Need to fork before connecting to D-Bus

2165

if not debug:

3164

if not foreground:

2166

3165

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

2167

3166

daemon()

2168

2169

gobject.threads_init()

2170

3167

3168

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

3169

# to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2171

3172

global main_loop

2172

3173

# From the Avahi example code

2173

DBusGMainLoop(set_as_default=True )

2174

main_loop = gobject.MainLoop()

3174

DBusGMainLoop(set_as_default=True)

3175

main_loop = GLib.MainLoop()

2175

3176

bus = dbus.SystemBus()

2176

3177

# End of Avahi example code

2177

3178

if use_dbus:

2178

3179

try:

2179

3180

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

2180

bus, do_not_queue=True)

2181

old_bus_name = (dbus.service.BusName

2182

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

2183

do_not_queue=True))

2184

except dbus.exceptions.NameExistsException as e:

2185

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

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

3187

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

2186

3188

use_dbus = False

2187

3189

server_settings["use_dbus"] = False

2188

3190

tcp_server.use_dbus = False

2189

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2190

service = AvahiServiceToSyslog(name =

2191

server_settings["servicename"],

2192

servicetype = "_mandos._tcp",

2193

protocol = protocol, bus = bus)

2194

if server_settings["interface"]:

2195

service.interface = (if_nametoindex

2196

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

2197

3191

if zeroconf:

3192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

3198

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2198

3202

global multiprocessing_manager

2199

3203

multiprocessing_manager = multiprocessing.Manager()

2200

3204

2201

3205

client_class = Client

2202

3206

if use_dbus:

2203

client_class = functools.partial(ClientDBusTransitional,

2204

bus = bus)

2205

3207

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

3208

2206

3209

client_settings = Client.config_parser(client_config)

2207

3210

old_client_settings = {}

2208

3211

clients_data = {}

2209

3212

3213

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

3214

global wnull

3215

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

3216

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

3217

# mode

3218

if debug or not foreground:

3219

wnull.close()

3220

2210

3221

# Get client data and settings from last running state.

2211

3222

if server_settings["restore"]:

2212

3223

try:

2213

3224

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

2214

clients_data, old_client_settings = (pickle.load

2215

(stored_state))

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name & .host

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if not value.has_key("key_id"):

3257

value["key_id"] = ""

3258

elif not value.has_key("fingerprint"):

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host

3270

for value in old_client_settings.values():

3271

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

3272

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

3273

.decode("utf-8"))

2216

3274

os.remove(stored_state_path)

2217

3275

except IOError as e:

2218

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

2219

.format(e))

2220

if e.errno != errno.ENOENT:

3276

if e.errno == errno.ENOENT:

3277

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

3278

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

3279

else:

3280

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

3281

exc_info=e)

2221

3282

raise

2222

3283

except EOFError as e:

2223

3284

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

2224

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

2225

3285

"EOFError:",

3286

exc_info=e)

3287

2226

3288

with PGPEngine() as pgp:

2227

for client_name, client in clients_data.iteritems():

3289

for client_name, client in clients_data.items():

3290

# Skip removed clients

3291

if client_name not in client_settings:

3292

continue

3293

2228

3294

# Decide which value to use after restoring saved state.

2229

3295

# We have three different values: Old config file,

2230

3296

# new config file, and saved state.

2235

3301

# For each value in new config, check if it

2236

3302

# differs from the old config value (Except for

2237

3303

# the "secret" attribute)

2238

if (name != "secret" and

2239

value != old_client_settings[client_name]

2240

[name]):

3304

if (name != "secret"

3305

and (value !=

3306

old_client_settings[client_name][name])):

2241

3307

client[name] = value

2242

3308

except KeyError:

2243

3309

pass

2244

3310

2245

3311

# Clients who has passed its expire date can still be

2246

# enabled if its last checker was successful. Clients

3312

# enabled if its last checker was successful. A Client

2247

3313

# whose checker succeeded before we stored its state is

2248

3314

# assumed to have successfully run all checkers during

2249

3315

# downtime.

2251

3317

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

2252

3318

if not client["last_checked_ok"]:

2253

3319

logger.warning(

2254

"disabling client {0} - Client never "

2255

"performed a successful checker"

2256

.format(client_name))

3320

"disabling client {} - Client never "

3321

"performed a successful checker".format(

3322

client_name))

2257

3323

client["enabled"] = False

2258

3324

elif client["last_checker_status"] != 0:

2259

3325

logger.warning(

2260

"disabling client {0} - Client "

2261

"last checker failed with error code {1}"

2262

.format(client_name,

2263

client["last_checker_status"]))

3326

"disabling client {} - Client last"

3327

" checker failed with error code"

3328

" {}".format(

3329

client_name,

3330

client["last_checker_status"]))

2264

3331

client["enabled"] = False

2265

3332

else:

2266

client["expires"] = (datetime.datetime

2267

.utcnow()

2268

+ client["timeout"])

3333

client["expires"] = (

3334

datetime.datetime.utcnow()

3335

+ client["timeout"])

2269

3336

logger.debug("Last checker succeeded,"

2270

" keeping {0} enabled"

2271

.format(client_name))

3337

" keeping {} enabled".format(

3338

client_name))

2272

3339

try:

2273

client["secret"] = (

2274

pgp.decrypt(client["encrypted_secret"],

2275

client_settings[client_name]

2276

["secret"]))

3340

client["secret"] = pgp.decrypt(

3341

client["encrypted_secret"],

3342

client_settings[client_name]["secret"])

2277

3343

except PGPError:

2278

3344

# If decryption fails, we use secret from new settings

2279

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

2280

.format(client_name))

2281

client["secret"] = (

2282

client_settings[client_name]["secret"])

3345

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

3346

client_name))

3347

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

3348

["secret"])

2283

3349

2284

2285

3350

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

2286

3351

for client_name in (set(old_client_settings)

2287

3352

- set(client_settings)):

2291

3356

clients_data[client_name] = client_settings[client_name]

2292

3357

2293

3358

# Create all client objects

2294

for client_name, client in clients_data.iteritems():

3359

for client_name, client in clients_data.items():

2295

3360

tcp_server.clients[client_name] = client_class(

2296

name = client_name, settings = client)

2297

3361

name=client_name,

3362

settings=client,

3363

server_settings=server_settings)

3364

2298

3365

if not tcp_server.clients:

2299

3366

logger.warning("No clients defined")

2300

2301

if not debug:

2302

try:

2303

with pidfile:

2304

pid = os.getpid()

2305

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

2306

del pidfile

2307

except IOError:

2308

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

2309

pidfilename, pid)

2310

except NameError:

2311

# "pidfile" was never created

2312

pass

3367

3368

if not foreground:

3369

if pidfile is not None:

3370

pid = os.getpid()

3371

try:

3372

with pidfile:

3373

print(pid, file=pidfile)

3374

except IOError:

3375

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

3376

pidfilename, pid)

3377

del pidfile

2313

3378

del pidfilename

2314

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

2315

2316

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

2317

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

2318

3379

3380

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

3381

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3382

lambda: main_loop.quit() and False)

3383

2319

3384

if use_dbus:

2320

class MandosDBusService(dbus.service.Object):

3385

3386

@alternate_dbus_interfaces(

3387

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

3388

class MandosDBusService(DBusObjectWithObjectManager):

2321

3389

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

3390

2322

3391

def __init__(self):

2323

3392

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

3393

2324

3394

_interface = "se.recompile.Mandos"

2325

3395

2326

3396

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

2327

3397

def ClientAdded(self, objpath):

2328

3398

"D-Bus signal"

2329

3399

pass

2330

3400

2331

3401

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

2332

def ClientNotFound(self, fingerprint, address):

3402

def ClientNotFound(self, key_id, address):

2333

3403

"D-Bus signal"

2334

3404

pass

2335

3405

3406

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

3407

"true"})

2336

3408

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

2337

3409

def ClientRemoved(self, objpath, name):

2338

3410

"D-Bus signal"

2339

3411

pass

2340

3412

3413

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

3414

"true"})

2341

3415

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

2342

3416

def GetAllClients(self):

2343

3417

"D-Bus method"

2344

return dbus.Array(c.dbus_object_path

2345

for c in

2346

tcp_server.clients.itervalues())

2347

3418

return dbus.Array(c.dbus_object_path for c in

3419

tcp_server.clients.values())

3420

3421

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

3422

"true"})

2348

3423

@dbus.service.method(_interface,

2349

3424

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

2350

3425

def GetAllClientsWithProperties(self):

2351

3426

"D-Bus method"

2352

3427

return dbus.Dictionary(

2353

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

2354

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

3428

{c.dbus_object_path: c.GetAll(

3429

"se.recompile.Mandos.Client")

3430

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

2355

3431

signature="oa{sv}")

2356

3432

2357

3433

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

2358

3434

def RemoveClient(self, object_path):

2359

3435

"D-Bus method"

2360

for c in tcp_server.clients.itervalues():

3436

for c in tcp_server.clients.values():

2361

3437

if c.dbus_object_path == object_path:

2362

3438

del tcp_server.clients[c.name]

2363

3439

c.remove_from_connection()

2364

# Don't signal anything except ClientRemoved

3440

# Don't signal the disabling

2365

3441

c.disable(quiet=True)

2366

# Emit D-Bus signal

2367

self.ClientRemoved(object_path, c.name)

3442

# Emit D-Bus signal for removal

3443

self.client_removed_signal(c)

2368

3444

return

2369

3445

raise KeyError(object_path)

2370

3446

2371

3447

del _interface

2372

2373

class MandosDBusServiceTransitional(MandosDBusService):

2374

__metaclass__ = AlternateDBusNamesMetaclass

2375

mandos_dbus_service = MandosDBusServiceTransitional()

2376

3448

3449

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3450

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

3451

def GetManagedObjects(self):

3452

"""D-Bus method"""

3453

return dbus.Dictionary(

3454

{client.dbus_object_path:

3455

dbus.Dictionary(

3456

{interface: client.GetAll(interface)

3457

for interface in

3458

client._get_all_interface_names()})

3459

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

3460

3461

def client_added_signal(self, client):

3462

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

3463

if use_dbus:

3464

# New standard signal

3465

self.InterfacesAdded(

3466

client.dbus_object_path,

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()}))

3471

# Old signal

3472

self.ClientAdded(client.dbus_object_path)

3473

3474

def client_removed_signal(self, client):

3475

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

3476

if use_dbus:

3477

# New standard signal

3478

self.InterfacesRemoved(

3479

client.dbus_object_path,

3480

client._get_all_interface_names())

3481

# Old signal

3482

self.ClientRemoved(client.dbus_object_path,

3483

client.name)

3484

3485

mandos_dbus_service = MandosDBusService()

3486

3487

# Save modules to variables to exempt the modules from being

3488

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

3489

mp = multiprocessing

3490

wn = wnull

3491

2377

3492

def cleanup():

2378

3493

"Cleanup function; run on exit"

2379

service.cleanup()

2380

2381

multiprocessing.active_children()

3494

if zeroconf:

3495

service.cleanup()

3496

3497

mp.active_children()

3498

wn.close()

2382

3499

if not (tcp_server.clients or client_settings):

2383

3500

return

2384

3501

2385

3502

# Store client before exiting. Secrets are encrypted with key

2386

3503

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

2387

3504

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

2388

3505

clients = {}

2389

3506

with PGPEngine() as pgp:

2390

for client in tcp_server.clients.itervalues():

3507

for client in tcp_server.clients.values():

2391

3508

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

2392

3509

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

2393

3510

key)

2394

3511

client_dict = {}

2395

3512

2396

3513

# A list of attributes that can not be pickled

2397

3514

# + secret.

2398

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

2399

"checker"))

2400

for name, typ in (inspect.getmembers

2401

(dbus.service.Object)):

3515

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

3516

"checker", "server_settings"}

3517

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

3518

.Object):

2402

3519

exclude.add(name)

2403

3520

2404

3521

client_dict["encrypted_secret"] = (client

2405

3522

.encrypted_secret)

2406

3523

for attr in client.client_structure:

2407

3524

if attr not in exclude:

2408

3525

client_dict[attr] = getattr(client, attr)

2409

3526

2410

3527

clients[client.name] = client_dict

2411

3528

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

2412

3529

2413

3530

try:

2414

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

2415

prefix="clients-",

2416

dir=os.path.dirname

2417

(stored_state_path))

2418

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

2419

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

3531

with tempfile.NamedTemporaryFile(

3532

mode='wb',

3533

suffix=".pickle",

3534

prefix='clients-',

3535

dir=os.path.dirname(stored_state_path),

3536

delete=False) as stored_state:

3537

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

3538

protocol=2)

3539

tempname = stored_state.name

2420

3540

os.rename(tempname, stored_state_path)

2421

3541

except (IOError, OSError) as e:

2422

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

2423

.format(e))

2424

3542

if not debug:

2425

3543

try:

2426

3544

os.remove(tempname)

2427

3545

except NameError:

2428

3546

pass

2429

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

2430

errno.EEXIST)):

2431

raise e

2432

3547

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

3548

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

3549

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

3550

else:

3551

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

3552

exc_info=e)

3553

raise

3554

2433

3555

# Delete all clients, and settings from config

2434

3556

while tcp_server.clients:

2435

3557

name, client = tcp_server.clients.popitem()

2436

3558

if use_dbus:

2437

3559

client.remove_from_connection()

2438

# Don't signal anything except ClientRemoved

3560

# Don't signal the disabling

2439

3561

client.disable(quiet=True)

3562

# Emit D-Bus signal for removal

2440

3563

if use_dbus:

2441

# Emit D-Bus signal

2442

mandos_dbus_service.ClientRemoved(client

2443

.dbus_object_path,

2444

client.name)

3564

mandos_dbus_service.client_removed_signal(client)

2445

3565

client_settings.clear()

2446

3566

2447

3567

atexit.register(cleanup)

2448

2449

for client in tcp_server.clients.itervalues():

3568

3569

for client in tcp_server.clients.values():

2450

3570

if use_dbus:

2451

# Emit D-Bus signal

2452

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3571

# Emit D-Bus signal for adding

3572

mandos_dbus_service.client_added_signal(client)

2453

3573

# Need to initiate checking of clients

2454

3574

if client.enabled:

2455

3575

client.init_checker()

2456

3576

2457

3577

tcp_server.enable()

2458

3578

tcp_server.server_activate()

2459

3579

2460

3580

# Find out what port we got

2461

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

3581

if zeroconf:

3582

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

2462

3583

if use_ipv6:

2463

3584

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

2464

" flowinfo %d, scope_id %d"

2465

% tcp_server.socket.getsockname())

3585

" flowinfo %d, scope_id %d",

3586

*tcp_server.socket.getsockname())

2466

3587

else: # IPv4

2467

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

2468

% tcp_server.socket.getsockname())

2469

2470

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

2471

3588

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

3589

*tcp_server.socket.getsockname())

3590

3591

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

3592

2472

3593

try:

2473

# From the Avahi example code

2474

try:

2475

service.activate()

2476

except dbus.exceptions.DBusException as error:

2477

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

2478

cleanup()

2479

sys.exit(1)

2480

# End of Avahi example code

2481

2482

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

2483

lambda *args, **kwargs:

2484

(tcp_server.handle_request

2485

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

2486

3594

if zeroconf:

3595

# From the Avahi example code

3596

try:

3597

service.activate()

3598

except dbus.exceptions.DBusException as error:

3599

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

3600

cleanup()

3601

sys.exit(1)

3602

# End of Avahi example code

3603

3604

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

3605

lambda *args, **kwargs:

3606

(tcp_server.handle_request

3607

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

3608

2487

3609

logger.debug("Starting main loop")

2488

3610

main_loop.run()

2489

3611

except AvahiError as error:

2490

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

3612

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

2491

3613

cleanup()

2492

3614

sys.exit(1)

2493

3615

except KeyboardInterrupt:

2498

3620

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

2499

3621

cleanup()

2500

3622

3623

2501

3624

if __name__ == '__main__':

2502

3625

main()