/mandos/trunk : revision 237.4.29

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

37

import SocketServer as socketserver

47

38

import socket

48

39

import argparse

49

40

import datetime

50

41

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

55

49

import sys

56

50

import re

57

51

import os

66

60

import struct

67

61

import fcntl

68

62

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

63

import cPickle as pickle

73

64

import multiprocessing

74

65

import types

75

66

import binascii

76

67

import tempfile

77

import itertools

78

import collections

79

import codecs

80

68

81

69

import dbus

82

70

import dbus.service

83

from gi.repository import GLib

71

import gobject

72

import avahi

84

73

from dbus.mainloop.glib import DBusGMainLoop

85

74

import ctypes

86

75

import ctypes.util

87

76

import xml.dom.minidom

88

77

import inspect

78

import GnuPGInterface

89

79

90

# Try to find the value of SO_BINDTODEVICE:

91

80

try:

92

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

93

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

94

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

82

except AttributeError:

96

83

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

84

from IN import SO_BINDTODEVICE

100

85

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.20"

86

SO_BINDTODEVICE = None

87

88

version = "1.5.3"

119

89

stored_state_file = "clients.pickle"

120

90

121

91

logger = logging.getLogger()

122

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

123

95

124

96

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

127

100

except (OSError, AttributeError):

128

129

101

def if_nametoindex(interface):

130

102

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

131

103

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

132

104

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

133

105

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

136

110

return interface_index

137

111

138

112

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

113

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

156

114

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

115

162

116

syslogger.setFormatter(logging.Formatter

163

117

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

164

118

' %(message)s'))

165

119

logger.addHandler(syslogger)

166

120

167

121

if debug:

168

122

console = logging.StreamHandler()

169

123

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

181

135

182

136

class PGPEngine(object):

183

137

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

184

185

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

186

140

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

147

206

148

def __enter__(self):

207

149

return self

208

209

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

150

151

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

210

152

self._cleanup()

211

153

return False

212

154

213

155

def __del__(self):

214

156

self._cleanup()

215

157

216

158

def _cleanup(self):

217

159

if self.tempdir is not None:

218

160

# Delete contents of tempdir

219

161

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

220

topdown=False):

162

topdown = False):

221

163

for filename in files:

222

164

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

223

165

for dirname in dirs:

225

167

# Remove tempdir

226

168

os.rmdir(self.tempdir)

227

169

self.tempdir = None

228

170

229

171

def password_encode(self, password):

230

172

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

231

173

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

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

174

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

175

240

176

def encrypt(self, data, password):

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

256

191

return ciphertext

257

192

258

193

def decrypt(self, data, password):

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

274

208

return decrypted_plaintext

275

209

276

210

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

211

304

212

class AvahiError(Exception):

305

213

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

306

214

self.value = value

307

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

308

**kwargs)

309

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

310

218

311

219

class AvahiServiceError(AvahiError):

312

220

pass

313

221

314

315

222

class AvahiGroupError(AvahiError):

316

223

pass

317

224

318

225

319

226

class AvahiService(object):

320

227

"""An Avahi (Zeroconf) service.

321

228

322

229

Attributes:

323

230

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

324

231

Used to optionally bind to the specified interface.

325

232

name: string; Example: 'Mandos'

326

233

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

327

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

234

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

328

235

port: integer; what port to announce

329

236

TXT: list of strings; TXT record for the service

330

237

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

336

243

server: D-Bus Server

337

244

bus: dbus.SystemBus()

338

245

"""

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

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

351

250

self.interface = interface

352

251

self.name = name

353

252

self.type = servicetype

362

261

self.server = None

363

262

self.bus = bus

364

263

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

264

def rename(self):

367

265

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

368

266

if self.rename_count >= self.max_renames:

369

267

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

370

268

" after %i retries, exiting.",

371

269

self.rename_count)

372

270

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

376

273

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

377

274

self.name)

378

if remove:

379

self.remove()

275

self.remove()

380

276

try:

381

277

self.add()

382

278

except dbus.exceptions.DBusException as error:

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

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

392

283

def remove(self):

393

284

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

394

285

if self.entry_group_state_changed_match is not None:

396

287

self.entry_group_state_changed_match = None

397

288

if self.group is not None:

398

289

self.group.Reset()

399

400

290

def add(self):

401

291

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

402

292

self.remove()

419

309

dbus.UInt16(self.port),

420

310

avahi.string_array_to_txt_array(self.TXT))

421

311

self.group.Commit()

422

423

312

def entry_group_state_changed(self, state, error):

424

313

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

425

314

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

426

315

427

316

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

317

logger.debug("Zeroconf service established.")

429

318

elif state == avahi.ENTRY_GROUP_COLLISION:

431

320

self.rename()

432

321

elif state == avahi.ENTRY_GROUP_FAILURE:

433

322

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

434

str(error))

435

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

436

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

437

326

def cleanup(self):

438

327

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

439

328

if self.group is not None:

444

333

pass

445

334

self.group = None

446

335

self.remove()

447

448

336

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

449

337

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

450

338

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

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

}

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

457

346

if state in bad_states:

458

347

if bad_states[state] is not None:

459

348

if error is None:

462

351

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

463

352

self.cleanup()

464

353

elif state == avahi.SERVER_RUNNING:

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)

354

self.add()

477

355

else:

478

356

if error is None:

479

357

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

480

358

else:

481

359

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

482

483

360

def activate(self):

484

361

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

485

362

if self.server is None:

489

366

follow_name_owner_changes=True),

490

367

avahi.DBUS_INTERFACE_SERVER)

491

368

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

369

self.server_state_changed)

493

370

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

494

371

495

496

372

class AvahiServiceToSyslog(AvahiService):

497

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

373

def rename(self):

498

374

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

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

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

503

380

return ret

504

381

505

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

_tls_rawpk_version = b"3.6.6"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CRT_RAWPK = 3

535

CLIENT = 2

536

SHUT_RDWR = 0

537

CRD_CERTIFICATE = 1

538

E_NO_CERTIFICATE_FOUND = -49

539

X509_FMT_DER = 0

540

NO_TICKETS = 1<<10

541

ENABLE_RAWPK = 1<<18

542

CTYPE_PEERS = 3

543

KEYID_USE_SHA256 = 1 # gnutls/x509.h

544

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

545

546

# Types

547

class session_int(ctypes.Structure):

548

_fields_ = []

549

session_t = ctypes.POINTER(session_int)

550

551

class certificate_credentials_st(ctypes.Structure):

552

_fields_ = []

553

certificate_credentials_t = ctypes.POINTER(

554

certificate_credentials_st)

555

certificate_type_t = ctypes.c_int

556

557

class datum_t(ctypes.Structure):

558

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

559

('size', ctypes.c_uint)]

560

561

class openpgp_crt_int(ctypes.Structure):

562

_fields_ = []

563

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

564

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

565

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

566

credentials_type_t = ctypes.c_int

567

transport_ptr_t = ctypes.c_void_p

568

close_request_t = ctypes.c_int

569

570

# Exceptions

571

class Error(Exception):

572

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

573

# exception might be raised from within GnuTLS.__init__,

574

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

575

# global variable has happened.

576

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

577

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

578

# code is passed, convert it to a string with

579

# gnutls.strerror()

580

self.code = code

581

if message is None and code is not None:

582

message = GnuTLS.strerror(code)

583

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

584

message, *args)

585

586

class CertificateSecurityError(Error):

587

pass

588

589

# Classes

590

class Credentials(object):

591

def __init__(self):

592

self._c_object = gnutls.certificate_credentials_t()

593

gnutls.certificate_allocate_credentials(

594

ctypes.byref(self._c_object))

595

self.type = gnutls.CRD_CERTIFICATE

596

597

def __del__(self):

598

gnutls.certificate_free_credentials(self._c_object)

599

600

class ClientSession(object):

601

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

602

self._c_object = gnutls.session_t()

603

gnutls_flags = gnutls.CLIENT

604

if gnutls.check_version("3.5.6"):

605

gnutls_flags |= gnutls.NO_TICKETS

606

if gnutls.has_rawpk:

607

gnutls_flags |= gnutls.ENABLE_RAWPK

608

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

609

del gnutls_flags

610

gnutls.set_default_priority(self._c_object)

611

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

612

gnutls.handshake_set_private_extensions(self._c_object,

613

True)

614

self.socket = socket

615

if credentials is None:

616

credentials = gnutls.Credentials()

617

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

618

ctypes.cast(credentials._c_object,

619

ctypes.c_void_p))

620

self.credentials = credentials

621

622

def __del__(self):

623

gnutls.deinit(self._c_object)

624

625

def handshake(self):

626

return gnutls.handshake(self._c_object)

627

628

def send(self, data):

629

data = bytes(data)

630

data_len = len(data)

631

while data_len > 0:

632

data_len -= gnutls.record_send(self._c_object,

633

data[-data_len:],

634

data_len)

635

636

def bye(self):

637

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

638

639

# Error handling functions

640

def _error_code(result):

641

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

642

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

643

if result >= 0:

644

return result

645

if result == gnutls.E_NO_CERTIFICATE_FOUND:

646

raise gnutls.CertificateSecurityError(code=result)

647

raise gnutls.Error(code=result)

648

649

def _retry_on_error(result, func, arguments):

650

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

651

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

652

while result < 0:

653

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

654

return _error_code(result)

655

result = func(*arguments)

656

return result

657

658

# Unless otherwise indicated, the function declarations below are

659

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

660

661

# Functions

662

priority_set_direct = _library.gnutls_priority_set_direct

663

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

664

ctypes.POINTER(ctypes.c_char_p)]

665

priority_set_direct.restype = _error_code

666

667

init = _library.gnutls_init

668

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

669

init.restype = _error_code

670

671

set_default_priority = _library.gnutls_set_default_priority

672

set_default_priority.argtypes = [session_t]

673

set_default_priority.restype = _error_code

674

675

record_send = _library.gnutls_record_send

676

record_send.argtypes = [session_t, ctypes.c_void_p,

677

ctypes.c_size_t]

678

record_send.restype = ctypes.c_ssize_t

679

record_send.errcheck = _retry_on_error

680

681

certificate_allocate_credentials = (

682

_library.gnutls_certificate_allocate_credentials)

683

certificate_allocate_credentials.argtypes = [

684

ctypes.POINTER(certificate_credentials_t)]

685

certificate_allocate_credentials.restype = _error_code

686

687

certificate_free_credentials = (

688

_library.gnutls_certificate_free_credentials)

689

certificate_free_credentials.argtypes = [

690

certificate_credentials_t]

691

certificate_free_credentials.restype = None

692

693

handshake_set_private_extensions = (

694

_library.gnutls_handshake_set_private_extensions)

695

handshake_set_private_extensions.argtypes = [session_t,

696

ctypes.c_int]

697

handshake_set_private_extensions.restype = None

698

699

credentials_set = _library.gnutls_credentials_set

700

credentials_set.argtypes = [session_t, credentials_type_t,

701

ctypes.c_void_p]

702

credentials_set.restype = _error_code

703

704

strerror = _library.gnutls_strerror

705

strerror.argtypes = [ctypes.c_int]

706

strerror.restype = ctypes.c_char_p

707

708

certificate_type_get = _library.gnutls_certificate_type_get

709

certificate_type_get.argtypes = [session_t]

710

certificate_type_get.restype = _error_code

711

712

certificate_get_peers = _library.gnutls_certificate_get_peers

713

certificate_get_peers.argtypes = [session_t,

714

ctypes.POINTER(ctypes.c_uint)]

715

certificate_get_peers.restype = ctypes.POINTER(datum_t)

716

717

global_set_log_level = _library.gnutls_global_set_log_level

718

global_set_log_level.argtypes = [ctypes.c_int]

719

global_set_log_level.restype = None

720

721

global_set_log_function = _library.gnutls_global_set_log_function

722

global_set_log_function.argtypes = [log_func]

723

global_set_log_function.restype = None

724

725

deinit = _library.gnutls_deinit

726

deinit.argtypes = [session_t]

727

deinit.restype = None

728

729

handshake = _library.gnutls_handshake

730

handshake.argtypes = [session_t]

731

handshake.restype = _error_code

732

handshake.errcheck = _retry_on_error

733

734

transport_set_ptr = _library.gnutls_transport_set_ptr

735

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

736

transport_set_ptr.restype = None

737

738

bye = _library.gnutls_bye

739

bye.argtypes = [session_t, close_request_t]

740

bye.restype = _error_code

741

bye.errcheck = _retry_on_error

742

743

check_version = _library.gnutls_check_version

744

check_version.argtypes = [ctypes.c_char_p]

745

check_version.restype = ctypes.c_char_p

746

747

has_rawpk = bool(check_version(_tls_rawpk_version))

748

749

if has_rawpk:

750

# Types

751

class pubkey_st(ctypes.Structure):

752

_fields = []

753

pubkey_t = ctypes.POINTER(pubkey_st)

754

755

x509_crt_fmt_t = ctypes.c_int

756

757

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

758

pubkey_init = _library.gnutls_pubkey_init

759

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

760

pubkey_init.restype = _error_code

761

762

pubkey_import = _library.gnutls_pubkey_import

763

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

764

x509_crt_fmt_t]

765

pubkey_import.restype = _error_code

766

767

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

768

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

769

ctypes.POINTER(ctypes.c_ubyte),

