/mandos/release : revision 237.7.559

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

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

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

186

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

143

198

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

199

'--homedir', self.tempdir,

145

200

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

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

149

206

def __enter__(self):

150

207

return self

151

208

152

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

175

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

176

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

177

240

def encrypt(self, data, password):

178

241

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

181

244

passfile.write(passphrase)

182

245

passfile.flush()

183

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

246

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

184

247

'--passphrase-file',

185

248

passfile.name]

186

249

+ self.gnupgargs,

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

191

254

if proc.returncode != 0:

192

255

raise PGPError(err)

193

256

return ciphertext

194

257

195

258

def decrypt(self, data, password):

196

259

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

199

262

passfile.write(passphrase)

200

263

passfile.flush()

201

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

264

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

202

265

'--passphrase-file',

203

266

passfile.name]

204

267

+ self.gnupgargs,

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

210

272

if proc.returncode != 0:

211

273

raise PGPError(err)

212

274

return decrypted_plaintext

213

275

214

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

215

304

class AvahiError(Exception):

216

305

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

217

306

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

307

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

308

**kwargs)

309

221

310

222

311

class AvahiServiceError(AvahiError):

223

312

pass

224

313

314

225

315

class AvahiGroupError(AvahiError):

226

316

pass

227

317

228

318

229

319

class AvahiService(object):

230

320

"""An Avahi (Zeroconf) service.

231

321

232

322

Attributes:

233

323

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

234

324

Used to optionally bind to the specified interface.

246

336

server: D-Bus Server

247

337

bus: dbus.SystemBus()

248

338

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

254

351

self.interface = interface

255

352

self.name = name

256

353

self.type = servicetype

265

362

self.server = None

266

363

self.bus = bus

267

364

self.entry_group_state_changed_match = None

268

269

def rename(self):

365

366

def rename(self, remove=True):

270

367

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

271

368

if self.rename_count >= self.max_renames:

272

369

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

273

370

" after %i retries, exiting.",

274

371

self.rename_count)

275

372

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

278

376

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

279

377

self.name)

280

self.remove()

378

if remove:

379

self.remove()

281

380

try:

282

381

self.add()

283

382

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

289

392

def remove(self):

290

393

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

291

394

if self.entry_group_state_changed_match is not None:

293

396

self.entry_group_state_changed_match = None

294

397

if self.group is not None:

295

398

self.group.Reset()

296

399

297

400

def add(self):

298

401

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

299

402

self.remove()

316

419

dbus.UInt16(self.port),

317

420

avahi.string_array_to_txt_array(self.TXT))

318

421

self.group.Commit()

319

422

320

423

def entry_group_state_changed(self, state, error):

321

424

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

322

425

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

323

426

324

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

428

logger.debug("Zeroconf service established.")

326

429

elif state == avahi.ENTRY_GROUP_COLLISION:

328

431

self.rename()

329

432

elif state == avahi.ENTRY_GROUP_FAILURE:

330

433

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

331

unicode(error))

332

raise AvahiGroupError("State changed: {0!s}"

333

.format(error))

334

434

str(error))

435

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

436

335

437

def cleanup(self):

336

438

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

337

439

if self.group is not None:

342

444

pass

343

445

self.group = None

344

446

self.remove()

345

447

346

448

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

347

449

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

348

450

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

356

457

if state in bad_states:

357

458

if bad_states[state] is not None:

358

459

if error is None:

361

462

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

362

463

self.cleanup()

363

464

elif state == avahi.SERVER_RUNNING:

364

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

365

477

else:

366

478

if error is None:

367

479

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

368

480

else:

369

481

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

370

482

371

483

def activate(self):

372

484

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

373

485

if self.server is None:

377

489

follow_name_owner_changes=True),

378

490

avahi.DBUS_INTERFACE_SERVER)

379

491

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

492

self.server_state_changed)

381

493

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

382

494

383

495

384

496

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

497

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

386

498

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

('Mandos ({0}) [%(process)d]:'

390

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

391

.format(self.name)))

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

392

503

return ret

393

504

394

505

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

_tls_rawpk_version = b"3.6.6"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CRT_RAWPK = 3

535

CLIENT = 2

536

SHUT_RDWR = 0

537

CRD_CERTIFICATE = 1

538

E_NO_CERTIFICATE_FOUND = -49

539

X509_FMT_DER = 0

540

NO_TICKETS = 1<<10

541

ENABLE_RAWPK = 1<<18

542

CTYPE_PEERS = 3

543

KEYID_USE_SHA256 = 1 # gnutls/x509.h

544

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

545

546

# Types

547

class session_int(ctypes.Structure):

548

_fields_ = []

549

session_t = ctypes.POINTER(session_int)

550

551

class certificate_credentials_st(ctypes.Structure):

552

_fields_ = []

553

certificate_credentials_t = ctypes.POINTER(

554

certificate_credentials_st)

555

certificate_type_t = ctypes.c_int

556

557

class datum_t(ctypes.Structure):

558

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

559

('size', ctypes.c_uint)]

560

561

class openpgp_crt_int(ctypes.Structure):

562

_fields_ = []

563

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

564

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

565

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

566

credentials_type_t = ctypes.c_int

567

transport_ptr_t = ctypes.c_void_p

568

close_request_t = ctypes.c_int

569

570

# Exceptions

571

class Error(Exception):

572

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

573

# exception might be raised from within GnuTLS.__init__,

574

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

575

# global variable has happened.

576

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

577

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

578

# code is passed, convert it to a string with

579

# gnutls.strerror()

580

self.code = code

581

if message is None and code is not None:

582

message = GnuTLS.strerror(code)

583

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

584

message, *args)

585

586

class CertificateSecurityError(Error):

587

pass

588

589

# Classes

590

class Credentials(object):

591

def __init__(self):

592

self._c_object = gnutls.certificate_credentials_t()

593

gnutls.certificate_allocate_credentials(

594

ctypes.byref(self._c_object))

595

self.type = gnutls.CRD_CERTIFICATE

596

597

def __del__(self):

598

gnutls.certificate_free_credentials(self._c_object)

599

600

class ClientSession(object):

601

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

602

self._c_object = gnutls.session_t()

603

gnutls_flags = gnutls.CLIENT

604

if gnutls.check_version("3.5.6"):

605

gnutls_flags |= gnutls.NO_TICKETS

606

if gnutls.has_rawpk:

607

gnutls_flags |= gnutls.ENABLE_RAWPK

608

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

609

del gnutls_flags

610

gnutls.set_default_priority(self._c_object)

611

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

612

gnutls.handshake_set_private_extensions(self._c_object,

613

True)

614

self.socket = socket

615

if credentials is None:

616

credentials = gnutls.Credentials()

617

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

618

ctypes.cast(credentials._c_object,

619

ctypes.c_void_p))

620

self.credentials = credentials

621

622

def __del__(self):

623

gnutls.deinit(self._c_object)

624

625

def handshake(self):

626

return gnutls.handshake(self._c_object)

627

628

def send(self, data):

629

data = bytes(data)

630

data_len = len(data)

631

while data_len > 0:

632

data_len -= gnutls.record_send(self._c_object,

633

data[-data_len:],

634

data_len)

635

636

def bye(self):

637

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

638

639

# Error handling functions

640

def _error_code(result):

641

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

642

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

643

if result >= 0:

644

return result

645

if result == gnutls.E_NO_CERTIFICATE_FOUND:

646

raise gnutls.CertificateSecurityError(code=result)

647

raise gnutls.Error(code=result)

648

649

def _retry_on_error(result, func, arguments):

650

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

651

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

652

while result < 0:

653

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

654

return _error_code(result)

655

result = func(*arguments)

656

return result

657

658

# Unless otherwise indicated, the function declarations below are

659

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

660

661

# Functions

662

priority_set_direct = _library.gnutls_priority_set_direct

663

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

664

ctypes.POINTER(ctypes.c_char_p)]

665

priority_set_direct.restype = _error_code

666

667

init = _library.gnutls_init

668

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

669

init.restype = _error_code

670

671

set_default_priority = _library.gnutls_set_default_priority

672

set_default_priority.argtypes = [session_t]

673

set_default_priority.restype = _error_code

674

675

record_send = _library.gnutls_record_send

676

record_send.argtypes = [session_t, ctypes.c_void_p,

677

ctypes.c_size_t]

678

record_send.restype = ctypes.c_ssize_t

679

record_send.errcheck = _retry_on_error

680

681

certificate_allocate_credentials = (

682

_library.gnutls_certificate_allocate_credentials)

683

certificate_allocate_credentials.argtypes = [

684

ctypes.POINTER(certificate_credentials_t)]

685

certificate_allocate_credentials.restype = _error_code

686

687

certificate_free_credentials = (

688

_library.gnutls_certificate_free_credentials)

689

certificate_free_credentials.argtypes = [

690

certificate_credentials_t]

691

certificate_free_credentials.restype = None

692

693

handshake_set_private_extensions = (

694

_library.gnutls_handshake_set_private_extensions)

695

handshake_set_private_extensions.argtypes = [session_t,

696

ctypes.c_int]

697

handshake_set_private_extensions.restype = None

698

699

credentials_set = _library.gnutls_credentials_set

700

credentials_set.argtypes = [session_t, credentials_type_t,

701

ctypes.c_void_p]

702

credentials_set.restype = _error_code

703

704

strerror = _library.gnutls_strerror

705

strerror.argtypes = [ctypes.c_int]

706

strerror.restype = ctypes.c_char_p

707

708

certificate_type_get = _library.gnutls_certificate_type_get

709

certificate_type_get.argtypes = [session_t]

710

certificate_type_get.restype = _error_code

711

712

certificate_get_peers = _library.gnutls_certificate_get_peers

713

certificate_get_peers.argtypes = [session_t,

714

ctypes.POINTER(ctypes.c_uint)]

715

certificate_get_peers.restype = ctypes.POINTER(datum_t)

716

717

global_set_log_level = _library.gnutls_global_set_log_level

718

global_set_log_level.argtypes = [ctypes.c_int]

719

global_set_log_level.restype = None

720

721

global_set_log_function = _library.gnutls_global_set_log_function

722

global_set_log_function.argtypes = [log_func]

723

global_set_log_function.restype = None

724

725

deinit = _library.gnutls_deinit

726

deinit.argtypes = [session_t]

727

deinit.restype = None

728

729

handshake = _library.gnutls_handshake

730

handshake.argtypes = [session_t]

731

handshake.restype = _error_code

732

handshake.errcheck = _retry_on_error

733

734

transport_set_ptr = _library.gnutls_transport_set_ptr

735

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

736

transport_set_ptr.restype = None

737

738

bye = _library.gnutls_bye

739

bye.argtypes = [session_t, close_request_t]

740

bye.restype = _error_code

741

bye.errcheck = _retry_on_error

742

743

check_version = _library.gnutls_check_version

744

check_version.argtypes = [ctypes.c_char_p]

745

check_version.restype = ctypes.c_char_p

746

747

has_rawpk = bool(check_version(_tls_rawpk_version))

748

749

if has_rawpk:

750

# Types

751

class pubkey_st(ctypes.Structure):

752

_fields = []

753

pubkey_t = ctypes.POINTER(pubkey_st)

754

755

x509_crt_fmt_t = ctypes.c_int

756

757

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

758

pubkey_init = _library.gnutls_pubkey_init

759

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

760

pubkey_init.restype = _error_code

761

762

pubkey_import = _library.gnutls_pubkey_import

763

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

764

x509_crt_fmt_t]

765

pubkey_import.restype = _error_code

766

767

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

768

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

769

ctypes.POINTER(ctypes.c_ubyte),

770

ctypes.POINTER(ctypes.c_size_t)]

771

pubkey_get_key_id.restype = _error_code

772

773

pubkey_deinit = _library.gnutls_pubkey_deinit

774

pubkey_deinit.argtypes = [pubkey_t]

775

pubkey_deinit.restype = None

776

else:

777

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

778

779

openpgp_crt_init = _library.gnutls_openpgp_crt_init

780

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

781

openpgp_crt_init.restype = _error_code

782

783

openpgp_crt_import = _library.gnutls_openpgp_crt_import

784

openpgp_crt_import.argtypes = [openpgp_crt_t,

785

ctypes.POINTER(datum_t),

786

openpgp_crt_fmt_t]

787

openpgp_crt_import.restype = _error_code

788

789

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

790

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

791

ctypes.POINTER(ctypes.c_uint)]

792

openpgp_crt_verify_self.restype = _error_code

793

794

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

795

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

796

openpgp_crt_deinit.restype = None

797

798

openpgp_crt_get_fingerprint = (

799

_library.gnutls_openpgp_crt_get_fingerprint)

800

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

801

ctypes.c_void_p,

802

ctypes.POINTER(

803

ctypes.c_size_t)]

804

openpgp_crt_get_fingerprint.restype = _error_code

805

806

if check_version("3.6.4"):

807

certificate_type_get2 = _library.gnutls_certificate_type_get2

808

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

809

certificate_type_get2.restype = _error_code

810

811

# Remove non-public functions

812

del _error_code, _retry_on_error

813

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

814

gnutls = GnuTLS()

815

816

817

def call_pipe(connection, # : multiprocessing.Connection

818

func, *args, **kwargs):

819

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

820

821

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

822

return value on the provided multiprocessing.Connection.

823

"""

824

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

825

connection.close()

400

826

401

827

402

828

class Client(object):

403

829

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

404

830

405

831

Attributes:

