/mandos/trunk : revision 1039

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

import SocketServer as socketserver

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

38

47

import socket

39

48

import argparse

40

49

import datetime

41

50

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

49

55

import sys

50

56

import re

51

57

import os

60

66

import struct

61

67

import fcntl

62

68

import functools

63

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

64

73

import multiprocessing

65

74

import types

66

75

import binascii

67

76

import tempfile

68

77

import itertools

78

import collections

79

import codecs

69

80

70

81

import dbus

71

82

import dbus.service

72

import gobject

73

import avahi

83

from gi.repository import GLib

74

84

from dbus.mainloop.glib import DBusGMainLoop

75

85

import ctypes

76

86

import ctypes.util

77

87

import xml.dom.minidom

78

88

import inspect

79

import GnuPGInterface

80

89

90

# Try to find the value of SO_BINDTODEVICE:

81

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:

82

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

83

95

except AttributeError:

84

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

85

99

from IN import SO_BINDTODEVICE

86

100

except ImportError:

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.3"

90

119

stored_state_file = "clients.pickle"

91

120

92

121

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

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

114

155

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

115

156

"""init logger and add loglevel"""

116

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

117

162

syslogger.setFormatter(logging.Formatter

118

163

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

119

164

' %(message)s'))

120

165

logger.addHandler(syslogger)

121

166

122

167

if debug:

123

168

console = logging.StreamHandler()

124

169

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

136

181

137

182

class PGPEngine(object):

138

183

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

184

139

185

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

186

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

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

149

206

def __enter__(self):

150

207

return self

151

152

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

208

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

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

179

with open(os.devnull, "w") as devnull:

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

192

256

return ciphertext

193

257

194

258

def decrypt(self, data, password):

195

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

196

with open(os.devnull, "w") as devnull:

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

209

274

return decrypted_plaintext

210

275

211

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

212

304

class AvahiError(Exception):

213

305

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

214

306

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

307

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

308

**kwargs)

309

218

310

219

311

class AvahiServiceError(AvahiError):

220

312

pass

221

313

314

222

315

class AvahiGroupError(AvahiError):

223

316

pass

224

317

225

318

226

319

class AvahiService(object):

227

320

"""An Avahi (Zeroconf) service.

228

321

229

322

Attributes:

230

323

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

231

324

Used to optionally bind to the specified interface.

232

325

name: string; Example: 'Mandos'

233

326

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

234

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

327

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

235

328

port: integer; what port to announce

236

329

TXT: list of strings; TXT record for the service

237

330

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

243

336

server: D-Bus Server

244

337

bus: dbus.SystemBus()

245

338

"""

246

247

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

248

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

249

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

250

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

251

351

self.interface = interface

252

352

self.name = name

253

353

self.type = servicetype

262

362

self.server = None

263

363

self.bus = bus

264

364

self.entry_group_state_changed_match = None

265

266

def rename(self):

365

366

def rename(self, remove=True):

267

367

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

268

368

if self.rename_count >= self.max_renames:

269

369

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

270

370

" after %i retries, exiting.",

271

371

self.rename_count)

272

372

raise AvahiServiceError("Too many renames")

273

self.name = unicode(self.server

274

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

275

376

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

276

377

self.name)

277

self.remove()

378

if remove:

379

self.remove()

278

380

try:

279

381

self.add()

280

382

except dbus.exceptions.DBusException as error:

281

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

282

self.cleanup()

283

os._exit(1)

284

self.rename_count += 1

285

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

286

392

def remove(self):

287

393

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

288

394

if self.entry_group_state_changed_match is not None:

290

396

self.entry_group_state_changed_match = None

291

397

if self.group is not None:

292

398

self.group.Reset()

293

399

294

400

def add(self):

295

401

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

296

402

self.remove()

313

419

dbus.UInt16(self.port),

314

420

avahi.string_array_to_txt_array(self.TXT))

315

421

self.group.Commit()

316

422

317

423

def entry_group_state_changed(self, state, error):

318

424

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

319

425

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

320

426

321

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

322

428

logger.debug("Zeroconf service established.")

323

429

elif state == avahi.ENTRY_GROUP_COLLISION:

325

431

self.rename()

326

432

elif state == avahi.ENTRY_GROUP_FAILURE:

327

433

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

328

unicode(error))

329

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

330

.format(error))

331

434

str(error))

435

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

436

332

437

def cleanup(self):

333

438

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

334

439

if self.group is not None:

339

444

pass

340

445

self.group = None

341

446

self.remove()

342

447

343

448

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

344

449

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

345

450

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

346

bad_states = { avahi.SERVER_INVALID:

347

"Zeroconf server invalid",

348

avahi.SERVER_REGISTERING: None,

349

avahi.SERVER_COLLISION:

350

"Zeroconf server name collision",

351

avahi.SERVER_FAILURE:

352

"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

}

353

457

if state in bad_states:

354

458

if bad_states[state] is not None:

355

459

if error is None:

358

462

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

359

463

self.cleanup()

360

464

elif state == avahi.SERVER_RUNNING:

361

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)

362

477

else:

363

478

if error is None:

364

479

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

365

480

else:

366

481

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

367

482

368

483

def activate(self):

369

484

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

370

485

if self.server is None:

374

489

follow_name_owner_changes=True),

375

490

avahi.DBUS_INTERFACE_SERVER)

376

491

self.server.connect_to_signal("StateChanged",

377

self.server_state_changed)

492

self.server_state_changed)

378

493

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

379

494

495

380

496

class AvahiServiceToSyslog(AvahiService):

381

def rename(self):

497

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

382

498

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

383

ret = AvahiService.rename(self)

384

syslogger.setFormatter(logging.Formatter

385

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

386

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

387

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

388

503

return ret

389

504

390

def timedelta_to_milliseconds(td):

391

"Convert a datetime.timedelta() to milliseconds"

392

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

393

+ (td.seconds * 1000)

394

+ (td.microseconds // 1000))

505

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

_tls_rawpk_version = b"3.6.6"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CRT_RAWPK = 3

535

CLIENT = 2

536

SHUT_RDWR = 0

537

CRD_CERTIFICATE = 1

538

E_NO_CERTIFICATE_FOUND = -49

539

X509_FMT_DER = 0

540

NO_TICKETS = 1<<10

541

ENABLE_RAWPK = 1<<18

542

CTYPE_PEERS = 3

543

KEYID_USE_SHA256 = 1 # gnutls/x509.h

544

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

545

546

# Types

547

class session_int(ctypes.Structure):

548

_fields_ = []

549

session_t = ctypes.POINTER(session_int)

550

551

class certificate_credentials_st(ctypes.Structure):

552

_fields_ = []

553

certificate_credentials_t = ctypes.POINTER(

554

certificate_credentials_st)

555

certificate_type_t = ctypes.c_int

556

557

class datum_t(ctypes.Structure):

558

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

559

('size', ctypes.c_uint)]

560

561

class openpgp_crt_int(ctypes.Structure):

562

_fields_ = []

563

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

564

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

565

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

566

credentials_type_t = ctypes.c_int

567

transport_ptr_t = ctypes.c_void_p

568

close_request_t = ctypes.c_int

569

570

# Exceptions

571

class Error(Exception):

572

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

573

# exception might be raised from within GnuTLS.__init__,

574

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

575

# global variable has happened.

576

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

577

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

578

# code is passed, convert it to a string with

579

# gnutls.strerror()

580

self.code = code

581

if message is None and code is not None:

582

message = GnuTLS.strerror(code)

583

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

584

message, *args)

585

586

class CertificateSecurityError(Error):

587

pass

588

589

# Classes

590

class Credentials(object):

591

def __init__(self):

592

self._c_object = gnutls.certificate_credentials_t()

593

gnutls.certificate_allocate_credentials(

594

ctypes.byref(self._c_object))

595

self.type = gnutls.CRD_CERTIFICATE

596

597

def __del__(self):

598

gnutls.certificate_free_credentials(self._c_object)

599

600

class ClientSession(object):

601

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

602

self._c_object = gnutls.session_t()

603

gnutls_flags = gnutls.CLIENT

604

if gnutls.check_version("3.5.6"):

605

gnutls_flags |= gnutls.NO_TICKETS

606

if gnutls.has_rawpk:

607

gnutls_flags |= gnutls.ENABLE_RAWPK

608

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

609

del gnutls_flags

610

gnutls.set_default_priority(self._c_object)

611

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

612

gnutls.handshake_set_private_extensions(self._c_object,

613

True)

614

self.socket = socket

615

if credentials is None:

616

credentials = gnutls.Credentials()

617

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

618

ctypes.cast(credentials._c_object,

619

ctypes.c_void_p))

620

self.credentials = credentials

621

622

def __del__(self):

623

gnutls.deinit(self._c_object)

624

625

def handshake(self):

626

return gnutls.handshake(self._c_object)

627

628

def send(self, data):

629

data = bytes(data)

630

data_len = len(data)

631

while data_len > 0:

632

data_len -= gnutls.record_send(self._c_object,

633

data[-data_len:],

634

data_len)

635

636

def bye(self):

637

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

638

639

# Error handling functions

640

def _error_code(result):

641

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

642

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

643

if result >= 0:

644

return result

645

if result == gnutls.E_NO_CERTIFICATE_FOUND:

646

raise gnutls.CertificateSecurityError(code=result)

647

raise gnutls.Error(code=result)

648

649

def _retry_on_error(result, func, arguments):

650

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

651

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

652

while result < 0:

653

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

654

return _error_code(result)

655

result = func(*arguments)

656

return result

657

658

# Unless otherwise indicated, the function declarations below are

659

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

660

661

# Functions

662

priority_set_direct = _library.gnutls_priority_set_direct

663

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

664

ctypes.POINTER(ctypes.c_char_p)]

665

priority_set_direct.restype = _error_code

666

667

init = _library.gnutls_init

668

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

669

init.restype = _error_code

670

671

set_default_priority = _library.gnutls_set_default_priority

672

set_default_priority.argtypes = [session_t]

673

set_default_priority.restype = _error_code

674

675

record_send = _library.gnutls_record_send

676

record_send.argtypes = [session_t, ctypes.c_void_p,

677

ctypes.c_size_t]

678

record_send.restype = ctypes.c_ssize_t

679

record_send.errcheck = _retry_on_error

680

681

certificate_allocate_credentials = (

682

_library.gnutls_certificate_allocate_credentials)

683

certificate_allocate_credentials.argtypes = [

684

ctypes.POINTER(certificate_credentials_t)]

685

certificate_allocate_credentials.restype = _error_code

686

687

certificate_free_credentials = (

688

_library.gnutls_certificate_free_credentials)

689

certificate_free_credentials.argtypes = [

690

certificate_credentials_t]

691

certificate_free_credentials.restype = None

692

693

handshake_set_private_extensions = (

694

_library.gnutls_handshake_set_private_extensions)

695

handshake_set_private_extensions.argtypes = [session_t,

696

ctypes.c_int]

697

handshake_set_private_extensions.restype = None

698

699

credentials_set = _library.gnutls_credentials_set

700

credentials_set.argtypes = [session_t, credentials_type_t,

701

ctypes.c_void_p]

702

credentials_set.restype = _error_code

703

704

strerror = _library.gnutls_strerror

705

strerror.argtypes = [ctypes.c_int]

706

strerror.restype = ctypes.c_char_p

707

708

certificate_type_get = _library.gnutls_certificate_type_get

709

certificate_type_get.argtypes = [session_t]

710

certificate_type_get.restype = _error_code

711

712

certificate_get_peers = _library.gnutls_certificate_get_peers

713

certificate_get_peers.argtypes = [session_t,

714

ctypes.POINTER(ctypes.c_uint)]

715

certificate_get_peers.restype = ctypes.POINTER(datum_t)

716

717

global_set_log_level = _library.gnutls_global_set_log_level

718

global_set_log_level.argtypes = [ctypes.c_int]

719

global_set_log_level.restype = None

720

721

global_set_log_function = _library.gnutls_global_set_log_function

722

global_set_log_function.argtypes = [log_func]

723

global_set_log_function.restype = None

724

725

deinit = _library.gnutls_deinit

726

deinit.argtypes = [session_t]

727

deinit.restype = None

728

729

handshake = _library.gnutls_handshake

730

handshake.argtypes = [session_t]

731

handshake.restype = _error_code

732

handshake.errcheck = _retry_on_error

733

734

transport_set_ptr = _library.gnutls_transport_set_ptr

735

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

736

transport_set_ptr.restype = None

737

738

bye = _library.gnutls_bye

739

bye.argtypes = [session_t, close_request_t]

740

bye.restype = _error_code

741

bye.errcheck = _retry_on_error

742

743

