/mandos/release : revision 292

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

import gi

84

from gi.repository import GLib

71

import gobject

72

import avahi

85

73

from dbus.mainloop.glib import DBusGMainLoop

86

74

import ctypes

87

75

import ctypes.util

88

76

import xml.dom.minidom

89

77

import inspect

90

91

if sys.version_info.major == 2:

92

__metaclass__ = type

93

94

# Try to find the value of SO_BINDTODEVICE:

78

import GnuPGInterface

79

95

80

try:

96

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

97

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

98

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

99

82

except AttributeError:

100

83

try:

101

# This is where SO_BINDTODEVICE was up to and including Python

102

# 2.6, and also 3.2:

103

84

from IN import SO_BINDTODEVICE

104

85

except ImportError:

105

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

106

# Try running the C preprocessor:

107

try:

108

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

109

"/dev/stdin"],

110

stdin=subprocess.PIPE,

111

stdout=subprocess.PIPE)

112

stdout = cc.communicate(

113

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

114

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

115

except (OSError, ValueError, IndexError):

116

# No value found

117

SO_BINDTODEVICE = None

118

119

if sys.version_info.major == 2:

120

str = unicode

121

122

if sys.version_info < (3, 2):

123

configparser.Configparser = configparser.SafeConfigParser

124

125

version = "1.8.8"

86

SO_BINDTODEVICE = None

87

88

version = "1.5.0"

126

89

stored_state_file = "clients.pickle"

127

90

128

91

logger = logging.getLogger()

129

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

130

95

131

96

try:

132

if_nametoindex = ctypes.cdll.LoadLibrary(

133

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

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

134

100

except (OSError, AttributeError):

135

136

101

def if_nametoindex(interface):

137

102

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

138

103

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

139

104

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

140

105

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

141

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

142

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]

143

110

return interface_index

144

111

145

112

146

def copy_function(func):

147

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

148

if sys.version_info.major == 2:

149

return types.FunctionType(func.func_code,

150

func.func_globals,

151

func.func_name,

152

func.func_defaults,

153

func.func_closure)

154

else:

155

return types.FunctionType(func.__code__,

156

func.__globals__,

157

func.__name__,

158

func.__defaults__,

159

func.__closure__)

160

161

162

113

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

163

114

"""init logger and add loglevel"""

164

165

global syslogger

166

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

115

169

116

syslogger.setFormatter(logging.Formatter

170

117

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

171

118

' %(message)s'))

172

119

logger.addHandler(syslogger)

173

120

174

121

if debug:

175

122

console = logging.StreamHandler()

176

123

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

186

133

pass

187

134

188

135

189

class PGPEngine:

136

class PGPEngine(object):

190

137

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

191

192

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

193

140

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

194

self.gpg = "gpg"

195

try:

196

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

197

for line in output.splitlines():

198

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

199

if name == "gpg":

200

self.gpg = path

201

break

202

except OSError as e:

203

if e.errno != errno.ENOENT:

204

raise

205

self.gnupgargs = ['--batch',

206

'--homedir', self.tempdir,

207

'--force-mdc',

208

'--quiet']

209

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

210

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

211

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

212

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

213

148

def __enter__(self):

214

149

return self

215

216

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

150

151

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

217

152

self._cleanup()

218

153

return False

219

154

220

155

def __del__(self):

221

156

self._cleanup()

222

157

223

158

def _cleanup(self):

224

159

if self.tempdir is not None:

225

160

# Delete contents of tempdir

226

161

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

227

topdown=False):

162

topdown = False):

228

163

for filename in files:

229

164

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

230

165

for dirname in dirs:

232

167

# Remove tempdir

233

168

os.rmdir(self.tempdir)

234

169

self.tempdir = None

235

170

236

171

def password_encode(self, password):

237

172

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

238

173

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

239

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

240

if len(encoded) > 2048:

241

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

242

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

243

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

244

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

245

return encoded

246

174

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

175

247

176

def encrypt(self, data, password):

248

passphrase = self.password_encode(password)

249

with tempfile.NamedTemporaryFile(

250

dir=self.tempdir) as passfile:

251

passfile.write(passphrase)

252

passfile.flush()

253

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

254

'--passphrase-file',

255

passfile.name]

256

+ self.gnupgargs,

257

stdin=subprocess.PIPE,

258

stdout=subprocess.PIPE,

259

stderr=subprocess.PIPE)

260

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

261

if proc.returncode != 0:

262

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

263

191

return ciphertext

264

192

265

193

def decrypt(self, data, password):

266

passphrase = self.password_encode(password)

267

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

269

passfile.write(passphrase)

270

passfile.flush()

271

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

272

'--passphrase-file',

273

passfile.name]

274

+ self.gnupgargs,

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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

279

if proc.returncode != 0:

280

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

281

208

return decrypted_plaintext

282

209

283

210

284

# Pretend that we have an Avahi module

285

class avahi:

286

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

287

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

288

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

289

PROTO_INET = 0 # avahi-common/address.h

290

PROTO_INET6 = 1 # avahi-common/address.h

291

DBUS_NAME = "org.freedesktop.Avahi"

292

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

293

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

294

DBUS_PATH_SERVER = "/"

295

296

@staticmethod

297

def string_array_to_txt_array(t):

298

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

299

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

300

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

301

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

302

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

303

SERVER_INVALID = 0 # avahi-common/defs.h

304

SERVER_REGISTERING = 1 # avahi-common/defs.h

305

SERVER_RUNNING = 2 # avahi-common/defs.h

306

SERVER_COLLISION = 3 # avahi-common/defs.h

307

SERVER_FAILURE = 4 # avahi-common/defs.h

308

309

211

310

212

class AvahiError(Exception):

311

213

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

312

214

self.value = value

313

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

314

**kwargs)

315

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

316

218

317

219

class AvahiServiceError(AvahiError):

318

220

pass

319

221

320

321

222

class AvahiGroupError(AvahiError):

322

223

pass

323

224

324

225

325

class AvahiService:

226

class AvahiService(object):

326

227

"""An Avahi (Zeroconf) service.

327

228

328

229

Attributes:

329

230

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

330

231

Used to optionally bind to the specified interface.

331

232

name: string; Example: 'Mandos'

332

233

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

333

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

234

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

334

235

port: integer; what port to announce

335

236

TXT: list of strings; TXT record for the service

336

237

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

342

243

server: D-Bus Server

343

244

bus: dbus.SystemBus()

344

245

"""

345

346

def __init__(self,

347

interface=avahi.IF_UNSPEC,

348

name=None,

349

servicetype=None,

350

port=None,

351

TXT=None,

352

domain="",

353

host="",

354

max_renames=32768,

355

protocol=avahi.PROTO_UNSPEC,

356

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

357

250

self.interface = interface

358

251

self.name = name

359

252

self.type = servicetype

368

261

self.server = None

369

262

self.bus = bus

370

263

self.entry_group_state_changed_match = None

371

372

def rename(self, remove=True):

264

def rename(self):

373

265

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

374

266

if self.rename_count >= self.max_renames:

375

267

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

376

268

" after %i retries, exiting.",

377

269

self.rename_count)

378

270

raise AvahiServiceError("Too many renames")

379

self.name = str(

380

self.server.GetAlternativeServiceName(self.name))

381

self.rename_count += 1

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

382

273

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

383

274

self.name)

384

if remove:

385

self.remove()

275

self.remove()

386

276

try:

387

277

self.add()

388

278

except dbus.exceptions.DBusException as error:

389

if (error.get_dbus_name()

390

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

391

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

392

return self.rename(remove=False)

393

else:

394

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

395

self.cleanup()

396

os._exit(1)

397

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

398

283

def remove(self):

399

284

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

400

285

if self.entry_group_state_changed_match is not None:

402

287

self.entry_group_state_changed_match = None

403

288

if self.group is not None:

404

289

self.group.Reset()

405

406

290

def add(self):

407

291

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

408

292

self.remove()

425

309

dbus.UInt16(self.port),

426

310

avahi.string_array_to_txt_array(self.TXT))

427

311

self.group.Commit()

428

429

312

def entry_group_state_changed(self, state, error):

430

313

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

431

314

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

432

315

433

316

if state == avahi.ENTRY_GROUP_ESTABLISHED:

434

317

logger.debug("Zeroconf service established.")

435

318

elif state == avahi.ENTRY_GROUP_COLLISION:

437

320

self.rename()

438

321

elif state == avahi.ENTRY_GROUP_FAILURE:

439

322

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

440

str(error))

441

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

442

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

443

326

def cleanup(self):

444

327

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

445

328

if self.group is not None:

450

333

pass

451

334

self.group = None

452

335

self.remove()

453

454

336

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

455

337

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

456

338

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

457

bad_states = {

458

avahi.SERVER_INVALID: "Zeroconf server invalid",

459

avahi.SERVER_REGISTERING: None,

460

avahi.SERVER_COLLISION: "Zeroconf server name collision",

461

avahi.SERVER_FAILURE: "Zeroconf server failure",

462

}

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

463

346

if state in bad_states:

464

347

if bad_states[state] is not None:

465

348

if error is None:

468

351

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

469

352

self.cleanup()

470

353

elif state == avahi.SERVER_RUNNING:

471

try:

472

self.add()

473

except dbus.exceptions.DBusException as error:

474

if (error.get_dbus_name()

475

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

476

logger.info("Local Zeroconf service name"

477

" collision.")

478

return self.rename(remove=False)

479

else:

480

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

481

self.cleanup()

482

os._exit(1)

354

self.add()

483

355

else:

484

356

if error is None:

485

357

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

486

358

else:

487

359

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

488

489

360

def activate(self):

490

361

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

491

362

if self.server is None:

495

366

follow_name_owner_changes=True),

496

367

avahi.DBUS_INTERFACE_SERVER)

497

368

self.server.connect_to_signal("StateChanged",

498

self.server_state_changed)

369

self.server_state_changed)

499

370

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

500

371

501

502

372

class AvahiServiceToSyslog(AvahiService):

503

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

373

def rename(self):

504

374

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

505

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

506

syslogger.setFormatter(logging.Formatter(

507

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

508

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

509

380

return ret

510

381

511

512

# Pretend that we have a GnuTLS module

513

class gnutls:

514

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

515

516

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

517

if library is None:

518

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

519

_library = ctypes.cdll.LoadLibrary(library)

520

del library

521

522

# Unless otherwise indicated, the constants and types below are

523

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

524

525

# Constants

526

E_SUCCESS = 0

527

E_INTERRUPTED = -52

528

E_AGAIN = -28

529

CRT_OPENPGP = 2

530

CRT_RAWPK = 3

531

CLIENT = 2

532

SHUT_RDWR = 0

533

CRD_CERTIFICATE = 1

534

E_NO_CERTIFICATE_FOUND = -49

535

X509_FMT_DER = 0

536

NO_TICKETS = 1<<10

537

ENABLE_RAWPK = 1<<18

538

CTYPE_PEERS = 3

539

KEYID_USE_SHA256 = 1 # gnutls/x509.h

540

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

541

542

# Types

543

class session_int(ctypes.Structure):

544

_fields_ = []

545

session_t = ctypes.POINTER(session_int)

546

547

class certificate_credentials_st(ctypes.Structure):

548

_fields_ = []

549

certificate_credentials_t = ctypes.POINTER(

550

certificate_credentials_st)

551

certificate_type_t = ctypes.c_int

552

553

class datum_t(ctypes.Structure):

554

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

555

('size', ctypes.c_uint)]

556

557

class openpgp_crt_int(ctypes.Structure):

558

_fields_ = []

559

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

560

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

561

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

562

credentials_type_t = ctypes.c_int

563

transport_ptr_t = ctypes.c_void_p

564

close_request_t = ctypes.c_int

565

566

# Exceptions

567

class Error(Exception):

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = gnutls.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials:

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession:

593

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

594

self._c_object = gnutls.session_t()

595

gnutls_flags = gnutls.CLIENT

596

if gnutls.check_version(b"3.5.6"):

597

gnutls_flags |= gnutls.NO_TICKETS

598

if gnutls.has_rawpk:

599

gnutls_flags |= gnutls.ENABLE_RAWPK

600

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

601

del gnutls_flags

602

gnutls.set_default_priority(self._c_object)

603

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

604

gnutls.handshake_set_private_extensions(self._c_object,

605

True)

606

self.socket = socket

607

if credentials is None:

608

credentials = gnutls.Credentials()

609

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

610

ctypes.cast(credentials._c_object,

611

ctypes.c_void_p))

612

self.credentials = credentials

613

614

def __del__(self):

615

gnutls.deinit(self._c_object)

616

617

def handshake(self):

618

return gnutls.handshake(self._c_object)

619

620

def send(self, data):

621

data = bytes(data)

622

data_len = len(data)

623

while data_len > 0:

624

data_len -= gnutls.record_send(self._c_object,

625

data[-data_len:],

626

data_len)

627

628

def bye(self):

629

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

630

631

# Error handling functions

632

def _error_code(result):

633

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

634

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

635

if result >= 0:

636

return result

637

if result == gnutls.E_NO_CERTIFICATE_FOUND:

638

raise gnutls.CertificateSecurityError(code=result)

639

raise gnutls.Error(code=result)

640

641

def _retry_on_error(result, func, arguments):

642

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

643

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

644

while result < 0:

645

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

646

return _error_code(result)

647

result = func(*arguments)

648

return result

649

650

# Unless otherwise indicated, the function declarations below are

651

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

652

653

# Functions

654

priority_set_direct = _library.gnutls_priority_set_direct

655

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

656

ctypes.POINTER(ctypes.c_char_p)]

657

priority_set_direct.restype = _error_code

658

659

init = _library.gnutls_init

660

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

661

init.restype = _error_code

662

663

set_default_priority = _library.gnutls_set_default_priority

664

set_default_priority.argtypes = [session_t]

665

set_default_priority.restype = _error_code

666

667

record_send = _library.gnutls_record_send

668

record_send.argtypes = [session_t, ctypes.c_void_p,

669

ctypes.c_size_t]

670

record_send.restype = ctypes.c_ssize_t

671

record_send.errcheck = _retry_on_error

672

673

certificate_allocate_credentials = (

674

_library.gnutls_certificate_allocate_credentials)

675

