/mandos/release : revision 295

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

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

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

37

import SocketServer as socketserver

47

38

import socket

48

39

import argparse

49

40

import datetime

50

41

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

55

49

import sys

56

50

import re

57

51

import os

66

60

import struct

67

61

import fcntl

68

62

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

63

import cPickle as pickle

73

64

import multiprocessing

74

65

import types

75

66

import binascii

76

67

import tempfile

77

import itertools

78

import collections

79

import codecs

80

68

81

69

import dbus

82

70

import dbus.service

83

from gi.repository import GLib

71

import gobject

72

import avahi

84

73

from dbus.mainloop.glib import DBusGMainLoop

85

74

import ctypes

86

75

import ctypes.util

87

76

import xml.dom.minidom

88

77

import inspect

78

import GnuPGInterface

89

79

90

# Try to find the value of SO_BINDTODEVICE:

91

80

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:

94

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

82

except AttributeError:

96

83

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

84

from IN import SO_BINDTODEVICE

100

85

except ImportError:

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

86

SO_BINDTODEVICE = None

87

88

version = "1.5.2"

119

89

stored_state_file = "clients.pickle"

120

90

121

91

logger = logging.getLogger()

122

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

123

95

124

96

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

127

100

except (OSError, AttributeError):

128

129

101

def if_nametoindex(interface):

130

102

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

131

103

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

132

104

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

133

105

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

136

110

return interface_index

137

111

138

112

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

155

113

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

156

114

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

115

162

116

syslogger.setFormatter(logging.Formatter

163

117

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

164

118

' %(message)s'))

165

119

logger.addHandler(syslogger)

166

120

167

121

if debug:

168

122

console = logging.StreamHandler()

169

123

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

181

135

182

136

class PGPEngine(object):

183

137

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

184

185

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

186

140

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

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

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

206

148

def __enter__(self):

207

149

return self

208

209

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

150

151

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

210

152

self._cleanup()

211

153

return False

212

154

213

155

def __del__(self):

214

156

self._cleanup()

215

157

216

158

def _cleanup(self):

217

159

if self.tempdir is not None:

218

160

# Delete contents of tempdir

219

161

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

220

topdown=False):

162

topdown = False):

221

163

for filename in files:

222

164

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

223

165

for dirname in dirs:

225

167

# Remove tempdir

226

168

os.rmdir(self.tempdir)

227

169

self.tempdir = None

228

170

229

171

def password_encode(self, password):

230

172

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

231

173

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

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

174

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

175

240

176

def encrypt(self, data, password):

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)

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

256

191

return ciphertext

257

192

258

193

def decrypt(self, data, password):

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)

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

274

208

return decrypted_plaintext

275

209

276

210

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

211

303

212

class AvahiError(Exception):

304

213

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

305

214

self.value = value

306

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

307

**kwargs)

308

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

309

218

310

219

class AvahiServiceError(AvahiError):

311

220

pass

312

221

313

314

222

class AvahiGroupError(AvahiError):

315

223

pass

316

224

317

225

318

226

class AvahiService(object):

319

227

"""An Avahi (Zeroconf) service.

320

228

321

229

Attributes:

322

230

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

323

231

Used to optionally bind to the specified interface.

324

232

name: string; Example: 'Mandos'

325

233

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

326

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

234

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

327

235

port: integer; what port to announce

328

236

TXT: list of strings; TXT record for the service

329

237

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

335

243

server: D-Bus Server

336

244

bus: dbus.SystemBus()

337

245

"""

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

350

250

self.interface = interface

351

251

self.name = name

352

252

self.type = servicetype

361

261

self.server = None

362

262

self.bus = bus

363

263

self.entry_group_state_changed_match = None

364

365

def rename(self, remove=True):

264

def rename(self):

366

265

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

367

266

if self.rename_count >= self.max_renames:

368

267

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

369

268

" after %i retries, exiting.",

370

269

self.rename_count)

371

270

raise AvahiServiceError("Too many renames")

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

375

273

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

376

274

self.name)

377

if remove:

378

self.remove()

275

self.remove()

379

276

try:

380

277

self.add()

381

278

except dbus.exceptions.DBusException as error:

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

391

283

def remove(self):

392

284

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

393

285

if self.entry_group_state_changed_match is not None:

395

287

self.entry_group_state_changed_match = None

396

288

if self.group is not None:

397

289

self.group.Reset()

398

399

290

def add(self):

400

291

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

401

292

self.remove()

418

309

dbus.UInt16(self.port),

419

310

avahi.string_array_to_txt_array(self.TXT))

420

311

self.group.Commit()

421

422

312

def entry_group_state_changed(self, state, error):

423

313

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

424

314

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

425

315

426

316

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

317

logger.debug("Zeroconf service established.")

428

318

elif state == avahi.ENTRY_GROUP_COLLISION:

430

320

self.rename()

431

321

elif state == avahi.ENTRY_GROUP_FAILURE:

432

322

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

433

str(error))

434

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

435

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

436

326

def cleanup(self):

437

327

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

438

328

if self.group is not None:

443

333

pass

444

334

self.group = None

445

335

self.remove()

446

447

336

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

448

337

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

449

338

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

456

346

if state in bad_states:

457

347

if bad_states[state] is not None:

458

348

if error is None:

461

351

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

462

352

self.cleanup()

463

353

elif state == avahi.SERVER_RUNNING:

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

354

self.add()

476

355

else:

477

356

if error is None:

478

357

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

479

358

else:

480

359

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

481

482

360

def activate(self):

483

361

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

484

362

if self.server is None:

488

366

follow_name_owner_changes=True),

489

367

avahi.DBUS_INTERFACE_SERVER)

490

368

self.server.connect_to_signal("StateChanged",

491

self.server_state_changed)

369

self.server_state_changed)

492

370

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

493

371

494

495

372

class AvahiServiceToSyslog(AvahiService):

496

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

373

def rename(self):

497

374

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

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

502

380

return ret

503

381

504

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version("3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

815

816

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

817

388

class Client(object):

818

389

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

819

390

820

391

Attributes:

821

392

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

822

393

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

824

395

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

825

396

to see if the client lives.

826

397

'None' if no process is running.

827

checker_callback_tag: a GLib event source tag, or None

398

checker_callback_tag: a gobject event source tag, or None

828

399

checker_command: string; External command which is run to check

829

400

if client lives. %() expansions are done at

830

401

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

831

402

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

832

checker_initiator_tag: a GLib event source tag, or None

403

checker_initiator_tag: a gobject event source tag, or None

833

404

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

834

405

client_structure: Object describing what attributes a client has

835

406

and is used for storing the client at exit

836

407

current_checker_command: string; current running checker_command

837

disable_initiator_tag: a GLib event source tag, or None

408

disable_initiator_tag: a gobject event source tag, or None

838

409

enabled: bool()

839

410

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

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

411

uniquely identify the client

843

412

host: string; available for use by the checker command

844

413

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

845

414

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

846

415

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

847

416

last_checker_status: integer between 0 and 255 reflecting exit

848

417

status of last checker. -1 reflects crashed

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

418

checker, or None.

852

419

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

853

420

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

854

421

D-Bus identifiers

859

426

runtime_expansions: Allowed attributes for runtime expansion.

860

427

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

861

428

disabled, or None

862

server_settings: The server_settings dict from main()

863

429

"""

864

430

865

431

runtime_expansions = ("approval_delay", "approval_duration",

866

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

867

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

868

"last_approval_request", "last_checked_ok",

432

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

433

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

869

434

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

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

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

460

882

461

@staticmethod

883

462

def config_parser(config):

891

470

for client_name in config.sections():

892

471

section = dict(config.items(client_name))

893

472

client = settings[client_name] = {}

894

473

895

474

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

896

475

# Reformat values from string types to Python types

897

476

client["approved_by_default"] = config.getboolean(

898

477

client_name, "approved_by_default")

899

478

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

900

479

"enabled")

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

480

907

481

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

908

482

.replace(" ", ""))

909

483

if "secret" in section:

910

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

911

.encode("utf-8"),

912

"base64")

484

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

913

485

elif "secfile" in section:

914

486

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

915

487

(section["secfile"])),

916

488

"rb") as secfile:

917

489

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

918

490

else:

919

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

920

.format(section))

491

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

492

% section)

921

493

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

922

494

client["extended_timeout"] = string_to_delta(

923

495

section["extended_timeout"])

929

501

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

930

502

client["last_approval_request"] = None

931

503

client["last_checked_ok"] = None

932

client["last_checker_status"] = -2

933

504

client["last_checker_status"] = None

505

934

506

return settings

935

936

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

507

508

509

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

510

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

511

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

512

attribute."""

937

513

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

941

514

# adding all client settings

942

for setting, value in settings.items():

515

for setting, value in settings.iteritems():

943

516

setattr(self, setting, value)

944

517

945

518

if self.enabled:

946

519

if not hasattr(self, "last_enabled"):

947

520

self.last_enabled = datetime.datetime.utcnow()

951

524

else:

952

525

self.last_enabled = None

953

526

self.expires = None

954

527

955

528

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

956

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

957

532

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

958

533

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

959

534

datetime.datetime.utcnow())

966

541

self.current_checker_command = None

967

542

self.approved = None

968

543

self.approvals_pending = 0

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

973

549

if not attr.startswith("_")]

974

550

self.client_structure.append("client_structure")

975

976

for name, t in inspect.getmembers(

977

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

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

978

556

if not name.startswith("_"):

979

557

self.client_structure.append(name)

980

558

981

559

# Send notice to process children that client state has changed

982

560

def send_changedstate(self):

983

561

with self.changedstate:

984

562

self.changedstate.notify_all()

985

563

986

564

def enable(self):

987

565

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

988

566

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

989

567

# Already enabled

990

568

return

569

self.send_changedstate()

991

570

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

992

571

self.enabled = True

993

572

self.last_enabled = datetime.datetime.utcnow()

994

573

self.init_checker()

995

self.send_changedstate()

996

574

997

575

def disable(self, quiet=True):

998

576

"""Disable this client."""

999

577

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

1000

578

return False

1001

579

if not quiet:

580

self.send_changedstate()

581

if not quiet:

1002

582

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

1003

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

1004

GLib.source_remove(self.disable_initiator_tag)

583

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

584

gobject.source_remove(self.disable_initiator_tag)

1005

585

self.disable_initiator_tag = None

1006

586

self.expires = None

1007

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

1008

GLib.source_remove(self.checker_initiator_tag)

587

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

588

gobject.source_remove(self.checker_initiator_tag)

1009

589

self.checker_initiator_tag = None

1010

590

self.stop_checker()

1011

591

self.enabled = False

1012

if not quiet:

1013

self.send_changedstate()

1014

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

592

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

1015

593

return False

1016

594

1017

595

def __del__(self):

1018

596

self.disable()

1019

597

1020

598

def init_checker(self):

1021

599

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

1022

600

# and every interval from then on.

1023

if self.checker_initiator_tag is not None:

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

1028

604

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

1029

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

1033

608

# Also start a new checker *right now*.

1034

609

self.start_checker()

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

610

611

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

1038

612

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

1039

613

self.checker_callback_tag = None

1040

614

self.checker = None

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1048

617

if self.last_checker_status == 0:

1049

618

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

1050

619

vars(self))