406

832

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

407

833

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

409

835

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

410

836

to see if the client lives.

411

837

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

838

checker_callback_tag: a GLib event source tag, or None

413

839

checker_command: string; External command which is run to check

414

840

if client lives. %() expansions are done at

415

841

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

416

842

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

417

checker_initiator_tag: a gobject event source tag, or None

843

checker_initiator_tag: a GLib event source tag, or None

418

844

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

419

845

client_structure: Object describing what attributes a client has

420

846

and is used for storing the client at exit

421

847

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

848

disable_initiator_tag: a GLib event source tag, or None

423

849

enabled: bool()

424

850

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

425

uniquely identify the client

851

uniquely identify an OpenPGP client

852

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

853

a client using raw public keys

426

854

host: string; available for use by the checker command

427

855

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

428

856

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

430

858

last_checker_status: integer between 0 and 255 reflecting exit

431

859

status of last checker. -1 reflects crashed

432

860

checker, -2 means no checker completed yet.

861

last_checker_signal: The signal which killed the last checker, if

862

last_checker_status is -1

433

863

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

434

864

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

435

865

D-Bus identifiers

440

870

runtime_expansions: Allowed attributes for runtime expansion.

441

871

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

442

872

disabled, or None

873

server_settings: The server_settings dict from main()

443

874

"""

444

875

445

876

runtime_expansions = ("approval_delay", "approval_duration",

446

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

877

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

447

878

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

448

879

"last_approval_request", "last_checked_ok",

449

880

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

881

client_defaults = {

882

"timeout": "PT5M",

883

"extended_timeout": "PT15M",

884

"interval": "PT2M",

885

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

886

"host": "",

887

"approval_delay": "PT0S",

888

"approval_duration": "PT1S",

889

"approved_by_default": "True",

890

"enabled": "True",

891

}

892

476

893

@staticmethod

477

894

def config_parser(config):

478

895

"""Construct a new dict of client settings of this form:

485

902

for client_name in config.sections():

486

903

section = dict(config.items(client_name))

487

904

client = settings[client_name] = {}

488

905

489

906

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

490

907

# Reformat values from string types to Python types

491

908

client["approved_by_default"] = config.getboolean(

492

909

client_name, "approved_by_default")

493

910

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

494

911

"enabled")

495

912

913

# Uppercase and remove spaces from key_id and fingerprint

914

# for later comparison purposes with return value from the

915

# key_id() and fingerprint() functions

916

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

917

.replace(" ", ""))

496

918

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

497

919

.replace(" ", ""))

498

920

if "secret" in section:

499

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

921

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

922

.encode("utf-8"),

923

"base64")

500

924

elif "secfile" in section:

501

925

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

502

926

(section["secfile"])),

503

927

"rb") as secfile:

504

928

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

505

929

else:

506

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

930

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

507

931

.format(section))

508

932

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

509

933

client["extended_timeout"] = string_to_delta(

517

941

client["last_approval_request"] = None

518

942

client["last_checked_ok"] = None

519

943

client["last_checker_status"] = -2

520

944

521

945

return settings

522

523

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

946

947

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

524

948

self.name = name

949

if server_settings is None:

950

server_settings = {}

951

self.server_settings = server_settings

525

952

# adding all client settings

526

for setting, value in settings.iteritems():

953

for setting, value in settings.items():

527

954

setattr(self, setting, value)

528

955

529

956

if self.enabled:

530

957

if not hasattr(self, "last_enabled"):

531

958

self.last_enabled = datetime.datetime.utcnow()

535

962

else:

536

963

self.last_enabled = None

537

964

self.expires = None

538

965

539

966

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

967

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

543

968

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

544

969

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

545

970

datetime.datetime.utcnow())

546

971

547

972

# attributes specific for this server instance

548

973

self.checker = None

549

974

self.checker_initiator_tag = None

552

977

self.current_checker_command = None

553

978

self.approved = None

554

979

self.approvals_pending = 0

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

980

self.changedstate = multiprocessing_manager.Condition(

981

multiprocessing_manager.Lock())

982

self.client_structure = [attr

983

for attr in self.__dict__.keys()

560

984

if not attr.startswith("_")]

561

985

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

986

987

for name, t in inspect.getmembers(

988

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

567

989

if not name.startswith("_"):

568

990

self.client_structure.append(name)

569

991

570

992

# Send notice to process children that client state has changed

571

993

def send_changedstate(self):

572

994

with self.changedstate:

573

995

self.changedstate.notify_all()

574

996

575

997

def enable(self):

576

998

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

577

999

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

582

1004

self.last_enabled = datetime.datetime.utcnow()

583

1005

self.init_checker()

584

1006

self.send_changedstate()

585

1007

586

1008

def disable(self, quiet=True):

587

1009

"""Disable this client."""

588

1010

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

590

1012

if not quiet:

591

1013

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

592

1014

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

593

gobject.source_remove(self.disable_initiator_tag)

1015

GLib.source_remove(self.disable_initiator_tag)

594

1016

self.disable_initiator_tag = None

595

1017

self.expires = None

596

1018

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

597

gobject.source_remove(self.checker_initiator_tag)

1019

GLib.source_remove(self.checker_initiator_tag)

598

1020

self.checker_initiator_tag = None

599

1021

self.stop_checker()

600

1022

self.enabled = False

601

1023

if not quiet:

602

1024

self.send_changedstate()

603

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

1025

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

604

1026

return False

605

1027

606

1028

def __del__(self):

607

1029

self.disable()

608

1030

609

1031

def init_checker(self):

610

1032

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

611

1033

# and every interval from then on.

612

1034

if self.checker_initiator_tag is not None:

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1035

GLib.source_remove(self.checker_initiator_tag)

1036

self.checker_initiator_tag = GLib.timeout_add(

1037

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

1038

self.start_checker)

617

1039

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

618

1040

if self.disable_initiator_tag is not None:

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1041

GLib.source_remove(self.disable_initiator_tag)

1042

self.disable_initiator_tag = GLib.timeout_add(

1043

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

623

1044

# Also start a new checker *right now*.

624

1045

self.start_checker()

625

626

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

1046

1047

def checker_callback(self, source, condition, connection,

1048

command):

627

1049

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

628

1050

self.checker_callback_tag = None

629

1051

self.checker = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1052

# Read return code from connection (see call_pipe)

1053

returncode = connection.recv()

1054

connection.close()

1055

1056

if returncode >= 0:

1057

self.last_checker_status = returncode

1058

self.last_checker_signal = None

632

1059

if self.last_checker_status == 0:

633

1060

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

634

1061

vars(self))

635

1062

self.checked_ok()

636

1063

else:

637

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

638

vars(self))

1064

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

639

1065

else:

640

1066

self.last_checker_status = -1

1067

self.last_checker_signal = -returncode

641

1068

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

642

1069

vars(self))

643

1070

return False

1071

644

1072

def checked_ok(self):

645

1073

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

646

1074

self.last_checked_ok = datetime.datetime.utcnow()

647

1075

self.last_checker_status = 0

1076

self.last_checker_signal = None

648

1077

self.bump_timeout()

649

1078

650

1079

def bump_timeout(self, timeout=None):

651

1080

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

652

1081

if timeout is None:

653

1082

timeout = self.timeout

654

1083

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1084

GLib.source_remove(self.disable_initiator_tag)

656

1085

self.disable_initiator_tag = None

657

1086

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1087

self.disable_initiator_tag = GLib.timeout_add(

1088

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

661

1089

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

662

1090

663

1091

def need_approval(self):

664

1092

self.last_approval_request = datetime.datetime.utcnow()

665

1093

666

1094

def start_checker(self):

667

1095

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

668

1096

669

1097

If a checker already exists, leave it running and do

670

1098

nothing."""

671

1099

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

676

1104

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

677

1105

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

678

1106

# should be.

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1107

1108

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

1109

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

1110

self.checker.join()

1111

self.checker = None

693

1112

# Start a new checker if needed

694

1113

if self.checker is None:

695

1114

# Escape attributes for the shell

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1115

escaped_attrs = {

1116

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

1117

for attr in self.runtime_expansions}

700

1118

try:

701

1119

command = self.checker_command % escaped_attrs

702

1120

except TypeError as error:

703

1121

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1122

self.checker_command,

1123

exc_info=error)

1124

return True # Try again later

706

1125

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

# This should never happen

732

logger.error("Child process vanished",

733

exc_info=error)

734

return True

735

raise

736

if pid:

737

gobject.source_remove(self.checker_callback_tag)

738

self.checker_callback(pid, status, command)

739

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

1126

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

1127

self.name)

1128

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

1129

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

1130

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

1131

# always replaced by /dev/null.)

1132

# The exception is when not debugging but nevertheless

1133

# running in the foreground; use the previously

1134

# created wnull.

1135

popen_args = {"close_fds": True,

1136

"shell": True,

1137

"cwd": "/"}

1138

if (not self.server_settings["debug"]

1139

and self.server_settings["foreground"]):

1140

popen_args.update({"stdout": wnull,

1141

"stderr": wnull})

1142

pipe = multiprocessing.Pipe(duplex=False)

1143

self.checker = multiprocessing.Process(

1144

target=call_pipe,

1145

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

1146

kwargs=popen_args)

1147

self.checker.start()

1148

self.checker_callback_tag = GLib.io_add_watch(

1149

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

1150

self.checker_callback, pipe[0], command)

1151

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

740

1152

return True

741

1153

742

1154

def stop_checker(self):

743

1155

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

744

1156

if self.checker_callback_tag:

745

gobject.source_remove(self.checker_callback_tag)

1157

GLib.source_remove(self.checker_callback_tag)

746

1158

self.checker_callback_tag = None

747

1159

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

748

1160

return

749

1161

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

750

try:

751

self.checker.terminate()

752

#time.sleep(0.5)

753

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

754

# self.checker.kill()

755

except OSError as error:

756

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

757

raise

1162

self.checker.terminate()

758

1163

self.checker = None

759

1164

760

1165

761

def dbus_service_property(dbus_interface, signature="v",

762

access="readwrite", byte_arrays=False):

1166

def dbus_service_property(dbus_interface,

1167

signature="v",

1168

access="readwrite",

1169

byte_arrays=False):

763

1170

"""Decorators for marking methods of a DBusObjectWithProperties to

764

1171

become properties on the D-Bus.

765

1172

766

1173

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

767

1174

and with one argument by "Set".

768

1175

769

1176

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

770

1177

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

771

1178

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

774

1181

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

775

1182

if byte_arrays and signature != "ay":

776

1183

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

777

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

1184

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

1185

778

1186

def decorator(func):

779

1187

func._dbus_is_property = True

780

1188

func._dbus_interface = dbus_interface

783

1191

func._dbus_name = func.__name__

784

1192

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

785

1193

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

786

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1194

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

787

1195

return func

1196

788

1197

return decorator

789

1198

790

1199

791

1200

def dbus_interface_annotations(dbus_interface):

792

1201

"""Decorator for marking functions returning interface annotations

793

1202

794

1203

Usage:

795

1204

796

1205

@dbus_interface_annotations("org.example.Interface")

797

1206

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

798

1207

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

799

1208

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

800

1209

"false"}

801

1210

"""

1211

802

1212

def decorator(func):

803

1213

func._dbus_is_interface = True

804

1214

func._dbus_interface = dbus_interface

805

1215

func._dbus_name = dbus_interface

806

1216

return func

1217

807

1218

return decorator

808

1219

809

1220

810

1221

def dbus_annotations(annotations):

811

1222

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

812

1223

Usage:

813

1224

1225

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

1226

"org.freedesktop.DBus.Property."

1227

"EmitsChangedSignal": "false"})

814

1228

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

815

1229

access="r")

816

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

817

"org.freedesktop.DBus.Property."

818

"EmitsChangedSignal": "false"})

819

1230

def Property_dbus_property(self):

820

1231

return dbus.Boolean(False)

1232

1233

See also the DBusObjectWithAnnotations class.

821

1234

"""

1235

822

1236

def decorator(func):

823

1237

func._dbus_annotations = annotations

824

1238

return func

1239

825

1240

return decorator

826

1241

827

1242

828

1243

class DBusPropertyException(dbus.exceptions.DBusException):

829

1244

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

830

1245

"""

831

def __unicode__(self):

832

return unicode(str(self))

1246

pass

833

1247

834

1248

835

1249

class DBusPropertyAccessException(DBusPropertyException):

844

1258

pass

845

1259

846

1260

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1261

class DBusObjectWithAnnotations(dbus.service.Object):

1262

"""A D-Bus object with annotations.

1263

1264

Classes inheriting from this can use the dbus_annotations

1265

decorator to add annotations to methods or signals.

853

1266

"""

854

1267

855

1268

@staticmethod

856

1269

def _is_dbus_thing(thing):

857

1270

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

858

1271

859

1272

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

860

1273

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

861

1274

"""

862

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

1275

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

863

1276

False)

864

1277

865

1278

def _get_all_dbus_things(self, thing):

866

1279

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

867

1280

"""

868

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

869

name),

1281

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

870

1282

athing.__get__(self))

871

1283

for cls in self.__class__.__mro__

872

1284

for name, athing in

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1285

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

1286

1287

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1288

out_signature="s",

1289

path_keyword='object_path',

1290

connection_keyword='connection')

1291

def Introspect(self, object_path, connection):

1292

"""Overloading of standard D-Bus method.

1293

1294

Inserts annotation tags on methods and signals.

1295

"""

