/mandos/release : revision 237.7.110

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

68

import itertools

78

import collections

79

import codecs

80

69

81

70

import dbus

82

71

import dbus.service

83

from gi.repository import GLib

72

import gobject

73

import avahi

84

74

from dbus.mainloop.glib import DBusGMainLoop

85

75

import ctypes

86

76

import ctypes.util

87

77

import xml.dom.minidom

88

78

import inspect

79

import GnuPGInterface

89

80

90

# Try to find the value of SO_BINDTODEVICE:

91

81

try:

92

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

93

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

94

82

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

83

except AttributeError:

96

84

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

85

from IN import SO_BINDTODEVICE

100

86

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.3"

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

119

90

stored_state_file = "clients.pickle"

120

91

121

92

logger = logging.getLogger()

122

syslogger = None

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

123

96

124

97

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

127

101

except (OSError, AttributeError):

128

129

102

def if_nametoindex(interface):

130

103

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

131

104

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

132

105

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

133

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

136

111

return interface_index

137

112

138

113

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

114

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

156

115

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

116

162

117

syslogger.setFormatter(logging.Formatter

163

118

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

164

119

' %(message)s'))

165

120

logger.addHandler(syslogger)

166

121

167

122

if debug:

168

123

console = logging.StreamHandler()

169

124

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

181

136

182

137

class PGPEngine(object):

183

138

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

184

185

139

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

186

141

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

206

149

def __enter__(self):

207

150

return self

208

209

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

151

152

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

210

153

self._cleanup()

211

154

return False

212

155

213

156

def __del__(self):

214

157

self._cleanup()

215

158

216

159

def _cleanup(self):

217

160

if self.tempdir is not None:

218

161

# Delete contents of tempdir

219

162

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

220

topdown=False):

163

topdown = False):

221

164

for filename in files:

222

165

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

223

166

for dirname in dirs:

225

168

# Remove tempdir

226

169

os.rmdir(self.tempdir)

227

170

self.tempdir = None

228

171

229

172

def password_encode(self, password):

230

173

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

231

174

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

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

175

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

176

240

177

def encrypt(self, data, password):

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

178

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

179

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

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

256

192

return ciphertext

257

193

258

194

def decrypt(self, data, password):

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

195

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

196

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

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

274

209

return decrypted_plaintext

275

210

276

211

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

212

304

213

class AvahiError(Exception):

305

214

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

306

215

self.value = value

307

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

308

**kwargs)

309

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

310

219

311

220

class AvahiServiceError(AvahiError):

312

221

pass

313

222

314

315

223

class AvahiGroupError(AvahiError):

316

224

pass

317

225

318

226

319

227

class AvahiService(object):

320

228

"""An Avahi (Zeroconf) service.

321

229

322

230

Attributes:

323

231

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

324

232

Used to optionally bind to the specified interface.

325

233

name: string; Example: 'Mandos'

326

234

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

327

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

235

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

328

236

port: integer; what port to announce

329

237

TXT: list of strings; TXT record for the service

330

238

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

336

244

server: D-Bus Server

337

245

bus: dbus.SystemBus()

338

246

"""

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

247

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

248

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

249

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

250

protocol = avahi.PROTO_UNSPEC, bus = None):

351

251

self.interface = interface

352

252

self.name = name

353

253

self.type = servicetype

362

262

self.server = None

363

263

self.bus = bus

364

264

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

265

def rename(self):

367

266

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

368

267

if self.rename_count >= self.max_renames:

369

268

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

370

269

" after %i retries, exiting.",

371

270

self.rename_count)

372

271

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

376

274

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

377

275

self.name)

378

if remove:

379

self.remove()

276

self.remove()

380

277

try:

381

278

self.add()

382

279

except dbus.exceptions.DBusException as error:

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

280

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

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

392

284

def remove(self):

393

285

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

394

286

if self.entry_group_state_changed_match is not None:

396

288

self.entry_group_state_changed_match = None

397

289

if self.group is not None:

398

290

self.group.Reset()

399

400

291

def add(self):

401

292

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

402

293

self.remove()

419

310

dbus.UInt16(self.port),

420

311

avahi.string_array_to_txt_array(self.TXT))

421

312

self.group.Commit()

422

423

313

def entry_group_state_changed(self, state, error):

424

314

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

425

315

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

426

316

427

317

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

318

logger.debug("Zeroconf service established.")

429

319

elif state == avahi.ENTRY_GROUP_COLLISION:

431

321

self.rename()

432

322

elif state == avahi.ENTRY_GROUP_FAILURE:

433

323

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

434

str(error))

435

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

436

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

437

327

def cleanup(self):

438

328

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

439

329

if self.group is not None:

444

334

pass

445

335

self.group = None

446

336

self.remove()

447

448

337

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

449

338

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

450

339

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

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

340

bad_states = { avahi.SERVER_INVALID:

341

"Zeroconf server invalid",

342

avahi.SERVER_REGISTERING: None,

343

avahi.SERVER_COLLISION:

344

"Zeroconf server name collision",

345

avahi.SERVER_FAILURE:

346

"Zeroconf server failure" }

457

347

if state in bad_states:

458

348

if bad_states[state] is not None:

459

349

if error is None:

462

352

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

463

353

self.cleanup()

464

354

elif state == avahi.SERVER_RUNNING:

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

355

self.add()

477

356

else:

478

357

if error is None:

479

358

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

480

359

else:

481

360

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

482

483

361

def activate(self):

484

362

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

485

363

if self.server is None:

489

367

follow_name_owner_changes=True),

490

368

avahi.DBUS_INTERFACE_SERVER)

491

369

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

370

self.server_state_changed)

493

371

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

494

372

495

496

373

class AvahiServiceToSyslog(AvahiService):

497

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

374

def rename(self):

498

375

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

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

376

ret = AvahiService.rename(self)

377

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

% self.name))

503

381

return ret

504

382

505

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

_tls_rawpk_version = b"3.6.6"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CRT_RAWPK = 3

535

CLIENT = 2

536

SHUT_RDWR = 0

537

CRD_CERTIFICATE = 1

538

E_NO_CERTIFICATE_FOUND = -49

539

X509_FMT_DER = 0

540

NO_TICKETS = 1<<10

541

ENABLE_RAWPK = 1<<18

542

CTYPE_PEERS = 3

543

KEYID_USE_SHA256 = 1 # gnutls/x509.h

544

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

545

546

# Types

547

class session_int(ctypes.Structure):

548

_fields_ = []

549

session_t = ctypes.POINTER(session_int)

550

551

class certificate_credentials_st(ctypes.Structure):

552

_fields_ = []

553

certificate_credentials_t = ctypes.POINTER(

554

certificate_credentials_st)

555

certificate_type_t = ctypes.c_int

556

557

class datum_t(ctypes.Structure):

558

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

559

('size', ctypes.c_uint)]

560

561

class openpgp_crt_int(ctypes.Structure):

562

_fields_ = []

563

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

564

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

565

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

566

credentials_type_t = ctypes.c_int

567

transport_ptr_t = ctypes.c_void_p

568

close_request_t = ctypes.c_int

569

570

# Exceptions

571

class Error(Exception):

572

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

573

# exception might be raised from within GnuTLS.__init__,

574

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

575

# global variable has happened.

576

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

577

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

578

# code is passed, convert it to a string with

579

# gnutls.strerror()

580

self.code = code

581

if message is None and code is not None:

582

message = GnuTLS.strerror(code)

583

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

584

message, *args)

585

586

class CertificateSecurityError(Error):

587

pass

588

589

# Classes

590

class Credentials(object):

591

def __init__(self):

592

self._c_object = gnutls.certificate_credentials_t()

593

gnutls.certificate_allocate_credentials(

594

ctypes.byref(self._c_object))

595

self.type = gnutls.CRD_CERTIFICATE

596

597

def __del__(self):

598

gnutls.certificate_free_credentials(self._c_object)

599

600

class ClientSession(object):

601

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

602

self._c_object = gnutls.session_t()

603

gnutls_flags = gnutls.CLIENT

604

if gnutls.check_version("3.5.6"):

605

gnutls_flags |= gnutls.NO_TICKETS

606

if gnutls.has_rawpk:

607

gnutls_flags |= gnutls.ENABLE_RAWPK

608

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

609

del gnutls_flags

610

gnutls.set_default_priority(self._c_object)

611

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

612

gnutls.handshake_set_private_extensions(self._c_object,

613

True)

614

self.socket = socket

615

if credentials is None:

616

credentials = gnutls.Credentials()

617

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

618

ctypes.cast(credentials._c_object,

619

ctypes.c_void_p))

620

self.credentials = credentials

621

622

def __del__(self):

623

gnutls.deinit(self._c_object)

624

625

def handshake(self):

626

return gnutls.handshake(self._c_object)

627

628

def send(self, data):

629

data = bytes(data)

630

data_len = len(data)

631

while data_len > 0:

632

data_len -= gnutls.record_send(self._c_object,

633

data[-data_len:],

634

data_len)

635

636

def bye(self):

637

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

638

639

# Error handling functions

640

def _error_code(result):

641

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

642

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

643

if result >= 0:

644

return result

645

if result == gnutls.E_NO_CERTIFICATE_FOUND:

646

raise gnutls.CertificateSecurityError(code=result)

647

raise gnutls.Error(code=result)

648

649

def _retry_on_error(result, func, arguments):

650

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

651

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

652

while result < 0:

653

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

654

return _error_code(result)

655

result = func(*arguments)

656

return result

657

658

# Unless otherwise indicated, the function declarations below are

659

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

660

661

# Functions

662

priority_set_direct = _library.gnutls_priority_set_direct

663

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

664

ctypes.POINTER(ctypes.c_char_p)]

665

priority_set_direct.restype = _error_code

666

667

init = _library.gnutls_init

668

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

669

init.restype = _error_code

670

671

set_default_priority = _library.gnutls_set_default_priority

672

set_default_priority.argtypes = [session_t]

673

set_default_priority.restype = _error_code

674

675

record_send = _library.gnutls_record_send

676

record_send.argtypes = [session_t, ctypes.c_void_p,

677

ctypes.c_size_t]

678

record_send.restype = ctypes.c_ssize_t

679

record_send.errcheck = _retry_on_error

680

681

certificate_allocate_credentials = (

682

_library.gnutls_certificate_allocate_credentials)

683

certificate_allocate_credentials.argtypes = [

684

ctypes.POINTER(certificate_credentials_t)]

685

certificate_allocate_credentials.restype = _error_code

686

687

certificate_free_credentials = (

688

_library.gnutls_certificate_free_credentials)

689

certificate_free_credentials.argtypes = [

690

certificate_credentials_t]

691

certificate_free_credentials.restype = None

692

693

handshake_set_private_extensions = (

694

_library.gnutls_handshake_set_private_extensions)

695

handshake_set_private_extensions.argtypes = [session_t,

696

ctypes.c_int]

697

handshake_set_private_extensions.restype = None

698

699

credentials_set = _library.gnutls_credentials_set

700

credentials_set.argtypes = [session_t, credentials_type_t,

701

ctypes.c_void_p]

702

credentials_set.restype = _error_code

703

704

strerror = _library.gnutls_strerror

705

strerror.argtypes = [ctypes.c_int]

706

strerror.restype = ctypes.c_char_p

707

708

certificate_type_get = _library.gnutls_certificate_type_get

709

certificate_type_get.argtypes = [session_t]

710

certificate_type_get.restype = _error_code

711

712

certificate_get_peers = _library.gnutls_certificate_get_peers

713

certificate_get_peers.argtypes = [session_t,

714

ctypes.POINTER(ctypes.c_uint)]

715

certificate_get_peers.restype = ctypes.POINTER(datum_t)

716

717

global_set_log_level = _library.gnutls_global_set_log_level

718

global_set_log_level.argtypes = [ctypes.c_int]

719

global_set_log_level.restype = None

720

721

global_set_log_function = _library.gnutls_global_set_log_function

722

global_set_log_function.argtypes = [log_func]

723

global_set_log_function.restype = None

724

725

deinit = _library.gnutls_deinit

726

deinit.argtypes = [session_t]

727

deinit.restype = None

728

729

handshake = _library.gnutls_handshake

730

handshake.argtypes = [session_t]

731

handshake.restype = _error_code

732

handshake.errcheck = _retry_on_error

733

734

transport_set_ptr = _library.gnutls_transport_set_ptr

735

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

736

transport_set_ptr.restype = None

737

738

bye = _library.gnutls_bye

739

bye.argtypes = [session_t, close_request_t]

740

bye.restype = _error_code

741

bye.errcheck = _retry_on_error

742

743

check_version = _library.gnutls_check_version

744

check_version.argtypes = [ctypes.c_char_p]

745

check_version.restype = ctypes.c_char_p

746

747

has_rawpk = bool(check_version(_tls_rawpk_version))

748

749

if has_rawpk:

750

# Types

751

class pubkey_st(ctypes.Structure):

752

_fields = []

753

pubkey_t = ctypes.POINTER(pubkey_st)

754

755

x509_crt_fmt_t = ctypes.c_int

756

757

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

758

pubkey_init = _library.gnutls_pubkey_init

759

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

760

pubkey_init.restype = _error_code

761

762

pubkey_import = _library.gnutls_pubkey_import

763

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

764

x509_crt_fmt_t]

765

pubkey_import.restype = _error_code

766

767

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

768

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

769

ctypes.POINTER(ctypes.c_ubyte),

770

ctypes.POINTER(ctypes.c_size_t)]

771

pubkey_get_key_id.restype = _error_code

772

773

pubkey_deinit = _library.gnutls_pubkey_deinit

774

pubkey_deinit.argtypes = [pubkey_t]

775

pubkey_deinit.restype = None

776

else:

777

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

778

779

openpgp_crt_init = _library.gnutls_openpgp_crt_init

780

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

781

openpgp_crt_init.restype = _error_code

782

783

openpgp_crt_import = _library.gnutls_openpgp_crt_import

784

openpgp_crt_import.argtypes = [openpgp_crt_t,

785

ctypes.POINTER(datum_t),

786

openpgp_crt_fmt_t]

787

openpgp_crt_import.restype = _error_code

788

789

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

790

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

791

ctypes.POINTER(ctypes.c_uint)]

792

openpgp_crt_verify_self.restype = _error_code

793

794

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

795

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

796

openpgp_crt_deinit.restype = None

797

798

openpgp_crt_get_fingerprint = (

799

_library.gnutls_openpgp_crt_get_fingerprint)

800

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

801

ctypes.c_void_p,

802

ctypes.POINTER(

803

ctypes.c_size_t)]

804