certificate_allocate_credentials.argtypes = [

676

ctypes.POINTER(certificate_credentials_t)]

677

certificate_allocate_credentials.restype = _error_code

678

679

certificate_free_credentials = (

680

_library.gnutls_certificate_free_credentials)

681

certificate_free_credentials.argtypes = [

682

certificate_credentials_t]

683

certificate_free_credentials.restype = None

684

685

handshake_set_private_extensions = (

686

_library.gnutls_handshake_set_private_extensions)

687

handshake_set_private_extensions.argtypes = [session_t,

688

ctypes.c_int]

689

handshake_set_private_extensions.restype = None

690

691

credentials_set = _library.gnutls_credentials_set

692

credentials_set.argtypes = [session_t, credentials_type_t,

693

ctypes.c_void_p]

694

credentials_set.restype = _error_code

695

696

strerror = _library.gnutls_strerror

697

strerror.argtypes = [ctypes.c_int]

698

strerror.restype = ctypes.c_char_p

699

700

certificate_type_get = _library.gnutls_certificate_type_get

701

certificate_type_get.argtypes = [session_t]

702

certificate_type_get.restype = _error_code

703

704

certificate_get_peers = _library.gnutls_certificate_get_peers

705

certificate_get_peers.argtypes = [session_t,

706

ctypes.POINTER(ctypes.c_uint)]

707

certificate_get_peers.restype = ctypes.POINTER(datum_t)

708

709

global_set_log_level = _library.gnutls_global_set_log_level

710

global_set_log_level.argtypes = [ctypes.c_int]

711

global_set_log_level.restype = None

712

713

global_set_log_function = _library.gnutls_global_set_log_function

714

global_set_log_function.argtypes = [log_func]

715

global_set_log_function.restype = None

716

717

deinit = _library.gnutls_deinit

718

deinit.argtypes = [session_t]

719

deinit.restype = None

720

721

handshake = _library.gnutls_handshake

722

handshake.argtypes = [session_t]

723

handshake.restype = _error_code

724

handshake.errcheck = _retry_on_error

725

726

transport_set_ptr = _library.gnutls_transport_set_ptr

727

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

728

transport_set_ptr.restype = None

729

730

bye = _library.gnutls_bye

731

bye.argtypes = [session_t, close_request_t]

732

bye.restype = _error_code

733

bye.errcheck = _retry_on_error

734

735

check_version = _library.gnutls_check_version

736

check_version.argtypes = [ctypes.c_char_p]

737

check_version.restype = ctypes.c_char_p

738

739

_need_version = b"3.3.0"

740

if check_version(_need_version) is None:

741

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

742

.format(_need_version))

743

744

_tls_rawpk_version = b"3.6.6"

745

has_rawpk = bool(check_version(_tls_rawpk_version))

746

747

if has_rawpk:

748

# Types

749

class pubkey_st(ctypes.Structure):

750

_fields = []

751

pubkey_t = ctypes.POINTER(pubkey_st)

752

753

x509_crt_fmt_t = ctypes.c_int

754

755

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

756

pubkey_init = _library.gnutls_pubkey_init

757

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

758

pubkey_init.restype = _error_code

759

760

pubkey_import = _library.gnutls_pubkey_import

761

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

762

x509_crt_fmt_t]

763

pubkey_import.restype = _error_code

764

765

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

766

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

767

ctypes.POINTER(ctypes.c_ubyte),

768

ctypes.POINTER(ctypes.c_size_t)]

769

pubkey_get_key_id.restype = _error_code

770

771

pubkey_deinit = _library.gnutls_pubkey_deinit

772

pubkey_deinit.argtypes = [pubkey_t]

773

pubkey_deinit.restype = None

774

else:

775

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

776

777

openpgp_crt_init = _library.gnutls_openpgp_crt_init

778

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

779

openpgp_crt_init.restype = _error_code

780

781

openpgp_crt_import = _library.gnutls_openpgp_crt_import

782

openpgp_crt_import.argtypes = [openpgp_crt_t,

783

ctypes.POINTER(datum_t),

784

openpgp_crt_fmt_t]

785

openpgp_crt_import.restype = _error_code

786

787

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

788

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

789

ctypes.POINTER(ctypes.c_uint)]

790

openpgp_crt_verify_self.restype = _error_code

791

792

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

793

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

794

openpgp_crt_deinit.restype = None

795

796

openpgp_crt_get_fingerprint = (

797

_library.gnutls_openpgp_crt_get_fingerprint)

798

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

799

ctypes.c_void_p,

800

ctypes.POINTER(

801

ctypes.c_size_t)]

802

openpgp_crt_get_fingerprint.restype = _error_code

803

804

if check_version(b"3.6.4"):

805

certificate_type_get2 = _library.gnutls_certificate_type_get2

806

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

807

certificate_type_get2.restype = _error_code

808

809

# Remove non-public functions

810

del _error_code, _retry_on_error

811

812

813

def call_pipe(connection, # : multiprocessing.Connection

814

func, *args, **kwargs):

815

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

816

817

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

818

return value on the provided multiprocessing.Connection.

819

"""

820

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

821

connection.close()

822

823

824

class Client:

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

388

class Client(object):

825

389

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

826

390

827

391

Attributes:

828

392

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

829

393

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

830

394

approval_duration: datetime.timedelta(); Duration of one approval

831

checker: multiprocessing.Process(); a running checker process used

832

to see if the client lives. 'None' if no process is

833

running.

834

checker_callback_tag: a GLib event source tag, or None

395

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

396

to see if the client lives.

397

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

835

399

checker_command: string; External command which is run to check

836

400

if client lives. %() expansions are done at

837

401

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

838

402

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

839

checker_initiator_tag: a GLib event source tag, or None

403

checker_initiator_tag: a gobject event source tag, or None

840

404

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

841

405

client_structure: Object describing what attributes a client has

842

406

and is used for storing the client at exit

843

407

current_checker_command: string; current running checker_command

844

disable_initiator_tag: a GLib event source tag, or None

408

disable_initiator_tag: a gobject event source tag, or None

845

409

enabled: bool()

846

410

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

847

uniquely identify an OpenPGP client

848

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

849

a client using raw public keys

411

uniquely identify the client

850

412

host: string; available for use by the checker command

851

413

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

852

414

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

853

415

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

854

416

last_checker_status: integer between 0 and 255 reflecting exit

855

417

status of last checker. -1 reflects crashed

856

checker, -2 means no checker completed yet.

857

last_checker_signal: The signal which killed the last checker, if

858

last_checker_status is -1

418

checker, or None.

859

419

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

860

420

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

861

421

D-Bus identifiers

862

422

secret: bytestring; sent verbatim (over TLS) to client

863

423

timeout: datetime.timedelta(); How long from last_checked_ok

864

424

until this client is disabled

865

extended_timeout: extra long timeout when secret has been sent

425

extended_timeout: extra long timeout when password has been sent

866

426

runtime_expansions: Allowed attributes for runtime expansion.

867

427

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

868

428

disabled, or None

869

server_settings: The server_settings dict from main()

870

429

"""

871

430

872

431

runtime_expansions = ("approval_delay", "approval_duration",

873

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

874

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

875

"last_approval_request", "last_checked_ok",

432

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

433

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

876

434

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

877

client_defaults = {

878

"timeout": "PT5M",

879

"extended_timeout": "PT15M",

880

"interval": "PT2M",

881

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

882

"host": "",

883

"approval_delay": "PT0S",

884

"approval_duration": "PT1S",

885

"approved_by_default": "True",

886

"enabled": "True",

887

}

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)

888

460

889

461

@staticmethod

890

462

def config_parser(config):

898

470

for client_name in config.sections():

899

471

section = dict(config.items(client_name))

900

472

client = settings[client_name] = {}

901

473

902

474

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

903

475

# Reformat values from string types to Python types

904

476

client["approved_by_default"] = config.getboolean(

905

477

client_name, "approved_by_default")

906

478

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

907

479

"enabled")

908

909

# Uppercase and remove spaces from key_id and fingerprint

910

# for later comparison purposes with return value from the

911

# key_id() and fingerprint() functions

912

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

913

.replace(" ", ""))

480

914

481

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

915

482

.replace(" ", ""))

916

483

if "secret" in section:

917

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

918

.encode("utf-8"),

919

"base64")

484

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

920

485

elif "secfile" in section:

921

486

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

922

487

(section["secfile"])),

923

488

"rb") as secfile:

924

489

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

925

490

else:

926

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

927

.format(section))

491

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

492

% section)

928

493

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

929

494

client["extended_timeout"] = string_to_delta(

930

495

section["extended_timeout"])

936

501

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

937

502

client["last_approval_request"] = None

938

503

client["last_checked_ok"] = None

939

client["last_checker_status"] = -2

940

504

client["last_checker_status"] = None

505

941

506

return settings

942

943

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

944

513

self.name = name

945

if server_settings is None:

946

server_settings = {}

947

self.server_settings = server_settings

948

514

# adding all client settings

949

for setting, value in settings.items():

515

for setting, value in settings.iteritems():

950

516

setattr(self, setting, value)

951

517

952

518

if self.enabled:

953

519

if not hasattr(self, "last_enabled"):

954

520

self.last_enabled = datetime.datetime.utcnow()

958

524

else:

959

525

self.last_enabled = None

960

526

self.expires = None

961

527

962

528

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

963

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

964

532

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

965

533

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

966

534

datetime.datetime.utcnow())

973

541

self.current_checker_command = None

974

542

self.approved = None

975

543

self.approvals_pending = 0

976

self.changedstate = multiprocessing_manager.Condition(

977

multiprocessing_manager.Lock())

978

self.client_structure = [attr

979

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

980

549

if not attr.startswith("_")]

981

550

self.client_structure.append("client_structure")

982

983

for name, t in inspect.getmembers(

984

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

985

556

if not name.startswith("_"):

986

557

self.client_structure.append(name)

987

558

988

559

# Send notice to process children that client state has changed

989

560

def send_changedstate(self):

990

561

with self.changedstate:

991

562

self.changedstate.notify_all()

992

563

993

564

def enable(self):

994

565

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

995

566

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

996

567

# Already enabled

997

568

return

569

self.send_changedstate()

998

570

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

999

571

self.enabled = True

1000

572

self.last_enabled = datetime.datetime.utcnow()

1001

573

self.init_checker()

1002

self.send_changedstate()

1003

574

1004

575

def disable(self, quiet=True):

1005

576

"""Disable this client."""

1006

577

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

1007

578

return False

1008

579

if not quiet:

580

self.send_changedstate()

581

if not quiet:

1009

582

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

1010

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

1011

GLib.source_remove(self.disable_initiator_tag)

583

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

584

gobject.source_remove(self.disable_initiator_tag)

1012

585

self.disable_initiator_tag = None

1013

586

self.expires = None

1014

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

1015

GLib.source_remove(self.checker_initiator_tag)

587

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

588

gobject.source_remove(self.checker_initiator_tag)

1016

589

self.checker_initiator_tag = None

1017

590

self.stop_checker()

1018

591

self.enabled = False

1019

if not quiet:

1020

self.send_changedstate()

1021

# 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

1022

593

return False

1023

594

1024

595

def __del__(self):

1025

596

self.disable()

1026

597

1027

598

def init_checker(self):

1028

599

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

1029

600

# and every interval from then on.

1030

if self.checker_initiator_tag is not None:

1031

GLib.source_remove(self.checker_initiator_tag)

1032

self.checker_initiator_tag = GLib.timeout_add(

1033

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

1034

self.start_checker)

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

1035

604

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

1036

if self.disable_initiator_tag is not None:

1037

GLib.source_remove(self.disable_initiator_tag)

1038

self.disable_initiator_tag = GLib.timeout_add(

1039

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

1040

608

# Also start a new checker *right now*.

1041

609

self.start_checker()

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

610

611

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

1045

612

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

1046

# Read return code from connection (see call_pipe)

1047

returncode = connection.recv()

1048

connection.close()

1049

self.checker.join()

1050

613

self.checker_callback_tag = None

1051

614

self.checker = None

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1056

617

if self.last_checker_status == 0:

1057

618

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

1058

619

vars(self))

1059

620

self.checked_ok()

1060

621

else:

1061

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

622

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

623

vars(self))

1062

624

else:

1063

625

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

1065

626

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

1066

627

vars(self))

1067

return False

1068

1069

def checked_ok(self):

1070

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

1071

self.last_checked_ok = datetime.datetime.utcnow()

1072

self.last_checker_status = 0

1073

self.last_checker_signal = None

1074

self.bump_timeout()

1075

1076

def bump_timeout(self, timeout=None):

1077

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

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

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

633

alive and well.

634

"""

1078

635

if timeout is None:

1079

636

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

1080

638

if self.disable_initiator_tag is not None:

1081

GLib.source_remove(self.disable_initiator_tag)

1082

self.disable_initiator_tag = None

639

gobject.source_remove(self.disable_initiator_tag)

1083

640

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

1084

self.disable_initiator_tag = GLib.timeout_add(

1085

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1086

644

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

1087

645

1088

646

def need_approval(self):

1089

647

self.last_approval_request = datetime.datetime.utcnow()

1090

648

1091

649

def start_checker(self):

1092

650

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

1093

651

1094

652

If a checker already exists, leave it running and do

1095

653

nothing."""

1096

654

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

1097

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

1098

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

1099

# would inevitably timeout, since no checker would get a

1100

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

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

1101

659

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

1102

660

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

1103

661

# should be.

1104

1105

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

1106

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

1107

self.checker.join()

1108

self.checker = None

662

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

self.current_checker_command)

1109

676

# Start a new checker if needed

1110

677

if self.checker is None:

1111

# Escape attributes for the shell

1112

escaped_attrs = {

1113

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

1114

for attr in self.runtime_expansions}

1115

678

try:

1116

command = self.checker_command % escaped_attrs

1117

except TypeError as error:

1118

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

1119

self.checker_command,

1120

exc_info=error)

1121

return True # Try again later

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

1122

697

self.current_checker_command = command

1123

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

1124

self.name)

1125

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

1126

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

1127

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

1128

# always replaced by /dev/null.)

1129

# The exception is when not debugging but nevertheless

1130

# running in the foreground; use the previously

1131

# created wnull.

1132

popen_args = {"close_fds": True,

1133

"shell": True,

1134

"cwd": "/"}