1296

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

1297

connection)

1298

try:

1299

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

1300

1301

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

1302

# Add annotation tags

1303

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

1304

for tag in if_tag.getElementsByTagName(typ):

1305

annots = dict()

1306

for name, prop in (self.

1307

_get_all_dbus_things(typ)):

1308

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

1309

and prop._dbus_interface

1310

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

1311

annots.update(getattr(

1312

prop, "_dbus_annotations", {}))

1313

for name, value in annots.items():

1314

ann_tag = document.createElement(

1315

"annotation")

1316

ann_tag.setAttribute("name", name)

1317

ann_tag.setAttribute("value", value)

1318

tag.appendChild(ann_tag)

1319

# Add interface annotation tags

1320

for annotation, value in dict(

1321

itertools.chain.from_iterable(

1322

annotations().items()

1323

for name, annotations

1324

in self._get_all_dbus_things("interface")

1325

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

1326

)).items():

1327

ann_tag = document.createElement("annotation")

1328

ann_tag.setAttribute("name", annotation)

1329

ann_tag.setAttribute("value", value)

1330

if_tag.appendChild(ann_tag)

1331

# Fix argument name for the Introspect method itself

1332

if (if_tag.getAttribute("name")

1333

== dbus.INTROSPECTABLE_IFACE):

1334

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

1335

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

1336

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

1337

if (arg.getAttribute("direction")

1338

== "out"):

1339

arg.setAttribute("name",

1340

"xml_data")

1341

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

1342

document.unlink()

1343

except (AttributeError, xml.dom.DOMException,

1344

xml.parsers.expat.ExpatError) as error:

1345

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

1346

exc_info=error)

1347

return xmlstring

1348

1349

1350

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1351

"""A D-Bus object with properties.

1352

1353

Classes inheriting from this can use the dbus_service_property

1354

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

1355

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

1356

"""

1357

876

1358

def _get_dbus_property(self, interface_name, property_name):

877

1359

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

878

1360

property with the specified name and interface.

879

1361

"""

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1362

for cls in self.__class__.__mro__:

1363

for name, value in inspect.getmembers(

1364

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

884

1365

if (value._dbus_name == property_name

885

1366

and value._dbus_interface == interface_name):

886

1367

return value.__get__(self)

887

1368

888

1369

# No such property

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1370

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

1371

self.dbus_object_path, interface_name, property_name))

1372

1373

@classmethod

1374

def _get_all_interface_names(cls):

1375

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

1376

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

1377

"_dbus_interface", None)

1378

for x in (inspect.getmro(cls))

1379

for attr in dir(x))

1380

if name is not None)

1381

1382

@dbus.service.method(dbus.PROPERTIES_IFACE,

1383

in_signature="ss",

894

1384

out_signature="v")

895

1385

def Get(self, interface_name, property_name):

896

1386

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

902

1392

if not hasattr(value, "variant_level"):

903

1393

return value

904

1394

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

905

1395

906

1396

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

907

1397

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

908

1398

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

914

1404

# The byte_arrays option is not supported yet on

915

1405

# signatures other than "ay".

916

1406

if prop._dbus_signature != "ay":

917

raise ValueError

1407

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

1408

"'ay' signature {!r}"

1409

.format(prop._dbus_signature))

918

1410

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

919

1411

for byte in value))

920

1412

prop(value)

921

922

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

1413

1414

@dbus.service.method(dbus.PROPERTIES_IFACE,

1415

in_signature="s",

923

1416

out_signature="a{sv}")

924

1417

def GetAll(self, interface_name):

925

1418

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

926

1419

standard.

927

1420

928

1421

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

929

1422

"""

930

1423

properties = {}

940

1433

if not hasattr(value, "variant_level"):

941

1434

properties[name] = value

942

1435

continue

943

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

944

value.variant_level+1)

1436

properties[name] = type(value)(

1437

value, variant_level=value.variant_level + 1)

945

1438

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

946

1439

1440

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

1441

def PropertiesChanged(self, interface_name, changed_properties,

1442

invalidated_properties):

1443

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

1444

standard.

1445

"""

1446

pass

1447

947

1448

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

948

1449

out_signature="s",

949

1450

path_keyword='object_path',

950

1451

connection_keyword='connection')

951

1452

def Introspect(self, object_path, connection):

952

1453

"""Overloading of standard D-Bus method.

953

1454

954

1455

Inserts property tags and interface annotation tags.

955

1456

"""

956

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

957

connection)

1457

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1458

object_path,

1459

connection)

958

1460

try:

959

1461

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

1462

960

1463

def make_tag(document, name, prop):

961

1464

e = document.createElement("property")

962

1465

e.setAttribute("name", name)

963

1466

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

964

1467

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

965

1468

return e

1469

966

1470

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

967

1471

# Add property tags

968

1472

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

971

1475

if prop._dbus_interface

972

1476

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

973

1477

if_tag.appendChild(tag)

974

# Add annotation tags

975

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

976

for tag in if_tag.getElementsByTagName(typ):

977

annots = dict()

978

for name, prop in (self.

979

_get_all_dbus_things(typ)):

980

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

981

and prop._dbus_interface

982

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

983

annots.update(getattr

984

(prop,

985

"_dbus_annotations",

986

{}))

987

for name, value in annots.iteritems():

988

ann_tag = document.createElement(

989

"annotation")

990

ann_tag.setAttribute("name", name)

991

ann_tag.setAttribute("value", value)

992

tag.appendChild(ann_tag)

993

# Add interface annotation tags

994

for annotation, value in dict(

995

itertools.chain.from_iterable(

996

annotations().iteritems()

997

for name, annotations in

998

self._get_all_dbus_things("interface")

999

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

1000

)).iteritems():

1001

ann_tag = document.createElement("annotation")

1002

ann_tag.setAttribute("name", annotation)

1003

ann_tag.setAttribute("value", value)

1004

if_tag.appendChild(ann_tag)

1478

# Add annotation tags for properties

1479

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

1480

annots = dict()

1481

for name, prop in self._get_all_dbus_things(

1482

"property"):

1483

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

1484

and prop._dbus_interface

1485

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

1486

annots.update(getattr(

1487

prop, "_dbus_annotations", {}))

1488

for name, value in annots.items():

1489

ann_tag = document.createElement(

1490

"annotation")

1491

ann_tag.setAttribute("name", name)

1492

ann_tag.setAttribute("value", value)

1493

tag.appendChild(ann_tag)

1005

1494

# Add the names to the return values for the

1006

1495

# "org.freedesktop.DBus.Properties" methods

1007

1496

if (if_tag.getAttribute("name")

1026

1515

return xmlstring

1027

1516

1028

1517

1518

try:

1519

dbus.OBJECT_MANAGER_IFACE

1520

except AttributeError:

1521

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

1522

1523

1524

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1525

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

1526

1527

Classes inheriting from this exposes the standard

1528

GetManagedObjects call and the InterfacesAdded and

1529

InterfacesRemoved signals on the standard

1530

"org.freedesktop.DBus.ObjectManager" interface.

1531

1532

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

1533

manually.

1534

"""

1535

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def GetManagedObjects(self):

1538

"""This function must be overridden"""

1539

raise NotImplementedError()

1540

1541

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def InterfacesAdded(self, object_path, interfaces_and_properties):

1544

pass

1545

1546

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

1547

def InterfacesRemoved(self, object_path, interfaces):

1548

pass

1549

1550

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1551

out_signature="s",

1552

path_keyword='object_path',

1553

connection_keyword='connection')

1554

def Introspect(self, object_path, connection):

1555

"""Overloading of standard D-Bus method.

1556

1557

Override return argument name of GetManagedObjects to be

1558

"objpath_interfaces_and_properties"

1559

"""

1560

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1561

object_path,

1562

connection)

1563

try:

1564

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

1565

1566

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

1567

# Fix argument name for the GetManagedObjects method

1568

if (if_tag.getAttribute("name")

1569

== dbus.OBJECT_MANAGER_IFACE):

1570

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

1571

if (cn.getAttribute("name")

1572

== "GetManagedObjects"):

1573

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

1574

if (arg.getAttribute("direction")

1575

== "out"):

1576

arg.setAttribute(

1577

"name",

1578

"objpath_interfaces"

1579

"_and_properties")

1580

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

1581

document.unlink()

1582

except (AttributeError, xml.dom.DOMException,

1583

xml.parsers.expat.ExpatError) as error:

1584

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

1585

exc_info=error)

1586

return xmlstring

1587

1588

1029

1589

def datetime_to_dbus(dt, variant_level=0):

1030

1590

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

1031

1591

if dt is None:

1032

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

1033

return dbus.String(dt.isoformat(),

1034

variant_level=variant_level)

1592

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

1593

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

1035

1594

1036

1595

1037

1596

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1039

1598

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

1040

1599

interface names according to the "alt_interface_names" mapping.

1041

1600

Usage:

1042

1601

1043

1602

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

1044

1603

"net.example.AlternateInterface"})

1045

1604

class SampleDBusObject(dbus.service.Object):

1046

1605

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

1047

1606

def SampleDBusMethod():

1048

1607

pass

1049

1608

1050

1609

The above "SampleDBusMethod" on "SampleDBusObject" will be

1051

1610

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

1052

1611

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

1053

1612

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

1054

1613

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

1055

1614

1056

1615

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

1057

1616

(from DBusObjectWithProperties) and interfaces (from the

1058

1617

dbus_interface_annotations decorator).

1059

1618

"""

1619

1060

1620

def wrapper(cls):

1061

1621

for orig_interface_name, alt_interface_name in (

1062

alt_interface_names.iteritems()):

1622

alt_interface_names.items()):

1063

1623

attr = {}

1064

1624

interface_names = set()

1065

1625

# Go though all attributes of the class

1067

1627

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

1068

1628

# with the wrong interface name

1069

1629

if (not hasattr(attribute, "_dbus_interface")

1070

or not attribute._dbus_interface

1071

.startswith(orig_interface_name)):

1630

or not attribute._dbus_interface.startswith(

1631

orig_interface_name)):

1072

1632

continue

1073

1633

# Create an alternate D-Bus interface name based on

1074

1634

# the current name

1075

alt_interface = (attribute._dbus_interface

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1635

alt_interface = attribute._dbus_interface.replace(

1636

orig_interface_name, alt_interface_name)

1078

1637

interface_names.add(alt_interface)

1079

1638

# Is this a D-Bus signal?

1080

1639

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

1081

1640

# Extract the original non-method undecorated

1082

1641

# function by black magic

1083

nonmethod_func = (dict(

1642

if sys.version_info.major == 2:

1643

nonmethod_func = (dict(

1084

1644

zip(attribute.func_code.co_freevars,

1085

attribute.__closure__))["func"]

1086

.cell_contents)

1645

attribute.__closure__))

1646

["func"].cell_contents)

1647

else:

1648

nonmethod_func = (dict(

1649

zip(attribute.__code__.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1087

1652

# Create a new, but exactly alike, function

1088

1653

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

1089

1654

# with the alternate D-Bus interface name

1090

new_function = (dbus.service.signal

1091

(alt_interface,

1092

attribute._dbus_signature)

1093

(types.FunctionType(

1094

nonmethod_func.func_code,

1095

nonmethod_func.func_globals,

1096

nonmethod_func.func_name,

1097

nonmethod_func.func_defaults,

1098

nonmethod_func.func_closure)))

1655

new_function = copy_function(nonmethod_func)

1656

new_function = (dbus.service.signal(

1657

alt_interface,

1658

attribute._dbus_signature)(new_function))

1099

1659

# Copy annotations, if any

1100

1660

try:

1101

new_function._dbus_annotations = (

1102

dict(attribute._dbus_annotations))

1661

new_function._dbus_annotations = dict(

1662

attribute._dbus_annotations)

1103

1663

except AttributeError:

1104

1664

pass

1665

1105

1666

# Define a creator of a function to call both the

1106

1667

# original and alternate functions, so both the

1107

1668

# original and alternate signals gets sent when

1110

1671

"""This function is a scope container to pass

1111

1672

func1 and func2 to the "call_both" function

1112

1673

outside of its arguments"""

1674

1675

@functools.wraps(func2)

1113

1676

def call_both(*args, **kwargs):

1114

1677

"""This function will emit two D-Bus

1115

1678