openpgp_crt_get_fingerprint.restype = _error_code

805

806

if check_version("3.6.4"):

807

certificate_type_get2 = _library.gnutls_certificate_type_get2

808

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

809

certificate_type_get2.restype = _error_code

810

811

# Remove non-public functions

812

del _error_code, _retry_on_error

813

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

814

gnutls = GnuTLS()

815

816

817

def call_pipe(connection, # : multiprocessing.Connection

818

func, *args, **kwargs):

819

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

820

821

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

822

return value on the provided multiprocessing.Connection.

823

"""

824

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

825

connection.close()

826

827

383

def timedelta_to_milliseconds(td):

384

"Convert a datetime.timedelta() to milliseconds"

385

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

386

+ (td.seconds * 1000)

387

+ (td.microseconds // 1000))

388

828

389

class Client(object):

829

390

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

830

391

831

392

Attributes:

832

393

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

833

394

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

835

396

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

836

397

to see if the client lives.

837

398

'None' if no process is running.

838

checker_callback_tag: a GLib event source tag, or None

399

checker_callback_tag: a gobject event source tag, or None

839

400

checker_command: string; External command which is run to check

840

401

if client lives. %() expansions are done at

841

402

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

842

403

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

843

checker_initiator_tag: a GLib event source tag, or None

404

checker_initiator_tag: a gobject event source tag, or None

844

405

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

845

406

client_structure: Object describing what attributes a client has

846

407

and is used for storing the client at exit

847

408

current_checker_command: string; current running checker_command

848

disable_initiator_tag: a GLib event source tag, or None

409

disable_initiator_tag: a gobject event source tag, or None

849

410

enabled: bool()

850

411

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

851

uniquely identify an OpenPGP client

852

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

853

a client using raw public keys

412

uniquely identify the client

854

413

host: string; available for use by the checker command

855

414

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

856

415

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

858

417

last_checker_status: integer between 0 and 255 reflecting exit

859

418

status of last checker. -1 reflects crashed

860

419

checker, -2 means no checker completed yet.

861

last_checker_signal: The signal which killed the last checker, if

862

last_checker_status is -1

863

420

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

864

421

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

865

422

D-Bus identifiers

870

427

runtime_expansions: Allowed attributes for runtime expansion.

871

428

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

872

429

disabled, or None

873

server_settings: The server_settings dict from main()

874

430

"""

875

431

876

432

runtime_expansions = ("approval_delay", "approval_duration",

877

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

878

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

879

"last_approval_request", "last_checked_ok",

433

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

434

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

880

435

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

881

client_defaults = {

882

"timeout": "PT5M",

883

"extended_timeout": "PT15M",

884

"interval": "PT2M",

885

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

886

"host": "",

887

"approval_delay": "PT0S",

888

"approval_duration": "PT1S",

889

"approved_by_default": "True",

890

"enabled": "True",

891

}

436

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

437

"extended_timeout": "15m",

438

"interval": "2m",

439

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

440

"host": "",

441

"approval_delay": "0s",

442

"approval_duration": "1s",

443

"approved_by_default": "True",

444

"enabled": "True",

445

}

446

447

def timeout_milliseconds(self):

448

"Return the 'timeout' attribute in milliseconds"

449

return timedelta_to_milliseconds(self.timeout)

450

451

def extended_timeout_milliseconds(self):

452

"Return the 'extended_timeout' attribute in milliseconds"

453

return timedelta_to_milliseconds(self.extended_timeout)

454

455

def interval_milliseconds(self):

456

"Return the 'interval' attribute in milliseconds"

457

return timedelta_to_milliseconds(self.interval)

458

459

def approval_delay_milliseconds(self):

460

return timedelta_to_milliseconds(self.approval_delay)

892

461

893

462

@staticmethod

894

463

def config_parser(config):

902

471

for client_name in config.sections():

903

472

section = dict(config.items(client_name))

904

473

client = settings[client_name] = {}

905

474

906

475

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

907

476

# Reformat values from string types to Python types

908

477

client["approved_by_default"] = config.getboolean(

909

478

client_name, "approved_by_default")

910

479

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

911

480

"enabled")

912

913

# Uppercase and remove spaces from key_id and fingerprint

914

# for later comparison purposes with return value from the

915

# key_id() and fingerprint() functions

916

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

917

.replace(" ", ""))

481

918

482

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

919

483

.replace(" ", ""))

920

484

if "secret" in section:

921

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

922

.encode("utf-8"),

923

"base64")

485

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

924

486

elif "secfile" in section:

925

487

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

926

488

(section["secfile"])),

927

489

"rb") as secfile:

928

490

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

929

491

else:

930

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

931

.format(section))

492

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

493

% section)

932

494

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

933

495

client["extended_timeout"] = string_to_delta(

934

496

section["extended_timeout"])

941

503

client["last_approval_request"] = None

942

504

client["last_checked_ok"] = None

943

505

client["last_checker_status"] = -2

944

506

945

507

return settings

946

947

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

508

509

510

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

511

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

512

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

513

attribute."""

948

514

self.name = name

949

if server_settings is None:

950

server_settings = {}

951

self.server_settings = server_settings

952

515

# adding all client settings

953

for setting, value in settings.items():

516

for setting, value in settings.iteritems():

954

517

setattr(self, setting, value)

955

518

956

519

if self.enabled:

957

520

if not hasattr(self, "last_enabled"):

958

521

self.last_enabled = datetime.datetime.utcnow()

962

525

else:

963

526

self.last_enabled = None

964

527

self.expires = None

965

528

966

529

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

967

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

530

# Uppercase and remove spaces from fingerprint for later

531

# comparison purposes with return value from the fingerprint()

532

# function

968

533

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

969

534

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

970

535

datetime.datetime.utcnow())

977

542

self.current_checker_command = None

978

543

self.approved = None

979

544

self.approvals_pending = 0

980

self.changedstate = multiprocessing_manager.Condition(

981

multiprocessing_manager.Lock())

982

self.client_structure = [attr

983

for attr in self.__dict__.keys()

545

self.changedstate = (multiprocessing_manager

546

.Condition(multiprocessing_manager

547

.Lock()))

548

self.client_structure = [attr for attr in

549

self.__dict__.iterkeys()

984

550

if not attr.startswith("_")]

985

551

self.client_structure.append("client_structure")

986

987

for name, t in inspect.getmembers(

988

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

552

553

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

554

lambda obj:

555

isinstance(obj,

556

property)):

989

557

if not name.startswith("_"):

990

558

self.client_structure.append(name)

991

559

992

560

# Send notice to process children that client state has changed

993

561

def send_changedstate(self):

994

562

with self.changedstate:

995

563

self.changedstate.notify_all()

996

564

997

565

def enable(self):

998

566

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

999

567

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

1000

568

# Already enabled

1001

569

return

570

self.send_changedstate()

1002

571

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

1003

572

self.enabled = True

1004

573

self.last_enabled = datetime.datetime.utcnow()

1005

574

self.init_checker()

1006

self.send_changedstate()

1007

575

1008

576

def disable(self, quiet=True):

1009

577

"""Disable this client."""

1010

578

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

1011

579

return False

1012

580

if not quiet:

581

self.send_changedstate()

582

if not quiet:

1013

583

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

1014

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

1015

GLib.source_remove(self.disable_initiator_tag)

584

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

585

gobject.source_remove(self.disable_initiator_tag)

1016

586

self.disable_initiator_tag = None

1017

587

self.expires = None

1018

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

1019

GLib.source_remove(self.checker_initiator_tag)

588

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

589

gobject.source_remove(self.checker_initiator_tag)

1020

590

self.checker_initiator_tag = None

1021

591

self.stop_checker()

1022

592

self.enabled = False

1023

if not quiet:

1024

self.send_changedstate()

1025

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

593

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

1026

594

return False

1027

595

1028

596

def __del__(self):

1029

597

self.disable()

1030

598

1031

599

def init_checker(self):

1032

600

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

1033

601

# and every interval from then on.

1034

if self.checker_initiator_tag is not None:

1035

GLib.source_remove(self.checker_initiator_tag)

1036

self.checker_initiator_tag = GLib.timeout_add(

1037

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

1038

self.start_checker)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

self.start_checker))

1039

605

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

1040

if self.disable_initiator_tag is not None:

1041

GLib.source_remove(self.disable_initiator_tag)

1042

self.disable_initiator_tag = GLib.timeout_add(

1043

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

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

self.disable))

1044

609

# Also start a new checker *right now*.

1045

610

self.start_checker()

1046

1047

def checker_callback(self, source, condition, connection,

1048

command):

611

612

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

1049

613

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

1050

614

self.checker_callback_tag = None

1051

615

self.checker = None

1052

# Read return code from connection (see call_pipe)

1053

returncode = connection.recv()

1054

connection.close()

1055

1056

if returncode >= 0:

1057

self.last_checker_status = returncode

1058

self.last_checker_signal = None

616

if os.WIFEXITED(condition):

617

self.last_checker_status = os.WEXITSTATUS(condition)

1059

618

if self.last_checker_status == 0:

1060

619

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

1061

620

vars(self))

1062

621

self.checked_ok()

1063

622

else:

1064

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

623

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

624

vars(self))

1065

625

else:

1066

626

self.last_checker_status = -1

1067

self.last_checker_signal = -returncode

1068

627

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

1069

628

vars(self))

1070

return False

1071

629

1072

630

def checked_ok(self):

1073

631

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

1074

632

self.last_checked_ok = datetime.datetime.utcnow()

1075

633

self.last_checker_status = 0

1076

self.last_checker_signal = None

1077

634

self.bump_timeout()

1078

635

1079

636

def bump_timeout(self, timeout=None):

1080

637

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

1081

638

if timeout is None:

1082

639

timeout = self.timeout

1083

640

if self.disable_initiator_tag is not None:

1084

GLib.source_remove(self.disable_initiator_tag)

1085

self.disable_initiator_tag = None

641

gobject.source_remove(self.disable_initiator_tag)

1086

642

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

1087

self.disable_initiator_tag = GLib.timeout_add(

1088

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1089

646

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

1090

647

1091

648

def need_approval(self):

1092

649

self.last_approval_request = datetime.datetime.utcnow()

1093

650

1094

651

def start_checker(self):

1095

652

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

1096

653

1097

654

If a checker already exists, leave it running and do

1098

655

nothing."""

1099

656

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

1100

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

1101

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

1102

# would inevitably timeout, since no checker would get a

1103

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

657

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

658

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

659

# client would inevitably timeout, since no checker would get

660

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

1104

661

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

1105

662

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

1106

663

# should be.

1107

1108

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

1109

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

1110

self.checker.join()

1111

self.checker = None

664

665

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

666

try:

667

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

668

except (AttributeError, OSError) as error:

669

if (isinstance(error, OSError)

670

and error.errno != errno.ECHILD):

671

raise error

672

else:

673

if pid:

674

logger.warning("Checker was a zombie")

675

gobject.source_remove(self.checker_callback_tag)

676

self.checker_callback(pid, status,

677

self.current_checker_command)

1112

678

# Start a new checker if needed

1113

679

if self.checker is None:

1114

# Escape attributes for the shell

1115

escaped_attrs = {

1116

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

1117

for attr in self.runtime_expansions}

1118

680

try:

1119

command = self.checker_command % escaped_attrs

1120

except TypeError as error:

1121

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

1122

self.checker_command,

1123

exc_info=error)

1124

return True # Try again later

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

' %s', self.checker_command, error)

698

return True # Try again later

1125

699

self.current_checker_command = command

1126

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

1127

self.name)

1128

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

1129

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

1130

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

1131

# always replaced by /dev/null.)

1132

# The exception is when not debugging but nevertheless

1133

# running in the foreground; use the previously

1134

# created wnull.

1135

popen_args = {"close_fds": True,

1136

"shell": True,

1137

"cwd": "/"}

1138

if (not self.server_settings["debug"]

1139

and self.server_settings["foreground"]):

1140

popen_args.update({"stdout": wnull,

1141

"stderr": wnull})

1142

pipe = multiprocessing.Pipe(duplex=False)

1143

self.checker = multiprocessing.Process(

1144

target=call_pipe,

1145

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

1146

kwargs=popen_args)

1147

self.checker.start()

1148

self.checker_callback_tag = GLib.io_add_watch(

1149

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

1150

self.checker_callback, pipe[0], command)

1151

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

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

self.checker = subprocess.Popen(command,

708

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

720

except OSError as error:

721

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

722

error)

723

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

1152

724

return True

1153

725

1154

726

def stop_checker(self):

1155

727

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

1156

728

if self.checker_callback_tag:

1157

GLib.source_remove(self.checker_callback_tag)

729

gobject.source_remove(self.checker_callback_tag)

1158

730

self.checker_callback_tag = None

1159

731

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

1160

732

return

1161

733

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

1162

self.checker.terminate()

734

try:

735

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

736

#time.sleep(0.5)

737

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

738

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

739

except OSError as error:

740

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

741

raise

1163

742

self.checker = None

1164

743

1165

744

1166

def dbus_service_property(dbus_interface,

1167

signature="v",

1168

access="readwrite",

1169

byte_arrays=False):

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1170

747

"""Decorators for marking methods of a DBusObjectWithProperties to

1171

748

become properties on the D-Bus.

1172

749

1173

750

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

1174

751

and with one argument by "Set".

1175

752

1176

753

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

1177

754

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

1178

755

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

1181

758

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

1182

759

if byte_arrays and signature != "ay":

1183

760

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

1184

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

1185

761

" signature %r" % signature)

1186

762

def decorator(func):

1187

763

func._dbus_is_property = True

1188

764

func._dbus_interface = dbus_interface

1191

767

func._dbus_name = func.__name__

1192

768

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

1193

769

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

1194

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1195

771

return func

1196

1197

772

return decorator

1198

773

1199

774

1200

775

def dbus_interface_annotations(dbus_interface):

1201

"""Decorator for marking functions returning interface annotations

1202

776

"""Decorator for marking functions returning interface annotations.

777

1203

778

Usage:

1204

779

1205

780

@dbus_interface_annotations("org.example.Interface")

1206

781

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

1207

782

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

1208

783

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

1209

784

"false"}

1210

785

"""

1211

1212

786

def decorator(func):

1213

787

func._dbus_is_interface = True

1214

788

func._dbus_interface = dbus_interface

1215

789

func._dbus_name = dbus_interface

1216

790

return func

1217

1218

791

return decorator

1219

792

1220

793

1221

794

def dbus_annotations(annotations):

1222

795

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

1223

796

Usage:

1224

1225

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

1226

"org.freedesktop.DBus.Property."

