/mandos/trunk : revision 237.4.27

1

#!/usr/bin/python3 -bI

2

# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

37

import SocketServer as socketserver

47

38

import socket

48

39

import argparse

49

40

import datetime

50

41

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

55

49

import sys

56

50

import re

57

51

import os

66

60

import struct

67

61

import fcntl

68

62

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

63

import cPickle as pickle

73

64

import multiprocessing

74

65

import types

75

66

import binascii

76

67

import tempfile

77

import itertools

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

68

84

69

import dbus

85

70

import dbus.service

86

import gi

87

from gi.repository import GLib

71

import gobject

72

import avahi

88

73

from dbus.mainloop.glib import DBusGMainLoop

89

74

import ctypes

90

75

import ctypes.util

91

76

import xml.dom.minidom

92

77

import inspect

93

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

# Add collections.abc.Callable if it does not exist

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

78

import GnuPGInterface

79

80

try:

122

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

82

except AttributeError:

124

83

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

84

from IN import SO_BINDTODEVICE

128

85

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.12"

86

SO_BINDTODEVICE = None

87

88

version = "1.5.2"

147

89

stored_state_file = "clients.pickle"

148

90

149

91

logger = logging.getLogger()

150

logging.captureWarnings(True) # Show warnings via the logging system

151

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

152

95

153

96

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

156

100

except (OSError, AttributeError):

157

158

101

def if_nametoindex(interface):

159

102

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

160

103

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

161

104

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

162

105

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

165

110

return interface_index

166

111

167

112

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

113

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

185

114

"""init logger and add loglevel"""

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

115

191

116

syslogger.setFormatter(logging.Formatter

192

117

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

193

118

' %(message)s'))

194

119

logger.addHandler(syslogger)

195

120

196

121

if debug:

197

122

console = logging.StreamHandler()

198

123

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

208

133

pass

209

134

210

135

211

class PGPEngine:

136

class PGPEngine(object):

212

137

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

213

214

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

215

140

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

229

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

147

235

148

def __enter__(self):

236

149

return self

237

238

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

150

151

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

239

152

self._cleanup()

240

153

return False

241

154

242

155

def __del__(self):

243

156

self._cleanup()

244

157

245

158

def _cleanup(self):

246

159

if self.tempdir is not None:

247

160

# Delete contents of tempdir

248

161

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

249

topdown=False):

162

topdown = False):

250

163

for filename in files:

251

164

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

252

165

for dirname in dirs:

254

167

# Remove tempdir

255

168

os.rmdir(self.tempdir)

256

169

self.tempdir = None

257

170

258

171

def password_encode(self, password):

259

172

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

260

173

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

261

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

262

if len(encoded) > 2048:

263

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

264

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

265

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

266

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

267

return encoded

268

174

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

175

269

176

def encrypt(self, data, password):

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

'--passphrase-file',

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

285

191

return ciphertext

286

192

287

193

def decrypt(self, data, password):

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

'--passphrase-file',

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

303

208

return decrypted_plaintext

304

209

305

210

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

211

332

212

class AvahiError(Exception):

333

213

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

334

214

self.value = value

335

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

336

**kwargs)

337

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

338

218

339

219

class AvahiServiceError(AvahiError):

340

220

pass

341

221

342

343

222

class AvahiGroupError(AvahiError):

344

223

pass

345

224

346

225

347

class AvahiService:

226

class AvahiService(object):

348

227

"""An Avahi (Zeroconf) service.

349

228

350

229

Attributes:

351

230

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

352

231

Used to optionally bind to the specified interface.

353

232

name: string; Example: 'Mandos'

354

233

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

355

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

234

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

356

235

port: integer; what port to announce

357

236

TXT: list of strings; TXT record for the service

358

237

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

364

243

server: D-Bus Server

365

244

bus: dbus.SystemBus()

366

245

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

379

250

self.interface = interface

380

251

self.name = name

381

252

self.type = servicetype

390

261

self.server = None

391

262

self.bus = bus

392

263

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

264

def rename(self):

395

265

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

396

266

if self.rename_count >= self.max_renames:

397

267

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

398

268

" after %i retries, exiting.",

399

269

self.rename_count)

400

270

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

404

273

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

405

274

self.name)

406

if remove:

407

self.remove()

275

self.remove()

408

276

try:

409

277

self.add()

410

278

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

420

283

def remove(self):

421

284

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

422

285

if self.entry_group_state_changed_match is not None:

424

287

self.entry_group_state_changed_match = None

425

288

if self.group is not None:

426

289

self.group.Reset()

427

428

290

def add(self):

429

291

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

430

292

self.remove()

447

309

dbus.UInt16(self.port),

448

310

avahi.string_array_to_txt_array(self.TXT))

449

311

self.group.Commit()

450

451

312

def entry_group_state_changed(self, state, error):

452

313

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

453

314

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

454

315

455

316

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

317

logger.debug("Zeroconf service established.")

457

318

elif state == avahi.ENTRY_GROUP_COLLISION:

459

320

self.rename()

460

321

elif state == avahi.ENTRY_GROUP_FAILURE:

461

322

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

462

str(error))

463

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

464

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

465

326

def cleanup(self):

466

327

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

467

328

if self.group is not None:

472

333

pass

473

334

self.group = None

474

335

self.remove()

475

476

336

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

477

337

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

478

338

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

485

346

if state in bad_states:

486

347

if bad_states[state] is not None:

487

348

if error is None:

490

351

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

491

352

self.cleanup()

492

353

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

354

self.add()

505

355

else:

506

356

if error is None:

507

357

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

508

358

else:

509

359

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

510

511

360

def activate(self):

512

361

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

513

362

if self.server is None:

517

366

follow_name_owner_changes=True),

518

367

avahi.DBUS_INTERFACE_SERVER)

519

368

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

369

self.server_state_changed)

521

370

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

522

371

523

524

372

class AvahiServiceToSyslog(AvahiService):

525

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

373

def rename(self):

526

374

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

532

380

return ret

533

381

534

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code)

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

# Classes

605

class Credentials:

606

def __init__(self):

607

self._c_object = gnutls.certificate_credentials_t()

608

gnutls.certificate_allocate_credentials(

609

ctypes.byref(self._c_object))

610

self.type = gnutls.CRD_CERTIFICATE

611

612

def __del__(self):

613

gnutls.certificate_free_credentials(self._c_object)

614

615

class ClientSession:

616

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

617

self._c_object = gnutls.session_t()

618

gnutls_flags = gnutls.CLIENT

619

if gnutls.check_version(b"3.5.6"):

620

gnutls_flags |= gnutls.NO_TICKETS

621

if gnutls.has_rawpk:

622

gnutls_flags |= gnutls.ENABLE_RAWPK

623

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

624

del gnutls_flags

625

gnutls.set_default_priority(self._c_object)

626

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

627

gnutls.handshake_set_private_extensions(self._c_object,

628

True)

629

self.socket = socket

630

if credentials is None:

631

credentials = gnutls.Credentials()

632

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

633

ctypes.cast(credentials._c_object,

634

ctypes.c_void_p))

635

self.credentials = credentials

636

637

def __del__(self):

638

gnutls.deinit(self._c_object)

639

640

def handshake(self):

641

return gnutls.handshake(self._c_object)

642

643

def send(self, data):

644

data = bytes(data)

645

data_len = len(data)

646

while data_len > 0:

647

data_len -= gnutls.record_send(self._c_object,

648

data[-data_len:],

649

data_len)

650

651

def bye(self):

652

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

653

654

# Error handling functions

655

def _error_code(result):

656

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

657

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

658

if result >= 0:

659

return result

660

if result == gnutls.E_NO_CERTIFICATE_FOUND:

661

raise gnutls.CertificateSecurityError(code=result)

662

raise gnutls.Error(code=result)

663

664

def _retry_on_error(result, func, arguments):

665

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

666

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

667

while result < 0:

668

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

669

return _error_code(result)

670

result = func(*arguments)

671

return result

672

673

# Unless otherwise indicated, the function declarations below are

674

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

675

676

# Functions

677

priority_set_direct = _library.gnutls_priority_set_direct

678

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

679

ctypes.POINTER(ctypes.c_char_p)]

680

priority_set_direct.restype = _error_code

681

682

init = _library.gnutls_init

683

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

684

init.restype = _error_code

685

686

set_default_priority = _library.gnutls_set_default_priority

687

set_default_priority.argtypes = [session_t]

688

set_default_priority.restype = _error_code

689

690

record_send = _library.gnutls_record_send

691

record_send.argtypes = [session_t, ctypes.c_void_p,

692

ctypes.c_size_t]

693

record_send.restype = ctypes.c_ssize_t

694

record_send.errcheck = _retry_on_error

695

696

certificate_allocate_credentials = (

697

_library.gnutls_certificate_allocate_credentials)

698

certificate_allocate_credentials.argtypes = [

699

ctypes.POINTER(certificate_credentials_t)]

700

certificate_allocate_credentials.restype = _error_code

701

702

certificate_free_credentials = (

703

_library.gnutls_certificate_free_credentials)

704

certificate_free_credentials.argtypes = [

705

certificate_credentials_t]

706

certificate_free_credentials.restype = None

707

708

handshake_set_private_extensions = (

709

_library.gnutls_handshake_set_private_extensions)

710

handshake_set_private_extensions.argtypes = [session_t,

711

ctypes.c_int]

712

handshake_set_private_extensions.restype = None

713

714

credentials_set = _library.gnutls_credentials_set

715

credentials_set.argtypes = [session_t, credentials_type_t,

716

ctypes.c_void_p]

717

credentials_set.restype = _error_code

718

719

strerror = _library.gnutls_strerror

720

strerror.argtypes = [ctypes.c_int]

721

strerror.restype = ctypes.c_char_p

722

723

certificate_type_get = _library.gnutls_certificate_type_get

724

certificate_type_get.argtypes = [session_t]

725

certificate_type_get.restype = _error_code

726

727

certificate_get_peers = _library.gnutls_certificate_get_peers

728

certificate_get_peers.argtypes = [session_t,

729

ctypes.POINTER(ctypes.c_uint)]

730

certificate_get_peers.restype = ctypes.POINTER(datum_t)

731

732

global_set_log_level = _library.gnutls_global_set_log_level

733

global_set_log_level.argtypes = [ctypes.c_int]

734

global_set_log_level.restype = None

735

736

global_set_log_function = _library.gnutls_global_set_log_function

737

global_set_log_function.argtypes = [log_func]

738

global_set_log_function.restype = None

739

740

deinit = _library.gnutls_deinit

741

deinit.argtypes = [session_t]

742

deinit.restype = None

743

744

handshake = _library.gnutls_handshake

745

handshake.argtypes = [session_t]

746

handshake.restype = _error_code

747

handshake.errcheck = _retry_on_error

748

749

transport_set_ptr = _library.gnutls_transport_set_ptr

750

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

751

transport_set_ptr.restype = None

752

753

bye = _library.gnutls_bye

754

bye.argtypes = [session_t, close_request_t]

755

bye.restype = _error_code

756

bye.errcheck = _retry_on_error

757

758

check_version = _library.gnutls_check_version

759

check_version.argtypes = [ctypes.c_char_p]

760

check_version.restype = ctypes.c_char_p

761

762

_need_version = b"3.3.0"

763

if check_version(_need_version) is None:

764

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

765

.format(_need_version))

766

767

_tls_rawpk_version = b"3.6.6"

768

has_rawpk = bool(check_version(_tls_rawpk_version))

769

770

if has_rawpk:

771

# Types

772

class pubkey_st(ctypes.Structure):

773

_fields = []

774

pubkey_t = ctypes.POINTER(pubkey_st)

775

776

x509_crt_fmt_t = ctypes.c_int

777

778

# All the function declarations below are from

779

# gnutls/abstract.h

780

pubkey_init = _library.gnutls_pubkey_init

781

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

782

pubkey_init.restype = _error_code

783

784

pubkey_import = _library.gnutls_pubkey_import

785

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

786

x509_crt_fmt_t]

787

pubkey_import.restype = _error_code

788

789

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

790

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

791

ctypes.POINTER(ctypes.c_ubyte),

792

ctypes.POINTER(ctypes.c_size_t)]

793

pubkey_get_key_id.restype = _error_code

794

795

pubkey_deinit = _library.gnutls_pubkey_deinit

796

pubkey_deinit.argtypes = [pubkey_t]

797

pubkey_deinit.restype = None

798

else:

799

# All the function declarations below are from

800

# gnutls/openpgp.h

801

802

openpgp_crt_init = _library.gnutls_openpgp_crt_init

803

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

804

openpgp_crt_init.restype = _error_code

805

806

openpgp_crt_import = _library.gnutls_openpgp_crt_import

807

openpgp_crt_import.argtypes = [openpgp_crt_t,

808

ctypes.POINTER(datum_t),

809

openpgp_crt_fmt_t]

810

openpgp_crt_import.restype = _error_code

811

812

openpgp_crt_verify_self = \

813

_library.gnutls_openpgp_crt_verify_self

814

openpgp_crt_verify_self.argtypes = [

815

openpgp_crt_t,

816

ctypes.c_uint,

817

ctypes.POINTER(ctypes.c_uint),

818

]

819

openpgp_crt_verify_self.restype = _error_code

820

821

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

822

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

823

openpgp_crt_deinit.restype = None

824

825

openpgp_crt_get_fingerprint = (

826

_library.gnutls_openpgp_crt_get_fingerprint)

827

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

828

ctypes.c_void_p,

829

ctypes.POINTER(

830

ctypes.c_size_t)]

831

openpgp_crt_get_fingerprint.restype = _error_code

832

833

if check_version(b"3.6.4"):

834

certificate_type_get2 = _library.gnutls_certificate_type_get2

835

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

836

certificate_type_get2.restype = _error_code

837

838

# Remove non-public functions

839

del _error_code, _retry_on_error

840

841

842

def call_pipe(connection, # : multiprocessing.Connection

843

func, *args, **kwargs):

844

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

845

846

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

847

return value on the provided multiprocessing.Connection.

848

"""

849

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

850

connection.close()

851

852

853

class Client:

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

388

class Client(object):

854

389

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

855

390

856

391

Attributes:

857

392

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

858

393

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

859

394

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

860

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

861

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

862

running.

863

checker_callback_tag: a GLib event source tag, or None

395

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

396

to see if the client lives.

397

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

864

399

checker_command: string; External command which is run to check

865

400

if client lives. %() expansions are done at

866

401

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

867

402

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

868

checker_initiator_tag: a GLib event source tag, or None

403

checker_initiator_tag: a gobject event source tag, or None

869

404

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

870

405

client_structure: Object describing what attributes a client has

871

406

and is used for storing the client at exit

872

407

current_checker_command: string; current running checker_command

873