770

ctypes.POINTER(ctypes.c_size_t)]

771

pubkey_get_key_id.restype = _error_code

772

773

pubkey_deinit = _library.gnutls_pubkey_deinit

774

pubkey_deinit.argtypes = [pubkey_t]

775

pubkey_deinit.restype = None

776

else:

777

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

778

779

openpgp_crt_init = _library.gnutls_openpgp_crt_init

780

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

781

openpgp_crt_init.restype = _error_code

782

783

openpgp_crt_import = _library.gnutls_openpgp_crt_import

784

openpgp_crt_import.argtypes = [openpgp_crt_t,

785

ctypes.POINTER(datum_t),

786

openpgp_crt_fmt_t]

787

openpgp_crt_import.restype = _error_code

788

789

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

790

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

791

ctypes.POINTER(ctypes.c_uint)]

792

openpgp_crt_verify_self.restype = _error_code

793

794

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

795

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

796

openpgp_crt_deinit.restype = None

797

798

openpgp_crt_get_fingerprint = (

799

_library.gnutls_openpgp_crt_get_fingerprint)

800

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

801

ctypes.c_void_p,

802

ctypes.POINTER(

803

ctypes.c_size_t)]

804

openpgp_crt_get_fingerprint.restype = _error_code

805

806

if check_version("3.6.4"):

807

certificate_type_get2 = _library.gnutls_certificate_type_get2

808

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

809

certificate_type_get2.restype = _error_code

810

811

# Remove non-public functions

812

del _error_code, _retry_on_error

813

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

814

gnutls = GnuTLS()

815

816

817

def call_pipe(connection, # : multiprocessing.Connection

818

func, *args, **kwargs):

819

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

820

821

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

822

return value on the provided multiprocessing.Connection.

823

"""

824

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

825

connection.close()

826

827

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

828

388

class Client(object):

829

389

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

830

390

831

391

Attributes:

832

392

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

833

393

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

835

395

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

836

396

to see if the client lives.

837

397

'None' if no process is running.

838

checker_callback_tag: a GLib event source tag, or None

398

checker_callback_tag: a gobject event source tag, or None

839

399

checker_command: string; External command which is run to check

840

400

if client lives. %() expansions are done at

841

401

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

842

402

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

843

checker_initiator_tag: a GLib event source tag, or None

403

checker_initiator_tag: a gobject event source tag, or None

844

404

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

845

405

client_structure: Object describing what attributes a client has

846

406

and is used for storing the client at exit

847

407

current_checker_command: string; current running checker_command

848

disable_initiator_tag: a GLib event source tag, or None

408

disable_initiator_tag: a gobject event source tag, or None

849

409

enabled: bool()

850

410

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

851

uniquely identify an OpenPGP client

852

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

853

a client using raw public keys

411

uniquely identify the client

854

412

host: string; available for use by the checker command

855

413

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

856

414

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

858

416

last_checker_status: integer between 0 and 255 reflecting exit

859

417

status of last checker. -1 reflects crashed

860

418

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

863

419

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

864

420

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

865

421

D-Bus identifiers

870

426

runtime_expansions: Allowed attributes for runtime expansion.

871

427

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

872

428

disabled, or None

873

server_settings: The server_settings dict from main()

874

429

"""

875

430

876

431

runtime_expansions = ("approval_delay", "approval_duration",

877

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

878

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

879

"last_approval_request", "last_checked_ok",

432

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

433

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

880

434

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

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

}

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

892

460

893

461

@staticmethod

894

462

def config_parser(config):

902

470

for client_name in config.sections():

903

471

section = dict(config.items(client_name))

904

472

client = settings[client_name] = {}

905

473

906

474

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

907

475

# Reformat values from string types to Python types

908

476

client["approved_by_default"] = config.getboolean(

909

477

client_name, "approved_by_default")

910

478

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

911

479

"enabled")

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

480

918

481

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

919

482

.replace(" ", ""))

920

483

if "secret" in section:

921

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

922

.encode("utf-8"),

923

"base64")

484

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

924

485

elif "secfile" in section:

925

486

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

926

487

(section["secfile"])),

927

488

"rb") as secfile:

928

489

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

929

490

else:

930

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

931

.format(section))

491

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

492

% section)

932

493

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

933

494

client["extended_timeout"] = string_to_delta(

934

495

section["extended_timeout"])

941

502

client["last_approval_request"] = None

942

503

client["last_checked_ok"] = None

943

504

client["last_checker_status"] = -2

944

505

945

506

return settings

946

947

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

507

508

509

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

510

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

511

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

512

attribute."""

948

513

self.name = name

949

if server_settings is None:

950

server_settings = {}

951

self.server_settings = server_settings

952

514

# adding all client settings

953

for setting, value in settings.items():

515

for setting, value in settings.iteritems():

954

516

setattr(self, setting, value)

955

517

956

518

if self.enabled:

957

519

if not hasattr(self, "last_enabled"):

958

520

self.last_enabled = datetime.datetime.utcnow()

962

524

else:

963

525

self.last_enabled = None

964

526

self.expires = None

965

527

966

528

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

967

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

968

532

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

969

533

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

970

534

datetime.datetime.utcnow())

977

541

self.current_checker_command = None

978

542

self.approved = None

979

543

self.approvals_pending = 0

980

self.changedstate = multiprocessing_manager.Condition(

981

multiprocessing_manager.Lock())

982

self.client_structure = [attr

983

for attr in self.__dict__.keys()

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

984

549

if not attr.startswith("_")]

985

550

self.client_structure.append("client_structure")

986

987

for name, t in inspect.getmembers(

988

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

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

989

556

if not name.startswith("_"):

990

557

self.client_structure.append(name)

991

558

992

559

# Send notice to process children that client state has changed

993

560

def send_changedstate(self):

994

561

with self.changedstate:

995

562

self.changedstate.notify_all()

996

563

997

564

def enable(self):

998

565

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

999

566

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

1000

567

# Already enabled

1001

568

return

569

self.send_changedstate()

1002

570

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

1003

571

self.enabled = True

1004

572

self.last_enabled = datetime.datetime.utcnow()

1005

573

self.init_checker()

1006

self.send_changedstate()

1007

574

1008

575

def disable(self, quiet=True):

1009

576

"""Disable this client."""

1010

577

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

1011

578

return False

1012

579

if not quiet:

580

self.send_changedstate()

581

if not quiet:

1013

582

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

1014

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

1015

GLib.source_remove(self.disable_initiator_tag)

583

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

584

gobject.source_remove(self.disable_initiator_tag)

1016

585

self.disable_initiator_tag = None

1017

586

self.expires = None

1018

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

1019

GLib.source_remove(self.checker_initiator_tag)

587

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

588

gobject.source_remove(self.checker_initiator_tag)

1020

589

self.checker_initiator_tag = None

1021

590

self.stop_checker()

1022

591

self.enabled = False

1023

if not quiet:

1024

self.send_changedstate()

1025

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

592

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

1026

593

return False

1027

594

1028

595

def __del__(self):

1029

596

self.disable()

1030

597

1031

598

def init_checker(self):

1032

599

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

1033

600

# and every interval from then on.

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)

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

1039

604

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

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)

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

1044

608

# Also start a new checker *right now*.

1045

609

self.start_checker()

1046

1047

def checker_callback(self, source, condition, connection,

1048

command):

610

611

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

1049

612

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

1050

613

self.checker_callback_tag = None

1051

614

self.checker = None

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

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1059

617

if self.last_checker_status == 0:

1060

618

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

1061

619

vars(self))

1062

620

self.checked_ok()

1063

621

else:

1064

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

622

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

623

vars(self))

1065

624

else:

1066

625

self.last_checker_status = -1

1067

self.last_checker_signal = -returncode

1068

626

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

1069

627

vars(self))

1070

return False

1071

628

1072

629

def checked_ok(self):

1073

630

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

1074

631

self.last_checked_ok = datetime.datetime.utcnow()

1075

632

self.last_checker_status = 0

1076

self.last_checker_signal = None

1077

633

self.bump_timeout()

1078

634

1079

635

def bump_timeout(self, timeout=None):

1080

636

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

1081

637

if timeout is None:

1082

638

timeout = self.timeout

1083

639

if self.disable_initiator_tag is not None:

1084

GLib.source_remove(self.disable_initiator_tag)

1085

self.disable_initiator_tag = None

640

gobject.source_remove(self.disable_initiator_tag)

1086

641

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

1087

self.disable_initiator_tag = GLib.timeout_add(

1088

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

642

self.disable_initiator_tag = (gobject.timeout_add

643

(timedelta_to_milliseconds

644

(timeout), self.disable))

1089

645

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

1090

646

1091

647

def need_approval(self):

1092

648

self.last_approval_request = datetime.datetime.utcnow()

1093

649

1094

650

def start_checker(self):

1095

651

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

1096

652

1097

653

If a checker already exists, leave it running and do

1098

654

nothing."""

1099

655

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

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

656

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

657

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

658

# client would inevitably timeout, since no checker would get

659

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

1104

660

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

1105

661

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

1106

662

# should be.

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

663

664

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

665

try:

666

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

667

except (AttributeError, OSError) as error:

668

if (isinstance(error, OSError)

669

and error.errno != errno.ECHILD):

670

raise error

671

else:

672

if pid:

673

logger.warning("Checker was a zombie")

674

gobject.source_remove(self.checker_callback_tag)

675

self.checker_callback(pid, status,

676

self.current_checker_command)

1112

677

# Start a new checker if needed

1113

678

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}

1118

679

try:

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

680

# In case checker_command has exactly one % operator

681

command = self.checker_command % self.host

682

except TypeError:

683

# Escape attributes for the shell

684

escaped_attrs = dict(

685

(attr,

686

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

687

errors=

688

'replace')))

689

for attr in

690

self.runtime_expansions)

691

692

try:

693

command = self.checker_command % escaped_attrs

694

except TypeError as error:

695

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

696

' %s', self.checker_command, error)

697

return True # Try again later

1125

698

self.current_checker_command = command

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

699

try:

700

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

701

command, self.name)

702

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

703

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

704

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

705

# always replaced by /dev/null.)

706

self.checker = subprocess.Popen(command,

707

close_fds=True,

708

shell=True, cwd="/")

709

self.checker_callback_tag = (gobject.child_watch_add

710

(self.checker.pid,

711

self.checker_callback,

712

data=command))

713

# The checker may have completed before the gobject

714

# watch was added. Check for this.

715

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

716

if pid:

717

gobject.source_remove(self.checker_callback_tag)

718

self.checker_callback(pid, status, command)

719

except OSError as error:

720

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

721

error)

722

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

1152

723

return True

1153

724

1154

725

def stop_checker(self):

1155

726

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

1156

727

if self.checker_callback_tag:

1157

GLib.source_remove(self.checker_callback_tag)

728

gobject.source_remove(self.checker_callback_tag)

1158

729

self.checker_callback_tag = None

1159

730

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

1160

731

return

1161

732

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

1162

self.checker.terminate()

733

try:

734

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

735

#time.sleep(0.5)

736

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

737

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

738

except OSError as error:

739

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

740

raise

1163

741

self.checker = None

1164

742

1165

743

1166

def dbus_service_property(dbus_interface,

1167

signature="v",

1168

access="readwrite",

1169

byte_arrays=False):

744

def dbus_service_property(dbus_interface, signature="v",

745

access="readwrite", byte_arrays=False):

1170

746

"""Decorators for marking methods of a DBusObjectWithProperties to

1171

747

become properties on the D-Bus.

1172

748

1173

749

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

1174

750

and with one argument by "Set".

1175

751

1176

752

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

1177

753

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

1178

754

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

1181

757

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

1182

758

if byte_arrays and signature != "ay":

1183

759

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

1184

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

1185

760

" signature %r" % signature)

1186

761

def decorator(func):

1187

762

func._dbus_is_property = True

1188

763

func._dbus_interface = dbus_interface

1191

766

func._dbus_name = func.__name__

1192

767

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

1193

768

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

1194

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1195

return func

1196

1197

return decorator

1198

1199

1200

def dbus_interface_annotations(dbus_interface):

1201

"""Decorator for marking functions returning interface annotations

1202

1203

Usage:

1204

1205

@dbus_interface_annotations("org.example.Interface")

1206

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

1207

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

1208

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

1209

"false"}

1210

"""

1211

1212

def decorator(func):

1213

func._dbus_is_interface = True

1214

func._dbus_interface = dbus_interface

1215

func._dbus_name = dbus_interface

1216

return func

1217

1218

return decorator

1219

1220

1221

def dbus_annotations(annotations):

1222

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

1223

Usage:

1224

1225

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

1226

"org.freedesktop.DBus.Property."

1227

"EmitsChangedSignal": "false"})

1228

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

1229

access="r")

1230

def Property_dbus_property(self):

1231

return dbus.Boolean(False)

1232

1233

See also the DBusObjectWithAnnotations class.

1234

"""

1235

1236

def decorator(func):

1237

func._dbus_annotations = annotations

1238

return func

1239

769

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

770

return func

1240

771

return decorator

1241

772

1242

773

1243

774

class DBusPropertyException(dbus.exceptions.DBusException):

1244

775

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

1245

776