1227

"EmitsChangedSignal": "false"})

797

1228

798

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

1229

799

access="r")

800

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

801

"org.freedesktop.DBus.Property."

802

"EmitsChangedSignal": "false"})

1230

803

def Property_dbus_property(self):

1231

804

return dbus.Boolean(False)

1232

1233

See also the DBusObjectWithAnnotations class.

1234

805

"""

1235

1236

806

def decorator(func):

1237

807

func._dbus_annotations = annotations

1238

808

return func

1239

1240

809

return decorator

1241

810

1242

811

1243

812

class DBusPropertyException(dbus.exceptions.DBusException):

1244

813

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

1245

814

"""

1246

pass

815

def __unicode__(self):

816

return unicode(str(self))

1247

817

1248

818

1249

819

class DBusPropertyAccessException(DBusPropertyException):

1258

828

pass

1259

829

1260

830

1261

class DBusObjectWithAnnotations(dbus.service.Object):

1262

"""A D-Bus object with annotations.

1263

1264

Classes inheriting from this can use the dbus_annotations

1265

decorator to add annotations to methods or signals.

831

class DBusObjectWithProperties(dbus.service.Object):

832

"""A D-Bus object with properties.

833

834

Classes inheriting from this can use the dbus_service_property

835

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

836

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

1266

837

"""

1267

838

1268

839

@staticmethod

1269

840

def _is_dbus_thing(thing):

1270

841

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

1271

842

1272

843

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

1273

844

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

1274

845

"""

1275

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

846

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

1276

847

False)

1277

848

1278

849

def _get_all_dbus_things(self, thing):

1279

850

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

1280

851

"""

1281

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

852

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

853

name),

1282

854

athing.__get__(self))

1283

855

for cls in self.__class__.__mro__

1284

856

for name, athing in

1285

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

1286

1287

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1288

out_signature="s",

1289

path_keyword='object_path',

1290

connection_keyword='connection')

1291

def Introspect(self, object_path, connection):

1292

"""Overloading of standard D-Bus method.

1293

1294

Inserts annotation tags on methods and signals.

1295

"""

1296

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

1297

connection)

1298

try:

1299

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

1300

1301

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

1302

# Add annotation tags

1303

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

1304

for tag in if_tag.getElementsByTagName(typ):

1305

annots = dict()

1306

for name, prop in (self.

1307

_get_all_dbus_things(typ)):

1308

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

1309

and prop._dbus_interface

1310

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

1311

annots.update(getattr(

1312

prop, "_dbus_annotations", {}))

1313

for name, value in annots.items():

1314

ann_tag = document.createElement(

1315

"annotation")

1316

ann_tag.setAttribute("name", name)

1317

ann_tag.setAttribute("value", value)

1318

tag.appendChild(ann_tag)

1319

# Add interface annotation tags

1320

for annotation, value in dict(

1321

itertools.chain.from_iterable(

1322

annotations().items()

1323

for name, annotations

1324

in self._get_all_dbus_things("interface")

1325

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

1326

)).items():

1327

ann_tag = document.createElement("annotation")

1328

ann_tag.setAttribute("name", annotation)

1329

ann_tag.setAttribute("value", value)

1330

if_tag.appendChild(ann_tag)

1331

# Fix argument name for the Introspect method itself

1332

if (if_tag.getAttribute("name")

1333

== dbus.INTROSPECTABLE_IFACE):

1334

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

1335

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

1336

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

1337

if (arg.getAttribute("direction")

1338

== "out"):

1339

arg.setAttribute("name",

1340

"xml_data")

1341

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

1342

document.unlink()

1343

except (AttributeError, xml.dom.DOMException,

1344

xml.parsers.expat.ExpatError) as error:

1345

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

1346

exc_info=error)

1347

return xmlstring

1348

1349

1350

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1351

"""A D-Bus object with properties.

1352

1353

Classes inheriting from this can use the dbus_service_property

1354

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

1355

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

1356

"""

1357

857

inspect.getmembers(cls,

858

self._is_dbus_thing(thing)))

859

1358

860

def _get_dbus_property(self, interface_name, property_name):

1359

861

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

1360

862

property with the specified name and interface.

1361

863

"""

1362

for cls in self.__class__.__mro__:

1363

for name, value in inspect.getmembers(

1364

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

864

for cls in self.__class__.__mro__:

865

for name, value in (inspect.getmembers

866

(cls,

867

self._is_dbus_thing("property"))):

1365

868

if (value._dbus_name == property_name

1366

869

and value._dbus_interface == interface_name):

1367

870

return value.__get__(self)

1368

871

1369

872

# No such property

1370

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

1371

self.dbus_object_path, interface_name, property_name))

1372

1373

@classmethod

1374

def _get_all_interface_names(cls):

1375

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

1376

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

1377

"_dbus_interface", None)

1378

for x in (inspect.getmro(cls))

1379

for attr in dir(x))

1380

if name is not None)

1381

1382

@dbus.service.method(dbus.PROPERTIES_IFACE,

1383

in_signature="ss",

873

raise DBusPropertyNotFound(self.dbus_object_path + ":"

874

+ interface_name + "."

875

+ property_name)

876

877

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

1384

878

out_signature="v")

1385

879

def Get(self, interface_name, property_name):

1386

880

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

1392

886

if not hasattr(value, "variant_level"):

1393

887

return value

1394

888

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

1395

889

1396

890

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

1397

891

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

1398

892

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

1404

898

# The byte_arrays option is not supported yet on

1405

899

# signatures other than "ay".

1406

900

if prop._dbus_signature != "ay":

1407

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

1408

"'ay' signature {!r}"

1409

.format(prop._dbus_signature))

901

raise ValueError

1410

902

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

1411

903

for byte in value))

1412

904

prop(value)

1413

1414

@dbus.service.method(dbus.PROPERTIES_IFACE,

1415

in_signature="s",

905

906

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

1416

907

out_signature="a{sv}")

1417

908

def GetAll(self, interface_name):

1418

909

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

1419

910

standard.

1420

911

1421

912

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

1422

913

"""

1423

914

properties = {}

1433

924

if not hasattr(value, "variant_level"):

1434

925

properties[name] = value

1435

926

continue

1436

properties[name] = type(value)(

1437

value, variant_level=value.variant_level + 1)

927

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

928

value.variant_level+1)

1438

929

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

1439

1440

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

1441

def PropertiesChanged(self, interface_name, changed_properties,

1442

invalidated_properties):

1443

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

1444

standard.

1445

"""

1446

pass

1447

930

1448

931

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1449

932

out_signature="s",

1450

933

path_keyword='object_path',

1451

934

connection_keyword='connection')

1452

935

def Introspect(self, object_path, connection):

1453

936

"""Overloading of standard D-Bus method.

1454

937

1455

938

Inserts property tags and interface annotation tags.

1456

939

"""

1457

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1458

object_path,

1459

connection)

940

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

941

connection)

1460

942

try:

1461

943

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

1462

1463

944

def make_tag(document, name, prop):

1464

945

e = document.createElement("property")

1465

946

e.setAttribute("name", name)

1466

947

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

1467

948

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

1468

949

return e

1469

1470

950

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

1471

951

# Add property tags

1472

952

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

1475

955

if prop._dbus_interface

1476

956

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

1477

957

if_tag.appendChild(tag)

1478

# Add annotation tags for properties

1479

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

1480

annots = dict()

1481

for name, prop in self._get_all_dbus_things(

1482

"property"):

1483

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

1484

and prop._dbus_interface

1485

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

1486

annots.update(getattr(

1487

prop, "_dbus_annotations", {}))

1488

for name, value in annots.items():

1489

ann_tag = document.createElement(

1490

"annotation")

1491

ann_tag.setAttribute("name", name)

1492

ann_tag.setAttribute("value", value)

1493

tag.appendChild(ann_tag)

958

# Add annotation tags

959

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

960

for tag in if_tag.getElementsByTagName(typ):

961

annots = dict()

962

for name, prop in (self.

963

_get_all_dbus_things(typ)):

964

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

965

and prop._dbus_interface

966

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

967

annots.update(getattr

968

(prop,

969

"_dbus_annotations",

970

{}))

971

for name, value in annots.iteritems():

972

ann_tag = document.createElement(

973

"annotation")

974

ann_tag.setAttribute("name", name)

975

ann_tag.setAttribute("value", value)

976

tag.appendChild(ann_tag)

977

# Add interface annotation tags

978

for annotation, value in dict(

979

itertools.chain(

980

*(annotations().iteritems()

981

for name, annotations in

982

self._get_all_dbus_things("interface")

983

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

984

))).iteritems():

985

ann_tag = document.createElement("annotation")

986

ann_tag.setAttribute("name", annotation)

987

ann_tag.setAttribute("value", value)

988

if_tag.appendChild(ann_tag)

1494

989

# Add the names to the return values for the

1495

990

# "org.freedesktop.DBus.Properties" methods

1496

991

if (if_tag.getAttribute("name")

1511

1006

except (AttributeError, xml.dom.DOMException,

1512

1007

xml.parsers.expat.ExpatError) as error:

1513

1008

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

1514

exc_info=error)

1515

return xmlstring

1516

1517

1518

try:

1519

dbus.OBJECT_MANAGER_IFACE

1520

except AttributeError:

1521

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

1522

1523

1524

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1525

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

1526

1527

Classes inheriting from this exposes the standard

1528

GetManagedObjects call and the InterfacesAdded and

1529

InterfacesRemoved signals on the standard

1530

"org.freedesktop.DBus.ObjectManager" interface.

1531

1532

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

1533

manually.

1534

"""

1535

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1536

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

1537

def GetManagedObjects(self):

1538

"""This function must be overridden"""

1539

raise NotImplementedError()

1540

1541

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def InterfacesAdded(self, object_path, interfaces_and_properties):

1544

pass

1545

1546

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

1547

def InterfacesRemoved(self, object_path, interfaces):

1548

pass

1549

1550

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1551

out_signature="s",

1552

path_keyword='object_path',

1553

connection_keyword='connection')

1554

def Introspect(self, object_path, connection):

1555

"""Overloading of standard D-Bus method.

1556

1557

Override return argument name of GetManagedObjects to be

1558

"objpath_interfaces_and_properties"

1559

"""

1560

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1561

object_path,

1562

connection)

1563

try:

1564

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

1565

1566

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

1567

# Fix argument name for the GetManagedObjects method

1568

if (if_tag.getAttribute("name")

1569

== dbus.OBJECT_MANAGER_IFACE):

1570

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

1571

if (cn.getAttribute("name")

1572

== "GetManagedObjects"):

1573

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

1574

if (arg.getAttribute("direction")

1575

== "out"):

1576

arg.setAttribute(

1577

"name",

1578

"objpath_interfaces"

1579

"_and_properties")

1580

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

1581

document.unlink()

1582

except (AttributeError, xml.dom.DOMException,

1583

xml.parsers.expat.ExpatError) as error:

1584

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

1585

exc_info=error)

1586

return xmlstring

1587

1588

1589

def datetime_to_dbus(dt, variant_level=0):

1009

error)

1010

return xmlstring

1011

1012

1013

def datetime_to_dbus (dt, variant_level=0):

1590

1014

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

1591

1015

if dt is None:

1592

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

1593

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

1594

1595

1596

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1597

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

1598

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

1599

interface names according to the "alt_interface_names" mapping.

1600

Usage:

1601

1602

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

1603

"net.example.AlternateInterface"})

1604

class SampleDBusObject(dbus.service.Object):

1605

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

1606

def SampleDBusMethod():

1607

pass

1608

1609

The above "SampleDBusMethod" on "SampleDBusObject" will be

1610

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

1611

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

1612

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

1613

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

1614

1615

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

1616

(from DBusObjectWithProperties) and interfaces (from the

1617

dbus_interface_annotations decorator).

1016

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

1017

return dbus.String(dt.isoformat(),

1018

variant_level=variant_level)

1019

1020

1021

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1022

.__metaclass__):

1023

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

1024

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

1618

1025

"""

1619

1620

def wrapper(cls):

1621

for orig_interface_name, alt_interface_name in (

1622

alt_interface_names.items()):

1623

attr = {}

1624

interface_names = set()

1625

# Go though all attributes of the class

1626

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

1026

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

1027

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

1028

# methods, signals, or properties in them

1029

old_interface_names = []

1030