1135

if (not self.server_settings["debug"]

1136

and self.server_settings["foreground"]):

1137

popen_args.update({"stdout": wnull,

1138

"stderr": wnull})

1139

pipe = multiprocessing.Pipe(duplex=False)

1140

self.checker = multiprocessing.Process(

1141

target=call_pipe,

1142

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

1143

kwargs=popen_args)

1144

self.checker.start()

1145

self.checker_callback_tag = GLib.io_add_watch(

1146

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

1147

self.checker_callback, pipe[0], command)

1148

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

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

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

720

error)

721

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

1149

722

return True

1150

723

1151

724

def stop_checker(self):

1152

725

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

1153

726

if self.checker_callback_tag:

1154

GLib.source_remove(self.checker_callback_tag)

727

gobject.source_remove(self.checker_callback_tag)

1155

728

self.checker_callback_tag = None

1156

729

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

1157

730

return

1158

731

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

1159

self.checker.terminate()

732

try:

733

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

734

#time.sleep(0.5)

735

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

736

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

737

except OSError as error:

738

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

739

raise

1160

740

self.checker = None

1161

741

1162

742

1163

def dbus_service_property(dbus_interface,

1164

signature="v",

1165

access="readwrite",

1166

byte_arrays=False):

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1167

745

"""Decorators for marking methods of a DBusObjectWithProperties to

1168

746

become properties on the D-Bus.

1169

747

1170

748

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

1171

749

and with one argument by "Set".

1172

750

1173

751

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

1174

752

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

1175

753

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

1178

756

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

1179

757

if byte_arrays and signature != "ay":

1180

758

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

1181

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

1182

759

" signature %r" % signature)

1183

760

def decorator(func):

1184

761

func._dbus_is_property = True

1185

762

func._dbus_interface = dbus_interface

1188

765

func._dbus_name = func.__name__

1189

766

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

1190

767

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

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1192

return func

1193

1194

return decorator

1195

1196

1197

def dbus_interface_annotations(dbus_interface):

1198

"""Decorator for marking functions returning interface annotations

1199

1200

Usage:

1201

1202

@dbus_interface_annotations("org.example.Interface")

1203

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

1204

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

1205

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

1206

"false"}

1207

"""

1208

1209

def decorator(func):

1210

func._dbus_is_interface = True

1211

func._dbus_interface = dbus_interface

1212

func._dbus_name = dbus_interface

1213

return func

1214

1215

return decorator

1216

1217

1218

def dbus_annotations(annotations):

1219

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

1220

Usage:

1221

1222

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

1223

"org.freedesktop.DBus.Property."

1224

"EmitsChangedSignal": "false"})

1225

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

1226

access="r")

1227

def Property_dbus_property(self):

1228

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

1231

"""

1232

1233

def decorator(func):

1234

func._dbus_annotations = annotations

1235

return func

1236

768

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

return func

1237

770

return decorator

1238

771

1239

772

1240

773

class DBusPropertyException(dbus.exceptions.DBusException):

1241

774

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

1242

775

"""

1243

pass

776

def __unicode__(self):

777

return unicode(str(self))

1244

778

1245

779

1246

780

class DBusPropertyAccessException(DBusPropertyException):

1255

789

pass

1256

790

1257

791

1258

class DBusObjectWithAnnotations(dbus.service.Object):

1259

"""A D-Bus object with annotations.

1260

1261

Classes inheriting from this can use the dbus_annotations

1262

decorator to add annotations to methods or signals.

1263

"""

1264

1265

@staticmethod

1266

def _is_dbus_thing(thing):

1267

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

1268

1269

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

1270

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

1271

"""

1272

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

1273

False)

1274

1275

def _get_all_dbus_things(self, thing):

1276

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

1277

"""

1278

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

1279

athing.__get__(self))

1280

for cls in self.__class__.__mro__

1281

for name, athing in

1282

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

1283

1284

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1285

out_signature="s",

1286

path_keyword='object_path',

1287

connection_keyword='connection')

1288

def Introspect(self, object_path, connection):

1289

"""Overloading of standard D-Bus method.

1290

1291

Inserts annotation tags on methods and signals.

1292

"""

1293

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

1294

connection)

1295

try:

1296

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

1297

1298

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

1299

# Add annotation tags

1300

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

1301

for tag in if_tag.getElementsByTagName(typ):

1302

annots = dict()

1303

for name, prop in (self.

1304

_get_all_dbus_things(typ)):

1305

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

1306

and prop._dbus_interface

1307

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

1308

annots.update(getattr(

1309

prop, "_dbus_annotations", {}))

1310

for name, value in annots.items():

1311

ann_tag = document.createElement(

1312

"annotation")

1313

ann_tag.setAttribute("name", name)

1314

ann_tag.setAttribute("value", value)

1315

tag.appendChild(ann_tag)

1316

# Add interface annotation tags

1317

for annotation, value in dict(

1318

itertools.chain.from_iterable(

1319

annotations().items()

1320

for name, annotations

1321

in self._get_all_dbus_things("interface")

1322

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

1323

)).items():

1324

ann_tag = document.createElement("annotation")

1325

ann_tag.setAttribute("name", annotation)

1326

ann_tag.setAttribute("value", value)

1327

if_tag.appendChild(ann_tag)

1328

# Fix argument name for the Introspect method itself

1329

if (if_tag.getAttribute("name")

1330

== dbus.INTROSPECTABLE_IFACE):

1331

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

1332

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

1333

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

1334

if (arg.getAttribute("direction")

1335

== "out"):

1336

arg.setAttribute("name",

1337

"xml_data")

1338

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

1339

document.unlink()

1340

except (AttributeError, xml.dom.DOMException,

1341

xml.parsers.expat.ExpatError) as error:

1342

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

1343

exc_info=error)

1344

return xmlstring

1345

1346

1347

class DBusObjectWithProperties(DBusObjectWithAnnotations):

792

class DBusObjectWithProperties(dbus.service.Object):

1348

793

"""A D-Bus object with properties.

1349

794

1350

795

Classes inheriting from this can use the dbus_service_property

1351

796

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

1352

797

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

1353

798

"""

1354

799

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

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

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

1355

812

def _get_dbus_property(self, interface_name, property_name):

1356

813

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

1357

814

property with the specified name and interface.

1358

815

"""

1359

for cls in self.__class__.__mro__:

1360

for name, value in inspect.getmembers(

1361

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

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1362

819

if (value._dbus_name == property_name

1363

820

and value._dbus_interface == interface_name):

1364

821

return value.__get__(self)

1365

822

1366

823

# No such property

1367

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

1368

self.dbus_object_path, interface_name, property_name))

1369

1370

@classmethod

1371

def _get_all_interface_names(cls):

1372

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

1373

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

1374

"_dbus_interface", None)

1375

for x in (inspect.getmro(cls))

1376

for attr in dir(x))

1377

if name is not None)

1378

1379

@dbus.service.method(dbus.PROPERTIES_IFACE,

1380

in_signature="ss",

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

1381

829

out_signature="v")

1382

830

def Get(self, interface_name, property_name):

1383

831

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

1389

837

if not hasattr(value, "variant_level"):

1390

838

return value

1391

839

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

1392

840

1393

841

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

1394

842

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

1395

843

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

1401

849

# The byte_arrays option is not supported yet on

1402

850

# signatures other than "ay".

1403

851

if prop._dbus_signature != "ay":

1404

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

1405

"'ay' signature {!r}"

1406

.format(prop._dbus_signature))

852

raise ValueError

1407

853

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

1408

854

for byte in value))

1409

855

prop(value)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="s",

856

857

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

1413

858

out_signature="a{sv}")

1414

859

def GetAll(self, interface_name):

1415

860

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

1416

861

standard.

1417

862

1418

863

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

1419

864

"""

1420

865

properties = {}

1421

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

866

for name, prop in self._get_all_dbus_properties():

1422

867

if (interface_name

1423

868

and interface_name != prop._dbus_interface):

1424

869

# Interface non-empty but did not match

1430

875

if not hasattr(value, "variant_level"):

1431

876

properties[name] = value

1432

877

continue

1433

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

878

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

879

value.variant_level+1)

1435

880

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

1436

1437

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

1438

def PropertiesChanged(self, interface_name, changed_properties,

1439

invalidated_properties):

1440

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

1441

standard.

1442

"""

1443

pass

1444

881

1445

882

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1446

883

out_signature="s",

1447

884

path_keyword='object_path',

1448

885

connection_keyword='connection')

1449

886

def Introspect(self, object_path, connection):

1450

"""Overloading of standard D-Bus method.

1451

1452

Inserts property tags and interface annotation tags.

887

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

1453

888

"""

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

889

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

890

connection)

1457

891

try:

1458

892

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

1459

1460

893

def make_tag(document, name, prop):

1461

894

e = document.createElement("property")

1462

895

e.setAttribute("name", name)

1463

896

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

1464

897

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

1465

898

return e

1466

1467

899

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

1468

# Add property tags

1469

900

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

1470

901

for name, prop

1471

in self._get_all_dbus_things("property")

902

in self._get_all_dbus_properties()

1472

903

if prop._dbus_interface

1473

904

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

1474

905

if_tag.appendChild(tag)

1475

# Add annotation tags for properties

1476

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

1477

annots = dict()

1478

for name, prop in self._get_all_dbus_things(

1479

"property"):

1480

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

1481

and prop._dbus_interface

1482

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

1483

annots.update(getattr(

1484

prop, "_dbus_annotations", {}))

1485

for name, value in annots.items():

1486

ann_tag = document.createElement(

1487

"annotation")

1488

ann_tag.setAttribute("name", name)

1489

ann_tag.setAttribute("value", value)

1490

tag.appendChild(ann_tag)

1491

906

# Add the names to the return values for the

1492

907

# "org.freedesktop.DBus.Properties" methods

1493

908

if (if_tag.getAttribute("name")

1508

923

except (AttributeError, xml.dom.DOMException,

1509

924

xml.parsers.expat.ExpatError) as error:

1510

925

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

1511

exc_info=error)

1512

return xmlstring

1513

1514

1515

try:

1516

dbus.OBJECT_MANAGER_IFACE

1517

except AttributeError:

1518

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

1519

1520

1521

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1522

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

1523

1524

Classes inheriting from this exposes the standard

1525

GetManagedObjects call and the InterfacesAdded and

1526

InterfacesRemoved signals on the standard

1527

"org.freedesktop.DBus.ObjectManager" interface.

1528

1529

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

1530

manually.

1531

"""

1532

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1533

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

1534

def GetManagedObjects(self):

1535

"""This function must be overridden"""

1536

raise NotImplementedError()

1537

1538

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def InterfacesAdded(self, object_path, interfaces_and_properties):

1541

pass

1542

1543

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

1544

def InterfacesRemoved(self, object_path, interfaces):

1545

pass

1546

1547

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1548

out_signature="s",

1549

path_keyword='object_path',

1550

connection_keyword='connection')

1551

def Introspect(self, object_path, connection):

1552

"""Overloading of standard D-Bus method.

1553

1554

Override return argument name of GetManagedObjects to be

1555

"objpath_interfaces_and_properties"

1556

"""

1557

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1558

object_path,

1559

connection)

1560

try:

1561

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

1562

1563

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

1564

# Fix argument name for the GetManagedObjects method

1565

if (if_tag.getAttribute("name")

1566

== dbus.OBJECT_MANAGER_IFACE):

1567

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

1568

if (cn.getAttribute("name")

1569

== "GetManagedObjects"):

1570

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

1571

if (arg.getAttribute("direction")

1572

== "out"):

1573

arg.setAttribute(

1574

"name",

1575

"objpath_interfaces"

1576

"_and_properties")

1577

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

1578

document.unlink()

1579

except (AttributeError, xml.dom.DOMException,

1580

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

def datetime_to_dbus(dt, variant_level=0):

926

error)

927

return xmlstring

928

929

930

def datetime_to_dbus (dt, variant_level=0):

1587

931

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

1588

932

if dt is None:

1589

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

1590

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

1591

1592

1593

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1594

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

1595

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

1596

interface names according to the "alt_interface_names" mapping.

1597

Usage:

1598

1599

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

1600

"net.example.AlternateInterface"})

1601

class SampleDBusObject(dbus.service.Object):

1602

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

1603

def SampleDBusMethod():

1604

pass

1605

1606

The above "SampleDBusMethod" on "SampleDBusObject" will be

1607

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

1608

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

1609

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

1610

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

1611

1612

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

1613

(from DBusObjectWithProperties) and interfaces (from the

1614

dbus_interface_annotations decorator).

933

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

1615

942

"""

1616

1617

def wrapper(cls):

1618

for orig_interface_name, alt_interface_name in (

1619

alt_interface_names.items()):

1620

attr = {}

1621

interface_names = set()

1622

# Go though all attributes of the class

1623

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

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

1624

950

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

1625

951

# with the wrong interface name

1626

952

if (not hasattr(attribute, "_dbus_interface")

1627

or not attribute._dbus_interface.startswith(

1628

orig_interface_name)):

953

or not attribute._dbus_interface

954

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

1629

955

continue

1630

956

# Create an alternate D-Bus interface name based on

1631

957

# the current name

1632

alt_interface = attribute._dbus_interface.replace(

1633

orig_interface_name, alt_interface_name)

1634

interface_names.add(alt_interface)

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1635

961

# Is this a D-Bus signal?

1636

962

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

1637

# Extract the original non-method undecorated

1638

# function by black magic

1639

if sys.version_info.major == 2:

1640

nonmethod_func = (dict(

963

# Extract the original non-method function by

964

# black magic

965

nonmethod_func = (dict(

1641

966

zip(attribute.func_code.co_freevars,

1642

attribute.__closure__))

1643

["func"].cell_contents)

1644

else:

1645

nonmethod_func = (dict(

1646

zip(attribute.__code__.co_freevars,

1647

attribute.__closure__))

1648

["func"].cell_contents)

967

attribute.__closure__))["func"]

968

.cell_contents)

1649

969

# Create a new, but exactly alike, function

1650

970

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

1651

971

# with the alternate D-Bus interface name

1652

new_function = copy_function(nonmethod_func)

1653

new_function = (dbus.service.signal(

1654

alt_interface,

1655

attribute._dbus_signature)(new_function))

1656

# Copy annotations, if any