disable_initiator_tag: a GLib event source tag, or None

408

disable_initiator_tag: a gobject event source tag, or None

874

409

enabled: bool()

875

410

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

876

uniquely identify an OpenPGP client

877

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

878

a client using raw public keys

411

uniquely identify the client

879

412

host: string; available for use by the checker command

880

413

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

881

414

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

883

416

last_checker_status: integer between 0 and 255 reflecting exit

884

417

status of last checker. -1 reflects crashed

885

418

checker, -2 means no checker completed yet.

886

last_checker_signal: The signal which killed the last checker, if

887

last_checker_status is -1

888

419

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

889

420

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

890

421

D-Bus identifiers

895

426

runtime_expansions: Allowed attributes for runtime expansion.

896

427

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

897

428

disabled, or None

898

server_settings: The server_settings dict from main()

899

429

"""

900

430

901

431

runtime_expansions = ("approval_delay", "approval_duration",

902

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

903

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

904

"last_approval_request", "last_checked_ok",

432

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

433

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

905

434

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

906

client_defaults = {

907

"timeout": "PT5M",

908

"extended_timeout": "PT15M",

909

"interval": "PT2M",

910

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

911

"host": "",

912

"approval_delay": "PT0S",

913

"approval_duration": "PT1S",

914

"approved_by_default": "True",

915

"enabled": "True",

916

}

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

917

460

918

461

@staticmethod

919

462

def config_parser(config):

927

470

for client_name in config.sections():

928

471

section = dict(config.items(client_name))

929

472

client = settings[client_name] = {}

930

473

931

474

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

932

475

# Reformat values from string types to Python types

933

476

client["approved_by_default"] = config.getboolean(

934

477

client_name, "approved_by_default")

935

478

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

936

479

"enabled")

937

938

# Uppercase and remove spaces from key_id and fingerprint

939

# for later comparison purposes with return value from the

940

# key_id() and fingerprint() functions

941

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

942

.replace(" ", ""))

480

943

481

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

944

482

.replace(" ", ""))

945

483

if "secret" in section:

946

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

947

.encode("utf-8"),

948

"base64")

484

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

949

485

elif "secfile" in section:

950

486

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

951

487

(section["secfile"])),

952

488

"rb") as secfile:

953

489

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

954

490

else:

955

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

956

.format(section))

491

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

492

% section)

957

493

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

958

494

client["extended_timeout"] = string_to_delta(

959

495

section["extended_timeout"])

966

502

client["last_approval_request"] = None

967

503

client["last_checked_ok"] = None

968

504

client["last_checker_status"] = -2

969

505

970

506

return settings

971

972

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

507

508

509

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

510

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

511

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

512

attribute."""

973

513

self.name = name

974

if server_settings is None:

975

server_settings = {}

976

self.server_settings = server_settings

977

514

# adding all client settings

978

for setting, value in settings.items():

515

for setting, value in settings.iteritems():

979

516

setattr(self, setting, value)

980

517

981

518

if self.enabled:

982

519

if not hasattr(self, "last_enabled"):

983

520

self.last_enabled = datetime.datetime.utcnow()

987

524

else:

988

525

self.last_enabled = None

989

526

self.expires = None

990

527

991

528

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

992

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

993

532

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

994

533

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

995

534

datetime.datetime.utcnow())

1002

541

self.current_checker_command = None

1003

542

self.approved = None

1004

543

self.approvals_pending = 0

1005

self.changedstate = multiprocessing_manager.Condition(

1006

multiprocessing_manager.Lock())

1007

self.client_structure = [attr

1008

for attr in self.__dict__.keys()

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

1009

549

if not attr.startswith("_")]

1010

550

self.client_structure.append("client_structure")

1011

1012

for name, t in inspect.getmembers(

1013

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

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

1014

556

if not name.startswith("_"):

1015

557

self.client_structure.append(name)

1016

558

1017

559

# Send notice to process children that client state has changed

1018

560

def send_changedstate(self):

1019

561

with self.changedstate:

1020

562

self.changedstate.notify_all()

1021

563

1022

564

def enable(self):

1023

565

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

1024

566

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

1025

567

# Already enabled

1026

568

return

569

self.send_changedstate()

1027

570

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

1028

571

self.enabled = True

1029

572

self.last_enabled = datetime.datetime.utcnow()

1030

573

self.init_checker()

1031

self.send_changedstate()

1032

574

1033

575

def disable(self, quiet=True):

1034

576

"""Disable this client."""

1035

577

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

1036

578

return False

1037

579

if not quiet:

580

self.send_changedstate()

581

if not quiet:

1038

582

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

1039

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

1040

GLib.source_remove(self.disable_initiator_tag)

583

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

584

gobject.source_remove(self.disable_initiator_tag)

1041

585

self.disable_initiator_tag = None

1042

586

self.expires = None

1043

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

1044

GLib.source_remove(self.checker_initiator_tag)

587

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

588

gobject.source_remove(self.checker_initiator_tag)

1045

589

self.checker_initiator_tag = None

1046

590

self.stop_checker()

1047

591

self.enabled = False

1048

if not quiet:

1049

self.send_changedstate()

1050

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

592

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

1051

593

return False

1052

594

1053

595

def __del__(self):

1054

596

self.disable()

1055

597

1056

598

def init_checker(self):

1057

599

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

1058

600

# and every interval from then on.

1059

if self.checker_initiator_tag is not None:

1060

GLib.source_remove(self.checker_initiator_tag)

1061

self.checker_initiator_tag = GLib.timeout_add(

1062

random.randrange(int(self.interval.total_seconds() * 1000

1063

+ 1)),

1064

self.start_checker)

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

1065

604

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

1066

if self.disable_initiator_tag is not None:

1067

GLib.source_remove(self.disable_initiator_tag)

1068

self.disable_initiator_tag = GLib.timeout_add(

1069

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

1070

608

# Also start a new checker *right now*.

1071

609

self.start_checker()

1072

1073

def checker_callback(self, source, condition, connection,

1074

command):

610

611

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

1075

612

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

1076

# Read return code from connection (see call_pipe)

1077

returncode = connection.recv()

1078

connection.close()

1079

if self.checker is not None:

1080

self.checker.join()

1081

613

self.checker_callback_tag = None

1082

614

self.checker = None

1083

1084

if returncode >= 0:

1085

self.last_checker_status = returncode

1086

self.last_checker_signal = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1087

617

if self.last_checker_status == 0:

1088

618

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

1089

619

vars(self))

1090

620

self.checked_ok()

1091

621

else:

1092

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

622

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

623

vars(self))

1093

624

else:

1094

625

self.last_checker_status = -1

1095

self.last_checker_signal = -returncode

1096

626

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

1097

627

vars(self))

1098

return False

1099

628

1100

629

def checked_ok(self):

1101

630

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

1102

631

self.last_checked_ok = datetime.datetime.utcnow()

1103

632

self.last_checker_status = 0

1104

self.last_checker_signal = None

1105

633

self.bump_timeout()

1106

634

1107

635

def bump_timeout(self, timeout=None):

1108

636

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

1109

637

if timeout is None:

1110

638

timeout = self.timeout

1111

639

if self.disable_initiator_tag is not None:

1112

GLib.source_remove(self.disable_initiator_tag)

1113

self.disable_initiator_tag = None

640

gobject.source_remove(self.disable_initiator_tag)

1114

641

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

1115

self.disable_initiator_tag = GLib.timeout_add(

1116

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

642

self.disable_initiator_tag = (gobject.timeout_add

643

(timedelta_to_milliseconds

644

(timeout), self.disable))

1117

645

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

1118

646

1119

647

def need_approval(self):

1120

648

self.last_approval_request = datetime.datetime.utcnow()

1121

649

1122

650

def start_checker(self):

1123

651

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

1124

652

1125

653

If a checker already exists, leave it running and do

1126

654

nothing."""

1127

655

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

1128

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

1129

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

1130

# would inevitably timeout, since no checker would get a

1131

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

656

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

657

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

658

# client would inevitably timeout, since no checker would get

659

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

1132

660

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

1133

661

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

1134

662

# should be.

1135

1136

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

1137

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

1138

self.checker.join()

1139

self.checker = None

663

664

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

665

try:

666

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

667

except (AttributeError, OSError) as error:

668

if (isinstance(error, OSError)

669

and error.errno != errno.ECHILD):

670

raise error

671

else:

672

if pid:

673

logger.warning("Checker was a zombie")

674

gobject.source_remove(self.checker_callback_tag)

675

self.checker_callback(pid, status,

676

self.current_checker_command)

1140

677

# Start a new checker if needed

1141

678

if self.checker is None:

1142

# Escape attributes for the shell

1143

escaped_attrs = {

1144

attr: shlex.quote(str(getattr(self, attr)))

1145

for attr in self.runtime_expansions}

1146

679

try:

1147

command = self.checker_command % escaped_attrs

1148

except TypeError as error:

1149

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

1150

self.checker_command,

1151

exc_info=error)

1152

return True # Try again later

680

# In case checker_command has exactly one % operator

681

command = self.checker_command % self.host

682

except TypeError:

683

# Escape attributes for the shell

684

escaped_attrs = dict(

685

(attr,

686

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

687

errors=

688

'replace')))

689

for attr in

690

self.runtime_expansions)

691

692

try:

693

command = self.checker_command % escaped_attrs

694

except TypeError as error:

695

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

696

' %s', self.checker_command, error)

697

return True # Try again later

1153

698

self.current_checker_command = command

1154

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

1155

self.name)

1156

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

1157

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

1158

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

1159

# always replaced by /dev/null.)

1160

# The exception is when not debugging but nevertheless

1161

# running in the foreground; use the previously

1162

# created wnull.

1163

popen_args = {"close_fds": True,

1164

"shell": True,

1165

"cwd": "/"}

1166

if (not self.server_settings["debug"]

1167

and self.server_settings["foreground"]):

1168

popen_args.update({"stdout": wnull,

1169

"stderr": wnull})

1170

pipe = multiprocessing.Pipe(duplex=False)

1171

self.checker = multiprocessing.Process(

1172

target=call_pipe,

1173

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

1174

kwargs=popen_args)

1175

self.checker.start()

1176

self.checker_callback_tag = GLib.io_add_watch(

1177

GLib.IOChannel.unix_new(pipe[0].fileno()),

1178

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1179

self.checker_callback, pipe[0], command)

1180

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

699

try:

700

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

701

command, self.name)

702

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

703

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

704

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

705

# always replaced by /dev/null.)

706

self.checker = subprocess.Popen(command,

707

close_fds=True,

708

shell=True, cwd="/")

709

self.checker_callback_tag = (gobject.child_watch_add

710

(self.checker.pid,

711

self.checker_callback,

712

data=command))

713

# The checker may have completed before the gobject

714

# watch was added. Check for this.

715

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

716

if pid:

717

gobject.source_remove(self.checker_callback_tag)

718

self.checker_callback(pid, status, command)

719

except OSError as error:

720

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

721

error)

722

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

1181

723

return True

1182

724

1183

725

def stop_checker(self):

1184

726

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

1185

727

if self.checker_callback_tag:

1186

GLib.source_remove(self.checker_callback_tag)

728

gobject.source_remove(self.checker_callback_tag)

1187

729

self.checker_callback_tag = None

1188

730

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

1189

731

return

1190

732

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

1191

self.checker.terminate()

733

try:

734

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

735

#time.sleep(0.5)

736

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

737

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

738

except OSError as error:

739

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

740

raise

1192

741

self.checker = None

1193

742

1194

743

1195

def dbus_service_property(dbus_interface,

1196

signature="v",

1197

access="readwrite",

1198

byte_arrays=False):

744

def dbus_service_property(dbus_interface, signature="v",

745

access="readwrite", byte_arrays=False):

1199

746

"""Decorators for marking methods of a DBusObjectWithProperties to

1200

747

become properties on the D-Bus.

1201

748

1202

749

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

1203

750

and with one argument by "Set".

1204

751

1205

752

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

1206

753

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

1207

754

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

1210

757

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

1211

758

if byte_arrays and signature != "ay":

1212

759

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

1213

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

1214

760

" signature %r" % signature)

1215

761

def decorator(func):

1216

762

func._dbus_is_property = True

1217

763

func._dbus_interface = dbus_interface

1220

766

func._dbus_name = func.__name__

1221

767

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

1222

768

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

1223

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1224

return func

1225

1226

return decorator

1227

1228

1229

def dbus_interface_annotations(dbus_interface):

1230

"""Decorator for marking functions returning interface annotations

1231

1232

Usage:

1233

1234

@dbus_interface_annotations("org.example.Interface")

1235

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

1236

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

1237

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

1238

"false"}

1239

"""

1240

1241

def decorator(func):

1242

func._dbus_is_interface = True

1243

func._dbus_interface = dbus_interface

1244

func._dbus_name = dbus_interface

1245

return func

1246

1247

return decorator

1248

1249

1250

def dbus_annotations(annotations):

1251

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

1252

Usage:

1253

1254

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

1255

"org.freedesktop.DBus.Property."

1256

"EmitsChangedSignal": "false"})

1257

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

1258

access="r")

1259

def Property_dbus_property(self):

1260

return dbus.Boolean(False)

1261

1262

See also the DBusObjectWithAnnotations class.

1263

"""

1264

1265

def decorator(func):

1266

func._dbus_annotations = annotations

1267

return func

1268

769

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

770

return func

1269

771

return decorator

1270

772

1271

773

1272

774

class DBusPropertyException(dbus.exceptions.DBusException):

1273

775

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

1274

776

"""

1275

pass

777

def __unicode__(self):

778

return unicode(str(self))

1276

779

1277

780

1278

781

class DBusPropertyAccessException(DBusPropertyException):

1287

790

pass

1288

791

1289

792

1290

class DBusObjectWithAnnotations(dbus.service.Object):

1291

"""A D-Bus object with annotations.

1292

1293

Classes inheriting from this can use the dbus_annotations

1294

decorator to add annotations to methods or signals.

1295

"""

1296

1297

@staticmethod

1298

def _is_dbus_thing(thing):

1299

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

1300

1301

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

1302

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

1303

"""

1304

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

1305

False)

1306

1307

def _get_all_dbus_things(self, thing):

1308

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

1309

"""

1310

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

1311

athing.__get__(self))

1312

for cls in self.__class__.__mro__

1313

for name, athing in

1314

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

1315

1316

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1317

out_signature="s",

1318

path_keyword='object_path',

1319

connection_keyword='connection')

1320

def Introspect(self, object_path, connection):

1321

"""Overloading of standard D-Bus method.

1322

1323

Inserts annotation tags on methods and signals.

1324

"""

1325

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

1326

connection)

1327

try:

1328

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

1329

1330

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

1331

# Add annotation tags

1332

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

1333

for tag in if_tag.getElementsByTagName(typ):