for base in (b for b in bases

1031

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

1032

# Go though all attributes of the base class

1033

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

1627

1034

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

1628

1035

# with the wrong interface name

1629

1036

if (not hasattr(attribute, "_dbus_interface")

1630

or not attribute._dbus_interface.startswith(

1631

orig_interface_name)):

1037

or not attribute._dbus_interface

1038

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

1632

1039

continue

1633

1040

# Create an alternate D-Bus interface name based on

1634

1041

# the current name

1635

alt_interface = attribute._dbus_interface.replace(

1636

orig_interface_name, alt_interface_name)

1637

interface_names.add(alt_interface)

1042

alt_interface = (attribute._dbus_interface

1043

.replace("se.recompile.Mandos",

1044

"se.bsnet.fukt.Mandos"))

1045

if alt_interface != attribute._dbus_interface:

1046

old_interface_names.append(alt_interface)

1638

1047

# Is this a D-Bus signal?

1639

1048

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

1640

# Extract the original non-method undecorated

1641

# function by black magic

1642

if sys.version_info.major == 2:

1643

nonmethod_func = (dict(

1049

# Extract the original non-method function by

1050

# black magic

1051

nonmethod_func = (dict(

1644

1052

zip(attribute.func_code.co_freevars,

1645

attribute.__closure__))

1646

["func"].cell_contents)

1647

else:

1648

nonmethod_func = (dict(

1649

zip(attribute.__code__.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1053

attribute.__closure__))["func"]

1054

.cell_contents)

1652

1055

# Create a new, but exactly alike, function

1653

1056

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

1654

1057

# with the alternate D-Bus interface name

1655

new_function = copy_function(nonmethod_func)

1656

new_function = (dbus.service.signal(

1657

alt_interface,

1658

attribute._dbus_signature)(new_function))

1058

new_function = (dbus.service.signal

1059

(alt_interface,

1060

attribute._dbus_signature)

1061

(types.FunctionType(

1062

nonmethod_func.func_code,

1063

nonmethod_func.func_globals,

1064

nonmethod_func.func_name,

1065

nonmethod_func.func_defaults,

1066

nonmethod_func.func_closure)))

1659

1067

# Copy annotations, if any

1660

1068

try:

1661

new_function._dbus_annotations = dict(

1662

attribute._dbus_annotations)

1069

new_function._dbus_annotations = (

1070

dict(attribute._dbus_annotations))

1663

1071

except AttributeError:

1664

1072

pass

1665

1666

1073

# Define a creator of a function to call both the

1667

# original and alternate functions, so both the

1668

# original and alternate signals gets sent when

1669

# the function is called

1074

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

1075

# signals gets sent when the function is called

1670

1076

def fixscope(func1, func2):

1671

1077

"""This function is a scope container to pass

1672

1078

func1 and func2 to the "call_both" function

1673

1079

outside of its arguments"""

1674

1675

@functools.wraps(func2)

1676

1080

def call_both(*args, **kwargs):

1677

1081

"""This function will emit two D-Bus

1678

1082

signals by calling func1 and func2"""

1679

1083

func1(*args, **kwargs)

1680

1084

func2(*args, **kwargs)

1681

# Make wrapper function look like a D-Bus

1682

# signal

1683

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

1684

if name.startswith("_dbus_"):

1685

setattr(call_both, name, attr)

1686

1687

1085

return call_both

1688

1086

# Create the "call_both" function and add it to

1689

1087

# the class

1690

attr[attrname] = fixscope(attribute, new_function)

1088

attr[attrname] = fixscope(attribute,

1089

new_function)

1691

1090

# Is this a D-Bus method?

1692

1091

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

1693

1092

# Create a new, but exactly alike, function

1694

1093

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

1695

1094

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

1696

1095

# to the class.

1697

attr[attrname] = (

1698

dbus.service.method(

1699

alt_interface,

1700

attribute._dbus_in_signature,

1701

attribute._dbus_out_signature)

1702

(copy_function(attribute)))

1096

attr[attrname] = (dbus.service.method

1097

(alt_interface,

1098

attribute._dbus_in_signature,

1099

attribute._dbus_out_signature)

1100

(types.FunctionType

1101

(attribute.func_code,

1102

attribute.func_globals,

1103

attribute.func_name,

1104

attribute.func_defaults,

1105

attribute.func_closure)))

1703

1106

# Copy annotations, if any

1704

1107

try:

1705

attr[attrname]._dbus_annotations = dict(

1706

attribute._dbus_annotations)

1108

attr[attrname]._dbus_annotations = (

1109

dict(attribute._dbus_annotations))

1707

1110

except AttributeError:

1708

1111

pass

1709

1112

# Is this a D-Bus property?

1712

1115

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

1713

1116

# property with the alternate D-Bus interface

1714

1117

# name. Add it to the class.

1715

attr[attrname] = (dbus_service_property(

1716

alt_interface, attribute._dbus_signature,

1717

attribute._dbus_access,

1718

attribute._dbus_get_args_options

1719

["byte_arrays"])

1720

(copy_function(attribute)))

1118

attr[attrname] = (dbus_service_property

1119

(alt_interface,

1120

attribute._dbus_signature,

1121

attribute._dbus_access,

1122

attribute

1123

._dbus_get_args_options

1124

["byte_arrays"])

1125

(types.FunctionType

1126

(attribute.func_code,

1127

attribute.func_globals,

1128

attribute.func_name,

1129

attribute.func_defaults,

1130

attribute.func_closure)))

1721

1131

# Copy annotations, if any

1722

1132

try:

1723

attr[attrname]._dbus_annotations = dict(

1724

attribute._dbus_annotations)

1133

attr[attrname]._dbus_annotations = (

1134

dict(attribute._dbus_annotations))

1725

1135

except AttributeError:

1726

1136

pass

1727

1137

# Is this a D-Bus interface?

1730

1140

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

1731

1141

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

1732

1142

# to the class.

1733

attr[attrname] = (

1734

dbus_interface_annotations(alt_interface)

1735

(copy_function(attribute)))

1736

if deprecate:

1737

# Deprecate all alternate interfaces

1738

iname = "_AlternateDBusNames_interface_annotation{}"

1739

for interface_name in interface_names:

1740

1741

@dbus_interface_annotations(interface_name)

1742

def func(self):

1743

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

1744

"true"}

1745

# Find an unused name

1746

for aname in (iname.format(i)

1747

for i in itertools.count()):

1748

if aname not in attr:

1749

attr[aname] = func

1750

break

1751

if interface_names:

1752

# Replace the class with a new subclass of it with

1753

# methods, signals, etc. as created above.

1754

if sys.version_info.major == 2:

1755

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

1756

(cls, ), attr)

1757

else:

1758

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

1759

(cls, ), attr)

1760

return cls

1761

1762

return wrapper

1763

1764

1765

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

1766

"se.bsnet.fukt.Mandos"})

1143

attr[attrname] = (dbus_interface_annotations

1144

(alt_interface)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1151

# Deprecate all old interfaces

1152

basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1153

for old_interface_name in old_interface_names:

1154

@dbus_interface_annotations(old_interface_name)

1155

def func(self):

1156

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

1157

# Find an unused name

1158

for aname in (basename.format(i) for i in

1159

itertools.count()):

1160

if aname not in attr:

1161

attr[aname] = func

1162

break

1163

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

1164

1165

1767

1166

class ClientDBus(Client, DBusObjectWithProperties):

1768

1167

"""A Client class using D-Bus

1769

1168

1770

1169

Attributes:

1771

1170

dbus_object_path: dbus.ObjectPath

1772

1171

bus: dbus.SystemBus()

1773

1172

"""

1774

1173

1775

1174

runtime_expansions = (Client.runtime_expansions

1776

+ ("dbus_object_path", ))

1777

1778

_interface = "se.recompile.Mandos.Client"

1779

1175

+ ("dbus_object_path",))

1176

1780

1177

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

1781

1782

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

1178

1179

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

1783

1180

self.bus = bus

1784

1181

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

1785

1182

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

1786

1183

# the D-Bus

1787