check_version = _library.gnutls_check_version

744

check_version.argtypes = [ctypes.c_char_p]

745

check_version.restype = ctypes.c_char_p

746

747

has_rawpk = bool(check_version(_tls_rawpk_version))

748

749

if has_rawpk:

750

# Types

751

class pubkey_st(ctypes.Structure):

752

_fields = []

753

pubkey_t = ctypes.POINTER(pubkey_st)

754

755

x509_crt_fmt_t = ctypes.c_int

756

757

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

758

pubkey_init = _library.gnutls_pubkey_init

759

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

760

pubkey_init.restype = _error_code

761

762

pubkey_import = _library.gnutls_pubkey_import

763

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

764

x509_crt_fmt_t]

765

pubkey_import.restype = _error_code

766

767

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

768

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

769

ctypes.POINTER(ctypes.c_ubyte),

770

ctypes.POINTER(ctypes.c_size_t)]

771

pubkey_get_key_id.restype = _error_code

772

773

pubkey_deinit = _library.gnutls_pubkey_deinit

774

pubkey_deinit.argtypes = [pubkey_t]

775

pubkey_deinit.restype = None

776

else:

777

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

778

779

openpgp_crt_init = _library.gnutls_openpgp_crt_init

780

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

781

openpgp_crt_init.restype = _error_code

782

783

openpgp_crt_import = _library.gnutls_openpgp_crt_import

784

openpgp_crt_import.argtypes = [openpgp_crt_t,

785

ctypes.POINTER(datum_t),

786

openpgp_crt_fmt_t]

787

openpgp_crt_import.restype = _error_code

788

789

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

790

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

791

ctypes.POINTER(ctypes.c_uint)]

792

openpgp_crt_verify_self.restype = _error_code

793

794

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

795

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

796

openpgp_crt_deinit.restype = None

797

798

openpgp_crt_get_fingerprint = (

799

_library.gnutls_openpgp_crt_get_fingerprint)

800

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

801

ctypes.c_void_p,

802

ctypes.POINTER(

803

ctypes.c_size_t)]

804

openpgp_crt_get_fingerprint.restype = _error_code

805

806

if check_version("3.6.4"):

807

certificate_type_get2 = _library.gnutls_certificate_type_get2

808

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

809

certificate_type_get2.restype = _error_code

810

811

# Remove non-public functions

812

del _error_code, _retry_on_error

813

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

814

gnutls = GnuTLS()

815

816

817

def call_pipe(connection, # : multiprocessing.Connection

818

func, *args, **kwargs):

819

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

820

821

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

822

return value on the provided multiprocessing.Connection.

823

"""

824

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

825

connection.close()

826

395

827

396

828

class Client(object):

397

829

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

398

830

399

831

Attributes:

400

832

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

401

833

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

403

835

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

404

836

to see if the client lives.

405

837

'None' if no process is running.

406

checker_callback_tag: a gobject event source tag, or None

838

checker_callback_tag: a GLib event source tag, or None

407

839

checker_command: string; External command which is run to check

408

840

if client lives. %() expansions are done at

409

841

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

410

842

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

411

checker_initiator_tag: a gobject event source tag, or None

843

checker_initiator_tag: a GLib event source tag, or None

412

844

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

413

845

client_structure: Object describing what attributes a client has

414

846

and is used for storing the client at exit

415

847

current_checker_command: string; current running checker_command

416

disable_initiator_tag: a gobject event source tag, or None

848

disable_initiator_tag: a GLib event source tag, or None

417

849

enabled: bool()

418

850

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

419

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

420

854

host: string; available for use by the checker command

421

855

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

422

856

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

424

858

last_checker_status: integer between 0 and 255 reflecting exit

425

859

status of last checker. -1 reflects crashed

426

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

427

863

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

428

864

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

429

865

D-Bus identifiers

434

870

runtime_expansions: Allowed attributes for runtime expansion.

435

871

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

436

872

disabled, or None

873

server_settings: The server_settings dict from main()

437

874

"""

438

875

439

876

runtime_expansions = ("approval_delay", "approval_duration",

440

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

441

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

877

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

878

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

879

"last_approval_request", "last_checked_ok",

442

880

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

443

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

444

"extended_timeout": "15m",

445

"interval": "2m",

446

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

447

"host": "",

448

"approval_delay": "0s",

449

"approval_duration": "1s",

450

"approved_by_default": "True",

451

"enabled": "True",

452

}

453

454

def timeout_milliseconds(self):

455

"Return the 'timeout' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.timeout)

457

458

def extended_timeout_milliseconds(self):

459

"Return the 'extended_timeout' attribute in milliseconds"

460

return timedelta_to_milliseconds(self.extended_timeout)

461

462

def interval_milliseconds(self):

463

"Return the 'interval' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.interval)

465

466

def approval_delay_milliseconds(self):

467

return timedelta_to_milliseconds(self.approval_delay)

468

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

469

893

@staticmethod

470

894

def config_parser(config):

471

895

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

478

902

for client_name in config.sections():

479

903

section = dict(config.items(client_name))

480

904

client = settings[client_name] = {}

481

905

482

906

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

483

907

# Reformat values from string types to Python types

484

908

client["approved_by_default"] = config.getboolean(

485

909

client_name, "approved_by_default")

486

910

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

487

911

"enabled")

488

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

489

918

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

490

919

.replace(" ", ""))

491

920

if "secret" in section:

492

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

921

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

922

.encode("utf-8"),

923

"base64")

493

924

elif "secfile" in section:

494

925

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

495

926

(section["secfile"])),

496

927

"rb") as secfile:

497

928

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

498

929

else:

499

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

930

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

500

931

.format(section))

501

932

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

502

933

client["extended_timeout"] = string_to_delta(

510

941

client["last_approval_request"] = None

511

942

client["last_checked_ok"] = None

512

943

client["last_checker_status"] = -2

513

944

514

945

return settings

515

516

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

946

947

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

517

948

self.name = name

949

if server_settings is None:

950

server_settings = {}

951

self.server_settings = server_settings

518

952

# adding all client settings

519

for setting, value in settings.iteritems():

953

for setting, value in settings.items():

520

954

setattr(self, setting, value)

521

955

522

956

if self.enabled:

523

957

if not hasattr(self, "last_enabled"):

524

958

self.last_enabled = datetime.datetime.utcnow()

528

962

else:

529

963

self.last_enabled = None

530

964

self.expires = None

531

965

532

966

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

533

# Uppercase and remove spaces from fingerprint for later

534

# comparison purposes with return value from the fingerprint()

535

# function

967

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

536

968

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

537

969

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

538

970

datetime.datetime.utcnow())

539

971

540

972

# attributes specific for this server instance

541

973

self.checker = None

542

974

self.checker_initiator_tag = None

545

977

self.current_checker_command = None

546

978

self.approved = None

547

979

self.approvals_pending = 0

548

self.changedstate = (multiprocessing_manager

549

.Condition(multiprocessing_manager

550

.Lock()))

551

self.client_structure = [attr for attr in

552

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

553

984

if not attr.startswith("_")]

554

985

self.client_structure.append("client_structure")

555

556

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

557

lambda obj:

558

isinstance(obj,

559

property)):

986

987

for name, t in inspect.getmembers(

988

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

560

989

if not name.startswith("_"):

561

990

self.client_structure.append(name)

562

991

563

992

# Send notice to process children that client state has changed

564

993

def send_changedstate(self):

565

994

with self.changedstate:

566

995

self.changedstate.notify_all()

567

996

568

997

def enable(self):

569

998

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

570

999

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

571

1000

# Already enabled

572

1001

return

573

self.send_changedstate()

574

1002

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

575

1003

self.enabled = True

576

1004

self.last_enabled = datetime.datetime.utcnow()

577

1005

self.init_checker()

578

1006

self.send_changedstate()

1007

579

1008

def disable(self, quiet=True):

580

1009

"""Disable this client."""

581

1010

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

582

1011

return False

583

1012

if not quiet:

584

self.send_changedstate()

585

if not quiet:

586

1013

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

587

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

588

gobject.source_remove(self.disable_initiator_tag)

1014

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

1015

GLib.source_remove(self.disable_initiator_tag)

589

1016

self.disable_initiator_tag = None

590

1017

self.expires = None

591

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

592

gobject.source_remove(self.checker_initiator_tag)

1018

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

1019

GLib.source_remove(self.checker_initiator_tag)

593

1020

self.checker_initiator_tag = None

594

1021

self.stop_checker()

595

1022

self.enabled = False

596

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

1023

if not quiet:

1024

self.send_changedstate()

1025

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

597

1026

return False

598

1027

599

1028

def __del__(self):

600

1029

self.disable()

601

1030

602

1031

def init_checker(self):

603

1032

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

604

1033

# and every interval from then on.

605

self.checker_initiator_tag = (gobject.timeout_add

606

(self.interval_milliseconds(),

607

self.start_checker))

1034

if self.checker_initiator_tag is not None:

1035

GLib.source_remove(self.checker_initiator_tag)

1036

self.checker_initiator_tag = GLib.timeout_add(

1037

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

1038

self.start_checker)

608

1039

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

609

self.disable_initiator_tag = (gobject.timeout_add

610

(self.timeout_milliseconds(),

611

self.disable))

1040

if self.disable_initiator_tag is not None:

1041

GLib.source_remove(self.disable_initiator_tag)

1042

self.disable_initiator_tag = GLib.timeout_add(

1043

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

612

1044

# Also start a new checker *right now*.

613

1045

self.start_checker()

614

615

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

1046

1047

def checker_callback(self, source, condition, connection,

1048

command):

616

1049

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

617

1050

self.checker_callback_tag = None

618

1051

self.checker = None

619

if os.WIFEXITED(condition):

620

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

621

1059

if self.last_checker_status == 0:

622

1060

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

623

1061

vars(self))

624

1062

self.checked_ok()

625

1063

else:

626

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

627

vars(self))

1064

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

628

1065

else:

629

1066

self.last_checker_status = -1

1067

self.last_checker_signal = -returncode

630

1068

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

631

1069

vars(self))

632

1070

return False

1071

633

1072

def checked_ok(self):

634

1073

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

635

1074

self.last_checked_ok = datetime.datetime.utcnow()

636

1075

self.last_checker_status = 0

1076

self.last_checker_signal = None

637

1077

self.bump_timeout()

638

1078

639

1079

def bump_timeout(self, timeout=None):

640

1080

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

641

1081

if timeout is None:

642

1082

timeout = self.timeout

643

1083

if self.disable_initiator_tag is not None:

644

gobject.source_remove(self.disable_initiator_tag)

1084

GLib.source_remove(self.disable_initiator_tag)

1085

self.disable_initiator_tag = None

645

1086

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

646

self.disable_initiator_tag = (gobject.timeout_add

647

(timedelta_to_milliseconds

648

(timeout), self.disable))

1087