1657

try:

1658

new_function._dbus_annotations = dict(

1659

attribute._dbus_annotations)

1660

except AttributeError:

1661

pass

1662

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

nonmethod_func.func_closure)))

1663

981

# Define a creator of a function to call both the

1664

# original and alternate functions, so both the

1665

# original and alternate signals gets sent when

1666

# the function is called

982

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

983

# signals gets sent when the function is called

1667

984

def fixscope(func1, func2):

1668

985

"""This function is a scope container to pass

1669

986

func1 and func2 to the "call_both" function

1670

987

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1673

988

def call_both(*args, **kwargs):

1674

989

"""This function will emit two D-Bus

1675

990

signals by calling func1 and func2"""

1676

991

func1(*args, **kwargs)

1677

992

func2(*args, **kwargs)

1678

# Make wrapper function look like a D-Bus

1679

# signal

1680

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

1681

if name.startswith("_dbus_"):

1682

setattr(call_both, name, attr)

1683

1684

993

return call_both

1685

994

# Create the "call_both" function and add it to

1686

995

# the class

1687

attr[attrname] = fixscope(attribute, new_function)

996

attr[attrname] = fixscope(attribute,

997

new_function)

1688

998

# Is this a D-Bus method?

1689

999

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

1690

1000

# Create a new, but exactly alike, function

1691

1001

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

1692

1002

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

1693

1003

# to the class.

1694

attr[attrname] = (

1695

dbus.service.method(

1696

alt_interface,

1697

attribute._dbus_in_signature,

1698

attribute._dbus_out_signature)

1699

(copy_function(attribute)))

1700

# Copy annotations, if any

1701

try:

1702

attr[attrname]._dbus_annotations = dict(

1703

attribute._dbus_annotations)

1704

except AttributeError:

1705

pass

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

attribute.func_closure)))

1706

1014

# Is this a D-Bus property?

1707

1015

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

1708

1016

# Create a new, but exactly alike, function

1709

1017

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

1710

1018

# property with the alternate D-Bus interface

1711

1019

# name. Add it to the class.

1712

attr[attrname] = (dbus_service_property(

1713

alt_interface, attribute._dbus_signature,

1714

attribute._dbus_access,

1715

attribute._dbus_get_args_options

1716

["byte_arrays"])

1717

(copy_function(attribute)))

1718

# Copy annotations, if any

1719

try:

1720

attr[attrname]._dbus_annotations = dict(

1721

attribute._dbus_annotations)

1722

except AttributeError:

1723

pass

1724

# Is this a D-Bus interface?

1725

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

1726

# Create a new, but exactly alike, function

1727

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

1728

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

1729

# to the class.

1730

attr[attrname] = (

1731

dbus_interface_annotations(alt_interface)

1732

(copy_function(attribute)))

1733

if deprecate:

1734

# Deprecate all alternate interfaces

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1736

for interface_name in interface_names:

1737

1738

@dbus_interface_annotations(interface_name)

1739

def func(self):

1740

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

1741

"true"}

1742

# Find an unused name

1743

for aname in (iname.format(i)

1744

for i in itertools.count()):

1745

if aname not in attr:

1746

attr[aname] = func

1747

break

1748

if interface_names:

1749

# Replace the class with a new subclass of it with

1750

# methods, signals, etc. as created above.

1751

if sys.version_info.major == 2:

1752

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

1753

(cls, ), attr)

1754

else:

1755

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

1756

(cls, ), attr)

1757

return cls

1758

1759

return wrapper

1760

1761

1762

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

1763

"se.bsnet.fukt.Mandos"})

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

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

1034

1035

1764

1036

class ClientDBus(Client, DBusObjectWithProperties):

1765

1037

"""A Client class using D-Bus

1766

1038

1767

1039

Attributes:

1768

1040

dbus_object_path: dbus.ObjectPath

1769

1041

bus: dbus.SystemBus()

1770

1042

"""

1771

1043

1772

1044

runtime_expansions = (Client.runtime_expansions

1773

+ ("dbus_object_path", ))

1774

1775

_interface = "se.recompile.Mandos.Client"

1776

1045

+ ("dbus_object_path",))

1046

1777

1047

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

1778

1779

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

1048

1049

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

1780

1050

self.bus = bus

1781

1051

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

1052

self._approvals_pending = 0

1053

1054

self._approvals_pending = 0

1782

1055

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

1783

1056

# the D-Bus

1784

client_object_name = str(self.name).translate(

1057

client_object_name = unicode(self.name).translate(

1785

1058

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

1786

1059

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

1787

self.dbus_object_path = dbus.ObjectPath(

1788

"/clients/" + client_object_name)

1060

self.dbus_object_path = (dbus.ObjectPath

1061

("/clients/" + client_object_name))

1789

1062

DBusObjectWithProperties.__init__(self, self.bus,

1790

1063

self.dbus_object_path)

1791

1792

def notifychangeproperty(transform_func, dbus_name,

1793

type_func=lambda x: x,

1794

variant_level=1,

1795

invalidate_only=False,

1796

_interface=_interface):

1064

1065

def notifychangeproperty(transform_func,

1066

dbus_name, type_func=lambda x: x,

1067

variant_level=1):

1797

1068

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

1798

1069

its changes to DBus.

1799

1070

1800

1071

transform_fun: Function that takes a value and a variant_level

1801

1072

and transforms it to a D-Bus type.

1802

1073

dbus_name: D-Bus name of the variable

1804

1075

to the D-Bus. Default: no transform

1805

1076

variant_level: D-Bus variant level. Default: 1

1806

1077

"""

1807

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

1808

1078

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

1809

1079

def setter(self, value):

1810

1080

if hasattr(self, "dbus_object_path"):

1811

1081

if (not hasattr(self, attrname) or

1812

1082

type_func(getattr(self, attrname, None))

1813

1083

!= type_func(value)):

1814

if invalidate_only:

1815

self.PropertiesChanged(

1816

_interface, dbus.Dictionary(),

1817

dbus.Array((dbus_name, )))

1818

else:

1819

dbus_value = transform_func(

1820

type_func(value),

1821

variant_level=variant_level)

1822

self.PropertyChanged(dbus.String(dbus_name),

1823

dbus_value)

1824

self.PropertiesChanged(

1825

_interface,

1826

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

1827

dbus_value}),

1828

dbus.Array())

1084

dbus_value = transform_func(type_func(value),

1085

variant_level

1086

=variant_level)

1087

self.PropertyChanged(dbus.String(dbus_name),

1088

dbus_value)

1829

1089

setattr(self, attrname, value)

1830

1090

1831

1091

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

1832

1092

1093

1833

1094

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1834

1095

approvals_pending = notifychangeproperty(dbus.Boolean,

1835

1096

"ApprovalPending",

1836

type_func=bool)

1097

type_func = bool)

1837

1098

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

1838

1099

last_enabled = notifychangeproperty(datetime_to_dbus,

1839

1100

"LastEnabled")

1840

checker = notifychangeproperty(

1841

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1101

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

1102

type_func = lambda checker:

1103

checker is not None)

1843

1104

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1844

1105

"LastCheckedOK")

1845

last_checker_status = notifychangeproperty(dbus.Int16,

1846

"LastCheckerStatus")

1847

1106

last_approval_request = notifychangeproperty(

1848

1107

datetime_to_dbus, "LastApprovalRequest")

1849

1108

approved_by_default = notifychangeproperty(dbus.Boolean,

1850

1109

"ApprovedByDefault")

1851

approval_delay = notifychangeproperty(

1852

dbus.UInt64, "ApprovalDelay",

1853

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

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1854

1114

approval_duration = notifychangeproperty(

1855

1115

dbus.UInt64, "ApprovalDuration",

1856

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

1116

type_func = timedelta_to_milliseconds)

1857

1117

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

1858

timeout = notifychangeproperty(

1859

dbus.UInt64, "Timeout",

1860

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1861

1121

extended_timeout = notifychangeproperty(

1862

1122

dbus.UInt64, "ExtendedTimeout",

1863

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

1864

interval = notifychangeproperty(

1865

dbus.UInt64, "Interval",

1866

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)

1867

1128

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

1868

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

1869

invalidate_only=True)

1870

1129

1871

1130

del notifychangeproperty

1872

1131

1873

1132

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

1874

1133

try:

1875

1134

self.remove_from_connection()

1878

1137

if hasattr(DBusObjectWithProperties, "__del__"):

1879

1138

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

1880

1139

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

1881

1882

def checker_callback(self, source, condition,

1883

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

1884

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

1885

connection, command, *args,

1886

**kwargs)

1887

exitstatus = self.last_checker_status

1888

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)

1889

1147

# Emit D-Bus signal

1890

1148

self.CheckerCompleted(dbus.Int16(exitstatus),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1149

dbus.Int64(condition),

1893

1150

dbus.String(command))

1894

1151

else:

1895

1152

# Emit D-Bus signal

1896

1153

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

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1154

dbus.Int64(condition),

1901

1155

dbus.String(command))

1902

return ret

1903

1156

1157

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

1158

*args, **kwargs)

1159

1904

1160

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

1905

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

1906

1166

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

1907

1167

# Only if new checker process was started

1908

1168

if (self.checker is not None

1910

1170

# Emit D-Bus signal

1911

1171

self.CheckerStarted(self.current_checker_command)

1912

1172

return r

1913

1173

1914

1174

def _reset_approved(self):

1915

1175

self.approved = None

1916

1176

return False

1917

1177

1918

1178

def approve(self, value=True):

1179

self.send_changedstate()

1919

1180

self.approved = value

1920

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

1921

* 1000), self._reset_approved)

1922

self.send_changedstate()

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

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

1930

1191

# CheckerCompleted - signal

1931

1192

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

1932

1193

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

1933

1194

"D-Bus signal"

1934

1195

pass

1935

1196

1936

1197

# CheckerStarted - signal

1937

1198

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

1938

1199

def CheckerStarted(self, command):

1939

1200

"D-Bus signal"

1940

1201

pass

1941

1202

1942

1203

# PropertyChanged - signal

1943

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

1944

1204

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

1945

1205

def PropertyChanged(self, property, value):

1946

1206

"D-Bus signal"

1947

1207

pass

1948

1208

1949

1209

# GotSecret - signal

1950

1210

@dbus.service.signal(_interface)

1951

1211

def GotSecret(self):

1954

1214

server to mandos-client

1955

1215

"""

1956

1216

pass

1957

1217

1958

1218

# Rejected - signal

1959

1219

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

1960

1220

def Rejected(self, reason):

1961

1221

"D-Bus signal"

1962

1222

pass

1963

1223

1964

1224

# NeedApproval - signal

1965

1225

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

1966

1226

def NeedApproval(self, timeout, default):

1967

1227

"D-Bus signal"

1968

1228

return self.need_approval()

1969

1970

# Methods

1971

1229

1230

# NeRwequest - signal

1231

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

1232

def NewRequest(self, ip):

1233

"""D-Bus signal

1234

Is sent after a client request a password.

1235