1051

620

self.checked_ok()

1052

621

else:

1053

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

622

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

623

vars(self))

1054

624

else:

1055

625

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

1057

626

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

1058

627

vars(self))

1059

return False

1060

1061

def checked_ok(self):

1062

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

1063

self.last_checked_ok = datetime.datetime.utcnow()

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

1066

self.bump_timeout()

1067

1068

def bump_timeout(self, timeout=None):

1069

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

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

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

633

alive and well.

634

"""

1070

635

if timeout is None:

1071

636

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

1072

638

if self.disable_initiator_tag is not None:

1073

GLib.source_remove(self.disable_initiator_tag)

1074

self.disable_initiator_tag = None

639

gobject.source_remove(self.disable_initiator_tag)

1075

640

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

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1078

644

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

1079

645

1080

646

def need_approval(self):

1081

647

self.last_approval_request = datetime.datetime.utcnow()

1082

648

1083

649

def start_checker(self):

1084

650

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

1085

651

1086

652

If a checker already exists, leave it running and do

1087

653

nothing."""

1088

654

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

1089

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

1090

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

1091

# would inevitably timeout, since no checker would get a

1092

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

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

1093

659

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

1094

660

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

1095

661

# should be.

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

662

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

self.current_checker_command)

1101

676

# Start a new checker if needed

1102

677

if self.checker is None:

1103

# Escape attributes for the shell

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

1107

678

try:

1108

command = self.checker_command % escaped_attrs

1109

except TypeError as error:

1110

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

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

1114

697

self.current_checker_command = command

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

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

720

error)

721

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

1141

722

return True

1142

723

1143

724

def stop_checker(self):

1144

725

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

1145

726

if self.checker_callback_tag:

1146

GLib.source_remove(self.checker_callback_tag)

727

gobject.source_remove(self.checker_callback_tag)

1147

728

self.checker_callback_tag = None

1148

729

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

1149

730

return

1150

731

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

1151

self.checker.terminate()

732

try:

733

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

734

#time.sleep(0.5)

735

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

736

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

737

except OSError as error:

738

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

739

raise

1152

740

self.checker = None

1153

741

1154

742

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1159

745

"""Decorators for marking methods of a DBusObjectWithProperties to

1160

746

become properties on the D-Bus.

1161

747

1162

748

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

1163

749

and with one argument by "Set".

1164

750

1165

751

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

1166

752

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

1167

753

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

1170

756

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

1171

757

if byte_arrays and signature != "ay":

1172

758

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

1173

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

1174

759

" signature %r" % signature)

1175

760

def decorator(func):

1176

761

func._dbus_is_property = True

1177

762

func._dbus_interface = dbus_interface

1180

765

func._dbus_name = func.__name__

1181

766

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

1182

767

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

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1184

return func

1185

1186

return decorator

1187

1188

1189

def dbus_interface_annotations(dbus_interface):

1190

"""Decorator for marking functions returning interface annotations

1191

1192

Usage:

1193

1194

@dbus_interface_annotations("org.example.Interface")

1195

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

1196

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

1197

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

1198

"false"}

1199

"""

1200

1201

def decorator(func):

1202

func._dbus_is_interface = True

1203

func._dbus_interface = dbus_interface

1204

func._dbus_name = dbus_interface

1205

return func

1206

1207

return decorator

1208

1209

1210

def dbus_annotations(annotations):

1211

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

1212

Usage:

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

1217

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

1218

access="r")

1219

def Property_dbus_property(self):

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

1223

"""

1224

1225

def decorator(func):

1226

func._dbus_annotations = annotations

1227

return func

1228

768

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

return func

1229

770

return decorator

1230

771

1231

772

1232

773

class DBusPropertyException(dbus.exceptions.DBusException):

1233

774

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

1234

775

"""

1235

pass

776

def __unicode__(self):

777

return unicode(str(self))

1236

778

1237

779

1238

780

class DBusPropertyAccessException(DBusPropertyException):

1247

789

pass

1248

790

1249

791

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

1255

"""

1256

1257

@staticmethod

1258

def _is_dbus_thing(thing):

1259

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

1260

1261

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

1262

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

1263

"""

1264

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

1265

False)

1266

1267

def _get_all_dbus_things(self, thing):

1268

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

1269

"""

1270

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

1271

athing.__get__(self))

1272

for cls in self.__class__.__mro__

1273

for name, athing in

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

792

class DBusObjectWithProperties(dbus.service.Object):

1340

793

"""A D-Bus object with properties.

1341

794

1342

795

Classes inheriting from this can use the dbus_service_property

1343

796

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

1344

797

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

1345

798

"""

1346

799

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

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

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

1347

812

def _get_dbus_property(self, interface_name, property_name):

1348

813

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

1349

814

property with the specified name and interface.

1350

815

"""

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1354

819

if (value._dbus_name == property_name

1355

820

and value._dbus_interface == interface_name):

1356

821

return value.__get__(self)

1357

822

1358

823

# No such property

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

1373

829

out_signature="v")

1374

830

def Get(self, interface_name, property_name):

1375

831

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

1381

837

if not hasattr(value, "variant_level"):

1382

838

return value

1383

839

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

1384

840

1385

841

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

1386

842

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

1387

843

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

1393

849

# The byte_arrays option is not supported yet on

1394

850

# signatures other than "ay".

1395

851

if prop._dbus_signature != "ay":

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

852

raise ValueError

1399

853

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

1400

854

for byte in value))

1401

855

prop(value)

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

856

857

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

1405

858

out_signature="a{sv}")

1406

859

def GetAll(self, interface_name):

1407

860

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

1408

861

standard.

1409

862

1410

863

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

1411

864

"""

1412

865

properties = {}

1413

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

866

for name, prop in self._get_all_dbus_properties():

1414

867

if (interface_name

1415

868

and interface_name != prop._dbus_interface):

1416

869

# Interface non-empty but did not match

1422

875

if not hasattr(value, "variant_level"):

1423

876

properties[name] = value

1424

877

continue

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

878

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

879

value.variant_level+1)

1427

880

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

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

881

1437

882

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1438

883

out_signature="s",

1439

884

path_keyword='object_path',

1440

885

connection_keyword='connection')

1441

886

def Introspect(self, object_path, connection):

1442

"""Overloading of standard D-Bus method.

1443

1444

Inserts property tags and interface annotation tags.

887

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

1445

888

"""

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

889

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

890

connection)

1449

891

try:

1450

892

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

1451

1452

893

def make_tag(document, name, prop):

1453

894

e = document.createElement("property")

1454

895

e.setAttribute("name", name)

1455

896

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

1456

897

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

1457

898

return e

1458

1459

899

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

1460

# Add property tags

1461

900

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

1462

901

for name, prop

1463

in self._get_all_dbus_things("property")

902

in self._get_all_dbus_properties()

1464

903

if prop._dbus_interface

1465

904

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

1466

905

if_tag.appendChild(tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

1483

906

# Add the names to the return values for the

1484

907

# "org.freedesktop.DBus.Properties" methods

1485

908

if (if_tag.getAttribute("name")

1500

923

except (AttributeError, xml.dom.DOMException,

1501

924

xml.parsers.expat.ExpatError) as error:

1502

925

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

1503

exc_info=error)

1504

return xmlstring

1505

1506

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1578

def datetime_to_dbus(dt, variant_level=0):

926

error)

927

return xmlstring

928

929

930

def datetime_to_dbus (dt, variant_level=0):

1579

931

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

1580

932

if dt is None:

1581

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

1582

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

1583

1584

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1586

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

1587

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

1588

interface names according to the "alt_interface_names" mapping.

1589

Usage:

1590

1591

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

1592

"net.example.AlternateInterface"})

1593

class SampleDBusObject(dbus.service.Object):

1594

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

1595

def SampleDBusMethod():

1596

pass

1597

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1599

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

1600

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

1601

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

1602

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

1603

1604

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

1605

(from DBusObjectWithProperties) and interfaces (from the

1606

dbus_interface_annotations decorator).

933

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

1607

942

"""

1608

1609

def wrapper(cls):

1610

for orig_interface_name, alt_interface_name in (

1611

alt_interface_names.items()):

1612

attr = {}

1613

interface_names = set()

1614

# Go though all attributes of the class

1615

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

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

1616

950

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

1617

951

# with the wrong interface name

1618

952

if (not hasattr(attribute, "_dbus_interface")

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

953

or not attribute._dbus_interface

954

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

1621

955

continue

1622

956

# Create an alternate D-Bus interface name based on

1623

957

# the current name

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1626

interface_names.add(alt_interface)

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1627

961

# Is this a D-Bus signal?

1628

962

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

1629

# Extract the original non-method undecorated

1630

# function by black magic

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

963

# Extract the original non-method function by

964

# black magic

965

nonmethod_func = (dict(

1633

966

zip(attribute.func_code.co_freevars,

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

967

attribute.__closure__))["func"]

968

.cell_contents)

1641

969

# Create a new, but exactly alike, function

1642

970

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

1643

971

# with the alternate D-Bus interface name

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1648

# Copy annotations, if any

1649

try:

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1652

except AttributeError:

1653

pass

1654

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

nonmethod_func.func_closure)))

1655

981

# Define a creator of a function to call both the

1656

# original and alternate functions, so both the

1657

# original and alternate signals gets sent when

1658

# the function is called

982

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

983

# signals gets sent when the function is called

1659

984

def fixscope(func1, func2):

1660

985

"""This function is a scope container to pass

1661

986

func1 and func2 to the "call_both" function

1662

987

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1665

988

def call_both(*args, **kwargs):

1666

989

"""This function will emit two D-Bus

1667

990

signals by calling func1 and func2"""

1668

991

func1(*args, **kwargs)

1669

992

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1676

993

return call_both

1677

994

# Create the "call_both" function and add it to

1678

995

# the class

1679

attr[attrname] = fixscope(attribute, new_function)

996

attr[attrname] = fixscope(attribute,

997

new_function)

1680

998

# Is this a D-Bus method?

1681

999

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

1682

1000

# Create a new, but exactly alike, function

1683

1001

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

1684

1002

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

1685

1003

# to the class.

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1692

# Copy annotations, if any

1693

try:

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1696

except AttributeError:

1697

pass

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

attribute.func_closure)))

1698

1014

# Is this a D-Bus property?

1699

1015

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

1700

1016

# Create a new, but exactly alike, function

1701

1017

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

1702

1018

# property with the alternate D-Bus interface

1703

1019

# name. Add it to the class.

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1710