1334

annots = dict()

1335

for name, prop in (self.

1336

_get_all_dbus_things(typ)):

1337

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

1338

and prop._dbus_interface

1339

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

1340

annots.update(getattr(

1341

prop, "_dbus_annotations", {}))

1342

for name, value in annots.items():

1343

ann_tag = document.createElement(

1344

"annotation")

1345

ann_tag.setAttribute("name", name)

1346

ann_tag.setAttribute("value", value)

1347

tag.appendChild(ann_tag)

1348

# Add interface annotation tags

1349

for annotation, value in dict(

1350

itertools.chain.from_iterable(

1351

annotations().items()

1352

for name, annotations

1353

in self._get_all_dbus_things("interface")

1354

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

1355

)).items():

1356

ann_tag = document.createElement("annotation")

1357

ann_tag.setAttribute("name", annotation)

1358

ann_tag.setAttribute("value", value)

1359

if_tag.appendChild(ann_tag)

1360

# Fix argument name for the Introspect method itself

1361

if (if_tag.getAttribute("name")

1362

== dbus.INTROSPECTABLE_IFACE):

1363

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

1364

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

1365

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

1366

if (arg.getAttribute("direction")

1367

== "out"):

1368

arg.setAttribute("name",

1369

"xml_data")

1370

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

1371

document.unlink()

1372

except (AttributeError, xml.dom.DOMException,

1373

xml.parsers.expat.ExpatError) as error:

1374

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

1375

exc_info=error)

1376

return xmlstring

1377

1378

1379

class DBusObjectWithProperties(DBusObjectWithAnnotations):

793

class DBusObjectWithProperties(dbus.service.Object):

1380

794

"""A D-Bus object with properties.

1381

795

1382

796

Classes inheriting from this can use the dbus_service_property

1383

797

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

1384

798

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

1385

799

"""

1386

800

801

@staticmethod

802

def _is_dbus_property(obj):

803

return getattr(obj, "_dbus_is_property", False)

804

805

def _get_all_dbus_properties(self):

806

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

807

"""

808

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

809

for cls in self.__class__.__mro__

810

for name, prop in

811

inspect.getmembers(cls, self._is_dbus_property))

812

1387

813

def _get_dbus_property(self, interface_name, property_name):

1388

814

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

1389

815

property with the specified name and interface.

1390

816

"""

1391

for cls in self.__class__.__mro__:

1392

for name, value in inspect.getmembers(

1393

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

817

for cls in self.__class__.__mro__:

818

for name, value in (inspect.getmembers

819

(cls, self._is_dbus_property)):

1394

820

if (value._dbus_name == property_name

1395

821

and value._dbus_interface == interface_name):

1396

822

return value.__get__(self)

1397

823

1398

824

# No such property

1399

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

1400

self.dbus_object_path, interface_name, property_name))

1401

1402

@classmethod

1403

def _get_all_interface_names(cls):

1404

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

1405

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

1406

"_dbus_interface", None)

1407

for x in (inspect.getmro(cls))

1408

for attr in dir(x))

1409

if name is not None)

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="ss",

825

raise DBusPropertyNotFound(self.dbus_object_path + ":"

826

+ interface_name + "."

827

+ property_name)

828

829

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

1413

830

out_signature="v")

1414

831

def Get(self, interface_name, property_name):

1415

832

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

1421

838

if not hasattr(value, "variant_level"):

1422

839

return value

1423

840

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

1424

841

1425

842

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

1426

843

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

1427

844

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

1433

850

# The byte_arrays option is not supported yet on

1434

851

# signatures other than "ay".

1435

852

if prop._dbus_signature != "ay":

1436

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

1437

"'ay' signature {!r}"

1438

.format(prop._dbus_signature))

1439

value = dbus.ByteArray(bytes(value))

853

raise ValueError

854

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

855

for byte in value))

1440

856

prop(value)

1441

1442

@dbus.service.method(dbus.PROPERTIES_IFACE,

1443

in_signature="s",

857

858

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

1444

859

out_signature="a{sv}")

1445

860

def GetAll(self, interface_name):

1446

861

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

1447

862

standard.

1448

863

1449

864

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

1450

865

"""

1451

866

properties = {}

1452

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

867

for name, prop in self._get_all_dbus_properties():

1453

868

if (interface_name

1454

869

and interface_name != prop._dbus_interface):

1455

870

# Interface non-empty but did not match

1461

876

if not hasattr(value, "variant_level"):

1462

877

properties[name] = value

1463

878

continue

1464

properties[name] = type(value)(

1465

value, variant_level=value.variant_level + 1)

879

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

880

value.variant_level+1)

1466

881

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

1467

1468

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

1469

def PropertiesChanged(self, interface_name, changed_properties,

1470

invalidated_properties):

1471

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

1472

standard.

1473

"""

1474

pass

1475

882

1476

883

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1477

884

out_signature="s",

1478

885

path_keyword='object_path',

1479

886

connection_keyword='connection')

1480

887

def Introspect(self, object_path, connection):

1481

"""Overloading of standard D-Bus method.

1482

1483

Inserts property tags and interface annotation tags.

888

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

1484

889

"""

1485

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1486

object_path,

1487

connection)

890

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

891

connection)

1488

892

try:

1489

893

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

1490

1491

894

def make_tag(document, name, prop):

1492

895

e = document.createElement("property")

1493

896

e.setAttribute("name", name)

1494

897

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

1495

898

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

1496

899

return e

1497

1498

900

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

1499

# Add property tags

1500

901

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

1501

902

for name, prop

1502

in self._get_all_dbus_things("property")

903

in self._get_all_dbus_properties()

1503

904

if prop._dbus_interface

1504

905

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

1505

906

if_tag.appendChild(tag)

1506

# Add annotation tags for properties

1507

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

1508

annots = dict()

1509

for name, prop in self._get_all_dbus_things(

1510

"property"):

1511

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

1512

and prop._dbus_interface

1513

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

1514

annots.update(getattr(

1515

prop, "_dbus_annotations", {}))

1516

for name, value in annots.items():

1517

ann_tag = document.createElement(

1518

"annotation")

1519

ann_tag.setAttribute("name", name)

1520

ann_tag.setAttribute("value", value)

1521

tag.appendChild(ann_tag)

1522

907

# Add the names to the return values for the

1523

908

# "org.freedesktop.DBus.Properties" methods

1524

909

if (if_tag.getAttribute("name")

1539

924

except (AttributeError, xml.dom.DOMException,

1540

925

xml.parsers.expat.ExpatError) as error:

1541

926

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

1542

exc_info=error)

1543

return xmlstring

1544

1545

1546

try:

1547

dbus.OBJECT_MANAGER_IFACE

1548

except AttributeError:

1549

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

1550

1551

1552

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1553

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

1554

1555

Classes inheriting from this exposes the standard

1556

GetManagedObjects call and the InterfacesAdded and

1557

InterfacesRemoved signals on the standard

1558

"org.freedesktop.DBus.ObjectManager" interface.

1559

1560

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

1561

manually.

1562

"""

1563

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1564

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

1565

def GetManagedObjects(self):

1566

"""This function must be overridden"""

1567

raise NotImplementedError()

1568

1569

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1570

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

1571

def InterfacesAdded(self, object_path, interfaces_and_properties):

1572

pass

1573

1574

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

1575

def InterfacesRemoved(self, object_path, interfaces):

1576

pass

1577

1578

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1579

out_signature="s",

1580

path_keyword='object_path',

1581

connection_keyword='connection')

1582

def Introspect(self, object_path, connection):

1583

"""Overloading of standard D-Bus method.

1584

1585

Override return argument name of GetManagedObjects to be

1586

"objpath_interfaces_and_properties"

1587

"""

1588

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1589

object_path,

1590

connection)

1591

try:

1592

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

1593

1594

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

1595

# Fix argument name for the GetManagedObjects method

1596

if (if_tag.getAttribute("name")

1597

== dbus.OBJECT_MANAGER_IFACE):

1598

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

1599

if (cn.getAttribute("name")

1600

== "GetManagedObjects"):

1601

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

1602

if (arg.getAttribute("direction")

1603

== "out"):

1604

arg.setAttribute(

1605

"name",

1606

"objpath_interfaces"

1607

"_and_properties")

1608

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

1609

document.unlink()

1610

except (AttributeError, xml.dom.DOMException,

1611

xml.parsers.expat.ExpatError) as error:

1612

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

1613

exc_info=error)

1614

return xmlstring

1615

1616

1617

def datetime_to_dbus(dt, variant_level=0):

927

error)

928

return xmlstring

929

930

931

def datetime_to_dbus (dt, variant_level=0):

1618

932

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

1619

933

if dt is None:

1620

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

1621

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

1622

1623

1624

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1625

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

1626

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

1627

interface names according to the "alt_interface_names" mapping.

1628

Usage:

1629

1630

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

1631

"net.example.AlternateInterface"})

1632

class SampleDBusObject(dbus.service.Object):

1633

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

1634

def SampleDBusMethod():

1635

pass

1636

1637

The above "SampleDBusMethod" on "SampleDBusObject" will be

1638

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

1639

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

1640

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

1641

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

1642

1643

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

1644

(from DBusObjectWithProperties) and interfaces (from the

1645

dbus_interface_annotations decorator).

934

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

935

return dbus.String(dt.isoformat(),

936

variant_level=variant_level)

937

938

939

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

940

.__metaclass__):

941

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

942

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

1646

943

"""

1647

1648

def wrapper(cls):

1649

for orig_interface_name, alt_interface_name in (

1650

alt_interface_names.items()):

1651

attr = {}

1652

interface_names = set()

1653

# Go though all attributes of the class

1654

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

944

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

945

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

946

# methods, signals, or properties in them

947

for base in (b for b in bases

948

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

949

# Go though all attributes of the base class

950

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

1655

951

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

1656

952

# with the wrong interface name

1657

953

if (not hasattr(attribute, "_dbus_interface")

1658

or not attribute._dbus_interface.startswith(

1659

orig_interface_name)):

954

or not attribute._dbus_interface

955

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

1660

956

continue

1661

957

# Create an alternate D-Bus interface name based on

1662

958

# the current name

1663

alt_interface = attribute._dbus_interface.replace(

1664

orig_interface_name, alt_interface_name)

1665

interface_names.add(alt_interface)

959

alt_interface = (attribute._dbus_interface

960

.replace("se.recompile.Mandos",

961

"se.bsnet.fukt.Mandos"))

1666

962

# Is this a D-Bus signal?

1667

963

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

1668

# Extract the original non-method undecorated

1669

# function by black magic

1670

if sys.version_info.major == 2:

1671

nonmethod_func = (dict(

964

# Extract the original non-method function by

965

# black magic

966

nonmethod_func = (dict(

1672

967

zip(attribute.func_code.co_freevars,

1673

attribute.__closure__))

1674

["func"].cell_contents)

1675

else:

1676

nonmethod_func = (dict(

1677

zip(attribute.__code__.co_freevars,

1678

attribute.__closure__))

1679

["func"].cell_contents)

968

attribute.__closure__))["func"]

969

.cell_contents)

1680

970

# Create a new, but exactly alike, function

1681

971

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

1682

972

# with the alternate D-Bus interface name

1683

new_function = copy_function(nonmethod_func)

1684

new_function = (dbus.service.signal(

1685

alt_interface,

1686

attribute._dbus_signature)(new_function))

1687

# Copy annotations, if any

1688

try:

1689

new_function._dbus_annotations = dict(

1690

attribute._dbus_annotations)

1691

except AttributeError:

1692

pass

1693

973

new_function = (dbus.service.signal

974

(alt_interface,

975

attribute._dbus_signature)

976

(types.FunctionType(

977

nonmethod_func.func_code,

978

nonmethod_func.func_globals,

979

nonmethod_func.func_name,

980

nonmethod_func.func_defaults,

981

nonmethod_func.func_closure)))

1694

982

# Define a creator of a function to call both the

1695

# original and alternate functions, so both the

1696

# original and alternate signals gets sent when

1697

# the function is called

983

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

984

# signals gets sent when the function is called

1698

985

def fixscope(func1, func2):

1699

986

"""This function is a scope container to pass

1700

987

func1 and func2 to the "call_both" function

1701

988

outside of its arguments"""

1702

1703

@functools.wraps(func2)

1704

989

def call_both(*args, **kwargs):

1705

990

"""This function will emit two D-Bus

1706

991

signals by calling func1 and func2"""

1707

992

func1(*args, **kwargs)

1708

993

func2(*args, **kwargs)

1709

# Make wrapper function look like a D-Bus

1710

# signal

1711

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

1712

if name.startswith("_dbus_"):

1713

setattr(call_both, name, attr)

1714

1715

994

return call_both

1716

995

# Create the "call_both" function and add it to

1717

996

# the class

1718

attr[attrname] = fixscope(attribute, new_function)

997

attr[attrname] = fixscope(attribute,

998

new_function)

1719

999

# Is this a D-Bus method?

1720

1000

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

1721

1001

# Create a new, but exactly alike, function

1722

1002

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

1723

1003

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

1724

1004

# to the class.

1725

attr[attrname] = (

1726

dbus.service.method(

1727

alt_interface,

1728

attribute._dbus_in_signature,

1729

attribute._dbus_out_signature)

1730

(copy_function(attribute)))

1731

# Copy annotations, if any

1732

try:

1733

attr[attrname]._dbus_annotations = dict(

1734

attribute._dbus_annotations)

1735

except AttributeError:

1736

pass

1005

attr[attrname] = (dbus.service.method

1006

(alt_interface,

1007

attribute._dbus_in_signature,

1008

attribute._dbus_out_signature)

1009

(types.FunctionType

1010

(attribute.func_code,

1011

attribute.func_globals,

1012

attribute.func_name,

1013

attribute.func_defaults,

1014

attribute.func_closure)))

1737

1015

# Is this a D-Bus property?

1738

1016

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

1739

1017

# Create a new, but exactly alike, function

1740

1018

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

1741

1019

# property with the alternate D-Bus interface

1742

1020

# name. Add it to the class.

1743

attr[attrname] = (dbus_service_property(

1744

alt_interface, attribute._dbus_signature,

1745

attribute._dbus_access,

1746

attribute._dbus_get_args_options

1747

["byte_arrays"])

1748

(copy_function(attribute)))

1749

# Copy annotations, if any

1750

try:

1751

attr[attrname]._dbus_annotations = dict(

1752

attribute._dbus_annotations)

1753

except AttributeError:

1754

pass

1755

# Is this a D-Bus interface?

1756

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

1757

# Create a new, but exactly alike, function

1758

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

1759

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

1760

# to the class.

1761

attr[attrname] = (

1762

dbus_interface_annotations(alt_interface)

1763

(copy_function(attribute)))

1764