self.disable_initiator_tag = GLib.timeout_add(

1088

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

649

1089

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

650

1090

651

1091

def need_approval(self):

652

1092

self.last_approval_request = datetime.datetime.utcnow()

653

1093

654

1094

def start_checker(self):

655

1095

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

656

1096

657

1097

If a checker already exists, leave it running and do

658

1098

nothing."""

659

1099

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

660

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

661

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

662

# client would inevitably timeout, since no checker would get

663

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

1100

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

1101

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

1102

# would inevitably timeout, since no checker would get a

1103

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

664

1104

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

665

1105

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

666

1106

# should be.

667

668

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

669

try:

670

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

671

except (AttributeError, OSError) as error:

672

if (isinstance(error, OSError)

673

and error.errno != errno.ECHILD):

674

raise error

675

else:

676

if pid:

677

logger.warning("Checker was a zombie")

678

gobject.source_remove(self.checker_callback_tag)

679

self.checker_callback(pid, status,

680

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

681

1112

# Start a new checker if needed

682

1113

if self.checker is None:

1114

# Escape attributes for the shell

1115

escaped_attrs = {

1116

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

1117

for attr in self.runtime_expansions}

683

1118

try:

684

# In case checker_command has exactly one % operator

685

command = self.checker_command % self.host

686

except TypeError:

687

# Escape attributes for the shell

688

escaped_attrs = dict(

689

(attr,

690

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

691

errors=

692

'replace')))

693

for attr in

694

self.runtime_expansions)

695

696

try:

697

command = self.checker_command % escaped_attrs

698

except TypeError as error:

699

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

700

self.checker_command, exc_info=error)

701

return True # Try again later

1119

command = self.checker_command % escaped_attrs

1120

except TypeError as error:

1121

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

1122

self.checker_command,

1123

exc_info=error)

1124

return True # Try again later

702

1125

self.current_checker_command = command

703

try:

704

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

705

command, self.name)

706

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

707

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

708

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

709

# always replaced by /dev/null.)

710

self.checker = subprocess.Popen(command,

711

close_fds=True,

712

shell=True, cwd="/")

713

self.checker_callback_tag = (gobject.child_watch_add

714

(self.checker.pid,

715

self.checker_callback,

716

data=command))

717

# The checker may have completed before the gobject

718

# watch was added. Check for this.

719

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

720

if pid:

721

gobject.source_remove(self.checker_callback_tag)

722

self.checker_callback(pid, status, command)

723

except OSError as error:

724

logger.error("Failed to start subprocess",

725

exc_info=error)

726

# 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

727

1152

return True

728

1153

729

1154

def stop_checker(self):

730

1155

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

731

1156

if self.checker_callback_tag:

732

gobject.source_remove(self.checker_callback_tag)

1157

GLib.source_remove(self.checker_callback_tag)

733

1158

self.checker_callback_tag = None

734

1159

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

735

1160

return

736

1161

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

737

try:

738

self.checker.terminate()

739

#time.sleep(0.5)

740

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

741

# self.checker.kill()

742

except OSError as error:

743

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

744

raise

1162

self.checker.terminate()

745

1163

self.checker = None

746

1164

747

1165

748

def dbus_service_property(dbus_interface, signature="v",

749

access="readwrite", byte_arrays=False):

1166

def dbus_service_property(dbus_interface,

1167

signature="v",

1168

access="readwrite",

1169

byte_arrays=False):

750

1170

"""Decorators for marking methods of a DBusObjectWithProperties to

751

1171

become properties on the D-Bus.

752

1172

753

1173

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

754

1174

and with one argument by "Set".

755

1175

756

1176

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

757

1177

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

758

1178

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

761

1181

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

762

1182

if byte_arrays and signature != "ay":

763

1183

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

764

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

1184

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

1185

765

1186

def decorator(func):

766

1187

func._dbus_is_property = True

767

1188

func._dbus_interface = dbus_interface

770

1191

func._dbus_name = func.__name__

771

1192

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

772

1193

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

773

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1194

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

774

1195

return func

1196

775

1197

return decorator

776

1198

777

1199

778

1200

def dbus_interface_annotations(dbus_interface):

779

1201

"""Decorator for marking functions returning interface annotations

780

1202

781

1203

Usage:

782

1204

783

1205

@dbus_interface_annotations("org.example.Interface")

784

1206

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

785

1207

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

786

1208

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

787

1209

"false"}

788

1210

"""

1211

789

1212

def decorator(func):

790

1213

func._dbus_is_interface = True

791

1214

func._dbus_interface = dbus_interface

792

1215

func._dbus_name = dbus_interface

793

1216

return func

1217

794

1218

return decorator

795

1219

796

1220

797

1221

def dbus_annotations(annotations):

798

1222

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

799

1223

Usage:

800

1224

1225

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

1226

"org.freedesktop.DBus.Property."

1227

"EmitsChangedSignal": "false"})

801

1228

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

802

1229

access="r")

803

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

804

"org.freedesktop.DBus.Property."

805

"EmitsChangedSignal": "false"})

806

1230

def Property_dbus_property(self):

807

1231

return dbus.Boolean(False)

1232

1233

See also the DBusObjectWithAnnotations class.

808

1234

"""

1235

809

1236

def decorator(func):

810

1237

func._dbus_annotations = annotations

811

1238

return func

1239

812

1240

return decorator

813

1241

814

1242

815

1243

class DBusPropertyException(dbus.exceptions.DBusException):

816

1244

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

817

1245

"""

818

def __unicode__(self):

819

return unicode(str(self))

1246

pass

820

1247

821

1248

822

1249

class DBusPropertyAccessException(DBusPropertyException):

831

1258

pass

832

1259

833

1260

834

class DBusObjectWithProperties(dbus.service.Object):

835

"""A D-Bus object with properties.

836

837

Classes inheriting from this can use the dbus_service_property

838

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

839

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.

840

1266

"""

841

1267

842

1268

@staticmethod

843

1269

def _is_dbus_thing(thing):

844

1270

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

845

1271

846

1272

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

847

1273

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

848

1274

"""

849

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

1275

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

850

1276

False)

851

1277

852

1278

def _get_all_dbus_things(self, thing):

853

1279

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

854

1280

"""

855

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

856

name),

1281

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

857

1282

athing.__get__(self))

858

1283

for cls in self.__class__.__mro__

859

1284

for name, athing in

860

inspect.getmembers(cls,

861

self._is_dbus_thing(thing)))

862

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

863

1358

def _get_dbus_property(self, interface_name, property_name):

864

1359

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

865

1360

property with the specified name and interface.

866

1361

"""

867

for cls in self.__class__.__mro__:

868

for name, value in (inspect.getmembers

869

(cls,

870

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

871

1365

if (value._dbus_name == property_name

872

1366

and value._dbus_interface == interface_name):

873

1367

return value.__get__(self)

874

1368

875

1369

# No such property

876

raise DBusPropertyNotFound(self.dbus_object_path + ":"

877

+ interface_name + "."

878

+ property_name)

879

880

@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",

881

1384

out_signature="v")

882

1385

def Get(self, interface_name, property_name):

883

1386

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

889

1392

if not hasattr(value, "variant_level"):

890

1393

return value

891

1394

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

892

1395

893

1396

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

894

1397

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

895

1398

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

901

1404

# The byte_arrays option is not supported yet on

902

1405

# signatures other than "ay".

903

1406

if prop._dbus_signature != "ay":

904

raise ValueError

1407

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

1408

"'ay' signature {!r}"

1409

.format(prop._dbus_signature))

905

1410

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

906

1411

for byte in value))

907

1412

prop(value)

908

909

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

1413

1414

@dbus.service.method(dbus.PROPERTIES_IFACE,

1415

in_signature="s",

910

1416

out_signature="a{sv}")

911

1417

def GetAll(self, interface_name):

912

1418

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

913

1419

standard.

914

1420

915

1421

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

916

1422

"""

917

1423

properties = {}

927

1433

if not hasattr(value, "variant_level"):

928

1434

properties[name] = value

929

1435

continue

930

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

931

value.variant_level+1)

1436

properties[name] = type(value)(

1437

value, variant_level=value.variant_level + 1)

932

1438

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

933

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

934

1448

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

935

1449

out_signature="s",

936

1450

path_keyword='object_path',

937

1451

connection_keyword='connection')

938

1452

def Introspect(self, object_path, connection):

939

1453

"""Overloading of standard D-Bus method.

940

1454

941

1455

Inserts property tags and interface annotation tags.

942

1456

"""

943

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

944

connection)

1457

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1458

object_path,

1459

connection)

945

1460

try:

946

1461

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

1462

947

1463

def make_tag(document, name, prop):

948

1464

e = document.createElement("property")

949

1465

e.setAttribute("name", name)

950

1466

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

951

1467

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

952

1468

return e

1469

953

1470

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

954

1471

# Add property tags

955

1472

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

958

1475

if prop._dbus_interface

959

1476

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

960

1477

if_tag.appendChild(tag)

961

# Add annotation tags

962

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

963

for tag in if_tag.getElementsByTagName(typ):

964

annots = dict()

965

for name, prop in (self.

966

_get_all_dbus_things(typ)):

967

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

968

and prop._dbus_interface

969

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

970

annots.update(getattr

971

(prop,

972

"_dbus_annotations",

973

{}))

974

for name, value in annots.iteritems():

975

ann_tag = document.createElement(

976

"annotation")

977

ann_tag.setAttribute("name", name)

978

ann_tag.setAttribute("value", value)

979

tag.appendChild(ann_tag)

980

# Add interface annotation tags

981

for annotation, value in dict(

982

itertools.chain.from_iterable(

983

annotations().iteritems()

984

for name, annotations in

985

self._get_all_dbus_things("interface")

986

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

987

)).iteritems():

988

ann_tag = document.createElement("annotation")

989

ann_tag.setAttribute("name", annotation)

990

ann_tag.setAttribute("value", value)

991

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)

992

1494

# Add the names to the return values for the

993

1495

# "org.freedesktop.DBus.Properties" methods

994

1496

if (if_tag.getAttribute("name")

1013

1515

return xmlstring

1014

1516

1015

1517

1016

def datetime_to_dbus (dt, variant_level=0):

1518

try:

1519

dbus.OBJECT_MANAGER_IFACE

1520

except AttributeError:

1521

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

1522

1523

1524

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1525

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

1526

1527

Classes inheriting from this exposes the standard

1528

GetManagedObjects call and the InterfacesAdded and

1529

InterfacesRemoved signals on the standard

1530

"org.freedesktop.DBus.ObjectManager" interface.

1531

1532

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

1533

manually.

1534

"""

1535

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def GetManagedObjects(self):

1538

"""This function must be overridden"""

1539

raise NotImplementedError()

1540

1541

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def InterfacesAdded(self, object_path, interfaces_and_properties):

1544

pass

1545

1546

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

1547

def InterfacesRemoved(self, object_path, interfaces):

1548

pass

1549

1550

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1551

out_signature="s",

1552

path_keyword='object_path',

1553

connection_keyword='connection')

1554

def Introspect(self, object_path, connection):

1555

"""Overloading of standard D-Bus method.

1556

1557

Override return argument name of GetManagedObjects to be

1558

"objpath_interfaces_and_properties"

1559

"""

1560

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1561

object_path,

1562

connection)

1563

try:

1564

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

1565

1566

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

1567

# Fix argument name for the GetManagedObjects method

1568

if (if_tag.getAttribute("name")

1569

== dbus.OBJECT_MANAGER_IFACE):

1570

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

1571

if (cn.getAttribute("name")

1572

== "GetManagedObjects"):

1573

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

1574

if (arg.getAttribute("direction")

1575

== "out"):

1576

arg.setAttribute(

1577

"name",

1578

"objpath_interfaces"

1579

"_and_properties")

1580

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

1581

document.unlink()

1582

except (AttributeError, xml.dom.DOMException,

1583

xml.parsers.expat.ExpatError) as error:

1584

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

1585

exc_info=error)

1586

return xmlstring

1587

1588

1589

def datetime_to_dbus(dt, variant_level=0):

1017

1590

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

1018

1591

if dt is None:

1019

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

1020

return dbus.String(dt.isoformat(),

1021

variant_level=variant_level)

1592

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

1593

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

1022

1594

1023

1595

1024

1596

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1026

1598

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

1027

1599

interface names according to the "alt_interface_names" mapping.

1028

1600

Usage:

1029

1030

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

1031

"net.example.AlternateInterface"})

1601

1602

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

1603

"net.example.AlternateInterface"})

1032

1604

class SampleDBusObject(dbus.service.Object):

1033

1605

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

1034

1606

def SampleDBusMethod():

1035

1607

pass

1036

1608

1037

1609

The above "SampleDBusMethod" on "SampleDBusObject" will be

1038

1610

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

1039

1611

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

1040

1612

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

1041

1613

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

1042

1614

1043

1615

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

1044

1616

(from DBusObjectWithProperties) and interfaces (from the

1045

1617

dbus_interface_annotations decorator).

1046

1618

"""

1619

1047

1620

def wrapper(cls):

1048

1621

for orig_interface_name, alt_interface_name in (

1049

alt_interface_names.iteritems()):

1622

alt_interface_names.items()):

1050

1623

attr = {}

1051

1624

interface_names = set()

1052

1625

# Go though all attributes of the class

1054

1627

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

1055

1628

# with the wrong interface name

1056

1629

if (not hasattr(attribute, "_dbus_interface")

1057

or not attribute._dbus_interface

1058

.startswith(orig_interface_name)):

1630

or not attribute._dbus_interface.startswith(

1631

orig_interface_name)):

1059

1632

continue

1060

1633

# Create an alternate D-Bus interface name based on

1061

1634

# the current name

1062

alt_interface = (attribute._dbus_interface

1063

.replace(orig_interface_name,

1064

alt_interface_name))

1635

alt_interface = attribute._dbus_interface.replace(

1636

orig_interface_name, alt_interface_name)

1065

1637

interface_names.add(alt_interface)

1066

1638

# Is this a D-Bus signal?

1067

1639

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

1068

# Extract the original non-method function by

1069

# black magic

1070