"""

1236

pass

1237

1238

## Methods

1239

1972

1240

# Approve - method

1973

1241

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

1974

1242

def Approve(self, value):

1975

1243

self.approve(value)

1976

1244

1977

1245

# CheckedOK - method

1978

1246

@dbus.service.method(_interface)

1979

1247

def CheckedOK(self):

1980

1248

self.checked_ok()

1981

1249

1982

1250

# Enable - method

1983

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

1984

1251

@dbus.service.method(_interface)

1985

1252

def Enable(self):

1986

1253

"D-Bus method"

1987

1254

self.enable()

1988

1255

1989

1256

# StartChecker - method

1990

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

1991

1257

@dbus.service.method(_interface)

1992

1258

def StartChecker(self):

1993

1259

"D-Bus method"

1994

1260

self.start_checker()

1995

1261

1996

1262

# Disable - method

1997

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

1998

1263

@dbus.service.method(_interface)

1999

1264

def Disable(self):

2000

1265

"D-Bus method"

2001

1266

self.disable()

2002

1267

2003

1268

# StopChecker - method

2004

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

2005

1269

@dbus.service.method(_interface)

2006

1270

def StopChecker(self):

2007

1271

self.stop_checker()

2008

2009

# Properties

2010

1272

1273

## Properties

1274

2011

1275

# ApprovalPending - property

2012

1276

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

2013

1277

def ApprovalPending_dbus_property(self):

2014

1278

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

2015

1279

2016

1280

# ApprovedByDefault - property

2017

@dbus_service_property(_interface,

2018

signature="b",

1281

@dbus_service_property(_interface, signature="b",

2019

1282

access="readwrite")

2020

1283

def ApprovedByDefault_dbus_property(self, value=None):

2021

1284

if value is None: # get

2022

1285

return dbus.Boolean(self.approved_by_default)

2023

1286

self.approved_by_default = bool(value)

2024

1287

2025

1288

# ApprovalDelay - property

2026

@dbus_service_property(_interface,

2027

signature="t",

1289

@dbus_service_property(_interface, signature="t",

2028

1290

access="readwrite")

2029

1291

def ApprovalDelay_dbus_property(self, value=None):

2030

1292

if value is None: # get

2031

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

2032

* 1000)

1293

return dbus.UInt64(self.approval_delay_milliseconds())

2033

1294

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

2034

1295

2035

1296

# ApprovalDuration - property

2036

@dbus_service_property(_interface,

2037

signature="t",

1297

@dbus_service_property(_interface, signature="t",

2038

1298

access="readwrite")

2039

1299

def ApprovalDuration_dbus_property(self, value=None):

2040

1300

if value is None: # get

2041

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

2042

* 1000)

1301

return dbus.UInt64(timedelta_to_milliseconds(

1302

self.approval_duration))

2043

1303

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

2044

1304

2045

1305

# Name - property

2046

@dbus_annotations(

2047

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

2048

1306

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

2049

1307

def Name_dbus_property(self):

2050

1308

return dbus.String(self.name)

2051

2052

# KeyID - property

2053

@dbus_annotations(

2054

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

2055

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

2056

def KeyID_dbus_property(self):

2057

return dbus.String(self.key_id)

2058

1309

2059

1310

# Fingerprint - property

2060

@dbus_annotations(

2061

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

2062

1311

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

2063

1312

def Fingerprint_dbus_property(self):

2064

1313

return dbus.String(self.fingerprint)

2065

1314

2066

1315

# Host - property

2067

@dbus_service_property(_interface,

2068

signature="s",

1316

@dbus_service_property(_interface, signature="s",

2069

1317

access="readwrite")

2070

1318

def Host_dbus_property(self, value=None):

2071

1319

if value is None: # get

2072

1320

return dbus.String(self.host)

2073

self.host = str(value)

2074

1321

self.host = unicode(value)

1322

2075

1323

# Created - property

2076

@dbus_annotations(

2077

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

2078

1324

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

2079

1325

def Created_dbus_property(self):

2080

1326

return datetime_to_dbus(self.created)

2081

1327

2082

1328

# LastEnabled - property

2083

1329

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

2084

1330

def LastEnabled_dbus_property(self):

2085

1331

return datetime_to_dbus(self.last_enabled)

2086

1332

2087

1333

# Enabled - property

2088

@dbus_service_property(_interface,

2089

signature="b",

1334

@dbus_service_property(_interface, signature="b",

2090

1335

access="readwrite")

2091

1336

def Enabled_dbus_property(self, value=None):

2092

1337

if value is None: # get

2095

1340

self.enable()

2096

1341

else:

2097

1342

self.disable()

2098

1343

2099

1344

# LastCheckedOK - property

2100

@dbus_service_property(_interface,

2101

signature="s",

1345

@dbus_service_property(_interface, signature="s",

2102

1346

access="readwrite")

2103

1347

def LastCheckedOK_dbus_property(self, value=None):

2104

1348

if value is not None:

2105

1349

self.checked_ok()

2106

1350

return

2107

1351

return datetime_to_dbus(self.last_checked_ok)

2108

2109

# LastCheckerStatus - property

2110

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

2111

def LastCheckerStatus_dbus_property(self):

2112

return dbus.Int16(self.last_checker_status)

2113

1352

2114

1353

# Expires - property

2115

1354

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

2116

1355

def Expires_dbus_property(self):

2117

1356

return datetime_to_dbus(self.expires)

2118

1357

2119

1358

# LastApprovalRequest - property

2120

1359

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

2121

1360

def LastApprovalRequest_dbus_property(self):

2122

1361

return datetime_to_dbus(self.last_approval_request)

2123

1362

2124

1363

# Timeout - property

2125

@dbus_service_property(_interface,

2126

signature="t",

1364

@dbus_service_property(_interface, signature="t",

2127

1365

access="readwrite")

2128

1366

def Timeout_dbus_property(self, value=None):

2129

1367

if value is None: # get

2130

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

2131

old_timeout = self.timeout

1368

return dbus.UInt64(self.timeout_milliseconds())

2132

1369

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

2133

# Reschedule disabling

1370

# Reschedule timeout

2134

1371

if self.enabled:

2135

1372

now = datetime.datetime.utcnow()

2136

self.expires += self.timeout - old_timeout

2137

if self.expires <= now:

1373

time_to_die = timedelta_to_milliseconds(

1374

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

1375

if time_to_die <= 0:

2138

1376

# The timeout has passed

2139

1377

self.disable()

2140

1378

else:

1379

self.expires = (now +

1380

datetime.timedelta(milliseconds =

1381

time_to_die))

2141

1382

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

2142

1383

is None):

2143

1384

return

2144

GLib.source_remove(self.disable_initiator_tag)

2145

self.disable_initiator_tag = GLib.timeout_add(

2146

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

2147

self.disable)

2148

1385

gobject.source_remove(self.disable_initiator_tag)

1386

self.disable_initiator_tag = (gobject.timeout_add

1387

(time_to_die,

1388

self.disable))

1389

2149

1390

# ExtendedTimeout - property

2150

@dbus_service_property(_interface,

2151

signature="t",

1391

@dbus_service_property(_interface, signature="t",

2152

1392

access="readwrite")

2153

1393

def ExtendedTimeout_dbus_property(self, value=None):

2154

1394

if value is None: # get

2155

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

2156

* 1000)

1395

return dbus.UInt64(self.extended_timeout_milliseconds())

2157

1396

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

2158

1397

2159

1398

# Interval - property

2160

@dbus_service_property(_interface,

2161

signature="t",

1399

@dbus_service_property(_interface, signature="t",

2162

1400

access="readwrite")

2163

1401

def Interval_dbus_property(self, value=None):

2164

1402

if value is None: # get

2165

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

1403

return dbus.UInt64(self.interval_milliseconds())

2166

1404

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

2167

1405

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

2168

1406

return

2169

1407

if self.enabled:

2170

1408

# Reschedule checker run

2171

GLib.source_remove(self.checker_initiator_tag)

2172

self.checker_initiator_tag = GLib.timeout_add(

2173

value, self.start_checker)

2174

self.start_checker() # Start one now, too

2175

1409

gobject.source_remove(self.checker_initiator_tag)

1410

self.checker_initiator_tag = (gobject.timeout_add

1411

(value, self.start_checker))

1412

self.start_checker() # Start one now, too

1413

2176

1414

# Checker - property

2177

@dbus_service_property(_interface,

2178

signature="s",

1415

@dbus_service_property(_interface, signature="s",

2179

1416

access="readwrite")

2180

1417

def Checker_dbus_property(self, value=None):

2181

1418

if value is None: # get

2182

1419

return dbus.String(self.checker_command)

2183

self.checker_command = str(value)

2184

1420

self.checker_command = unicode(value)

1421

2185

1422

# CheckerRunning - property

2186

@dbus_service_property(_interface,

2187

signature="b",

1423

@dbus_service_property(_interface, signature="b",

2188

1424

access="readwrite")

2189

1425

def CheckerRunning_dbus_property(self, value=None):

2190

1426

if value is None: # get

2193

1429

self.start_checker()

2194

1430

else:

2195

1431

self.stop_checker()

2196

1432

2197

1433

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

2201

1434

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

2202

1435

def ObjectPath_dbus_property(self):

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1436

return self.dbus_object_path # is already a dbus.ObjectPath

1437

2205

1438

# Secret = property

2206

@dbus_annotations(

2207

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

2208

"invalidates"})

2209

@dbus_service_property(_interface,

2210

signature="ay",

2211

access="write",

2212

byte_arrays=True)

1439

@dbus_service_property(_interface, signature="ay",

1440

access="write", byte_arrays=True)

2213

1441

def Secret_dbus_property(self, value):

2214

self.secret = bytes(value)

2215

1442

self.secret = str(value)

1443

2216

1444

del _interface

2217

1445

2218

1446

2219

class ProxyClient:

2220

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

1447

class ProxyClient(object):

1448

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

2221

1449

self._pipe = child_pipe

2222

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

1450

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

2223

1451

if not self._pipe.recv():

2224

raise KeyError(key_id or fpr)

2225

1452

raise KeyError()

1453

2226

1454

def __getattribute__(self, name):

2227

1455

if name == '_pipe':

2228

1456

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

2231

1459

if data[0] == 'data':

2232

1460

return data[1]

2233

1461

if data[0] == 'function':

2234

2235

1462

def func(*args, **kwargs):

2236

1463

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

2237

1464

return self._pipe.recv()[1]

2238

2239

1465

return func

2240

1466

2241

1467

def __setattr__(self, name, value):

2242

1468

if name == '_pipe':

2243

1469

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

2244

1470

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

2245

1471

2246

1472

1473

class ClientDBusTransitional(ClientDBus):

1474

__metaclass__ = AlternateDBusNamesMetaclass

1475

1476

2247

1477

class ClientHandler(socketserver.BaseRequestHandler, object):

2248

1478

"""A class to handle client connections.

2249

1479

2250

1480

Instantiated once for each connection to handle it.

2251

1481

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

2252

1482

2253

1483

def handle(self):

2254

1484

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

2255

1485

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

2256

str(self.client_address))

1486

unicode(self.client_address))

2257

1487

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

2258

1488

self.server.child_pipe.fileno())

2259

2260

session = gnutls.ClientSession(self.request)

2261

2262

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

2263

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

2264

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

2265

# "+DHE-DSS"))

1489

1490

session = (gnutls.connection

1491

.ClientSession(self.request,

1492

gnutls.connection

1493

.X509Credentials()))

1494

1495

# Note: gnutls.connection.X509Credentials is really a

1496

# generic GnuTLS certificate credentials object so long as

1497

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

1498

# here despite using OpenPGP certificates.

1499

1500

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

1501

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

1502

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

1503

# "+DHE-DSS"))

2266

1504

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

2267

1505

priority = self.server.gnutls_priority

2268

1506

if priority is None:

2269

1507

priority = "NORMAL"

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1508

(gnutls.library.functions

1509

.gnutls_priority_set_direct(session._c_object,

1510

priority, None))

1511

2274

1512

# Start communication using the Mandos protocol

2275

1513

# Get protocol number

2276

1514

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

2277

1515

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

2278

1516

try:

2279

1517

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

2280

raise RuntimeError(line)

1518

raise RuntimeError

2281

1519

except (ValueError, IndexError, RuntimeError) as error:

2282

1520

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

2283

1521

return

2284

1522

2285

1523

# Start GnuTLS connection

2286

1524

try:

2287

1525

session.handshake()

2288

except gnutls.Error as error:

1526

except gnutls.errors.GNUTLSError as error:

2289

1527

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

2290

1528

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

2291

1529

# established. Just abandon the request.

2292

1530

return

2293

1531

logger.debug("Handshake succeeded")

2294

1532

2295

1533

approval_required = False

2296

1534

try:

2297

if gnutls.has_rawpk:

2298

fpr = b""

2299

try:

2300

key_id = self.key_id(

2301

self.peer_certificate(session))

2302

except (TypeError, gnutls.Error) as error:

2303

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

2304

return

2305

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

2306

2307

else:

2308

key_id = b""

2309

try:

2310

fpr = self.fingerprint(

2311

self.peer_certificate(session))

2312

except (TypeError, gnutls.Error) as error:

2313

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

2314

return

2315

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

2316

2317

try:

2318

client = ProxyClient(child_pipe, key_id, fpr,

1535

try:

1536

fpr = self.fingerprint(self.peer_certificate

1537

(session))

1538

except (TypeError,

1539

gnutls.errors.GNUTLSError) as error:

1540

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

1541

return

1542

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

1543

1544

try:

1545

client = ProxyClient(child_pipe, fpr,

2319

1546

self.client_address)

2320

1547

except KeyError:

2321

1548

return

2322

1549

1550

if self.server.use_dbus:

1551

# Emit D-Bus signal

1552

client.NewRequest(str(self.client_address))

1553

2323

1554

if client.approval_delay:

2324

1555

delay = client.approval_delay

2325

1556

client.approvals_pending += 1

2326

1557

approval_required = True

2327

1558

2328

1559

while True:

2329

1560

if not client.enabled:

2330

1561

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

2331

client.name)

1562

client.name)

2332

1563

if self.server.use_dbus:

2333

1564

# Emit D-Bus signal

2334

1565

client.Rejected("Disabled")

2335

1566

return

2336

1567

2337

1568

if client.approved or not client.approval_delay:

2338

# We are approved or approval is disabled

1569

#We are approved or approval is disabled

2339

1570

break

2340

1571

elif client.approved is None:

2341

1572

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

2343

1574

if self.server.use_dbus:

2344

1575

# Emit D-Bus signal

2345

1576

client.NeedApproval(

2346

client.approval_delay.total_seconds()

2347

* 1000, client.approved_by_default)

1577

client.approval_delay_milliseconds(),

1578

client.approved_by_default)

2348

1579

else:

2349

1580

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

2350

1581

client.name)

2352

1583

# Emit D-Bus signal

2353

1584

client.Rejected("Denied")

2354

1585

return

2355

2356

# wait until timeout or approved

1586

1587

#wait until timeout or approved

2357

1588

time = datetime.datetime.now()

2358

1589

client.changedstate.acquire()

2359

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

1590

(client.changedstate.wait

1591

(float(client.timedelta_to_milliseconds(delay)

1592

/ 1000)))

2360

1593

client.changedstate.release()

2361

1594

time2 = datetime.datetime.now()

2362

1595

if (time2 - time) >= delay:

2372

1605

break

2373

1606

else:

2374

1607

delay -= time2 - time

2375

2376

try:

2377

session.send(client.secret)

2378

except gnutls.Error as error:

2379

logger.warning("gnutls send failed",

2380

exc_info=error)

2381

return

2382

1608

1609

sent_size = 0

1610

while sent_size < len(client.secret):

1611

try:

1612

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

1613

except gnutls.errors.GNUTLSError as error:

1614

logger.warning("gnutls send failed")

1615

return

1616

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

1617

sent, len(client.secret)

1618

- (sent_size + sent))

1619

sent_size += sent

1620

2383

1621

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

2384

1622

# bump the timeout using extended_timeout

2385

client.bump_timeout(client.extended_timeout)

1623

client.checked_ok(client.extended_timeout)

2386

1624

if self.server.use_dbus:

2387

1625

# Emit D-Bus signal

2388

1626

client.GotSecret()

2389

1627

2390

1628

finally:

2391

1629

if approval_required:

2392

1630

client.approvals_pending -= 1

2393

1631

try:

2394

1632

session.bye()

2395

except gnutls.Error as error:

2396

logger.warning("GnuTLS bye failed",

2397

exc_info=error)

2398

1633

except gnutls.errors.GNUTLSError as error:

1634

logger.warning("GnuTLS bye failed")

1635

2399

1636

@staticmethod

2400

1637

def peer_certificate(session):

2401

"Return the peer's certificate as a bytestring"

2402

try:

2403

cert_type = gnutls.certificate_type_get2(session._c_object,

2404

gnutls.CTYPE_PEERS)

2405

except AttributeError:

2406

cert_type = gnutls.certificate_type_get(session._c_object)

2407

if gnutls.has_rawpk:

2408

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2409

else:

2410

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2411

# If not a valid certificate type...

2412

if cert_type not in valid_cert_types:

2413

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

2414

valid_cert_types)

2415

# ...return invalid data

2416

return b""

1638

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

1639

# If not an OpenPGP certificate...

1640