signals by calling func1 and func2"""

1116

1679

func1(*args, **kwargs)

1117

1680

func2(*args, **kwargs)

1681

# Make wrapper function look like a D-Bus

1682

# signal

1683

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

1684

if name.startswith("_dbus_"):

1685

setattr(call_both, name, attr)

1686

1118

1687

return call_both

1119

1688

# Create the "call_both" function and add it to

1120

1689

# the class

1125

1694

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

1126

1695

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

1127

1696

# to the class.

1128

attr[attrname] = (dbus.service.method

1129

(alt_interface,

1130

attribute._dbus_in_signature,

1131

attribute._dbus_out_signature)

1132

(types.FunctionType

1133

(attribute.func_code,

1134

attribute.func_globals,

1135

attribute.func_name,

1136

attribute.func_defaults,

1137

attribute.func_closure)))

1697

attr[attrname] = (

1698

dbus.service.method(

1699

alt_interface,

1700

attribute._dbus_in_signature,

1701

attribute._dbus_out_signature)

1702

(copy_function(attribute)))

1138

1703

# Copy annotations, if any

1139

1704

try:

1140

attr[attrname]._dbus_annotations = (

1141

dict(attribute._dbus_annotations))

1705

attr[attrname]._dbus_annotations = dict(

1706

attribute._dbus_annotations)

1142

1707

except AttributeError:

1143

1708

pass

1144

1709

# Is this a D-Bus property?

1147

1712

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

1148

1713

# property with the alternate D-Bus interface

1149

1714

# name. Add it to the class.

1150

attr[attrname] = (dbus_service_property

1151

(alt_interface,

1152

attribute._dbus_signature,

1153

attribute._dbus_access,

1154

attribute

1155

._dbus_get_args_options

1156

["byte_arrays"])

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1715

attr[attrname] = (dbus_service_property(

1716

alt_interface, attribute._dbus_signature,

1717

attribute._dbus_access,

1718

attribute._dbus_get_args_options

1719

["byte_arrays"])

1720

(copy_function(attribute)))

1163

1721

# Copy annotations, if any

1164

1722

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1723

attr[attrname]._dbus_annotations = dict(

1724

attribute._dbus_annotations)

1167

1725

except AttributeError:

1168

1726

pass

1169

1727

# Is this a D-Bus interface?

1172

1730

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

1173

1731

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

1174

1732

# to the class.

1175

attr[attrname] = (dbus_interface_annotations

1176

(alt_interface)

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1733

attr[attrname] = (

1734

dbus_interface_annotations(alt_interface)

1735

(copy_function(attribute)))

1183

1736

if deprecate:

1184

1737

# Deprecate all alternate interfaces

1185

iname="_AlternateDBusNames_interface_annotation{0}"

1738

iname = "_AlternateDBusNames_interface_annotation{}"

1186

1739

for interface_name in interface_names:

1740

1187

1741

@dbus_interface_annotations(interface_name)

1188

1742

def func(self):

1189

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

1190

"true" }

1743

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

1744

"true"}

1191

1745

# Find an unused name

1192

1746

for aname in (iname.format(i)

1193

1747

for i in itertools.count()):

1197

1751

if interface_names:

1198

1752

# Replace the class with a new subclass of it with

1199

1753

# methods, signals, etc. as created above.

1200

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

1201

(cls,), attr)

1754

if sys.version_info.major == 2:

1755

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

1756

(cls, ), attr)

1757

else:

1758

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

1759

(cls, ), attr)

1202

1760

return cls

1761

1203

1762

return wrapper

1204

1763

1205

1764

1206

1765

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

1207

"se.bsnet.fukt.Mandos"})

1766

"se.bsnet.fukt.Mandos"})

1208

1767

class ClientDBus(Client, DBusObjectWithProperties):

1209

1768

"""A Client class using D-Bus

1210

1769

1211

1770

Attributes:

1212

1771

dbus_object_path: dbus.ObjectPath

1213

1772

bus: dbus.SystemBus()

1214

1773

"""

1215

1774

1216

1775

runtime_expansions = (Client.runtime_expansions

1217

+ ("dbus_object_path",))

1218

1776

+ ("dbus_object_path", ))

1777

1778

_interface = "se.recompile.Mandos.Client"

1779

1219

1780

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

1220

1221

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

1781

1782

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

1222

1783

self.bus = bus

1223

1784

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

1224

1785

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

1225

1786

# the D-Bus

1226

client_object_name = unicode(self.name).translate(

1787

client_object_name = str(self.name).translate(

1227

1788

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

1228

1789

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

1229

self.dbus_object_path = (dbus.ObjectPath

1230

("/clients/" + client_object_name))

1790

self.dbus_object_path = dbus.ObjectPath(

1791

"/clients/" + client_object_name)

1231

1792

DBusObjectWithProperties.__init__(self, self.bus,

1232

1793

self.dbus_object_path)

1233

1234

def notifychangeproperty(transform_func,

1235

dbus_name, type_func=lambda x: x,

1236

variant_level=1):

1794

1795

def notifychangeproperty(transform_func, dbus_name,

1796

type_func=lambda x: x,

1797

variant_level=1,

1798

invalidate_only=False,

1799

_interface=_interface):

1237

1800

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

1238

1801

its changes to DBus.

1239

1802

1240

1803

transform_fun: Function that takes a value and a variant_level

1241

1804

and transforms it to a D-Bus type.

1242

1805

dbus_name: D-Bus name of the variable

1244

1807

to the D-Bus. Default: no transform

1245

1808

variant_level: D-Bus variant level. Default: 1

1246

1809

"""

1247

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

1810

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

1811

1248

1812

def setter(self, value):

1249

1813

if hasattr(self, "dbus_object_path"):

1250

1814

if (not hasattr(self, attrname) or

1251

1815

type_func(getattr(self, attrname, None))

1252

1816

!= type_func(value)):

1253

dbus_value = transform_func(type_func(value),

1254

variant_level

1255

=variant_level)

1256

self.PropertyChanged(dbus.String(dbus_name),

1257

dbus_value)

1817

if invalidate_only:

1818

self.PropertiesChanged(

1819

_interface, dbus.Dictionary(),

1820

dbus.Array((dbus_name, )))

1821

else:

1822

dbus_value = transform_func(

1823

type_func(value),

1824

variant_level=variant_level)

1825

self.PropertyChanged(dbus.String(dbus_name),

1826

dbus_value)

1827

self.PropertiesChanged(

1828

_interface,

1829

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

1830

dbus_value}),

1831

dbus.Array())

1258

1832

setattr(self, attrname, value)

1259

1833

1260

1834

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

1261

1835

1262

1836

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1263

1837

approvals_pending = notifychangeproperty(dbus.Boolean,

1264

1838

"ApprovalPending",

1265

type_func = bool)

1839

type_func=bool)

1266

1840

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

1267

1841

last_enabled = notifychangeproperty(datetime_to_dbus,

1268

1842

"LastEnabled")

1269

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

1270

type_func = lambda checker:

1271

checker is not None)

1843

checker = notifychangeproperty(

1844

dbus.Boolean, "CheckerRunning",

1845

type_func=lambda checker: checker is not None)

1272

1846

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1273

1847

"LastCheckedOK")

1274

1848

last_checker_status = notifychangeproperty(dbus.Int16,

1277

1851

datetime_to_dbus, "LastApprovalRequest")

1278

1852

approved_by_default = notifychangeproperty(dbus.Boolean,

1279

1853

"ApprovedByDefault")

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1281

"ApprovalDelay",

1282

type_func =

1283

timedelta_to_milliseconds)

1854

approval_delay = notifychangeproperty(

1855

dbus.UInt64, "ApprovalDelay",

1856

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

1284

1857

approval_duration = notifychangeproperty(

1285

1858

dbus.UInt64, "ApprovalDuration",

1286

type_func = timedelta_to_milliseconds)

1859

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

1287

1860

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

1288

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

1289

type_func =

1290

timedelta_to_milliseconds)

1861

timeout = notifychangeproperty(

1862

dbus.UInt64, "Timeout",

1863

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

1291

1864

extended_timeout = notifychangeproperty(

1292

1865

dbus.UInt64, "ExtendedTimeout",

1293

type_func = timedelta_to_milliseconds)

1294

interval = notifychangeproperty(dbus.UInt64,

1295

"Interval",

1296

type_func =

1297

timedelta_to_milliseconds)

1866

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

1867

interval = notifychangeproperty(

1868

dbus.UInt64, "Interval",

1869

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

1298

1870

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

1299

1871

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

1872

invalidate_only=True)

1873

1300

1874

del notifychangeproperty

1301

1875

1302

1876

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

1303

1877

try:

1304

1878

self.remove_from_connection()

1307

1881

if hasattr(DBusObjectWithProperties, "__del__"):

1308

1882

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

1309

1883

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

1310

1311

def checker_callback(self, pid, condition, command,

1312

*args, **kwargs):

1313

self.checker_callback_tag = None

1314

self.checker = None

1315

if os.WIFEXITED(condition):

1316

exitstatus = os.WEXITSTATUS(condition)

1884

1885

def checker_callback(self, source, condition,

1886

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

1887

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

1888

connection, command, *args,

1889

**kwargs)

1890

exitstatus = self.last_checker_status

1891

if exitstatus >= 0:

1317

1892

# Emit D-Bus signal

1318

1893

self.CheckerCompleted(dbus.Int16(exitstatus),

1319

dbus.Int64(condition),

1894

# This is specific to GNU libC

1895

dbus.Int64(exitstatus << 8),

1320

1896

dbus.String(command))

1321

1897

else:

1322

1898

# Emit D-Bus signal

1323

1899

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

1324

dbus.Int64(condition),

1900

dbus.Int64(

1901

# This is specific to GNU libC

1902

(exitstatus << 8)

1903

| self.last_checker_signal),

1325

1904

dbus.String(command))

1326

1327

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

1328

*args, **kwargs)

1329

1905

return ret

1906

1330

1907

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

1331

old_checker = self.checker

1332

if self.checker is not None:

1333

old_checker_pid = self.checker.pid

1334

else:

1335

old_checker_pid = None

1908

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

1336

1909

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

1337

1910

# Only if new checker process was started

1338

1911

if (self.checker is not None

1340

1913

# Emit D-Bus signal

1341

1914

self.CheckerStarted(self.current_checker_command)

1342

1915

return r

1343

1916

1344

1917

def _reset_approved(self):

1345

1918

self.approved = None

1346

1919

return False

1347

1920

1348

1921

def approve(self, value=True):

1349

1922

self.approved = value

1350

gobject.timeout_add(timedelta_to_milliseconds

1351

(self.approval_duration),

1352

self._reset_approved)

1923

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

1924

* 1000), self._reset_approved)

1353

1925

self.send_changedstate()

1354

1355

## D-Bus methods, signals & properties

1356

_interface = "se.recompile.Mandos.Client"

1357

1358

## Interfaces

1359

1360

@dbus_interface_annotations(_interface)

1361

def _foo(self):

1362

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

1363

"false"}

1364

1365

## Signals

1366

1926

1927

# D-Bus methods, signals & properties

1928

1929

# Interfaces

1930

1931

# Signals

1932

1367

1933

# CheckerCompleted - signal

1368

1934

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

1369

1935

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

1370

1936

"D-Bus signal"

1371

1937

pass

1372

1938

1373

1939

# CheckerStarted - signal

1374

1940

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

1375

1941

def CheckerStarted(self, command):

1376

1942

"D-Bus signal"

1377

1943

pass

1378

1944

1379

1945

# PropertyChanged - signal

1946

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

1380

1947

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

1381

1948

def PropertyChanged(self, property, value):

1382

1949

"D-Bus signal"

1383

1950

pass

1384

1951

1385

1952

# GotSecret - signal

1386

1953

@dbus.service.signal(_interface)

1387

1954

def GotSecret(self):

1390

1957

server to mandos-client

1391

1958