"""

1246

pass

777

def __unicode__(self):

778

return unicode(str(self))

1247

779

1248

780

1249

781

class DBusPropertyAccessException(DBusPropertyException):

1258

790

pass

1259

791

1260

792

1261

class DBusObjectWithAnnotations(dbus.service.Object):

1262

"""A D-Bus object with annotations.

1263

1264

Classes inheriting from this can use the dbus_annotations

1265

decorator to add annotations to methods or signals.

1266

"""

1267

1268

@staticmethod

1269

def _is_dbus_thing(thing):

1270

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

1271

1272

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

1273

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

1274

"""

1275

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

1276

False)

1277

1278

def _get_all_dbus_things(self, thing):

1279

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

1280

"""

1281

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

1282

athing.__get__(self))

1283

for cls in self.__class__.__mro__

1284

for name, athing in

1285

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

1286

1287

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1288

out_signature="s",

1289

path_keyword='object_path',

1290

connection_keyword='connection')

1291

def Introspect(self, object_path, connection):

1292

"""Overloading of standard D-Bus method.

1293

1294

Inserts annotation tags on methods and signals.

1295

"""

1296

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

1297

connection)

1298

try:

1299

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

1300

1301

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

1302

# Add annotation tags

1303

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

1304

for tag in if_tag.getElementsByTagName(typ):

1305

annots = dict()

1306

for name, prop in (self.

1307

_get_all_dbus_things(typ)):

1308

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

1309

and prop._dbus_interface

1310

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

1311

annots.update(getattr(

1312

prop, "_dbus_annotations", {}))

1313

for name, value in annots.items():

1314

ann_tag = document.createElement(

1315

"annotation")

1316

ann_tag.setAttribute("name", name)

1317

ann_tag.setAttribute("value", value)

1318

tag.appendChild(ann_tag)

1319

# Add interface annotation tags

1320

for annotation, value in dict(

1321

itertools.chain.from_iterable(

1322

annotations().items()

1323

for name, annotations

1324

in self._get_all_dbus_things("interface")

1325

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

1326

)).items():

1327

ann_tag = document.createElement("annotation")

1328

ann_tag.setAttribute("name", annotation)

1329

ann_tag.setAttribute("value", value)

1330

if_tag.appendChild(ann_tag)

1331

# Fix argument name for the Introspect method itself

1332

if (if_tag.getAttribute("name")

1333

== dbus.INTROSPECTABLE_IFACE):

1334

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

1335

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

1336

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

1337

if (arg.getAttribute("direction")

1338

== "out"):

1339

arg.setAttribute("name",

1340

"xml_data")

1341

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

1342

document.unlink()

1343

except (AttributeError, xml.dom.DOMException,

1344

xml.parsers.expat.ExpatError) as error:

1345

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

1346

exc_info=error)

1347

return xmlstring

1348

1349

1350

class DBusObjectWithProperties(DBusObjectWithAnnotations):

793

class DBusObjectWithProperties(dbus.service.Object):

1351

794

"""A D-Bus object with properties.

1352

795

1353

796

Classes inheriting from this can use the dbus_service_property

1354

797

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

1355

798

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

1356

799

"""

1357

800

801

@staticmethod

802

def _is_dbus_property(obj):

803

return getattr(obj, "_dbus_is_property", False)

804

805

def _get_all_dbus_properties(self):

806

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

807

"""

808

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

809

for cls in self.__class__.__mro__

810

for name, prop in

811

inspect.getmembers(cls, self._is_dbus_property))

812

1358

813

def _get_dbus_property(self, interface_name, property_name):

1359

814

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

1360

815

property with the specified name and interface.

1361

816

"""

1362

for cls in self.__class__.__mro__:

1363

for name, value in inspect.getmembers(

1364

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

817

for cls in self.__class__.__mro__:

818

for name, value in (inspect.getmembers

819

(cls, self._is_dbus_property)):

1365

820

if (value._dbus_name == property_name

1366

821

and value._dbus_interface == interface_name):

1367

822

return value.__get__(self)

1368

823

1369

824

# No such property

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

825

raise DBusPropertyNotFound(self.dbus_object_path + ":"

826

+ interface_name + "."

827

+ property_name)

828

829

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

1384

830

out_signature="v")

1385

831

def Get(self, interface_name, property_name):

1386

832

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

1392

838

if not hasattr(value, "variant_level"):

1393

839

return value

1394

840

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

1395

841

1396

842

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

1397

843

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

1398

844

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

1404

850

# The byte_arrays option is not supported yet on

1405

851

# signatures other than "ay".

1406

852

if prop._dbus_signature != "ay":

1407

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

1408

"'ay' signature {!r}"

1409

.format(prop._dbus_signature))

853

raise ValueError

1410

854

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

1411

855

for byte in value))

1412

856

prop(value)

1413

1414

@dbus.service.method(dbus.PROPERTIES_IFACE,

1415

in_signature="s",

857

858

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

1416

859

out_signature="a{sv}")

1417

860

def GetAll(self, interface_name):

1418

861

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

1419

862

standard.

1420

863

1421

864

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

1422

865

"""

1423

866

properties = {}

1424

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

867

for name, prop in self._get_all_dbus_properties():

1425

868

if (interface_name

1426

869

and interface_name != prop._dbus_interface):

1427

870

# Interface non-empty but did not match

1433

876

if not hasattr(value, "variant_level"):

1434

877

properties[name] = value

1435

878

continue

1436

properties[name] = type(value)(

1437

value, variant_level=value.variant_level + 1)

879

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

880

value.variant_level+1)

1438

881

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

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

882

1448

883

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1449

884

out_signature="s",

1450

885

path_keyword='object_path',

1451

886

connection_keyword='connection')

1452

887

def Introspect(self, object_path, connection):

1453

"""Overloading of standard D-Bus method.

1454

1455

Inserts property tags and interface annotation tags.

888

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

1456

889

"""

1457

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1458

object_path,

1459

connection)

890

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

891

connection)

1460

892

try:

1461

893

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

1462

1463

894

def make_tag(document, name, prop):

1464

895

e = document.createElement("property")

1465

896

e.setAttribute("name", name)

1466

897

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

1467

898

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

1468

899

return e

1469

1470

900

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

1471

# Add property tags

1472

901

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

1473

902

for name, prop

1474

in self._get_all_dbus_things("property")

903

in self._get_all_dbus_properties()

1475

904

if prop._dbus_interface

1476

905

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

1477

906

if_tag.appendChild(tag)

1478

# Add annotation tags for properties

1479

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

1480

annots = dict()

1481

for name, prop in self._get_all_dbus_things(

1482

"property"):

1483

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

1484

and prop._dbus_interface

1485

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

1486

annots.update(getattr(

1487

prop, "_dbus_annotations", {}))

1488

for name, value in annots.items():

1489

ann_tag = document.createElement(

1490

"annotation")

1491

ann_tag.setAttribute("name", name)

1492

ann_tag.setAttribute("value", value)

1493

tag.appendChild(ann_tag)

1494

907

# Add the names to the return values for the

1495

908

# "org.freedesktop.DBus.Properties" methods

1496

909

if (if_tag.getAttribute("name")

1511

924

except (AttributeError, xml.dom.DOMException,

1512

925

xml.parsers.expat.ExpatError) as error:

1513

926

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

1514

exc_info=error)

1515

return xmlstring

1516

1517

1518

try:

1519

dbus.OBJECT_MANAGER_IFACE

1520

except AttributeError:

1521

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

1522

1523

1524

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1525

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

1526

1527

Classes inheriting from this exposes the standard

1528

GetManagedObjects call and the InterfacesAdded and

1529

InterfacesRemoved signals on the standard

1530

"org.freedesktop.DBus.ObjectManager" interface.

1531

1532

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

1533

manually.

1534

"""

1535

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def GetManagedObjects(self):

1538

"""This function must be overridden"""

1539

raise NotImplementedError()

1540

1541

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def InterfacesAdded(self, object_path, interfaces_and_properties):

1544

pass

1545

1546

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

1547

def InterfacesRemoved(self, object_path, interfaces):

1548

pass

1549

1550

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1551

out_signature="s",

1552

path_keyword='object_path',

1553

connection_keyword='connection')

1554

def Introspect(self, object_path, connection):

1555

"""Overloading of standard D-Bus method.

1556

1557

Override return argument name of GetManagedObjects to be

1558

"objpath_interfaces_and_properties"

1559

"""

1560

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1561

object_path,

1562

connection)

1563

try:

1564

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

1565

1566

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

1567

# Fix argument name for the GetManagedObjects method

1568

if (if_tag.getAttribute("name")

1569

== dbus.OBJECT_MANAGER_IFACE):

1570

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

1571

if (cn.getAttribute("name")

1572

== "GetManagedObjects"):

1573

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

1574

if (arg.getAttribute("direction")

1575

== "out"):

1576

arg.setAttribute(

1577

"name",

1578

"objpath_interfaces"

1579

"_and_properties")

1580

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

1581

document.unlink()

1582

except (AttributeError, xml.dom.DOMException,

1583

xml.parsers.expat.ExpatError) as error:

1584

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

1585

exc_info=error)

1586

return xmlstring

1587

1588

1589

def datetime_to_dbus(dt, variant_level=0):

927

error)

928

return xmlstring

929

930

931

def datetime_to_dbus (dt, variant_level=0):

1590

932

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

1591

933

if dt is None:

1592

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

1593

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

1594

1595

1596

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1597

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

1598

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

1599

interface names according to the "alt_interface_names" mapping.

1600

Usage:

1601

1602

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

1603

"net.example.AlternateInterface"})

1604

class SampleDBusObject(dbus.service.Object):

1605

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

1606

def SampleDBusMethod():

1607

pass

1608

1609

The above "SampleDBusMethod" on "SampleDBusObject" will be

1610

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

1611

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

1612

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

1613

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

1614

1615

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

1616

(from DBusObjectWithProperties) and interfaces (from the

1617

dbus_interface_annotations decorator).

934

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

935

return dbus.String(dt.isoformat(),

936

variant_level=variant_level)

937

938

939

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

940

.__metaclass__):

941

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

942

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

1618

943

"""

1619

1620

def wrapper(cls):

1621

for orig_interface_name, alt_interface_name in (

1622

alt_interface_names.items()):

1623

attr = {}

1624

interface_names = set()

1625

# Go though all attributes of the class

1626

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

944

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

945

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

946

# methods, signals, or properties in them

947

for base in (b for b in bases

948

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

949

# Go though all attributes of the base class

950

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

1627

951

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

1628

952

# with the wrong interface name

1629

953

if (not hasattr(attribute, "_dbus_interface")

1630

or not attribute._dbus_interface.startswith(

1631

orig_interface_name)):

954

or not attribute._dbus_interface

955

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

1632

956

continue

1633

957

# Create an alternate D-Bus interface name based on

1634

958

# the current name

1635

alt_interface = attribute._dbus_interface.replace(

1636

orig_interface_name, alt_interface_name)

1637

interface_names.add(alt_interface)

959

alt_interface = (attribute._dbus_interface

960

.replace("se.recompile.Mandos",

961

"se.bsnet.fukt.Mandos"))

1638

962

# Is this a D-Bus signal?

1639

963

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

1640

# Extract the original non-method undecorated

1641

# function by black magic

1642

if sys.version_info.major == 2:

1643

nonmethod_func = (dict(

964

# Extract the original non-method function by

965

# black magic

966

nonmethod_func = (dict(

1644

967

zip(attribute.func_code.co_freevars,

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)

968

attribute.__closure__))["func"]

969

.cell_contents)

1652

970

# Create a new, but exactly alike, function

1653

971

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

1654

972

# with the alternate D-Bus interface name

1655

new_function = copy_function(nonmethod_func)

1656

new_function = (dbus.service.signal(

1657

alt_interface,

1658

attribute._dbus_signature)(new_function))

1659

# Copy annotations, if any

1660

try:

1661

new_function._dbus_annotations = dict(

1662

attribute._dbus_annotations)

1663

except AttributeError:

1664

pass

1665

973

new_function = (dbus.service.signal

974

(alt_interface,

975

attribute._dbus_signature)

976

(types.FunctionType(

977

nonmethod_func.func_code,

978

nonmethod_func.func_globals,

979

nonmethod_func.func_name,

980

nonmethod_func.func_defaults,

981

nonmethod_func.func_closure)))

1666

982

# Define a creator of a function to call both the

1667

# original and alternate functions, so both the

1668

# original and alternate signals gets sent when

1669

# the function is called

983

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

984

# signals gets sent when the function is called

1670

985

def fixscope(func1, func2):

1671

986

"""This function is a scope container to pass

1672

987

func1 and func2 to the "call_both" function

1673

988

outside of its arguments"""

1674

1675

@functools.wraps(func2)

1676

989

def call_both(*args, **kwargs):

1677

990

"""This function will emit two D-Bus

1678

991

signals by calling func1 and func2"""

1679

992

func1(*args, **kwargs)

1680

993

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

1687

994

return call_both

1688

995

# Create the "call_both" function and add it to

1689

996

# the class

1690

attr[attrname] = fixscope(attribute, new_function)

997

attr[attrname] = fixscope(attribute,

998

new_function)

1691

999

# Is this a D-Bus method?

1692

1000

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

1693

1001

# Create a new, but exactly alike, function

1694

1002

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

1695

1003

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

1696

1004

# to the class.

1697

attr[attrname] = (

1698

dbus.service.method(

1699

alt_interface,

1700

attribute._dbus_in_signature,

1701

attribute._dbus_out_signature)

1702

(copy_function(attribute)))

1703

# Copy annotations, if any

1704

try:

1705

attr[attrname]._dbus_annotations = dict(

1706

attribute._dbus_annotations)

1707

except AttributeError:

1708

pass

1005

attr[attrname] = (dbus.service.method

1006

(alt_interface,

1007

attribute._dbus_in_signature,

1008

attribute._dbus_out_signature)

1009

(types.FunctionType

1010

(attribute.func_code,

1011

attribute.func_globals,

1012

attribute.func_name,

1013

attribute.func_defaults,

1014

attribute.func_closure)))

1709

1015

# Is this a D-Bus property?

1710

1016

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

1711

1017

# Create a new, but exactly alike, function

1712

1018

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

1713

1019

# property with the alternate D-Bus interface

1714

1020

# name. Add it to the class.

1715

attr[attrname] = (dbus_service_property(

1716

alt_interface, attribute._dbus_signature,

1717

attribute._dbus_access,

1718

attribute._dbus_get_args_options

1719

["byte_arrays"])

1720

(copy_function(attribute)))

1721

# Copy annotations, if any

1722

try:

1723

attr[attrname]._dbus_annotations = dict(

1724

attribute._dbus_annotations)

1725

except AttributeError:

1726

pass

1727

# Is this a D-Bus interface?

1728

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

1729

# Create a new, but exactly alike, function

1730

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

1731

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

1732

# to the class.

1733

attr[attrname] = (

1734

dbus_interface_annotations(alt_interface)

1735

(copy_function(attribute)))

1736

if deprecate:

1737

# Deprecate all alternate interfaces

1738

iname = "_AlternateDBusNames_interface_annotation{}"

1739

for interface_name in interface_names:

1740

1741

@dbus_interface_annotations(interface_name)

1742

def func(self):

1743

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

1744

"true"}

1745

# Find an unused name

1746

for aname in (iname.format(i)

1747

for i in itertools.count()):

1748

if aname not in attr:

1749

attr[aname] = func

1750

break

1751

if interface_names:

1752

# Replace the class with a new subclass of it with

1753

# methods, signals, etc. as created above.

1754

if sys.version_info.major == 2:

1755

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

1756

(cls, ), attr)