if (gnutls.library.functions

1641

.gnutls_certificate_type_get(session._c_object)

1642

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1643

# ...do the normal thing

1644

return session.peer_certificate

2417

1645

list_size = ctypes.c_uint(1)

2418

cert_list = (gnutls.certificate_get_peers

1646

cert_list = (gnutls.library.functions

1647

.gnutls_certificate_get_peers

2419

1648

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

2420

1649

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

2421

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

1650

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

1651

" certificate")

2422

1652

if list_size.value == 0:

2423

1653

return None

2424

1654

cert = cert_list[0]

2425

1655

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

2426

2427

@staticmethod

2428

def key_id(certificate):

2429

"Convert a certificate bytestring to a hexdigit key ID"

2430

# New GnuTLS "datum" with the public key

2431

datum = gnutls.datum_t(

2432

ctypes.cast(ctypes.c_char_p(certificate),

2433

ctypes.POINTER(ctypes.c_ubyte)),

2434

ctypes.c_uint(len(certificate)))

2435

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

2436

# New empty GnuTLS certificate

2437

pubkey = gnutls.pubkey_t()

2438

gnutls.pubkey_init(ctypes.byref(pubkey))

2439

# Import the raw public key into the certificate

2440

gnutls.pubkey_import(pubkey,

2441

ctypes.byref(datum),

2442

gnutls.X509_FMT_DER)

2443

# New buffer for the key ID

2444

buf = ctypes.create_string_buffer(32)

2445

buf_len = ctypes.c_size_t(len(buf))

2446

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

2447

gnutls.pubkey_get_key_id(pubkey,

2448

gnutls.KEYID_USE_SHA256,

2449

ctypes.cast(ctypes.byref(buf),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.byref(buf_len))

2452

# Deinit the certificate

2453

gnutls.pubkey_deinit(pubkey)

2454

2455

# Convert the buffer to a Python bytestring

2456

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

2457

# Convert the bytestring to hexadecimal notation

2458

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

2459

return hex_key_id

2460

1656

2461

1657

@staticmethod

2462

1658

def fingerprint(openpgp):

2463

1659

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2464

1660

# New GnuTLS "datum" with the OpenPGP public key

2465

datum = gnutls.datum_t(

2466

ctypes.cast(ctypes.c_char_p(openpgp),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.c_uint(len(openpgp)))

1661

datum = (gnutls.library.types

1662

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

1663

ctypes.POINTER

1664

(ctypes.c_ubyte)),

1665

ctypes.c_uint(len(openpgp))))

2469

1666

# New empty GnuTLS certificate

2470

crt = gnutls.openpgp_crt_t()

2471

gnutls.openpgp_crt_init(ctypes.byref(crt))

1667

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1668

(gnutls.library.functions

1669

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2472

1670

# Import the OpenPGP public key into the certificate

2473

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

2474

gnutls.OPENPGP_FMT_RAW)

1671

(gnutls.library.functions

1672

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

1673

gnutls.library.constants

1674

.GNUTLS_OPENPGP_FMT_RAW))

2475

1675

# Verify the self signature in the key

2476

1676

crtverify = ctypes.c_uint()

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1677

(gnutls.library.functions

1678

.gnutls_openpgp_crt_verify_self(crt, 0,

1679

ctypes.byref(crtverify)))

2479

1680

if crtverify.value != 0:

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1681

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1682

raise (gnutls.errors.CertificateSecurityError

1683

("Verify failed"))

2483

1684

# New buffer for the fingerprint

2484

1685

buf = ctypes.create_string_buffer(20)

2485

1686

buf_len = ctypes.c_size_t()

2486

1687

# Get the fingerprint from the certificate into the buffer

2487

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

2488

ctypes.byref(buf_len))

1688

(gnutls.library.functions

1689

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

1690

ctypes.byref(buf_len)))

2489

1691

# Deinit the certificate

2490

gnutls.openpgp_crt_deinit(crt)

1692

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2491

1693

# Convert the buffer to a Python bytestring

2492

1694

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

2493

1695

# Convert the bytestring to hexadecimal notation

2495

1697

return hex_fpr

2496

1698

2497

1699

2498

class MultiprocessingMixIn:

1700

class MultiprocessingMixIn(object):

2499

1701

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

2500

2501

1702

def sub_process_main(self, request, address):

2502

1703

try:

2503

1704

self.finish_request(request, address)

2504

1705

except Exception:

2505

1706

self.handle_error(request, address)

2506

1707

self.close_request(request)

2507

1708

2508

1709

def process_request(self, request, address):

2509

1710

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

2510

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

2511

args=(request, address))

1711

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

1712

args = (request,

1713

address))

2512

1714

proc.start()

2513

1715

return proc

2514

1716

2515

1717

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1718

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2517

1719

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

2518

2519

1720

def process_request(self, request, client_address):

2520

1721

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

2521

1722

2522

1723

This function creates a new pipe in self.pipe

2523

1724

"""

2524

1725

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2525

1726

2526

1727

proc = MultiprocessingMixIn.process_request(self, request,

2527

1728

client_address)

2528

1729

self.child_pipe.close()

2529

1730

self.add_pipe(parent_pipe, proc)

2530

1731

2531

1732

def add_pipe(self, parent_pipe, proc):

2532

1733

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

2533

raise NotImplementedError()

1734

raise NotImplementedError

2534

1735

2535

1736

2536

1737

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2537

socketserver.TCPServer):

1738

socketserver.TCPServer, object):

2538

1739

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

2539

1740

2540

1741

Attributes:

2541

1742

enabled: Boolean; whether this server is activated yet

2542

1743

interface: None or a network interface name (string)

2543

1744

use_ipv6: Boolean; to use IPv6 or not

2544

1745

"""

2545

2546

1746

def __init__(self, server_address, RequestHandlerClass,

2547

interface=None,

2548

use_ipv6=True,

2549

socketfd=None):

2550

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

2551

creating a new one with socket.socket().

2552

"""

1747

interface=None, use_ipv6=True):

2553

1748

self.interface = interface

2554

1749

if use_ipv6:

2555

1750

self.address_family = socket.AF_INET6

2556

if socketfd is not None:

2557

# Save the file descriptor

2558

self.socketfd = socketfd

2559

# Save the original socket.socket() function

2560

self.socket_socket = socket.socket

2561

2562

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

2563

#

2564

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

2565

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

2566

# patching socket.socket.)

2567

#

2568

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

2569

@functools.wraps(socket.socket)

2570

def socket_wrapper(*args, **kwargs):

2571

# Restore original function so subsequent calls are

2572

# not affected.

2573

socket.socket = self.socket_socket

2574

del self.socket_socket

2575

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

2576

# saved file descriptor.

2577

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

2578

# Replace socket.socket() function with wrapper

2579

socket.socket = socket_wrapper

2580

# The socketserver.TCPServer.__init__ will call

2581

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

2582

# socket_wrapper(), if socketfd was set.

2583

1751

socketserver.TCPServer.__init__(self, server_address,

2584

1752

RequestHandlerClass)

2585

2586

1753

def server_bind(self):

2587

1754

"""This overrides the normal server_bind() function

2588

1755

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

2589

1756

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

2590

global SO_BINDTODEVICE

2591

1757

if self.interface is not None:

2592

1758

if SO_BINDTODEVICE is None:

2593

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

2594

# common enough.

2595

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

2596

SO_BINDTODEVICE = 25

2597

try:

2598

self.socket.setsockopt(

2599

socket.SOL_SOCKET, SO_BINDTODEVICE,

2600

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

2601

except socket.error as error:

2602

if error.errno == errno.EPERM:

2603

logger.error("No permission to bind to"

2604

" interface %s", self.interface)

2605

elif error.errno == errno.ENOPROTOOPT:

2606

logger.error("SO_BINDTODEVICE not available;"

2607

" cannot bind to interface %s",

2608

self.interface)

2609

elif error.errno == errno.ENODEV:

2610

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

2611

" cannot bind", self.interface)

2612

else:

2613

raise

1759

logger.error("SO_BINDTODEVICE does not exist;"

1760

" cannot bind to interface %s",

1761

self.interface)

1762

else:

1763

try:

1764

self.socket.setsockopt(socket.SOL_SOCKET,

1765

SO_BINDTODEVICE,

1766

str(self.interface

1767

+ '\0'))

1768

except socket.error as error:

1769

if error[0] == errno.EPERM:

1770

logger.error("No permission to"

1771

" bind to interface %s",

1772

self.interface)

1773

elif error[0] == errno.ENOPROTOOPT:

1774

logger.error("SO_BINDTODEVICE not available;"

1775

" cannot bind to interface %s",

1776

self.interface)

1777

else:

1778

raise

2614

1779

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

2615

1780

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

2618

1781

if not self.server_address[0]:

2619

1782

if self.address_family == socket.AF_INET6:

2620

any_address = "::" # in6addr_any

1783

any_address = "::" # in6addr_any

2621

1784

else:

2622

any_address = "0.0.0.0" # INADDR_ANY

1785

any_address = socket.INADDR_ANY

2623

1786

self.server_address = (any_address,

2624

1787

self.server_address[1])

2625

1788

elif not self.server_address[1]:

2626

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

1789

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

1790

0)

2627

1791

# if self.interface:

2628

1792

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

2629

1793

# 0, # port

2635

1799

2636

1800

class MandosServer(IPv6_TCPServer):

2637

1801

"""Mandos server.

2638

1802

2639

1803

Attributes:

2640

1804

clients: set of Client objects

2641

1805

gnutls_priority GnuTLS priority string

2642

1806

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

2643

2644

Assumes a GLib.MainLoop event loop.

1807

1808

Assumes a gobject.MainLoop event loop.

2645

1809

"""

2646

2647

1810

def __init__(self, server_address, RequestHandlerClass,

2648

interface=None,

2649

use_ipv6=True,

2650

clients=None,

2651

gnutls_priority=None,

2652

use_dbus=True,

2653

socketfd=None):

1811

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

1812

gnutls_priority=None, use_dbus=True):

2654

1813

self.enabled = False

2655

1814

self.clients = clients

2656

1815

if self.clients is None:

2659

1818

self.gnutls_priority = gnutls_priority

2660

1819

IPv6_TCPServer.__init__(self, server_address,

2661

1820

RequestHandlerClass,

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

1821

interface = interface,

1822

use_ipv6 = use_ipv6)

2666

1823

def server_activate(self):

2667

1824

if self.enabled:

2668

1825

return socketserver.TCPServer.server_activate(self)

2669

1826

2670

1827

def enable(self):

2671

1828

self.enabled = True

2672

1829

2673

1830

def add_pipe(self, parent_pipe, proc):

2674

1831

# Call "handle_ipc" for both data and EOF events

2675

GLib.io_add_watch(

2676

parent_pipe.fileno(),

2677

GLib.IO_IN | GLib.IO_HUP,

2678

functools.partial(self.handle_ipc,

2679

parent_pipe=parent_pipe,

2680

proc=proc))

2681

2682

def handle_ipc(self, source, condition,

2683

parent_pipe=None,

2684

proc=None,

2685

client_object=None):

1832

gobject.io_add_watch(parent_pipe.fileno(),

1833

gobject.IO_IN | gobject.IO_HUP,

1834

functools.partial(self.handle_ipc,

1835

parent_pipe =

1836

parent_pipe,

1837

proc = proc))

1838

1839

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

1840

proc = None, client_object=None):

1841

condition_names = {

1842

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

1843

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

1844

# blocking).

1845

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

1846

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

1847

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

1848

# broken, usually for pipes and

1849

# sockets).

1850

}

1851

conditions_string = ' | '.join(name

1852

for cond, name in

1853

condition_names.iteritems()

1854

if cond & condition)

2686

1855

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

2687

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

1856

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

2688

1857

# Wait for other process to exit

2689

1858

proc.join()

2690

1859

return False

2691

1860

2692

1861

# Read a request from the child

2693

1862

request = parent_pipe.recv()

2694

1863

command = request[0]

2695

1864

2696

1865

if command == 'init':

2697

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

2698

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

2699

address = request[3]

2700

2701

for c in self.clients.values():

2702

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2703

continue

2704

if key_id and c.key_id == key_id:

2705

client = c

2706

break

2707

if fpr and c.fingerprint == fpr:

1866

fpr = request[1]

1867

address = request[2]

1868

1869

for c in self.clients.itervalues():

1870

if c.fingerprint == fpr:

2708

1871

client = c

2709

1872

break

2710

1873

else:

2711

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

2712

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

1874

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

1875

"dress: %s", fpr, address)

2713

1876

if self.use_dbus:

2714

1877

# Emit D-Bus signal

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

1878

mandos_dbus_service.ClientNotFound(fpr,

2716

1879

address[0])

2717

1880

parent_pipe.send(False)

2718

1881

return False

2719

2720

GLib.io_add_watch(

2721

parent_pipe.fileno(),

2722

GLib.IO_IN | GLib.IO_HUP,

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc,

2726

client_object=client))

1882

1883

gobject.io_add_watch(parent_pipe.fileno(),

1884

gobject.IO_IN | gobject.IO_HUP,

1885

functools.partial(self.handle_ipc,

1886

parent_pipe =

1887

parent_pipe,

1888

proc = proc,

1889

client_object =

1890

client))

2727

1891

parent_pipe.send(True)

2728

1892

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

2729

1893

# same fileno

2732

1896

funcname = request[1]

2733

1897

args = request[2]

2734

1898

kwargs = request[3]

2735

1899

2736

1900

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

2737

1901

funcname)(*args,

2738

**kwargs)))

2739

1902

**kwargs)))

1903

2740

1904

if command == 'getattr':

2741

1905

attrname = request[1]

2742

if isinstance(client_object.__getattribute__(attrname),

2743

collections.Callable):

2744

parent_pipe.send(('function', ))

1906

if callable(client_object.__getattribute__(attrname)):

1907

parent_pipe.send(('function',))

2745

1908

else:

2746