if deprecate:

1765

# Deprecate all alternate interfaces

1766

iname = "_AlternateDBusNames_interface_annotation{}"

1767

for interface_name in interface_names:

1768

1769

@dbus_interface_annotations(interface_name)

1770

def func(self):

1771

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

1772

"true"}

1773

# Find an unused name

1774

for aname in (iname.format(i)

1775

for i in itertools.count()):

1776

if aname not in attr:

1777

attr[aname] = func

1778

break

1779

if interface_names:

1780

# Replace the class with a new subclass of it with

1781

# methods, signals, etc. as created above.

1782

if sys.version_info.major == 2:

1783

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

1784

(cls, ), attr)

1785

else:

1786

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

1787

(cls, ), attr)

1788

return cls

1789

1790

return wrapper

1791

1792

1793

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

1794

"se.bsnet.fukt.Mandos"})

1021

attr[attrname] = (dbus_service_property

1022

(alt_interface,

1023

attribute._dbus_signature,

1024

attribute._dbus_access,

1025

attribute

1026

._dbus_get_args_options

1027

["byte_arrays"])

1028

(types.FunctionType

1029

(attribute.func_code,

1030

attribute.func_globals,

1031

attribute.func_name,

1032

attribute.func_defaults,

1033

attribute.func_closure)))

1034

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

1035

1036

1795

1037

class ClientDBus(Client, DBusObjectWithProperties):

1796

1038

"""A Client class using D-Bus

1797

1039

1798

1040

Attributes:

1799

1041

dbus_object_path: dbus.ObjectPath

1800

1042

bus: dbus.SystemBus()

1801

1043

"""

1802

1044

1803

1045

runtime_expansions = (Client.runtime_expansions

1804

+ ("dbus_object_path", ))

1805

1806

_interface = "se.recompile.Mandos.Client"

1807

1046

+ ("dbus_object_path",))

1047

1808

1048

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

1809

1810

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

1049

1050

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

1811

1051

self.bus = bus

1812

1052

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

1813

1053

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

1814

1054

# the D-Bus

1815