"""

1392

1959

pass

1393

1960

1394

1961

# Rejected - signal

1395

1962

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

1396

1963

def Rejected(self, reason):

1397

1964

"D-Bus signal"

1398

1965

pass

1399

1966

1400

1967

# NeedApproval - signal

1401

1968

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

1402

1969

def NeedApproval(self, timeout, default):

1403

1970

"D-Bus signal"

1404

1971

return self.need_approval()

1405

1406

## Methods

1407

1972

1973

# Methods

1974

1408

1975

# Approve - method

1409

1976

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

1410

1977

def Approve(self, value):

1411

1978

self.approve(value)

1412

1979

1413

1980

# CheckedOK - method

1414

1981

@dbus.service.method(_interface)

1415

1982

def CheckedOK(self):

1416

1983

self.checked_ok()

1417

1984

1418

1985

# Enable - method

1986

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

1419

1987

@dbus.service.method(_interface)

1420

1988

def Enable(self):

1421

1989

"D-Bus method"

1422

1990

self.enable()

1423

1991

1424

1992

# StartChecker - method

1993

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

1425

1994

@dbus.service.method(_interface)

1426

1995

def StartChecker(self):

1427

1996

"D-Bus method"

1428

1997

self.start_checker()

1429

1998

1430

1999

# Disable - method

2000

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

1431

2001

@dbus.service.method(_interface)

1432

2002

def Disable(self):

1433

2003

"D-Bus method"

1434

2004

self.disable()

1435

2005

1436

2006

# StopChecker - method

2007

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

1437

2008

@dbus.service.method(_interface)

1438

2009

def StopChecker(self):

1439

2010

self.stop_checker()

1440

1441

## Properties

1442

2011

2012

# Properties

2013

1443

2014

# ApprovalPending - property

1444

2015

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

1445

2016

def ApprovalPending_dbus_property(self):

1446

2017

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

1447

2018

1448

2019

# ApprovedByDefault - property

1449

@dbus_service_property(_interface, signature="b",

2020

@dbus_service_property(_interface,

2021

signature="b",

1450

2022

access="readwrite")

1451

2023

def ApprovedByDefault_dbus_property(self, value=None):

1452

2024

if value is None: # get

1453

2025

return dbus.Boolean(self.approved_by_default)

1454

2026

self.approved_by_default = bool(value)

1455

2027

1456

2028

# ApprovalDelay - property

1457

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1458

2031

access="readwrite")

1459

2032

def ApprovalDelay_dbus_property(self, value=None):

1460

2033

if value is None: # get

1461

return dbus.UInt64(self.approval_delay_milliseconds())

2034

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

2035

* 1000)

1462

2036

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

1463

2037

1464

2038

# ApprovalDuration - property

1465

@dbus_service_property(_interface, signature="t",

2039

@dbus_service_property(_interface,

2040

signature="t",

1466

2041

access="readwrite")

1467

2042

def ApprovalDuration_dbus_property(self, value=None):

1468

2043

if value is None: # get

1469

return dbus.UInt64(timedelta_to_milliseconds(

1470

self.approval_duration))

2044

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

2045

* 1000)

1471

2046

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

1472

2047

1473

2048

# Name - property

2049

@dbus_annotations(

2050

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

1474

2051

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

1475

2052

def Name_dbus_property(self):

1476

2053

return dbus.String(self.name)

1477

2054

2055

# KeyID - property

2056

@dbus_annotations(

2057

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

2058

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

2059

def KeyID_dbus_property(self):

2060

return dbus.String(self.key_id)

2061

1478

2062

# Fingerprint - property

2063

@dbus_annotations(

2064

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

1479

2065

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

1480

2066

def Fingerprint_dbus_property(self):

1481

2067

return dbus.String(self.fingerprint)

1482

2068

1483

2069

# Host - property

1484

@dbus_service_property(_interface, signature="s",

2070

@dbus_service_property(_interface,

2071

signature="s",

1485

2072

access="readwrite")

1486

2073

def Host_dbus_property(self, value=None):

1487

2074

if value is None: # get

1488

2075

return dbus.String(self.host)

1489

self.host = unicode(value)

1490

2076

self.host = str(value)

2077

1491

2078

# Created - property

2079

@dbus_annotations(

2080

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

1492

2081

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

1493

2082

def Created_dbus_property(self):

1494

2083

return datetime_to_dbus(self.created)

1495

2084

1496

2085

# LastEnabled - property

1497

2086

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

1498

2087

def LastEnabled_dbus_property(self):

1499

2088

return datetime_to_dbus(self.last_enabled)

1500

2089

1501

2090

# Enabled - property

1502

@dbus_service_property(_interface, signature="b",

2091

@dbus_service_property(_interface,

2092

signature="b",

1503

2093

access="readwrite")

1504

2094

def Enabled_dbus_property(self, value=None):

1505

2095

if value is None: # get

1508

2098

self.enable()

1509

2099

else:

1510

2100

self.disable()

1511

2101

1512

2102

# LastCheckedOK - property

1513

@dbus_service_property(_interface, signature="s",

2103

@dbus_service_property(_interface,

2104

signature="s",

1514

2105

access="readwrite")

1515

2106

def LastCheckedOK_dbus_property(self, value=None):

1516

2107

if value is not None:

1517

2108

self.checked_ok()

1518

2109

return

1519

2110

return datetime_to_dbus(self.last_checked_ok)

1520

2111

1521

2112

# LastCheckerStatus - property

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2113

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

1524

2114

def LastCheckerStatus_dbus_property(self):

1525

2115

return dbus.Int16(self.last_checker_status)

1526

2116

1527

2117

# Expires - property

1528

2118

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

1529

2119

def Expires_dbus_property(self):

1530

2120

return datetime_to_dbus(self.expires)

1531

2121

1532

2122

# LastApprovalRequest - property

1533

2123

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

1534

2124

def LastApprovalRequest_dbus_property(self):

1535

2125

return datetime_to_dbus(self.last_approval_request)

1536

2126

1537

2127

# Timeout - property

1538

@dbus_service_property(_interface, signature="t",

2128

@dbus_service_property(_interface,

2129

signature="t",

1539

2130

access="readwrite")

1540

2131

def Timeout_dbus_property(self, value=None):

1541

2132

if value is None: # get

1542

return dbus.UInt64(self.timeout_milliseconds())

2133

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

1543

2134

old_timeout = self.timeout

1544

2135

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

1545

2136

# Reschedule disabling

1553

2144

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

1554

2145

is None):

1555

2146

return

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

timedelta_to_milliseconds(self.expires - now),

1560

self.disable))

1561

2147

GLib.source_remove(self.disable_initiator_tag)

2148

self.disable_initiator_tag = GLib.timeout_add(

2149

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

2150

self.disable)

2151

1562

2152

# ExtendedTimeout - property

1563

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1564

2155

access="readwrite")

1565

2156

def ExtendedTimeout_dbus_property(self, value=None):

1566

2157

if value is None: # get

1567

return dbus.UInt64(self.extended_timeout_milliseconds())

2158

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

2159

* 1000)

1568

2160

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

1569

2161

1570

2162

# Interval - property

1571

@dbus_service_property(_interface, signature="t",

2163

@dbus_service_property(_interface,

2164

signature="t",

1572

2165

access="readwrite")

1573

2166

def Interval_dbus_property(self, value=None):

1574

2167

if value is None: # get

1575

return dbus.UInt64(self.interval_milliseconds())

2168

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

1576

2169

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

1577

2170

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

1578

2171

return

1579

2172

if self.enabled:

1580

2173

# Reschedule checker run

1581

gobject.source_remove(self.checker_initiator_tag)

1582

self.checker_initiator_tag = (gobject.timeout_add

1583

(value, self.start_checker))

1584

self.start_checker() # Start one now, too

1585

2174

GLib.source_remove(self.checker_initiator_tag)

2175

self.checker_initiator_tag = GLib.timeout_add(

2176

value, self.start_checker)

2177

self.start_checker() # Start one now, too

2178

1586

2179

# Checker - property

1587

@dbus_service_property(_interface, signature="s",

2180

@dbus_service_property(_interface,

2181

signature="s",

1588

2182

access="readwrite")

1589

2183

def Checker_dbus_property(self, value=None):

1590

2184

if value is None: # get

1591

2185

return dbus.String(self.checker_command)

1592

self.checker_command = unicode(value)

1593

2186

self.checker_command = str(value)

2187

1594

2188

# CheckerRunning - property

1595

@dbus_service_property(_interface, signature="b",

2189

@dbus_service_property(_interface,

2190

signature="b",

1596

2191

access="readwrite")

1597

2192

def CheckerRunning_dbus_property(self, value=None):

1598

2193

if value is None: # get

1601

2196

self.start_checker()

1602

2197

else:

1603

2198

self.stop_checker()

1604

2199

1605

2200

# ObjectPath - property

2201

@dbus_annotations(

2202

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

2203

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

1606

2204

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

1607

2205

def ObjectPath_dbus_property(self):

1608

return self.dbus_object_path # is already a dbus.ObjectPath

1609

2206

return self.dbus_object_path # is already a dbus.ObjectPath

2207

1610

2208

# Secret = property

1611

@dbus_service_property(_interface, signature="ay",

1612

access="write", byte_arrays=True)

2209

@dbus_annotations(

2210

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

2211

"invalidates"})

2212

@dbus_service_property(_interface,

2213

signature="ay",

2214

access="write",

2215

byte_arrays=True)

1613

2216

def Secret_dbus_property(self, value):

1614

self.secret = str(value)

1615

2217

self.secret = bytes(value)

2218

1616

2219

del _interface

1617

2220

1618

2221

1619

2222

class ProxyClient(object):

1620

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

2223

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

1621

2224

self._pipe = child_pipe

1622

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

2225

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

1623

2226

if not self._pipe.recv():

1624

raise KeyError()

1625

2227

raise KeyError(key_id or fpr)

2228

1626

2229

def __getattribute__(self, name):

1627

2230

if name == '_pipe':

1628

2231

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

1631

2234

if data[0] == 'data':

1632

2235

return data[1]

1633

2236

if data[0] == 'function':

2237

1634

2238

def func(*args, **kwargs):

1635

2239

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

1636

2240

return self._pipe.recv()[1]

2241

1637

2242

return func

1638

2243

1639

2244

def __setattr__(self, name, value):

1640

2245

if name == '_pipe':

1641

2246

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

1644

2249

1645

2250

class ClientHandler(socketserver.BaseRequestHandler, object):

1646

2251

"""A class to handle client connections.

1647

2252

1648

2253

Instantiated once for each connection to handle it.

1649

2254

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

1650

2255

1651

2256

def handle(self):

1652

2257

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

1653

2258

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

1654

unicode(self.client_address))

2259

str(self.client_address))

1655

2260

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

1656

2261

self.server.child_pipe.fileno())

1657

1658

session = (gnutls.connection

1659

.ClientSession(self.request,

1660

gnutls.connection

1661

.X509Credentials()))

1662

1663

# Note: gnutls.connection.X509Credentials is really a

1664

# generic GnuTLS certificate credentials object so long as

1665

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

1666

# here despite using OpenPGP certificates.

1667

1668

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

1669

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

1670

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

1671

# "+DHE-DSS"))

2262

2263

session = gnutls.ClientSession(self.request)

2264

2265

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

2266

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

2267

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

2268

# "+DHE-DSS"))

1672

2269

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

1673

2270

priority = self.server.gnutls_priority

1674

2271

if priority is None:

1675

2272

priority = "NORMAL"

1676

(gnutls.library.functions

1677

.gnutls_priority_set_direct(session._c_object,

1678

priority, None))

1679

2273

gnutls.priority_set_direct(session._c_object,

2274

priority.encode("utf-8"),

2275

None)

2276

1680

2277

# Start communication using the Mandos protocol

1681

2278

# Get protocol number

1682

2279

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

1683

2280

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

1684

2281

try:

1685

2282

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

1686

raise RuntimeError

2283

raise RuntimeError(line)

1687

2284

except (ValueError, IndexError, RuntimeError) as error:

1688

2285

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

1689

2286

return

1690

2287

1691

2288

# Start GnuTLS connection

1692

2289

try:

1693

2290

session.handshake()

1694

except gnutls.errors.GNUTLSError as error:

2291

except gnutls.Error as error:

1695

2292

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

1696

2293

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

1697

2294

# established. Just abandon the request.

1698

2295

return

1699

2296

logger.debug("Handshake succeeded")

1700

2297

1701

2298

approval_required = False

1702

2299

try:

1703

try:

1704

fpr = self.fingerprint(self.peer_certificate

1705

(session))

1706

except (TypeError,

1707

gnutls.errors.GNUTLSError) as error:

1708

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

1709

return

1710

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

1711

1712

try:

1713

client = ProxyClient(child_pipe, fpr,

2300

if gnutls.has_rawpk:

2301

fpr = ""

2302

try:

2303

key_id = self.key_id(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

else:

2311

key_id = ""

2312

try:

2313

fpr = self.fingerprint(

2314

self.peer_certificate(session))

2315

except (TypeError, gnutls.Error) as error:

2316

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

2317

return

2318

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

2319

2320

try:

2321

client = ProxyClient(child_pipe, key_id, fpr,

1714

2322

self.client_address)

1715

2323

except KeyError:

1716

2324

return

1717

2325

1718

2326

if client.approval_delay:

1719

2327

delay = client.approval_delay

1720

2328

client.approvals_pending += 1

1721

2329

approval_required = True

1722

2330

1723

2331

while True:

1724

2332

if not client.enabled:

1725

2333

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

1726

client.name)

2334

client.name)

1727

2335

if self.server.use_dbus:

1728

2336

# Emit D-Bus signal

1729

2337

client.Rejected("Disabled")

1730

2338

return

1731

2339

1732

2340

if client.approved or not client.approval_delay:

1733

#We are approved or approval is disabled

2341

# We are approved or approval is disabled

1734

2342

break

1735

2343

elif client.approved is None:

1736

2344

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

1738

2346

if self.server.use_dbus:

1739

2347

# Emit D-Bus signal

1740

2348

client.NeedApproval(

1741

client.approval_delay_milliseconds(),

1742

client.approved_by_default)

2349

client.approval_delay.total_seconds()

2350

* 1000, client.approved_by_default)

1743

2351

else:

1744

2352

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

1745

2353

client.name)

1747

2355

# Emit D-Bus signal

1748

2356

client.Rejected("Denied")

1749

2357

return

1750

1751

#wait until timeout or approved

2358

2359

# wait until timeout or approved

1752

2360

time = datetime.datetime.now()

1753

2361

client.changedstate.acquire()

1754

client.changedstate.wait(

1755

float(timedelta_to_milliseconds(delay)

1756

/ 1000))

2362

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

1757

2363

client.changedstate.release()

1758

2364

time2 = datetime.datetime.now()

1759

2365

if (time2 - time) >= delay:

1769

2375

break

1770

2376

else:

1771

2377

delay -= time2 - time

1772

1773

sent_size = 0

1774

while sent_size < len(client.secret):

1775

try:

1776

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

1777

except gnutls.errors.GNUTLSError as error:

1778

logger.warning("gnutls send failed",

1779

exc_info=error)

1780

return

1781

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

1782

sent, len(client.secret)

1783

- (sent_size + sent))

1784

sent_size += sent

1785

2378

2379

try:

2380

session.send(client.secret)

2381

except gnutls.Error as error:

2382

logger.warning("gnutls send failed",

2383

exc_info=error)

2384

return

2385

1786

2386

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

1787

2387

# bump the timeout using extended_timeout

1788

2388

client.bump_timeout(client.extended_timeout)

1789

2389

if self.server.use_dbus:

1790

2390

# Emit D-Bus signal

1791

2391

client.GotSecret()

1792

2392

1793

2393

finally:

1794

2394

if approval_required:

1795

2395

client.approvals_pending -= 1

1796

2396

try:

1797

2397

session.bye()

1798

except gnutls.errors.GNUTLSError as error:

2398

except gnutls.Error as error:

1799

2399

logger.warning("GnuTLS bye failed",

1800

2400

exc_info=error)

1801

2401

1802

2402

@staticmethod

1803

2403