parent_pipe.send((

2747

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

2748

1909

parent_pipe.send(('data', client_object

1910

.__getattribute__(attrname)))

1911

2749

1912

if command == 'setattr':

2750

1913

attrname = request[1]

2751

1914

value = request[2]

2752

1915

setattr(client_object, attrname, value)

2753

1916

2754

1917

return True

2755

1918

2756

1919

2757

def rfc3339_duration_to_delta(duration):

2758

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

2759

2760

>>> rfc3339_duration_to_delta("P7D")

2761

datetime.timedelta(7)

2762

>>> rfc3339_duration_to_delta("PT60S")

2763

datetime.timedelta(0, 60)

2764

>>> rfc3339_duration_to_delta("PT60M")

2765

datetime.timedelta(0, 3600)

2766

>>> rfc3339_duration_to_delta("PT24H")

2767

datetime.timedelta(1)

2768

>>> rfc3339_duration_to_delta("P1W")

2769

datetime.timedelta(7)

2770

>>> rfc3339_duration_to_delta("PT5M30S")

2771

datetime.timedelta(0, 330)

2772

>>> rfc3339_duration_to_delta("P1DT3M20S")

2773

datetime.timedelta(1, 200)

2774

"""

2775

2776

# Parsing an RFC 3339 duration with regular expressions is not

2777

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

2778

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

2779

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

2780

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

2781

# avoid excessive use of external libraries.

2782

2783

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

2784

Token = collections.namedtuple("Token", (

2785

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

2786

# a "group" containing digits

2787

"value", # datetime.timedelta or None

2788

"followers")) # Tokens valid after this token

2789

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

2790

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

2791

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

2792

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

2793

datetime.timedelta(seconds=1),

2794

frozenset((token_end, )))

2795

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

2796

datetime.timedelta(minutes=1),

2797

frozenset((token_second, token_end)))

2798

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

2799

datetime.timedelta(hours=1),

2800

frozenset((token_minute, token_end)))

2801

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

2802

None,

2803

frozenset((token_hour, token_minute,

2804

token_second)))

2805

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

2806

datetime.timedelta(days=1),

2807

frozenset((token_time, token_end)))

2808

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

2809

datetime.timedelta(weeks=4),

2810

frozenset((token_day, token_end)))

2811

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

2812

datetime.timedelta(weeks=52),

2813

frozenset((token_month, token_end)))

2814

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

2815

datetime.timedelta(weeks=1),

2816

frozenset((token_end, )))

2817

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

2818

frozenset((token_year, token_month,

2819

token_day, token_time,

2820

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2824

found_token = None

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2829

# Loop until end token is found

2830

while found_token is not token_end:

2831

# Search for any currently valid tokens

2832

for token in followers:

2833

match = token.regexp.match(s)

2834

if match is not None:

2835

# Token found

2836

if token.value is not None:

2837

# Value found, parse digits

2838

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

2839

# Add to value so far

2840

value += factor * token.value

2841

# Strip token from string

2842

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

2843

# Go to found token

2844

found_token = token

2845

# Set valid next tokens

2846

followers = found_token.followers

2847

break

2848

else:

2849

# No currently valid tokens were found

2850

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

2851

.format(duration))

2852

# End token found

2853

return value

2854

2855

2856

1920

def string_to_delta(interval):

2857

1921

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

2858

1922

2859

1923

>>> string_to_delta('7d')

2860

1924

datetime.timedelta(7)

2861

1925

>>> string_to_delta('60s')

2869

1933

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

2870

1934

datetime.timedelta(0, 330)

2871

1935

"""

2872

2873

try:

2874

return rfc3339_duration_to_delta(interval)

2875

except ValueError:

2876

pass

2877

2878

1936

timevalue = datetime.timedelta(0)

2879

1937

for s in interval.split():

2880

1938

try:

2881

suffix = s[-1]

1939

suffix = unicode(s[-1])

2882

1940

value = int(s[:-1])

2883

1941

if suffix == "d":

2884

1942

delta = datetime.timedelta(value)

2891

1949

elif suffix == "w":

2892

1950

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

2893

1951

else:

2894

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

2895

except IndexError as e:

1952

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

1953

except (ValueError, IndexError) as e:

2896

1954

raise ValueError(*(e.args))

2897

1955

timevalue += delta

2898

1956

return timevalue

2899

1957

2900

1958

2901

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

1959

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

2902

1960

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

2903

1961

2904

1962

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

2905

1963

if os.fork():

2906

1964

sys.exit()

2911

1969

sys.exit()

2912

1970

if not noclose:

2913

1971

# Close all standard open file descriptors

2914

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

1972

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

2915

1973

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

2916

1974

raise OSError(errno.ENODEV,

2917

"{} not a character device"

2918

.format(os.devnull))

1975

"%s not a character device"

1976

% os.path.devnull)

2919

1977

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

2920

1978

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

2921

1979

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

2924

1982

2925

1983

2926

1984

def main():

2927

1985

2928

1986

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

2929

1987

# Parsing of options, both command line and config file

2930

1988

2931

1989

parser = argparse.ArgumentParser()

2932

1990

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

2933

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

1991

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

2934

1992

help="show version number and exit")

2935

1993

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

2936

1994

help="Bind to interface IF")

2942

2000

help="Run self-test")

2943

2001

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

2944

2002

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

2945

" to terminal", default=None)

2003

" to terminal")

2946

2004

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

2947

2005

help="Debug level for stdout output")

2948

2006

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

2955

2013

" files")

2956

2014

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

2957

2015

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

2958

" system bus interface", default=None)

2016

" system bus interface")

2959

2017

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

2960

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

2961

default=None)

2018

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

2962

2019

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

2963

2020

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

2964

" state", default=None)

2965

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

2966

help="Specify a file descriptor to a network"

2967

" socket to use instead of creating one")

2021

" state")

2968

2022

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

2969

2023

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

2970

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

2971

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

2972

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

2973

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

2974

default=None)

2975

2024

2976

2025

options = parser.parse_args()

2977

2026

2978

2027

if options.check:

2979

2028

import doctest

2980

fail_count, test_count = doctest.testmod()

2981

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

2982

2029

doctest.testmod()

2030

sys.exit()

2031

2983

2032

# Default values for config file for server-global settings

2984

if gnutls.has_rawpk:

2985

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

2986

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

2987

else:

2988

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

2989

":+SIGN-DSA-SHA256")

2990

server_defaults = {"interface": "",

2991

"address": "",

2992

"port": "",

2993

"debug": "False",

2994

"priority": priority,

2995

"servicename": "Mandos",

2996

"use_dbus": "True",

2997

"use_ipv6": "True",

2998

"debuglevel": "",

2999

"restore": "True",

3000

"socket": "",

3001

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

3002

"foreground": "False",

3003

"zeroconf": "True",

3004

}

3005

del priority

3006

2033

server_defaults = { "interface": "",

2034

"address": "",

2035

"port": "",

2036

"debug": "False",

2037

"priority":

2038

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

2039

"servicename": "Mandos",

2040

"use_dbus": "True",

2041

"use_ipv6": "True",

2042

"debuglevel": "",

2043

"restore": "True",

2044

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

2045

}

2046

3007

2047

# Parse config file for server-global settings

3008

server_config = configparser.ConfigParser(server_defaults)

2048

server_config = configparser.SafeConfigParser(server_defaults)

3009

2049

del server_defaults

3010

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

3011

# Convert the ConfigParser object to a dict

2050

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

2051

"mandos.conf"))

2052

# Convert the SafeConfigParser object to a dict

3012

2053

server_settings = server_config.defaults()

3013

2054

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

3014

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

3015

"foreground", "zeroconf"):

2055

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

3016

2056

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

3017

2057

option)

3018

2058

if server_settings["port"]:

3019

2059

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

3020

2060

"port")

3021

if server_settings["socket"]:

3022

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

3023

"socket")

3024

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

3025

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

3026

# happen with a supplied network socket.

3027

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

3028

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

3029

["socket"])

3030

2061

del server_config

3031

2062

3032

2063

# Override the settings from the config file with command line

3033

2064

# options, if set.

3034

2065

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

3035

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

3036

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

3037

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

2066

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

2067

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

2068

"statedir"):

3038

2069

value = getattr(options, option)

3039

2070

if value is not None:

3040

2071

server_settings[option] = value

3041

2072

del options

3042

2073

# Force all strings to be unicode

3043

2074

for option in server_settings.keys():

3044

if isinstance(server_settings[option], bytes):

3045

server_settings[option] = (server_settings[option]

3046

.decode("utf-8"))

3047

# Force all boolean options to be boolean

3048

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

3049

"foreground", "zeroconf"):

3050

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

3051

# Debug implies foreground

3052

if server_settings["debug"]:

3053

server_settings["foreground"] = True

2075

if type(server_settings[option]) is str:

2076

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

3054

2077

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

3055

2078

3056

2079

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

3057

3058

if (not server_settings["zeroconf"]

3059

and not (server_settings["port"]

3060

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

3061

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

3062

2080

3063

2081

# For convenience

3064

2082

debug = server_settings["debug"]

3065

2083

debuglevel = server_settings["debuglevel"]

3067

2085

use_ipv6 = server_settings["use_ipv6"]

3068

2086

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

3069

2087

stored_state_file)

3070

foreground = server_settings["foreground"]

3071

zeroconf = server_settings["zeroconf"]

3072

2088

3073

2089

if debug:

3074

2090

initlogger(debug, logging.DEBUG)

3075

2091

else:

3078

2094

else:

3079

2095

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

3080

2096

initlogger(debug, level)

3081

2097

3082

2098

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

3083

syslogger.setFormatter(

3084

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

3085

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

3086

server_settings["servicename"])))

3087

2099

syslogger.setFormatter(logging.Formatter

2100

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

2101

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

2102

% server_settings["servicename"]))

2103

3088

2104

# Parse config file with clients

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2105

client_config = configparser.SafeConfigParser(Client

2106

.client_defaults)

3090

2107

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

3091

2108

"clients.conf"))

3092

2109

3093

2110

global mandos_dbus_service

3094

2111

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

2112

2113

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

2114

server_settings["port"]),

2115

ClientHandler,

2116

interface=(server_settings["interface"]

2117

or None),

2118

use_ipv6=use_ipv6,

2119

gnutls_priority=

2120

server_settings["priority"],

2121

use_dbus=use_dbus)

2122

if not debug:

2123

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

2124

try:

2125

pidfile = open(pidfilename, "w")

2126

except IOError:

2127

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

2128

2129

try:

2130

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

2131

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

2132

except KeyError:

2133

try:

2134

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

2135

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

3125

2136

except KeyError:

3126

continue

3127

else:

3128

uid = 65534

3129

gid = 65534

2137

try:

2138

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

2139

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

2140

except KeyError:

2141

uid = 65534

2142

gid = 65534

3130

2143

try:

3131

2144

os.setgid(gid)

3132

2145

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

3136

2146

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

2147

if error[0] != errno.EPERM:

2148

raise error

2149

3142

2150

if debug:

3143

2151

# Enable all possible GnuTLS debugging

3144

2152

3145

2153

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

3146

2154

# - GnuTLS manual

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2155

gnutls.library.functions.gnutls_global_set_log_level(11)

2156

2157

@gnutls.library.types.gnutls_log_func

3150

2158

def debug_gnutls(level, string):

3151

2159

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

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2160

2161

(gnutls.library.functions

2162

.gnutls_global_set_log_function(debug_gnutls))

2163

3155

2164

# Redirect stdin so all checkers get /dev/null

3156

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

2165

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

3157

2166

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

3158

2167

if null > 2:

3159

2168

os.close(null)

3160

2169

3161

2170

# Need to fork before connecting to D-Bus

3162

if not foreground:

2171

if not debug:

3163

2172

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

3164

2173

daemon()

3165

3166

if gi.version_info < (3, 10, 2):

3167

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

3168

# need to inform GLib that threads will be used.

3169

GLib.threads_init()

3170

2174

2175

gobject.threads_init()

2176

3171

2177

global main_loop

3172

2178

# From the Avahi example code

3173

DBusGMainLoop(set_as_default=True)

3174

main_loop = GLib.MainLoop()

2179

DBusGMainLoop(set_as_default=True )

2180

main_loop = gobject.MainLoop()

3175

2181

bus = dbus.SystemBus()

3176

2182

# End of Avahi example code

3177

2183

if use_dbus:

3178

2184

try:

3179

2185

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

3180

bus,

3181

do_not_queue=True)

3182

old_bus_name = dbus.service.BusName(

3183

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

3184

do_not_queue=True)

3185

except dbus.exceptions.DBusException as e:

3186

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

2186

bus, do_not_queue=True)

2187

old_bus_name = (dbus.service.BusName

2188

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

2189

do_not_queue=True))

2190

except dbus.exceptions.NameExistsException as e:

2191

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

3187

2192

use_dbus = False

3188

2193

server_settings["use_dbus"] = False

3189

2194

tcp_server.use_dbus = False

3190

if zeroconf:

3191

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3192

service = AvahiServiceToSyslog(

3193

name=server_settings["servicename"],

3194

servicetype="_mandos._tcp",

3195

protocol=protocol,

3196

bus=bus)

3197

if server_settings["interface"]:

3198

service.interface = if_nametoindex(

3199

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

3200

2195

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2196

service = AvahiServiceToSyslog(name =

2197

server_settings["servicename"],

2198

servicetype = "_mandos._tcp",

2199

protocol = protocol, bus = bus)

2200

if server_settings["interface"]:

2201

service.interface = (if_nametoindex

2202

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

2203

3201

2204

global multiprocessing_manager

3202

2205

multiprocessing_manager = multiprocessing.Manager()

3203

2206

3204

2207

client_class = Client

3205

2208

if use_dbus:

3206

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

3207

2209

client_class = functools.partial(ClientDBusTransitional,

2210

bus = bus)

2211

3208

2212

client_settings = Client.config_parser(client_config)

3209

2213

old_client_settings = {}

3210

2214

clients_data = {}

3211

3212

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

3213

global wnull

3214

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

3215

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

3216

# mode

3217

if debug or not foreground:

3218

wnull.close()

3219

2215

3220

2216

# Get client data and settings from last running state.

3221

2217

if server_settings["restore"]:

3222

2218

try:

3223

2219

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

3224

if sys.version_info.major == 2:

3225

clients_data, old_client_settings = pickle.load(

3226

stored_state)

3227

else:

3228

bytes_clients_data, bytes_old_client_settings = (

3229

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

3230

# Fix bytes to strings

3231

# clients_data

3232

# .keys()

3233

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

3234

if isinstance(key, bytes)

3235

else key): value

3236

for key, value in

3237

bytes_clients_data.items()}

3238

del bytes_clients_data

3239

for key in clients_data:

3240

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

3241

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

3242

for k, v in

3243

clients_data[key].items()}

3244