client_object_name = str(self.name).translate(

1184

client_object_name = unicode(self.name).translate(

1788

1185

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

1789

1186

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

1790

self.dbus_object_path = dbus.ObjectPath(

1791

"/clients/" + client_object_name)

1187

self.dbus_object_path = (dbus.ObjectPath

1188

("/clients/" + client_object_name))

1792

1189

DBusObjectWithProperties.__init__(self, self.bus,

1793

1190

self.dbus_object_path)

1794

1795

def notifychangeproperty(transform_func, dbus_name,

1796

type_func=lambda x: x,

1797

variant_level=1,

1798

invalidate_only=False,

1799

_interface=_interface):

1191

1192

def notifychangeproperty(transform_func,

1193

dbus_name, type_func=lambda x: x,

1194

variant_level=1):

1800

1195

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

1801

1196

its changes to DBus.

1802

1197

1803

1198

transform_fun: Function that takes a value and a variant_level

1804

1199

and transforms it to a D-Bus type.

1805

1200

dbus_name: D-Bus name of the variable

1807

1202

to the D-Bus. Default: no transform

1808

1203

variant_level: D-Bus variant level. Default: 1

1809

1204

"""

1810

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

1811

1205

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

1812

1206

def setter(self, value):

1813

1207

if hasattr(self, "dbus_object_path"):

1814

1208

if (not hasattr(self, attrname) or

1815

1209

type_func(getattr(self, attrname, None))

1816

1210

!= type_func(value)):

1817

if invalidate_only:

1818

self.PropertiesChanged(

1819

_interface, dbus.Dictionary(),

1820

dbus.Array((dbus_name, )))

1821

else:

1822

dbus_value = transform_func(

1823

type_func(value),

1824

variant_level=variant_level)

1825

self.PropertyChanged(dbus.String(dbus_name),

1826

dbus_value)

1827

self.PropertiesChanged(

1828

_interface,

1829

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

1830

dbus_value}),

1831

dbus.Array())

1211

dbus_value = transform_func(type_func(value),

1212

variant_level

1213

=variant_level)

1214

self.PropertyChanged(dbus.String(dbus_name),

1215

dbus_value)

1832

1216

setattr(self, attrname, value)

1833

1217

1834

1218

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

1835

1219

1220

1836

1221

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1837

1222

approvals_pending = notifychangeproperty(dbus.Boolean,

1838

1223

"ApprovalPending",

1839

type_func=bool)

1224

type_func = bool)

1840

1225

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

1841

1226

last_enabled = notifychangeproperty(datetime_to_dbus,

1842

1227

"LastEnabled")

1843

checker = notifychangeproperty(

1844

dbus.Boolean, "CheckerRunning",

1845

type_func=lambda checker: checker is not None)

1228

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

1229

type_func = lambda checker:

1230

checker is not None)

1846

1231

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1847

1232

"LastCheckedOK")

1848

1233

last_checker_status = notifychangeproperty(dbus.Int16,

1851

1236

datetime_to_dbus, "LastApprovalRequest")

1852

1237

approved_by_default = notifychangeproperty(dbus.Boolean,

1853

1238

"ApprovedByDefault")

1854

approval_delay = notifychangeproperty(

1855

dbus.UInt64, "ApprovalDelay",

1856

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

1239

approval_delay = notifychangeproperty(dbus.UInt64,

1240

"ApprovalDelay",

1241

type_func =

1242

timedelta_to_milliseconds)

1857

1243

approval_duration = notifychangeproperty(

1858

1244

dbus.UInt64, "ApprovalDuration",

1859

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

1245

type_func = timedelta_to_milliseconds)

1860

1246

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

1861

timeout = notifychangeproperty(

1862

dbus.UInt64, "Timeout",

1863

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

1247

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

1248

type_func =

1249

timedelta_to_milliseconds)

1864

1250

extended_timeout = notifychangeproperty(

1865

1251

dbus.UInt64, "ExtendedTimeout",

1866

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

1867

interval = notifychangeproperty(

1868

dbus.UInt64, "Interval",

1869

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

1252

type_func = timedelta_to_milliseconds)

1253

interval = notifychangeproperty(dbus.UInt64,

1254

"Interval",

1255

type_func =

1256

timedelta_to_milliseconds)

1870

1257

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

1871

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

1872

invalidate_only=True)

1873

1258

1874

1259

del notifychangeproperty

1875

1260

1876

1261

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

1877

1262

try:

1878

1263

self.remove_from_connection()

1881

1266

if hasattr(DBusObjectWithProperties, "__del__"):

1882

1267

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

1883

1268

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

1884

1885

def checker_callback(self, source, condition,

1886

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

1887

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

1888

connection, command, *args,

1889

**kwargs)

1890

exitstatus = self.last_checker_status

1891

if exitstatus >= 0:

1269

1270

def checker_callback(self, pid, condition, command,

1271

*args, **kwargs):

1272

self.checker_callback_tag = None

1273

self.checker = None

1274

if os.WIFEXITED(condition):

1275

exitstatus = os.WEXITSTATUS(condition)

1892

1276

# Emit D-Bus signal

1893

1277

self.CheckerCompleted(dbus.Int16(exitstatus),

1894

# This is specific to GNU libC

1895

dbus.Int64(exitstatus << 8),

1278

dbus.Int64(condition),

1896

1279

dbus.String(command))

1897

1280

else:

1898

1281

# Emit D-Bus signal

1899

1282

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

1900

dbus.Int64(

1901

# This is specific to GNU libC

1902

(exitstatus << 8)

1903

| self.last_checker_signal),

1283

dbus.Int64(condition),

1904

1284

dbus.String(command))

1905

return ret

1906

1285

1286

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

1287

*args, **kwargs)

1288

1907

1289

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

1908

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

1290

old_checker = self.checker

1291

if self.checker is not None:

1292

old_checker_pid = self.checker.pid

1293

else:

1294

old_checker_pid = None

1909

1295

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

1910

1296

# Only if new checker process was started

1911

1297

if (self.checker is not None

1913

1299

# Emit D-Bus signal

1914

1300

self.CheckerStarted(self.current_checker_command)

1915

1301

return r

1916

1302

1917

1303

def _reset_approved(self):

1918

1304

self.approved = None

1919

1305

return False

1920

1306

1921

1307

def approve(self, value=True):

1308

self.send_changedstate()

1922

1309

self.approved = value

1923

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

1924

* 1000), self._reset_approved)

1925

self.send_changedstate()

1926

1927

# D-Bus methods, signals & properties

1928

1929

# Interfaces

1930

1931

# Signals

1932

1310

gobject.timeout_add(timedelta_to_milliseconds

1311

(self.approval_duration),

1312

self._reset_approved)

1313

1314

1315

## D-Bus methods, signals & properties

1316

_interface = "se.recompile.Mandos.Client"

1317

1318

## Interfaces

1319

1320

@dbus_interface_annotations(_interface)

1321

def _foo(self):

1322

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

1323

"false"}

1324

1325

## Signals

1326

1933

1327

# CheckerCompleted - signal

1934

1328

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

1935

1329

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

1936

1330

"D-Bus signal"

1937

1331

pass

1938

1332

1939

1333

# CheckerStarted - signal

1940

1334

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

1941

1335

def CheckerStarted(self, command):

1942

1336

"D-Bus signal"

1943

1337

pass

1944

1338

1945

1339

# PropertyChanged - signal

1946

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

1947

1340

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

1948

1341

def PropertyChanged(self, property, value):

1949

1342

"D-Bus signal"

1950

1343

pass

1951

1344

1952

1345

# GotSecret - signal

1953

1346

@dbus.service.signal(_interface)

1954

1347

def GotSecret(self):

1957

1350

server to mandos-client

1958

1351

"""

1959

1352

pass

1960

1353

1961

1354

# Rejected - signal

1962

1355

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

1963

1356

def Rejected(self, reason):

1964

1357

"D-Bus signal"

1965

1358

pass

1966

1359

1967

1360

# NeedApproval - signal

1968

1361

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

1969

1362

def NeedApproval(self, timeout, default):

1970

1363

"D-Bus signal"

1971

1364

return self.need_approval()

1972

1973

# Methods

1974

1365

1366

## Methods

1367

1975

1368

# Approve - method

1976

1369

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

1977

1370

def Approve(self, value):

1978

1371

self.approve(value)

1979

1372

1980

1373

# CheckedOK - method

1981

1374

@dbus.service.method(_interface)

1982

1375

def CheckedOK(self):

1983

1376

self.checked_ok()

1984

1377

1985

1378

# Enable - method

1986

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

1987

1379

@dbus.service.method(_interface)

1988

1380

def Enable(self):

1989

1381

"D-Bus method"

1990

1382

self.enable()

1991

1383

1992

1384

# StartChecker - method

1993

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

1994

1385

@dbus.service.method(_interface)

1995

1386

def StartChecker(self):

1996

1387

"D-Bus method"

1997

1388

self.start_checker()

1998

1389

1999

1390

# Disable - method

2000

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

2001

1391

@dbus.service.method(_interface)

2002

1392

def Disable(self):

2003

1393

"D-Bus method"

2004

1394

self.disable()

2005

1395

2006

1396

# StopChecker - method

2007

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

2008

1397

@dbus.service.method(_interface)

2009

1398

def StopChecker(self):

2010

1399

self.stop_checker()

2011

2012

# Properties

2013

1400

1401

## Properties

1402

2014

1403

# ApprovalPending - property

2015

1404

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

2016

1405

def ApprovalPending_dbus_property(self):

2017

1406

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

2018

1407

2019

1408

# ApprovedByDefault - property

2020

@dbus_service_property(_interface,

2021

signature="b",

1409

@dbus_service_property(_interface, signature="b",

2022

1410

access="readwrite")

2023

1411

def ApprovedByDefault_dbus_property(self, value=None):

2024

1412

if value is None: # get

2025

1413

return dbus.Boolean(self.approved_by_default)

2026

1414

self.approved_by_default = bool(value)

2027

1415

2028

1416

# ApprovalDelay - property

2029

@dbus_service_property(_interface,

2030

signature="t",

1417

@dbus_service_property(_interface, signature="t",

2031

1418

access="readwrite")

2032

1419

def ApprovalDelay_dbus_property(self, value=None):

2033

1420

if value is None: # get

2034

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

2035

* 1000)

1421

return dbus.UInt64(self.approval_delay_milliseconds())

2036

1422

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

2037

1423

2038

1424

# ApprovalDuration - property

2039

@dbus_service_property(_interface,

2040

signature="t",

1425

@dbus_service_property(_interface, signature="t",

2041

1426

access="readwrite")

2042

1427

def ApprovalDuration_dbus_property(self, value=None):

2043

1428

if value is None: # get

2044

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

2045

* 1000)

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

2046

1431

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

2047

1432

2048

1433

# Name - property

2049

@dbus_annotations(

2050

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

2051

1434

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

2052

1435

def Name_dbus_property(self):

2053

1436

return dbus.String(self.name)

2054

2055

# KeyID - property

2056

@dbus_annotations(

2057

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

2058

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

2059

def KeyID_dbus_property(self):

2060

return dbus.String(self.key_id)

2061

1437

2062

1438

# Fingerprint - property

2063

@dbus_annotations(

2064

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

2065

1439

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

2066

1440

def Fingerprint_dbus_property(self):

2067

1441

return dbus.String(self.fingerprint)

2068

1442

2069

1443

# Host - property

2070

@dbus_service_property(_interface,

2071

signature="s",

1444

@dbus_service_property(_interface, signature="s",

2072

1445

access="readwrite")

2073

1446

def Host_dbus_property(self, value=None):

2074

1447

if value is None: # get

2075

1448

return dbus.String(self.host)

2076

self.host = str(value)

2077

1449

self.host = unicode(value)

1450

2078

1451

# Created - property

2079

@dbus_annotations(

2080

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

2081

1452

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

2082

1453

def Created_dbus_property(self):

2083

1454

return datetime_to_dbus(self.created)

2084

1455

2085

1456

# LastEnabled - property

2086

1457

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

2087

1458

def LastEnabled_dbus_property(self):

2088

1459

return datetime_to_dbus(self.last_enabled)

2089

1460

2090

1461

# Enabled - property

2091

@dbus_service_property(_interface,

2092

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2093

1463

access="readwrite")

2094

1464

def Enabled_dbus_property(self, value=None):

2095

1465

if value is None: # get

2098

1468

self.enable()

2099

1469

else:

2100

1470

self.disable()

2101

1471

2102

1472

# LastCheckedOK - property

2103

@dbus_service_property(_interface,

2104

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2105

1474

access="readwrite")

2106

1475

def LastCheckedOK_dbus_property(self, value=None):

2107

1476

if value is not None:

2108

1477

self.checked_ok()

2109

1478

return

2110

1479

return datetime_to_dbus(self.last_checked_ok)

2111

1480

2112

1481

# LastCheckerStatus - property

2113

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

1482

@dbus_service_property(_interface, signature="n",

1483

access="read")

2114

1484

def LastCheckerStatus_dbus_property(self):

2115

1485

return dbus.Int16(self.last_checker_status)

2116

1486

2117

1487

# Expires - property

2118

1488

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

2119

1489

def Expires_dbus_property(self):

2120

1490

return datetime_to_dbus(self.expires)

2121

1491

2122

1492

# LastApprovalRequest - property

2123

1493

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

2124

1494

def LastApprovalRequest_dbus_property(self):

2125

1495

return datetime_to_dbus(self.last_approval_request)

2126

1496

2127

1497

# Timeout - property

2128

@dbus_service_property(_interface,

2129

signature="t",

1498

@dbus_service_property(_interface, signature="t",

2130

1499

access="readwrite")

2131

1500

def Timeout_dbus_property(self, value=None):

2132

1501

if value is None: # get

2133

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

2134

old_timeout = self.timeout

1502

return dbus.UInt64(self.timeout_milliseconds())

2135

1503

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

2136

# Reschedule disabling

1504

# Reschedule timeout

2137

1505

if self.enabled:

2138

1506

now = datetime.datetime.utcnow()

2139

self.expires += self.timeout - old_timeout

2140

if self.expires <= now:

1507

time_to_die = timedelta_to_milliseconds(

1508

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

1509

if time_to_die <= 0:

2141

1510

# The timeout has passed

2142

1511

self.disable()

2143

1512

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

2144

1516

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

2145

1517

is None):

2146

1518

return

2147

GLib.source_remove(self.disable_initiator_tag)

2148

self.disable_initiator_tag = GLib.timeout_add(

2149

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

2150

self.disable)

2151

1519

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1523

2152

1524

# ExtendedTimeout - property

2153

@dbus_service_property(_interface,

2154

signature="t",

1525

@dbus_service_property(_interface, signature="t",

2155

1526

access="readwrite")

2156

1527

def ExtendedTimeout_dbus_property(self, value=None):

2157

1528

if value is None: # get

2158

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

2159

* 1000)

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

2160

1530

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

2161

1531

2162

1532

# Interval - property

2163

@dbus_service_property(_interface,

2164

signature="t",

1533

@dbus_service_property(_interface, signature="t",

2165

1534

access="readwrite")

2166

1535

def Interval_dbus_property(self, value=None):

2167

1536

if value is None: # get

2168

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

1537

return dbus.UInt64(self.interval_milliseconds())

2169

1538

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

2170

1539

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

2171

1540

return

2172

1541

if self.enabled:

2173

1542

# Reschedule checker run

2174

GLib.source_remove(self.checker_initiator_tag)

2175

self.checker_initiator_tag = GLib.timeout_add(

2176

value, self.start_checker)

2177

self.start_checker() # Start one now, too

2178

1543

gobject.source_remove(self.checker_initiator_tag)

1544

self.checker_initiator_tag = (gobject.timeout_add

1545

(value, self.start_checker))

1546

self.start_checker() # Start one now, too

1547

2179

1548

# Checker - property

2180

@dbus_service_property(_interface,

2181

signature="s",

1549

@dbus_service_property(_interface, signature="s",

2182

1550

access="readwrite")

2183

1551

def Checker_dbus_property(self, value=None):

2184

1552

if value is None: # get

2185

1553

return dbus.String(self.checker_command)

2186

self.checker_command = str(value)

2187

1554

self.checker_command = unicode(value)

1555

2188

1556

# CheckerRunning - property

2189

@dbus_service_property(_interface,

2190

signature="b",

1557

@dbus_service_property(_interface, signature="b",

2191

1558

access="readwrite")

2192

1559

def CheckerRunning_dbus_property(self, value=None):

2193

1560

if value is None: # get

2196

1563

self.start_checker()

2197

1564

else:

2198

1565

self.stop_checker()

2199

1566

2200

1567

# ObjectPath - property

2201

@dbus_annotations(

2202

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

2203

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

2204

1568

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

2205

1569

def ObjectPath_dbus_property(self):

2206

return self.dbus_object_path # is already a dbus.ObjectPath

2207

1570

return self.dbus_object_path # is already a dbus.ObjectPath

1571

2208

1572

# Secret = property

2209

@dbus_annotations(

2210

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

2211

"invalidates"})

2212

@dbus_service_property(_interface,

2213

signature="ay",

2214

access="write",

2215

byte_arrays=True)

1573

@dbus_service_property(_interface, signature="ay",

1574

access="write", byte_arrays=True)

2216

1575

def Secret_dbus_property(self, value):

2217

self.secret = bytes(value)

2218

1576

self.secret = str(value)

1577

2219

1578

del _interface

2220

1579

2221

1580

2222

1581

class ProxyClient(object):

2223

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

1582

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

2224

1583

self._pipe = child_pipe

2225

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

1584

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

2226

1585

if not self._pipe.recv():

2227

raise KeyError(key_id or fpr)

2228

1586

raise KeyError()

1587

2229

1588

def __getattribute__(self, name):

2230

1589

if name == '_pipe':

2231

1590

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

2234

1593

if data[0] == 'data':

2235

1594

return data[1]

2236

1595

if data[0] == 'function':

2237

2238

1596

def func(*args, **kwargs):

2239

1597

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

2240

1598

return self._pipe.recv()[1]

2241

2242

1599

return func

2243

1600

2244

1601

def __setattr__(self, name, value):

2245

1602

if name == '_pipe':

2246

1603

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

2247

1604

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

2248

1605

2249

1606

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

2250

1611

class ClientHandler(socketserver.BaseRequestHandler, object):

2251

1612

"""A class to handle client connections.

2252

1613

2253

1614

Instantiated once for each connection to handle it.

2254

1615

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

2255

1616

2256

1617

def handle(self):

2257

1618

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

2258

1619

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

2259

str(self.client_address))

1620

unicode(self.client_address))

2260

1621

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

2261

1622

self.server.child_pipe.fileno())

2262

2263

session = gnutls.ClientSession(self.request)

2264

2265

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

2266

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

2267

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

2268

# "+DHE-DSS"))

1623

1624

session = (gnutls.connection

1625

.ClientSession(self.request,

1626

gnutls.connection

1627

.X509Credentials()))

1628

1629

# Note: gnutls.connection.X509Credentials is really a

1630

# generic GnuTLS certificate credentials object so long as

1631

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

1632

# here despite using OpenPGP certificates.

1633

1634

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

1635

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

1636

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

1637

# "+DHE-DSS"))

2269

1638

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

2270

1639

priority = self.server.gnutls_priority

2271

1640

if priority is None:

2272

1641

priority = "NORMAL"

2273

gnutls.priority_set_direct(session._c_object,

2274

priority.encode("utf-8"),

2275

None)

2276

1642

(gnutls.library.functions

1643

.gnutls_priority_set_direct(session._c_object,

1644

priority, None))

1645

2277

1646

# Start communication using the Mandos protocol

2278

1647

# Get protocol number

2279

1648

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

2280

1649

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

2281

1650

try:

2282

1651

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

2283

raise RuntimeError(line)

1652

raise RuntimeError

2284

1653

except (ValueError, IndexError, RuntimeError) as error:

2285

1654

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

2286

1655

return

2287

1656

2288

1657

# Start GnuTLS connection

2289

1658

try:

2290

1659

session.handshake()

2291

except gnutls.Error as error:

1660

except gnutls.errors.GNUTLSError as error:

2292

1661

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

2293

1662

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

2294

1663

# established. Just abandon the request.

2295

1664

return

2296

1665

logger.debug("Handshake succeeded")

2297

1666

2298

1667

approval_required = False

2299

1668

try:

2300

if gnutls.has_rawpk:

2301

fpr = ""

2302

try:

2303

key_id = self.key_id(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

else:

2311

key_id = ""

2312

try:

2313

fpr = self.fingerprint(

2314

self.peer_certificate(session))

2315

except (TypeError, gnutls.Error) as error:

2316

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

2317

return

2318

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

2319

2320

try:

2321

client = ProxyClient(child_pipe, key_id, fpr,

1669

try:

1670

fpr = self.fingerprint(self.peer_certificate

1671

(session))

1672

except (TypeError,

1673

gnutls.errors.GNUTLSError) as error:

1674

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

1675

return

1676

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

1677

1678

try:

1679

client = ProxyClient(child_pipe, fpr,

2322

1680

self.client_address)

2323

1681

except KeyError:

2324

1682

return

2325

1683

2326

1684

if client.approval_delay:

2327

1685

delay = client.approval_delay

2328

1686

client.approvals_pending += 1

2329

1687

approval_required = True

2330

1688

2331

1689

while True:

2332

1690

if not client.enabled:

2333

1691

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

2334

client.name)

1692

client.name)

2335

1693

if self.server.use_dbus:

2336

1694

# Emit D-Bus signal

2337

1695

client.Rejected("Disabled")

2338

1696

return

2339

1697

2340

1698

if client.approved or not client.approval_delay:

2341

# We are approved or approval is disabled

1699

#We are approved or approval is disabled

2342

1700

break

2343

1701

elif client.approved is None:

2344

1702

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

2346

1704

if self.server.use_dbus:

2347

1705

# Emit D-Bus signal

2348

1706

client.NeedApproval(

2349

client.approval_delay.total_seconds()

2350

* 1000, client.approved_by_default)

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

2351

1709

else:

2352

1710

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

2353

1711

client.name)

2355

1713

# Emit D-Bus signal

2356

1714

client.Rejected("Denied")

2357

1715

return

2358

2359

# wait until timeout or approved

1716

1717

#wait until timeout or approved

2360

1718

time = datetime.datetime.now()

2361

1719

client.changedstate.acquire()

2362

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

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

2363

1723

client.changedstate.release()

2364

1724

time2 = datetime.datetime.now()

2365

1725

if (time2 - time) >= delay:

2375

1735

break

2376

1736

else:

2377

1737

delay -= time2 - time

2378

2379

try:

2380

session.send(client.secret)

2381

except gnutls.Error as error:

2382

logger.warning("gnutls send failed",

2383

exc_info=error)

2384

return

2385

1738

1739

sent_size = 0

1740

while sent_size < len(client.secret):

1741

try:

1742

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

1743

except gnutls.errors.GNUTLSError as error:

1744

logger.warning("gnutls send failed")

1745

return

1746

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

1747

sent, len(client.secret)

1748

- (sent_size + sent))

1749

sent_size += sent

1750

2386

1751

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

2387

1752

# bump the timeout using extended_timeout

2388

1753

client.bump_timeout(client.extended_timeout)

2389

1754

if self.server.use_dbus:

2390

1755

# Emit D-Bus signal

2391

1756

client.GotSecret()

2392

1757

2393

1758

finally:

2394

1759

if approval_required:

2395

1760

client.approvals_pending -= 1

2396

1761

try:

2397

1762

session.bye()

2398

except gnutls.Error as error:

2399

logger.warning("GnuTLS bye failed",

2400

exc_info=error)

2401

1763

except gnutls.errors.GNUTLSError as error:

1764

logger.warning("GnuTLS bye failed")

1765

2402

1766

@staticmethod

2403

1767

def peer_certificate(session):

2404

"Return the peer's certificate as a bytestring"

2405

try:

2406

cert_type = gnutls.certificate_type_get2(session._c_object,

2407

gnutls.CTYPE_PEERS)

2408

except AttributeError:

2409

cert_type = gnutls.certificate_type_get(session._c_object)

2410

if gnutls.has_rawpk:

2411

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2412

else:

2413

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2414

# If not a valid certificate type...

2415

if cert_type not in valid_cert_types:

2416

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

2417

valid_cert_types)

2418

# ...return invalid data

2419

return b""

1768

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

1769

# If not an OpenPGP certificate...

1770

if (gnutls.library.functions

1771

.gnutls_certificate_type_get(session._c_object)

1772

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1773

# ...do the normal thing

1774

return session.peer_certificate

2420

1775

list_size = ctypes.c_uint(1)

2421

cert_list = (gnutls.certificate_get_peers

1776

cert_list = (gnutls.library.functions

1777

.gnutls_certificate_get_peers

2422

1778

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

2423

1779

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

2424

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

1780

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

1781

" certificate")

2425

1782

if list_size.value == 0:

2426

1783

return None

2427

1784

cert = cert_list[0]

2428

1785

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

2429

2430

@staticmethod

2431

def key_id(certificate):

2432

"Convert a certificate bytestring to a hexdigit key ID"

2433

# New GnuTLS "datum" with the public key

2434

datum = gnutls.datum_t(

2435

ctypes.cast(ctypes.c_char_p(certificate),

2436

ctypes.POINTER(ctypes.c_ubyte)),

2437

ctypes.c_uint(len(certificate)))

2438

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

2439

# New empty GnuTLS certificate

2440

pubkey = gnutls.pubkey_t()

2441

gnutls.pubkey_init(ctypes.byref(pubkey))

2442

# Import the raw public key into the certificate

2443

gnutls.pubkey_import(pubkey,

2444

ctypes.byref(datum),

2445

gnutls.X509_FMT_DER)

2446

# New buffer for the key ID

2447

buf = ctypes.create_string_buffer(32)

2448

buf_len = ctypes.c_size_t(len(buf))

2449

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

2450

gnutls.pubkey_get_key_id(pubkey,

2451

gnutls.KEYID_USE_SHA256,

2452

ctypes.cast(ctypes.byref(buf),

2453

ctypes.POINTER(ctypes.c_ubyte)),

2454

ctypes.byref(buf_len))

2455

# Deinit the certificate

2456

gnutls.pubkey_deinit(pubkey)

2457

2458

# Convert the buffer to a Python bytestring

2459

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

2460

# Convert the bytestring to hexadecimal notation

2461

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

2462

return hex_key_id

2463

1786

2464

1787

@staticmethod

2465

1788

def fingerprint(openpgp):

2466

1789

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2467

1790

# New GnuTLS "datum" with the OpenPGP public key

2468

datum = gnutls.datum_t(

2469

ctypes.cast(ctypes.c_char_p(openpgp),

2470

ctypes.POINTER(ctypes.c_ubyte)),

2471

ctypes.c_uint(len(openpgp)))

1791

datum = (gnutls.library.types

1792

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

1793

ctypes.POINTER

1794

(ctypes.c_ubyte)),

1795

ctypes.c_uint(len(openpgp))))

2472

1796

# New empty GnuTLS certificate

2473

crt = gnutls.openpgp_crt_t()

2474

gnutls.openpgp_crt_init(ctypes.byref(crt))

1797

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1798

(gnutls.library.functions

1799

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2475

1800

# Import the OpenPGP public key into the certificate

2476

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

2477

gnutls.OPENPGP_FMT_RAW)

1801

(gnutls.library.functions

1802

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

1803

gnutls.library.constants

1804

.GNUTLS_OPENPGP_FMT_RAW))

2478

1805

# Verify the self signature in the key

2479

1806

crtverify = ctypes.c_uint()

2480

gnutls.openpgp_crt_verify_self(crt, 0,

2481

ctypes.byref(crtverify))

1807

(gnutls.library.functions

1808

.gnutls_openpgp_crt_verify_self(crt, 0,

1809

ctypes.byref(crtverify)))

2482

1810

if crtverify.value != 0:

2483

gnutls.openpgp_crt_deinit(crt)

2484

raise gnutls.CertificateSecurityError(code

2485

=crtverify.value)

1811

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1812

raise (gnutls.errors.CertificateSecurityError

1813

("Verify failed"))

2486

1814

# New buffer for the fingerprint

2487

1815

buf = ctypes.create_string_buffer(20)

2488

1816

buf_len = ctypes.c_size_t()

2489

1817

# Get the fingerprint from the certificate into the buffer

2490

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

2491

ctypes.byref(buf_len))

1818

(gnutls.library.functions

1819

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

1820

ctypes.byref(buf_len)))

2492

1821

# Deinit the certificate

2493

gnutls.openpgp_crt_deinit(crt)

1822

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2494

1823

# Convert the buffer to a Python bytestring

2495

1824

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

2496

1825

# Convert the bytestring to hexadecimal notation

2500

1829

2501

1830

class MultiprocessingMixIn(object):

2502

1831

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

2503

2504

1832

def sub_process_main(self, request, address):

2505

1833

try:

2506

1834

self.finish_request(request, address)

2507

1835

except Exception:

2508

1836

self.handle_error(request, address)

2509

1837

self.close_request(request)

2510

1838

2511

1839

def process_request(self, request, address):

2512

1840

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

2513

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

2514

args=(request, address))

1841

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

1842

args = (request,

1843

address))

2515

1844

proc.start()

2516

1845

return proc

2517

1846

2518

1847

2519

1848

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2520

1849

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

2521

2522

1850

def process_request(self, request, client_address):

2523

1851

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

2524

1852

2525

1853

This function creates a new pipe in self.pipe

2526

1854

"""

2527

1855

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2528

1856

2529

1857

proc = MultiprocessingMixIn.process_request(self, request,

2530

1858

client_address)

2531

1859

self.child_pipe.close()

2532

1860

self.add_pipe(parent_pipe, proc)

2533

1861

2534

1862

def add_pipe(self, parent_pipe, proc):

2535

1863

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

2536

raise NotImplementedError()

1864

raise NotImplementedError

2537

1865

2538

1866

2539

1867

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2540

1868

socketserver.TCPServer, object):

2541

1869

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

2542

1870

2543

1871

Attributes:

2544

1872

enabled: Boolean; whether this server is activated yet

2545

1873

interface: None or a network interface name (string)

2546

1874

use_ipv6: Boolean; to use IPv6 or not

2547

1875

"""

2548

2549

1876

def __init__(self, server_address, RequestHandlerClass,

2550

interface=None,

2551

use_ipv6=True,

2552

socketfd=None):

2553

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

2554

creating a new one with socket.socket().

2555

"""

1877

interface=None, use_ipv6=True):

2556

1878

self.interface = interface

2557

1879

if use_ipv6:

2558

1880

self.address_family = socket.AF_INET6

2559

if socketfd is not None:

2560

# Save the file descriptor

2561

self.socketfd = socketfd

2562

# Save the original socket.socket() function

2563

self.socket_socket = socket.socket

2564

2565

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

2566

#

2567

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

2568

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

2569

# patching socket.socket.)

2570

#

2571

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

2572

@functools.wraps(socket.socket)

2573

def socket_wrapper(*args, **kwargs):

2574

# Restore original function so subsequent calls are

2575

# not affected.

2576

socket.socket = self.socket_socket

2577

del self.socket_socket

2578

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

2579

# saved file descriptor.

2580

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

2581

# Replace socket.socket() function with wrapper

2582

socket.socket = socket_wrapper

2583

# The socketserver.TCPServer.__init__ will call

2584

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

2585

# socket_wrapper(), if socketfd was set.

2586

1881

socketserver.TCPServer.__init__(self, server_address,

2587

1882

RequestHandlerClass)

2588

2589

1883

def server_bind(self):

2590

1884

"""This overrides the normal server_bind() function

2591

1885

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

2592

1886

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

2593

global SO_BINDTODEVICE

2594

1887

if self.interface is not None:

2595

1888

if SO_BINDTODEVICE is None:

2596

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

2597

# common enough.

2598

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

2599

SO_BINDTODEVICE = 25

2600

try:

2601

self.socket.setsockopt(

2602

socket.SOL_SOCKET, SO_BINDTODEVICE,

2603

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

2604

except socket.error as error:

2605

if error.errno == errno.EPERM:

2606

logger.error("No permission to bind to"

2607

" interface %s", self.interface)

2608

elif error.errno == errno.ENOPROTOOPT:

2609

logger.error("SO_BINDTODEVICE not available;"

2610

" cannot bind to interface %s",

2611

self.interface)

2612

elif error.errno == errno.ENODEV:

2613

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

2614

" cannot bind", self.interface)

2615

else:

2616

raise

1889

logger.error("SO_BINDTODEVICE does not exist;"

1890

" cannot bind to interface %s",

1891

self.interface)

1892

else:

1893

try:

1894

self.socket.setsockopt(socket.SOL_SOCKET,

1895

SO_BINDTODEVICE,

1896

str(self.interface

1897

+ '\0'))

1898

except socket.error as error:

1899

if error[0] == errno.EPERM:

1900

logger.error("No permission to"

1901

" bind to interface %s",

1902

self.interface)

1903

elif error[0] == errno.ENOPROTOOPT:

1904

logger.error("SO_BINDTODEVICE not available;"

1905

" cannot bind to interface %s",

1906

self.interface)

1907

else:

1908

raise

2617

1909

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

2618

1910

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

2619

1911

if not self.server_address[0]:

2620

1912

if self.address_family == socket.AF_INET6:

2621

any_address = "::" # in6addr_any

1913

any_address = "::" # in6addr_any

2622

1914

else:

2623

any_address = "0.0.0.0" # INADDR_ANY

1915

any_address = socket.INADDR_ANY

2624

1916

self.server_address = (any_address,

2625

1917

self.server_address[1])

2626

1918

elif not self.server_address[1]:

2627

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

1919

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

1920

0)

2628

1921

# if self.interface:

2629

1922

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

2630

1923

# 0, # port

2636

1929

2637

1930

class MandosServer(IPv6_TCPServer):

2638

1931

"""Mandos server.

2639

1932

2640

1933

Attributes:

2641

1934

clients: set of Client objects

2642

1935

gnutls_priority GnuTLS priority string

2643

1936

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

2644

2645

Assumes a GLib.MainLoop event loop.

1937

1938

Assumes a gobject.MainLoop event loop.

2646

1939

"""

2647

2648

1940

def __init__(self, server_address, RequestHandlerClass,

2649

interface=None,

2650

use_ipv6=True,

2651

clients=None,

2652

gnutls_priority=None,

2653

use_dbus=True,

2654

socketfd=None):

1941

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

1942

gnutls_priority=None, use_dbus=True):

2655

1943

self.enabled = False

2656

1944

self.clients = clients

2657

1945

if self.clients is None:

2660

1948

self.gnutls_priority = gnutls_priority

2661

1949

IPv6_TCPServer.__init__(self, server_address,

2662

1950

RequestHandlerClass,

2663

interface=interface,

2664

use_ipv6=use_ipv6,

2665

socketfd=socketfd)

2666

1951

interface = interface,

1952

use_ipv6 = use_ipv6)

2667

1953

def server_activate(self):

2668

1954

if self.enabled:

2669

1955

return socketserver.TCPServer.server_activate(self)

2670

1956

2671

1957

def enable(self):

2672

1958

self.enabled = True

2673

1959

2674

1960

def add_pipe(self, parent_pipe, proc):

2675

1961

# Call "handle_ipc" for both data and EOF events

2676

GLib.io_add_watch(

2677

parent_pipe.fileno(),

2678

GLib.IO_IN | GLib.IO_HUP,

2679

functools.partial(self.handle_ipc,

2680

parent_pipe=parent_pipe,

2681

proc=proc))

2682

2683

def handle_ipc(self, source, condition,

2684

parent_pipe=None,

2685

proc=None,

2686

client_object=None):

1962

gobject.io_add_watch(parent_pipe.fileno(),

1963

gobject.IO_IN | gobject.IO_HUP,

1964

functools.partial(self.handle_ipc,

1965

parent_pipe =

1966

parent_pipe,

1967

proc = proc))

1968

1969

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

1970

proc = None, client_object=None):

1971

condition_names = {

1972

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

1973

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

1974

# blocking).

1975

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

1976

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

1977

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

1978

# broken, usually for pipes and

1979

# sockets).

1980

}

1981

conditions_string = ' | '.join(name

1982

for cond, name in

1983

condition_names.iteritems()

1984

if cond & condition)

2687

1985

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

2688

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

1986

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

2689

1987

# Wait for other process to exit

2690

1988

proc.join()

2691

1989

return False

2692

1990

2693

1991

# Read a request from the child

2694

1992

request = parent_pipe.recv()

2695

1993

command = request[0]

2696

1994

2697

1995

if command == 'init':

2698

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

2699

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

2700

address = request[3]

2701

2702

for c in self.clients.values():

2703

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2704

continue

2705

if key_id and c.key_id == key_id:

2706

client = c

2707

break

2708

if fpr and c.fingerprint == fpr:

1996

fpr = request[1]

1997

address = request[2]

1998

1999

for c in self.clients.itervalues():

2000

if c.fingerprint == fpr:

2709

2001

client = c

2710

2002

break

2711

2003

else:

2712

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

2713

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

2004

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

2005

"dress: %s", fpr, address)

2714

2006

if self.use_dbus:

2715

2007

# Emit D-Bus signal

2716

mandos_dbus_service.ClientNotFound(key_id or fpr,

2008

mandos_dbus_service.ClientNotFound(fpr,

2717

2009

address[0])

2718

2010

parent_pipe.send(False)

2719

2011

return False

2720

2721

GLib.io_add_watch(

2722

parent_pipe.fileno(),

2723

GLib.IO_IN | GLib.IO_HUP,

2724

functools.partial(self.handle_ipc,

2725

parent_pipe=parent_pipe,

2726

proc=proc,

2727

client_object=client))

2012

2013

gobject.io_add_watch(parent_pipe.fileno(),

2014

gobject.IO_IN | gobject.IO_HUP,

2015

functools.partial(self.handle_ipc,

2016

parent_pipe =

2017

parent_pipe,

2018

proc = proc,

2019

client_object =

2020

client))

2728

2021

parent_pipe.send(True)

2729

2022

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

2730

2023

# same fileno

2733

2026

funcname = request[1]

2734

2027

args = request[2]

2735

2028

kwargs = request[3]

2736

2029

2737

2030

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

2738

2031

funcname)(*args,

2739

**kwargs)))

2740

2032

**kwargs)))

2033

2741

2034

if command == 'getattr':

2742

2035

attrname = request[1]

2743

if isinstance(client_object.__getattribute__(attrname),

2744

collections.Callable):

2745

parent_pipe.send(('function', ))

2036

if callable(client_object.__getattribute__(attrname)):

2037

parent_pipe.send(('function',))

2746

2038

else:

2747

parent_pipe.send((

2748

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

2749

2039

parent_pipe.send(('data', client_object

2040

.__getattribute__(attrname)))

2041

2750

2042

if command == 'setattr':

2751

2043

attrname = request[1]

2752

2044

value = request[2]

2753

2045

setattr(client_object, attrname, value)

2754

2046

2755

2047

return True

2756

2048

2757

2049

2758

def rfc3339_duration_to_delta(duration):

2759

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

2760

2761

>>> rfc3339_duration_to_delta("P7D")

2762

datetime.timedelta(7)

2763

>>> rfc3339_duration_to_delta("PT60S")

2764

datetime.timedelta(0, 60)

2765

>>> rfc3339_duration_to_delta("PT60M")

2766

datetime.timedelta(0, 3600)

2767

>>> rfc3339_duration_to_delta("PT24H")

2768

datetime.timedelta(1)

2769

>>> rfc3339_duration_to_delta("P1W")

2770

datetime.timedelta(7)

2771

>>> rfc3339_duration_to_delta("PT5M30S")

2772

datetime.timedelta(0, 330)

2773

>>> rfc3339_duration_to_delta("P1DT3M20S")

2774

datetime.timedelta(1, 200)

2775

"""

2776

2777

# Parsing an RFC 3339 duration with regular expressions is not

2778

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

2779

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

2780

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

2781

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

2782

# avoid excessive use of external libraries.

2783

2784

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

2785

Token = collections.namedtuple("Token", (

2786

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

2787

# a "group" containing digits

2788

"value", # datetime.timedelta or None

2789

"followers")) # Tokens valid after this token

2790

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

2791

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

2792

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

2793

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

2794

datetime.timedelta(seconds=1),

2795

frozenset((token_end, )))

2796

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

2797

datetime.timedelta(minutes=1),

2798

frozenset((token_second, token_end)))

2799

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

2800

datetime.timedelta(hours=1),

2801

frozenset((token_minute, token_end)))

2802

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

2803

None,

2804

frozenset((token_hour, token_minute,

2805

token_second)))

2806

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

2807

datetime.timedelta(days=1),

2808

frozenset((token_time, token_end)))

2809

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

2810

datetime.timedelta(weeks=4),

2811

frozenset((token_day, token_end)))

2812

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

2813

datetime.timedelta(weeks=52),

2814

frozenset((token_month, token_end)))

2815

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

2816

datetime.timedelta(weeks=1),

2817

frozenset((token_end, )))

2818

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

2819

frozenset((token_year, token_month,

2820

token_day, token_time,

2821

token_week)))

2822

# Define starting values:

2823

# Value so far

2824

value = datetime.timedelta()

2825

found_token = None

2826

# Following valid tokens

2827

followers = frozenset((token_duration, ))

2828

# String left to parse

2829

s = duration

2830

# Loop until end token is found

2831

while found_token is not token_end:

2832

# Search for any currently valid tokens

2833

for token in followers:

2834

match = token.regexp.match(s)

2835

if match is not None:

2836

# Token found

2837

if token.value is not None:

2838

# Value found, parse digits

2839

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

2840

# Add to value so far

2841

value += factor * token.value

2842

# Strip token from string

2843

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

2844

# Go to found token

2845

found_token = token

2846

# Set valid next tokens

2847

followers = found_token.followers

2848

break

2849

else:

2850

# No currently valid tokens were found

2851

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

2852

.format(duration))