client_object_name = str(self.name).translate(

1055

client_object_name = unicode(self.name).translate(

1816

1056

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

1817

1057

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

1818

self.dbus_object_path = dbus.ObjectPath(

1819

"/clients/" + client_object_name)

1058

self.dbus_object_path = (dbus.ObjectPath

1059

("/clients/" + client_object_name))

1820

1060

DBusObjectWithProperties.__init__(self, self.bus,

1821

1061

self.dbus_object_path)

1822

1823

def notifychangeproperty(transform_func, dbus_name,

1824

type_func=lambda x: x,

1825

variant_level=1,

1826

invalidate_only=False,

1827

_interface=_interface):

1062

1063

def notifychangeproperty(transform_func,

1064

dbus_name, type_func=lambda x: x,

1065

variant_level=1):

1828

1066

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

1829

1067

its changes to DBus.

1830

1068

1831

1069

transform_fun: Function that takes a value and a variant_level

1832

1070

and transforms it to a D-Bus type.

1833

1071

dbus_name: D-Bus name of the variable

1835

1073

to the D-Bus. Default: no transform

1836

1074

variant_level: D-Bus variant level. Default: 1

1837

1075

"""

1838

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

1839

1076

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

1840

1077

def setter(self, value):

1841

1078

if hasattr(self, "dbus_object_path"):

1842

1079

if (not hasattr(self, attrname) or

1843

1080

type_func(getattr(self, attrname, None))

1844

1081

!= type_func(value)):

1845

if invalidate_only:

1846

self.PropertiesChanged(

1847

_interface, dbus.Dictionary(),

1848

dbus.Array((dbus_name, )))

1849

else:

1850

dbus_value = transform_func(

1851

type_func(value),

1852

variant_level=variant_level)

1853

self.PropertyChanged(dbus.String(dbus_name),

1854

dbus_value)

1855

self.PropertiesChanged(

1856

_interface,

1857

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

1858

dbus_value}),

1859

dbus.Array())

1082

dbus_value = transform_func(type_func(value),

1083

variant_level

1084

=variant_level)

1085

self.PropertyChanged(dbus.String(dbus_name),

1086

dbus_value)

1860

1087

setattr(self, attrname, value)

1861

1088

1862

1089

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

1863

1090

1091

1864

1092

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1865

1093

approvals_pending = notifychangeproperty(dbus.Boolean,

1866

1094

"ApprovalPending",

1867

type_func=bool)

1095

type_func = bool)

1868

1096

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

1869

1097

last_enabled = notifychangeproperty(datetime_to_dbus,

1870

1098

"LastEnabled")

1871

checker = notifychangeproperty(

1872

dbus.Boolean, "CheckerRunning",

1873

type_func=lambda checker: checker is not None)

1099

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

1100

type_func = lambda checker:

1101

checker is not None)

1874

1102

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1875

1103

"LastCheckedOK")

1876

1104

last_checker_status = notifychangeproperty(dbus.Int16,

1879

1107

datetime_to_dbus, "LastApprovalRequest")

1880

1108

approved_by_default = notifychangeproperty(dbus.Boolean,

1881

1109

"ApprovedByDefault")

1882

approval_delay = notifychangeproperty(

1883

dbus.UInt64, "ApprovalDelay",

1884

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

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1885

1114

approval_duration = notifychangeproperty(

1886

1115

dbus.UInt64, "ApprovalDuration",

1887

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

1116

type_func = timedelta_to_milliseconds)

1888

1117

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

1889

timeout = notifychangeproperty(

1890

dbus.UInt64, "Timeout",

1891

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1892

1121

extended_timeout = notifychangeproperty(

1893

1122

dbus.UInt64, "ExtendedTimeout",

1894

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

1895

interval = notifychangeproperty(

1896

dbus.UInt64, "Interval",

1897

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

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

timedelta_to_milliseconds)

1898

1128

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

1899

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

1900

invalidate_only=True)

1901

1129

1902

1130

del notifychangeproperty

1903

1131

1904

1132

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

1905

1133

try:

1906

1134

self.remove_from_connection()

1909

1137

if hasattr(DBusObjectWithProperties, "__del__"):

1910

1138

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

1911

1139

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

1912

1913

def checker_callback(self, source, condition,

1914

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

1915

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

1916

connection, command, *args,

1917

**kwargs)

1918

exitstatus = self.last_checker_status

1919

if exitstatus >= 0:

1140

1141

def checker_callback(self, pid, condition, command,

1142

*args, **kwargs):

1143

self.checker_callback_tag = None

1144

self.checker = None

1145

if os.WIFEXITED(condition):

1146

exitstatus = os.WEXITSTATUS(condition)

1920

1147

# Emit D-Bus signal

1921

1148

self.CheckerCompleted(dbus.Int16(exitstatus),

1922

# This is specific to GNU libC

1923

dbus.Int64(exitstatus << 8),

1149

dbus.Int64(condition),

1924

1150

dbus.String(command))

1925

1151

else:

1926

1152

# Emit D-Bus signal

1927

1153

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

1928

dbus.Int64(

1929

# This is specific to GNU libC

1930

(exitstatus << 8)

1931

| self.last_checker_signal),

1154

dbus.Int64(condition),

1932

1155

dbus.String(command))

1933

return ret

1934

1156

1157

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

1158

*args, **kwargs)

1159

1935

1160

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

1936

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

1161

old_checker = self.checker

1162

if self.checker is not None:

1163

old_checker_pid = self.checker.pid

1164

else:

1165

old_checker_pid = None

1937

1166

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

1938

1167

# Only if new checker process was started

1939

1168

if (self.checker is not None

1941

1170

# Emit D-Bus signal

1942

1171

self.CheckerStarted(self.current_checker_command)

1943

1172

return r

1944

1173

1945

1174

def _reset_approved(self):

1946

1175

self.approved = None

1947

1176

return False

1948

1177

1949

1178

def approve(self, value=True):

1179

self.send_changedstate()

1950

1180

self.approved = value

1951

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

1952

* 1000), self._reset_approved)

1953

self.send_changedstate()

1954

1955

# D-Bus methods, signals & properties

1956

1957

# Interfaces

1958

1959

# Signals

1960

1181

gobject.timeout_add(timedelta_to_milliseconds

1182

(self.approval_duration),

1183

self._reset_approved)

1184

1185

1186

## D-Bus methods, signals & properties

1187

_interface = "se.recompile.Mandos.Client"

1188

1189

## Signals

1190

1961

1191

# CheckerCompleted - signal

1962

1192

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

1963

1193

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

1964

1194

"D-Bus signal"

1965

1195

pass

1966

1196

1967

1197

# CheckerStarted - signal

1968

1198

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

1969

1199

def CheckerStarted(self, command):

1970

1200

"D-Bus signal"

1971

1201

pass

1972

1202

1973

1203

# PropertyChanged - signal

1974

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

1975

1204

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

1976

1205

def PropertyChanged(self, property, value):

1977

1206

"D-Bus signal"

1978

1207

pass

1979

1208

1980

1209

# GotSecret - signal

1981

1210

@dbus.service.signal(_interface)

1982

1211

def GotSecret(self):

1985

1214

server to mandos-client

1986

1215

"""

1987

1216

pass

1988

1217

1989

1218

# Rejected - signal

1990

1219

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

1991

1220

def Rejected(self, reason):

1992

1221

"D-Bus signal"

1993

1222

pass

1994

1223

1995

1224

# NeedApproval - signal

1996

1225

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

1997

1226

def NeedApproval(self, timeout, default):

1998

1227

"D-Bus signal"

1999

1228

return self.need_approval()

2000

2001

# Methods

2002

1229

1230

## Methods

1231

2003

1232

# Approve - method

2004

1233

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

2005

1234

def Approve(self, value):

2006

1235

self.approve(value)

2007

1236

2008

1237

# CheckedOK - method

2009

1238

@dbus.service.method(_interface)

2010

1239

def CheckedOK(self):

2011

1240

self.checked_ok()

2012

1241

2013

1242

# Enable - method

2014

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

2015

1243

@dbus.service.method(_interface)

2016

1244

def Enable(self):

2017

1245

"D-Bus method"

2018

1246

self.enable()

2019

1247

2020

1248

# StartChecker - method

2021

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

2022

1249

@dbus.service.method(_interface)

2023

1250

def StartChecker(self):

2024

1251

"D-Bus method"

2025

1252

self.start_checker()

2026

1253

2027

1254

# Disable - method

2028

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

2029

1255

@dbus.service.method(_interface)

2030

1256

def Disable(self):

2031

1257

"D-Bus method"

2032

1258

self.disable()

2033

1259

2034

1260

# StopChecker - method

2035

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

2036

1261

@dbus.service.method(_interface)

2037

1262

def StopChecker(self):

2038

1263

self.stop_checker()

2039

2040

# Properties

2041

1264

1265

## Properties

1266

2042

1267

# ApprovalPending - property

2043

1268

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

2044

1269

def ApprovalPending_dbus_property(self):

2045

1270

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

2046

1271

2047

1272

# ApprovedByDefault - property

2048

@dbus_service_property(_interface,

2049

signature="b",

1273

@dbus_service_property(_interface, signature="b",

2050

1274

access="readwrite")

2051

1275

def ApprovedByDefault_dbus_property(self, value=None):

2052

1276

if value is None: # get

2053

1277

return dbus.Boolean(self.approved_by_default)

2054

1278

self.approved_by_default = bool(value)

2055

1279

2056

1280

# ApprovalDelay - property

2057

@dbus_service_property(_interface,

2058

signature="t",

1281

@dbus_service_property(_interface, signature="t",

2059

1282

access="readwrite")

2060

1283

def ApprovalDelay_dbus_property(self, value=None):

2061

1284

if value is None: # get

2062

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

2063

* 1000)

1285

return dbus.UInt64(self.approval_delay_milliseconds())

2064

1286

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

2065

1287

2066

1288

# ApprovalDuration - property

2067

@dbus_service_property(_interface,

2068

signature="t",

1289

@dbus_service_property(_interface, signature="t",

2069

1290

access="readwrite")

2070

1291

def ApprovalDuration_dbus_property(self, value=None):

2071

1292

if value is None: # get

2072

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

2073

* 1000)

1293

return dbus.UInt64(timedelta_to_milliseconds(

1294

self.approval_duration))

2074

1295

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

2075

1296

2076

1297

# Name - property

2077

@dbus_annotations(

2078

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

2079

1298

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

2080

1299

def Name_dbus_property(self):

2081

1300

return dbus.String(self.name)

2082

2083

# KeyID - property

2084

@dbus_annotations(

2085

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

2086

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

2087

def KeyID_dbus_property(self):

2088

return dbus.String(self.key_id)

2089

1301

2090

1302

# Fingerprint - property

2091

@dbus_annotations(

2092

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

2093

1303

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

2094

1304

def Fingerprint_dbus_property(self):

2095

1305

return dbus.String(self.fingerprint)

2096

1306

2097

1307

# Host - property

2098

@dbus_service_property(_interface,

2099

signature="s",

1308

@dbus_service_property(_interface, signature="s",

2100

1309

access="readwrite")

2101

1310

def Host_dbus_property(self, value=None):

2102

1311

if value is None: # get

2103

1312

return dbus.String(self.host)

2104

self.host = str(value)

2105

1313

self.host = unicode(value)

1314

2106

1315

# Created - property

2107

@dbus_annotations(

2108

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

2109

1316

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

2110

1317

def Created_dbus_property(self):

2111

1318

return datetime_to_dbus(self.created)

2112

1319

2113

1320

# LastEnabled - property

2114

1321

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

2115

1322

def LastEnabled_dbus_property(self):

2116

1323

return datetime_to_dbus(self.last_enabled)

2117

1324

2118

1325

# Enabled - property

2119

@dbus_service_property(_interface,

2120

signature="b",

1326

@dbus_service_property(_interface, signature="b",

2121

1327

access="readwrite")

2122

1328

def Enabled_dbus_property(self, value=None):

2123

1329

if value is None: # get

2126

1332

self.enable()

2127

1333

else:

2128

1334

self.disable()

2129

1335

2130

1336

# LastCheckedOK - property

2131

@dbus_service_property(_interface,

2132

signature="s",

1337

@dbus_service_property(_interface, signature="s",

2133

1338

access="readwrite")

2134

1339

def LastCheckedOK_dbus_property(self, value=None):

2135

1340

if value is not None:

2136

1341

self.checked_ok()

2137

1342

return

2138

1343

return datetime_to_dbus(self.last_checked_ok)

2139

1344

2140

1345

# LastCheckerStatus - property

2141

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

1346

@dbus_service_property(_interface, signature="n",

1347

access="read")

2142

1348

def LastCheckerStatus_dbus_property(self):

2143

1349

return dbus.Int16(self.last_checker_status)

2144

1350

2145

1351

# Expires - property

2146

1352

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

2147

1353

def Expires_dbus_property(self):

2148

1354

return datetime_to_dbus(self.expires)

2149

1355

2150

1356

# LastApprovalRequest - property

2151

1357

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

2152

1358

def LastApprovalRequest_dbus_property(self):

2153

1359

return datetime_to_dbus(self.last_approval_request)

2154

1360

2155

1361

# Timeout - property

2156

@dbus_service_property(_interface,

2157

signature="t",

1362

@dbus_service_property(_interface, signature="t",

2158

1363

access="readwrite")

2159

1364

def Timeout_dbus_property(self, value=None):

2160

1365

if value is None: # get

2161

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

2162

old_timeout = self.timeout

1366

return dbus.UInt64(self.timeout_milliseconds())

2163

1367

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

2164

# Reschedule disabling

1368

# Reschedule timeout

2165

1369

if self.enabled:

2166

1370

now = datetime.datetime.utcnow()

2167

self.expires += self.timeout - old_timeout

2168

if self.expires <= now:

1371

time_to_die = timedelta_to_milliseconds(

1372

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

1373

if time_to_die <= 0:

2169

1374

# The timeout has passed

2170

1375

self.disable()

2171

1376

else:

1377

self.expires = (now +

1378

datetime.timedelta(milliseconds =

1379

time_to_die))

2172

1380

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

2173

1381

is None):

2174

1382

return

2175

GLib.source_remove(self.disable_initiator_tag)

2176

self.disable_initiator_tag = GLib.timeout_add(

2177

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

2178

self.disable)

2179

1383

gobject.source_remove(self.disable_initiator_tag)

1384

self.disable_initiator_tag = (gobject.timeout_add

1385

(time_to_die,

1386

self.disable))

1387

2180

1388

# ExtendedTimeout - property

2181

@dbus_service_property(_interface,

2182

signature="t",

1389

@dbus_service_property(_interface, signature="t",

2183

1390

access="readwrite")

2184

1391

def ExtendedTimeout_dbus_property(self, value=None):

2185

1392

if value is None: # get

2186

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

2187

* 1000)

1393

return dbus.UInt64(self.extended_timeout_milliseconds())

2188

1394

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

2189

1395

2190

1396

# Interval - property

2191

@dbus_service_property(_interface,

2192

signature="t",

1397

@dbus_service_property(_interface, signature="t",

2193

1398

access="readwrite")

2194

1399

def Interval_dbus_property(self, value=None):

2195

1400

if value is None: # get

2196

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

1401

return dbus.UInt64(self.interval_milliseconds())

2197

1402

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

2198

1403

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

2199

1404

return

2200

1405

if self.enabled:

2201

1406

# Reschedule checker run

2202

GLib.source_remove(self.checker_initiator_tag)

2203

self.checker_initiator_tag = GLib.timeout_add(

2204

value, self.start_checker)

2205

self.start_checker() # Start one now, too

2206

1407

gobject.source_remove(self.checker_initiator_tag)

1408

self.checker_initiator_tag = (gobject.timeout_add

1409

(value, self.start_checker))

1410

self.start_checker() # Start one now, too

1411

2207

1412

# Checker - property

2208

@dbus_service_property(_interface,

2209

signature="s",

1413

@dbus_service_property(_interface, signature="s",

2210

1414

access="readwrite")

2211

1415

def Checker_dbus_property(self, value=None):

2212

1416

if value is None: # get

2213

1417

return dbus.String(self.checker_command)

2214

self.checker_command = str(value)

2215

1418

self.checker_command = unicode(value)

1419

2216

1420

# CheckerRunning - property

2217

@dbus_service_property(_interface,

2218

signature="b",

1421

@dbus_service_property(_interface, signature="b",

2219

1422

access="readwrite")

2220

1423

def CheckerRunning_dbus_property(self, value=None):

2221

1424

if value is None: # get

2224

1427

self.start_checker()

2225

1428

else:

2226

1429

self.stop_checker()

2227

1430

2228

1431

# ObjectPath - property

2229

@dbus_annotations(

2230

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

2231

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

2232

1432

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

2233

1433

def ObjectPath_dbus_property(self):

2234

return self.dbus_object_path # is already a dbus.ObjectPath

2235

1434

return self.dbus_object_path # is already a dbus.ObjectPath

1435

2236

1436

# Secret = property

2237

@dbus_annotations(

2238

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

2239

"invalidates"})

2240

@dbus_service_property(_interface,

2241

signature="ay",

2242

access="write",

2243

byte_arrays=True)

1437

@dbus_service_property(_interface, signature="ay",

1438

access="write", byte_arrays=True)

2244

1439

def Secret_dbus_property(self, value):

2245

self.secret = bytes(value)

2246

1440

self.secret = str(value)

1441

2247

1442

del _interface

2248

1443

2249

1444

2250

class ProxyClient:

2251

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

1445

class ProxyClient(object):

1446

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

2252

1447

self._pipe = child_pipe

2253

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

1448

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

2254

1449

if not self._pipe.recv():

2255

raise KeyError(key_id or fpr)

2256

1450

raise KeyError()

1451

2257

1452

def __getattribute__(self, name):

2258

1453

if name == '_pipe':

2259

1454

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

2262

1457

if data[0] == 'data':

2263

1458

return data[1]

2264

1459

if data[0] == 'function':

2265

2266

1460

def func(*args, **kwargs):

2267

1461

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

2268

1462

return self._pipe.recv()[1]

2269

2270

1463

return func

2271

1464

2272

1465

def __setattr__(self, name, value):

2273

1466

if name == '_pipe':

2274

1467

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

2275

1468

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

2276

1469

2277

1470

1471

class ClientDBusTransitional(ClientDBus):

1472

__metaclass__ = AlternateDBusNamesMetaclass

1473

1474

2278

1475

class ClientHandler(socketserver.BaseRequestHandler, object):

2279

1476

"""A class to handle client connections.

2280

1477

2281

1478

Instantiated once for each connection to handle it.

2282

1479

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

2283

1480

2284

1481

def handle(self):

2285

1482

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

2286

1483

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

2287

str(self.client_address))

1484

unicode(self.client_address))

2288

1485

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

2289

1486

self.server.child_pipe.fileno())

2290

2291

session = gnutls.ClientSession(self.request)

2292

2293

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

2294

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

2295

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

2296

# "+DHE-DSS"))

1487

1488

session = (gnutls.connection

1489

.ClientSession(self.request,

1490

gnutls.connection

1491

.X509Credentials()))

1492

1493

# Note: gnutls.connection.X509Credentials is really a

1494

# generic GnuTLS certificate credentials object so long as

1495

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

1496

# here despite using OpenPGP certificates.

1497

1498

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

1499

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

1500

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

1501

# "+DHE-DSS"))

2297

1502

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

2298

1503

priority = self.server.gnutls_priority

2299

1504

if priority is None:

2300

1505

priority = "NORMAL"

2301

gnutls.priority_set_direct(session._c_object,

2302

priority.encode("utf-8"),

2303

None)

2304

1506

(gnutls.library.functions

1507

.gnutls_priority_set_direct(session._c_object,

1508

priority, None))

1509

2305

1510

# Start communication using the Mandos protocol

2306

1511

# Get protocol number

2307

1512

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

2308

1513

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

2309

1514

try:

2310

1515

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

2311

raise RuntimeError(line)

1516

raise RuntimeError

2312

1517

except (ValueError, IndexError, RuntimeError) as error:

2313

1518

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

2314

1519

return

2315

1520

2316

1521

# Start GnuTLS connection

2317

1522

try:

2318

1523

session.handshake()

2319

except gnutls.Error as error:

1524

except gnutls.errors.GNUTLSError as error:

2320

1525

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

2321

1526

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

2322

1527

# established. Just abandon the request.

2323

1528

return

2324

1529

logger.debug("Handshake succeeded")

2325

1530

2326

1531

approval_required = False

2327

1532

try:

2328

if gnutls.has_rawpk:

2329

fpr = b""

2330

try:

2331

key_id = self.key_id(

2332

self.peer_certificate(session))

2333

except (TypeError, gnutls.Error) as error:

2334

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

2335

return

2336

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

2337

2338

else:

2339

key_id = b""

2340

try:

2341

fpr = self.fingerprint(

2342

self.peer_certificate(session))

2343

except (TypeError, gnutls.Error) as error:

2344

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

2345

return

2346

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

2347

2348

try:

2349

client = ProxyClient(child_pipe, key_id, fpr,

1533

try:

1534

fpr = self.fingerprint(self.peer_certificate

1535

(session))

1536

except (TypeError,

1537

gnutls.errors.GNUTLSError) as error:

1538

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

1539

return

1540

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

1541

1542

try:

1543

client = ProxyClient(child_pipe, fpr,

2350

1544

self.client_address)

2351

1545

except KeyError:

2352

1546

return

2353

1547

2354

1548

if client.approval_delay:

2355

1549

delay = client.approval_delay

2356

1550

client.approvals_pending += 1

2357

1551

approval_required = True

2358

1552

2359

1553

while True:

2360

1554

if not client.enabled:

2361

1555

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

2362

client.name)

1556

client.name)

2363

1557

if self.server.use_dbus:

2364

1558

# Emit D-Bus signal

2365

1559

client.Rejected("Disabled")

2366

1560

return

2367

1561

2368

1562

if client.approved or not client.approval_delay:

2369

# We are approved or approval is disabled

1563

#We are approved or approval is disabled

2370

1564

break

2371

1565

elif client.approved is None:

2372

1566

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

2374

1568

if self.server.use_dbus:

2375

1569

# Emit D-Bus signal

2376

1570

client.NeedApproval(

2377

client.approval_delay.total_seconds()

2378

* 1000, client.approved_by_default)

1571

client.approval_delay_milliseconds(),

1572

client.approved_by_default)

2379

1573

else:

2380

1574

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

2381

1575

client.name)

2383

1577

# Emit D-Bus signal

2384

1578

client.Rejected("Denied")

2385

1579

return

2386

2387

# wait until timeout or approved

1580

1581

#wait until timeout or approved

2388

1582

time = datetime.datetime.now()

2389

1583

client.changedstate.acquire()

2390

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

1584

(client.changedstate.wait

1585

(float(client.timedelta_to_milliseconds(delay)

1586

/ 1000)))

2391

1587

client.changedstate.release()

2392

1588

time2 = datetime.datetime.now()

2393

1589

if (time2 - time) >= delay:

2403

1599

break

2404

1600

else:

2405

1601

delay -= time2 - time

2406

2407

try:

2408

session.send(client.secret)

2409

except gnutls.Error as error:

2410

logger.warning("gnutls send failed",

2411

exc_info=error)

2412

return

2413

1602

1603

sent_size = 0

1604

while sent_size < len(client.secret):

1605

try:

1606

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

1607

except gnutls.errors.GNUTLSError as error:

1608

logger.warning("gnutls send failed")

1609

return

1610

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

1611

sent, len(client.secret)

1612

- (sent_size + sent))

1613

sent_size += sent

1614

2414

1615

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

2415

1616

# bump the timeout using extended_timeout

2416

1617

client.bump_timeout(client.extended_timeout)

2417

1618

if self.server.use_dbus:

2418

1619

# Emit D-Bus signal

2419

1620

client.GotSecret()

2420

1621

2421

1622

finally:

2422

1623

if approval_required:

2423

1624

client.approvals_pending -= 1

2424

1625

try:

2425

1626

session.bye()

2426

except gnutls.Error as error:

2427

logger.warning("GnuTLS bye failed",

2428

exc_info=error)

2429

1627

except gnutls.errors.GNUTLSError as error:

1628

logger.warning("GnuTLS bye failed")

1629

2430

1630

@staticmethod

2431

1631

def peer_certificate(session):

2432

"Return the peer's certificate as a bytestring"

2433

try:

2434

cert_type = gnutls.certificate_type_get2(session._c_object,

2435

gnutls.CTYPE_PEERS)

2436

except AttributeError:

2437

cert_type = gnutls.certificate_type_get(session._c_object)

2438

if gnutls.has_rawpk:

2439

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2440

else:

2441

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2442

# If not a valid certificate type...

2443

if cert_type not in valid_cert_types:

2444

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

2445

valid_cert_types)

2446

# ...return invalid data

2447

return b""

1632

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

1633

# If not an OpenPGP certificate...

1634

if (gnutls.library.functions

1635

.gnutls_certificate_type_get(session._c_object)

1636

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1637

# ...do the normal thing

1638

return session.peer_certificate

2448

1639

list_size = ctypes.c_uint(1)

2449

cert_list = (gnutls.certificate_get_peers

1640

cert_list = (gnutls.library.functions

1641

.gnutls_certificate_get_peers

2450

1642

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

2451

1643

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

2452

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

1644

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

1645

" certificate")

2453

1646

if list_size.value == 0:

2454

1647

return None

2455

1648

cert = cert_list[0]

2456

1649

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

2457

2458

@staticmethod

2459

def key_id(certificate):

2460

"Convert a certificate bytestring to a hexdigit key ID"

2461

# New GnuTLS "datum" with the public key

2462

datum = gnutls.datum_t(

2463

ctypes.cast(ctypes.c_char_p(certificate),

2464

ctypes.POINTER(ctypes.c_ubyte)),

2465

ctypes.c_uint(len(certificate)))

2466

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

2467

# New empty GnuTLS certificate

2468

pubkey = gnutls.pubkey_t()

2469

gnutls.pubkey_init(ctypes.byref(pubkey))

2470

# Import the raw public key into the certificate

2471

gnutls.pubkey_import(pubkey,

2472

ctypes.byref(datum),

2473

gnutls.X509_FMT_DER)

2474

# New buffer for the key ID

2475

buf = ctypes.create_string_buffer(32)

2476

buf_len = ctypes.c_size_t(len(buf))

2477

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

2478

gnutls.pubkey_get_key_id(

2479

pubkey,

2480

gnutls.KEYID_USE_SHA256,

2481

ctypes.cast(ctypes.byref(buf),

2482

ctypes.POINTER(ctypes.c_ubyte)),

2483

ctypes.byref(buf_len))

2484

# Deinit the certificate

2485

gnutls.pubkey_deinit(pubkey)

2486

2487

# Convert the buffer to a Python bytestring

2488

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

2489

# Convert the bytestring to hexadecimal notation

2490

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

2491

return hex_key_id

2492

1650

2493

1651

@staticmethod

2494

1652

def fingerprint(openpgp):

2495

1653

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2496

1654

# New GnuTLS "datum" with the OpenPGP public key

2497

datum = gnutls.datum_t(

2498

ctypes.cast(ctypes.c_char_p(openpgp),

2499

ctypes.POINTER(ctypes.c_ubyte)),

2500

ctypes.c_uint(len(openpgp)))

1655

datum = (gnutls.library.types

1656

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

1657

ctypes.POINTER

1658

(ctypes.c_ubyte)),

1659

ctypes.c_uint(len(openpgp))))

2501

1660

# New empty GnuTLS certificate

2502

crt = gnutls.openpgp_crt_t()

2503

gnutls.openpgp_crt_init(ctypes.byref(crt))

1661

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2504

1664

# Import the OpenPGP public key into the certificate

2505

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

2506

gnutls.OPENPGP_FMT_RAW)

1665

(gnutls.library.functions

1666

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

1667

gnutls.library.constants

1668

.GNUTLS_OPENPGP_FMT_RAW))

2507

1669

# Verify the self signature in the key

2508

1670

crtverify = ctypes.c_uint()

2509

gnutls.openpgp_crt_verify_self(crt, 0,

2510

ctypes.byref(crtverify))

1671

(gnutls.library.functions

1672

.gnutls_openpgp_crt_verify_self(crt, 0,

1673

ctypes.byref(crtverify)))

2511

1674

if crtverify.value != 0:

2512

gnutls.openpgp_crt_deinit(crt)

2513

raise gnutls.CertificateSecurityError(code

2514

=crtverify.value)

1675

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1676

raise (gnutls.errors.CertificateSecurityError

1677

("Verify failed"))

2515

1678

# New buffer for the fingerprint

2516

1679

buf = ctypes.create_string_buffer(20)

2517

1680

buf_len = ctypes.c_size_t()

2518

1681

# Get the fingerprint from the certificate into the buffer

2519

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

2520

ctypes.byref(buf_len))

1682

(gnutls.library.functions

1683

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

1684

ctypes.byref(buf_len)))

2521

1685

# Deinit the certificate

2522

gnutls.openpgp_crt_deinit(crt)

1686

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2523

1687

# Convert the buffer to a Python bytestring

2524

1688

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

2525

1689

# Convert the bytestring to hexadecimal notation

2527

1691

return hex_fpr

2528

1692

2529

1693

2530

class MultiprocessingMixIn:

1694

class MultiprocessingMixIn(object):

2531

1695

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

2532

2533

1696

def sub_process_main(self, request, address):

2534

1697

try:

2535

1698

self.finish_request(request, address)

2536

1699

except Exception:

2537

1700

self.handle_error(request, address)

2538

1701

self.close_request(request)

2539

1702

2540

1703

def process_request(self, request, address):

2541

1704

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

2542

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

2543

args=(request, address))

1705

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

1706

args = (request,

1707

address))

2544

1708

proc.start()

2545

1709

return proc

2546

1710

2547

1711

2548

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1712

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2549

1713

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

2550

2551

1714

def process_request(self, request, client_address):

2552

1715

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

2553

1716

2554

1717

This function creates a new pipe in self.pipe

2555

1718

"""

2556

1719

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2557

1720

2558

1721

proc = MultiprocessingMixIn.process_request(self, request,

2559

1722

client_address)

2560

1723

self.child_pipe.close()

2561

1724

self.add_pipe(parent_pipe, proc)

2562

1725

2563

1726

def add_pipe(self, parent_pipe, proc):

2564

1727

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

2565

raise NotImplementedError()

1728

raise NotImplementedError

2566

1729

2567

1730

2568

1731

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2569

socketserver.TCPServer):

1732

socketserver.TCPServer, object):

2570

1733

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

2571

1734

2572

1735

Attributes:

2573

1736

enabled: Boolean; whether this server is activated yet

2574

1737

interface: None or a network interface name (string)

2575

1738

use_ipv6: Boolean; to use IPv6 or not

2576

1739

"""

2577

2578

1740

def __init__(self, server_address, RequestHandlerClass,

2579

interface=None,

2580

use_ipv6=True,

2581

socketfd=None):

2582

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

2583

creating a new one with socket.socket().

2584

"""

1741

interface=None, use_ipv6=True):

2585

1742

self.interface = interface

2586

1743

if use_ipv6:

2587

1744

self.address_family = socket.AF_INET6

2588

if socketfd is not None:

2589

# Save the file descriptor

2590

self.socketfd = socketfd

2591

# Save the original socket.socket() function

2592

self.socket_socket = socket.socket

2593

2594

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

2595

#

2596

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

2597

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

2598

# patching socket.socket.)

2599

#

2600

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

2601

@functools.wraps(socket.socket)

2602

def socket_wrapper(*args, **kwargs):

2603

# Restore original function so subsequent calls are

2604

# not affected.

2605

socket.socket = self.socket_socket

2606

del self.socket_socket

2607

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

2608

# saved file descriptor.

2609

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

2610

# Replace socket.socket() function with wrapper

2611

socket.socket = socket_wrapper

2612

# The socketserver.TCPServer.__init__ will call

2613

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

2614

# socket_wrapper(), if socketfd was set.

2615

1745

socketserver.TCPServer.__init__(self, server_address,

2616

1746

RequestHandlerClass)

2617

2618

1747

def server_bind(self):

2619

1748

"""This overrides the normal server_bind() function

2620

1749

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

2621

1750

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

2622

global SO_BINDTODEVICE

2623

1751

if self.interface is not None:

2624

1752

if SO_BINDTODEVICE is None:

2625

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

2626

# common enough.

2627

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

2628

SO_BINDTODEVICE = 25

2629

try:

2630

self.socket.setsockopt(

2631

socket.SOL_SOCKET, SO_BINDTODEVICE,

2632

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

2633

except socket.error as error:

2634

if error.errno == errno.EPERM:

2635

logger.error("No permission to bind to"

2636

" interface %s", self.interface)

2637

elif error.errno == errno.ENOPROTOOPT:

2638

logger.error("SO_BINDTODEVICE not available;"

2639

" cannot bind to interface %s",

2640

self.interface)

2641

elif error.errno == errno.ENODEV:

2642

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

2643

" cannot bind", self.interface)

2644

else:

2645

raise

1753

logger.error("SO_BINDTODEVICE does not exist;"

1754

" cannot bind to interface %s",

1755

self.interface)

1756

else:

1757

try:

1758

self.socket.setsockopt(socket.SOL_SOCKET,

1759

SO_BINDTODEVICE,

1760

str(self.interface

1761

+ '\0'))

1762

except socket.error as error:

1763

if error[0] == errno.EPERM:

1764

logger.error("No permission to"

1765

" bind to interface %s",

1766

self.interface)

1767

elif error[0] == errno.ENOPROTOOPT:

1768

logger.error("SO_BINDTODEVICE not available;"

1769

" cannot bind to interface %s",

1770

self.interface)

1771

else:

1772

raise

2646

1773

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

2647

1774

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

2648

if self.server_address[1]:

2649

self.allow_reuse_address = True

2650

1775

if not self.server_address[0]:

2651

1776

if self.address_family == socket.AF_INET6:

2652

any_address = "::" # in6addr_any

1777

any_address = "::" # in6addr_any

2653

1778

else:

2654

any_address = "0.0.0.0" # INADDR_ANY

1779

any_address = socket.INADDR_ANY

2655

1780

self.server_address = (any_address,

2656

1781

self.server_address[1])

2657

1782

elif not self.server_address[1]:

2658

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

1783

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

1784

0)

2659

1785

# if self.interface:

2660

1786

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

2661

1787

# 0, # port

2667

1793

2668

1794

class MandosServer(IPv6_TCPServer):

2669

1795

"""Mandos server.

2670

1796

2671

1797

Attributes:

2672

1798

clients: set of Client objects

2673

1799

gnutls_priority GnuTLS priority string

2674

1800

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

2675

2676

Assumes a GLib.MainLoop event loop.

1801

1802

Assumes a gobject.MainLoop event loop.

2677

1803

"""

2678

2679

1804

def __init__(self, server_address, RequestHandlerClass,

2680

interface=None,

2681

use_ipv6=True,

2682

clients=None,

2683

gnutls_priority=None,

2684

use_dbus=True,

2685

socketfd=None):

1805

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

1806

gnutls_priority=None, use_dbus=True):

2686

1807

self.enabled = False

2687

1808

self.clients = clients

2688

1809

if self.clients is None:

2691

1812

self.gnutls_priority = gnutls_priority

2692

1813

IPv6_TCPServer.__init__(self, server_address,

2693

1814

RequestHandlerClass,

2694

interface=interface,

2695

use_ipv6=use_ipv6,

2696

socketfd=socketfd)

2697

1815

interface = interface,

1816

use_ipv6 = use_ipv6)

2698

1817

def server_activate(self):

2699

1818

if self.enabled:

2700

1819

return socketserver.TCPServer.server_activate(self)

2701

1820

2702

1821

def enable(self):

2703

1822

self.enabled = True

2704

1823

2705

1824

def add_pipe(self, parent_pipe, proc):

2706

1825

# Call "handle_ipc" for both data and EOF events

2707

GLib.io_add_watch(

2708

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2709

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2710

functools.partial(self.handle_ipc,

2711

parent_pipe=parent_pipe,

2712

proc=proc))

2713

2714

def handle_ipc(self, source, condition,

2715

parent_pipe=None,

2716

proc=None,

2717

client_object=None):

1826

gobject.io_add_watch(parent_pipe.fileno(),

1827

gobject.IO_IN | gobject.IO_HUP,

1828

functools.partial(self.handle_ipc,

1829

parent_pipe =

1830

parent_pipe,

1831

proc = proc))

1832

1833

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

1834

proc = None, client_object=None):

1835

condition_names = {

1836

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

1837

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

1838

# blocking).

1839

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

1840

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

1841

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

1842

# broken, usually for pipes and

1843

# sockets).

1844

}

1845

conditions_string = ' | '.join(name

1846

for cond, name in

1847

condition_names.iteritems()

1848

if cond & condition)

2718

1849

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

2719

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

1850

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

2720

1851

# Wait for other process to exit

2721

1852

proc.join()

2722

1853

return False

2723

1854

2724

1855

# Read a request from the child

2725

1856

request = parent_pipe.recv()

2726

1857

command = request[0]

2727

1858

2728

1859

if command == 'init':

2729

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

2730

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

2731

address = request[3]

2732

2733

for c in self.clients.values():

2734

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2735

"27AE41E4649B934CA495991B7852B855"):

2736

continue

2737

if key_id and c.key_id == key_id:

2738

client = c

2739

break

2740

if fpr and c.fingerprint == fpr:

1860

fpr = request[1]

1861

address = request[2]

1862

1863

for c in self.clients.itervalues():

1864

if c.fingerprint == fpr:

2741

1865

client = c

2742

1866

break

2743

1867

else:

2744

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

2745

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

1868

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

1869

"dress: %s", fpr, address)

2746

1870

if self.use_dbus:

2747

1871

# Emit D-Bus signal

2748

mandos_dbus_service.ClientNotFound(key_id or fpr,

1872

mandos_dbus_service.ClientNotFound(fpr,

2749

1873

address[0])

2750

1874

parent_pipe.send(False)

2751

1875

return False

2752

2753

GLib.io_add_watch(

2754

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2755

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2756

functools.partial(self.handle_ipc,

2757

parent_pipe=parent_pipe,

2758

proc=proc,

2759

client_object=client))

1876

1877

gobject.io_add_watch(parent_pipe.fileno(),

1878

gobject.IO_IN | gobject.IO_HUP,

1879

functools.partial(self.handle_ipc,

1880

parent_pipe =

1881

parent_pipe,

1882

proc = proc,

1883

client_object =

1884

client))

2760

1885

parent_pipe.send(True)

2761

1886

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

2762

1887

# same fileno

2765

1890

funcname = request[1]

2766

1891

args = request[2]

2767

1892

kwargs = request[3]

2768

1893

2769

1894

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

2770

1895

funcname)(*args,

2771

**kwargs)))

2772

1896

**kwargs)))

1897

2773

1898

if command == 'getattr':

2774

1899

attrname = request[1]

2775

if isinstance(client_object.__getattribute__(attrname),

2776

collections.abc.Callable):

2777

parent_pipe.send(('function', ))

1900

if callable(client_object.__getattribute__(attrname)):

1901

parent_pipe.send(('function',))

2778

1902

else:

2779

parent_pipe.send((

2780

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

2781

1903

parent_pipe.send(('data', client_object

1904

.__getattribute__(attrname)))

1905

2782

1906

if command == 'setattr':

2783

1907

attrname = request[1]

2784

1908

value = request[2]

2785

1909

setattr(client_object, attrname, value)

2786

1910

2787

1911

return True

2788

1912

2789

1913

2790

def rfc3339_duration_to_delta(duration):

2791

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

2792

2793

>>> timedelta = datetime.timedelta

2794

>>> rfc3339_duration_to_delta("P7D") == timedelta(7)

2795

True

2796

>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)

2797

True

2798

>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)

2799

True

2800

>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)

2801

True

2802

>>> rfc3339_duration_to_delta("P1W") == timedelta(7)

2803

True

2804

>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)

2805

True

2806

>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)

2807

True

2808

>>> del timedelta

2809

"""

2810

2811

# Parsing an RFC 3339 duration with regular expressions is not

2812

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

2813

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

2814

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

2815

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

2816

# avoid excessive use of external libraries.

2817

2818

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

2819

Token = collections.namedtuple("Token", (

2820

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

2821

# a "group" containing digits

2822

"value", # datetime.timedelta or None

2823

"followers")) # Tokens valid after this token

2824

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

2825

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

2826

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

2827

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

2828

datetime.timedelta(seconds=1),

2829

frozenset((token_end, )))

2830

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

2831

datetime.timedelta(minutes=1),

2832

frozenset((token_second, token_end)))

2833

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

2834

datetime.timedelta(hours=1),

2835

frozenset((token_minute, token_end)))

2836

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

2837

None,

2838

frozenset((token_hour, token_minute,

2839

token_second)))

2840

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

2841

datetime.timedelta(days=1),

2842

frozenset((token_time, token_end)))

2843

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

2844

datetime.timedelta(weeks=4),

2845

frozenset((token_day, token_end)))

2846

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

2847

datetime.timedelta(weeks=52),

2848

frozenset((token_month, token_end)))

2849

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

2850

datetime.timedelta(weeks=1),

2851

frozenset((token_end, )))

2852

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

2853

frozenset((token_year, token_month,

2854

token_day, token_time,

2855

token_week)))

2856

# Define starting values:

2857

# Value so far

2858

value = datetime.timedelta()

2859

found_token = None

2860

# Following valid tokens

2861

followers = frozenset((token_duration, ))

2862

# String left to parse

2863

s = duration

2864

# Loop until end token is found

2865

while found_token is not token_end:

2866

# Search for any currently valid tokens

2867

for token in followers:

2868

match = token.regexp.match(s)

2869

if match is not None:

2870

# Token found

2871

if token.value is not None:

2872

# Value found, parse digits

2873

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

2874

# Add to value so far

2875

value += factor * token.value

2876

# Strip token from string

2877

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

2878

# Go to found token

2879

found_token = token

2880

# Set valid next tokens

2881

followers = found_token.followers

2882

break

2883

else:

2884

# No currently valid tokens were found

2885

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

2886

.format(duration))

2887

# End token found

2888

return value

2889

2890

2891

1914

def string_to_delta(interval):

2892

1915

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

2893

2894

>>> string_to_delta('7d') == datetime.timedelta(7)

2895

True

2896

>>> string_to_delta('60s') == datetime.timedelta(0, 60)

2897

True

2898

>>> string_to_delta('60m') == datetime.timedelta(0, 3600)

2899

True

2900

>>> string_to_delta('24h') == datetime.timedelta(1)

2901

True

2902

>>> string_to_delta('1w') == datetime.timedelta(7)

2903

True

2904

>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)