# Copy annotations, if any

1711

try:

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1714

except AttributeError:

1715

pass

1716

# Is this a D-Bus interface?

1717

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

1718

# Create a new, but exactly alike, function

1719

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

1720

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

1721

# to the class.

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1725

if deprecate:

1726

# Deprecate all alternate interfaces

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1728

for interface_name in interface_names:

1729

1730

@dbus_interface_annotations(interface_name)

1731

def func(self):

1732

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

1733

"true"}

1734

# Find an unused name

1735

for aname in (iname.format(i)

1736

for i in itertools.count()):

1737

if aname not in attr:

1738

attr[aname] = func

1739

break

1740

if interface_names:

1741

# Replace the class with a new subclass of it with

1742

# methods, signals, etc. as created above.

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1749

return cls

1750

1751

return wrapper

1752

1753

1754

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

1755

"se.bsnet.fukt.Mandos"})

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

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

1034

1035

1756

1036

class ClientDBus(Client, DBusObjectWithProperties):

1757

1037

"""A Client class using D-Bus

1758

1038

1759

1039

Attributes:

1760

1040

dbus_object_path: dbus.ObjectPath

1761

1041

bus: dbus.SystemBus()

1762

1042

"""

1763

1043

1764

1044

runtime_expansions = (Client.runtime_expansions

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1045

+ ("dbus_object_path",))

1046

1769

1047

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

1770

1771

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

1048

1049

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

1772

1050

self.bus = bus

1773

1051

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

1774

1052

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

1775

1053

# the D-Bus

1776