1757

else:

1758

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

1759

(cls, ), attr)

1760

return cls

1761

1762

return wrapper

1763

1764

1765

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

1766

"se.bsnet.fukt.Mandos"})

1021

attr[attrname] = (dbus_service_property

1022

(alt_interface,

1023

attribute._dbus_signature,

1024

attribute._dbus_access,

1025

attribute

1026

._dbus_get_args_options

1027

["byte_arrays"])

1028

(types.FunctionType

1029

(attribute.func_code,

1030

attribute.func_globals,

1031

attribute.func_name,

1032

attribute.func_defaults,

1033

attribute.func_closure)))

1034

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

1035

1036

1767

1037

class ClientDBus(Client, DBusObjectWithProperties):

1768

1038

"""A Client class using D-Bus

1769

1039

1770

1040

Attributes:

1771

1041

dbus_object_path: dbus.ObjectPath

1772

1042

bus: dbus.SystemBus()

1773

1043

"""

1774

1044

1775

1045

runtime_expansions = (Client.runtime_expansions

1776

+ ("dbus_object_path", ))

1777

1778

_interface = "se.recompile.Mandos.Client"

1779

1046

+ ("dbus_object_path",))

1047

1780

1048

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

1781

1782

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

1049

1050

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

1783

1051

self.bus = bus

1784

1052

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

1785

1053

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

1786

1054

# the D-Bus

1787