2905

True

1916

1917

>>> string_to_delta('7d')

1918

datetime.timedelta(7)

1919

>>> string_to_delta('60s')

1920

datetime.timedelta(0, 60)

1921

>>> string_to_delta('60m')

1922

datetime.timedelta(0, 3600)

1923

>>> string_to_delta('24h')

1924

datetime.timedelta(1)

1925

>>> string_to_delta('1w')

1926

datetime.timedelta(7)

1927

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

1928

datetime.timedelta(0, 330)

2906

1929

"""

2907

2908

try:

2909

return rfc3339_duration_to_delta(interval)

2910

except ValueError:

2911

pass

2912

2913

1930

timevalue = datetime.timedelta(0)

2914

1931

for s in interval.split():

2915

1932

try:

2916

suffix = s[-1]

1933

suffix = unicode(s[-1])

2917

1934

value = int(s[:-1])

2918

1935

if suffix == "d":

2919

1936

delta = datetime.timedelta(value)

2926

1943

elif suffix == "w":

2927

1944

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

2928

1945

else:

2929

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

2930

except IndexError as e:

1946

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

1947

except (ValueError, IndexError) as e:

2931

1948

raise ValueError(*(e.args))

2932

1949

timevalue += delta

2933

1950

return timevalue

2934

1951

2935

1952

2936

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

1953

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

2937

1954

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

2938

1955

2939

1956

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

2940

1957

if os.fork():

2941

1958

sys.exit()

2946

1963

sys.exit()

2947

1964

if not noclose:

2948

1965

# Close all standard open file descriptors

2949

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

1966

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

2950

1967

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

2951

1968

raise OSError(errno.ENODEV,

2952

"{} not a character device"

2953

.format(os.devnull))

1969

"%s not a character device"

1970

% os.path.devnull)

2954

1971

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

2955

1972

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

2956

1973

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

2959

1976

2960

1977

2961

1978

def main():

2962

1979

2963

1980

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

2964

1981

# Parsing of options, both command line and config file

2965

1982

2966

1983

parser = argparse.ArgumentParser()

2967

1984

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

2968

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

1985

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

2969

1986

help="show version number and exit")

2970

1987

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

2971

1988

help="Bind to interface IF")

2977

1994

help="Run self-test")

2978

1995

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

2979

1996

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

2980

" to terminal", default=None)

1997

" to terminal")

2981

1998

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

2982

1999

help="Debug level for stdout output")

2983

2000

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

2990

2007

" files")

2991

2008

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

2992

2009

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

2993

" system bus interface", default=None)

2010

" system bus interface")

2994

2011

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

2995

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

2996

default=None)

2012

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

2997

2013

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

2998

2014

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

2999

" state", default=None)

3000

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

3001

help="Specify a file descriptor to a network"

3002

" socket to use instead of creating one")

2015

" state")

3003

2016

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

3004

2017

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

3005

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

3006

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

3007

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

3008

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

3009

default=None)

3010

2018

3011

2019

options = parser.parse_args()

3012

2020

2021

if options.check:

2022

import doctest

2023

doctest.testmod()

2024

sys.exit()

2025

3013

2026

# Default values for config file for server-global settings

3014

if gnutls.has_rawpk:

3015

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

3016

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

3017

else:

3018

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

3019

":+SIGN-DSA-SHA256")

3020

server_defaults = {"interface": "",

3021

"address": "",

3022

"port": "",

3023

"debug": "False",

3024

"priority": priority,

3025

"servicename": "Mandos",

3026

"use_dbus": "True",

3027

"use_ipv6": "True",

3028

"debuglevel": "",

3029

"restore": "True",

3030

"socket": "",

3031

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

3032

"foreground": "False",

3033

"zeroconf": "True",

3034

}

3035

del priority

3036

2027

server_defaults = { "interface": "",

2028

"address": "",

2029

"port": "",

2030

"debug": "False",

2031

"priority":

2032

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

2033

"servicename": "Mandos",

2034

"use_dbus": "True",

2035

"use_ipv6": "True",

2036

"debuglevel": "",

2037

"restore": "True",

2038

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

2039

}

2040

3037

2041

# Parse config file for server-global settings

3038

server_config = configparser.ConfigParser(server_defaults)

2042

server_config = configparser.SafeConfigParser(server_defaults)

3039

2043

del server_defaults

3040

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

3041

# Convert the ConfigParser object to a dict

2044

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

2045

"mandos.conf"))

2046

# Convert the SafeConfigParser object to a dict

3042

2047

server_settings = server_config.defaults()

3043

2048

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

3044

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

3045

"foreground", "zeroconf"):

2049

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

3046

2050

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

3047

2051

option)

3048

2052

if server_settings["port"]:

3049

2053

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

3050

2054

"port")

3051

if server_settings["socket"]:

3052

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

3053

"socket")

3054

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

3055

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

3056

# happen with a supplied network socket.

3057

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

3058

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

3059

["socket"])

3060

2055

del server_config

3061

2056

3062

2057

# Override the settings from the config file with command line

3063

2058

# options, if set.

3064

2059

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

3065

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

3066

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

3067

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

2060

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

2061

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

2062

"statedir"):

3068

2063

value = getattr(options, option)

3069

2064

if value is not None:

3070

2065

server_settings[option] = value

3071

2066

del options

3072

2067

# Force all strings to be unicode

3073

2068

for option in server_settings.keys():

3074

if isinstance(server_settings[option], bytes):

3075

server_settings[option] = (server_settings[option]

3076

.decode("utf-8"))

3077

# Force all boolean options to be boolean

3078

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

3079

"foreground", "zeroconf"):

3080

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

3081

# Debug implies foreground

3082

if server_settings["debug"]:

3083

server_settings["foreground"] = True

2069

if type(server_settings[option]) is str:

2070

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

3084

2071

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

3085

2072

3086

2073

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

3087

3088

if (not server_settings["zeroconf"]

3089

and not (server_settings["port"]

3090

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

3091

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

3092

2074

3093

2075

# For convenience

3094

2076

debug = server_settings["debug"]

3095

2077

debuglevel = server_settings["debuglevel"]

3097

2079

use_ipv6 = server_settings["use_ipv6"]

3098

2080

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

3099

2081

stored_state_file)

3100

foreground = server_settings["foreground"]

3101

zeroconf = server_settings["zeroconf"]

3102

2082

3103

2083

if debug:

3104

2084

initlogger(debug, logging.DEBUG)

3105

2085

else:

3108

2088

else:

3109

2089

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

3110

2090

initlogger(debug, level)

3111

2091

3112

2092

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

3113

syslogger.setFormatter(

3114

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

3115

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

3116

server_settings["servicename"])))

3117

2093

syslogger.setFormatter(logging.Formatter

2094

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

2095

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

2096

% server_settings["servicename"]))

2097

3118

2098

# Parse config file with clients

3119

client_config = configparser.ConfigParser(Client.client_defaults)

2099

client_config = configparser.SafeConfigParser(Client

2100

.client_defaults)

3120

2101

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

3121

2102

"clients.conf"))

3122

2103

3123

2104

global mandos_dbus_service

3124

2105

mandos_dbus_service = None

3125

3126

socketfd = None

3127

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

3128

socketfd = server_settings["socket"]

3129

tcp_server = MandosServer(

3130

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

3131

ClientHandler,

3132

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

3133

use_ipv6=use_ipv6,

3134

gnutls_priority=server_settings["priority"],

3135

use_dbus=use_dbus,

3136

socketfd=socketfd)

3137

if not foreground:

3138

pidfilename = "/run/mandos.pid"

3139

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

3140

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

3141

pidfile = None

3142

try:

3143

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

3144

except IOError as e:

3145

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

3146

exc_info=e)

3147

3148

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

3149

("mandos", "mandos"),

3150

("nobody", "nogroup")):

3151

try:

3152

uid = pwd.getpwnam(name).pw_uid

3153

gid = pwd.getpwnam(group).pw_gid

3154

break

2106

2107

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

2108

server_settings["port"]),

2109

ClientHandler,

2110

interface=(server_settings["interface"]

2111

or None),

2112

use_ipv6=use_ipv6,

2113

gnutls_priority=

2114

server_settings["priority"],

2115

use_dbus=use_dbus)

2116

if not debug:

2117

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

2118

try:

2119

pidfile = open(pidfilename, "w")

2120

except IOError:

2121

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

2122

2123

try:

2124

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

2125

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

2126

except KeyError:

2127

try:

2128

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

2129

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

3155

2130

except KeyError:

3156

continue

3157

else:

3158

uid = 65534

3159

gid = 65534

2131

try:

2132

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

2133

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

2134

except KeyError:

2135

uid = 65534

2136

gid = 65534

3160

2137

try:

3161

2138

os.setgid(gid)

3162

2139

os.setuid(uid)

3163

if debug:

3164

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

3165

gid))

3166

2140

except OSError as error:

3167

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

3168

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

3169

if error.errno != errno.EPERM:

3170

raise

3171

2141

if error[0] != errno.EPERM:

2142

raise error

2143

3172

2144

if debug:

3173

2145

# Enable all possible GnuTLS debugging

3174

2146

3175

2147

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

3176

2148

# - GnuTLS manual

3177

gnutls.global_set_log_level(11)

3178

3179

@gnutls.log_func

2149

gnutls.library.functions.gnutls_global_set_log_level(11)

2150

2151

@gnutls.library.types.gnutls_log_func

3180

2152

def debug_gnutls(level, string):

3181

2153

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

3182

3183

gnutls.global_set_log_function(debug_gnutls)

3184

2154

2155

(gnutls.library.functions

2156

.gnutls_global_set_log_function(debug_gnutls))

2157

3185

2158

# Redirect stdin so all checkers get /dev/null

3186

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

2159

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

3187

2160

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

3188

2161

if null > 2:

3189

2162

os.close(null)

3190

2163

3191

2164

# Need to fork before connecting to D-Bus

3192

if not foreground:

2165

if not debug:

3193

2166

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

3194

2167

daemon()

3195

3196

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

3197

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

3198

# need to inform GLib that threads will be used.

3199

GLib.threads_init()

3200

2168

2169

gobject.threads_init()

2170

3201

2171

global main_loop

3202

2172

# From the Avahi example code

3203

DBusGMainLoop(set_as_default=True)

3204

main_loop = GLib.MainLoop()

2173

DBusGMainLoop(set_as_default=True )

2174

main_loop = gobject.MainLoop()

3205

2175

bus = dbus.SystemBus()

3206

2176

# End of Avahi example code

3207

2177

if use_dbus:

3208

2178

try:

3209

2179

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

3210

bus,

3211

do_not_queue=True)

3212

old_bus_name = dbus.service.BusName(

3213

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

3214

do_not_queue=True)

3215

except dbus.exceptions.DBusException as e:

3216

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

2180

bus, do_not_queue=True)

2181

old_bus_name = (dbus.service.BusName

2182

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

2183

do_not_queue=True))

2184

except dbus.exceptions.NameExistsException as e:

2185

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

3217

2186

use_dbus = False

3218

2187

server_settings["use_dbus"] = False

3219

2188

tcp_server.use_dbus = False

3220

if zeroconf:

3221

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3222

service = AvahiServiceToSyslog(

3223

name=server_settings["servicename"],

3224

servicetype="_mandos._tcp",

3225

protocol=protocol,

3226

bus=bus)

3227

if server_settings["interface"]:

3228

service.interface = if_nametoindex(

3229

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

3230

2189

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2190

service = AvahiServiceToSyslog(name =

2191

server_settings["servicename"],

2192

servicetype = "_mandos._tcp",

2193

protocol = protocol, bus = bus)

2194

if server_settings["interface"]:

2195

service.interface = (if_nametoindex

2196

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

2197

3231

2198

global multiprocessing_manager

3232

2199

multiprocessing_manager = multiprocessing.Manager()

3233

2200

3234

2201

client_class = Client

3235

2202

if use_dbus:

3236

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

3237

2203

client_class = functools.partial(ClientDBusTransitional,

2204

bus = bus)

2205

3238

2206

client_settings = Client.config_parser(client_config)

3239

2207

old_client_settings = {}

3240

2208

clients_data = {}

3241

3242

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

3243

global wnull

3244

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

3245

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

3246

# mode

3247

if debug or not foreground:

3248

wnull.close()

3249

2209

3250

2210

# Get client data and settings from last running state.

3251

2211

if server_settings["restore"]:

3252

2212

try:

3253

2213

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

3254

if sys.version_info.major == 2:

3255

clients_data, old_client_settings = pickle.load(

3256

stored_state)

3257

else:

3258

bytes_clients_data, bytes_old_client_settings = (

3259

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

3260

# Fix bytes to strings

3261

# clients_data

3262

# .keys()

3263

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

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_clients_data.items()}

3268

del bytes_clients_data

3269

for key in clients_data:

3270

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

3271

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

3272

for k, v in

3273

clients_data[key].items()}

3274

clients_data[key] = value

3275

# .client_structure

3276

value["client_structure"] = [

3277

(s.decode("utf-8")

3278

if isinstance(s, bytes)

3279

else s) for s in

3280

value["client_structure"]]

3281

# .name, .host, and .checker_command

3282

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

3283

if isinstance(value[k], bytes):

3284

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

3285

if "key_id" not in value:

3286

value["key_id"] = ""

3287

elif "fingerprint" not in value:

3288

value["fingerprint"] = ""

3289

# old_client_settings

3290

# .keys()

3291

old_client_settings = {

3292

(key.decode("utf-8")

3293

if isinstance(key, bytes)

3294

else key): value

3295

for key, value in

3296

bytes_old_client_settings.items()}

3297

del bytes_old_client_settings

3298

# .host and .checker_command

3299

for value in old_client_settings.values():

3300

for attribute in ("host", "checker_command"):

3301

if isinstance(value[attribute], bytes):

3302

value[attribute] = (value[attribute]

3303

.decode("utf-8"))

2214

clients_data, old_client_settings = (pickle.load

2215

(stored_state))

3304

2216

os.remove(stored_state_path)

3305

2217

except IOError as e:

3306

if e.errno == errno.ENOENT:

3307

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

3308

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

3309

else:

3310

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

3311

exc_info=e)

2218

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

2219

.format(e))

2220

if e.errno != errno.ENOENT:

3312

2221

raise

3313

2222

except EOFError as e:

3314

2223

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

3315

"EOFError:",

3316

exc_info=e)

3317

2224

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

2225

3318

2226

with PGPEngine() as pgp:

3319

for client_name, client in clients_data.items():

3320

# Skip removed clients

3321

if client_name not in client_settings:

3322

continue

3323

2227

for client_name, client in clients_data.iteritems():

3324

2228

# Decide which value to use after restoring saved state.

3325

2229

# We have three different values: Old config file,

3326

2230

# new config file, and saved state.

3331

2235

# For each value in new config, check if it

3332

2236

# differs from the old config value (Except for

3333

2237

# the "secret" attribute)

3334

if (name != "secret"

3335

and (value !=

3336

old_client_settings[client_name][name])):

2238

if (name != "secret" and

2239

value != old_client_settings[client_name]

2240

[name]):

3337

2241

client[name] = value

3338

2242

except KeyError:

3339

2243

pass

3340

2244

3341

2245

# Clients who has passed its expire date can still be

3342

# enabled if its last checker was successful. A Client

2246

# enabled if its last checker was successful. Clients

3343

2247

# whose checker succeeded before we stored its state is

3344

2248

# assumed to have successfully run all checkers during

3345

2249

# downtime.

3347

2251

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

3348

2252

if not client["last_checked_ok"]:

3349

2253

logger.warning(

3350

"disabling client {} - Client never "

3351

"performed a successful checker".format(

3352

client_name))

2254

"disabling client {0} - Client never "

2255

"performed a successful checker"

2256

.format(client_name))

3353

2257

client["enabled"] = False

3354

2258

elif client["last_checker_status"] != 0:

3355

2259

logger.warning(

3356

"disabling client {} - Client last"

3357

" checker failed with error code"

3358

" {}".format(

3359

client_name,

3360

client["last_checker_status"]))

2260

"disabling client {0} - Client "

2261

"last checker failed with error code {1}"

2262

.format(client_name,

2263

client["last_checker_status"]))

3361

2264

client["enabled"] = False

3362

2265

else:

3363

client["expires"] = (

3364

datetime.datetime.utcnow()

3365

+ client["timeout"])

2266

client["expires"] = (datetime.datetime

2267

.utcnow()

2268

+ client["timeout"])

3366

2269

logger.debug("Last checker succeeded,"

3367

" keeping {} enabled".format(

3368

client_name))

2270

" keeping {0} enabled"

2271

.format(client_name))

3369

2272

try:

3370

client["secret"] = pgp.decrypt(

3371

client["encrypted_secret"],

3372

client_settings[client_name]["secret"])

2273

client["secret"] = (

2274

pgp.decrypt(client["encrypted_secret"],

2275

client_settings[client_name]

2276

["secret"]))

3373

2277

except PGPError:

3374

2278

# If decryption fails, we use secret from new settings

3375

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

3376

client_name))

3377

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

3378

["secret"])

2279

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

2280

.format(client_name))

2281

client["secret"] = (

2282

client_settings[client_name]["secret"])

3379

2283

2284

3380

2285

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

3381

2286

for client_name in (set(old_client_settings)

3382

2287

- set(client_settings)):

3386

2291

clients_data[client_name] = client_settings[client_name]

3387

2292

3388

2293

# Create all client objects

3389

for client_name, client in clients_data.items():

2294

for client_name, client in clients_data.iteritems():

3390

2295

tcp_server.clients[client_name] = client_class(

3391

name=client_name,

3392

settings=client,

3393

server_settings=server_settings)

3394

2296

name = client_name, settings = client)

2297

3395

2298

if not tcp_server.clients:

3396

2299

logger.warning("No clients defined")

3397

3398

if not foreground:

3399

if pidfile is not None:

3400

pid = os.getpid()

3401

try:

3402

with pidfile:

3403

print(pid, file=pidfile)

3404

except IOError:

3405

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

3406

pidfilename, pid)

3407

del pidfile

2300

2301

if not debug:

2302

try:

2303

with pidfile:

2304

pid = os.getpid()

2305

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

2306

del pidfile

2307

except IOError:

2308

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

2309

pidfilename, pid)

2310

except NameError:

2311

# "pidfile" was never created

2312

pass

3408

2313

del pidfilename

3409

3410

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

3411

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3412

lambda: main_loop.quit() and False)

3413

2314

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

2315

2316

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

2317

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

2318

3414

2319

if use_dbus:

3415

3416

@alternate_dbus_interfaces(

3417

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

3418

class MandosDBusService(DBusObjectWithObjectManager):

2320

class MandosDBusService(dbus.service.Object):

3419

2321

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

3420

3421

2322

def __init__(self):

3422

2323

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

3423

3424

2324

_interface = "se.recompile.Mandos"

3425

2325

3426

2326

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

3427

2327

def ClientAdded(self, objpath):

3428

2328

"D-Bus signal"

3429

2329

pass

3430

2330

3431

2331

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

3432

def ClientNotFound(self, key_id, address):

2332

def ClientNotFound(self, fingerprint, address):

3433

2333

"D-Bus signal"

3434

2334

pass

3435

3436

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

3437

"true"})

2335

3438

2336

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

3439

2337

def ClientRemoved(self, objpath, name):

3440

2338

"D-Bus signal"

3441

2339

pass

3442

3443

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

3444

"true"})

2340

3445

2341

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

3446

2342

def GetAllClients(self):

3447

2343

"D-Bus method"

3448

return dbus.Array(c.dbus_object_path for c in

3449

tcp_server.clients.values())

3450

3451

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

3452

"true"})

2344

return dbus.Array(c.dbus_object_path

2345

for c in

2346

tcp_server.clients.itervalues())

2347

3453

2348

@dbus.service.method(_interface,

3454

2349

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

3455

2350

def GetAllClientsWithProperties(self):

3456

2351

"D-Bus method"

3457

2352

return dbus.Dictionary(

3458

{c.dbus_object_path: c.GetAll(

3459

"se.recompile.Mandos.Client")

3460

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

2353

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

2354

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

3461

2355

signature="oa{sv}")

3462

2356

3463

2357

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

3464

2358

def RemoveClient(self, object_path):

3465

2359

"D-Bus method"

3466

for c in tcp_server.clients.values():

2360

for c in tcp_server.clients.itervalues():

3467

2361

if c.dbus_object_path == object_path:

3468

2362

del tcp_server.clients[c.name]

3469

2363

c.remove_from_connection()

3470

# Don't signal the disabling

2364

# Don't signal anything except ClientRemoved

3471

2365

c.disable(quiet=True)

3472

# Emit D-Bus signal for removal

3473

self.client_removed_signal(c)

2366

# Emit D-Bus signal

2367

self.ClientRemoved(object_path, c.name)

3474

2368

return

3475

2369

raise KeyError(object_path)

3476

2370

3477

2371

del _interface

3478

3479

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3480

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

3481

def GetManagedObjects(self):

3482

"""D-Bus method"""

3483

return dbus.Dictionary(

3484

{client.dbus_object_path:

3485

dbus.Dictionary(

3486

{interface: client.GetAll(interface)

3487

for interface in

3488

client._get_all_interface_names()})

3489

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

3490

3491

def client_added_signal(self, client):

3492

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

3493

if use_dbus:

3494

# New standard signal

3495

self.InterfacesAdded(

3496

client.dbus_object_path,

3497

dbus.Dictionary(

3498

{interface: client.GetAll(interface)

3499

for interface in

3500

client._get_all_interface_names()}))

3501

# Old signal

3502

self.ClientAdded(client.dbus_object_path)

3503

3504

def client_removed_signal(self, client):

3505

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

3506

if use_dbus:

3507

# New standard signal

3508

self.InterfacesRemoved(

3509

client.dbus_object_path,

3510

client._get_all_interface_names())

3511

# Old signal

3512

self.ClientRemoved(client.dbus_object_path,

3513

client.name)

3514

3515

mandos_dbus_service = MandosDBusService()

3516

3517

# Save modules to variables to exempt the modules from being

3518

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

3519

mp = multiprocessing

3520

wn = wnull

3521

2372

2373

class MandosDBusServiceTransitional(MandosDBusService):

2374

__metaclass__ = AlternateDBusNamesMetaclass

2375

mandos_dbus_service = MandosDBusServiceTransitional()

2376

3522

2377

def cleanup():

3523

2378

"Cleanup function; run on exit"

3524

if zeroconf:

3525

service.cleanup()

3526

3527

mp.active_children()

3528

wn.close()

2379

service.cleanup()

2380

2381

multiprocessing.active_children()

3529

2382

if not (tcp_server.clients or client_settings):

3530

2383

return

3531

2384

3532

2385

# Store client before exiting. Secrets are encrypted with key

3533

2386

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

3534

2387

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

3535

2388

clients = {}

3536

2389

with PGPEngine() as pgp:

3537

for client in tcp_server.clients.values():

2390

for client in tcp_server.clients.itervalues():

3538

2391

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

3539

2392

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

3540

2393

key)

3541

2394

client_dict = {}

3542

2395

3543

2396

# A list of attributes that can not be pickled

3544

2397

# + secret.

3545

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

3546

"checker", "server_settings"}

3547

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

3548

.Object):

2398

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

2399

"checker"))

2400

for name, typ in (inspect.getmembers

2401

(dbus.service.Object)):

3549

2402

exclude.add(name)

3550

2403

3551

2404

client_dict["encrypted_secret"] = (client

3552

2405

.encrypted_secret)

3553

2406

for attr in client.client_structure:

3554

2407

if attr not in exclude:

3555

2408

client_dict[attr] = getattr(client, attr)

3556

2409

3557

2410

clients[client.name] = client_dict

3558

2411

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

3559

2412

3560

2413

try:

3561

with tempfile.NamedTemporaryFile(

3562

mode='wb',

3563

suffix=".pickle",

3564

prefix='clients-',

3565

dir=os.path.dirname(stored_state_path),

3566

delete=False) as stored_state:

3567

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

3568

protocol=2)

3569

tempname = stored_state.name

2414

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

2415

prefix="clients-",

2416

dir=os.path.dirname

2417

(stored_state_path))

2418

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

2419

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

3570

2420

os.rename(tempname, stored_state_path)

3571

2421

except (IOError, OSError) as e:

2422

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

2423

.format(e))

3572

2424

if not debug:

3573

2425

try:

3574

2426

os.remove(tempname)

3575

2427

except NameError:

3576

2428

pass

3577

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

3578

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

3579

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

3580

else:

3581

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

3582

exc_info=e)

3583

raise

3584

2429

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

2430

errno.EEXIST)):

2431

raise e

2432

3585

2433

# Delete all clients, and settings from config

3586

2434

while tcp_server.clients:

3587

2435

name, client = tcp_server.clients.popitem()

3588

2436

if use_dbus:

3589

2437

client.remove_from_connection()

3590

# Don't signal the disabling

2438

# Don't signal anything except ClientRemoved

3591

2439

client.disable(quiet=True)

3592

# Emit D-Bus signal for removal

3593

2440

if use_dbus:

3594

mandos_dbus_service.client_removed_signal(client)

2441

# Emit D-Bus signal

2442

mandos_dbus_service.ClientRemoved(client

2443

.dbus_object_path,

2444

client.name)

3595

2445

client_settings.clear()

3596

2446

3597

2447

atexit.register(cleanup)

3598

3599

for client in tcp_server.clients.values():

2448

2449

for client in tcp_server.clients.itervalues():

3600

2450

if use_dbus:

3601

# Emit D-Bus signal for adding

3602

mandos_dbus_service.client_added_signal(client)

2451

# Emit D-Bus signal

2452

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3603

2453

# Need to initiate checking of clients

3604

2454

if client.enabled:

3605

2455

client.init_checker()

3606

2456

3607

2457

tcp_server.enable()

3608

2458

tcp_server.server_activate()

3609

2459

3610

2460

# Find out what port we got

3611

if zeroconf:

3612

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

2461

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

3613

2462

if use_ipv6:

3614

2463

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

3615

" flowinfo %d, scope_id %d",

3616

*tcp_server.socket.getsockname())

2464

" flowinfo %d, scope_id %d"

2465

% tcp_server.socket.getsockname())

3617

2466

else: # IPv4

3618

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

3619

*tcp_server.socket.getsockname())

3620

3621

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

3622

2467

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

2468

% tcp_server.socket.getsockname())

2469

2470

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

2471

3623

2472

try:

3624

if zeroconf:

3625

# From the Avahi example code

3626

try:

3627

service.activate()

3628

except dbus.exceptions.DBusException as error:

3629

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

3630

cleanup()

3631

sys.exit(1)

3632

# End of Avahi example code

3633

3634

GLib.io_add_watch(

3635

GLib.IOChannel.unix_new(tcp_server.fileno()),

3636

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3637

lambda *args, **kwargs: (tcp_server.handle_request

3638

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

3639

2473

# From the Avahi example code

2474

try:

2475

service.activate()

2476

except dbus.exceptions.DBusException as error:

2477

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

2478

cleanup()

2479

sys.exit(1)

2480

# End of Avahi example code

2481

2482

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

2483

lambda *args, **kwargs:

2484

(tcp_server.handle_request

2485

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

2486

3640

2487

logger.debug("Starting main loop")

3641

2488

main_loop.run()

3642

2489

except AvahiError as error:

3643

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

2490

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

3644

2491

cleanup()

3645

2492

sys.exit(1)

3646

2493

except KeyboardInterrupt:

3651

2498

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

3652

2499

cleanup()

3653

2500

3654

3655

def should_only_run_tests():

3656

parser = argparse.ArgumentParser(add_help=False)

3657

parser.add_argument("--check", action='store_true')

3658

args, unknown_args = parser.parse_known_args()

3659

run_tests = args.check

3660

if run_tests:

3661

# Remove --check argument from sys.argv

3662

sys.argv[1:] = unknown_args

3663

return run_tests

3664

3665

# Add all tests from doctest strings

3666

def load_tests(loader, tests, none):

3667

import doctest

3668

tests.addTests(doctest.DocTestSuite())

3669

return tests

3670

3671

2501

if __name__ == '__main__':

3672

try:

3673

if should_only_run_tests():

3674

# Call using ./mandos --check [--verbose]

3675

unittest.main()

3676

else:

3677

main()

3678

finally:

3679

logging.shutdown()

2502

main()