client_object_name = str(self.name).translate(

1054

client_object_name = unicode(self.name).translate(

1777

1055

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

1778

1056

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

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1057

self.dbus_object_path = (dbus.ObjectPath

1058

("/clients/" + client_object_name))

1781

1059

DBusObjectWithProperties.__init__(self, self.bus,

1782

1060

self.dbus_object_path)

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1061

1062

def notifychangeproperty(transform_func,

1063

dbus_name, type_func=lambda x: x,

1064

variant_level=1):

1789

1065

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

1790

1066

its changes to DBus.

1791

1067

1792

1068

transform_fun: Function that takes a value and a variant_level

1793

1069

and transforms it to a D-Bus type.

1794

1070

dbus_name: D-Bus name of the variable

1796

1072

to the D-Bus. Default: no transform

1797

1073

variant_level: D-Bus variant level. Default: 1

1798

1074

"""

1799

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

1800

1075

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

1801

1076

def setter(self, value):

1802

1077

if hasattr(self, "dbus_object_path"):

1803

1078

if (not hasattr(self, attrname) or

1804

1079

type_func(getattr(self, attrname, None))

1805

1080

!= type_func(value)):

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1081

dbus_value = transform_func(type_func(value),

1082

variant_level

1083

=variant_level)

1084

self.PropertyChanged(dbus.String(dbus_name),

1085

dbus_value)

1821

1086

setattr(self, attrname, value)

1822

1087

1823

1088

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

1824

1089

1090

1825

1091

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1826

1092

approvals_pending = notifychangeproperty(dbus.Boolean,

1827

1093

"ApprovalPending",

1828

type_func=bool)

1094

type_func = bool)

1829

1095

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

1830

1096

last_enabled = notifychangeproperty(datetime_to_dbus,

1831

1097

"LastEnabled")

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1098

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

1099

type_func = lambda checker:

1100

checker is not None)

1835

1101

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1836

1102

"LastCheckedOK")

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1838

"LastCheckerStatus")

1839

1103

last_approval_request = notifychangeproperty(

1840

1104

datetime_to_dbus, "LastApprovalRequest")

1841

1105

approved_by_default = notifychangeproperty(dbus.Boolean,

1842

1106

"ApprovedByDefault")

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1107

approval_delay = notifychangeproperty(dbus.UInt64,

1108

"ApprovalDelay",

1109

type_func =

1110

timedelta_to_milliseconds)

1846

1111

approval_duration = notifychangeproperty(

1847

1112

dbus.UInt64, "ApprovalDuration",

1848

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

1113

type_func = timedelta_to_milliseconds)

1849

1114

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

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1115

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

1116

type_func =

1117

timedelta_to_milliseconds)

1853

1118

extended_timeout = notifychangeproperty(

1854

1119

dbus.UInt64, "ExtendedTimeout",

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1120

type_func = timedelta_to_milliseconds)

1121

interval = notifychangeproperty(dbus.UInt64,

1122

"Interval",

1123

type_func =

1124

timedelta_to_milliseconds)

1859

1125

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

1860

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

1861

invalidate_only=True)

1862

1126

1863

1127

del notifychangeproperty

1864

1128

1865

1129

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

1866

1130

try:

1867

1131

self.remove_from_connection()

1870

1134

if hasattr(DBusObjectWithProperties, "__del__"):

1871

1135

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

1872

1136

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

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1137

1138

def checker_callback(self, pid, condition, command,

1139

*args, **kwargs):

1140

self.checker_callback_tag = None

1141

self.checker = None

1142

if os.WIFEXITED(condition):

1143

exitstatus = os.WEXITSTATUS(condition)

1881

1144

# Emit D-Bus signal

1882

1145

self.CheckerCompleted(dbus.Int16(exitstatus),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1146

dbus.Int64(condition),

1885

1147

dbus.String(command))

1886

1148

else:

1887

1149

# Emit D-Bus signal

1888

1150

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

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1151

dbus.Int64(condition),

1893

1152

dbus.String(command))

1894

return ret

1895

1153

1154

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

1155

*args, **kwargs)

1156

1896

1157

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

1897

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

1158

old_checker = self.checker

1159

if self.checker is not None:

1160

old_checker_pid = self.checker.pid

1161

else:

1162

old_checker_pid = None

1898

1163

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

1899

1164

# Only if new checker process was started

1900

1165

if (self.checker is not None

1902

1167

# Emit D-Bus signal

1903

1168

self.CheckerStarted(self.current_checker_command)

1904

1169

return r

1905

1170

1906

1171

def _reset_approved(self):

1907

1172

self.approved = None

1908

1173

return False

1909

1174

1910

1175

def approve(self, value=True):

1176

self.send_changedstate()

1911

1177

self.approved = value

1912

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

1913

* 1000), self._reset_approved)

1914

self.send_changedstate()

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1178

gobject.timeout_add(timedelta_to_milliseconds

1179

(self.approval_duration),

1180

self._reset_approved)

1181

1182

1183

## D-Bus methods, signals & properties

1184

_interface = "se.recompile.Mandos.Client"

1185

1186

## Signals

1187

1922

1188

# CheckerCompleted - signal

1923

1189

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

1924

1190

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

1925

1191

"D-Bus signal"

1926

1192

pass

1927

1193

1928

1194

# CheckerStarted - signal

1929

1195

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

1930

1196

def CheckerStarted(self, command):

1931

1197

"D-Bus signal"

1932

1198

pass

1933

1199

1934

1200

# PropertyChanged - signal

1935

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

1936

1201

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

1937

1202

def PropertyChanged(self, property, value):

1938

1203

"D-Bus signal"

1939

1204

pass

1940

1205

1941

1206

# GotSecret - signal

1942

1207

@dbus.service.signal(_interface)

1943

1208

def GotSecret(self):

1946

1211

server to mandos-client

1947

1212

"""

1948

1213

pass

1949

1214

1950

1215

# Rejected - signal

1951

1216

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

1952

1217

def Rejected(self, reason):

1953

1218

"D-Bus signal"

1954

1219

pass

1955

1220

1956

1221

# NeedApproval - signal

1957

1222

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

1958

1223

def NeedApproval(self, timeout, default):

1959

1224

"D-Bus signal"

1960

1225

return self.need_approval()

1961

1962

# Methods

1963

1226

1227

## Methods

1228

1964

1229

# Approve - method

1965

1230

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

1966

1231

def Approve(self, value):

1967

1232

self.approve(value)

1968

1233

1969

1234

# CheckedOK - method

1970

1235

@dbus.service.method(_interface)

1971

1236

def CheckedOK(self):

1972

1237

self.checked_ok()

1973

1238

1974

1239

# Enable - method

1975

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

1976

1240

@dbus.service.method(_interface)

1977

1241

def Enable(self):

1978

1242

"D-Bus method"

1979

1243

self.enable()

1980

1244

1981

1245

# StartChecker - method

1982

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

1983

1246

@dbus.service.method(_interface)

1984

1247

def StartChecker(self):

1985

1248

"D-Bus method"

1986

1249

self.start_checker()

1987

1250

1988

1251

# Disable - method

1989

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

1990

1252

@dbus.service.method(_interface)

1991

1253

def Disable(self):

1992

1254

"D-Bus method"

1993

1255

self.disable()

1994

1256

1995

1257

# StopChecker - method

1996

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

1997

1258

@dbus.service.method(_interface)

1998

1259

def StopChecker(self):

1999

1260

self.stop_checker()

2000

2001

# Properties

2002

1261

1262

## Properties

1263

2003

1264

# ApprovalPending - property

2004

1265

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

2005

1266

def ApprovalPending_dbus_property(self):

2006

1267

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

2007

1268

2008

1269

# ApprovedByDefault - property

2009

@dbus_service_property(_interface,

2010

signature="b",

1270

@dbus_service_property(_interface, signature="b",

2011

1271

access="readwrite")

2012

1272

def ApprovedByDefault_dbus_property(self, value=None):

2013

1273

if value is None: # get

2014

1274

return dbus.Boolean(self.approved_by_default)

2015

1275

self.approved_by_default = bool(value)

2016

1276

2017

1277

# ApprovalDelay - property

2018

@dbus_service_property(_interface,

2019

signature="t",

1278

@dbus_service_property(_interface, signature="t",

2020

1279

access="readwrite")

2021

1280

def ApprovalDelay_dbus_property(self, value=None):

2022

1281

if value is None: # get

2023

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

2024

* 1000)

1282

return dbus.UInt64(self.approval_delay_milliseconds())

2025

1283

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

2026

1284

2027

1285

# ApprovalDuration - property

2028

@dbus_service_property(_interface,

2029

signature="t",

1286

@dbus_service_property(_interface, signature="t",

2030

1287

access="readwrite")

2031

1288

def ApprovalDuration_dbus_property(self, value=None):

2032

1289

if value is None: # get

2033

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

2034

* 1000)

1290

return dbus.UInt64(timedelta_to_milliseconds(

1291

self.approval_duration))

2035

1292

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

2036

1293

2037

1294

# Name - property

2038

@dbus_annotations(

2039

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

2040

1295

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

2041

1296

def Name_dbus_property(self):

2042

1297

return dbus.String(self.name)

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1298

2051

1299

# Fingerprint - property

2052

@dbus_annotations(

2053

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

2054

1300

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

2055

1301

def Fingerprint_dbus_property(self):

2056

1302

return dbus.String(self.fingerprint)

2057

1303

2058

1304

# Host - property

2059

@dbus_service_property(_interface,

2060

signature="s",

1305

@dbus_service_property(_interface, signature="s",

2061

1306

access="readwrite")

2062

1307

def Host_dbus_property(self, value=None):

2063

1308

if value is None: # get

2064

1309

return dbus.String(self.host)

2065

self.host = str(value)

2066

1310

self.host = unicode(value)

1311

2067

1312

# Created - property

2068

@dbus_annotations(

2069

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

2070

1313

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

2071

1314

def Created_dbus_property(self):

2072

1315

return datetime_to_dbus(self.created)

2073

1316

2074

1317

# LastEnabled - property

2075

1318

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

2076

1319

def LastEnabled_dbus_property(self):

2077

1320

return datetime_to_dbus(self.last_enabled)

2078

1321

2079

1322

# Enabled - property

2080

@dbus_service_property(_interface,

2081

signature="b",

1323

@dbus_service_property(_interface, signature="b",

2082

1324

access="readwrite")

2083

1325

def Enabled_dbus_property(self, value=None):

2084

1326

if value is None: # get

2087

1329

self.enable()

2088

1330

else:

2089

1331

self.disable()

2090

1332

2091

1333

# LastCheckedOK - property

2092

@dbus_service_property(_interface,

2093

signature="s",

1334

@dbus_service_property(_interface, signature="s",

2094

1335

access="readwrite")

2095

1336

def LastCheckedOK_dbus_property(self, value=None):

2096

1337

if value is not None:

2097

1338

self.checked_ok()

2098

1339

return

2099

1340

return datetime_to_dbus(self.last_checked_ok)

2100

2101

# LastCheckerStatus - property

2102

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

2103

def LastCheckerStatus_dbus_property(self):

2104

return dbus.Int16(self.last_checker_status)

2105

1341

2106

1342

# Expires - property

2107

1343

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

2108

1344

def Expires_dbus_property(self):

2109

1345

return datetime_to_dbus(self.expires)

2110

1346

2111

1347

# LastApprovalRequest - property

2112

1348

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

2113

1349

def LastApprovalRequest_dbus_property(self):

2114

1350

return datetime_to_dbus(self.last_approval_request)

2115

1351

2116

1352

# Timeout - property

2117

@dbus_service_property(_interface,

2118

signature="t",

1353

@dbus_service_property(_interface, signature="t",

2119

1354

access="readwrite")

2120

1355

def Timeout_dbus_property(self, value=None):

2121

1356

if value is None: # get

2122

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

2123

old_timeout = self.timeout

1357

return dbus.UInt64(self.timeout_milliseconds())

2124

1358

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

2125

# Reschedule disabling

1359

# Reschedule timeout

2126

1360

if self.enabled:

2127

1361

now = datetime.datetime.utcnow()

2128

self.expires += self.timeout - old_timeout

2129

if self.expires <= now:

1362

time_to_die = timedelta_to_milliseconds(

1363

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

1364

if time_to_die <= 0:

2130

1365

# The timeout has passed

2131

1366

self.disable()

2132

1367

else:

1368

self.expires = (now +

1369

datetime.timedelta(milliseconds =

1370

time_to_die))

2133

1371

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

2134

1372

is None):

2135

1373

return

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1374

gobject.source_remove(self.disable_initiator_tag)

1375

self.disable_initiator_tag = (gobject.timeout_add

1376

(time_to_die,

1377

self.disable))

1378

2141

1379

# ExtendedTimeout - property

2142

@dbus_service_property(_interface,

2143

signature="t",

1380

@dbus_service_property(_interface, signature="t",

2144

1381

access="readwrite")

2145

1382

def ExtendedTimeout_dbus_property(self, value=None):

2146

1383

if value is None: # get

2147

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

2148

* 1000)

1384

return dbus.UInt64(self.extended_timeout_milliseconds())

2149

1385

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

2150

1386

2151

1387

# Interval - property

2152

@dbus_service_property(_interface,

2153

signature="t",

1388

@dbus_service_property(_interface, signature="t",

2154

1389

access="readwrite")

2155

1390

def Interval_dbus_property(self, value=None):

2156

1391

if value is None: # get

2157

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

1392

return dbus.UInt64(self.interval_milliseconds())

2158

1393

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

2159

1394

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

2160

1395

return

2161

1396

if self.enabled:

2162

1397

# Reschedule checker run

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1398

gobject.source_remove(self.checker_initiator_tag)

1399

self.checker_initiator_tag = (gobject.timeout_add

1400

(value, self.start_checker))

1401

self.start_checker() # Start one now, too

1402

2168

1403

# Checker - property

2169

@dbus_service_property(_interface,

2170

signature="s",

1404

@dbus_service_property(_interface, signature="s",

2171

1405

access="readwrite")

2172

1406

def Checker_dbus_property(self, value=None):

2173

1407

if value is None: # get

2174

1408

return dbus.String(self.checker_command)

2175

self.checker_command = str(value)

2176

1409

self.checker_command = unicode(value)

1410

2177

1411

# CheckerRunning - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1412

@dbus_service_property(_interface, signature="b",

2180

1413

access="readwrite")

2181

1414

def CheckerRunning_dbus_property(self, value=None):

2182

1415

if value is None: # get

2185

1418

self.start_checker()

2186

1419

else:

2187

1420

self.stop_checker()

2188

1421

2189

1422

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

2193

1423

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

2194

1424

def ObjectPath_dbus_property(self):

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1425

return self.dbus_object_path # is already a dbus.ObjectPath

1426

2197

1427

# Secret = property

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1428

@dbus_service_property(_interface, signature="ay",

1429

access="write", byte_arrays=True)

2205

1430

def Secret_dbus_property(self, value):

2206

self.secret = bytes(value)

2207

1431

self.secret = str(value)

1432

2208

1433

del _interface

2209

1434

2210

1435

2211

1436

class ProxyClient(object):

2212

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

1437

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

2213

1438

self._pipe = child_pipe

2214

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

1439

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

2215

1440

if not self._pipe.recv():

2216

raise KeyError(key_id or fpr)

2217

1441

raise KeyError()

1442

2218

1443

def __getattribute__(self, name):

2219

1444

if name == '_pipe':

2220

1445

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

2223

1448

if data[0] == 'data':

2224

1449

return data[1]

2225

1450

if data[0] == 'function':

2226

2227

1451

def func(*args, **kwargs):

2228

1452

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

2229

1453

return self._pipe.recv()[1]

2230

2231

1454

return func

2232

1455

2233

1456

def __setattr__(self, name, value):

2234

1457

if name == '_pipe':

2235

1458

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

2236

1459

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

2237

1460

2238

1461

1462

class ClientDBusTransitional(ClientDBus):

1463

__metaclass__ = AlternateDBusNamesMetaclass

1464

1465

2239

1466

class ClientHandler(socketserver.BaseRequestHandler, object):

2240

1467

"""A class to handle client connections.

2241

1468

2242

1469

Instantiated once for each connection to handle it.

2243

1470

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

2244

1471

2245

1472

def handle(self):

2246

1473

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

2247

1474

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

2248

str(self.client_address))

1475

unicode(self.client_address))

2249

1476

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

2250

1477

self.server.child_pipe.fileno())

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1478

1479

session = (gnutls.connection

1480

.ClientSession(self.request,

1481

gnutls.connection

1482

.X509Credentials()))

1483

1484

# Note: gnutls.connection.X509Credentials is really a

1485

# generic GnuTLS certificate credentials object so long as

1486

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

1487

# here despite using OpenPGP certificates.

1488

1489

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

1490

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

1491

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

1492

# "+DHE-DSS"))

2258

1493

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

2259

1494

priority = self.server.gnutls_priority

2260

1495

if priority is None:

2261

1496

priority = "NORMAL"

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1497

(gnutls.library.functions

1498

.gnutls_priority_set_direct(session._c_object,

1499

priority, None))

1500

2266

1501

# Start communication using the Mandos protocol

2267

1502

# Get protocol number

2268

1503

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

2269

1504

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

2270

1505

try:

2271

1506

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

2272

raise RuntimeError(line)

1507

raise RuntimeError

2273

1508

except (ValueError, IndexError, RuntimeError) as error:

2274

1509

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

2275

1510

return

2276

1511

2277

1512

# Start GnuTLS connection

2278

1513

try:

2279

1514

session.handshake()

2280

except gnutls.Error as error:

1515

except gnutls.errors.GNUTLSError as error:

2281

1516

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

2282

1517

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

2283

1518

# established. Just abandon the request.

2284

1519

return

2285

1520

logger.debug("Handshake succeeded")

2286

1521

2287

1522

approval_required = False

2288

1523

try:

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1524

try:

1525

fpr = self.fingerprint(self.peer_certificate

1526

(session))

1527

except (TypeError,

1528

gnutls.errors.GNUTLSError) as error:

1529

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

1530

return

1531

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

1532

1533

try:

1534

client = ProxyClient(child_pipe, fpr,

2311

1535

self.client_address)

2312

1536

except KeyError:

2313

1537

return

2314

1538

2315

1539

if client.approval_delay:

2316

1540

delay = client.approval_delay

2317

1541

client.approvals_pending += 1

2318

1542

approval_required = True

2319

1543

2320

1544

while True:

2321

1545

if not client.enabled:

2322

1546

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

2323

client.name)

1547

client.name)

2324

1548

if self.server.use_dbus:

2325

1549

# Emit D-Bus signal

2326

1550

client.Rejected("Disabled")

2327

1551

return

2328

1552

2329

1553

if client.approved or not client.approval_delay:

2330

# We are approved or approval is disabled

1554

#We are approved or approval is disabled

2331

1555

break

2332

1556

elif client.approved is None:

2333

1557

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

2335

1559

if self.server.use_dbus:

2336

1560

# Emit D-Bus signal

2337

1561

client.NeedApproval(

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1562

client.approval_delay_milliseconds(),

1563

client.approved_by_default)

2340

1564

else:

2341

1565

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

2342

1566

client.name)

2344

1568

# Emit D-Bus signal

2345

1569

client.Rejected("Denied")

2346

1570

return

2347

2348

# wait until timeout or approved

1571

1572

#wait until timeout or approved

2349

1573

time = datetime.datetime.now()

2350

1574

client.changedstate.acquire()

2351

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

1575

(client.changedstate.wait

1576

(float(client.timedelta_to_milliseconds(delay)

1577

/ 1000)))

2352

1578

client.changedstate.release()

2353

1579

time2 = datetime.datetime.now()

2354

1580

if (time2 - time) >= delay:

2364

1590

break

2365

1591

else:

2366

1592

delay -= time2 - time

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1593

1594

sent_size = 0

1595

while sent_size < len(client.secret):

1596

try:

1597

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

1598

except gnutls.errors.GNUTLSError as error:

1599

logger.warning("gnutls send failed")

1600

return

1601

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

1602

sent, len(client.secret)

1603

- (sent_size + sent))

1604

sent_size += sent

1605

2375

1606

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

2376

1607

# bump the timeout using extended_timeout

2377

client.bump_timeout(client.extended_timeout)

1608

client.checked_ok(client.extended_timeout)

2378

1609

if self.server.use_dbus:

2379

1610

# Emit D-Bus signal

2380

1611

client.GotSecret()

2381

1612

2382

1613

finally:

2383

1614

if approval_required:

2384

1615

client.approvals_pending -= 1

2385

1616

try:

2386

1617

session.bye()

2387

except gnutls.Error as error:

2388

logger.warning("GnuTLS bye failed",

2389

exc_info=error)

2390

1618

except gnutls.errors.GNUTLSError as error:

1619

logger.warning("GnuTLS bye failed")

1620

2391

1621

@staticmethod

2392

1622

def peer_certificate(session):

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1623

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

1624

# If not an OpenPGP certificate...

1625

if (gnutls.library.functions

1626

.gnutls_certificate_type_get(session._c_object)

1627

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1628

# ...do the normal thing

1629

return session.peer_certificate

2409

1630

list_size = ctypes.c_uint(1)

2410

cert_list = (gnutls.certificate_get_peers

1631

cert_list = (gnutls.library.functions

1632

.gnutls_certificate_get_peers

2411

1633

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

2412

1634

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

2413

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

1635

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

1636

" certificate")

2414

1637

if list_size.value == 0:

2415

1638

return None

2416

1639

cert = cert_list[0]

2417

1640

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

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1641

2453

1642

@staticmethod

2454

1643

def fingerprint(openpgp):

2455

1644

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2456

1645

# New GnuTLS "datum" with the OpenPGP public key

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1646

datum = (gnutls.library.types

1647

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

1648

ctypes.POINTER

1649

(ctypes.c_ubyte)),

1650

ctypes.c_uint(len(openpgp))))

2461

1651

# New empty GnuTLS certificate

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1652

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1653

(gnutls.library.functions

1654

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2464

1655

# Import the OpenPGP public key into the certificate

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1656

(gnutls.library.functions

1657

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

1658

gnutls.library.constants

1659

.GNUTLS_OPENPGP_FMT_RAW))

2467

1660

# Verify the self signature in the key

2468

1661

crtverify = ctypes.c_uint()

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_verify_self(crt, 0,

1664

ctypes.byref(crtverify)))

2471

1665

if crtverify.value != 0:

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1666

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1667

raise (gnutls.errors.CertificateSecurityError

1668

("Verify failed"))

2475

1669

# New buffer for the fingerprint

2476

1670

buf = ctypes.create_string_buffer(20)

2477

1671

buf_len = ctypes.c_size_t()

2478

1672

# Get the fingerprint from the certificate into the buffer

2479

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

2480

ctypes.byref(buf_len))

1673

(gnutls.library.functions

1674

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

1675

ctypes.byref(buf_len)))

2481

1676

# Deinit the certificate

2482

gnutls.openpgp_crt_deinit(crt)

1677

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

1678

# Convert the buffer to a Python bytestring

2484

1679

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

2485

1680

# Convert the bytestring to hexadecimal notation

2489

1684

2490

1685

class MultiprocessingMixIn(object):

2491

1686

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

2492

2493

1687

def sub_process_main(self, request, address):

2494

1688

try:

2495

1689

self.finish_request(request, address)

2496

1690

except Exception:

2497

1691

self.handle_error(request, address)

2498

1692

self.close_request(request)

2499

1693

2500

1694

def process_request(self, request, address):

2501

1695

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

2502

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

2503

args=(request, address))

1696

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

1697

args = (request,

1698

address))

2504

1699

proc.start()

2505

1700

return proc

2506

1701

2507

1702

2508

1703

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2509

1704

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

2510

2511

1705

def process_request(self, request, client_address):

2512

1706

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

2513

1707

2514

1708

This function creates a new pipe in self.pipe

2515

1709

"""

2516

1710

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2517

1711

2518

1712

proc = MultiprocessingMixIn.process_request(self, request,

2519

1713

client_address)

2520

1714

self.child_pipe.close()

2521

1715

self.add_pipe(parent_pipe, proc)

2522

1716

2523

1717

def add_pipe(self, parent_pipe, proc):

2524

1718

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

2525

raise NotImplementedError()

1719

raise NotImplementedError

2526

1720

2527

1721

2528

1722

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2529

1723

socketserver.TCPServer, object):

2530

1724

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

2531

1725

2532

1726

Attributes:

2533

1727

enabled: Boolean; whether this server is activated yet

2534

1728

interface: None or a network interface name (string)

2535

1729

use_ipv6: Boolean; to use IPv6 or not

2536

1730

"""

2537

2538

1731

def __init__(self, server_address, RequestHandlerClass,

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

2542

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

2543

creating a new one with socket.socket().

2544

"""

1732

interface=None, use_ipv6=True):

2545

1733

self.interface = interface

2546

1734

if use_ipv6:

2547

1735

self.address_family = socket.AF_INET6

2548

if socketfd is not None:

2549

# Save the file descriptor

2550

self.socketfd = socketfd

2551

# Save the original socket.socket() function

2552

self.socket_socket = socket.socket

2553

2554

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

2555

#

2556

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

2557

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

2558

# patching socket.socket.)

2559

#

2560

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

2561

@functools.wraps(socket.socket)

2562

def socket_wrapper(*args, **kwargs):

2563

# Restore original function so subsequent calls are

2564

# not affected.

2565

socket.socket = self.socket_socket

2566

del self.socket_socket

2567

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

2568

# saved file descriptor.

2569

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

2570

# Replace socket.socket() function with wrapper

2571

socket.socket = socket_wrapper

2572

# The socketserver.TCPServer.__init__ will call

2573

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

2574

# socket_wrapper(), if socketfd was set.

2575

1736

socketserver.TCPServer.__init__(self, server_address,

2576

1737

RequestHandlerClass)

2577

2578

1738

def server_bind(self):

2579

1739

"""This overrides the normal server_bind() function

2580

1740

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

2581

1741

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

2582

global SO_BINDTODEVICE

2583

1742

if self.interface is not None:

2584

1743

if SO_BINDTODEVICE is None:

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1744

logger.error("SO_BINDTODEVICE does not exist;"

1745

" cannot bind to interface %s",

1746

self.interface)

1747

else:

1748

try:

1749

self.socket.setsockopt(socket.SOL_SOCKET,

1750

SO_BINDTODEVICE,

1751

str(self.interface

1752

+ '\0'))

1753

except socket.error as error:

1754

if error[0] == errno.EPERM:

1755

logger.error("No permission to"

1756

" bind to interface %s",

1757

self.interface)

1758

elif error[0] == errno.ENOPROTOOPT:

1759

logger.error("SO_BINDTODEVICE not available;"

1760

" cannot bind to interface %s",

1761

self.interface)

1762

else:

1763

raise

2606

1764

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

2607

1765

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

2608

if self.server_address[1]:

2609

self.allow_reuse_address = True

2610

1766

if not self.server_address[0]:

2611

1767

if self.address_family == socket.AF_INET6:

2612

any_address = "::" # in6addr_any

1768

any_address = "::" # in6addr_any

2613

1769

else:

2614

any_address = "0.0.0.0" # INADDR_ANY

1770

any_address = socket.INADDR_ANY

2615

1771

self.server_address = (any_address,

2616

1772

self.server_address[1])

2617

1773

elif not self.server_address[1]:

2618

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

1774

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

1775

0)

2619

1776

# if self.interface:

2620

1777

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

2621

1778

# 0, # port

2627

1784

2628

1785

class MandosServer(IPv6_TCPServer):

2629

1786

"""Mandos server.

2630

1787

2631

1788

Attributes:

2632

1789

clients: set of Client objects

2633

1790

gnutls_priority GnuTLS priority string

2634

1791

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

2635

2636

Assumes a GLib.MainLoop event loop.

1792

1793

Assumes a gobject.MainLoop event loop.

2637

1794

"""

2638

2639

1795

def __init__(self, server_address, RequestHandlerClass,

2640

interface=None,

2641

use_ipv6=True,

2642

clients=None,

2643

gnutls_priority=None,

2644

use_dbus=True,

2645

socketfd=None):

1796

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

1797

gnutls_priority=None, use_dbus=True):

2646

1798

self.enabled = False

2647

1799

self.clients = clients

2648

1800

if self.clients is None:

2651

1803

self.gnutls_priority = gnutls_priority

2652

1804

IPv6_TCPServer.__init__(self, server_address,

2653

1805

RequestHandlerClass,

2654

interface=interface,

2655

use_ipv6=use_ipv6,

2656

socketfd=socketfd)

2657

1806

interface = interface,

1807

use_ipv6 = use_ipv6)

2658

1808

def server_activate(self):

2659

1809

if self.enabled:

2660

1810

return socketserver.TCPServer.server_activate(self)

2661

1811

2662

1812

def enable(self):

2663

1813

self.enabled = True

2664

1814

2665

1815

def add_pipe(self, parent_pipe, proc):

2666

1816

# Call "handle_ipc" for both data and EOF events

2667

GLib.io_add_watch(

2668

parent_pipe.fileno(),

2669

GLib.IO_IN | GLib.IO_HUP,

2670

functools.partial(self.handle_ipc,

2671

parent_pipe=parent_pipe,

2672

proc=proc))

2673

2674

def handle_ipc(self, source, condition,

2675

parent_pipe=None,

2676

proc=None,

2677

client_object=None):

1817

gobject.io_add_watch(parent_pipe.fileno(),

1818

gobject.IO_IN | gobject.IO_HUP,

1819

functools.partial(self.handle_ipc,

1820

parent_pipe =

1821

parent_pipe,

1822

proc = proc))

1823

1824

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

1825

proc = None, client_object=None):

1826

condition_names = {

1827

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

1828

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

1829

# blocking).

1830

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

1831

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

1832

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

1833

# broken, usually for pipes and

1834

# sockets).

1835

}

1836

conditions_string = ' | '.join(name

1837

for cond, name in

1838

condition_names.iteritems()

1839

if cond & condition)

2678

1840

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

2679

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

1841

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

2680

1842

# Wait for other process to exit

2681

1843

proc.join()

2682

1844

return False

2683

1845

2684

1846

# Read a request from the child

2685

1847

request = parent_pipe.recv()

2686

1848

command = request[0]

2687

1849

2688

1850

if command == 'init':

2689

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

2690

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

2691

address = request[3]

2692

2693

for c in self.clients.values():

2694

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2695

continue

2696

if key_id and c.key_id == key_id:

2697

client = c

2698

break

2699

if fpr and c.fingerprint == fpr:

1851

fpr = request[1]

1852

address = request[2]

1853

1854

for c in self.clients.itervalues():

1855

if c.fingerprint == fpr:

2700

1856

client = c

2701

1857

break

2702

1858

else:

2703

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

2704

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

1859

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

1860

"dress: %s", fpr, address)

2705

1861

if self.use_dbus:

2706

1862

# Emit D-Bus signal

2707

mandos_dbus_service.ClientNotFound(key_id or fpr,

1863

mandos_dbus_service.ClientNotFound(fpr,

2708

1864

address[0])

2709

1865

parent_pipe.send(False)

2710

1866

return False

2711

2712

GLib.io_add_watch(

2713

parent_pipe.fileno(),

2714

GLib.IO_IN | GLib.IO_HUP,

2715

functools.partial(self.handle_ipc,

2716

parent_pipe=parent_pipe,

2717

proc=proc,

2718

client_object=client))

1867

1868

gobject.io_add_watch(parent_pipe.fileno(),

1869

gobject.IO_IN | gobject.IO_HUP,

1870

functools.partial(self.handle_ipc,

1871

parent_pipe =

1872

parent_pipe,

1873

proc = proc,

1874

client_object =

1875

client))

2719

1876

parent_pipe.send(True)

2720

1877

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

2721

1878

# same fileno

2724

1881

funcname = request[1]

2725

1882

args = request[2]

2726

1883

kwargs = request[3]

2727

1884

2728

1885

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

2729

1886

funcname)(*args,

2730

**kwargs)))

2731

1887

**kwargs)))

1888

2732

1889

if command == 'getattr':

2733

1890

attrname = request[1]

2734

if isinstance(client_object.__getattribute__(attrname),

2735

collections.Callable):

2736

parent_pipe.send(('function', ))

1891

if callable(client_object.__getattribute__(attrname)):

1892

parent_pipe.send(('function',))

2737

1893

else:

2738

parent_pipe.send((

2739

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

2740

1894

parent_pipe.send(('data', client_object

1895

.__getattribute__(attrname)))

1896

2741

1897

if command == 'setattr':

2742

1898

attrname = request[1]

2743

1899

value = request[2]

2744

1900

setattr(client_object, attrname, value)

2745

1901

2746

1902

return True

2747

1903

2748

1904

2749

def rfc3339_duration_to_delta(duration):

2750

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

2751

2752

>>> rfc3339_duration_to_delta("P7D")

2753

datetime.timedelta(7)

2754

>>> rfc3339_duration_to_delta("PT60S")

2755

datetime.timedelta(0, 60)

2756

>>> rfc3339_duration_to_delta("PT60M")

2757

datetime.timedelta(0, 3600)

2758

>>> rfc3339_duration_to_delta("PT24H")

2759

datetime.timedelta(1)

2760

>>> rfc3339_duration_to_delta("P1W")

2761

datetime.timedelta(7)

2762

>>> rfc3339_duration_to_delta("PT5M30S")

2763

datetime.timedelta(0, 330)

2764

>>> rfc3339_duration_to_delta("P1DT3M20S")

2765

datetime.timedelta(1, 200)

2766

"""

2767

2768

# Parsing an RFC 3339 duration with regular expressions is not

2769

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

2770

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

2771

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

2772

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

2773

# avoid excessive use of external libraries.

2774

2775

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

2776

Token = collections.namedtuple("Token", (

2777

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

2778

# a "group" containing digits

2779

"value", # datetime.timedelta or None

2780

"followers")) # Tokens valid after this token

2781

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

2782

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

2783

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

2784

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

2785

datetime.timedelta(seconds=1),

2786

frozenset((token_end, )))

2787

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

2788

datetime.timedelta(minutes=1),

2789

frozenset((token_second, token_end)))

2790

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

2791

datetime.timedelta(hours=1),

2792

frozenset((token_minute, token_end)))

2793

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

2794

None,

2795

frozenset((token_hour, token_minute,

2796

token_second)))

2797

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

2798

datetime.timedelta(days=1),

2799

frozenset((token_time, token_end)))

2800

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

2801

datetime.timedelta(weeks=4),

2802

frozenset((token_day, token_end)))

2803

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

2804

datetime.timedelta(weeks=52),

2805

frozenset((token_month, token_end)))

2806

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

2807

datetime.timedelta(weeks=1),

2808

frozenset((token_end, )))

2809

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

2810

frozenset((token_year, token_month,

2811

token_day, token_time,

2812

token_week)))

2813

# Define starting values:

2814

# Value so far

2815

value = datetime.timedelta()

2816

found_token = None

2817

# Following valid tokens

2818

followers = frozenset((token_duration, ))

2819

# String left to parse

2820

s = duration

2821

# Loop until end token is found

2822

while found_token is not token_end:

2823

# Search for any currently valid tokens

2824

for token in followers:

2825

match = token.regexp.match(s)

2826

if match is not None:

2827

# Token found

2828

if token.value is not None:

2829

# Value found, parse digits

2830

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

2831

# Add to value so far

2832

value += factor * token.value

2833

# Strip token from string

2834

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

2835

# Go to found token

2836

found_token = token

2837

# Set valid next tokens

2838

followers = found_token.followers

2839

break

2840

else:

2841

# No currently valid tokens were found

2842

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

2843

.format(duration))