def peer_certificate(session):

1804

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

1805

# If not an OpenPGP certificate...

1806

if (gnutls.library.functions

1807

.gnutls_certificate_type_get(session._c_object)

1808

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1809

# ...do the normal thing

1810

return session.peer_certificate

2404

"Return the peer's certificate as a bytestring"

2405

try:

2406

cert_type = gnutls.certificate_type_get2(session._c_object,

2407

gnutls.CTYPE_PEERS)

2408

except AttributeError:

2409

cert_type = gnutls.certificate_type_get(session._c_object)

2410

if gnutls.has_rawpk:

2411

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2412

else:

2413

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2414

# If not a valid certificate type...

2415

if cert_type not in valid_cert_types:

2416

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

2417

valid_cert_types)

2418

# ...return invalid data

2419

return b""

1811

2420

list_size = ctypes.c_uint(1)

1812

cert_list = (gnutls.library.functions

1813

.gnutls_certificate_get_peers

2421

cert_list = (gnutls.certificate_get_peers

1814

2422

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

1815

2423

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

1816

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

1817

" certificate")

2424

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

1818

2425

if list_size.value == 0:

1819

2426

return None

1820

2427

cert = cert_list[0]

1821

2428

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

1822

2429

2430

@staticmethod

2431

def key_id(certificate):

2432

"Convert a certificate bytestring to a hexdigit key ID"

2433

# New GnuTLS "datum" with the public key

2434

datum = gnutls.datum_t(

2435

ctypes.cast(ctypes.c_char_p(certificate),

2436

ctypes.POINTER(ctypes.c_ubyte)),

2437

ctypes.c_uint(len(certificate)))

2438

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

2439

# New empty GnuTLS certificate

2440

pubkey = gnutls.pubkey_t()

2441

gnutls.pubkey_init(ctypes.byref(pubkey))

2442

# Import the raw public key into the certificate

2443

gnutls.pubkey_import(pubkey,

2444

ctypes.byref(datum),

2445

gnutls.X509_FMT_DER)

2446

# New buffer for the key ID

2447

buf = ctypes.create_string_buffer(32)

2448

buf_len = ctypes.c_size_t(len(buf))

2449

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

2450

gnutls.pubkey_get_key_id(pubkey,

2451

gnutls.KEYID_USE_SHA256,

2452

ctypes.cast(ctypes.byref(buf),

2453

ctypes.POINTER(ctypes.c_ubyte)),

2454

ctypes.byref(buf_len))

2455

# Deinit the certificate

2456

gnutls.pubkey_deinit(pubkey)

2457

2458

# Convert the buffer to a Python bytestring

2459

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

2460

# Convert the bytestring to hexadecimal notation

2461

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

2462

return hex_key_id

2463

1823

2464

@staticmethod

1824

2465

def fingerprint(openpgp):

1825

2466

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1826

2467

# New GnuTLS "datum" with the OpenPGP public key

1827

datum = (gnutls.library.types

1828

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

1829

ctypes.POINTER

1830

(ctypes.c_ubyte)),

1831

ctypes.c_uint(len(openpgp))))

2468

datum = gnutls.datum_t(

2469

ctypes.cast(ctypes.c_char_p(openpgp),

2470

ctypes.POINTER(ctypes.c_ubyte)),

2471

ctypes.c_uint(len(openpgp)))

1832

2472

# New empty GnuTLS certificate

1833

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2473

crt = gnutls.openpgp_crt_t()

2474

gnutls.openpgp_crt_init(ctypes.byref(crt))

1836

2475

# Import the OpenPGP public key into the certificate

1837

(gnutls.library.functions

1838

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

1839

gnutls.library.constants

1840

.GNUTLS_OPENPGP_FMT_RAW))

2476

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

2477

gnutls.OPENPGP_FMT_RAW)

1841

2478

# Verify the self signature in the key

1842

2479

crtverify = ctypes.c_uint()

1843

(gnutls.library.functions

1844

.gnutls_openpgp_crt_verify_self(crt, 0,

1845

ctypes.byref(crtverify)))

2480

gnutls.openpgp_crt_verify_self(crt, 0,

2481

ctypes.byref(crtverify))

1846

2482

if crtverify.value != 0:

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1848

raise (gnutls.errors.CertificateSecurityError

1849

("Verify failed"))

2483

gnutls.openpgp_crt_deinit(crt)

2484

raise gnutls.CertificateSecurityError(code

2485

=crtverify.value)

1850

2486

# New buffer for the fingerprint

1851

2487

buf = ctypes.create_string_buffer(20)

1852

2488

buf_len = ctypes.c_size_t()

1853

2489

# Get the fingerprint from the certificate into the buffer

1854

(gnutls.library.functions

1855

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

1856

ctypes.byref(buf_len)))

2490

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

2491

ctypes.byref(buf_len))

1857

2492

# Deinit the certificate

1858

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2493

gnutls.openpgp_crt_deinit(crt)

1859

2494

# Convert the buffer to a Python bytestring

1860

2495

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

1861

2496

# Convert the bytestring to hexadecimal notation

1865

2500

1866

2501

class MultiprocessingMixIn(object):

1867

2502

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

2503

1868

2504

def sub_process_main(self, request, address):

1869

2505

try:

1870

2506

self.finish_request(request, address)

1871

2507

except Exception:

1872

2508

self.handle_error(request, address)

1873

2509

self.close_request(request)

1874

2510

1875

2511

def process_request(self, request, address):

1876

2512

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

1877

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

1878

args = (request, address))

2513

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

2514

args=(request, address))

1879

2515

proc.start()

1880

2516

return proc

1881

2517

1882

2518

1883

2519

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1884

2520

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

2521

1885

2522

def process_request(self, request, client_address):

1886

2523

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

1887

2524

1888

2525

This function creates a new pipe in self.pipe

1889

2526

"""

1890

2527

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1891

2528

1892

2529

proc = MultiprocessingMixIn.process_request(self, request,

1893

2530

client_address)

1894

2531

self.child_pipe.close()

1895

2532

self.add_pipe(parent_pipe, proc)

1896

2533

1897

2534

def add_pipe(self, parent_pipe, proc):

1898

2535

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

1899

raise NotImplementedError

2536

raise NotImplementedError()

1900

2537

1901

2538

1902

2539

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1903

2540

socketserver.TCPServer, object):

1904

2541

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

1905

2542

1906

2543

Attributes:

1907

2544

enabled: Boolean; whether this server is activated yet

1908

2545

interface: None or a network interface name (string)

1909

2546

use_ipv6: Boolean; to use IPv6 or not

1910

2547

"""

2548

1911

2549

def __init__(self, server_address, RequestHandlerClass,

1912

interface=None, use_ipv6=True, socketfd=None):

2550

interface=None,

2551

use_ipv6=True,

2552

socketfd=None):

1913

2553

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

1914

2554

creating a new one with socket.socket().

1915

2555

"""

1921

2561

self.socketfd = socketfd

1922

2562

# Save the original socket.socket() function

1923

2563

self.socket_socket = socket.socket

2564

1924

2565

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

1925

#

2566

#

1926

2567

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

1927

2568

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

1928

2569

# patching socket.socket.)

1929

#

2570

#

1930

2571

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

1931

2572

@functools.wraps(socket.socket)

1932

2573

def socket_wrapper(*args, **kwargs):

1944

2585

# socket_wrapper(), if socketfd was set.

1945

2586

socketserver.TCPServer.__init__(self, server_address,

1946

2587

RequestHandlerClass)

1947

2588

1948

2589

def server_bind(self):

1949

2590

"""This overrides the normal server_bind() function

1950

2591

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

1951

2592

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

2593

global SO_BINDTODEVICE

1952

2594

if self.interface is not None:

1953

2595

if SO_BINDTODEVICE is None:

1954

logger.error("SO_BINDTODEVICE does not exist;"

1955

" cannot bind to interface %s",

1956

self.interface)

1957

else:

1958

try:

1959

self.socket.setsockopt(socket.SOL_SOCKET,

1960

SO_BINDTODEVICE,

1961

str(self.interface + '\0'))

1962

except socket.error as error:

1963

if error.errno == errno.EPERM:

1964

logger.error("No permission to bind to"

1965

" interface %s", self.interface)

1966

elif error.errno == errno.ENOPROTOOPT:

1967

logger.error("SO_BINDTODEVICE not available;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

elif error.errno == errno.ENODEV:

1971

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

1972

" cannot bind", self.interface)

1973

else:

1974

raise

2596

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

2597

# common enough.

2598

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

2599

SO_BINDTODEVICE = 25

2600

try:

2601

self.socket.setsockopt(

2602

socket.SOL_SOCKET, SO_BINDTODEVICE,

2603

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

2604

except socket.error as error:

2605

if error.errno == errno.EPERM:

2606

logger.error("No permission to bind to"

2607

" interface %s", self.interface)

2608

elif error.errno == errno.ENOPROTOOPT:

2609

logger.error("SO_BINDTODEVICE not available;"

2610

" cannot bind to interface %s",

2611

self.interface)

2612

elif error.errno == errno.ENODEV:

2613

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

2614

" cannot bind", self.interface)

2615

else:

2616

raise

1975

2617

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

1976

2618

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

1977

2619

if not self.server_address[0]:

1978

2620

if self.address_family == socket.AF_INET6:

1979

any_address = "::" # in6addr_any

2621

any_address = "::" # in6addr_any

1980

2622

else:

1981

any_address = socket.INADDR_ANY

2623

any_address = "0.0.0.0" # INADDR_ANY

1982

2624

self.server_address = (any_address,

1983

2625

self.server_address[1])

1984

2626

elif not self.server_address[1]:

1985

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

1986

0)

2627

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

1987

2628

# if self.interface:

1988

2629

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

1989

2630

# 0, # port

1995

2636

1996

2637

class MandosServer(IPv6_TCPServer):

1997

2638

"""Mandos server.

1998

2639

1999

2640

Attributes:

2000

2641

clients: set of Client objects

2001

2642

gnutls_priority GnuTLS priority string

2002

2643

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

2003

2004

Assumes a gobject.MainLoop event loop.

2644

2645

Assumes a GLib.MainLoop event loop.

2005

2646

"""

2647

2006

2648

def __init__(self, server_address, RequestHandlerClass,

2007

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

2008

gnutls_priority=None, use_dbus=True, socketfd=None):

2649

interface=None,

2650

use_ipv6=True,

2651

clients=None,

2652

gnutls_priority=None,

2653

use_dbus=True,

2654

socketfd=None):

2009

2655

self.enabled = False

2010

2656

self.clients = clients

2011

2657

if self.clients is None:

2014

2660

self.gnutls_priority = gnutls_priority

2015

2661

IPv6_TCPServer.__init__(self, server_address,

2016

2662

RequestHandlerClass,

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2663

interface=interface,

2664

use_ipv6=use_ipv6,

2665

socketfd=socketfd)

2666

2020

2667

def server_activate(self):

2021

2668

if self.enabled:

2022

2669

return socketserver.TCPServer.server_activate(self)

2023

2670

2024

2671

def enable(self):

2025

2672

self.enabled = True

2026

2673

2027

2674

def add_pipe(self, parent_pipe, proc):

2028

2675

# Call "handle_ipc" for both data and EOF events

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2035

2036

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

2037

proc = None, client_object=None):

2676

GLib.io_add_watch(

2677

parent_pipe.fileno(),

2678

GLib.IO_IN | GLib.IO_HUP,

2679

functools.partial(self.handle_ipc,

2680

parent_pipe=parent_pipe,

2681

proc=proc))

2682

2683

def handle_ipc(self, source, condition,

2684

parent_pipe=None,

2685

proc=None,

2686

client_object=None):

2038

2687

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

2039

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

2688

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

2040

2689

# Wait for other process to exit

2041

2690

proc.join()

2042

2691

return False

2043

2692

2044

2693

# Read a request from the child

2045

2694

request = parent_pipe.recv()

2046

2695

command = request[0]

2047

2696

2048

2697

if command == 'init':

2049

fpr = request[1]

2050

address = request[2]

2051

2052

for c in self.clients.itervalues():

2053

if c.fingerprint == fpr:

2698

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

2699

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

2700

address = request[3]

2701

2702

for c in self.clients.values():

2703

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2704

continue

2705

if key_id and c.key_id == key_id:

2706

client = c

2707

break

2708

if fpr and c.fingerprint == fpr:

2054

2709

client = c

2055

2710

break

2056

2711

else:

2057

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

2058

"dress: %s", fpr, address)

2712

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

2713

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

2059

2714

if self.use_dbus:

2060

2715

# Emit D-Bus signal

2061

mandos_dbus_service.ClientNotFound(fpr,

2716

mandos_dbus_service.ClientNotFound(key_id or fpr,

2062

2717

address[0])

2063

2718

parent_pipe.send(False)

2064

2719

return False

2065

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2720

2721

GLib.io_add_watch(

2722

parent_pipe.fileno(),

2723

GLib.IO_IN | GLib.IO_HUP,

2724

functools.partial(self.handle_ipc,

2725

parent_pipe=parent_pipe,

2726

proc=proc,

2727

client_object=client))

2074

2728

parent_pipe.send(True)

2075

2729

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

2076

2730

# same fileno

2079

2733

funcname = request[1]

2080

2734

args = request[2]

2081

2735

kwargs = request[3]

2082

2736

2083

2737

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

2084

2738

funcname)(*args,

2085

**kwargs)))

2086

2739

**kwargs)))