nonmethod_func = (dict(

1640

# Extract the original non-method undecorated

1641

# function by black magic

1642

if sys.version_info.major == 2:

1643

nonmethod_func = (dict(

1071

1644

zip(attribute.func_code.co_freevars,

1072

attribute.__closure__))["func"]

1073

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

1074

1652

# Create a new, but exactly alike, function

1075

1653

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

1076

1654

# with the alternate D-Bus interface name

1077

new_function = (dbus.service.signal

1078

(alt_interface,

1079

attribute._dbus_signature)

1080

(types.FunctionType(

1081

nonmethod_func.func_code,

1082

nonmethod_func.func_globals,

1083

nonmethod_func.func_name,

1084

nonmethod_func.func_defaults,

1085

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

1086

1659

# Copy annotations, if any

1087

1660

try:

1088

new_function._dbus_annotations = (

1089

dict(attribute._dbus_annotations))

1661

new_function._dbus_annotations = dict(

1662

attribute._dbus_annotations)

1090

1663

except AttributeError:

1091

1664

pass

1665

1092

1666

# Define a creator of a function to call both the

1093

1667

# original and alternate functions, so both the

1094

1668

# original and alternate signals gets sent when

1097

1671

"""This function is a scope container to pass

1098

1672

func1 and func2 to the "call_both" function

1099

1673

outside of its arguments"""

1674

1675

@functools.wraps(func2)

1100

1676

def call_both(*args, **kwargs):

1101

1677

"""This function will emit two D-Bus

1102

1678

signals by calling func1 and func2"""

1103

1679

func1(*args, **kwargs)

1104

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

1105

1687

return call_both

1106

1688

# Create the "call_both" function and add it to

1107

1689

# the class

1112

1694

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

1113

1695

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

1114

1696

# to the class.

1115

attr[attrname] = (dbus.service.method

1116

(alt_interface,

1117

attribute._dbus_in_signature,

1118

attribute._dbus_out_signature)

1119

(types.FunctionType

1120

(attribute.func_code,

1121

attribute.func_globals,

1122

attribute.func_name,

1123

attribute.func_defaults,

1124

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

1125

1703

# Copy annotations, if any

1126

1704

try:

1127

attr[attrname]._dbus_annotations = (

1128

dict(attribute._dbus_annotations))

1705

attr[attrname]._dbus_annotations = dict(

1706

attribute._dbus_annotations)

1129

1707

except AttributeError:

1130

1708

pass

1131

1709

# Is this a D-Bus property?

1134

1712

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

1135

1713

# property with the alternate D-Bus interface

1136

1714

# name. Add it to the class.

1137

attr[attrname] = (dbus_service_property

1138

(alt_interface,

1139

attribute._dbus_signature,

1140

attribute._dbus_access,

1141

attribute

1142

._dbus_get_args_options

1143

["byte_arrays"])

1144

(types.FunctionType

1145

(attribute.func_code,

1146

attribute.func_globals,

1147

attribute.func_name,

1148

attribute.func_defaults,

1149

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

1150

1721

# Copy annotations, if any

1151

1722

try:

1152

attr[attrname]._dbus_annotations = (

1153

dict(attribute._dbus_annotations))

1723

attr[attrname]._dbus_annotations = dict(

1724

attribute._dbus_annotations)

1154

1725

except AttributeError:

1155

1726

pass

1156

1727

# Is this a D-Bus interface?

1159

1730

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

1160

1731

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

1161

1732

# to the class.

1162

attr[attrname] = (dbus_interface_annotations

1163

(alt_interface)

1164

(types.FunctionType

1165

(attribute.func_code,

1166

attribute.func_globals,

1167

attribute.func_name,

1168

attribute.func_defaults,

1169

attribute.func_closure)))

1733

attr[attrname] = (

1734

dbus_interface_annotations(alt_interface)

1735

(copy_function(attribute)))

1170

1736

if deprecate:

1171

1737

# Deprecate all alternate interfaces

1172

iname="_AlternateDBusNames_interface_annotation{0}"

1738

iname = "_AlternateDBusNames_interface_annotation{}"

1173

1739

for interface_name in interface_names:

1740

1174

1741

@dbus_interface_annotations(interface_name)

1175

1742

def func(self):

1176

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

1177

"true" }

1743

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

1744

"true"}

1178

1745

# Find an unused name

1179

1746

for aname in (iname.format(i)

1180

1747

for i in itertools.count()):

1184

1751

if interface_names:

1185

1752

# Replace the class with a new subclass of it with

1186

1753

# methods, signals, etc. as created above.

1187

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

1188

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

1189

1760

return cls

1761

1190

1762

return wrapper

1191

1763

1192

1764

1193

1765

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

1194

"se.bsnet.fukt.Mandos"})

1766

"se.bsnet.fukt.Mandos"})

1195

1767

class ClientDBus(Client, DBusObjectWithProperties):

1196

1768

"""A Client class using D-Bus

1197

1769

1198

1770

Attributes:

1199

1771

dbus_object_path: dbus.ObjectPath

1200

1772

bus: dbus.SystemBus()

1201

1773

"""

1202

1774

1203

1775

runtime_expansions = (Client.runtime_expansions

1204

+ ("dbus_object_path",))

1205

1776

+ ("dbus_object_path", ))

1777

1778

_interface = "se.recompile.Mandos.Client"

1779

1206

1780

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

1207

1208

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

1781

1782

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

1209

1783

self.bus = bus

1210

1784

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

1211

1785

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

1212

1786

# the D-Bus

1213

client_object_name = unicode(self.name).translate(

1787

client_object_name = str(self.name).translate(

1214

1788

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

1215

1789

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

1216

self.dbus_object_path = (dbus.ObjectPath

1217

("/clients/" + client_object_name))

1790

self.dbus_object_path = dbus.ObjectPath(

1791

"/clients/" + client_object_name)

1218

1792

DBusObjectWithProperties.__init__(self, self.bus,

1219

1793

self.dbus_object_path)

1220

1221

def notifychangeproperty(transform_func,

1222

dbus_name, type_func=lambda x: x,

1223

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

1224

1800

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

1225

1801

its changes to DBus.

1226

1802

1227

1803

transform_fun: Function that takes a value and a variant_level

1228

1804

and transforms it to a D-Bus type.

1229

1805

dbus_name: D-Bus name of the variable

1231

1807

to the D-Bus. Default: no transform

1232

1808

variant_level: D-Bus variant level. Default: 1

1233

1809

"""

1234

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

1810

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

1811

1235

1812

def setter(self, value):

1236

1813

if hasattr(self, "dbus_object_path"):

1237

1814

if (not hasattr(self, attrname) or

1238

1815

type_func(getattr(self, attrname, None))

1239

1816

!= type_func(value)):

1240

dbus_value = transform_func(type_func(value),

1241

variant_level

1242

=variant_level)

1243

self.PropertyChanged(dbus.String(dbus_name),

1244

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

1245

1832

setattr(self, attrname, value)

1246

1833

1247

1834

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

1248

1835

1249

1836

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1250

1837

approvals_pending = notifychangeproperty(dbus.Boolean,

1251

1838

"ApprovalPending",

1252

type_func = bool)

1839

type_func=bool)

1253

1840

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

1254

1841

last_enabled = notifychangeproperty(datetime_to_dbus,

1255

1842

"LastEnabled")

1256

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

1257

type_func = lambda checker:

1258

checker is not None)

1843

checker = notifychangeproperty(

1844

dbus.Boolean, "CheckerRunning",

1845

type_func=lambda checker: checker is not None)

1259

1846

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1260

1847

"LastCheckedOK")

1261

1848

last_checker_status = notifychangeproperty(dbus.Int16,

1264

1851

datetime_to_dbus, "LastApprovalRequest")

1265

1852

approved_by_default = notifychangeproperty(dbus.Boolean,

1266

1853

"ApprovedByDefault")

1267

approval_delay = notifychangeproperty(dbus.UInt64,

1268

"ApprovalDelay",

1269

type_func =

1270

timedelta_to_milliseconds)

1854

approval_delay = notifychangeproperty(

1855

dbus.UInt64, "ApprovalDelay",

1856

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

1271

1857

approval_duration = notifychangeproperty(

1272

1858

dbus.UInt64, "ApprovalDuration",

1273

type_func = timedelta_to_milliseconds)

1859

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

1274

1860

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

1275

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

1276

type_func =

1277

timedelta_to_milliseconds)

1861

timeout = notifychangeproperty(

1862

dbus.UInt64, "Timeout",

1863

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

1278

1864

extended_timeout = notifychangeproperty(

1279

1865

dbus.UInt64, "ExtendedTimeout",

1280

type_func = timedelta_to_milliseconds)

1281

interval = notifychangeproperty(dbus.UInt64,

1282

"Interval",

1283

type_func =

1284

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)

1285

1870

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

1286

1871

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

1872

invalidate_only=True)

1873

1287

1874

del notifychangeproperty

1288

1875

1289

1876

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

1290

1877

try:

1291

1878

self.remove_from_connection()

1294

1881

if hasattr(DBusObjectWithProperties, "__del__"):

1295

1882

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

1296

1883

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

1297

1298

def checker_callback(self, pid, condition, command,

1299

*args, **kwargs):

1300

self.checker_callback_tag = None

1301

self.checker = None

1302

if os.WIFEXITED(condition):

1303

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:

1304

1892

# Emit D-Bus signal

1305

1893

self.CheckerCompleted(dbus.Int16(exitstatus),

1306

dbus.Int64(condition),

1894

# This is specific to GNU libC

1895

dbus.Int64(exitstatus << 8),

1307

1896

dbus.String(command))

1308

1897

else:

1309

1898

# Emit D-Bus signal

1310

1899

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

1311

dbus.Int64(condition),

1900

dbus.Int64(

1901

# This is specific to GNU libC

1902

(exitstatus << 8)

1903

| self.last_checker_signal),

1312

1904

dbus.String(command))

1313

1314

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

1315

*args, **kwargs)

1316

1905

return ret

1906

1317

1907

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

1318

old_checker = self.checker

1319

if self.checker is not None:

1320

old_checker_pid = self.checker.pid

1321

else:

1322

old_checker_pid = None

1908

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

1323

1909

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

1324

1910

# Only if new checker process was started

1325

1911

if (self.checker is not None

1327

1913

# Emit D-Bus signal

1328

1914

self.CheckerStarted(self.current_checker_command)

1329

1915

return r

1330

1916

1331

1917

def _reset_approved(self):

1332

1918

self.approved = None

1333

1919

return False

1334

1920

1335

1921

def approve(self, value=True):

1336

self.send_changedstate()

1337

1922

self.approved = value

1338

gobject.timeout_add(timedelta_to_milliseconds

1339

(self.approval_duration),

1340

self._reset_approved)

1341

1342

## D-Bus methods, signals & properties

1343

_interface = "se.recompile.Mandos.Client"

1344

1345

## Interfaces

1346

1347

@dbus_interface_annotations(_interface)

1348

def _foo(self):

1349

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

1350

"false"}

1351

1352

## Signals

1353

1923

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

1924

* 1000), self._reset_approved)

1925

self.send_changedstate()

1926

1927

# D-Bus methods, signals & properties

1928

1929

# Interfaces

1930

1931

# Signals

1932

1354

1933

# CheckerCompleted - signal

1355

1934

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

1356

1935

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

1357

1936

"D-Bus signal"

1358

1937

pass

1359

1938

1360

1939

# CheckerStarted - signal

1361

1940

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

1362

1941

def CheckerStarted(self, command):

1363

1942

"D-Bus signal"

1364

1943

pass

1365

1944

1366

1945

# PropertyChanged - signal

1946

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

1367

1947

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

1368

1948

def PropertyChanged(self, property, value):

1369

1949

"D-Bus signal"

1370

1950

pass

1371

1951

1372

1952

# GotSecret - signal

1373

1953

@dbus.service.signal(_interface)

1374

1954

def GotSecret(self):

1377

1957

server to mandos-client

1378

1958

"""

1379

1959

pass

1380

1960

1381

1961

# Rejected - signal

1382

1962

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

1383

1963

def Rejected(self, reason):

1384

1964

"D-Bus signal"

1385

1965

pass

1386

1966

1387

1967

# NeedApproval - signal

1388

1968

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

1389

1969

def NeedApproval(self, timeout, default):

1390

1970

"D-Bus signal"

1391

1971

return self.need_approval()

1392

1393

## Methods

1394

1972

1973

# Methods

1974

1395

1975

# Approve - method

1396

1976

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

1397

1977

def Approve(self, value):

1398

1978

self.approve(value)

1399

1979

1400

1980

# CheckedOK - method

1401

1981

@dbus.service.method(_interface)

1402

1982

def CheckedOK(self):

1403

1983

self.checked_ok()

1404

1984

1405

1985

# Enable - method

1986

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

1406

1987

@dbus.service.method(_interface)

1407

1988

def Enable(self):

1408

1989

"D-Bus method"

1409

1990

self.enable()

1410

1991

1411

1992

# StartChecker - method

1993

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

1412

1994

@dbus.service.method(_interface)

1413

1995

def StartChecker(self):

1414

1996

"D-Bus method"

1415

1997

self.start_checker()

1416

1998

1417

1999

# Disable - method

2000

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

1418

2001

@dbus.service.method(_interface)

1419

2002

def Disable(self):

1420

2003

"D-Bus method"

1421

2004

self.disable()

1422

2005

1423

2006

# StopChecker - method

2007

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

1424

2008

@dbus.service.method(_interface)

1425

2009

def StopChecker(self):

1426

2010

self.stop_checker()

1427

1428

## Properties

1429

2011

2012

# Properties

2013

1430

2014

# ApprovalPending - property

1431

2015

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

1432

2016

def ApprovalPending_dbus_property(self):

1433

2017

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

1434

2018

1435

2019

# ApprovedByDefault - property

1436

@dbus_service_property(_interface, signature="b",

2020

@dbus_service_property(_interface,

2021

signature="b",

1437

2022

access="readwrite")

1438

2023

def ApprovedByDefault_dbus_property(self, value=None):

1439

2024

if value is None: # get

1440

2025

return dbus.Boolean(self.approved_by_default)

1441

2026

self.approved_by_default = bool(value)

1442

2027

1443

2028

# ApprovalDelay - property

1444

@dbus_service_property(_interface, signature="t",

2029

@dbus_service_property(_interface,

2030

signature="t",

1445

2031

access="readwrite")

1446

2032

def ApprovalDelay_dbus_property(self, value=None):

1447

2033

if value is None: # get

1448

return dbus.UInt64(self.approval_delay_milliseconds())

2034

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

2035

* 1000)

1449

2036

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

1450

2037

1451

2038

# ApprovalDuration - property

1452

@dbus_service_property(_interface, signature="t",

2039

@dbus_service_property(_interface,

2040

signature="t",

1453

2041

access="readwrite")

1454

2042

def ApprovalDuration_dbus_property(self, value=None):

1455

2043

if value is None: # get

1456

return dbus.UInt64(timedelta_to_milliseconds(

1457

self.approval_duration))

2044

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

2045

* 1000)

1458

2046

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

1459

2047

1460

2048

# Name - property

2049

@dbus_annotations(

2050

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

1461

2051

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

1462

2052

def Name_dbus_property(self):

1463

2053

return dbus.String(self.name)

1464

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

1465

2062

# Fingerprint - property

2063

@dbus_annotations(

2064

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

1466

2065

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

1467

2066

def Fingerprint_dbus_property(self):

1468

2067

return dbus.String(self.fingerprint)

1469

2068

1470

2069

# Host - property

1471

@dbus_service_property(_interface, signature="s",

2070

@dbus_service_property(_interface,

2071

signature="s",

1472

2072

access="readwrite")

1473

2073

def Host_dbus_property(self, value=None):

1474

2074

if value is None: # get

1475

2075

return dbus.String(self.host)

1476

self.host = unicode(value)

1477

2076

self.host = str(value)

2077

1478

2078

# Created - property

2079

@dbus_annotations(

2080

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

1479

2081

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

1480

2082

def Created_dbus_property(self):

1481

2083

return datetime_to_dbus(self.created)

1482

2084

1483

2085

# LastEnabled - property

1484

2086

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

1485

2087

def LastEnabled_dbus_property(self):

1486

2088

return datetime_to_dbus(self.last_enabled)

1487

2089

1488

2090

# Enabled - property

1489

@dbus_service_property(_interface, signature="b",

2091

@dbus_service_property(_interface,

2092

signature="b",

1490

2093

access="readwrite")

1491

2094

def Enabled_dbus_property(self, value=None):

1492

2095

if value is None: # get

1495

2098

self.enable()

1496

2099

else:

1497

2100

self.disable()

1498

2101

1499

2102

# LastCheckedOK - property

1500

@dbus_service_property(_interface, signature="s",

2103

@dbus_service_property(_interface,

2104

signature="s",

1501

2105

access="readwrite")

1502

2106

def LastCheckedOK_dbus_property(self, value=None):

1503

2107

if value is not None:

1504

2108

self.checked_ok()

1505

2109

return

1506

2110

return datetime_to_dbus(self.last_checked_ok)

1507

2111

1508

2112

# LastCheckerStatus - property

1509

@dbus_service_property(_interface, signature="n",

1510

access="read")

2113

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

1511

2114

def LastCheckerStatus_dbus_property(self):

1512

2115

return dbus.Int16(self.last_checker_status)

1513

2116

1514

2117

# Expires - property

1515

2118

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

1516

2119

def Expires_dbus_property(self):

1517

2120

return datetime_to_dbus(self.expires)

1518

2121

1519

2122

# LastApprovalRequest - property

1520

2123

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

1521

2124

def LastApprovalRequest_dbus_property(self):

1522

2125

return datetime_to_dbus(self.last_approval_request)

1523

2126

1524

2127

# Timeout - property

1525

@dbus_service_property(_interface, signature="t",

2128

@dbus_service_property(_interface,

2129

signature="t",

1526

2130

access="readwrite")

1527

2131

def Timeout_dbus_property(self, value=None):

1528

2132

if value is None: # get

1529

return dbus.UInt64(self.timeout_milliseconds())

2133

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

2134

old_timeout = self.timeout

1530

2135

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

1531

# Reschedule timeout

2136

# Reschedule disabling

1532

2137

if self.enabled:

1533

2138

now = datetime.datetime.utcnow()

1534

time_to_die = timedelta_to_milliseconds(

1535

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

1536

if time_to_die <= 0:

2139

self.expires += self.timeout - old_timeout

2140

if self.expires <= now:

1537

2141

# The timeout has passed

1538

2142

self.disable()

1539

2143

else:

1540

self.expires = (now +

1541

datetime.timedelta(milliseconds =

1542

time_to_die))

1543

2144

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

1544

2145

is None):

1545

2146

return

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (gobject.timeout_add

1548

(time_to_die,

1549

self.disable))

1550

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

1551

2152

# ExtendedTimeout - property

1552

@dbus_service_property(_interface, signature="t",

2153

@dbus_service_property(_interface,

2154

signature="t",

1553

2155

access="readwrite")

1554

2156

def ExtendedTimeout_dbus_property(self, value=None):

1555

2157

if value is None: # get

1556

return dbus.UInt64(self.extended_timeout_milliseconds())

2158

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

2159

* 1000)

1557

2160

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

1558

2161

1559

2162

# Interval - property

1560

@dbus_service_property(_interface, signature="t",

2163

@dbus_service_property(_interface,

2164

signature="t",

1561

2165

access="readwrite")

1562

2166

def Interval_dbus_property(self, value=None):

1563

2167

if value is None: # get

1564

return dbus.UInt64(self.interval_milliseconds())

2168

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

1565

2169

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

1566

2170

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

1567

2171

return

1568

2172

if self.enabled:

1569

2173

# Reschedule checker run

1570

gobject.source_remove(self.checker_initiator_tag)

1571

self.checker_initiator_tag = (gobject.timeout_add

1572

(value, self.start_checker))

1573

self.start_checker() # Start one now, too

1574

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

1575

2179

# Checker - property

1576

@dbus_service_property(_interface, signature="s",

2180

@dbus_service_property(_interface,

2181

signature="s",

1577

2182

access="readwrite")

1578

2183

def Checker_dbus_property(self, value=None):

1579

2184

if value is None: # get

1580

2185

return dbus.String(self.checker_command)

1581

self.checker_command = unicode(value)

1582

2186

self.checker_command = str(value)

2187

1583

2188

# CheckerRunning - property

1584

@dbus_service_property(_interface, signature="b",

2189

@dbus_service_property(_interface,

2190

signature="b",

1585

2191

access="readwrite")

1586

2192

def CheckerRunning_dbus_property(self, value=None):

1587

2193

if value is None: # get

1590

2196

self.start_checker()

1591

2197

else:

1592

2198

self.stop_checker()

1593

2199

1594

2200

# ObjectPath - property

2201

@dbus_annotations(

2202

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

2203

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

1595

2204

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

1596

2205

def ObjectPath_dbus_property(self):

1597

return self.dbus_object_path # is already a dbus.ObjectPath

1598

2206

return self.dbus_object_path # is already a dbus.ObjectPath

2207

1599

2208

# Secret = property

1600

@dbus_service_property(_interface, signature="ay",

1601

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)

1602

2216

def Secret_dbus_property(self, value):

1603

self.secret = str(value)

1604

2217

self.secret = bytes(value)

2218

1605

2219

del _interface

1606

2220

1607

2221

1608

2222

class ProxyClient(object):

1609

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

2223

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

1610

2224

self._pipe = child_pipe

1611

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

2225

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

1612

2226

if not self._pipe.recv():

1613

raise KeyError()

1614

2227

raise KeyError(key_id or fpr)

2228

1615

2229

def __getattribute__(self, name):

1616

2230

if name == '_pipe':

1617

2231

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

1620

2234

if data[0] == 'data':

1621

2235

return data[1]

1622

2236

if data[0] == 'function':

2237

1623

2238

def func(*args, **kwargs):

1624

2239

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

1625

2240

return self._pipe.recv()[1]

2241

1626

2242

return func

1627

2243

1628

2244

def __setattr__(self, name, value):

1629

2245

if name == '_pipe':

1630

2246

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

1633

2249

1634

2250

class ClientHandler(socketserver.BaseRequestHandler, object):

1635

2251

"""A class to handle client connections.

1636

2252

1637

2253

Instantiated once for each connection to handle it.

1638

2254

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

1639

2255

1640

2256

def handle(self):

1641

2257

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

1642

2258

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

1643

unicode(self.client_address))

2259

str(self.client_address))

1644

2260

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

1645

2261

self.server.child_pipe.fileno())

1646

1647

session = (gnutls.connection

1648

.ClientSession(self.request,

1649

gnutls.connection

1650

.X509Credentials()))

1651

1652

# Note: gnutls.connection.X509Credentials is really a

1653

# generic GnuTLS certificate credentials object so long as

1654

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

1655

# here despite using OpenPGP certificates.

1656

1657

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

1658

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

1659

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

1660

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

1661

2269

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

1662

2270

priority = self.server.gnutls_priority

1663

2271

if priority is None:

1664

2272

priority = "NORMAL"

1665

(gnutls.library.functions

1666

.gnutls_priority_set_direct(session._c_object,

1667

priority, None))

1668

2273

gnutls.priority_set_direct(session._c_object,

2274

priority.encode("utf-8"),

2275

None)

2276

1669

2277

# Start communication using the Mandos protocol

1670

2278

# Get protocol number

1671

2279

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

1672

2280

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

1673

2281

try:

1674

2282

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

1675

raise RuntimeError

2283

raise RuntimeError(line)

1676

2284

except (ValueError, IndexError, RuntimeError) as error:

1677

2285

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

1678

2286

return

1679

2287

1680

2288

# Start GnuTLS connection

1681

2289

try:

1682

2290

session.handshake()

1683

except gnutls.errors.GNUTLSError as error:

2291

except gnutls.Error as error:

1684

2292

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

1685

2293

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

1686

2294

# established. Just abandon the request.

1687

2295

return

1688

2296

logger.debug("Handshake succeeded")

1689

2297

1690

2298

approval_required = False

1691

2299

try:

1692

try:

1693

fpr = self.fingerprint(self.peer_certificate

1694

(session))

1695

except (TypeError,

1696

gnutls.errors.GNUTLSError) as error:

1697

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

1698

return

1699

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

1700

1701

try:

1702

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,

1703

2322

self.client_address)

1704

2323

except KeyError:

1705

2324

return

1706

2325

1707

2326

if client.approval_delay:

1708

2327

delay = client.approval_delay

1709

2328

client.approvals_pending += 1

1710

2329

approval_required = True

1711

2330

1712

2331

while True:

1713

2332

if not client.enabled:

1714

2333

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

1715

client.name)

2334

client.name)

1716

2335

if self.server.use_dbus:

1717

2336

# Emit D-Bus signal

1718

2337

client.Rejected("Disabled")

1719

2338

return

1720

2339

1721

2340

if client.approved or not client.approval_delay:

1722

#We are approved or approval is disabled

2341

# We are approved or approval is disabled

1723

2342

break

1724

2343

elif client.approved is None:

1725

2344

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

1727

2346

if self.server.use_dbus:

1728

2347

# Emit D-Bus signal

1729

2348

client.NeedApproval(

1730

client.approval_delay_milliseconds(),

1731

client.approved_by_default)

2349

client.approval_delay.total_seconds()

2350

* 1000, client.approved_by_default)

1732

2351

else:

1733

2352

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

1734

2353

client.name)

1736

2355

# Emit D-Bus signal

1737

2356

client.Rejected("Denied")

1738

2357

return

1739

1740

#wait until timeout or approved

2358

2359

# wait until timeout or approved

1741

2360

time = datetime.datetime.now()

1742

2361

client.changedstate.acquire()

1743

(client.changedstate.wait

1744

(float(client.timedelta_to_milliseconds(delay)

1745

/ 1000)))

2362

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

1746

2363

client.changedstate.release()

1747

2364

time2 = datetime.datetime.now()

1748

2365

if (time2 - time) >= delay:

1758

2375

break

1759

2376

else:

1760

2377

delay -= time2 - time

1761

1762

sent_size = 0

1763

while sent_size < len(client.secret):

1764

try:

1765

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

1766

except gnutls.errors.GNUTLSError as error:

1767

logger.warning("gnutls send failed",

1768

exc_info=error)

1769

return

1770

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

1771

sent, len(client.secret)

1772

- (sent_size + sent))

1773

sent_size += sent

1774

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

1775

2386

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

1776

2387

# bump the timeout using extended_timeout

1777

2388

client.bump_timeout(client.extended_timeout)

1778

2389

if self.server.use_dbus:

1779

2390

# Emit D-Bus signal

1780

2391

client.GotSecret()

1781

2392

1782

2393

finally:

1783

2394

if approval_required:

1784

2395

client.approvals_pending -= 1

1785

2396

try:

1786

2397

session.bye()

1787

except gnutls.errors.GNUTLSError as error:

2398

except gnutls.Error as error:

1788

2399

logger.warning("GnuTLS bye failed",

1789

2400

exc_info=error)

1790

2401

1791

2402

@staticmethod

1792

2403

def peer_certificate(session):

1793

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

1794

# If not an OpenPGP certificate...

1795

if (gnutls.library.functions

1796

.gnutls_certificate_type_get(session._c_object)

1797

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1798

# ...do the normal thing

1799

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

1800

2420

list_size = ctypes.c_uint(1)

1801

cert_list = (gnutls.library.functions

1802

.gnutls_certificate_get_peers

2421

cert_list = (gnutls.certificate_get_peers

1803

2422

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

1804

2423

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

1805

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

1806

" certificate")

2424

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

1807

2425

if list_size.value == 0:

1808

2426

return None

1809

2427

cert = cert_list[0]

1810

2428

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

1811

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

1812

2464

@staticmethod

1813

2465

def fingerprint(openpgp):

1814

2466

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1815

2467

# New GnuTLS "datum" with the OpenPGP public key

1816

datum = (gnutls.library.types

1817

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

1818

ctypes.POINTER

1819

(ctypes.c_ubyte)),

1820

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

1821

2472

# New empty GnuTLS certificate

1822

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1823

(gnutls.library.functions

1824

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2473

crt = gnutls.openpgp_crt_t()

2474

gnutls.openpgp_crt_init(ctypes.byref(crt))

1825

2475

# Import the OpenPGP public key into the certificate

1826

(gnutls.library.functions

1827

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

1828

gnutls.library.constants

1829

.GNUTLS_OPENPGP_FMT_RAW))

2476

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

2477

gnutls.OPENPGP_FMT_RAW)

1830

2478

# Verify the self signature in the key

1831

2479

crtverify = ctypes.c_uint()

1832

(gnutls.library.functions

1833

.gnutls_openpgp_crt_verify_self(crt, 0,

1834

ctypes.byref(crtverify)))

2480

gnutls.openpgp_crt_verify_self(crt, 0,

2481

ctypes.byref(crtverify))

1835

2482

if crtverify.value != 0:

1836

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1837

raise (gnutls.errors.CertificateSecurityError

1838

("Verify failed"))

2483

gnutls.openpgp_crt_deinit(crt)

2484

raise gnutls.CertificateSecurityError(code

2485

=crtverify.value)

1839

2486

# New buffer for the fingerprint

1840

2487

buf = ctypes.create_string_buffer(20)

1841

2488

buf_len = ctypes.c_size_t()

1842

2489

# Get the fingerprint from the certificate into the buffer

1843

(gnutls.library.functions

1844

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

1845

ctypes.byref(buf_len)))

2490

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

2491

ctypes.byref(buf_len))

1846

2492

# Deinit the certificate

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2493

gnutls.openpgp_crt_deinit(crt)

1848

2494

# Convert the buffer to a Python bytestring

1849

2495

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

1850

2496

# Convert the bytestring to hexadecimal notation

1854

2500

1855

2501

class MultiprocessingMixIn(object):

1856

2502

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

2503

1857

2504

def sub_process_main(self, request, address):

1858

2505

try:

1859

2506

self.finish_request(request, address)

1860

2507

except Exception:

1861

2508

self.handle_error(request, address)

1862

2509

self.close_request(request)

1863

2510

1864

2511

def process_request(self, request, address):

1865

2512

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

1866

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

1867

args = (request,

1868

address))

2513

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

2514

args=(request, address))

1869

2515

proc.start()

1870

2516

return proc

1871

2517

1872

2518

1873

2519

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1874

2520

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

2521

1875

2522

def process_request(self, request, client_address):

1876

2523

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

1877

2524

1878

2525

This function creates a new pipe in self.pipe

1879

2526

"""

1880

2527

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1881

2528

1882

2529

proc = MultiprocessingMixIn.process_request(self, request,

1883

2530

client_address)

1884

2531

self.child_pipe.close()

1885

2532

self.add_pipe(parent_pipe, proc)

1886

2533

1887

2534

def add_pipe(self, parent_pipe, proc):

1888

2535

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

1889

raise NotImplementedError

2536

raise NotImplementedError()

1890

2537

1891

2538

1892

2539

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1893

2540

socketserver.TCPServer, object):

1894

2541

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

1895

2542

1896

2543

Attributes:

1897

2544

enabled: Boolean; whether this server is activated yet

1898

2545

interface: None or a network interface name (string)

1899

2546

use_ipv6: Boolean; to use IPv6 or not

1900

2547

"""

2548

1901

2549

def __init__(self, server_address, RequestHandlerClass,

1902

interface=None, use_ipv6=True):

2550

interface=None,

2551

use_ipv6=True,

2552

socketfd=None):

2553

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

2554

creating a new one with socket.socket().

2555

"""

1903

2556

self.interface = interface

1904

2557

if use_ipv6:

1905

2558

self.address_family = socket.AF_INET6

2559

if socketfd is not None:

2560

# Save the file descriptor

2561

self.socketfd = socketfd

2562

# Save the original socket.socket() function

2563

self.socket_socket = socket.socket

2564

2565

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

2566

#

2567

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

2568

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

2569

# patching socket.socket.)

2570

#

2571

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

2572

@functools.wraps(socket.socket)

2573

def socket_wrapper(*args, **kwargs):

2574

# Restore original function so subsequent calls are

2575

# not affected.

2576

socket.socket = self.socket_socket

2577

del self.socket_socket

2578

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

2579

# saved file descriptor.

2580

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

2581

# Replace socket.socket() function with wrapper

2582

socket.socket = socket_wrapper

2583

# The socketserver.TCPServer.__init__ will call

2584

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

2585

# socket_wrapper(), if socketfd was set.

1906

2586

socketserver.TCPServer.__init__(self, server_address,

1907

2587

RequestHandlerClass)

2588

1908

2589

def server_bind(self):

1909

2590

"""This overrides the normal server_bind() function

1910

2591

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

1911

2592

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

2593

global SO_BINDTODEVICE

1912

2594

if self.interface is not None:

1913

2595

if SO_BINDTODEVICE is None:

1914

logger.error("SO_BINDTODEVICE does not exist;"

1915

" cannot bind to interface %s",

1916

self.interface)

1917

else:

1918

try:

1919

self.socket.setsockopt(socket.SOL_SOCKET,

1920

SO_BINDTODEVICE,

1921

str(self.interface

1922

+ '\0'))

1923

except socket.error as error:

1924

if error[0] == errno.EPERM:

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1928

elif error[0] == errno.ENOPROTOOPT:

1929

logger.error("SO_BINDTODEVICE not available;"

1930

" cannot bind to interface %s",

1931

self.interface)

1932

else:

1933

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

1934

2617

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

1935

2618

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

1936

2619

if not self.server_address[0]:

1937

2620

if self.address_family == socket.AF_INET6:

1938

any_address = "::" # in6addr_any

2621

any_address = "::" # in6addr_any

1939

2622

else:

1940

any_address = socket.INADDR_ANY

2623

any_address = "0.0.0.0" # INADDR_ANY

1941

2624

self.server_address = (any_address,

1942

2625

self.server_address[1])

1943

2626

elif not self.server_address[1]:

1944

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

1945

0)

2627

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

1946

2628

# if self.interface:

1947

2629

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

1948

2630

# 0, # port

1954

2636

1955

2637

class MandosServer(IPv6_TCPServer):

1956

2638

"""Mandos server.

1957

2639

1958

2640

Attributes:

1959

2641

clients: set of Client objects

1960

2642

gnutls_priority GnuTLS priority string

1961

2643

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

1962

1963

Assumes a gobject.MainLoop event loop.

2644

2645

Assumes a GLib.MainLoop event loop.

1964

2646

"""

2647

1965

2648

def __init__(self, server_address, RequestHandlerClass,

1966

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

1967

gnutls_priority=None, use_dbus=True):

2649

interface=None,

2650

use_ipv6=True,

2651

clients=None,

2652

gnutls_priority=None,

2653

use_dbus=True,

2654

socketfd=None):

1968

2655

self.enabled = False

1969

2656

self.clients = clients

1970

2657

if self.clients is None:

1973

2660

self.gnutls_priority = gnutls_priority

1974

2661

IPv6_TCPServer.__init__(self, server_address,

1975

2662

RequestHandlerClass,

1976

interface = interface,

1977

use_ipv6 = use_ipv6)

2663

interface=interface,

2664

use_ipv6=use_ipv6,

2665

socketfd=socketfd)

2666

1978

2667

def server_activate(self):

1979

2668

if self.enabled:

1980

2669

return socketserver.TCPServer.server_activate(self)

1981

2670

1982

2671

def enable(self):

1983

2672

self.enabled = True

1984

2673

1985

2674

def add_pipe(self, parent_pipe, proc):

1986

2675

# Call "handle_ipc" for both data and EOF events

1987

gobject.io_add_watch(parent_pipe.fileno(),

1988

gobject.IO_IN | gobject.IO_HUP,

1989

functools.partial(self.handle_ipc,

1990

parent_pipe =

1991

parent_pipe,

1992

proc = proc))

1993

1994

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

1995

proc = None, client_object=None):

1996

condition_names = {

1997

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

1998

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

1999

# blocking).

2000

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

2001

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

2002

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

2003

# broken, usually for pipes and

2004

# sockets).

2005

}

2006

conditions_string = ' | '.join(name

2007

for cond, name in

2008

condition_names.iteritems()

2009

if cond & condition)

2676

GLib.io_add_watch(

2677

parent_pipe.fileno(),

2678

GLib.IO_IN | GLib.IO_HUP,

2679

functools.partial(self.handle_ipc,

2680

parent_pipe=parent_pipe,

2681

proc=proc))

2682

2683

def handle_ipc(self, source, condition,

2684

parent_pipe=None,

2685

proc=None,

2686

client_object=None):

2010

2687

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

2011

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

2688

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

2012

2689

# Wait for other process to exit

2013

2690

proc.join()

2014

2691

return False

2015

2692

2016

2693

# Read a request from the child

2017

2694

request = parent_pipe.recv()

2018

2695

command = request[0]

2019

2696

2020

2697

if command == 'init':

2021

fpr = request[1]

2022

address = request[2]

2023

2024

for c in self.clients.itervalues():

2025

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:

2026

2709

client = c

2027

2710

break

2028

2711

else:

2029

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

2030

"dress: %s", fpr, address)

2712

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

2713

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

2031

2714

if self.use_dbus:

2032

2715

# Emit D-Bus signal

2033

mandos_dbus_service.ClientNotFound(fpr,

2716

mandos_dbus_service.ClientNotFound(key_id or fpr,

2034

2717

address[0])

2035

2718

parent_pipe.send(False)

2036

2719

return False

2037

2038

gobject.io_add_watch(parent_pipe.fileno(),

2039

gobject.IO_IN | gobject.IO_HUP,

2040

functools.partial(self.handle_ipc,

2041

parent_pipe =

2042

parent_pipe,

2043

proc = proc,

2044

client_object =

2045

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

2046

2728

parent_pipe.send(True)

2047

2729

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

2048

2730

# same fileno

2051

2733

funcname = request[1]

2052

2734

args = request[2]

2053

2735

kwargs = request[3]

2054

2736

2055

2737

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

2056

2738

funcname)(*args,

2057

**kwargs)))

2058

2739

**kwargs)))

2740

2059

2741

if command == 'getattr':

2060

2742

attrname = request[1]

2061

if callable(client_object.__getattribute__(attrname)):

2062

parent_pipe.send(('function',))

2743

if isinstance(client_object.__getattribute__(attrname),

2744

collections.Callable):

2745

parent_pipe.send(('function', ))

2063

2746

else:

2064

parent_pipe.send(('data', client_object

2065

.__getattribute__(attrname)))

2066

2747

parent_pipe.send((

2748

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

2749

2067

2750

if command == 'setattr':

2068

2751

attrname = request[1]

2069

2752

value = request[2]

2070

2753

setattr(client_object, attrname, value)

2071

2754

2072

2755

return True

2073

2756

2074

2757

2758

def rfc3339_duration_to_delta(duration):

2759

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

2760

2761

>>> rfc3339_duration_to_delta("P7D")

2762

datetime.timedelta(7)

2763

>>> rfc3339_duration_to_delta("PT60S")

2764

datetime.timedelta(0, 60)

2765

>>> rfc3339_duration_to_delta("PT60M")

2766

datetime.timedelta(0, 3600)

2767

>>> rfc3339_duration_to_delta("PT24H")

2768

datetime.timedelta(1)

2769

>>> rfc3339_duration_to_delta("P1W")

2770

datetime.timedelta(7)

2771

>>> rfc3339_duration_to_delta("PT5M30S")

2772

datetime.timedelta(0, 330)

2773

>>> rfc3339_duration_to_delta("P1DT3M20S")

2774

datetime.timedelta(1, 200)

2775

"""

2776

2777

# Parsing an RFC 3339 duration with regular expressions is not

2778

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

2779

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

2780

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

2781

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

2782

# avoid excessive use of external libraries.

2783

2784

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

2785

Token = collections.namedtuple("Token", (

2786

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

2787

# a "group" containing digits

2788

"value", # datetime.timedelta or None

2789

"followers")) # Tokens valid after this token

2790

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

2791

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

2792

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

2793

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

2794

datetime.timedelta(seconds=1),

2795

frozenset((token_end, )))

2796

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

2797

datetime.timedelta(minutes=1),

2798

frozenset((token_second, token_end)))

2799

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

2800

datetime.timedelta(hours=1),

2801

frozenset((token_minute, token_end)))

2802

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

2803

None,

2804

frozenset((token_hour, token_minute,

2805

token_second)))

2806

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

2807

datetime.timedelta(days=1),

2808

frozenset((token_time, token_end)))

2809

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

2810

datetime.timedelta(weeks=4),

2811

frozenset((token_day, token_end)))

2812

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

2813

datetime.timedelta(weeks=52),

2814

frozenset((token_month, token_end)))

2815

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

2816

datetime.timedelta(weeks=1),

2817

frozenset((token_end, )))

2818

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

2819

frozenset((token_year, token_month,

2820

token_day, token_time,

2821

token_week)))

2822

# Define starting values:

2823

# Value so far

2824

value = datetime.timedelta()

2825

found_token = None

2826

# Following valid tokens

2827

followers = frozenset((token_duration, ))

2828

# String left to parse

2829

s = duration

2830

# Loop until end token is found

2831

while found_token is not token_end:

2832

# Search for any currently valid tokens

2833

for token in followers:

2834

match = token.regexp.match(s)

2835

if match is not None:

2836

# Token found

2837

if token.value is not None:

2838

# Value found, parse digits

2839

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

2840

# Add to value so far

2841

value += factor * token.value

2842

# Strip token from string

2843

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

2844

# Go to found token

2845

found_token = token

2846

# Set valid next tokens

2847

followers = found_token.followers

2848

break

2849

else:

2850

# No currently valid tokens were found

2851

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

2852

.format(duration))

2853

# End token found

2854

return value

2855

2856

2075

2857

def string_to_delta(interval):

2076

2858

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

2077

2859

2078

2860

>>> string_to_delta('7d')

2079

2861

datetime.timedelta(7)

2080

2862

>>> string_to_delta('60s')

2088

2870

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

2089

2871

datetime.timedelta(0, 330)

2090

2872

"""

2873

2874

try:

2875

return rfc3339_duration_to_delta(interval)

2876

except ValueError:

2877

pass

2878

2091

2879

timevalue = datetime.timedelta(0)

2092

2880

for s in interval.split():

2093

2881

try:

2094

suffix = unicode(s[-1])

2882

suffix = s[-1]

2095

2883

value = int(s[:-1])

2096

2884

if suffix == "d":

2097

2885

delta = datetime.timedelta(value)

2104

2892

elif suffix == "w":

2105

2893

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

2106

2894

else:

2107

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

2108

.format(suffix))

2109

except (ValueError, IndexError) as e:

2895

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

2896

except IndexError as e:

2110

2897

raise ValueError(*(e.args))

2111

2898

timevalue += delta

2112

2899

return timevalue

2113

2900

2114

2901

2115

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

2902

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

2116

2903

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

2117

2904

2118

2905

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

2119

2906

if os.fork():

2120

2907

sys.exit()

2128

2915

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

2129

2916

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

2130

2917

raise OSError(errno.ENODEV,

2131

"{0} not a character device"

2918

"{} not a character device"

2132

2919

.format(os.devnull))

2133

2920

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

2134

2921

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

2138

2925

2139

2926

2140

2927

def main():

2141

2928

2142

2929

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

2143

2930

# Parsing of options, both command line and config file

2144

2931

2145

2932

parser = argparse.ArgumentParser()

2146

2933

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

2147

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

2934

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

2148

2935

help="show version number and exit")

2149

2936

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

2150

2937

help="Bind to interface IF")

2156

2943

help="Run self-test")

2157

2944

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

2158

2945

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

2159

" to terminal")

2946

" to terminal", default=None)

2160

2947

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

2161

2948

help="Debug level for stdout output")

2162

2949

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

2169

2956

" files")

2170

2957

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

2171

2958

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

2172

" system bus interface")

2959

" system bus interface", default=None)

2173

2960

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

2174

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

2961

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

2962

default=None)

2175

2963

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

2176

2964

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

2177

" state")

2965

" state", default=None)

2966

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

2967

help="Specify a file descriptor to a network"

2968

" socket to use instead of creating one")

2178

2969

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

2179

2970

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

2180

2971

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

2972

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

2973

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

2974

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

2975

default=None)

2976

2181

2977

options = parser.parse_args()

2182

2978

2183

2979

if options.check:

2184

2980

import doctest

2185

doctest.testmod()

2186

sys.exit()

2187

2981

fail_count, test_count = doctest.testmod()

2982

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

2983

2188

2984

# Default values for config file for server-global settings

2189

server_defaults = { "interface": "",

2190

"address": "",

2191

"port": "",

2192

"debug": "False",

2193

"priority":

2194

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

2195

"servicename": "Mandos",

2196

"use_dbus": "True",

2197

"use_ipv6": "True",

2198

"debuglevel": "",

2199

"restore": "True",

2200

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

2201

}

2202

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

2203

3008

# Parse config file for server-global settings

2204

3009

server_config = configparser.SafeConfigParser(server_defaults)

2205

3010

del server_defaults

2206

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

2207

"mandos.conf"))

3011

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

2208

3012

# Convert the SafeConfigParser object to a dict

2209

3013

server_settings = server_config.defaults()

2210

3014

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

2211

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

3015

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

3016

"foreground", "zeroconf"):

2212

3017

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

2213

3018

option)

2214

3019

if server_settings["port"]:

2215

3020

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

2216

3021

"port")

3022

if server_settings["socket"]:

3023

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

3024

"socket")

3025

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

3026

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

3027

# happen with a supplied network socket.

3028

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

3029

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

3030

["socket"])

2217

3031

del server_config

2218

3032

2219

3033

# Override the settings from the config file with command line

2220

3034

# options, if set.

2221

3035

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

2222

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

2223

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

2224

"statedir"):

3036

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

3037

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

3038

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

2225

3039

value = getattr(options, option)

2226

3040

if value is not None:

2227

3041

server_settings[option] = value

2228

3042

del options

2229

3043

# Force all strings to be unicode

2230

3044

for option in server_settings.keys():

2231

if type(server_settings[option]) is str:

2232

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

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

3048

# Force all boolean options to be boolean

3049

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

3050

"foreground", "zeroconf"):

3051

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

3052

# Debug implies foreground

3053

if server_settings["debug"]:

3054

server_settings["foreground"] = True

2233

3055

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

2234

3056

2235

3057

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

2236

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

2237

3064

# For convenience

2238

3065

debug = server_settings["debug"]

2239

3066

debuglevel = server_settings["debuglevel"]

2241

3068

use_ipv6 = server_settings["use_ipv6"]

2242

3069

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

2243

3070

stored_state_file)

2244

3071

foreground = server_settings["foreground"]

3072

zeroconf = server_settings["zeroconf"]

3073

2245

3074

if debug:

2246

3075

initlogger(debug, logging.DEBUG)

2247

3076

else:

2250

3079

else:

2251

3080

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

2252

3081

initlogger(debug, level)

2253

3082

2254

3083

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

2255

syslogger.setFormatter(logging.Formatter

2256

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

2257

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

2258

.format(server_settings

2259

["servicename"])))

2260

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2261

3089

# Parse config file with clients

2262

3090

client_config = configparser.SafeConfigParser(Client

2263

3091

.client_defaults)

2264

3092

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

2265

3093

"clients.conf"))

2266

3094

2267

3095

global mandos_dbus_service

2268

3096

mandos_dbus_service = None

2269

2270

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

2271

server_settings["port"]),

2272

ClientHandler,

2273

interface=(server_settings["interface"]

2274

or None),

2275

use_ipv6=use_ipv6,

2276

gnutls_priority=

2277

server_settings["priority"],

2278

use_dbus=use_dbus)

2279

if not debug:

2280

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

3097

3098

socketfd = None

3099

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

3100

socketfd = server_settings["socket"]

3101

tcp_server = MandosServer(

3102

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

3103

ClientHandler,

3104

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

3105

use_ipv6=use_ipv6,

3106

gnutls_priority=server_settings["priority"],

3107

use_dbus=use_dbus,

3108

socketfd=socketfd)

3109

if not foreground:

3110

pidfilename = "/run/mandos.pid"

3111

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

3112

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

3113

pidfile = None

2281

3114

try:

2282

pidfile = open(pidfilename, "w")

3115

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

2283

3116

except IOError as e:

2284

3117

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

2285

3118

exc_info=e)

2286

2287

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

3119

3120

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

3121

("mandos", "mandos"),

3122

("nobody", "nogroup")):

2288

3123

try:

2289

3124

uid = pwd.getpwnam(name).pw_uid

2290

gid = pwd.getpwnam(name).pw_gid

3125

gid = pwd.getpwnam(group).pw_gid

2291

3126

break

2292

3127

except KeyError:

2293

3128

continue

2297

3132

try:

2298

3133

os.setgid(gid)

2299

3134

os.setuid(uid)

3135

if debug:

3136

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

3137

gid))

2300

3138

except OSError as error:

2301

if error[0] != errno.EPERM:

2302

raise error

2303

3139

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

3140

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

3141

if error.errno != errno.EPERM:

3142

raise

3143

2304

3144

if debug:

2305

3145

# Enable all possible GnuTLS debugging

2306

3146

2307

3147

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

2308

3148

# - GnuTLS manual

2309

gnutls.library.functions.gnutls_global_set_log_level(11)

2310

2311

@gnutls.library.types.gnutls_log_func

3149

gnutls.global_set_log_level(11)

3150

3151

@gnutls.log_func

2312

3152

def debug_gnutls(level, string):

2313

3153

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

2314

2315

(gnutls.library.functions

2316

.gnutls_global_set_log_function(debug_gnutls))

2317

3154

3155

gnutls.global_set_log_function(debug_gnutls)

3156

2318

3157

# Redirect stdin so all checkers get /dev/null

2319

3158

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

2320

3159

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

2321

3160

if null > 2:

2322

3161

os.close(null)

2323

3162

2324

3163

# Need to fork before connecting to D-Bus

2325

if not debug:

3164

if not foreground:

2326

3165

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

2327

3166

daemon()

2328

2329

gobject.threads_init()

2330

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

2331

3172

global main_loop

2332

3173

# From the Avahi example code

2333

3174

DBusGMainLoop(set_as_default=True)

2334

main_loop = gobject.MainLoop()

3175

main_loop = GLib.MainLoop()

2335

3176

bus = dbus.SystemBus()

2336

3177

# End of Avahi example code

2337

3178

if use_dbus:

2338

3179

try:

2339

3180

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

2340

bus, do_not_queue=True)

2341

old_bus_name = (dbus.service.BusName

2342

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

2343

do_not_queue=True))

2344

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:

2345

3187

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

2346

3188

use_dbus = False

2347

3189

server_settings["use_dbus"] = False

2348

3190

tcp_server.use_dbus = False

2349

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2350

service = AvahiServiceToSyslog(name =

2351

server_settings["servicename"],

2352

servicetype = "_mandos._tcp",

2353

protocol = protocol, bus = bus)

2354

if server_settings["interface"]:

2355

service.interface = (if_nametoindex

2356

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

2357

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

2358

3202

global multiprocessing_manager

2359

3203

multiprocessing_manager = multiprocessing.Manager()

2360

3204

2361

3205

client_class = Client

2362

3206

if use_dbus:

2363

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

2364

3207

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

3208

2365

3209

client_settings = Client.config_parser(client_config)

2366

3210

old_client_settings = {}

2367

3211

clients_data = {}

2368

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

2369

3221

# Get client data and settings from last running state.

2370

3222

if server_settings["restore"]:

2371

3223

try:

2372

3224

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

2373

clients_data, old_client_settings = (pickle.load

2374

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

2375

3274

os.remove(stored_state_path)

2376

3275

except IOError as e:

2377

3276

if e.errno == errno.ENOENT:

2378

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

2379

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

3277

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

3278

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

2380

3279

else:

2381

3280

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

2382

3281

exc_info=e)

2383

3282

raise

2384

3283

except EOFError as e:

2385

3284

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

2386

"EOFError:", exc_info=e)

2387

3285

"EOFError:",

3286

exc_info=e)

3287

2388

3288

with PGPEngine() as pgp:

2389

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

2390

3294

# Decide which value to use after restoring saved state.

2391

3295

# We have three different values: Old config file,

2392

3296

# new config file, and saved state.

2397

3301

# For each value in new config, check if it

2398

3302

# differs from the old config value (Except for

2399

3303

# the "secret" attribute)

2400

if (name != "secret" and

2401

value != old_client_settings[client_name]

2402

[name]):

3304

if (name != "secret"

3305

and (value !=

3306

old_client_settings[client_name][name])):

2403

3307

client[name] = value

2404

3308

except KeyError:

2405

3309

pass

2406

3310

2407

3311

# Clients who has passed its expire date can still be

2408

# enabled if its last checker was successful. Clients

3312

# enabled if its last checker was successful. A Client

2409

3313

# whose checker succeeded before we stored its state is

2410

3314

# assumed to have successfully run all checkers during

2411

3315

# downtime.

2413

3317

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

2414

3318

if not client["last_checked_ok"]:

2415

3319

logger.warning(

2416

"disabling client {0} - Client never "

2417

"performed a successful checker"

2418

.format(client_name))

3320

"disabling client {} - Client never "

3321

"performed a successful checker".format(

3322

client_name))

2419

3323

client["enabled"] = False

2420

3324

elif client["last_checker_status"] != 0:

2421

3325

logger.warning(

2422

"disabling client {0} - Client "

2423

"last checker failed with error code {1}"

2424

.format(client_name,

2425

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

2426

3331

client["enabled"] = False

2427

3332

else:

2428

client["expires"] = (datetime.datetime

2429

.utcnow()

2430

+ client["timeout"])

3333

client["expires"] = (

3334

datetime.datetime.utcnow()

3335

+ client["timeout"])

2431

3336

logger.debug("Last checker succeeded,"

2432

" keeping {0} enabled"

2433

.format(client_name))

3337

" keeping {} enabled".format(

3338

client_name))

2434

3339

try:

2435

client["secret"] = (

2436

pgp.decrypt(client["encrypted_secret"],

2437

client_settings[client_name]

2438

["secret"]))

3340

client["secret"] = pgp.decrypt(

3341

client["encrypted_secret"],

3342

client_settings[client_name]["secret"])

2439

3343

except PGPError:

2440

3344

# If decryption fails, we use secret from new settings

2441

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

2442

.format(client_name))

2443

client["secret"] = (

2444

client_settings[client_name]["secret"])

2445

3345

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

3346

client_name))

3347

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

3348

["secret"])

3349

2446

3350

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

2447

3351

for client_name in (set(old_client_settings)

2448

3352

- set(client_settings)):

2450

3354

for client_name in (set(client_settings)

2451

3355

- set(old_client_settings)):

2452

3356

clients_data[client_name] = client_settings[client_name]

2453

3357

2454

3358

# Create all client objects

2455

for client_name, client in clients_data.iteritems():

3359

for client_name, client in clients_data.items():

2456

3360

tcp_server.clients[client_name] = client_class(

2457

name = client_name, settings = client)

2458

3361

name=client_name,

3362

settings=client,

3363

server_settings=server_settings)

3364

2459

3365

if not tcp_server.clients:

2460

3366

logger.warning("No clients defined")

2461

2462

if not debug:

2463

try:

2464

with pidfile:

2465

pid = os.getpid()

2466

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

2467

del pidfile

2468

except IOError:

2469

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

2470

pidfilename, pid)

2471

except NameError:

2472

# "pidfile" was never created

2473

pass

3367

3368

if not foreground:

3369

if pidfile is not None:

3370

pid = os.getpid()

3371

try:

3372

with pidfile:

3373

print(pid, file=pidfile)

3374

except IOError:

3375

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

3376

pidfilename, pid)

3377

del pidfile

2474

3378

del pidfilename

2475

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

2476

2477

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

2478

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

2479

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

2480

3384

if use_dbus:

2481

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

2482

"se.bsnet.fukt.Mandos"})

2483

class MandosDBusService(DBusObjectWithProperties):

3385

3386

@alternate_dbus_interfaces(

3387

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

3388

class MandosDBusService(DBusObjectWithObjectManager):

2484

3389

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

3390

2485

3391

def __init__(self):

2486

3392

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

3393

2487

3394

_interface = "se.recompile.Mandos"

2488

2489

@dbus_interface_annotations(_interface)

2490

def _foo(self):

2491

return { "org.freedesktop.DBus.Property"

2492

".EmitsChangedSignal":

2493

"false"}

2494

3395

2495

3396

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

2496

3397

def ClientAdded(self, objpath):

2497

3398

"D-Bus signal"

2498

3399

pass

2499

3400

2500

3401

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

2501

def ClientNotFound(self, fingerprint, address):

3402

def ClientNotFound(self, key_id, address):

2502

3403

"D-Bus signal"

2503

3404

pass

2504

3405

3406

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

3407

"true"})

2505

3408

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

2506

3409

def ClientRemoved(self, objpath, name):

2507

3410

"D-Bus signal"

2508

3411

pass

2509

3412

3413

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

3414

"true"})

2510

3415

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

2511

3416

def GetAllClients(self):

2512

3417

"D-Bus method"

2513

return dbus.Array(c.dbus_object_path

2514

for c in

2515

tcp_server.clients.itervalues())

2516

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

2517

3423

@dbus.service.method(_interface,

2518

3424

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

2519

3425

def GetAllClientsWithProperties(self):

2520

3426

"D-Bus method"

2521

3427

return dbus.Dictionary(

2522

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

2523

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

2524

3431

signature="oa{sv}")

2525

3432

2526

3433

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

2527

3434

def RemoveClient(self, object_path):

2528

3435

"D-Bus method"

2529

for c in tcp_server.clients.itervalues():

3436

for c in tcp_server.clients.values():

2530

3437

if c.dbus_object_path == object_path:

2531

3438

del tcp_server.clients[c.name]

2532

3439

c.remove_from_connection()

2533

# Don't signal anything except ClientRemoved

3440

# Don't signal the disabling

2534

3441

c.disable(quiet=True)

2535

# Emit D-Bus signal

2536

self.ClientRemoved(object_path, c.name)

3442

# Emit D-Bus signal for removal

3443

self.client_removed_signal(c)

2537

3444

return

2538

3445

raise KeyError(object_path)

2539

3446

2540

3447

del _interface

2541

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

2542

3485

mandos_dbus_service = MandosDBusService()

2543

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

2544

3492

def cleanup():

2545

3493

"Cleanup function; run on exit"

2546

service.cleanup()

2547

2548

multiprocessing.active_children()

3494

if zeroconf:

3495

service.cleanup()

3496

3497

mp.active_children()

3498

wn.close()

2549

3499

if not (tcp_server.clients or client_settings):

2550

3500

return

2551

3501

2552

3502

# Store client before exiting. Secrets are encrypted with key

2553

3503

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

2554

3504

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

2555

3505

clients = {}

2556

3506

with PGPEngine() as pgp:

2557

for client in tcp_server.clients.itervalues():

3507

for client in tcp_server.clients.values():

2558

3508

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

2559

3509

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

2560

3510

key)

2561

3511

client_dict = {}

2562

3512

2563

3513

# A list of attributes that can not be pickled

2564

3514

# + secret.

2565

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

2566

"checker"))

2567

for name, typ in (inspect.getmembers

2568

(dbus.service.Object)):

3515

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

3516

"checker", "server_settings"}

3517

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

3518

.Object):

2569

3519

exclude.add(name)

2570

3520

2571

3521

client_dict["encrypted_secret"] = (client

2572

3522

.encrypted_secret)

2573

3523

for attr in client.client_structure:

2574

3524

if attr not in exclude:

2575

3525

client_dict[attr] = getattr(client, attr)

2576

3526

2577

3527

clients[client.name] = client_dict

2578

3528

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

2579

3529

2580

3530

try:

2581

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

2582

prefix="clients-",

2583

dir=os.path.dirname

2584

(stored_state_path))

2585

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

2586

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

3531

with tempfile.NamedTemporaryFile(

3532

mode='wb',

3533

suffix=".pickle",

3534

prefix='clients-',

3535

dir=os.path.dirname(stored_state_path),

3536

delete=False) as stored_state:

3537

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

3538

protocol=2)

3539

tempname = stored_state.name

2587

3540

os.rename(tempname, stored_state_path)

2588

3541

except (IOError, OSError) as e:

2589

3542

if not debug:

2592

3545

except NameError:

2593

3546

pass

2594

3547

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

2595

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

3548

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

2596

3549

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

2597

3550

else:

2598

3551

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

2599

3552

exc_info=e)

2600

raise e

2601

3553

raise

3554

2602

3555

# Delete all clients, and settings from config

2603

3556

while tcp_server.clients:

2604

3557

name, client = tcp_server.clients.popitem()

2605

3558

if use_dbus:

2606

3559

client.remove_from_connection()

2607

# Don't signal anything except ClientRemoved

3560

# Don't signal the disabling

2608

3561

client.disable(quiet=True)

3562

# Emit D-Bus signal for removal

2609

3563

if use_dbus:

2610

# Emit D-Bus signal

2611

mandos_dbus_service.ClientRemoved(client

2612

.dbus_object_path,

2613

client.name)

3564

mandos_dbus_service.client_removed_signal(client)

2614

3565

client_settings.clear()

2615

3566

2616

3567

atexit.register(cleanup)

2617

2618

for client in tcp_server.clients.itervalues():

3568

3569

for client in tcp_server.clients.values():

2619

3570

if use_dbus:

2620

# Emit D-Bus signal

2621

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3571

# Emit D-Bus signal for adding

3572

mandos_dbus_service.client_added_signal(client)

2622

3573

# Need to initiate checking of clients

2623

3574

if client.enabled:

2624

3575

client.init_checker()

2625

3576

2626

3577

tcp_server.enable()

2627

3578

tcp_server.server_activate()

2628

3579

2629

3580

# Find out what port we got

2630

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

3581

if zeroconf:

3582

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

2631

3583

if use_ipv6:

2632

3584

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

2633

3585

" flowinfo %d, scope_id %d",

2635

3587

else: # IPv4

2636

3588

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

2637

3589

*tcp_server.socket.getsockname())

2638

2639

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

2640

3590

3591

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

3592

2641

3593

try:

2642

# From the Avahi example code

2643

try:

2644

service.activate()

2645

except dbus.exceptions.DBusException as error:

2646

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

2647

cleanup()

2648

sys.exit(1)

2649

# End of Avahi example code

2650

2651

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

2652

lambda *args, **kwargs:

2653

(tcp_server.handle_request

2654

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

2655

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

2656

3609

logger.debug("Starting main loop")

2657

3610

main_loop.run()

2658

3611

except AvahiError as error:

2667

3620

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

2668

3621

cleanup()

2669

3622

3623

2670

3624

if __name__ == '__main__':

2671

3625

main()