clients_data[key] = value

3245

# .client_structure

3246

value["client_structure"] = [

3247

(s.decode("utf-8")

3248

if isinstance(s, bytes)

3249

else s) for s in

3250

value["client_structure"]]

3251

# .name & .host

3252

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

3253

if isinstance(value[k], bytes):

3254

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

3255

if "key_id" not in value:

3256

value["key_id"] = ""

3257

elif "fingerprint" not in value:

3258

value["fingerprint"] = ""

3259

# old_client_settings

3260

# .keys()

3261

old_client_settings = {

3262

(key.decode("utf-8")

3263

if isinstance(key, bytes)

3264

else key): value

3265

for key, value in

3266

bytes_old_client_settings.items()}

3267

del bytes_old_client_settings

3268

# .host

3269

for value in old_client_settings.values():

3270

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

3271

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

3272

.decode("utf-8"))

2220

clients_data, old_client_settings = (pickle.load

2221

(stored_state))

3273

2222

os.remove(stored_state_path)

3274

2223

except IOError as e:

3275

if e.errno == errno.ENOENT:

3276

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

3277

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

3278

else:

3279

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

3280

exc_info=e)

2224

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

2225

.format(e))

2226

if e.errno != errno.ENOENT:

3281

2227

raise

3282

2228

except EOFError as e:

3283

2229

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

3284

"EOFError:",

3285

exc_info=e)

3286

2230

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

2231

3287

2232

with PGPEngine() as pgp:

3288

for client_name, client in clients_data.items():

3289

# Skip removed clients

3290

if client_name not in client_settings:

3291

continue

3292

2233

for client_name, client in clients_data.iteritems():

3293

2234

# Decide which value to use after restoring saved state.

3294

2235

# We have three different values: Old config file,

3295

2236

# new config file, and saved state.

3300

2241

# For each value in new config, check if it

3301

2242

# differs from the old config value (Except for

3302

2243

# the "secret" attribute)

3303

if (name != "secret"

3304

and (value !=

3305

old_client_settings[client_name][name])):

2244

if (name != "secret" and

2245

value != old_client_settings[client_name]

2246

[name]):

3306

2247

client[name] = value

3307

2248

except KeyError:

3308

2249

pass

3309

2250

3310

2251

# Clients who has passed its expire date can still be

3311

# enabled if its last checker was successful. A Client

3312

# whose checker succeeded before we stored its state is

3313

# assumed to have successfully run all checkers during

3314

# downtime.

2252

# enabled if its last checker was successful. Clients

2253

# whose checker failed before we stored its state is

2254

# assumed to have failed all checkers during downtime.

3315

2255

if client["enabled"]:

3316

2256

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

3317

2257

if not client["last_checked_ok"]:

3318

2258

logger.warning(

3319

"disabling client {} - Client never "

3320

"performed a successful checker".format(

3321

client_name))

2259

"disabling client {0} - Client never "

2260

"performed a successfull checker"

2261

.format(client["name"]))

3322

2262

client["enabled"] = False

3323

2263

elif client["last_checker_status"] != 0:

3324

2264

logger.warning(

3325

"disabling client {} - Client last"

3326

" checker failed with error code"

3327

" {}".format(

3328

client_name,

3329

client["last_checker_status"]))

2265

"disabling client {0} - Client "

2266

"last checker failed with error code {1}"

2267

.format(client["name"],

2268

client["last_checker_status"]))

3330

2269

client["enabled"] = False

3331

2270

else:

3332

client["expires"] = (

3333

datetime.datetime.utcnow()

3334

+ client["timeout"])

2271

client["expires"] = (datetime.datetime

2272

.utcnow()

2273

+ client["timeout"])

3335

2274

logger.debug("Last checker succeeded,"

3336

" keeping {} enabled".format(

3337

client_name))

2275

" keeping {0} enabled"

2276

.format(client["name"]))

3338

2277

try:

3339

client["secret"] = pgp.decrypt(

3340

client["encrypted_secret"],

3341

client_settings[client_name]["secret"])

2278

client["secret"] = (

2279

pgp.decrypt(client["encrypted_secret"],

2280

client_settings[client_name]

2281

["secret"]))

3342

2282

except PGPError:

3343

2283

# If decryption fails, we use secret from new settings

3344

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

3345

client_name))

3346

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

3347

["secret"])

2284

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

2285

.format(client_name))

2286

client["secret"] = (

2287

client_settings[client_name]["secret"])

3348

2288

2289

3349

2290

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

3350

2291

for client_name in (set(old_client_settings)

3351

2292

- set(client_settings)):

3354

2295

- set(old_client_settings)):

3355

2296

clients_data[client_name] = client_settings[client_name]

3356

2297

3357

# Create all client objects

3358

for client_name, client in clients_data.items():

2298

# Create clients all clients

2299

for client_name, client in clients_data.iteritems():

3359

2300

tcp_server.clients[client_name] = client_class(

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2301

name = client_name, settings = client)

2302

3364

2303

if not tcp_server.clients:

3365

2304

logger.warning("No clients defined")

3366

3367

if not foreground:

3368

if pidfile is not None:

3369

pid = os.getpid()

3370

try:

3371

with pidfile:

3372

print(pid, file=pidfile)

3373

except IOError:

3374

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

3375

pidfilename, pid)

3376

del pidfile

2305

2306

if not debug:

2307

try:

2308

with pidfile:

2309

pid = os.getpid()

2310

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

2311

del pidfile

2312

except IOError:

2313

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

2314

pidfilename, pid)

2315

except NameError:

2316

# "pidfile" was never created

2317

pass

3377

2318

del pidfilename

3378

3379

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

3380

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3381

lambda: main_loop.quit() and False)

3382

2319

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

2320

2321

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

2322

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

2323

3383

2324

if use_dbus:

3384

3385

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2325

class MandosDBusService(dbus.service.Object):

3388

2326

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

3389

3390

2327

def __init__(self):

3391

2328

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

3392

3393

2329

_interface = "se.recompile.Mandos"

3394

2330

3395

2331

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

3396

2332

def ClientAdded(self, objpath):

3397

2333

"D-Bus signal"

3398

2334

pass

3399

2335

3400

2336

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

3401

def ClientNotFound(self, key_id, address):

2337

def ClientNotFound(self, fingerprint, address):

3402

2338

"D-Bus signal"

3403

2339

pass

3404

3405

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

3406

"true"})

2340

3407

2341

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

3408

2342

def ClientRemoved(self, objpath, name):

3409

2343

"D-Bus signal"

3410

2344

pass

3411

3412

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

3413

"true"})

2345

3414

2346

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

3415

2347

def GetAllClients(self):

3416

2348

"D-Bus method"

3417

return dbus.Array(c.dbus_object_path for c in

3418

tcp_server.clients.values())

3419

3420

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

3421

"true"})

2349

return dbus.Array(c.dbus_object_path

2350

for c in

2351

tcp_server.clients.itervalues())

2352

3422

2353

@dbus.service.method(_interface,

3423

2354

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

3424

2355

def GetAllClientsWithProperties(self):

3425

2356

"D-Bus method"

3426

2357

return dbus.Dictionary(

3427

{c.dbus_object_path: c.GetAll(

3428

"se.recompile.Mandos.Client")

3429

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

2358

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

2359

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

3430

2360

signature="oa{sv}")

3431

2361

3432

2362

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

3433

2363

def RemoveClient(self, object_path):

3434

2364

"D-Bus method"

3435

for c in tcp_server.clients.values():

2365

for c in tcp_server.clients.itervalues():

3436

2366

if c.dbus_object_path == object_path:

3437

2367

del tcp_server.clients[c.name]

3438

2368

c.remove_from_connection()

3439

# Don't signal the disabling

2369

# Don't signal anything except ClientRemoved

3440

2370

c.disable(quiet=True)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2371

# Emit D-Bus signal

2372

self.ClientRemoved(object_path, c.name)

3443

2373

return

3444

2374

raise KeyError(object_path)

3445

2375

3446

2376

del _interface

3447

3448

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3449

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

3450

def GetManagedObjects(self):

3451

"""D-Bus method"""

3452

return dbus.Dictionary(

3453

{client.dbus_object_path:

3454

dbus.Dictionary(

3455

{interface: client.GetAll(interface)

3456

for interface in

3457

client._get_all_interface_names()})

3458

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

3459

3460

def client_added_signal(self, client):

3461

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

3462

if use_dbus:

3463

# New standard signal

3464

self.InterfacesAdded(

3465

client.dbus_object_path,

3466

dbus.Dictionary(

3467

{interface: client.GetAll(interface)

3468

for interface in

3469

client._get_all_interface_names()}))

3470

# Old signal

3471

self.ClientAdded(client.dbus_object_path)

3472

3473

def client_removed_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesRemoved(

3478

client.dbus_object_path,

3479

client._get_all_interface_names())

3480

# Old signal

3481

self.ClientRemoved(client.dbus_object_path,

3482

client.name)

3483

3484

mandos_dbus_service = MandosDBusService()

3485

3486

# Save modules to variables to exempt the modules from being

3487

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

3488

mp = multiprocessing

3489

wn = wnull

3490

2377

2378

class MandosDBusServiceTransitional(MandosDBusService):

2379

__metaclass__ = AlternateDBusNamesMetaclass

2380

mandos_dbus_service = MandosDBusServiceTransitional()

2381

3491

2382

def cleanup():

3492

2383

"Cleanup function; run on exit"

3493

if zeroconf:

3494

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2384

service.cleanup()

2385

2386

multiprocessing.active_children()

3498

2387

if not (tcp_server.clients or client_settings):

3499

2388

return

3500

2389

3501

2390

# Store client before exiting. Secrets are encrypted with key

3502

2391

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

3503

2392

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

3504

2393

clients = {}

3505

2394

with PGPEngine() as pgp:

3506

for client in tcp_server.clients.values():

2395

for client in tcp_server.clients.itervalues():

3507

2396

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

3508

2397

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

3509

2398

key)

3510

2399

client_dict = {}

3511

2400

3512

2401

# A list of attributes that can not be pickled

3513

2402

# + secret.

3514

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

3515

"checker", "server_settings"}

3516

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

3517

.Object):

2403

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

2404

"checker"))

2405

for name, typ in (inspect.getmembers

2406

(dbus.service.Object)):

3518

2407

exclude.add(name)

3519

2408

3520

2409

client_dict["encrypted_secret"] = (client

3521

2410

.encrypted_secret)

3522

2411

for attr in client.client_structure:

3523

2412

if attr not in exclude:

3524

2413

client_dict[attr] = getattr(client, attr)

3525

2414

3526

2415

clients[client.name] = client_dict

3527

2416

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

3528

2417

3529

2418

try:

3530

with tempfile.NamedTemporaryFile(

3531

mode='wb',

3532

suffix=".pickle",

3533

prefix='clients-',

3534

dir=os.path.dirname(stored_state_path),

3535

delete=False) as stored_state:

3536

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

3537

protocol=2)

3538

tempname = stored_state.name

2419

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

2420

prefix="clients-",

2421

dir=os.path.dirname

2422

(stored_state_path))

2423

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

2424

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

3539

2425

os.rename(tempname, stored_state_path)

3540

2426

except (IOError, OSError) as e:

2427

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

2428

.format(e))

3541

2429

if not debug:

3542

2430

try:

3543

2431

os.remove(tempname)

3544

2432

except NameError:

3545

2433

pass

3546

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

3547

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

3548

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

3549

else:

3550

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

3551

exc_info=e)

3552

raise

3553

2434

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

2435

errno.EEXIST)):

2436

raise e

2437

3554

2438

# Delete all clients, and settings from config

3555

2439

while tcp_server.clients:

3556

2440

name, client = tcp_server.clients.popitem()

3557

2441

if use_dbus:

3558

2442

client.remove_from_connection()

3559

# Don't signal the disabling

2443

# Don't signal anything except ClientRemoved

3560

2444

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

3562

2445

if use_dbus:

3563

mandos_dbus_service.client_removed_signal(client)

2446

# Emit D-Bus signal

2447

mandos_dbus_service.ClientRemoved(client

2448

.dbus_object_path,

2449

client.name)

3564

2450

client_settings.clear()

3565

2451

3566

2452

atexit.register(cleanup)

3567

3568

for client in tcp_server.clients.values():

2453

2454

for client in tcp_server.clients.itervalues():

3569

2455

if use_dbus:

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2456

# Emit D-Bus signal

2457

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3572

2458

# Need to initiate checking of clients

3573

2459

if client.enabled:

3574

2460

client.init_checker()

3575

2461

3576

2462

tcp_server.enable()

3577

2463

tcp_server.server_activate()

3578

2464

3579

2465

# Find out what port we got

3580

if zeroconf:

3581

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

2466

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

3582

2467

if use_ipv6:

3583

2468

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

3584

" flowinfo %d, scope_id %d",

3585

*tcp_server.socket.getsockname())

2469

" flowinfo %d, scope_id %d"

2470

% tcp_server.socket.getsockname())

3586

2471

else: # IPv4

3587

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

3588

*tcp_server.socket.getsockname())

3589

3590

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

3591

2472

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

2473

% tcp_server.socket.getsockname())

2474

2475

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

2476

3592

2477

try:

3593

if zeroconf:

3594

# From the Avahi example code

3595

try:

3596

service.activate()

3597

except dbus.exceptions.DBusException as error:

3598

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

3599

cleanup()

3600

sys.exit(1)

3601

# End of Avahi example code

3602

3603

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

3604

lambda *args, **kwargs:

3605

(tcp_server.handle_request

3606

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

3607

2478

# From the Avahi example code

2479

try:

2480

service.activate()

2481

except dbus.exceptions.DBusException as error:

2482

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

2483

cleanup()

2484

sys.exit(1)

2485

# End of Avahi example code

2486

2487

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

2488

lambda *args, **kwargs:

2489

(tcp_server.handle_request

2490

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

2491

3608

2492

logger.debug("Starting main loop")

3609

2493

main_loop.run()

3610

2494

except AvahiError as error:

3611

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

2495

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

3612

2496

cleanup()

3613

2497

sys.exit(1)

3614

2498

except KeyboardInterrupt:

3619

2503

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

3620

2504

cleanup()

3621

2505

3622

3623

2506

if __name__ == '__main__':

3624

2507

main()