2740

2087

2741

if command == 'getattr':

2088

2742

attrname = request[1]

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2743

if isinstance(client_object.__getattribute__(attrname),

2744

collections.Callable):

2745

parent_pipe.send(('function', ))

2091

2746

else:

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2747

parent_pipe.send((

2748

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

2749

2095

2750

if command == 'setattr':

2096

2751

attrname = request[1]

2097

2752

value = request[2]

2098

2753

setattr(client_object, attrname, value)

2099

2754

2100

2755

return True

2101

2756

2102

2757

2103

2758

def rfc3339_duration_to_delta(duration):

2104

2759

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

2105

2760

2106

2761

>>> rfc3339_duration_to_delta("P7D")

2107

2762

datetime.timedelta(7)

2108

2763

>>> rfc3339_duration_to_delta("PT60S")

2118

2773

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

2774

datetime.timedelta(1, 200)

2120

2775

"""

2121

2776

2122

2777

# Parsing an RFC 3339 duration with regular expressions is not

2123

2778

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

2124

2779

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

2125

2780

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

2126

2781

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

2127

2782

# avoid excessive use of external libraries.

2128

2783

2129

2784

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

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2785

Token = collections.namedtuple("Token", (

2786

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

2787

# a "group" containing digits

2788

"value", # datetime.timedelta or None

2789

"followers")) # Tokens valid after this token

2139

2790

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

2140

2791

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

2141

2792

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

2142

2793

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

2143

2794

datetime.timedelta(seconds=1),

2144

frozenset((token_end,)))

2795

frozenset((token_end, )))

2145

2796

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

2146

2797

datetime.timedelta(minutes=1),

2147

2798

frozenset((token_second, token_end)))

2163

2814

frozenset((token_month, token_end)))

2164

2815

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

2165

2816

datetime.timedelta(weeks=1),

2166

frozenset((token_end,)))

2817

frozenset((token_end, )))

2167

2818

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

2168

2819

frozenset((token_year, token_month,

2169

2820

token_day, token_time,

2170

token_week))),

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2821

token_week)))

2822

# Define starting values:

2823

# Value so far

2824

value = datetime.timedelta()

2173

2825

found_token = None

2174

followers = frozenset(token_duration,) # Following valid tokens

2175

s = duration # String left to parse

2826

# Following valid tokens

2827

followers = frozenset((token_duration, ))

2828

# String left to parse

2829

s = duration

2176

2830

# Loop until end token is found

2177

2831

while found_token is not token_end:

2178

2832

# Search for any currently valid tokens

2194

2848

break

2195

2849

else:

2196

2850

# No currently valid tokens were found

2197

raise ValueError("Invalid RFC 3339 duration")

2851

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

2852

.format(duration))

2198

2853

# End token found

2199

2854

return value

2200

2855

2201

2856

2202

2857

def string_to_delta(interval):

2203

2858

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

2204

2859

2205

2860

>>> string_to_delta('7d')

2206

2861

datetime.timedelta(7)

2207

2862

>>> string_to_delta('60s')

2215

2870

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

2216

2871

datetime.timedelta(0, 330)

2217

2872

"""

2218

2873

2219

2874

try:

2220

2875

return rfc3339_duration_to_delta(interval)

2221

2876

except ValueError:

2222

2877

pass

2223

2878

2224

2879

timevalue = datetime.timedelta(0)

2225

2880

for s in interval.split():

2226

2881

try:

2227

suffix = unicode(s[-1])

2882

suffix = s[-1]

2228

2883

value = int(s[:-1])

2229

2884

if suffix == "d":

2230

2885

delta = datetime.timedelta(value)

2237

2892

elif suffix == "w":

2238

2893

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

2239

2894

else:

2240

raise ValueError("Unknown suffix {0!r}"

2241

.format(suffix))

2242

except (ValueError, IndexError) as e:

2895

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

2896

except IndexError as e:

2243

2897

raise ValueError(*(e.args))

2244

2898

timevalue += delta

2245

2899

return timevalue

2246

2900

2247

2901

2248

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

2902

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

2249

2903

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

2250

2904

2251

2905

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

2252

2906

if os.fork():

2253

2907

sys.exit()

2261

2915

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

2262

2916

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

2263

2917

raise OSError(errno.ENODEV,

2264

"{0} not a character device"

2918

"{} not a character device"

2265

2919

.format(os.devnull))

2266

2920

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

2267

2921

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

2271

2925

2272

2926

2273

2927

def main():

2274

2928

2275

2929

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

2276

2930

# Parsing of options, both command line and config file

2277

2931

2278

2932

parser = argparse.ArgumentParser()

2279

2933

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

2280

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

2934

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

2281

2935

help="show version number and exit")

2282

2936

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

2283

2937

help="Bind to interface IF")

2289

2943

help="Run self-test")

2290

2944

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

2291

2945

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

2292

" to terminal")

2946

" to terminal", default=None)

2293

2947

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

2294

2948

help="Debug level for stdout output")

2295

2949

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

2302

2956

" files")

2303

2957

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

2304

2958

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

2305

" system bus interface")

2959

" system bus interface", default=None)

2306

2960

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

2307

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

2961

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

2962

default=None)

2308

2963

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

2309

2964

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

2310

" state")

2965

" state", default=None)

2311

2966

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

2312

2967

help="Specify a file descriptor to a network"

2313

2968

" socket to use instead of creating one")

2314

2969

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

2315

2970

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

2316

2971

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

2317

help="Run in foreground")

2318

2972

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

2973

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

2974

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

2975

default=None)

2976

2319

2977

options = parser.parse_args()

2320

2978

2321

2979

if options.check:

2322

2980

import doctest

2323

doctest.testmod()

2324

sys.exit()

2325

2981

fail_count, test_count = doctest.testmod()

2982

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

2983

2326

2984

# Default values for config file for server-global settings

2327

server_defaults = { "interface": "",

2328

"address": "",

2329

"port": "",

2330

"debug": "False",

2331

"priority":

2332

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

2333

"servicename": "Mandos",

2334

"use_dbus": "True",

2335

"use_ipv6": "True",

2336

"debuglevel": "",

2337

"restore": "True",

2338

"socket": "",

2339

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

2340

"foreground": "False",

2341

}

2342

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2343

3008

# Parse config file for server-global settings

2344

3009

server_config = configparser.SafeConfigParser(server_defaults)

2345

3010

del server_defaults

2346

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

2347

"mandos.conf"))

3011

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

2348

3012

# Convert the SafeConfigParser object to a dict

2349

3013

server_settings = server_config.defaults()

2350

3014

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

2351

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

3015

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

3016

"foreground", "zeroconf"):

2352

3017

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

2353

3018

option)

2354

3019

if server_settings["port"]:

2364

3029

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

2365

3030

["socket"])

2366

3031

del server_config

2367

3032

2368

3033

# Override the settings from the config file with command line

2369

3034

# options, if set.

2370

3035

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

2371

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

2372

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

2373

"statedir", "socket", "foreground"):

3036

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

3037

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

3038

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

2374

3039

value = getattr(options, option)

2375

3040

if value is not None:

2376

3041

server_settings[option] = value

2377

3042

del options

2378

3043

# Force all strings to be unicode

2379

3044

for option in server_settings.keys():

2380

if type(server_settings[option]) is str:

2381

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

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

3048

# Force all boolean options to be boolean

3049

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

3050

"foreground", "zeroconf"):

3051

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

2382

3052

# Debug implies foreground

2383

3053

if server_settings["debug"]:

2384

3054

server_settings["foreground"] = True

2385

3055

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

2386

3056

2387

3057

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

2388

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2389

3064

# For convenience

2390

3065

debug = server_settings["debug"]

2391

3066

debuglevel = server_settings["debuglevel"]

2394

3069

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

2395

3070

stored_state_file)

2396

3071

foreground = server_settings["foreground"]

2397

3072

zeroconf = server_settings["zeroconf"]

3073

2398

3074

if debug:

2399

3075

initlogger(debug, logging.DEBUG)

2400

3076

else:

2403

3079

else:

2404

3080

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

2405

3081

initlogger(debug, level)

2406

3082

2407

3083

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

2408

syslogger.setFormatter(logging.Formatter

2409

('Mandos ({0}) [%(process)d]:'

2410

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

2411

.format(server_settings

2412

["servicename"])))

2413

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2414

3089

# Parse config file with clients

2415

3090

client_config = configparser.SafeConfigParser(Client

2416

3091

.client_defaults)

2417

3092

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

2418

3093

"clients.conf"))

2419

3094

2420

3095

global mandos_dbus_service

2421

3096

mandos_dbus_service = None

2422

2423

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

2424

server_settings["port"]),

2425

ClientHandler,

2426

interface=(server_settings["interface"]

2427

or None),

2428

use_ipv6=use_ipv6,

2429

gnutls_priority=

2430

server_settings["priority"],

2431

use_dbus=use_dbus,

2432

socketfd=(server_settings["socket"]

2433

or None))

3097

3098

socketfd = None

3099

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

3100

socketfd = server_settings["socket"]

3101

tcp_server = MandosServer(

3102

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

3103

ClientHandler,

3104

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

3105

use_ipv6=use_ipv6,

3106

gnutls_priority=server_settings["priority"],

3107

use_dbus=use_dbus,

3108

socketfd=socketfd)

2434

3109

if not foreground:

2435

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

3110

pidfilename = "/run/mandos.pid"

3111

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

3112

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

2436

3113

pidfile = None

2437

3114

try:

2438

pidfile = open(pidfilename, "w")

3115

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

2439

3116

except IOError as e:

2440

3117

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

2441

3118

exc_info=e)

2442

2443

for name in ("_mandos", "mandos", "nobody"):

3119

3120

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

3121

("mandos", "mandos"),

3122

("nobody", "nogroup")):

2444

3123

try:

2445

3124

uid = pwd.getpwnam(name).pw_uid

2446

gid = pwd.getpwnam(name).pw_gid

3125

gid = pwd.getpwnam(group).pw_gid

2447

3126

break

2448

3127

except KeyError:

2449

3128

continue

2453

3132

try:

2454

3133

os.setgid(gid)

2455

3134

os.setuid(uid)

3135

if debug:

3136

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

3137

gid))

2456

3138

except OSError as error:

3139

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

3140

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

2457

3141

if error.errno != errno.EPERM:

2458

raise error

2459

3142

raise

3143

2460

3144

if debug:

2461

3145

# Enable all possible GnuTLS debugging

2462

3146

2463

3147

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

2464

3148

# - GnuTLS manual

2465

gnutls.library.functions.gnutls_global_set_log_level(11)

2466

2467

@gnutls.library.types.gnutls_log_func

3149

gnutls.global_set_log_level(11)

3150

3151

@gnutls.log_func

2468

3152

def debug_gnutls(level, string):

2469

3153

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

2470

2471

(gnutls.library.functions

2472

.gnutls_global_set_log_function(debug_gnutls))

2473

3154

3155

gnutls.global_set_log_function(debug_gnutls)

3156

2474

3157

# Redirect stdin so all checkers get /dev/null

2475

3158

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

2476

3159

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

2477

3160

if null > 2:

2478

3161

os.close(null)

2479

3162

2480

3163

# Need to fork before connecting to D-Bus

2481

3164

if not foreground:

2482

3165

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

2483

3166

daemon()

2484

2485

# multiprocessing will use threads, so before we use gobject we

2486

# need to inform gobject that threads will be used.

2487

gobject.threads_init()

2488

3167

3168

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

3169

# to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2489

3172

global main_loop

2490

3173

# From the Avahi example code

2491

3174

DBusGMainLoop(set_as_default=True)

2492

main_loop = gobject.MainLoop()

3175

main_loop = GLib.MainLoop()

2493

3176

bus = dbus.SystemBus()

2494

3177

# End of Avahi example code

2495

3178

if use_dbus:

2496

3179

try:

2497

3180

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

2498

bus, do_not_queue=True)

2499

old_bus_name = (dbus.service.BusName

2500

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

2501

do_not_queue=True))

2502

except dbus.exceptions.NameExistsException as e:

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

2503

3187

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

2504

3188

use_dbus = False

2505

3189

server_settings["use_dbus"] = False

2506

3190

tcp_server.use_dbus = False

2507

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2508

service = AvahiServiceToSyslog(name =

2509

server_settings["servicename"],

2510

servicetype = "_mandos._tcp",

2511

protocol = protocol, bus = bus)

2512

if server_settings["interface"]:

2513

service.interface = (if_nametoindex

2514

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

2515

3191

if zeroconf:

3192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

3198

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2516

3202

global multiprocessing_manager

2517

3203

multiprocessing_manager = multiprocessing.Manager()

2518

3204

2519

3205

client_class = Client

2520

3206

if use_dbus:

2521

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

2522

3207

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

3208

2523

3209

client_settings = Client.config_parser(client_config)

2524

3210

old_client_settings = {}

2525

3211

clients_data = {}

2526

3212

3213

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

3214

global wnull

3215

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

3216

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

3217

# mode

3218

if debug or not foreground:

3219

wnull.close()

3220

2527

3221

# Get client data and settings from last running state.

2528

3222

if server_settings["restore"]:

2529

3223

try:

2530

3224

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

2531

clients_data, old_client_settings = (pickle.load

2532

(stored_state))

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name & .host

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if not value.has_key("key_id"):

3257

value["key_id"] = ""

3258

elif not value.has_key("fingerprint"):

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host

3270

for value in old_client_settings.values():

3271

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

3272

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

3273

.decode("utf-8"))