2853

# End token found

2854

return value

2855

2856

2857

2050

def string_to_delta(interval):

2858

2051

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

2859

2052

2860

2053

>>> string_to_delta('7d')

2861

2054

datetime.timedelta(7)

2862

2055

>>> string_to_delta('60s')

2870

2063

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

2871

2064

datetime.timedelta(0, 330)

2872

2065

"""

2873

2874

try:

2875

return rfc3339_duration_to_delta(interval)

2876

except ValueError:

2877

pass

2878

2879

2066

timevalue = datetime.timedelta(0)

2880

2067

for s in interval.split():

2881

2068

try:

2882

suffix = s[-1]

2069

suffix = unicode(s[-1])

2883

2070

value = int(s[:-1])

2884

2071

if suffix == "d":

2885

2072

delta = datetime.timedelta(value)

2892

2079

elif suffix == "w":

2893

2080

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

2894

2081

else:

2895

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

2896

except IndexError as e:

2082

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

2083

except (ValueError, IndexError) as e:

2897

2084

raise ValueError(*(e.args))

2898

2085

timevalue += delta

2899

2086

return timevalue

2900

2087

2901

2088

2902

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

2089

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

2903

2090

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

2904

2091

2905

2092

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

2906

2093

if os.fork():

2907

2094

sys.exit()

2915

2102

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

2916

2103

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

2917

2104

raise OSError(errno.ENODEV,

2918

"{} not a character device"

2919

.format(os.devnull))

2105

"%s not a character device"

2106

% os.devnull)

2920

2107

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

2921

2108

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

2922

2109

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

2925

2112

2926

2113

2927

2114

def main():

2928

2115

2929

2116

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

2930

2117

# Parsing of options, both command line and config file

2931

2118

2932

2119

parser = argparse.ArgumentParser()

2933

2120

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

2934

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

2121

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

2935

2122

help="show version number and exit")

2936

2123

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

2937

2124

help="Bind to interface IF")

2943

2130

help="Run self-test")

2944

2131

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

2945

2132

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

2946

" to terminal", default=None)

2133

" to terminal")

2947

2134

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

2948

2135

help="Debug level for stdout output")

2949

2136

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

2956

2143

" files")

2957

2144

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

2958

2145

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

2959

" system bus interface", default=None)

2146

" system bus interface")

2960

2147

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

2961

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

2962

default=None)

2148

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

2963

2149

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

2964

2150

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

2965

" state", default=None)

2966

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

2967

help="Specify a file descriptor to a network"

2968

" socket to use instead of creating one")

2151

" state")

2969

2152

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

2970

2153

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

2971

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

2972

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

2973

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

2974

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

2975

default=None)

2976

2154

2977

2155

options = parser.parse_args()

2978

2156

2979

2157

if options.check:

2980

2158

import doctest

2981

fail_count, test_count = doctest.testmod()

2982

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

2983

2159

doctest.testmod()

2160

sys.exit()

2161

2984

2162

# Default values for config file for server-global settings

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2163

server_defaults = { "interface": "",

2164

"address": "",

2165

"port": "",

2166

"debug": "False",

2167

"priority":

2168

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

2169

"servicename": "Mandos",

2170

"use_dbus": "True",

2171

"use_ipv6": "True",

2172

"debuglevel": "",

2173

"restore": "True",

2174

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

2175

}

2176

3008

2177

# Parse config file for server-global settings

3009

2178

server_config = configparser.SafeConfigParser(server_defaults)

3010

2179

del server_defaults

3011

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

2180

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

2181

"mandos.conf"))

3012

2182

# Convert the SafeConfigParser object to a dict

3013

2183

server_settings = server_config.defaults()

3014

2184

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

3015

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

3016

"foreground", "zeroconf"):

2185

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

3017

2186

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

3018

2187

option)

3019

2188

if server_settings["port"]:

3020

2189

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

3021

2190

"port")

3022

if server_settings["socket"]:

3023

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

3024

"socket")

3025

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

3026

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

3027

# happen with a supplied network socket.

3028

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

3029

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

3030

["socket"])

3031

2191

del server_config

3032

2192

3033

2193

# Override the settings from the config file with command line

3034

2194

# options, if set.

3035

2195

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

3036

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

3037

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

3038

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

2196

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

2197

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

2198

"statedir"):

3039

2199

value = getattr(options, option)

3040

2200

if value is not None:

3041

2201

server_settings[option] = value

3042

2202

del options

3043

2203

# Force all strings to be unicode

3044

2204

for option in server_settings.keys():

3045

if isinstance(server_settings[option], bytes):

3046

server_settings[option] = (server_settings[option]

3047

.decode("utf-8"))

3048

# Force all boolean options to be boolean

3049

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

3050

"foreground", "zeroconf"):

3051

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

3052

# Debug implies foreground

3053

if server_settings["debug"]:

3054

server_settings["foreground"] = True

2205

if type(server_settings[option]) is str:

2206

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

3055

2207

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

3056

2208

3057

2209

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

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2210

3064

2211

# For convenience

3065

2212

debug = server_settings["debug"]

3066

2213

debuglevel = server_settings["debuglevel"]

3068

2215

use_ipv6 = server_settings["use_ipv6"]

3069

2216

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

3070

2217

stored_state_file)

3071

foreground = server_settings["foreground"]

3072

zeroconf = server_settings["zeroconf"]

3073

2218

3074

2219

if debug:

3075

2220

initlogger(debug, logging.DEBUG)

3076

2221

else:

3079

2224

else:

3080

2225

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

3081

2226

initlogger(debug, level)

3082

2227

3083

2228

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

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2229

syslogger.setFormatter(logging.Formatter

2230

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

2231

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

2232

% server_settings["servicename"]))

2233

3089

2234

# Parse config file with clients

3090

2235

client_config = configparser.SafeConfigParser(Client

3091

2236

.client_defaults)

3092

2237

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

3093

2238

"clients.conf"))

3094

2239

3095

2240

global mandos_dbus_service

3096

2241

mandos_dbus_service = None

3097

3098

socketfd = None

3099

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

3100

socketfd = server_settings["socket"]

3101

tcp_server = MandosServer(

3102

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

3103

ClientHandler,

3104

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

3105

use_ipv6=use_ipv6,

3106

gnutls_priority=server_settings["priority"],

3107

use_dbus=use_dbus,

3108

socketfd=socketfd)

3109

if not foreground:

3110

pidfilename = "/run/mandos.pid"

3111

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

3112

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

3113

pidfile = None

3114

try:

3115

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

3116

except IOError as e:

3117

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

3118

exc_info=e)

3119

3120

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

3121

("mandos", "mandos"),

3122

("nobody", "nogroup")):

3123

try:

3124

uid = pwd.getpwnam(name).pw_uid

3125

gid = pwd.getpwnam(group).pw_gid

3126

break

2242

2243

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

2244

server_settings["port"]),

2245

ClientHandler,

2246

interface=(server_settings["interface"]

2247

or None),

2248

use_ipv6=use_ipv6,

2249

gnutls_priority=

2250

server_settings["priority"],

2251

use_dbus=use_dbus)

2252

if not debug:

2253

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

2254

try:

2255

pidfile = open(pidfilename, "w")

2256

except IOError:

2257

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

2258

2259

try:

2260

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

2261

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

2262

except KeyError:

2263

try:

2264

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

2265

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

3127

2266

except KeyError:

3128

continue

3129

else:

3130

uid = 65534

3131

gid = 65534

2267

try:

2268

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

2269

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

2270

except KeyError:

2271

uid = 65534

2272

gid = 65534

3132

2273

try:

3133

2274

os.setgid(gid)

3134

2275

os.setuid(uid)

3135

if debug:

3136

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

3137

gid))

3138

2276

except OSError as error:

3139

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

3140

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

3141

if error.errno != errno.EPERM:

3142

raise

3143

2277

if error[0] != errno.EPERM:

2278

raise error

2279

3144

2280

if debug:

3145

2281

# Enable all possible GnuTLS debugging

3146

2282

3147

2283

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

3148

2284

# - GnuTLS manual

3149

gnutls.global_set_log_level(11)

3150

3151

@gnutls.log_func

2285

gnutls.library.functions.gnutls_global_set_log_level(11)

2286

2287

@gnutls.library.types.gnutls_log_func

3152

2288

def debug_gnutls(level, string):

3153

2289

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

3154

3155

gnutls.global_set_log_function(debug_gnutls)

3156

2290

2291

(gnutls.library.functions

2292

.gnutls_global_set_log_function(debug_gnutls))

2293

3157

2294

# Redirect stdin so all checkers get /dev/null

3158

2295

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

3159

2296

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

3160

2297

if null > 2:

3161

2298

os.close(null)

3162

2299

3163

2300

# Need to fork before connecting to D-Bus

3164

if not foreground:

2301

if not debug:

3165

2302

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

3166

2303

daemon()

3167

3168

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

3169

# to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2304

2305

gobject.threads_init()

2306

3172

2307

global main_loop

3173

2308

# From the Avahi example code

3174

2309

DBusGMainLoop(set_as_default=True)

3175

main_loop = GLib.MainLoop()

2310

main_loop = gobject.MainLoop()

3176

2311

bus = dbus.SystemBus()

3177

2312

# End of Avahi example code

3178

2313

if use_dbus:

3179

2314

try:

3180

2315

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

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

3187

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

2316

bus, do_not_queue=True)

2317

old_bus_name = (dbus.service.BusName

2318

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

2319

do_not_queue=True))

2320

except dbus.exceptions.NameExistsException as e:

2321

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

3188

2322

use_dbus = False

3189

2323

server_settings["use_dbus"] = False

3190

2324

tcp_server.use_dbus = False

3191

if zeroconf:

3192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

3198

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2325

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2326

service = AvahiServiceToSyslog(name =

2327

server_settings["servicename"],

2328

servicetype = "_mandos._tcp",

2329

protocol = protocol, bus = bus)

2330

if server_settings["interface"]:

2331

service.interface = (if_nametoindex

2332

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

2333

3202

2334

global multiprocessing_manager

3203

2335

multiprocessing_manager = multiprocessing.Manager()

3204

2336

3205

2337

client_class = Client

3206

2338

if use_dbus:

3207

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

3208

2339

client_class = functools.partial(ClientDBusTransitional,

2340

bus = bus)

2341

3209

2342

client_settings = Client.config_parser(client_config)

3210

2343

old_client_settings = {}

3211

2344

clients_data = {}

3212

3213

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

3214

global wnull

3215

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

3216

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

3217

# mode

3218

if debug or not foreground:

3219

wnull.close()

3220

2345

3221

2346

# Get client data and settings from last running state.

3222

2347

if server_settings["restore"]:

3223

2348

try:

3224

2349

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

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name & .host

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if not value.has_key("key_id"):

3257

value["key_id"] = ""

3258

elif not value.has_key("fingerprint"):

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host

3270

for value in old_client_settings.values():

3271

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

3272

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

3273

.decode("utf-8"))

2350

clients_data, old_client_settings = (pickle.load

2351

(stored_state))

3274

2352

os.remove(stored_state_path)

3275

2353

except IOError as e:

3276

if e.errno == errno.ENOENT:

3277

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

3278

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

3279

else:

3280

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

3281

exc_info=e)

2354

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

2355

.format(e))

2356

if e.errno != errno.ENOENT:

3282

2357

raise

3283

2358

except EOFError as e:

3284

2359

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

3285

"EOFError:",

3286

exc_info=e)

3287

2360

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

2361

3288

2362

with PGPEngine() as pgp:

3289

for client_name, client in clients_data.items():

3290

# Skip removed clients

3291

if client_name not in client_settings:

3292

continue

3293

2363

for client_name, client in clients_data.iteritems():

3294

2364

# Decide which value to use after restoring saved state.

3295

2365

# We have three different values: Old config file,

3296

2366

# new config file, and saved state.

3301

2371

# For each value in new config, check if it

3302

2372

# differs from the old config value (Except for

3303

2373

# the "secret" attribute)

3304

if (name != "secret"

3305

and (value !=

3306

old_client_settings[client_name][name])):

2374

if (name != "secret" and

2375

value != old_client_settings[client_name]

2376

[name]):

3307

2377

client[name] = value

3308

2378

except KeyError:

3309

2379

pass

3310

2380

3311

2381

# Clients who has passed its expire date can still be

3312

# enabled if its last checker was successful. A Client

2382

# enabled if its last checker was successful. Clients

3313

2383

# whose checker succeeded before we stored its state is

3314

2384

# assumed to have successfully run all checkers during

3315

2385

# downtime.

3317

2387

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

3318

2388

if not client["last_checked_ok"]:

3319

2389

logger.warning(

3320

"disabling client {} - Client never "

3321

"performed a successful checker".format(

3322

client_name))

2390

"disabling client {0} - Client never "

2391

"performed a successful checker"

2392

.format(client_name))

3323

2393

client["enabled"] = False

3324

2394

elif client["last_checker_status"] != 0:

3325

2395

logger.warning(

3326

"disabling client {} - Client last"

3327

" checker failed with error code"

3328

" {}".format(

3329

client_name,

3330

client["last_checker_status"]))

2396

"disabling client {0} - Client "

2397

"last checker failed with error code {1}"

2398

.format(client_name,

2399

client["last_checker_status"]))

3331

2400

client["enabled"] = False

3332

2401

else:

3333

client["expires"] = (

3334

datetime.datetime.utcnow()

3335

+ client["timeout"])

2402

client["expires"] = (datetime.datetime

2403

.utcnow()

2404

+ client["timeout"])

3336

2405

logger.debug("Last checker succeeded,"

3337

" keeping {} enabled".format(

3338

client_name))

2406

" keeping {0} enabled"

2407

.format(client_name))

3339

2408

try:

3340

client["secret"] = pgp.decrypt(

3341

client["encrypted_secret"],

3342

client_settings[client_name]["secret"])

2409

client["secret"] = (

2410

pgp.decrypt(client["encrypted_secret"],

2411

client_settings[client_name]

2412

["secret"]))

3343

2413

except PGPError:

3344

2414

# If decryption fails, we use secret from new settings

3345

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

3346

client_name))

3347

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

3348

["secret"])

2415

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

2416

.format(client_name))

2417

client["secret"] = (

2418

client_settings[client_name]["secret"])

3349

2419

2420

3350

2421

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

3351

2422

for client_name in (set(old_client_settings)

3352

2423

- set(client_settings)):

3356

2427

clients_data[client_name] = client_settings[client_name]

3357

2428

3358

2429

# Create all client objects

3359

for client_name, client in clients_data.items():

2430

for client_name, client in clients_data.iteritems():

3360

2431

tcp_server.clients[client_name] = client_class(

3361

name=client_name,

3362

settings=client,

3363

server_settings=server_settings)

3364

2432

name = client_name, settings = client)

2433

3365

2434

if not tcp_server.clients:

3366

2435

logger.warning("No clients defined")

3367

3368

if not foreground:

3369

if pidfile is not None:

3370

pid = os.getpid()

3371

try:

3372

with pidfile:

3373

print(pid, file=pidfile)

3374

except IOError:

3375

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

3376

pidfilename, pid)

3377

del pidfile

2436

2437

if not debug:

2438

try:

2439

with pidfile:

2440

pid = os.getpid()

2441

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

2442

del pidfile

2443

except IOError:

2444

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

2445

pidfilename, pid)

2446

except NameError:

2447

# "pidfile" was never created

2448

pass

3378

2449

del pidfilename

3379

3380

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

3381

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3382

lambda: main_loop.quit() and False)

3383

2450

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

2451

2452

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

2453

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

2454

3384

2455

if use_dbus:

3385

3386

@alternate_dbus_interfaces(

3387

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

3388

class MandosDBusService(DBusObjectWithObjectManager):

2456

class MandosDBusService(DBusObjectWithProperties):

3389

2457

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

3390

3391

2458

def __init__(self):

3392

2459

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

3393

3394

2460

_interface = "se.recompile.Mandos"

3395

2461

2462

@dbus_interface_annotations(_interface)

2463

def _foo(self):

2464

return { "org.freedesktop.DBus.Property"

2465

".EmitsChangedSignal":

2466

"false"}

2467

3396

2468

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

3397

2469

def ClientAdded(self, objpath):

3398

2470

"D-Bus signal"

3399

2471

pass

3400

2472

3401

2473

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

3402

def ClientNotFound(self, key_id, address):

2474

def ClientNotFound(self, fingerprint, address):

3403

2475

"D-Bus signal"

3404

2476

pass

3405

3406

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

3407

"true"})

2477

3408

2478

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

3409

2479

def ClientRemoved(self, objpath, name):

3410

2480

"D-Bus signal"

3411

2481

pass

3412

3413

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

3414

"true"})

2482

3415

2483

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

3416

2484

def GetAllClients(self):

3417

2485

"D-Bus method"

3418

return dbus.Array(c.dbus_object_path for c in

3419

tcp_server.clients.values())

3420

3421

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

3422

"true"})

2486

return dbus.Array(c.dbus_object_path

2487

for c in

2488

tcp_server.clients.itervalues())

2489

3423

2490

@dbus.service.method(_interface,

3424

2491

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

3425

2492

def GetAllClientsWithProperties(self):

3426

2493

"D-Bus method"

3427

2494

return dbus.Dictionary(

3428

{c.dbus_object_path: c.GetAll(

3429

"se.recompile.Mandos.Client")

3430

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

2495

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

2496

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

3431

2497

signature="oa{sv}")

3432

2498

3433

2499

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

3434

2500

def RemoveClient(self, object_path):

3435

2501

"D-Bus method"

3436

for c in tcp_server.clients.values():

2502

for c in tcp_server.clients.itervalues():

3437

2503

if c.dbus_object_path == object_path:

3438

2504

del tcp_server.clients[c.name]

3439

2505

c.remove_from_connection()

3440

# Don't signal the disabling

2506

# Don't signal anything except ClientRemoved

3441

2507

c.disable(quiet=True)

3442

# Emit D-Bus signal for removal

3443

self.client_removed_signal(c)

2508

# Emit D-Bus signal

2509

self.ClientRemoved(object_path, c.name)

3444

2510

return

3445

2511

raise KeyError(object_path)

3446

2512

3447

2513

del _interface

3448

3449

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3450

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

3451

def GetManagedObjects(self):

3452

"""D-Bus method"""

3453

return dbus.Dictionary(

3454

{client.dbus_object_path:

3455

dbus.Dictionary(

3456

{interface: client.GetAll(interface)

3457

for interface in

3458

client._get_all_interface_names()})

3459

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

3460

3461

def client_added_signal(self, client):

3462

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

3463

if use_dbus:

3464

# New standard signal

3465

self.InterfacesAdded(

3466

client.dbus_object_path,

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()}))

3471

# Old signal

3472

self.ClientAdded(client.dbus_object_path)

3473

3474

def client_removed_signal(self, client):

3475

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

3476

if use_dbus:

3477

# New standard signal

3478

self.InterfacesRemoved(

3479

client.dbus_object_path,

3480

client._get_all_interface_names())

3481

# Old signal

3482

self.ClientRemoved(client.dbus_object_path,

3483

client.name)

3484

3485

mandos_dbus_service = MandosDBusService()

3486

3487

# Save modules to variables to exempt the modules from being

3488

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

3489

mp = multiprocessing

3490

wn = wnull

3491

2514

2515

class MandosDBusServiceTransitional(MandosDBusService):

2516

__metaclass__ = AlternateDBusNamesMetaclass

2517

mandos_dbus_service = MandosDBusServiceTransitional()

2518

3492

2519

def cleanup():

3493

2520

"Cleanup function; run on exit"

3494

if zeroconf:

3495

service.cleanup()

3496

3497

mp.active_children()

3498

wn.close()

2521

service.cleanup()

2522

2523

multiprocessing.active_children()

3499

2524

if not (tcp_server.clients or client_settings):

3500

2525

return

3501

2526

3502

2527

# Store client before exiting. Secrets are encrypted with key

3503

2528

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

3504

2529

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

3505

2530

clients = {}

3506

2531

with PGPEngine() as pgp:

3507

for client in tcp_server.clients.values():

2532

for client in tcp_server.clients.itervalues():

3508

2533

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

3509

2534

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

3510

2535

key)

3511

2536

client_dict = {}

3512

2537

3513

2538

# A list of attributes that can not be pickled

3514

2539

# + secret.

3515

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

3516

"checker", "server_settings"}

3517

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

3518

.Object):

2540

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

2541

"checker"))

2542

for name, typ in (inspect.getmembers

2543

(dbus.service.Object)):

3519

2544

exclude.add(name)

3520

2545

3521

2546

client_dict["encrypted_secret"] = (client

3522

2547

.encrypted_secret)

3523

2548

for attr in client.client_structure:

3524

2549

if attr not in exclude:

3525

2550

client_dict[attr] = getattr(client, attr)

3526

2551

3527

2552

clients[client.name] = client_dict

3528

2553

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

3529

2554

3530

2555

try:

3531

with tempfile.NamedTemporaryFile(

3532

mode='wb',

3533

suffix=".pickle",

3534

prefix='clients-',

3535

dir=os.path.dirname(stored_state_path),

3536

delete=False) as stored_state:

3537

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

3538

protocol=2)

3539

tempname = stored_state.name

2556

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

2557

prefix="clients-",

2558

dir=os.path.dirname

2559

(stored_state_path))

2560

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

2561

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

3540

2562

os.rename(tempname, stored_state_path)

3541

2563

except (IOError, OSError) as e:

2564

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

2565

.format(e))

3542

2566

if not debug:

3543

2567

try:

3544

2568

os.remove(tempname)

3545

2569

except NameError:

3546

2570

pass

3547

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

3548

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

3549

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

3550

else:

3551

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

3552

exc_info=e)

3553

raise

3554

2571

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

2572

errno.EEXIST)):

2573

raise e

2574

3555

2575

# Delete all clients, and settings from config

3556

2576

while tcp_server.clients:

3557

2577

name, client = tcp_server.clients.popitem()

3558

2578

if use_dbus:

3559

2579

client.remove_from_connection()

3560

# Don't signal the disabling

2580

# Don't signal anything except ClientRemoved

3561

2581

client.disable(quiet=True)

3562

# Emit D-Bus signal for removal

3563

2582

if use_dbus:

3564

mandos_dbus_service.client_removed_signal(client)

2583

# Emit D-Bus signal

2584

mandos_dbus_service.ClientRemoved(client

2585

.dbus_object_path,

2586

client.name)

3565

2587

client_settings.clear()

3566

2588

3567

2589

atexit.register(cleanup)

3568

3569

for client in tcp_server.clients.values():

2590

2591

for client in tcp_server.clients.itervalues():

3570

2592

if use_dbus:

3571

# Emit D-Bus signal for adding

3572

mandos_dbus_service.client_added_signal(client)

2593

# Emit D-Bus signal

2594

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3573

2595

# Need to initiate checking of clients

3574

2596

if client.enabled:

3575

2597

client.init_checker()

3576

2598

3577

2599

tcp_server.enable()

3578

2600

tcp_server.server_activate()

3579

2601

3580

2602

# Find out what port we got

3581

if zeroconf:

3582

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

2603

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

3583

2604

if use_ipv6:

3584

2605

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

3585

" flowinfo %d, scope_id %d",

3586

*tcp_server.socket.getsockname())

2606

" flowinfo %d, scope_id %d"

2607

% tcp_server.socket.getsockname())

3587

2608

else: # IPv4

3588

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

3589

*tcp_server.socket.getsockname())

3590

3591

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

3592

2609

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

2610

% tcp_server.socket.getsockname())

2611

2612

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

2613

3593

2614

try:

3594

if zeroconf:

3595

# From the Avahi example code

3596

try:

3597

service.activate()

3598

except dbus.exceptions.DBusException as error:

3599

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

3600

cleanup()

3601

sys.exit(1)

3602

# End of Avahi example code

3603

3604

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

3605

lambda *args, **kwargs:

3606

(tcp_server.handle_request

3607

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

3608

2615

# From the Avahi example code

2616

try:

2617

service.activate()

2618

except dbus.exceptions.DBusException as error:

2619

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

2620

cleanup()

2621

sys.exit(1)

2622

# End of Avahi example code

2623

2624

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

2625

lambda *args, **kwargs:

2626

(tcp_server.handle_request

2627

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

2628

3609

2629

logger.debug("Starting main loop")

3610

2630

main_loop.run()

3611

2631

except AvahiError as error:

3612

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

2632

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

3613

2633

cleanup()

3614

2634

sys.exit(1)

3615

2635

except KeyboardInterrupt:

3620

2640

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

3621

2641

cleanup()

3622

2642

3623

3624

2643

if __name__ == '__main__':

3625

2644

main()