client_object_name = str(self.name).translate(

1055

client_object_name = unicode(self.name).translate(

1788

1056

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

1789

1057

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

1790

self.dbus_object_path = dbus.ObjectPath(

1791

"/clients/" + client_object_name)

1058

self.dbus_object_path = (dbus.ObjectPath

1059

("/clients/" + client_object_name))

1792

1060

DBusObjectWithProperties.__init__(self, self.bus,

1793

1061

self.dbus_object_path)

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

1062

1063

def notifychangeproperty(transform_func,

1064

dbus_name, type_func=lambda x: x,

1065

variant_level=1):

1800

1066

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

1801

1067

its changes to DBus.

1802

1068

1803

1069

transform_fun: Function that takes a value and a variant_level

1804

1070

and transforms it to a D-Bus type.

1805

1071

dbus_name: D-Bus name of the variable

1807

1073

to the D-Bus. Default: no transform

1808

1074

variant_level: D-Bus variant level. Default: 1

1809

1075

"""

1810

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

1811

1076

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

1812

1077

def setter(self, value):

1813

1078

if hasattr(self, "dbus_object_path"):

1814

1079

if (not hasattr(self, attrname) or

1815

1080

type_func(getattr(self, attrname, None))

1816

1081

!= type_func(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())

1082

dbus_value = transform_func(type_func(value),

1083

variant_level

1084

=variant_level)

1085

self.PropertyChanged(dbus.String(dbus_name),

1086

dbus_value)

1832

1087

setattr(self, attrname, value)

1833

1088

1834

1089

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

1835

1090

1091

1836

1092

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1837

1093

approvals_pending = notifychangeproperty(dbus.Boolean,

1838

1094

"ApprovalPending",

1839

type_func=bool)

1095

type_func = bool)

1840

1096

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

1841

1097

last_enabled = notifychangeproperty(datetime_to_dbus,

1842

1098

"LastEnabled")

1843

checker = notifychangeproperty(

1844

dbus.Boolean, "CheckerRunning",

1845

type_func=lambda checker: checker is not None)

1099

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

1100

type_func = lambda checker:

1101

checker is not None)

1846

1102

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1847

1103

"LastCheckedOK")

1848

1104

last_checker_status = notifychangeproperty(dbus.Int16,

1851

1107

datetime_to_dbus, "LastApprovalRequest")

1852

1108

approved_by_default = notifychangeproperty(dbus.Boolean,

1853

1109

"ApprovedByDefault")

1854

approval_delay = notifychangeproperty(

1855

dbus.UInt64, "ApprovalDelay",

1856

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

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1857

1114

approval_duration = notifychangeproperty(

1858

1115

dbus.UInt64, "ApprovalDuration",

1859

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

1116

type_func = timedelta_to_milliseconds)

1860

1117

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

1861

timeout = notifychangeproperty(

1862

dbus.UInt64, "Timeout",

1863

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1864

1121

extended_timeout = notifychangeproperty(

1865

1122

dbus.UInt64, "ExtendedTimeout",

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)

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

timedelta_to_milliseconds)

1870

1128

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

1871

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

1872

invalidate_only=True)

1873

1129

1874

1130

del notifychangeproperty

1875

1131

1876

1132

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

1877

1133

try:

1878

1134

self.remove_from_connection()

1881

1137

if hasattr(DBusObjectWithProperties, "__del__"):

1882

1138

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

1883

1139

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

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:

1140

1141

def checker_callback(self, pid, condition, command,

1142

*args, **kwargs):

1143

self.checker_callback_tag = None

1144

self.checker = None

1145

if os.WIFEXITED(condition):

1146

exitstatus = os.WEXITSTATUS(condition)

1892

1147

# Emit D-Bus signal

1893

1148

self.CheckerCompleted(dbus.Int16(exitstatus),

1894

# This is specific to GNU libC

1895

dbus.Int64(exitstatus << 8),

1149

dbus.Int64(condition),

1896

1150

dbus.String(command))

1897

1151

else:

1898

1152

# Emit D-Bus signal

1899

1153

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

1900

dbus.Int64(

1901

# This is specific to GNU libC

1902

(exitstatus << 8)

1903

| self.last_checker_signal),

1154

dbus.Int64(condition),

1904

1155

dbus.String(command))

1905

return ret

1906

1156

1157

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

1158

*args, **kwargs)

1159

1907

1160

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

1908

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

1161

old_checker = self.checker

1162

if self.checker is not None:

1163

old_checker_pid = self.checker.pid

1164

else:

1165

old_checker_pid = None

1909

1166

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

1910

1167

# Only if new checker process was started

1911

1168

if (self.checker is not None

1913

1170

# Emit D-Bus signal

1914

1171

self.CheckerStarted(self.current_checker_command)

1915

1172

return r

1916

1173

1917

1174

def _reset_approved(self):

1918

1175

self.approved = None

1919

1176

return False

1920

1177

1921

1178

def approve(self, value=True):

1179

self.send_changedstate()

1922

1180

self.approved = value

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

1181

gobject.timeout_add(timedelta_to_milliseconds

1182

(self.approval_duration),

1183

self._reset_approved)

1184

1185

1186

## D-Bus methods, signals & properties

1187

_interface = "se.recompile.Mandos.Client"

1188

1189

## Signals

1190

1933

1191

# CheckerCompleted - signal

1934

1192

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

1935

1193

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

1936

1194

"D-Bus signal"

1937

1195

pass

1938

1196

1939

1197

# CheckerStarted - signal

1940

1198

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

1941

1199

def CheckerStarted(self, command):

1942

1200

"D-Bus signal"

1943

1201

pass

1944

1202

1945

1203

# PropertyChanged - signal

1946

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

1947

1204

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

1948

1205

def PropertyChanged(self, property, value):

1949

1206

"D-Bus signal"

1950

1207

pass

1951

1208

1952

1209

# GotSecret - signal

1953

1210

@dbus.service.signal(_interface)

1954

1211

def GotSecret(self):

1957

1214

server to mandos-client

1958

1215

"""

1959

1216

pass

1960

1217

1961

1218

# Rejected - signal

1962

1219

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

1963

1220

def Rejected(self, reason):

1964

1221

"D-Bus signal"

1965

1222

pass

1966

1223

1967

1224

# NeedApproval - signal

1968

1225

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

1969

1226

def NeedApproval(self, timeout, default):

1970

1227

"D-Bus signal"

1971

1228

return self.need_approval()

1972

1973

# Methods

1974

1229

1230

## Methods

1231

1975

1232

# Approve - method

1976

1233

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

1977

1234

def Approve(self, value):

1978

1235

self.approve(value)

1979

1236

1980

1237

# CheckedOK - method

1981

1238

@dbus.service.method(_interface)

1982

1239

def CheckedOK(self):

1983

1240

self.checked_ok()

1984

1241

1985

1242

# Enable - method

1986

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

1987

1243

@dbus.service.method(_interface)

1988

1244

def Enable(self):

1989

1245

"D-Bus method"

1990

1246

self.enable()

1991

1247

1992

1248

# StartChecker - method

1993

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

1994

1249

@dbus.service.method(_interface)

1995

1250

def StartChecker(self):

1996

1251

"D-Bus method"

1997

1252

self.start_checker()

1998

1253

1999

1254

# Disable - method

2000

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

2001

1255

@dbus.service.method(_interface)

2002

1256

def Disable(self):

2003

1257

"D-Bus method"

2004

1258

self.disable()

2005

1259

2006

1260

# StopChecker - method

2007

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

2008

1261

@dbus.service.method(_interface)

2009

1262

def StopChecker(self):

2010

1263

self.stop_checker()

2011

2012

# Properties

2013

1264

1265

## Properties

1266

2014

1267

# ApprovalPending - property

2015

1268

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

2016

1269

def ApprovalPending_dbus_property(self):

2017

1270

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

2018

1271

2019

1272

# ApprovedByDefault - property

2020

@dbus_service_property(_interface,

2021

signature="b",

1273

@dbus_service_property(_interface, signature="b",

2022

1274

access="readwrite")

2023

1275

def ApprovedByDefault_dbus_property(self, value=None):

2024

1276

if value is None: # get

2025

1277

return dbus.Boolean(self.approved_by_default)

2026

1278

self.approved_by_default = bool(value)

2027

1279

2028

1280

# ApprovalDelay - property

2029

@dbus_service_property(_interface,

2030

signature="t",

1281

@dbus_service_property(_interface, signature="t",

2031

1282

access="readwrite")

2032

1283

def ApprovalDelay_dbus_property(self, value=None):

2033

1284

if value is None: # get

2034

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

2035

* 1000)

1285

return dbus.UInt64(self.approval_delay_milliseconds())

2036

1286

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

2037

1287

2038

1288

# ApprovalDuration - property

2039

@dbus_service_property(_interface,

2040

signature="t",

1289

@dbus_service_property(_interface, signature="t",

2041

1290

access="readwrite")

2042

1291

def ApprovalDuration_dbus_property(self, value=None):

2043

1292

if value is None: # get

2044

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

2045

* 1000)

1293

return dbus.UInt64(timedelta_to_milliseconds(

1294

self.approval_duration))

2046

1295

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

2047

1296

2048

1297

# Name - property

2049

@dbus_annotations(

2050

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

2051

1298

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

2052

1299

def Name_dbus_property(self):

2053

1300

return dbus.String(self.name)

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

1301

2062

1302

# Fingerprint - property

2063

@dbus_annotations(

2064

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

2065

1303

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

2066

1304

def Fingerprint_dbus_property(self):

2067

1305

return dbus.String(self.fingerprint)

2068

1306

2069

1307

# Host - property

2070

@dbus_service_property(_interface,

2071

signature="s",

1308

@dbus_service_property(_interface, signature="s",

2072

1309

access="readwrite")

2073

1310

def Host_dbus_property(self, value=None):

2074

1311

if value is None: # get

2075

1312

return dbus.String(self.host)

2076

self.host = str(value)

2077

1313

self.host = unicode(value)

1314

2078

1315

# Created - property

2079

@dbus_annotations(

2080

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

2081

1316

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

2082

1317

def Created_dbus_property(self):

2083

1318

return datetime_to_dbus(self.created)

2084

1319

2085

1320

# LastEnabled - property

2086

1321

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

2087

1322

def LastEnabled_dbus_property(self):

2088

1323

return datetime_to_dbus(self.last_enabled)

2089

1324

2090

1325

# Enabled - property

2091

@dbus_service_property(_interface,

2092

signature="b",

1326

@dbus_service_property(_interface, signature="b",

2093

1327

access="readwrite")

2094

1328

def Enabled_dbus_property(self, value=None):

2095

1329

if value is None: # get

2098

1332

self.enable()

2099

1333

else:

2100

1334

self.disable()

2101

1335

2102

1336

# LastCheckedOK - property

2103

@dbus_service_property(_interface,

2104

signature="s",

1337

@dbus_service_property(_interface, signature="s",

2105

1338

access="readwrite")

2106

1339

def LastCheckedOK_dbus_property(self, value=None):

2107

1340

if value is not None:

2108

1341

self.checked_ok()

2109

1342

return

2110

1343

return datetime_to_dbus(self.last_checked_ok)

2111

1344

2112

1345

# LastCheckerStatus - property

2113

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

1346

@dbus_service_property(_interface, signature="n",

1347

access="read")

2114

1348

def LastCheckerStatus_dbus_property(self):

2115

1349

return dbus.Int16(self.last_checker_status)

2116

1350

2117

1351

# Expires - property

2118

1352

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

2119

1353

def Expires_dbus_property(self):

2120

1354

return datetime_to_dbus(self.expires)

2121

1355

2122

1356

# LastApprovalRequest - property

2123

1357

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

2124

1358

def LastApprovalRequest_dbus_property(self):

2125

1359

return datetime_to_dbus(self.last_approval_request)

2126

1360

2127

1361

# Timeout - property

2128

@dbus_service_property(_interface,

2129

signature="t",

1362

@dbus_service_property(_interface, signature="t",

2130

1363

access="readwrite")

2131

1364

def Timeout_dbus_property(self, value=None):

2132

1365

if value is None: # get

2133

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

2134

old_timeout = self.timeout

1366

return dbus.UInt64(self.timeout_milliseconds())

2135

1367

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

2136

# Reschedule disabling

1368

# Reschedule timeout

2137

1369

if self.enabled:

2138

1370

now = datetime.datetime.utcnow()

2139

self.expires += self.timeout - old_timeout

2140

if self.expires <= now:

1371

time_to_die = timedelta_to_milliseconds(

1372

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

1373

if time_to_die <= 0:

2141

1374

# The timeout has passed

2142

1375

self.disable()

2143

1376

else:

1377

self.expires = (now +

1378

datetime.timedelta(milliseconds =

1379

time_to_die))

2144

1380

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

2145

1381

is None):

2146

1382

return

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

1383

gobject.source_remove(self.disable_initiator_tag)

1384

self.disable_initiator_tag = (gobject.timeout_add

1385

(time_to_die,

1386

self.disable))

1387

2152

1388

# ExtendedTimeout - property

2153

@dbus_service_property(_interface,

2154

signature="t",

1389

@dbus_service_property(_interface, signature="t",

2155

1390

access="readwrite")

2156

1391

def ExtendedTimeout_dbus_property(self, value=None):

2157

1392

if value is None: # get

2158

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

2159

* 1000)

1393

return dbus.UInt64(self.extended_timeout_milliseconds())

2160

1394

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

2161

1395

2162

1396

# Interval - property

2163

@dbus_service_property(_interface,

2164

signature="t",

1397

@dbus_service_property(_interface, signature="t",

2165

1398

access="readwrite")

2166

1399

def Interval_dbus_property(self, value=None):

2167

1400

if value is None: # get

2168

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

1401

return dbus.UInt64(self.interval_milliseconds())

2169

1402

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

2170

1403

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

2171

1404

return

2172

1405

if self.enabled:

2173

1406

# Reschedule checker run

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

1407

gobject.source_remove(self.checker_initiator_tag)

1408

self.checker_initiator_tag = (gobject.timeout_add

1409

(value, self.start_checker))

1410

self.start_checker() # Start one now, too

1411

2179

1412

# Checker - property

2180

@dbus_service_property(_interface,

2181

signature="s",

1413

@dbus_service_property(_interface, signature="s",

2182

1414

access="readwrite")

2183

1415

def Checker_dbus_property(self, value=None):

2184

1416

if value is None: # get

2185

1417

return dbus.String(self.checker_command)

2186

self.checker_command = str(value)

2187

1418

self.checker_command = unicode(value)

1419

2188

1420

# CheckerRunning - property

2189

@dbus_service_property(_interface,

2190

signature="b",

1421

@dbus_service_property(_interface, signature="b",

2191

1422

access="readwrite")

2192

1423

def CheckerRunning_dbus_property(self, value=None):

2193

1424

if value is None: # get

2196

1427

self.start_checker()

2197

1428

else:

2198

1429

self.stop_checker()

2199

1430

2200

1431

# ObjectPath - property

2201

@dbus_annotations(

2202

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

2203

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

2204

1432

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

2205

1433

def ObjectPath_dbus_property(self):

2206

return self.dbus_object_path # is already a dbus.ObjectPath

2207

1434

return self.dbus_object_path # is already a dbus.ObjectPath

1435

2208

1436

# Secret = property

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)

1437

@dbus_service_property(_interface, signature="ay",

1438

access="write", byte_arrays=True)

2216

1439

def Secret_dbus_property(self, value):

2217

self.secret = bytes(value)

2218

1440

self.secret = str(value)

1441

2219

1442

del _interface

2220

1443

2221

1444

2222

1445

class ProxyClient(object):

2223

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

1446

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

2224

1447

self._pipe = child_pipe

2225

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

1448

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

2226

1449

if not self._pipe.recv():

2227

raise KeyError(key_id or fpr)

2228

1450

raise KeyError()

1451

2229

1452

def __getattribute__(self, name):

2230

1453

if name == '_pipe':

2231

1454

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

2234

1457

if data[0] == 'data':

2235

1458

return data[1]

2236

1459

if data[0] == 'function':

2237

2238

1460

def func(*args, **kwargs):

2239

1461

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

2240

1462

return self._pipe.recv()[1]

2241

2242

1463

return func

2243

1464

2244

1465

def __setattr__(self, name, value):

2245

1466

if name == '_pipe':

2246

1467

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

2247

1468

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

2248

1469

2249

1470

1471

class ClientDBusTransitional(ClientDBus):

1472

__metaclass__ = AlternateDBusNamesMetaclass

1473

1474

2250

1475

class ClientHandler(socketserver.BaseRequestHandler, object):

2251

1476

"""A class to handle client connections.

2252

1477

2253

1478

Instantiated once for each connection to handle it.

2254

1479

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

2255

1480

2256

1481

def handle(self):

2257

1482

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

2258

1483

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

2259

str(self.client_address))

1484

unicode(self.client_address))

2260

1485

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

2261

1486

self.server.child_pipe.fileno())

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

1487

1488

session = (gnutls.connection

1489

.ClientSession(self.request,

1490

gnutls.connection

1491

.X509Credentials()))

1492

1493

# Note: gnutls.connection.X509Credentials is really a

1494

# generic GnuTLS certificate credentials object so long as

1495

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

1496

# here despite using OpenPGP certificates.

1497

1498

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

1499

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

1500

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

1501

# "+DHE-DSS"))

2269

1502

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

2270

1503

priority = self.server.gnutls_priority

2271

1504

if priority is None:

2272

1505

priority = "NORMAL"

2273

gnutls.priority_set_direct(session._c_object,

2274

priority.encode("utf-8"),

2275

None)

2276

1506

(gnutls.library.functions

1507

.gnutls_priority_set_direct(session._c_object,

1508

priority, None))

1509

2277

1510

# Start communication using the Mandos protocol

2278

1511

# Get protocol number

2279

1512

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

2280

1513

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

2281

1514

try:

2282

1515

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

2283

raise RuntimeError(line)

1516

raise RuntimeError

2284

1517

except (ValueError, IndexError, RuntimeError) as error:

2285

1518

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

2286

1519

return

2287

1520

2288

1521

# Start GnuTLS connection

2289

1522

try:

2290

1523

session.handshake()

2291

except gnutls.Error as error:

1524

except gnutls.errors.GNUTLSError as error:

2292

1525

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

2293

1526

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

2294

1527

# established. Just abandon the request.

2295

1528

return

2296

1529

logger.debug("Handshake succeeded")

2297

1530

2298

1531

approval_required = False

2299

1532

try:

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,

1533

try:

1534

fpr = self.fingerprint(self.peer_certificate

1535

(session))

1536

except (TypeError,

1537

gnutls.errors.GNUTLSError) as error:

1538

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

1539

return

1540

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

1541

1542

try:

1543

client = ProxyClient(child_pipe, fpr,

2322

1544

self.client_address)

2323

1545

except KeyError:

2324

1546

return

2325

1547

2326

1548

if client.approval_delay:

2327

1549

delay = client.approval_delay

2328

1550

client.approvals_pending += 1

2329

1551

approval_required = True

2330

1552

2331

1553

while True:

2332

1554

if not client.enabled:

2333

1555

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

2334

client.name)

1556

client.name)

2335

1557

if self.server.use_dbus:

2336

1558

# Emit D-Bus signal

2337

1559

client.Rejected("Disabled")

2338

1560

return

2339

1561

2340

1562

if client.approved or not client.approval_delay:

2341

# We are approved or approval is disabled

1563

#We are approved or approval is disabled

2342

1564

break

2343

1565

elif client.approved is None:

2344

1566

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

2346

1568

if self.server.use_dbus:

2347

1569

# Emit D-Bus signal

2348

1570

client.NeedApproval(

2349

client.approval_delay.total_seconds()

2350

* 1000, client.approved_by_default)

1571

client.approval_delay_milliseconds(),

1572

client.approved_by_default)

2351

1573

else:

2352

1574

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

2353

1575

client.name)

2355

1577

# Emit D-Bus signal

2356

1578

client.Rejected("Denied")

2357

1579

return

2358

2359

# wait until timeout or approved

1580

1581

#wait until timeout or approved

2360

1582

time = datetime.datetime.now()

2361

1583

client.changedstate.acquire()

2362

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

1584

(client.changedstate.wait

1585

(float(client.timedelta_to_milliseconds(delay)

1586

/ 1000)))

2363

1587

client.changedstate.release()

2364

1588

time2 = datetime.datetime.now()

2365

1589

if (time2 - time) >= delay:

2375

1599

break

2376

1600

else:

2377

1601

delay -= time2 - time

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

1602

1603

sent_size = 0

1604

while sent_size < len(client.secret):

1605

try:

1606

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

1607

except gnutls.errors.GNUTLSError as error:

1608

logger.warning("gnutls send failed")

1609

return

1610

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

1611

sent, len(client.secret)

1612

- (sent_size + sent))

1613

sent_size += sent

1614

2386

1615

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

2387

1616

# bump the timeout using extended_timeout

2388

1617

client.bump_timeout(client.extended_timeout)

2389

1618

if self.server.use_dbus:

2390

1619

# Emit D-Bus signal

2391

1620

client.GotSecret()

2392

1621

2393

1622

finally:

2394

1623

if approval_required:

2395

1624

client.approvals_pending -= 1

2396

1625

try:

2397

1626

session.bye()

2398

except gnutls.Error as error:

2399

logger.warning("GnuTLS bye failed",

2400

exc_info=error)

2401

1627

except gnutls.errors.GNUTLSError as error:

1628

logger.warning("GnuTLS bye failed")

1629

2402

1630

@staticmethod

2403

1631

def peer_certificate(session):

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

1632

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

1633

# If not an OpenPGP certificate...

1634

if (gnutls.library.functions

1635

.gnutls_certificate_type_get(session._c_object)

1636

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1637

# ...do the normal thing

1638

return session.peer_certificate

2420

1639

list_size = ctypes.c_uint(1)

2421

cert_list = (gnutls.certificate_get_peers

1640

cert_list = (gnutls.library.functions

1641

.gnutls_certificate_get_peers

2422

1642

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

2423

1643

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

2424

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

1644

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

1645

" certificate")

2425

1646

if list_size.value == 0:

2426

1647

return None

2427

1648

cert = cert_list[0]

2428

1649

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

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

1650

2464

1651

@staticmethod

2465

1652

def fingerprint(openpgp):

2466

1653

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2467

1654

# New GnuTLS "datum" with the OpenPGP public key

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

1655

datum = (gnutls.library.types

1656

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

1657

ctypes.POINTER

1658

(ctypes.c_ubyte)),

1659

ctypes.c_uint(len(openpgp))))

2472

1660

# New empty GnuTLS certificate

2473

crt = gnutls.openpgp_crt_t()

2474

gnutls.openpgp_crt_init(ctypes.byref(crt))

1661

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2475

1664

# Import the OpenPGP public key into the certificate

2476

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

2477

gnutls.OPENPGP_FMT_RAW)

1665

(gnutls.library.functions

1666

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

1667

gnutls.library.constants

1668

.GNUTLS_OPENPGP_FMT_RAW))

2478

1669

# Verify the self signature in the key

2479

1670

crtverify = ctypes.c_uint()

2480

gnutls.openpgp_crt_verify_self(crt, 0,

2481

ctypes.byref(crtverify))

1671

(gnutls.library.functions

1672

.gnutls_openpgp_crt_verify_self(crt, 0,

1673

ctypes.byref(crtverify)))

2482

1674

if crtverify.value != 0:

2483

gnutls.openpgp_crt_deinit(crt)

2484

raise gnutls.CertificateSecurityError(code

2485

=crtverify.value)

1675

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1676

raise (gnutls.errors.CertificateSecurityError

1677

("Verify failed"))

2486

1678

# New buffer for the fingerprint

2487

1679

buf = ctypes.create_string_buffer(20)

2488

1680

buf_len = ctypes.c_size_t()

2489

1681

# Get the fingerprint from the certificate into the buffer

2490

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

2491

ctypes.byref(buf_len))

1682

(gnutls.library.functions

1683

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

1684

ctypes.byref(buf_len)))

2492

1685

# Deinit the certificate

2493

gnutls.openpgp_crt_deinit(crt)

1686

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2494

1687

# Convert the buffer to a Python bytestring

2495

1688

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

2496

1689

# Convert the bytestring to hexadecimal notation

2500

1693

2501

1694

class MultiprocessingMixIn(object):

2502

1695

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

2503

2504

1696

def sub_process_main(self, request, address):

2505

1697

try:

2506

1698

self.finish_request(request, address)

2507

1699

except Exception:

2508

1700

self.handle_error(request, address)

2509

1701

self.close_request(request)

2510

1702

2511

1703

def process_request(self, request, address):

2512

1704

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

2513

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

2514

args=(request, address))

1705

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

1706

args = (request,

1707

address))

2515

1708

proc.start()

2516

1709

return proc

2517

1710

2518

1711

2519

1712

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2520

1713

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

2521

2522

1714

def process_request(self, request, client_address):

2523

1715

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

2524

1716

2525

1717

This function creates a new pipe in self.pipe

2526

1718

"""

2527

1719

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2528

1720

2529

1721

proc = MultiprocessingMixIn.process_request(self, request,

2530

1722

client_address)

2531

1723

self.child_pipe.close()

2532

1724

self.add_pipe(parent_pipe, proc)

2533

1725

2534

1726

def add_pipe(self, parent_pipe, proc):

2535

1727

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

2536

raise NotImplementedError()

1728

raise NotImplementedError

2537

1729

2538

1730

2539

1731

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2540

1732

socketserver.TCPServer, object):

2541

1733

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

2542

1734

2543

1735

Attributes:

2544

1736

enabled: Boolean; whether this server is activated yet

2545

1737

interface: None or a network interface name (string)

2546

1738

use_ipv6: Boolean; to use IPv6 or not

2547

1739

"""

2548

2549

1740

def __init__(self, server_address, RequestHandlerClass,

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

"""

1741

interface=None, use_ipv6=True):

2556

1742

self.interface = interface

2557

1743

if use_ipv6:

2558

1744

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.

2586

1745

socketserver.TCPServer.__init__(self, server_address,

2587

1746

RequestHandlerClass)

2588

2589

1747

def server_bind(self):

2590

1748

"""This overrides the normal server_bind() function

2591

1749

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

2592

1750

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

2593

global SO_BINDTODEVICE

2594

1751

if self.interface is not None:

2595

1752

if SO_BINDTODEVICE is None:

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

1753

logger.error("SO_BINDTODEVICE does not exist;"

1754

" cannot bind to interface %s",

1755

self.interface)

1756

else:

1757

try:

1758

self.socket.setsockopt(socket.SOL_SOCKET,

1759

SO_BINDTODEVICE,

1760

str(self.interface

1761

+ '\0'))

1762

except socket.error as error:

1763

if error[0] == errno.EPERM:

1764

logger.error("No permission to"

1765

" bind to interface %s",

1766

self.interface)

1767

elif error[0] == errno.ENOPROTOOPT:

1768

logger.error("SO_BINDTODEVICE not available;"

1769

" cannot bind to interface %s",

1770

self.interface)

1771

else:

1772

raise

2617

1773

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

2618

1774

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

2619

1775

if not self.server_address[0]:

2620

1776

if self.address_family == socket.AF_INET6:

2621

any_address = "::" # in6addr_any

1777

any_address = "::" # in6addr_any

2622

1778

else:

2623

any_address = "0.0.0.0" # INADDR_ANY

1779

any_address = socket.INADDR_ANY

2624

1780

self.server_address = (any_address,

2625

1781

self.server_address[1])

2626

1782

elif not self.server_address[1]:

2627

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

1783

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

1784

0)

2628

1785

# if self.interface:

2629

1786

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

2630

1787

# 0, # port

2636

1793

2637

1794

class MandosServer(IPv6_TCPServer):

2638

1795

"""Mandos server.

2639

1796

2640

1797

Attributes:

2641

1798

clients: set of Client objects

2642

1799

gnutls_priority GnuTLS priority string

2643

1800

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

2644

2645

Assumes a GLib.MainLoop event loop.

1801

1802

Assumes a gobject.MainLoop event loop.

2646

1803

"""

2647

2648

1804

def __init__(self, server_address, RequestHandlerClass,

2649

interface=None,

2650

use_ipv6=True,

2651

clients=None,

2652

gnutls_priority=None,

2653

use_dbus=True,

2654

socketfd=None):

1805

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

1806

gnutls_priority=None, use_dbus=True):

2655

1807

self.enabled = False

2656

1808

self.clients = clients

2657

1809

if self.clients is None:

2660

1812

self.gnutls_priority = gnutls_priority

2661

1813

IPv6_TCPServer.__init__(self, server_address,

2662

1814

RequestHandlerClass,

2663

interface=interface,

2664

use_ipv6=use_ipv6,

2665

socketfd=socketfd)

2666

1815

interface = interface,

1816

use_ipv6 = use_ipv6)

2667

1817

def server_activate(self):

2668

1818

if self.enabled:

2669

1819

return socketserver.TCPServer.server_activate(self)

2670

1820

2671

1821

def enable(self):

2672

1822

self.enabled = True

2673

1823

2674

1824

def add_pipe(self, parent_pipe, proc):

2675

1825

# Call "handle_ipc" for both data and EOF events

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

1826

gobject.io_add_watch(parent_pipe.fileno(),

1827

gobject.IO_IN | gobject.IO_HUP,

1828

functools.partial(self.handle_ipc,

1829

parent_pipe =

1830

parent_pipe,

1831

proc = proc))

1832

1833

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

1834

proc = None, client_object=None):

1835

condition_names = {

1836

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

1837

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

1838

# blocking).

1839

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

1840

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

1841

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

1842

# broken, usually for pipes and

1843

# sockets).

1844

}

1845

conditions_string = ' | '.join(name

1846

for cond, name in

1847

condition_names.iteritems()

1848

if cond & condition)

2687

1849

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

2688

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

1850

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

2689

1851

# Wait for other process to exit

2690

1852

proc.join()

2691

1853

return False

2692

1854

2693

1855

# Read a request from the child

2694

1856

request = parent_pipe.recv()

2695

1857

command = request[0]

2696

1858

2697

1859

if command == 'init':

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 and c.key_id == key_id:

2704

client = c

2705

break

2706

if fpr and c.fingerprint == fpr:

1860

fpr = request[1]

1861

address = request[2]

1862

1863

for c in self.clients.itervalues():

1864

if c.fingerprint == fpr:

2707

1865

client = c

2708

1866

break

2709

1867

else:

2710

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

2711

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

1868

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

1869

"dress: %s", fpr, address)

2712

1870

if self.use_dbus:

2713

1871

# Emit D-Bus signal

2714

mandos_dbus_service.ClientNotFound(key_id or fpr,

1872

mandos_dbus_service.ClientNotFound(fpr,

2715

1873

address[0])

2716

1874

parent_pipe.send(False)

2717

1875

return False

2718

2719

GLib.io_add_watch(

2720

parent_pipe.fileno(),

2721

GLib.IO_IN | GLib.IO_HUP,

2722

functools.partial(self.handle_ipc,

2723

parent_pipe=parent_pipe,

2724

proc=proc,

2725

client_object=client))

1876

1877

gobject.io_add_watch(parent_pipe.fileno(),

1878

gobject.IO_IN | gobject.IO_HUP,

1879

functools.partial(self.handle_ipc,

1880

parent_pipe =

1881

parent_pipe,

1882

proc = proc,

1883

client_object =

1884

client))

2726

1885

parent_pipe.send(True)

2727

1886

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

2728

1887

# same fileno

2731

1890

funcname = request[1]

2732

1891

args = request[2]

2733

1892

kwargs = request[3]

2734

1893

2735

1894

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

2736

1895

funcname)(*args,

2737

**kwargs)))

2738

1896

**kwargs)))

1897

2739

1898

if command == 'getattr':

2740

1899

attrname = request[1]

2741

if isinstance(client_object.__getattribute__(attrname),

2742

collections.Callable):

2743

parent_pipe.send(('function', ))

1900

if callable(client_object.__getattribute__(attrname)):

1901

parent_pipe.send(('function',))

2744

1902

else:

2745

parent_pipe.send((

2746

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

2747

1903

parent_pipe.send(('data', client_object

1904

.__getattribute__(attrname)))

1905

2748

1906

if command == 'setattr':

2749

1907

attrname = request[1]

2750

1908

value = request[2]

2751

1909

setattr(client_object, attrname, value)

2752

1910

2753

1911

return True

2754

1912

2755

1913

2756

def rfc3339_duration_to_delta(duration):

2757

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

2758

2759

>>> rfc3339_duration_to_delta("P7D")

2760

datetime.timedelta(7)

2761

>>> rfc3339_duration_to_delta("PT60S")

2762

datetime.timedelta(0, 60)

2763

>>> rfc3339_duration_to_delta("PT60M")

2764

datetime.timedelta(0, 3600)

2765

>>> rfc3339_duration_to_delta("PT24H")

2766

datetime.timedelta(1)

2767

>>> rfc3339_duration_to_delta("P1W")

2768

datetime.timedelta(7)

2769

>>> rfc3339_duration_to_delta("PT5M30S")

2770

datetime.timedelta(0, 330)

2771

>>> rfc3339_duration_to_delta("P1DT3M20S")

2772

datetime.timedelta(1, 200)

2773

"""

2774

2775

# Parsing an RFC 3339 duration with regular expressions is not

2776

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

2777

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

2778

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

2779

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

2780

# avoid excessive use of external libraries.

2781

2782

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

2783

Token = collections.namedtuple("Token", (

2784

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

2785

# a "group" containing digits

2786

"value", # datetime.timedelta or None

2787

"followers")) # Tokens valid after this token

2788

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

2789

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

2790

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

2791

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

2792

datetime.timedelta(seconds=1),

2793

frozenset((token_end, )))

2794

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

2795

datetime.timedelta(minutes=1),

2796

frozenset((token_second, token_end)))

2797

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

2798

datetime.timedelta(hours=1),

2799

frozenset((token_minute, token_end)))

2800

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

2801

None,

2802

frozenset((token_hour, token_minute,

2803

token_second)))

2804

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

2805

datetime.timedelta(days=1),

2806

frozenset((token_time, token_end)))

2807

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

2808

datetime.timedelta(weeks=4),

2809

frozenset((token_day, token_end)))

2810

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

2811

datetime.timedelta(weeks=52),

2812

frozenset((token_month, token_end)))

2813

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

2814

datetime.timedelta(weeks=1),

2815

frozenset((token_end, )))

2816

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

2817

frozenset((token_year, token_month,

2818

token_day, token_time,

2819

token_week)))

2820

# Define starting values:

2821

# Value so far

2822

value = datetime.timedelta()

2823

found_token = None

2824

# Following valid tokens

2825

followers = frozenset((token_duration, ))

2826

# String left to parse

2827

s = duration

2828

# Loop until end token is found

2829

while found_token is not token_end:

2830

# Search for any currently valid tokens

2831

for token in followers:

2832

match = token.regexp.match(s)

2833

if match is not None:

2834

# Token found

2835

if token.value is not None:

2836

# Value found, parse digits

2837

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

2838

# Add to value so far

2839

value += factor * token.value

2840

# Strip token from string

2841

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

2842

# Go to found token

2843

found_token = token

2844

# Set valid next tokens

2845

followers = found_token.followers

2846

break

2847

else:

2848

# No currently valid tokens were found

2849

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

2850

.format(duration))

2851

# End token found

2852

return value

2853

2854

2855

1914

def string_to_delta(interval):

2856

1915

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

2857

1916

2858

1917

>>> string_to_delta('7d')

2859

1918

datetime.timedelta(7)

2860

1919

>>> string_to_delta('60s')

2868

1927

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

2869

1928

datetime.timedelta(0, 330)

2870

1929

"""

2871

2872

try:

2873

return rfc3339_duration_to_delta(interval)

2874

except ValueError:

2875

pass

2876

2877

1930

timevalue = datetime.timedelta(0)

2878

1931

for s in interval.split():

2879

1932

try:

2880

suffix = s[-1]

1933

suffix = unicode(s[-1])

2881

1934

value = int(s[:-1])

2882

1935

if suffix == "d":

2883

1936

delta = datetime.timedelta(value)

2890

1943

elif suffix == "w":

2891

1944

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

2892

1945

else:

2893

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

2894

except IndexError as e:

1946

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

1947

except (ValueError, IndexError) as e:

2895

1948

raise ValueError(*(e.args))

2896

1949

timevalue += delta

2897

1950

return timevalue

2898

1951

2899

1952

2900

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

1953

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

2901

1954

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

2902

1955

2903

1956

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

2904

1957

if os.fork():

2905

1958

sys.exit()

2910

1963

sys.exit()

2911

1964

if not noclose:

2912

1965

# Close all standard open file descriptors

2913

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

1966

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

2914

1967

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

2915

1968

raise OSError(errno.ENODEV,

2916

"{} not a character device"

2917

.format(os.devnull))

1969

"%s not a character device"

1970

% os.path.devnull)

2918

1971

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

2919

1972

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

2920

1973

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

2923

1976

2924

1977

2925

1978

def main():

2926

1979

2927

1980

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

2928

1981

# Parsing of options, both command line and config file

2929

1982

2930

1983

parser = argparse.ArgumentParser()

2931

1984

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

2932

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

1985

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

2933

1986

help="show version number and exit")

2934

1987

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

2935

1988

help="Bind to interface IF")

2941

1994

help="Run self-test")

2942

1995

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

2943

1996

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

2944

" to terminal", default=None)

1997

" to terminal")

2945

1998

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

2946

1999

help="Debug level for stdout output")

2947

2000

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

2954

2007

" files")

2955

2008

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

2956

2009

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

2957

" system bus interface", default=None)

2010

" system bus interface")

2958

2011

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

2959

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

2960

default=None)

2012

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

2961

2013

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

2962

2014

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

2963

" state", default=None)

2964

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

2965

help="Specify a file descriptor to a network"

2966

" socket to use instead of creating one")

2015

" state")

2967

2016

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

2968

2017

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

2969

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

2970

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

2971

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

2972

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

2973

default=None)

2974

2018

2975

2019

options = parser.parse_args()

2976

2020

2977

2021

if options.check:

2978

2022

import doctest

2979

fail_count, test_count = doctest.testmod()

2980

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

2981

2023

doctest.testmod()

2024

sys.exit()

2025

2982

2026

# Default values for config file for server-global settings

2983

if gnutls.has_rawpk:

2984

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

2985

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

2986

else:

2987

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

2988

":+SIGN-DSA-SHA256")

2989

server_defaults = {"interface": "",

2990

"address": "",

2991

"port": "",

2992

"debug": "False",

2993

"priority": priority,

2994

"servicename": "Mandos",

2995

"use_dbus": "True",

2996

"use_ipv6": "True",

2997

"debuglevel": "",

2998

"restore": "True",

2999

"socket": "",

3000

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

3001

"foreground": "False",

3002

"zeroconf": "True",

3003

}

3004

del priority

3005

2027

server_defaults = { "interface": "",

2028

"address": "",

2029

"port": "",

2030

"debug": "False",

2031

"priority":

2032

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

2033

"servicename": "Mandos",

2034

"use_dbus": "True",

2035

"use_ipv6": "True",

2036

"debuglevel": "",

2037

"restore": "True",

2038

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

2039

}

2040

3006

2041

# Parse config file for server-global settings

3007

2042

server_config = configparser.SafeConfigParser(server_defaults)

3008

2043

del server_defaults

3009

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

2044

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

2045

"mandos.conf"))

3010

2046

# Convert the SafeConfigParser object to a dict

3011

2047

server_settings = server_config.defaults()

3012

2048

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

3013

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

3014

"foreground", "zeroconf"):

2049

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

3015

2050

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

3016

2051

option)

3017

2052

if server_settings["port"]:

3018

2053

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

3019

2054

"port")

3020

if server_settings["socket"]:

3021

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

3022

"socket")

3023

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

3024

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

3025

# happen with a supplied network socket.

3026

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

3027

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

3028

["socket"])

3029

2055

del server_config

3030

2056

3031

2057

# Override the settings from the config file with command line

3032

2058

# options, if set.

3033

2059

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

3034

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

3035

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

3036

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

2060

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

2061

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

2062

"statedir"):

3037

2063

value = getattr(options, option)

3038

2064

if value is not None:

3039

2065

server_settings[option] = value

3040

2066

del options

3041

2067

# Force all strings to be unicode

3042

2068

for option in server_settings.keys():

3043

if isinstance(server_settings[option], bytes):

3044

server_settings[option] = (server_settings[option]

3045

.decode("utf-8"))

3046

# Force all boolean options to be boolean

3047

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

3048

"foreground", "zeroconf"):

3049

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

3050

# Debug implies foreground

3051

if server_settings["debug"]:

3052

server_settings["foreground"] = True

2069

if type(server_settings[option]) is str:

2070

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

3053

2071

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

3054

2072

3055

2073

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

3056

3057

if (not server_settings["zeroconf"]

3058

and not (server_settings["port"]

3059

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

3060

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

3061

2074

3062

2075

# For convenience

3063

2076

debug = server_settings["debug"]

3064

2077

debuglevel = server_settings["debuglevel"]

3066

2079

use_ipv6 = server_settings["use_ipv6"]

3067

2080

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

3068

2081

stored_state_file)

3069

foreground = server_settings["foreground"]

3070

zeroconf = server_settings["zeroconf"]

3071

2082

3072

2083

if debug:

3073

2084

initlogger(debug, logging.DEBUG)

3074

2085

else:

3077

2088

else:

3078

2089

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

3079

2090

initlogger(debug, level)

3080

2091

3081

2092

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

3082

syslogger.setFormatter(

3083

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

3084

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

3085

server_settings["servicename"])))

3086

2093

syslogger.setFormatter(logging.Formatter

2094

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

2095

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

2096

% server_settings["servicename"]))

2097

3087

2098

# Parse config file with clients

3088

2099

client_config = configparser.SafeConfigParser(Client

3089

2100

.client_defaults)

3090

2101

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

3091

2102

"clients.conf"))

3092

2103

3093

2104

global mandos_dbus_service

3094

2105

mandos_dbus_service = None

3095

3096

socketfd = None

3097

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

3098

socketfd = server_settings["socket"]

3099

tcp_server = MandosServer(

3100

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

3101

ClientHandler,

3102

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

3103

use_ipv6=use_ipv6,

3104

gnutls_priority=server_settings["priority"],

3105

use_dbus=use_dbus,

3106

socketfd=socketfd)

3107

if not foreground:

3108

pidfilename = "/run/mandos.pid"

3109

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

3110

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

3111

pidfile = None

3112

try:

3113

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

3114

except IOError as e:

3115

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

3116

exc_info=e)

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

3121

try:

3122

uid = pwd.getpwnam(name).pw_uid

3123

gid = pwd.getpwnam(group).pw_gid

3124

break

2106

2107

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

2108

server_settings["port"]),

2109

ClientHandler,

2110

interface=(server_settings["interface"]

2111

or None),

2112

use_ipv6=use_ipv6,

2113

gnutls_priority=

2114

server_settings["priority"],

2115

use_dbus=use_dbus)

2116

if not debug:

2117

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

2118

try:

2119

pidfile = open(pidfilename, "w")

2120

except IOError:

2121

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

2122

2123

try:

2124

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

2125

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

2126

except KeyError:

2127

try:

2128

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

2129

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

3125

2130

except KeyError:

3126

continue

3127

else:

3128

uid = 65534

3129

gid = 65534

2131

try:

2132

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

2133

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

2134

except KeyError:

2135

uid = 65534

2136

gid = 65534

3130

2137

try:

3131

2138

os.setgid(gid)

3132

2139

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

3136

2140

except OSError as error:

3137

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

3138

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

3139

if error.errno != errno.EPERM:

3140

raise

3141

2141

if error[0] != errno.EPERM:

2142

raise error

2143

3142

2144

if debug:

3143

2145

# Enable all possible GnuTLS debugging

3144

2146

3145

2147

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

3146

2148

# - GnuTLS manual

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2149

gnutls.library.functions.gnutls_global_set_log_level(11)

2150

2151

@gnutls.library.types.gnutls_log_func

3150

2152

def debug_gnutls(level, string):

3151

2153

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

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2154

2155

(gnutls.library.functions

2156

.gnutls_global_set_log_function(debug_gnutls))

2157

3155

2158

# Redirect stdin so all checkers get /dev/null

3156

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

2159

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

3157

2160

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

3158

2161

if null > 2:

3159

2162

os.close(null)

3160

2163

3161

2164

# Need to fork before connecting to D-Bus

3162

if not foreground:

2165

if not debug:

3163

2166

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

3164

2167

daemon()

3165

3166

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

3167

# to inform GLib that threads will be used.

3168

GLib.threads_init()

3169

2168

2169

gobject.threads_init()

2170

3170

2171

global main_loop

3171

2172

# From the Avahi example code

3172

DBusGMainLoop(set_as_default=True)

3173

main_loop = GLib.MainLoop()

2173

DBusGMainLoop(set_as_default=True )

2174

main_loop = gobject.MainLoop()

3174

2175

bus = dbus.SystemBus()

3175

2176

# End of Avahi example code

3176

2177

if use_dbus:

3177

2178

try:

3178

2179

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

3179

bus,

3180

do_not_queue=True)

3181

old_bus_name = dbus.service.BusName(

3182

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

3183

do_not_queue=True)

3184

except dbus.exceptions.DBusException as e:

3185

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

2180

bus, do_not_queue=True)

2181

old_bus_name = (dbus.service.BusName

2182

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

2183

do_not_queue=True))

2184

except dbus.exceptions.NameExistsException as e:

2185

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

3186

2186

use_dbus = False

3187

2187

server_settings["use_dbus"] = False

3188

2188

tcp_server.use_dbus = False

3189

if zeroconf:

3190

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3191

service = AvahiServiceToSyslog(

3192

name=server_settings["servicename"],

3193

servicetype="_mandos._tcp",

3194

protocol=protocol,

3195

bus=bus)

3196

if server_settings["interface"]:

3197

service.interface = if_nametoindex(

3198

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

3199

2189

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2190

service = AvahiServiceToSyslog(name =

2191

server_settings["servicename"],

2192

servicetype = "_mandos._tcp",

2193

protocol = protocol, bus = bus)

2194

if server_settings["interface"]:

2195

service.interface = (if_nametoindex

2196

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

2197

3200

2198

global multiprocessing_manager

3201

2199

multiprocessing_manager = multiprocessing.Manager()

3202

2200

3203

2201

client_class = Client

3204

2202

if use_dbus:

3205

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

3206

2203

client_class = functools.partial(ClientDBusTransitional,

2204

bus = bus)

2205

3207

2206

client_settings = Client.config_parser(client_config)

3208

2207

old_client_settings = {}

3209

2208

clients_data = {}

3210

3211

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

3212

global wnull

3213

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

3214

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

3215

# mode

3216

if debug or not foreground:

3217

wnull.close()

3218

2209

3219

2210

# Get client data and settings from last running state.

3220

2211

if server_settings["restore"]:

3221

2212

try:

3222

2213

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

3223

if sys.version_info.major == 2:

3224

clients_data, old_client_settings = pickle.load(

3225

stored_state)

3226

else:

3227

bytes_clients_data, bytes_old_client_settings = (

3228

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

3229

# Fix bytes to strings

3230

# clients_data

3231

# .keys()

3232

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

3233

if isinstance(key, bytes)

3234

else key): value

3235

for key, value in

3236

bytes_clients_data.items()}

3237

del bytes_clients_data

3238

for key in clients_data:

3239

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

3240

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

3241

for k, v in

3242

clients_data[key].items()}

3243

clients_data[key] = value

3244

# .client_structure

3245

value["client_structure"] = [

3246

(s.decode("utf-8")

3247

if isinstance(s, bytes)

3248

else s) for s in

3249

value["client_structure"]]

3250

# .name & .host

3251

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

3252

if isinstance(value[k], bytes):

3253

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

3254

if not value.has_key("key_id"):

3255

value["key_id"] = ""

3256

elif not value.has_key("fingerprint"):

3257

value["fingerprint"] = ""

3258

# old_client_settings

3259

# .keys()

3260

old_client_settings = {

3261

(key.decode("utf-8")

3262

if isinstance(key, bytes)

3263

else key): value

3264

for key, value in

3265

bytes_old_client_settings.items()}

3266

del bytes_old_client_settings

3267

# .host

3268

for value in old_client_settings.values():

3269

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

3270

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

3271

.decode("utf-8"))

2214

clients_data, old_client_settings = (pickle.load

2215

(stored_state))

3272

2216

os.remove(stored_state_path)

3273

2217

except IOError as e:

3274

if e.errno == errno.ENOENT:

3275

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

3276

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

3277

else:

3278

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

3279

exc_info=e)

2218

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

2219

.format(e))

2220

if e.errno != errno.ENOENT:

3280

2221

raise

3281

2222

except EOFError as e:

3282

2223

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

3283

"EOFError:",

3284

exc_info=e)

3285

2224

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

2225

3286

2226

with PGPEngine() as pgp:

3287

for client_name, client in clients_data.items():

3288

# Skip removed clients

3289

if client_name not in client_settings:

3290

continue

3291

2227

for client_name, client in clients_data.iteritems():

3292

2228

# Decide which value to use after restoring saved state.

3293

2229

# We have three different values: Old config file,

3294

2230

# new config file, and saved state.

3299

2235

# For each value in new config, check if it

3300

2236

# differs from the old config value (Except for

3301

2237

# the "secret" attribute)

3302

if (name != "secret"

3303

and (value !=

3304

old_client_settings[client_name][name])):

2238

if (name != "secret" and

2239

value != old_client_settings[client_name]

2240

[name]):

3305

2241

client[name] = value

3306

2242

except KeyError:

3307

2243

pass

3308

2244

3309

2245

# Clients who has passed its expire date can still be

3310

# enabled if its last checker was successful. A Client

2246

# enabled if its last checker was successful. Clients

3311

2247

# whose checker succeeded before we stored its state is

3312

2248

# assumed to have successfully run all checkers during

3313

2249

# downtime.

3315

2251

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

3316

2252

if not client["last_checked_ok"]:

3317

2253

logger.warning(

3318

"disabling client {} - Client never "

3319

"performed a successful checker".format(

3320

client_name))

2254

"disabling client {0} - Client never "

2255

"performed a successful checker"

2256

.format(client_name))

3321

2257

client["enabled"] = False

3322

2258

elif client["last_checker_status"] != 0:

3323

2259

logger.warning(

3324

"disabling client {} - Client last"

3325

" checker failed with error code"

3326

" {}".format(

3327

client_name,

3328

client["last_checker_status"]))

2260

"disabling client {0} - Client "

2261

"last checker failed with error code {1}"

2262

.format(client_name,

2263

client["last_checker_status"]))

3329

2264

client["enabled"] = False

3330

2265

else:

3331

client["expires"] = (

3332

datetime.datetime.utcnow()

3333

+ client["timeout"])

2266

client["expires"] = (datetime.datetime

2267

.utcnow()

2268

+ client["timeout"])

3334

2269

logger.debug("Last checker succeeded,"

3335

" keeping {} enabled".format(

3336

client_name))

2270

" keeping {0} enabled"

2271

.format(client_name))

3337

2272

try:

3338

client["secret"] = pgp.decrypt(

3339

client["encrypted_secret"],

3340

client_settings[client_name]["secret"])

2273

client["secret"] = (

2274

pgp.decrypt(client["encrypted_secret"],

2275

client_settings[client_name]

2276

["secret"]))

3341

2277

except PGPError:

3342

2278

# If decryption fails, we use secret from new settings

3343

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

3344

client_name))

3345

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

3346

["secret"])

2279

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

2280

.format(client_name))

2281

client["secret"] = (

2282

client_settings[client_name]["secret"])

3347

2283

2284

3348

2285

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

3349

2286

for client_name in (set(old_client_settings)

3350

2287

- set(client_settings)):

3354

2291

clients_data[client_name] = client_settings[client_name]

3355

2292

3356

2293

# Create all client objects

3357

for client_name, client in clients_data.items():

2294

for client_name, client in clients_data.iteritems():

3358

2295

tcp_server.clients[client_name] = client_class(

3359

name=client_name,

3360

settings=client,

3361

server_settings=server_settings)

3362

2296

name = client_name, settings = client)

2297

3363

2298

if not tcp_server.clients:

3364

2299

logger.warning("No clients defined")

3365

3366

if not foreground:

3367

if pidfile is not None:

3368

pid = os.getpid()

3369

try:

3370

with pidfile:

3371

print(pid, file=pidfile)

3372

except IOError:

3373

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

3374

pidfilename, pid)

3375

del pidfile

2300

2301

if not debug:

2302

try:

2303

with pidfile:

2304

pid = os.getpid()

2305

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

2306

del pidfile

2307

except IOError:

2308

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

2309

pidfilename, pid)

2310

except NameError:

2311

# "pidfile" was never created

2312

pass

3376

2313

del pidfilename

3377

3378

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

3379

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3380

lambda: main_loop.quit() and False)

3381

2314

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

2315

2316

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

2317

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

2318

3382

2319

if use_dbus:

3383

3384

@alternate_dbus_interfaces(

3385

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

3386

class MandosDBusService(DBusObjectWithObjectManager):

2320

class MandosDBusService(dbus.service.Object):

3387

2321

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

3388

3389

2322

def __init__(self):

3390

2323

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

3391

3392

2324

_interface = "se.recompile.Mandos"

3393

2325

3394

2326

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

3395

2327

def ClientAdded(self, objpath):

3396

2328

"D-Bus signal"

3397

2329

pass

3398

2330

3399

2331

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

3400

def ClientNotFound(self, key_id, address):

2332

def ClientNotFound(self, fingerprint, address):

3401

2333

"D-Bus signal"

3402

2334

pass

3403

3404

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

3405

"true"})

2335

3406

2336

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

3407

2337

def ClientRemoved(self, objpath, name):

3408

2338

"D-Bus signal"

3409

2339

pass

3410

3411

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

3412

"true"})

2340

3413

2341

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

3414

2342

def GetAllClients(self):

3415

2343

"D-Bus method"

3416

return dbus.Array(c.dbus_object_path for c in

3417

tcp_server.clients.values())

3418

3419

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

3420

"true"})

2344

return dbus.Array(c.dbus_object_path

2345

for c in

2346

tcp_server.clients.itervalues())

2347

3421

2348

@dbus.service.method(_interface,

3422

2349

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

3423

2350

def GetAllClientsWithProperties(self):

3424

2351

"D-Bus method"

3425

2352

return dbus.Dictionary(

3426

{c.dbus_object_path: c.GetAll(

3427

"se.recompile.Mandos.Client")

3428

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

2353

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

2354

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

3429

2355

signature="oa{sv}")

3430

2356

3431

2357

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

3432

2358

def RemoveClient(self, object_path):

3433

2359

"D-Bus method"

3434

for c in tcp_server.clients.values():

2360

for c in tcp_server.clients.itervalues():

3435

2361

if c.dbus_object_path == object_path:

3436

2362

del tcp_server.clients[c.name]

3437

2363

c.remove_from_connection()

3438

# Don't signal the disabling

2364

# Don't signal anything except ClientRemoved

3439

2365

c.disable(quiet=True)

3440

# Emit D-Bus signal for removal

3441

self.client_removed_signal(c)

2366

# Emit D-Bus signal

2367

self.ClientRemoved(object_path, c.name)

3442

2368

return

3443

2369

raise KeyError(object_path)

3444

2370

3445

2371

del _interface

3446

3447

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3448

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

3449

def GetManagedObjects(self):

3450

"""D-Bus method"""

3451

return dbus.Dictionary(

3452

{client.dbus_object_path:

3453

dbus.Dictionary(

3454

{interface: client.GetAll(interface)

3455

for interface in

3456

client._get_all_interface_names()})

3457

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

3458

3459

def client_added_signal(self, client):

3460

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

3461

if use_dbus:

3462

# New standard signal

3463

self.InterfacesAdded(

3464

client.dbus_object_path,

3465

dbus.Dictionary(

3466

{interface: client.GetAll(interface)

3467

for interface in

3468

client._get_all_interface_names()}))

3469

# Old signal

3470

self.ClientAdded(client.dbus_object_path)

3471

3472

def client_removed_signal(self, client):

3473

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

3474

if use_dbus:

3475

# New standard signal

3476

self.InterfacesRemoved(

3477

client.dbus_object_path,

3478

client._get_all_interface_names())

3479

# Old signal

3480

self.ClientRemoved(client.dbus_object_path,

3481

client.name)

3482

3483

mandos_dbus_service = MandosDBusService()

3484

3485

# Save modules to variables to exempt the modules from being

3486

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

3487

mp = multiprocessing

3488

wn = wnull

3489

2372

2373

class MandosDBusServiceTransitional(MandosDBusService):

2374

__metaclass__ = AlternateDBusNamesMetaclass

2375

mandos_dbus_service = MandosDBusServiceTransitional()

2376

3490

2377

def cleanup():

3491

2378

"Cleanup function; run on exit"

3492

if zeroconf:

3493

service.cleanup()

3494

3495

mp.active_children()

3496

wn.close()

2379

service.cleanup()

2380

2381

multiprocessing.active_children()

3497

2382

if not (tcp_server.clients or client_settings):

3498

2383

return

3499

2384

3500

2385

# Store client before exiting. Secrets are encrypted with key

3501

2386

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

3502

2387

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

3503

2388

clients = {}

3504

2389

with PGPEngine() as pgp:

3505

for client in tcp_server.clients.values():

2390

for client in tcp_server.clients.itervalues():

3506

2391

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

3507

2392

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

3508

2393

key)

3509

2394

client_dict = {}

3510

2395

3511

2396

# A list of attributes that can not be pickled

3512

2397

# + secret.

3513

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

3514

"checker", "server_settings"}

3515

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

3516

.Object):

2398

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

2399

"checker"))

2400

for name, typ in (inspect.getmembers

2401

(dbus.service.Object)):

3517

2402

exclude.add(name)

3518

2403

3519

2404

client_dict["encrypted_secret"] = (client

3520

2405

.encrypted_secret)

3521

2406

for attr in client.client_structure:

3522

2407

if attr not in exclude:

3523

2408

client_dict[attr] = getattr(client, attr)

3524

2409

3525

2410

clients[client.name] = client_dict

3526

2411

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

3527

2412

3528

2413

try:

3529

with tempfile.NamedTemporaryFile(

3530

mode='wb',

3531

suffix=".pickle",

3532

prefix='clients-',

3533

dir=os.path.dirname(stored_state_path),

3534

delete=False) as stored_state:

3535

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

3536

protocol=2)

3537

tempname = stored_state.name

2414

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

2415

prefix="clients-",

2416

dir=os.path.dirname

2417

(stored_state_path))

2418

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

2419

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

3538

2420

os.rename(tempname, stored_state_path)

3539

2421

except (IOError, OSError) as e:

2422

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

2423

.format(e))

3540

2424

if not debug:

3541

2425

try:

3542

2426

os.remove(tempname)

3543

2427

except NameError:

3544

2428

pass

3545

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

3546

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

3547

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

3548

else:

3549

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

3550

exc_info=e)

3551

raise

3552

2429

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

2430

errno.EEXIST)):

2431

raise e

2432

3553

2433

# Delete all clients, and settings from config

3554

2434

while tcp_server.clients:

3555

2435

name, client = tcp_server.clients.popitem()

3556

2436

if use_dbus:

3557

2437

client.remove_from_connection()

3558

# Don't signal the disabling

2438

# Don't signal anything except ClientRemoved

3559

2439

client.disable(quiet=True)

3560

# Emit D-Bus signal for removal

3561

2440

if use_dbus:

3562

mandos_dbus_service.client_removed_signal(client)

2441

# Emit D-Bus signal

2442

mandos_dbus_service.ClientRemoved(client

2443

.dbus_object_path,

2444

client.name)

3563

2445

client_settings.clear()

3564

2446

3565

2447

atexit.register(cleanup)

3566

3567

for client in tcp_server.clients.values():

2448

2449

for client in tcp_server.clients.itervalues():

3568

2450

if use_dbus:

3569

# Emit D-Bus signal for adding

3570

mandos_dbus_service.client_added_signal(client)

2451

# Emit D-Bus signal

2452

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3571

2453

# Need to initiate checking of clients

3572

2454

if client.enabled:

3573

2455

client.init_checker()

3574

2456

3575

2457

tcp_server.enable()

3576

2458

tcp_server.server_activate()

3577

2459

3578

2460

# Find out what port we got

3579

if zeroconf:

3580

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

2461

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

3581

2462

if use_ipv6:

3582

2463

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

3583

" flowinfo %d, scope_id %d",

3584

*tcp_server.socket.getsockname())

2464

" flowinfo %d, scope_id %d"

2465

% tcp_server.socket.getsockname())

3585

2466

else: # IPv4

3586

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

3587

*tcp_server.socket.getsockname())

3588

3589

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

3590

2467

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

2468

% tcp_server.socket.getsockname())

2469

2470

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

2471

3591

2472

try:

3592

if zeroconf:

3593

# From the Avahi example code

3594

try:

3595

service.activate()

3596

except dbus.exceptions.DBusException as error:

3597

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

3598

cleanup()

3599

sys.exit(1)

3600

# End of Avahi example code

3601

3602

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

3603

lambda *args, **kwargs:

3604

(tcp_server.handle_request

3605

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

3606

2473

# From the Avahi example code

2474

try:

2475

service.activate()

2476

except dbus.exceptions.DBusException as error:

2477

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

2478

cleanup()

2479

sys.exit(1)

2480

# End of Avahi example code

2481

2482

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

2483

lambda *args, **kwargs:

2484

(tcp_server.handle_request

2485

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

2486

3607

2487

logger.debug("Starting main loop")

3608

2488

main_loop.run()

3609

2489

except AvahiError as error:

3610

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

2490

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

3611

2491

cleanup()

3612

2492

sys.exit(1)

3613

2493

except KeyboardInterrupt:

3618

2498

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

3619

2499

cleanup()

3620

2500

3621

3622

2501

if __name__ == '__main__':

3623

2502

main()