2844

# End token found

2845

return value

2846

2847

2848

1905

def string_to_delta(interval):

2849

1906

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

2850

1907

2851

1908

>>> string_to_delta('7d')

2852

1909

datetime.timedelta(7)

2853

1910

>>> string_to_delta('60s')

2861

1918

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

2862

1919

datetime.timedelta(0, 330)

2863

1920

"""

2864

2865

try:

2866

return rfc3339_duration_to_delta(interval)

2867

except ValueError:

2868

pass

2869

2870

1921

timevalue = datetime.timedelta(0)

2871

1922

for s in interval.split():

2872

1923

try:

2873

suffix = s[-1]

1924

suffix = unicode(s[-1])

2874

1925

value = int(s[:-1])

2875

1926

if suffix == "d":

2876

1927

delta = datetime.timedelta(value)

2883

1934

elif suffix == "w":

2884

1935

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

2885

1936

else:

2886

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

2887

except IndexError as e:

1937

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

1938

except (ValueError, IndexError) as e:

2888

1939

raise ValueError(*(e.args))

2889

1940

timevalue += delta

2890

1941

return timevalue

2891

1942

2892

1943

2893

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

1944

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

2894

1945

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

2895

1946

2896

1947

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

2897

1948

if os.fork():

2898

1949

sys.exit()

2903

1954

sys.exit()

2904

1955

if not noclose:

2905

1956

# Close all standard open file descriptors

2906

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

1957

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

2907

1958

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

2908

1959

raise OSError(errno.ENODEV,

2909

"{} not a character device"

2910

.format(os.devnull))

1960

"%s not a character device"

1961

% os.path.devnull)

2911

1962

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

2912

1963

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

2913

1964

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

2916

1967

2917

1968

2918

1969

def main():

2919

1970

2920

1971

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

2921

1972

# Parsing of options, both command line and config file

2922

1973

2923

1974

parser = argparse.ArgumentParser()

2924

1975

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

2925

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

1976

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

2926

1977

help="show version number and exit")

2927

1978

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

2928

1979

help="Bind to interface IF")

2934

1985

help="Run self-test")

2935

1986

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

2936

1987

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

2937

" to terminal", default=None)

1988

" to terminal")

2938

1989

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

2939

1990

help="Debug level for stdout output")

2940

1991

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

2947

1998

" files")

2948

1999

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

2949

2000

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

2950

" system bus interface", default=None)

2001

" system bus interface")

2951

2002

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

2952

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

2953

default=None)

2003

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

2954

2004

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

2955

2005

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

2956

" state", default=None)

2957

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

2958

help="Specify a file descriptor to a network"

2959

" socket to use instead of creating one")

2006

" state")

2960

2007

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

2961

2008

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

2962

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

2963

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

2964

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

2965

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

2966

default=None)

2967

2009

2968

2010

options = parser.parse_args()

2969

2011

2970

2012

if options.check:

2971

2013

import doctest

2972

fail_count, test_count = doctest.testmod()

2973

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

2974

2014

doctest.testmod()

2015

sys.exit()

2016

2975

2017

# Default values for config file for server-global settings

2976

if gnutls.has_rawpk:

2977

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

2978

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

2979

else:

2980

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

2981

":+SIGN-DSA-SHA256")

2982

server_defaults = {"interface": "",

2983

"address": "",

2984

"port": "",

2985

"debug": "False",

2986

"priority": priority,

2987

"servicename": "Mandos",

2988

"use_dbus": "True",

2989

"use_ipv6": "True",

2990

"debuglevel": "",

2991

"restore": "True",

2992

"socket": "",

2993

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

2994

"foreground": "False",

2995

"zeroconf": "True",

2996

}

2997

del priority

2998

2018

server_defaults = { "interface": "",

2019

"address": "",

2020

"port": "",

2021

"debug": "False",

2022

"priority":

2023

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

2024

"servicename": "Mandos",

2025

"use_dbus": "True",

2026

"use_ipv6": "True",

2027

"debuglevel": "",

2028

"restore": "True",

2029

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

2030

}

2031

2999

2032

# Parse config file for server-global settings

3000

2033

server_config = configparser.SafeConfigParser(server_defaults)

3001

2034

del server_defaults

3002

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

2035

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

2036

"mandos.conf"))

3003

2037

# Convert the SafeConfigParser object to a dict

3004

2038

server_settings = server_config.defaults()

3005

2039

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

3006

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

3007

"foreground", "zeroconf"):

2040

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

3008

2041

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

3009

2042

option)

3010

2043

if server_settings["port"]:

3011

2044

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

3012

2045

"port")

3013

if server_settings["socket"]:

3014

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

3015

"socket")

3016

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

3017

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

3018

# happen with a supplied network socket.

3019

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

3020

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

3021

["socket"])

3022

2046

del server_config

3023

2047

3024

2048

# Override the settings from the config file with command line

3025

2049

# options, if set.

3026

2050

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

3027

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

3028

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

3029

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

2051

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

2052

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

2053

"statedir"):

3030

2054

value = getattr(options, option)

3031

2055

if value is not None:

3032

2056

server_settings[option] = value

3033

2057

del options

3034

2058

# Force all strings to be unicode

3035

2059

for option in server_settings.keys():

3036

if isinstance(server_settings[option], bytes):

3037

server_settings[option] = (server_settings[option]

3038

.decode("utf-8"))

3039

# Force all boolean options to be boolean

3040

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

3041

"foreground", "zeroconf"):

3042

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

3043

# Debug implies foreground

3044

if server_settings["debug"]:

3045

server_settings["foreground"] = True

2060

if type(server_settings[option]) is str:

2061

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

3046

2062

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

3047

2063

3048

2064

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

3049

3050

if (not server_settings["zeroconf"]

3051

and not (server_settings["port"]

3052

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

3053

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

3054

2065

3055

2066

# For convenience

3056

2067

debug = server_settings["debug"]

3057

2068

debuglevel = server_settings["debuglevel"]

3059

2070

use_ipv6 = server_settings["use_ipv6"]

3060

2071

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

3061

2072

stored_state_file)

3062

foreground = server_settings["foreground"]

3063

zeroconf = server_settings["zeroconf"]

3064

2073

3065

2074

if debug:

3066

2075

initlogger(debug, logging.DEBUG)

3067

2076

else:

3070

2079

else:

3071

2080

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

3072

2081

initlogger(debug, level)

3073

2082

3074

2083

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

3075

syslogger.setFormatter(

3076

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

3077

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

3078

server_settings["servicename"])))

3079

2084

syslogger.setFormatter(logging.Formatter

2085

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

2086

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

2087

% server_settings["servicename"]))

2088

3080

2089

# Parse config file with clients

3081

2090

client_config = configparser.SafeConfigParser(Client

3082

2091

.client_defaults)

3083

2092

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

3084

2093

"clients.conf"))

3085

2094

3086

2095

global mandos_dbus_service

3087

2096

mandos_dbus_service = None

3088

3089

socketfd = None

3090

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

3091

socketfd = server_settings["socket"]

3092

tcp_server = MandosServer(

3093

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

3094

ClientHandler,

3095

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

3096

use_ipv6=use_ipv6,

3097

gnutls_priority=server_settings["priority"],

3098

use_dbus=use_dbus,

3099

socketfd=socketfd)

3100

if not foreground:

3101

pidfilename = "/run/mandos.pid"

3102

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

3103

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

3104

pidfile = None

3105

try:

3106

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

3107

except IOError as e:

3108

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

3109

exc_info=e)

3110

3111

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

3112

("mandos", "mandos"),

3113

("nobody", "nogroup")):

3114

try:

3115

uid = pwd.getpwnam(name).pw_uid

3116

gid = pwd.getpwnam(group).pw_gid

3117

break

2097

2098

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

2099

server_settings["port"]),

2100

ClientHandler,

2101

interface=(server_settings["interface"]

2102

or None),

2103

use_ipv6=use_ipv6,

2104

gnutls_priority=

2105

server_settings["priority"],

2106

use_dbus=use_dbus)

2107

if not debug:

2108

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

2109

try:

2110

pidfile = open(pidfilename, "w")

2111

except IOError:

2112

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

2113

2114

try:

2115

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

2116

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

2117

except KeyError:

2118

try:

2119

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

2120

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

3118

2121

except KeyError:

3119

continue

3120

else:

3121

uid = 65534

3122

gid = 65534

2122

try:

2123

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

2124

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

2125

except KeyError:

2126

uid = 65534

2127

gid = 65534

3123

2128

try:

3124

2129

os.setgid(gid)

3125

2130

os.setuid(uid)

3126

if debug:

3127

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

3128

gid))

3129

2131

except OSError as error:

3130

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

3131

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

3132

if error.errno != errno.EPERM:

3133

raise

3134

2132

if error[0] != errno.EPERM:

2133

raise error

2134

3135

2135

if debug:

3136

2136

# Enable all possible GnuTLS debugging

3137

2137

3138

2138

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

3139

2139

# - GnuTLS manual

3140

gnutls.global_set_log_level(11)

3141

3142

@gnutls.log_func

2140

gnutls.library.functions.gnutls_global_set_log_level(11)

2141

2142

@gnutls.library.types.gnutls_log_func

3143

2143

def debug_gnutls(level, string):

3144

2144

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

3145

3146

gnutls.global_set_log_function(debug_gnutls)

3147

2145

2146

(gnutls.library.functions

2147

.gnutls_global_set_log_function(debug_gnutls))

2148

3148

2149

# Redirect stdin so all checkers get /dev/null

3149

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

2150

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

3150

2151

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

3151

2152

if null > 2:

3152

2153

os.close(null)

3153

2154

3154

2155

# Need to fork before connecting to D-Bus

3155

if not foreground:

2156

if not debug:

3156

2157

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

3157

2158

daemon()

3158

3159

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

3160

# to inform GLib that threads will be used.

3161

GLib.threads_init()

3162

2159

2160

gobject.threads_init()

2161

3163

2162

global main_loop

3164

2163

# From the Avahi example code

3165

DBusGMainLoop(set_as_default=True)

3166

main_loop = GLib.MainLoop()

2164

DBusGMainLoop(set_as_default=True )

2165

main_loop = gobject.MainLoop()

3167

2166

bus = dbus.SystemBus()

3168

2167

# End of Avahi example code

3169

2168

if use_dbus:

3170

2169

try:

3171

2170

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

3172

bus,

3173

do_not_queue=True)

3174

old_bus_name = dbus.service.BusName(

3175

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

3176

do_not_queue=True)

3177

except dbus.exceptions.DBusException as e:

3178

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

2171

bus, do_not_queue=True)

2172

old_bus_name = (dbus.service.BusName

2173

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

2174

do_not_queue=True))

2175

except dbus.exceptions.NameExistsException as e:

2176

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

3179

2177

use_dbus = False

3180

2178

server_settings["use_dbus"] = False

3181

2179

tcp_server.use_dbus = False

3182

if zeroconf:

3183

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3184

service = AvahiServiceToSyslog(

3185

name=server_settings["servicename"],

3186

servicetype="_mandos._tcp",

3187

protocol=protocol,

3188

bus=bus)

3189

if server_settings["interface"]:

3190

service.interface = if_nametoindex(

3191

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

3192

2180

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2181

service = AvahiServiceToSyslog(name =

2182

server_settings["servicename"],

2183

servicetype = "_mandos._tcp",

2184

protocol = protocol, bus = bus)

2185

if server_settings["interface"]:

2186

service.interface = (if_nametoindex

2187

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

2188

3193

2189

global multiprocessing_manager

3194

2190

multiprocessing_manager = multiprocessing.Manager()

3195

2191

3196

2192

client_class = Client

3197

2193

if use_dbus:

3198

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

3199

2194

client_class = functools.partial(ClientDBusTransitional,

2195

bus = bus)

2196

3200

2197

client_settings = Client.config_parser(client_config)

3201

2198

old_client_settings = {}

3202

2199

clients_data = {}

3203

3204

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

3205

global wnull

3206

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

3207

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

3208

# mode

3209

if debug or not foreground:

3210

wnull.close()

3211

2200

3212

2201

# Get client data and settings from last running state.

3213

2202

if server_settings["restore"]:

3214

2203

try:

3215

2204

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

3216

if sys.version_info.major == 2:

3217

clients_data, old_client_settings = pickle.load(

3218

stored_state)

3219

else:

3220

bytes_clients_data, bytes_old_client_settings = (

3221

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

3222

# Fix bytes to strings

3223

# clients_data

3224

# .keys()

3225

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

3226

if isinstance(key, bytes)

3227

else key): value

3228

for key, value in

3229

bytes_clients_data.items()}

3230

del bytes_clients_data

3231

for key in clients_data:

3232

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

3233

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

3234

for k, v in

3235

clients_data[key].items()}

3236

clients_data[key] = value

3237

# .client_structure

3238

value["client_structure"] = [

3239

(s.decode("utf-8")

3240

if isinstance(s, bytes)

3241

else s) for s in

3242

value["client_structure"]]

3243

# .name & .host

3244

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

3245

if isinstance(value[k], bytes):

3246

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

3247

if not value.has_key("key_id"):

3248

value["key_id"] = ""

3249

elif not value.has_key("fingerprint"):

3250

value["fingerprint"] = ""

3251

# old_client_settings

3252

# .keys()

3253

old_client_settings = {

3254

(key.decode("utf-8")

3255

if isinstance(key, bytes)

3256

else key): value

3257

for key, value in

3258

bytes_old_client_settings.items()}

3259

del bytes_old_client_settings

3260

# .host

3261

for value in old_client_settings.values():

3262

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

3263

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

3264

.decode("utf-8"))

2205

clients_data, old_client_settings = (pickle.load

2206

(stored_state))

3265

2207

os.remove(stored_state_path)

3266

2208

except IOError as e:

3267

if e.errno == errno.ENOENT:

3268

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

3269

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

3270

else:

3271

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

3272

exc_info=e)

2209

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

2210

.format(e))

2211

if e.errno != errno.ENOENT:

3273

2212

raise

3274

2213

except EOFError as e:

3275

2214

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

3276

"EOFError:",

3277

exc_info=e)

3278

2215

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

2216

3279

2217

with PGPEngine() as pgp:

3280

for client_name, client in clients_data.items():

3281

# Skip removed clients

3282

if client_name not in client_settings:

3283

continue

3284

2218

for client_name, client in clients_data.iteritems():

3285

2219

# Decide which value to use after restoring saved state.

3286

2220

# We have three different values: Old config file,

3287

2221

# new config file, and saved state.

3292

2226

# For each value in new config, check if it

3293

2227

# differs from the old config value (Except for

3294

2228

# the "secret" attribute)

3295

if (name != "secret"

3296

and (value !=

3297

old_client_settings[client_name][name])):

2229

if (name != "secret" and

2230

value != old_client_settings[client_name]

2231

[name]):

3298

2232

client[name] = value

3299

2233

except KeyError:

3300

2234

pass

3301

2235

3302

2236

# Clients who has passed its expire date can still be

3303

# enabled if its last checker was successful. A Client

2237

# enabled if its last checker was successful. Clients

3304

2238

# whose checker succeeded before we stored its state is

3305

2239

# assumed to have successfully run all checkers during

3306

2240

# downtime.

3308

2242

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

3309

2243

if not client["last_checked_ok"]:

3310

2244

logger.warning(

3311

"disabling client {} - Client never "

3312

"performed a successful checker".format(

3313

client_name))

2245

"disabling client {0} - Client never "

2246

"performed a successful checker"

2247

.format(client_name))

3314

2248

client["enabled"] = False

3315

2249

elif client["last_checker_status"] != 0:

3316

2250

logger.warning(

3317

"disabling client {} - Client last"

3318

" checker failed with error code"

3319

" {}".format(

3320

client_name,

3321

client["last_checker_status"]))

2251

"disabling client {0} - Client "

2252

"last checker failed with error code {1}"

2253

.format(client_name,

2254

client["last_checker_status"]))

3322

2255

client["enabled"] = False

3323

2256

else:

3324

client["expires"] = (

3325

datetime.datetime.utcnow()

3326

+ client["timeout"])

2257

client["expires"] = (datetime.datetime

2258

.utcnow()

2259

+ client["timeout"])

3327

2260

logger.debug("Last checker succeeded,"

3328

" keeping {} enabled".format(

3329

client_name))

2261

" keeping {0} enabled"

2262

.format(client_name))

3330

2263

try:

3331

client["secret"] = pgp.decrypt(

3332

client["encrypted_secret"],

3333

client_settings[client_name]["secret"])

2264

client["secret"] = (

2265

pgp.decrypt(client["encrypted_secret"],

2266

client_settings[client_name]

2267

["secret"]))

3334

2268

except PGPError:

3335

2269

# If decryption fails, we use secret from new settings

3336

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

3337

client_name))

3338

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

3339

["secret"])

2270

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

2271

.format(client_name))

2272

client["secret"] = (

2273

client_settings[client_name]["secret"])

3340

2274

2275

3341

2276

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

3342

2277

for client_name in (set(old_client_settings)

3343

2278

- set(client_settings)):

3347

2282

clients_data[client_name] = client_settings[client_name]

3348

2283

3349

2284

# Create all client objects

3350

for client_name, client in clients_data.items():

2285

for client_name, client in clients_data.iteritems():

3351

2286

tcp_server.clients[client_name] = client_class(

3352

name=client_name,

3353

settings=client,

3354

server_settings=server_settings)

3355

2287

name = client_name, settings = client)

2288

3356

2289

if not tcp_server.clients:

3357

2290

logger.warning("No clients defined")

3358

3359

if not foreground:

3360

if pidfile is not None:

3361

pid = os.getpid()

3362

try:

3363

with pidfile:

3364

print(pid, file=pidfile)

3365

except IOError:

3366

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

3367

pidfilename, pid)

3368

del pidfile

2291

2292

if not debug:

2293

try:

2294

with pidfile:

2295

pid = os.getpid()

2296

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

2297

del pidfile

2298

except IOError:

2299

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

2300

pidfilename, pid)

2301

except NameError:

2302

# "pidfile" was never created

2303

pass

3369

2304

del pidfilename

3370

3371

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

3372

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3373

lambda: main_loop.quit() and False)

3374

2305

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

2306

2307

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

2308

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

2309

3375

2310

if use_dbus:

3376

3377

@alternate_dbus_interfaces(

3378

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

3379

class MandosDBusService(DBusObjectWithObjectManager):

2311

class MandosDBusService(dbus.service.Object):

3380

2312

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

3381

3382

2313

def __init__(self):

3383

2314

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

3384

3385

2315

_interface = "se.recompile.Mandos"

3386

2316

3387

2317

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

3388

2318

def ClientAdded(self, objpath):

3389

2319

"D-Bus signal"

3390

2320

pass

3391

2321

3392

2322

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

3393

def ClientNotFound(self, key_id, address):

2323

def ClientNotFound(self, fingerprint, address):

3394

2324

"D-Bus signal"

3395

2325

pass

3396

3397

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

3398

"true"})

2326

3399

2327

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

3400

2328

def ClientRemoved(self, objpath, name):

3401

2329

"D-Bus signal"

3402

2330

pass

3403

3404

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

3405

"true"})

2331

3406

2332

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

3407

2333

def GetAllClients(self):

3408

2334

"D-Bus method"

3409

return dbus.Array(c.dbus_object_path for c in

3410

tcp_server.clients.values())

3411

3412

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

3413

"true"})

2335

return dbus.Array(c.dbus_object_path

2336

for c in

2337

tcp_server.clients.itervalues())

2338

3414

2339

@dbus.service.method(_interface,

3415

2340

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

3416

2341

def GetAllClientsWithProperties(self):

3417

2342

"D-Bus method"

3418

2343

return dbus.Dictionary(

3419

{c.dbus_object_path: c.GetAll(

3420

"se.recompile.Mandos.Client")

3421

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

2344

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

2345

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

3422

2346

signature="oa{sv}")

3423

2347

3424

2348

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

3425

2349

def RemoveClient(self, object_path):

3426

2350

"D-Bus method"

3427

for c in tcp_server.clients.values():

2351

for c in tcp_server.clients.itervalues():

3428

2352

if c.dbus_object_path == object_path:

3429

2353

del tcp_server.clients[c.name]

3430

2354

c.remove_from_connection()

3431

# Don't signal the disabling

2355

# Don't signal anything except ClientRemoved

3432

2356

c.disable(quiet=True)

3433

# Emit D-Bus signal for removal

3434

self.client_removed_signal(c)

2357

# Emit D-Bus signal

2358

self.ClientRemoved(object_path, c.name)

3435

2359

return

3436

2360

raise KeyError(object_path)

3437

2361

3438

2362

del _interface

3439

3440

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3441

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

3442

def GetManagedObjects(self):

3443

"""D-Bus method"""

3444

return dbus.Dictionary(

3445

{client.dbus_object_path:

3446

dbus.Dictionary(

3447

{interface: client.GetAll(interface)

3448

for interface in

3449

client._get_all_interface_names()})

3450

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

3451

3452

def client_added_signal(self, client):

3453

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

3454

if use_dbus:

3455

# New standard signal

3456

self.InterfacesAdded(

3457

client.dbus_object_path,

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()}))

3462

# Old signal

3463

self.ClientAdded(client.dbus_object_path)

3464

3465

def client_removed_signal(self, client):

3466

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

3467

if use_dbus:

3468

# New standard signal

3469

self.InterfacesRemoved(

3470

client.dbus_object_path,

3471

client._get_all_interface_names())

3472

# Old signal

3473

self.ClientRemoved(client.dbus_object_path,

3474

client.name)

3475

3476

mandos_dbus_service = MandosDBusService()

3477

3478

# Save modules to variables to exempt the modules from being

3479

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

3480

mp = multiprocessing

3481

wn = wnull

3482

2363

2364

class MandosDBusServiceTransitional(MandosDBusService):

2365

__metaclass__ = AlternateDBusNamesMetaclass

2366

mandos_dbus_service = MandosDBusServiceTransitional()

2367

3483

2368

def cleanup():

3484

2369

"Cleanup function; run on exit"

3485

if zeroconf:

3486

service.cleanup()

3487

3488

mp.active_children()

3489

wn.close()

2370

service.cleanup()

2371

2372

multiprocessing.active_children()

3490

2373

if not (tcp_server.clients or client_settings):

3491

2374

return

3492

2375

3493

2376

# Store client before exiting. Secrets are encrypted with key

3494

2377

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

3495

2378

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

3496

2379

clients = {}

3497

2380

with PGPEngine() as pgp:

3498

for client in tcp_server.clients.values():

2381

for client in tcp_server.clients.itervalues():

3499

2382

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

3500

2383

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

3501

2384

key)

3502

2385

client_dict = {}

3503

2386

3504

2387

# A list of attributes that can not be pickled

3505

2388

# + secret.

3506

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

3507

"checker", "server_settings"}

3508

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

3509

.Object):

2389

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

2390

"checker"))

2391

for name, typ in (inspect.getmembers

2392

(dbus.service.Object)):

3510

2393

exclude.add(name)

3511

2394

3512

2395

client_dict["encrypted_secret"] = (client

3513

2396

.encrypted_secret)

3514

2397

for attr in client.client_structure:

3515

2398

if attr not in exclude:

3516

2399

client_dict[attr] = getattr(client, attr)

3517

2400

3518

2401

clients[client.name] = client_dict

3519

2402

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

3520

2403

3521

2404

try:

3522

with tempfile.NamedTemporaryFile(

3523

mode='wb',

3524

suffix=".pickle",

3525

prefix='clients-',

3526

dir=os.path.dirname(stored_state_path),

3527

delete=False) as stored_state:

3528

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

3529

protocol=2)

3530

tempname = stored_state.name

2405

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

2406

prefix="clients-",

2407

dir=os.path.dirname

2408

(stored_state_path))

2409

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

2410

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

3531

2411

os.rename(tempname, stored_state_path)

3532

2412

except (IOError, OSError) as e:

2413

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

2414

.format(e))

3533

2415

if not debug:

3534

2416

try:

3535

2417

os.remove(tempname)

3536

2418

except NameError:

3537

2419

pass

3538

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

3539

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

3540

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

3541

else:

3542

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

3543

exc_info=e)

3544

raise

3545

2420

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

2421

errno.EEXIST)):

2422

raise e

2423

3546

2424

# Delete all clients, and settings from config

3547

2425

while tcp_server.clients:

3548

2426

name, client = tcp_server.clients.popitem()

3549

2427

if use_dbus:

3550

2428

client.remove_from_connection()

3551

# Don't signal the disabling

2429

# Don't signal anything except ClientRemoved

3552

2430

client.disable(quiet=True)

3553

# Emit D-Bus signal for removal

3554

2431

if use_dbus:

3555

mandos_dbus_service.client_removed_signal(client)

2432

# Emit D-Bus signal

2433

mandos_dbus_service.ClientRemoved(client

2434

.dbus_object_path,

2435

client.name)

3556

2436

client_settings.clear()

3557

2437

3558

2438

atexit.register(cleanup)

3559

3560

for client in tcp_server.clients.values():

2439

2440

for client in tcp_server.clients.itervalues():

3561

2441

if use_dbus:

3562

# Emit D-Bus signal for adding

3563

mandos_dbus_service.client_added_signal(client)

2442

# Emit D-Bus signal

2443

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3564

2444

# Need to initiate checking of clients

3565

2445

if client.enabled:

3566

2446

client.init_checker()

3567

2447

3568

2448

tcp_server.enable()

3569

2449

tcp_server.server_activate()

3570

2450

3571

2451

# Find out what port we got

3572

if zeroconf:

3573

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

2452

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

3574

2453

if use_ipv6:

3575

2454

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

3576

" flowinfo %d, scope_id %d",

3577

*tcp_server.socket.getsockname())

2455

" flowinfo %d, scope_id %d"

2456

% tcp_server.socket.getsockname())

3578

2457

else: # IPv4

3579

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

3580

*tcp_server.socket.getsockname())

3581

3582

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

3583

2458

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

2459

% tcp_server.socket.getsockname())

2460

2461

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

2462

3584

2463

try:

3585

if zeroconf:

3586

# From the Avahi example code

3587

try:

3588

service.activate()

3589

except dbus.exceptions.DBusException as error:

3590

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

3591

cleanup()

3592

sys.exit(1)

3593

# End of Avahi example code

3594

3595

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

3596

lambda *args, **kwargs:

3597

(tcp_server.handle_request

3598

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

3599

2464

# From the Avahi example code

2465

try:

2466

service.activate()

2467

except dbus.exceptions.DBusException as error:

2468

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

2469

cleanup()

2470

sys.exit(1)

2471

# End of Avahi example code

2472

2473

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

2474

lambda *args, **kwargs:

2475

(tcp_server.handle_request

2476

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

2477

3600

2478

logger.debug("Starting main loop")

3601

2479

main_loop.run()

3602

2480

except AvahiError as error:

3603

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

2481

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

3604

2482

cleanup()

3605

2483

sys.exit(1)

3606

2484

except KeyboardInterrupt:

3611

2489

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

3612

2490

cleanup()

3613

2491

3614

3615

2492

if __name__ == '__main__':

3616

2493

main()