2533

3274

os.remove(stored_state_path)

2534

3275

except IOError as e:

2535

3276

if e.errno == errno.ENOENT:

2536

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

2537

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

3277

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

3278

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

2538

3279

else:

2539

3280

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

2540

3281

exc_info=e)

2541

3282

raise

2542

3283

except EOFError as e:

2543

3284

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

2544

"EOFError:", exc_info=e)

2545

3285

"EOFError:",

3286

exc_info=e)

3287

2546

3288

with PGPEngine() as pgp:

2547

for client_name, client in clients_data.iteritems():

3289

for client_name, client in clients_data.items():

3290

# Skip removed clients

3291

if client_name not in client_settings:

3292

continue

3293

2548

3294

# Decide which value to use after restoring saved state.

2549

3295

# We have three different values: Old config file,

2550

3296

# new config file, and saved state.

2555

3301

# For each value in new config, check if it

2556

3302

# differs from the old config value (Except for

2557

3303

# the "secret" attribute)

2558

if (name != "secret" and

2559

value != old_client_settings[client_name]

2560

[name]):

3304

if (name != "secret"

3305

and (value !=

3306

old_client_settings[client_name][name])):

2561

3307

client[name] = value

2562

3308

except KeyError:

2563

3309

pass

2564

3310

2565

3311

# Clients who has passed its expire date can still be

2566

# enabled if its last checker was successful. Clients

3312

# enabled if its last checker was successful. A Client

2567

3313

# whose checker succeeded before we stored its state is

2568

3314

# assumed to have successfully run all checkers during

2569

3315

# downtime.

2571

3317

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

2572

3318

if not client["last_checked_ok"]:

2573

3319

logger.warning(

2574

"disabling client {0} - Client never "

2575

"performed a successful checker"

2576

.format(client_name))

3320

"disabling client {} - Client never "

3321

"performed a successful checker".format(

3322

client_name))

2577

3323

client["enabled"] = False

2578

3324

elif client["last_checker_status"] != 0:

2579

3325

logger.warning(

2580

"disabling client {0} - Client "

2581

"last checker failed with error code {1}"

2582

.format(client_name,

2583

client["last_checker_status"]))

3326

"disabling client {} - Client last"

3327

" checker failed with error code"

3328

" {}".format(

3329

client_name,

3330

client["last_checker_status"]))

2584

3331

client["enabled"] = False

2585

3332

else:

2586

client["expires"] = (datetime.datetime

2587

.utcnow()

2588

+ client["timeout"])

3333

client["expires"] = (

3334

datetime.datetime.utcnow()

3335

+ client["timeout"])

2589

3336

logger.debug("Last checker succeeded,"

2590

" keeping {0} enabled"

2591

.format(client_name))

3337

" keeping {} enabled".format(

3338

client_name))

2592

3339

try:

2593

client["secret"] = (

2594

pgp.decrypt(client["encrypted_secret"],

2595

client_settings[client_name]

2596

["secret"]))

3340

client["secret"] = pgp.decrypt(

3341

client["encrypted_secret"],

3342

client_settings[client_name]["secret"])

2597

3343

except PGPError:

2598

3344

# If decryption fails, we use secret from new settings

2599

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

2600

.format(client_name))

2601

client["secret"] = (

2602

client_settings[client_name]["secret"])

2603

3345

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

3346

client_name))

3347

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

3348

["secret"])

3349

2604

3350

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

2605

3351

for client_name in (set(old_client_settings)

2606

3352

- set(client_settings)):

2608

3354

for client_name in (set(client_settings)

2609

3355

- set(old_client_settings)):

2610

3356

clients_data[client_name] = client_settings[client_name]

2611

3357

2612

3358

# Create all client objects

2613

for client_name, client in clients_data.iteritems():

3359

for client_name, client in clients_data.items():

2614

3360

tcp_server.clients[client_name] = client_class(

2615

name = client_name, settings = client)

2616

3361

name=client_name,

3362

settings=client,

3363

server_settings=server_settings)

3364

2617

3365

if not tcp_server.clients:

2618

3366

logger.warning("No clients defined")

2619

3367

2620

3368

if not foreground:

2621

3369

if pidfile is not None:

3370

pid = os.getpid()

2622

3371

try:

2623

3372

with pidfile:

2624

pid = os.getpid()

2625

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

3373

print(pid, file=pidfile)

2626

3374

except IOError:

2627

3375

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

2628

3376

pidfilename, pid)

2629

3377

del pidfile

2630

3378

del pidfilename

2631

2632

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

2633

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

2634

3379

3380

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

3381

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3382

lambda: main_loop.quit() and False)

3383

2635

3384

if use_dbus:

2636

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

2637

"se.bsnet.fukt.Mandos"})

2638

class MandosDBusService(DBusObjectWithProperties):

3385

3386

@alternate_dbus_interfaces(

3387

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

3388

class MandosDBusService(DBusObjectWithObjectManager):

2639

3389

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

3390

2640

3391

def __init__(self):

2641

3392

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

3393

2642

3394

_interface = "se.recompile.Mandos"

2643

2644

@dbus_interface_annotations(_interface)

2645

def _foo(self):

2646

return { "org.freedesktop.DBus.Property"

2647

".EmitsChangedSignal":

2648

"false"}

2649

3395

2650

3396

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

2651

3397

def ClientAdded(self, objpath):

2652

3398

"D-Bus signal"

2653

3399

pass

2654

3400

2655

3401

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

2656

def ClientNotFound(self, fingerprint, address):

3402

def ClientNotFound(self, key_id, address):

2657

3403

"D-Bus signal"

2658

3404

pass

2659

3405

3406

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

3407

"true"})

2660

3408

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

2661

3409

def ClientRemoved(self, objpath, name):

2662

3410

"D-Bus signal"

2663

3411

pass

2664

3412

3413

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

3414

"true"})

2665

3415

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

2666

3416

def GetAllClients(self):

2667

3417

"D-Bus method"

2668

return dbus.Array(c.dbus_object_path

2669

for c in

2670

tcp_server.clients.itervalues())

2671

3418

return dbus.Array(c.dbus_object_path for c in

3419

tcp_server.clients.values())

3420

3421

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

3422

"true"})

2672

3423

@dbus.service.method(_interface,

2673

3424

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

2674

3425

def GetAllClientsWithProperties(self):

2675

3426

"D-Bus method"

2676

3427

return dbus.Dictionary(

2677

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

2678

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

3428

{c.dbus_object_path: c.GetAll(

3429

"se.recompile.Mandos.Client")

3430

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

2679

3431

signature="oa{sv}")

2680

3432

2681

3433

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

2682

3434

def RemoveClient(self, object_path):

2683

3435

"D-Bus method"

2684

for c in tcp_server.clients.itervalues():

3436

for c in tcp_server.clients.values():

2685

3437

if c.dbus_object_path == object_path:

2686

3438

del tcp_server.clients[c.name]

2687

3439

c.remove_from_connection()

2688

# Don't signal anything except ClientRemoved

3440

# Don't signal the disabling

2689

3441

c.disable(quiet=True)

2690

# Emit D-Bus signal

2691

self.ClientRemoved(object_path, c.name)

3442

# Emit D-Bus signal for removal

3443

self.client_removed_signal(c)

2692

3444

return

2693

3445

raise KeyError(object_path)

2694

3446

2695

3447

del _interface

2696

3448

3449

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3450

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

3451

def GetManagedObjects(self):

3452

"""D-Bus method"""

3453

return dbus.Dictionary(

3454

{client.dbus_object_path:

3455

dbus.Dictionary(

3456

{interface: client.GetAll(interface)

3457

for interface in

3458

client._get_all_interface_names()})

3459

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

3460

3461

def client_added_signal(self, client):

3462

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

3463

if use_dbus:

3464

# New standard signal

3465

self.InterfacesAdded(

3466

client.dbus_object_path,

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()}))

3471

# Old signal

3472

self.ClientAdded(client.dbus_object_path)

3473

3474

def client_removed_signal(self, client):

3475

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

3476

if use_dbus:

3477

# New standard signal

3478

self.InterfacesRemoved(

3479

client.dbus_object_path,

3480

client._get_all_interface_names())

3481

# Old signal

3482

self.ClientRemoved(client.dbus_object_path,

3483

client.name)

3484

2697

3485

mandos_dbus_service = MandosDBusService()

2698

3486

3487

# Save modules to variables to exempt the modules from being

3488

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

3489

mp = multiprocessing

3490

wn = wnull

3491

2699

3492

def cleanup():

2700

3493

"Cleanup function; run on exit"

2701

service.cleanup()

2702

2703

multiprocessing.active_children()

3494

if zeroconf:

3495

service.cleanup()

3496

3497

mp.active_children()

3498

wn.close()

2704

3499

if not (tcp_server.clients or client_settings):

2705

3500

return

2706

3501

2707

3502

# Store client before exiting. Secrets are encrypted with key

2708

3503

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

2709

3504

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

2710

3505

clients = {}

2711

3506

with PGPEngine() as pgp:

2712

for client in tcp_server.clients.itervalues():

3507

for client in tcp_server.clients.values():

2713

3508

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

2714

3509

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

2715

3510

key)

2716

3511

client_dict = {}

2717

3512

2718

3513

# A list of attributes that can not be pickled

2719

3514

# + secret.

2720

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

2721

"checker"))

2722

for name, typ in (inspect.getmembers

2723

(dbus.service.Object)):

3515

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

3516

"checker", "server_settings"}

3517

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

3518

.Object):

2724

3519

exclude.add(name)

2725

3520

2726

3521

client_dict["encrypted_secret"] = (client

2727

3522

.encrypted_secret)

2728

3523

for attr in client.client_structure:

2729

3524

if attr not in exclude:

2730

3525

client_dict[attr] = getattr(client, attr)

2731

3526

2732

3527

clients[client.name] = client_dict

2733

3528

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

2734

3529

2735

3530

try:

2736

with (tempfile.NamedTemporaryFile

2737

(mode='wb', suffix=".pickle", prefix='clients-',

2738

dir=os.path.dirname(stored_state_path),

2739

delete=False)) as stored_state:

2740

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

2741

tempname=stored_state.name

3531

with tempfile.NamedTemporaryFile(

3532

mode='wb',

3533

suffix=".pickle",

3534

prefix='clients-',

3535

dir=os.path.dirname(stored_state_path),

3536

delete=False) as stored_state:

3537

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

3538

protocol=2)

3539

tempname = stored_state.name

2742

3540

os.rename(tempname, stored_state_path)

2743

3541

except (IOError, OSError) as e:

2744

3542

if not debug:

2747

3545

except NameError:

2748

3546

pass

2749

3547

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

2750

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

3548

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

2751

3549

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

2752

3550

else:

2753

3551

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

2754

3552

exc_info=e)

2755

raise e

2756

3553

raise

3554

2757

3555

# Delete all clients, and settings from config

2758

3556

while tcp_server.clients:

2759

3557

name, client = tcp_server.clients.popitem()

2760

3558

if use_dbus:

2761

3559

client.remove_from_connection()

2762

# Don't signal anything except ClientRemoved

3560

# Don't signal the disabling

2763

3561

client.disable(quiet=True)

3562

# Emit D-Bus signal for removal

2764

3563

if use_dbus:

2765

# Emit D-Bus signal

2766

mandos_dbus_service.ClientRemoved(client

2767

.dbus_object_path,

2768

client.name)

3564

mandos_dbus_service.client_removed_signal(client)

2769

3565

client_settings.clear()

2770

3566

2771

3567

atexit.register(cleanup)

2772

2773

for client in tcp_server.clients.itervalues():

3568

3569

for client in tcp_server.clients.values():

2774

3570

if use_dbus:

2775

# Emit D-Bus signal

2776

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3571

# Emit D-Bus signal for adding

3572

mandos_dbus_service.client_added_signal(client)

2777

3573

# Need to initiate checking of clients

2778

3574

if client.enabled:

2779

3575

client.init_checker()

2780

3576

2781

3577

tcp_server.enable()

2782

3578

tcp_server.server_activate()

2783

3579

2784

3580

# Find out what port we got

2785

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

3581

if zeroconf:

3582

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

2786

3583

if use_ipv6:

2787

3584

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

2788

3585

" flowinfo %d, scope_id %d",

2790

3587

else: # IPv4

2791

3588

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

2792

3589

*tcp_server.socket.getsockname())

2793

2794

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

2795

3590

3591

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

3592

2796

3593

try:

2797

# From the Avahi example code

2798

try:

2799

service.activate()

2800

except dbus.exceptions.DBusException as error:

2801

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

2802

cleanup()

2803

sys.exit(1)

2804

# End of Avahi example code

2805

2806

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

2807

lambda *args, **kwargs:

2808

(tcp_server.handle_request

2809

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

2810

3594

if zeroconf:

3595

# From the Avahi example code

3596

try:

3597

service.activate()

3598

except dbus.exceptions.DBusException as error:

3599

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

3600

cleanup()

3601

sys.exit(1)

3602

# End of Avahi example code

3603

3604

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

3605

lambda *args, **kwargs:

3606

(tcp_server.handle_request

3607

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

3608

2811

3609

logger.debug("Starting main loop")

2812

3610

main_loop.run()

2813

3611

except AvahiError as error:

2822

3620

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

2823

3621

cleanup()

2824

3622

3623

2825

3624

if __name__ == '__main__':

2826

3625

main()