/mandos/trunk : revision 561

1

#!/usr/bin/python3 -b

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

68

import itertools

78

import collections

79

import codecs

80

import unittest

81

69

82

70

import dbus

83

71

import dbus.service

84

import gi

85

from gi.repository import GLib

72

import gobject

73

import avahi

86

74

from dbus.mainloop.glib import DBusGMainLoop

87

75

import ctypes

88

76

import ctypes.util

89

77

import xml.dom.minidom

90

78

import inspect

91

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

95

# Show warnings by default

96

if not sys.warnoptions:

97

import warnings

98

warnings.simplefilter("default")

99

100

# Try to find the value of SO_BINDTODEVICE:

79

import GnuPGInterface

80

101

81

try:

102

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

103

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

104

82

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

105

83

except AttributeError:

106

84

try:

107

# This is where SO_BINDTODEVICE was up to and including Python

108

# 2.6, and also 3.2:

109

85

from IN import SO_BINDTODEVICE

110

86

except ImportError:

111

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

112

# Try running the C preprocessor:

113

try:

114

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

115

"/dev/stdin"],

116

stdin=subprocess.PIPE,

117

stdout=subprocess.PIPE)

118

stdout = cc.communicate(

119

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

120

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

121

except (OSError, ValueError, IndexError):

122

# No value found

123

SO_BINDTODEVICE = None

124

125

if sys.version_info.major == 2:

126

str = unicode

127

128

if sys.version_info < (3, 2):

129

configparser.Configparser = configparser.SafeConfigParser

130

131

version = "1.8.8"

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

132

90

stored_state_file = "clients.pickle"

133

91

134

92

logger = logging.getLogger()

135

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

136

syslogger = None

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

137

96

138

97

try:

139

if_nametoindex = ctypes.cdll.LoadLibrary(

140

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

141

101

except (OSError, AttributeError):

142

143

102

def if_nametoindex(interface):

144

103

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

145

104

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

146

105

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

147

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

148

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

149

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

150

111

return interface_index

151

112

152

113

153

def copy_function(func):

154

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

155

if sys.version_info.major == 2:

156

return types.FunctionType(func.func_code,

157

func.func_globals,

158

func.func_name,

159

func.func_defaults,

160

func.func_closure)

161

else:

162

return types.FunctionType(func.__code__,

163

func.__globals__,

164

func.__name__,

165

func.__defaults__,

166

func.__closure__)

167

168

169

114

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

170

115

"""init logger and add loglevel"""

171

172

global syslogger

173

syslogger = (logging.handlers.SysLogHandler(

174

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

175

address="/dev/log"))

116

176

117

syslogger.setFormatter(logging.Formatter

177

118

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

178

119

' %(message)s'))

179

120

logger.addHandler(syslogger)

180

121

181

122

if debug:

182

123

console = logging.StreamHandler()

183

124

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

193

134

pass

194

135

195

136

196

class PGPEngine:

137

class PGPEngine(object):

197

138

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

198

199

139

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

200

141

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

201

self.gpg = "gpg"

202

try:

203

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

204

for line in output.splitlines():

205

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

206

if name == b"gpg":

207

self.gpg = path

208

break

209

except OSError as e:

210

if e.errno != errno.ENOENT:

211

raise

212

self.gnupgargs = ['--batch',

213

'--homedir', self.tempdir,

214

'--force-mdc',

215

'--quiet']

216

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

217

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

218

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

219

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

220

149

def __enter__(self):

221

150

return self

222

223

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

151

152

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

224

153

self._cleanup()

225

154

return False

226

155

227

156

def __del__(self):

228

157

self._cleanup()

229

158

230

159

def _cleanup(self):

231

160

if self.tempdir is not None:

232

161

# Delete contents of tempdir

233

162

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

234

topdown=False):

163

topdown = False):

235

164

for filename in files:

236

165

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

237

166

for dirname in dirs:

239

168

# Remove tempdir

240

169

os.rmdir(self.tempdir)

241

170

self.tempdir = None

242

171

243

172

def password_encode(self, password):

244

173

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

245

174

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

246

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

247

if len(encoded) > 2048:

248

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

249

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

250

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

251

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

252

return encoded

253

175

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

176

254

177

def encrypt(self, data, password):

255

passphrase = self.password_encode(password)

256

with tempfile.NamedTemporaryFile(

257

dir=self.tempdir) as passfile:

258

passfile.write(passphrase)

259

passfile.flush()

260

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

261

'--passphrase-file',

262

passfile.name]

263

+ self.gnupgargs,

264

stdin=subprocess.PIPE,

265

stdout=subprocess.PIPE,

266

stderr=subprocess.PIPE)

267

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

268

if proc.returncode != 0:

269

raise PGPError(err)

178

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

179

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

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

270

192

return ciphertext

271

193

272

194

def decrypt(self, data, password):

273

passphrase = self.password_encode(password)

274

with tempfile.NamedTemporaryFile(

275

dir=self.tempdir) as passfile:

276

passfile.write(passphrase)

277

passfile.flush()

278

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

279

'--passphrase-file',

280

passfile.name]

281

+ self.gnupgargs,

282

stdin=subprocess.PIPE,

283

stdout=subprocess.PIPE,

284

stderr=subprocess.PIPE)

285

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

286

if proc.returncode != 0:

287

raise PGPError(err)

195

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

196

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

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

288

209

return decrypted_plaintext

289

210

290

211

291

# Pretend that we have an Avahi module

292

class avahi:

293

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

294

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

295

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

296

PROTO_INET = 0 # avahi-common/address.h

297

PROTO_INET6 = 1 # avahi-common/address.h

298

DBUS_NAME = "org.freedesktop.Avahi"

299

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

300

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

301

DBUS_PATH_SERVER = "/"

302

303

@staticmethod

304

def string_array_to_txt_array(t):

305

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

306

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

307

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

308

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

309

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

310

SERVER_INVALID = 0 # avahi-common/defs.h

311

SERVER_REGISTERING = 1 # avahi-common/defs.h

312

SERVER_RUNNING = 2 # avahi-common/defs.h

313

SERVER_COLLISION = 3 # avahi-common/defs.h

314

SERVER_FAILURE = 4 # avahi-common/defs.h

315

316

212

317

213

class AvahiError(Exception):

318

214

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

319

215

self.value = value

320

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

321

**kwargs)

322

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

323

219

324

220

class AvahiServiceError(AvahiError):

325

221

pass

326

222

327

328

223

class AvahiGroupError(AvahiError):

329

224

pass

330

225

331

226

332

class AvahiService:

227

class AvahiService(object):

333

228

"""An Avahi (Zeroconf) service.

334

229

335

230

Attributes:

336

231

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

337

232

Used to optionally bind to the specified interface.

338

233

name: string; Example: 'Mandos'

339

234

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

340

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

235

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

341

236

port: integer; what port to announce

342

237

TXT: list of strings; TXT record for the service

343

238

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

349

244

server: D-Bus Server

350

245

bus: dbus.SystemBus()

351

246

"""

352

353

def __init__(self,

354

interface=avahi.IF_UNSPEC,

355

name=None,

356

servicetype=None,

357

port=None,

358

TXT=None,

359

domain="",

360

host="",

361

max_renames=32768,

362

protocol=avahi.PROTO_UNSPEC,

363

bus=None):

247

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

248

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

249

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

250

protocol = avahi.PROTO_UNSPEC, bus = None):

364

251

self.interface = interface

365

252

self.name = name

366

253

self.type = servicetype

375

262

self.server = None

376

263

self.bus = bus

377

264

self.entry_group_state_changed_match = None

378

379

def rename(self, remove=True):

265

def rename(self):

380

266

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

381

267

if self.rename_count >= self.max_renames:

382

268

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

383

269

" after %i retries, exiting.",

384

270

self.rename_count)

385

271

raise AvahiServiceError("Too many renames")

386

self.name = str(

387

self.server.GetAlternativeServiceName(self.name))

388

self.rename_count += 1

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

389

274

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

390

275

self.name)

391

if remove:

392

self.remove()

276

self.remove()

393

277

try:

394

278

self.add()

395

279

except dbus.exceptions.DBusException as error:

396

if (error.get_dbus_name()

397

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

398

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

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

404

280

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

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

405

284

def remove(self):

406

285

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

407

286

if self.entry_group_state_changed_match is not None:

409

288

self.entry_group_state_changed_match = None

410

289

if self.group is not None:

411

290

self.group.Reset()

412

413

291

def add(self):

414

292

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

415

293

self.remove()

432

310

dbus.UInt16(self.port),

433

311

avahi.string_array_to_txt_array(self.TXT))

434

312

self.group.Commit()

435

436

313

def entry_group_state_changed(self, state, error):

437

314

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

438

315

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

439

316

440

317

if state == avahi.ENTRY_GROUP_ESTABLISHED:

441

318

logger.debug("Zeroconf service established.")

442

319

elif state == avahi.ENTRY_GROUP_COLLISION:

444

321

self.rename()

445

322

elif state == avahi.ENTRY_GROUP_FAILURE:

446

323

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

447

str(error))

448

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

449

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

450

327

def cleanup(self):

451

328

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

452

329

if self.group is not None:

457

334

pass

458

335

self.group = None

459

336

self.remove()

460

461

337

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

462

338

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

463

339

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

464

bad_states = {

465

avahi.SERVER_INVALID: "Zeroconf server invalid",

466

avahi.SERVER_REGISTERING: None,

467

avahi.SERVER_COLLISION: "Zeroconf server name collision",

468

avahi.SERVER_FAILURE: "Zeroconf server failure",

469

}

340

bad_states = { avahi.SERVER_INVALID:

341

"Zeroconf server invalid",

342

avahi.SERVER_REGISTERING: None,

343

avahi.SERVER_COLLISION:

344

"Zeroconf server name collision",

345

avahi.SERVER_FAILURE:

346

"Zeroconf server failure" }

470

347

if state in bad_states:

471

348

if bad_states[state] is not None:

472

349

if error is None:

475

352

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

476

353

self.cleanup()

477

354

elif state == avahi.SERVER_RUNNING:

478

try:

479

self.add()

480

except dbus.exceptions.DBusException as error:

481

if (error.get_dbus_name()

482

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

483

logger.info("Local Zeroconf service name"

484

" collision.")

485

return self.rename(remove=False)

486

else:

487

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

488

self.cleanup()

489

os._exit(1)

355

self.add()

490

356

else:

491

357

if error is None:

492

358

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

493

359

else:

494

360

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

495

496

361

def activate(self):

497

362

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

498

363

if self.server is None:

502

367

follow_name_owner_changes=True),

503

368

avahi.DBUS_INTERFACE_SERVER)

504

369

self.server.connect_to_signal("StateChanged",

505

self.server_state_changed)

370

self.server_state_changed)

506

371

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

507

372

508

509

373

class AvahiServiceToSyslog(AvahiService):

510

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

374

def rename(self):

511

375

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

512

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

513

syslogger.setFormatter(logging.Formatter(

514

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

515

.format(self.name)))

376

ret = AvahiService.rename(self)

377

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

% self.name))

516

381

return ret

517

382

518

519

# Pretend that we have a GnuTLS module

520

class gnutls:

521

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

522

523

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

524

if library is None:

525

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

526

_library = ctypes.cdll.LoadLibrary(library)

527

del library

528

529

# Unless otherwise indicated, the constants and types below are

530

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

531

532

# Constants

533

E_SUCCESS = 0

534

E_INTERRUPTED = -52

535

E_AGAIN = -28

536

CRT_OPENPGP = 2

537

CRT_RAWPK = 3

538

CLIENT = 2

539

SHUT_RDWR = 0

540

CRD_CERTIFICATE = 1

541

E_NO_CERTIFICATE_FOUND = -49

542

X509_FMT_DER = 0

543

NO_TICKETS = 1<<10

544

ENABLE_RAWPK = 1<<18

545

CTYPE_PEERS = 3

546

KEYID_USE_SHA256 = 1 # gnutls/x509.h

547

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

548

549

# Types

550

class session_int(ctypes.Structure):

551

_fields_ = []

552

session_t = ctypes.POINTER(session_int)

553

554

class certificate_credentials_st(ctypes.Structure):

555

_fields_ = []

556

certificate_credentials_t = ctypes.POINTER(

557

certificate_credentials_st)

558

certificate_type_t = ctypes.c_int

559

560

class datum_t(ctypes.Structure):

561

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

562

('size', ctypes.c_uint)]

563

564

class openpgp_crt_int(ctypes.Structure):

565

_fields_ = []

566

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

567

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

568

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

569

credentials_type_t = ctypes.c_int

570

transport_ptr_t = ctypes.c_void_p

571

close_request_t = ctypes.c_int

572

573

# Exceptions

574

class Error(Exception):

575

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

576

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

577

# code is passed, convert it to a string with

578

# gnutls.strerror()

579

self.code = code

580

if message is None and code is not None:

581

message = gnutls.strerror(code)

582

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

583

message, *args)

584

585

class CertificateSecurityError(Error):

586

pass

587

588

# Classes

589

class Credentials:

590

def __init__(self):

591

self._c_object = gnutls.certificate_credentials_t()

592

gnutls.certificate_allocate_credentials(

593

ctypes.byref(self._c_object))

594

self.type = gnutls.CRD_CERTIFICATE

595

596

def __del__(self):

597

gnutls.certificate_free_credentials(self._c_object)

598

599

class ClientSession:

600

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

601

self._c_object = gnutls.session_t()

602

gnutls_flags = gnutls.CLIENT

603

if gnutls.check_version(b"3.5.6"):

604

gnutls_flags |= gnutls.NO_TICKETS

605

if gnutls.has_rawpk:

606

gnutls_flags |= gnutls.ENABLE_RAWPK

607

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

608

del gnutls_flags

609

gnutls.set_default_priority(self._c_object)

610

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

611

gnutls.handshake_set_private_extensions(self._c_object,

612

True)

613

self.socket = socket

614

if credentials is None:

615

credentials = gnutls.Credentials()

616

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

617

ctypes.cast(credentials._c_object,

618

ctypes.c_void_p))

619

self.credentials = credentials

620

621

def __del__(self):

622

gnutls.deinit(self._c_object)

623

624

def handshake(self):

625

return gnutls.handshake(self._c_object)

626

627

def send(self, data):

628

data = bytes(data)

629

data_len = len(data)

630

while data_len > 0:

631

data_len -= gnutls.record_send(self._c_object,

632

data[-data_len:],

633

data_len)

634

635

def bye(self):

636

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

637

638

# Error handling functions

639

def _error_code(result):

640

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

641

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

642

if result >= 0:

643

return result

644

if result == gnutls.E_NO_CERTIFICATE_FOUND:

645

raise gnutls.CertificateSecurityError(code=result)

646

raise gnutls.Error(code=result)

647

648

def _retry_on_error(result, func, arguments):

649

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

650

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

651

while result < 0:

652

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

653

return _error_code(result)

654

result = func(*arguments)

655

return result

656

657

# Unless otherwise indicated, the function declarations below are

658

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

659

660

# Functions

661

priority_set_direct = _library.gnutls_priority_set_direct

662

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

663

ctypes.POINTER(ctypes.c_char_p)]

664

priority_set_direct.restype = _error_code

665

666

init = _library.gnutls_init

667

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

668

init.restype = _error_code

669

670

set_default_priority = _library.gnutls_set_default_priority

671

set_default_priority.argtypes = [session_t]

672

set_default_priority.restype = _error_code

673

674

record_send = _library.gnutls_record_send

675

record_send.argtypes = [session_t, ctypes.c_void_p,

676

ctypes.c_size_t]

677

record_send.restype = ctypes.c_ssize_t

678

record_send.errcheck = _retry_on_error

679

680

certificate_allocate_credentials = (

681

_library.gnutls_certificate_allocate_credentials)

682

certificate_allocate_credentials.argtypes = [

683

ctypes.POINTER(certificate_credentials_t)]

684

certificate_allocate_credentials.restype = _error_code

685

686

certificate_free_credentials = (

687

_library.gnutls_certificate_free_credentials)

688

certificate_free_credentials.argtypes = [

689

certificate_credentials_t]

690

certificate_free_credentials.restype = None

691

692

handshake_set_private_extensions = (

693

_library.gnutls_handshake_set_private_extensions)

694

handshake_set_private_extensions.argtypes = [session_t,

695

ctypes.c_int]

696

handshake_set_private_extensions.restype = None

697

698

credentials_set = _library.gnutls_credentials_set

699

credentials_set.argtypes = [session_t, credentials_type_t,

700

ctypes.c_void_p]

701

credentials_set.restype = _error_code

702

703

strerror = _library.gnutls_strerror

704

strerror.argtypes = [ctypes.c_int]

705

strerror.restype = ctypes.c_char_p

706

707

certificate_type_get = _library.gnutls_certificate_type_get

708

certificate_type_get.argtypes = [session_t]

709

certificate_type_get.restype = _error_code

710

711

certificate_get_peers = _library.gnutls_certificate_get_peers

712

certificate_get_peers.argtypes = [session_t,

713

ctypes.POINTER(ctypes.c_uint)]

714

certificate_get_peers.restype = ctypes.POINTER(datum_t)

715

716

global_set_log_level = _library.gnutls_global_set_log_level

717

global_set_log_level.argtypes = [ctypes.c_int]

718

global_set_log_level.restype = None

719

720

global_set_log_function = _library.gnutls_global_set_log_function

721

global_set_log_function.argtypes = [log_func]

722

global_set_log_function.restype = None

723

724

deinit = _library.gnutls_deinit

725

deinit.argtypes = [session_t]

726

deinit.restype = None

727

728

handshake = _library.gnutls_handshake

729

handshake.argtypes = [session_t]

730

handshake.restype = _error_code

731

handshake.errcheck = _retry_on_error

732

733

transport_set_ptr = _library.gnutls_transport_set_ptr

734

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

735

transport_set_ptr.restype = None

736

737

bye = _library.gnutls_bye

738

bye.argtypes = [session_t, close_request_t]

739

bye.restype = _error_code

740

bye.errcheck = _retry_on_error

741

742

check_version = _library.gnutls_check_version

743

check_version.argtypes = [ctypes.c_char_p]

744

check_version.restype = ctypes.c_char_p

745

746

_need_version = b"3.3.0"

747

if check_version(_need_version) is None:

748

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

749

.format(_need_version))

750

751

_tls_rawpk_version = b"3.6.6"

752

has_rawpk = bool(check_version(_tls_rawpk_version))

753

754

if has_rawpk:

755

# Types

756

class pubkey_st(ctypes.Structure):

757

_fields = []

758

pubkey_t = ctypes.POINTER(pubkey_st)

759

760

x509_crt_fmt_t = ctypes.c_int

761

762

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

763

pubkey_init = _library.gnutls_pubkey_init

764

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

765

pubkey_init.restype = _error_code

766

767

pubkey_import = _library.gnutls_pubkey_import

768

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

769

x509_crt_fmt_t]

770

pubkey_import.restype = _error_code

771

772

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

773

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

774

ctypes.POINTER(ctypes.c_ubyte),

775

ctypes.POINTER(ctypes.c_size_t)]

776

pubkey_get_key_id.restype = _error_code

777

778

pubkey_deinit = _library.gnutls_pubkey_deinit

779

pubkey_deinit.argtypes = [pubkey_t]

780

pubkey_deinit.restype = None

781

else:

782

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

783

784

openpgp_crt_init = _library.gnutls_openpgp_crt_init

785

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

786

openpgp_crt_init.restype = _error_code

787

788

openpgp_crt_import = _library.gnutls_openpgp_crt_import

789

openpgp_crt_import.argtypes = [openpgp_crt_t,

790

ctypes.POINTER(datum_t),

791

openpgp_crt_fmt_t]

792

openpgp_crt_import.restype = _error_code

793

794

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

795

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

796

ctypes.POINTER(ctypes.c_uint)]

797

openpgp_crt_verify_self.restype = _error_code

798

799

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

800

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

801

openpgp_crt_deinit.restype = None

802

803

openpgp_crt_get_fingerprint = (

804

_library.gnutls_openpgp_crt_get_fingerprint)

805

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

806

ctypes.c_void_p,

807

ctypes.POINTER(

808

ctypes.c_size_t)]

809

openpgp_crt_get_fingerprint.restype = _error_code

810

811

if check_version(b"3.6.4"):

812

certificate_type_get2 = _library.gnutls_certificate_type_get2

813

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

814

certificate_type_get2.restype = _error_code

815

816

# Remove non-public functions

817

del _error_code, _retry_on_error

818

819

820

def call_pipe(connection, # : multiprocessing.Connection

821

func, *args, **kwargs):

822

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

823

824

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

825

return value on the provided multiprocessing.Connection.

826

"""

827

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

828

connection.close()

829

830

831

class Client:

383

def timedelta_to_milliseconds(td):

384

"Convert a datetime.timedelta() to milliseconds"

385

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

386

+ (td.seconds * 1000)

387

+ (td.microseconds // 1000))

388

389

class Client(object):

832

390

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

833

391

834

392

Attributes:

835

393

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

836

394

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

837

395

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

838

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

839

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

840

running.

841

checker_callback_tag: a GLib event source tag, or None

396

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

397

to see if the client lives.

398

'None' if no process is running.

399

checker_callback_tag: a gobject event source tag, or None

842

400

checker_command: string; External command which is run to check

843

401

if client lives. %() expansions are done at

844

402

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

845

403

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

846

checker_initiator_tag: a GLib event source tag, or None

404

checker_initiator_tag: a gobject event source tag, or None

847

405

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

848

406

client_structure: Object describing what attributes a client has

849

407

and is used for storing the client at exit

850

408

current_checker_command: string; current running checker_command

851

disable_initiator_tag: a GLib event source tag, or None

409

disable_initiator_tag: a gobject event source tag, or None

852

410

enabled: bool()

853

411

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

854

uniquely identify an OpenPGP client

855

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

856

a client using raw public keys

412

uniquely identify the client

857

413

host: string; available for use by the checker command

858

414

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

859

415

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

861

417

last_checker_status: integer between 0 and 255 reflecting exit

862

418

status of last checker. -1 reflects crashed

863

419

checker, -2 means no checker completed yet.

864

last_checker_signal: The signal which killed the last checker, if

865

last_checker_status is -1

866

420

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

867

421

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

868

422

D-Bus identifiers

873

427

runtime_expansions: Allowed attributes for runtime expansion.

874

428

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

875

429

disabled, or None

876

server_settings: The server_settings dict from main()

877

430

"""

878

431

879

432

runtime_expansions = ("approval_delay", "approval_duration",

880

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

881

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

882

"last_approval_request", "last_checked_ok",

433

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

434

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

883

435

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

884

client_defaults = {

885

"timeout": "PT5M",

886

"extended_timeout": "PT15M",

887

"interval": "PT2M",

888

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

889

"host": "",

890

"approval_delay": "PT0S",

891

"approval_duration": "PT1S",

892

"approved_by_default": "True",

893

"enabled": "True",

894

}

436

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

437

"extended_timeout": "15m",

438

"interval": "2m",

439

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

440

"host": "",

441

"approval_delay": "0s",

442

"approval_duration": "1s",

443

"approved_by_default": "True",

444

"enabled": "True",

445

}

446

447

def timeout_milliseconds(self):

448

"Return the 'timeout' attribute in milliseconds"

449

return timedelta_to_milliseconds(self.timeout)

450

451

def extended_timeout_milliseconds(self):

452

"Return the 'extended_timeout' attribute in milliseconds"

453

return timedelta_to_milliseconds(self.extended_timeout)

454

455

def interval_milliseconds(self):

456

"Return the 'interval' attribute in milliseconds"

457

return timedelta_to_milliseconds(self.interval)

458

459

def approval_delay_milliseconds(self):

460

return timedelta_to_milliseconds(self.approval_delay)

895

461

896

462

@staticmethod

897

463

def config_parser(config):

905

471

for client_name in config.sections():

906

472

section = dict(config.items(client_name))

907

473

client = settings[client_name] = {}

908

474

909

475

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

910

476

# Reformat values from string types to Python types

911

477

client["approved_by_default"] = config.getboolean(

912

478

client_name, "approved_by_default")

913

479

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

914

480

"enabled")

915

916

# Uppercase and remove spaces from key_id and fingerprint

917

# for later comparison purposes with return value from the

918

# key_id() and fingerprint() functions

919

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

920

.replace(" ", ""))

481

921

482

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

922

483

.replace(" ", ""))

923

484

if "secret" in section:

924

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

925

.encode("utf-8"),

926

"base64")

485

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

927

486

elif "secfile" in section:

928

487

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

929

488

(section["secfile"])),

930

489

"rb") as secfile:

931

490

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

932

491

else:

933

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

934

.format(section))

492

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

493

% section)

935

494

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

936

495

client["extended_timeout"] = string_to_delta(

937

496

section["extended_timeout"])

944

503

client["last_approval_request"] = None

945

504

client["last_checked_ok"] = None

946

505

client["last_checker_status"] = -2

947

506

948

507

return settings

949

950

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

508

509

510

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

511

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

512

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

513

attribute."""

951

514

self.name = name

952

if server_settings is None:

953

server_settings = {}

954

self.server_settings = server_settings

955

515

# adding all client settings

956

for setting, value in settings.items():

516

for setting, value in settings.iteritems():

957

517

setattr(self, setting, value)

958

518

959

519

if self.enabled:

960

520

if not hasattr(self, "last_enabled"):

961

521

self.last_enabled = datetime.datetime.utcnow()

965

525

else:

966

526

self.last_enabled = None

967

527

self.expires = None

968

528

969

529

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

970

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

530

# Uppercase and remove spaces from fingerprint for later

531

# comparison purposes with return value from the fingerprint()

532

# function

971

533

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

972

534

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

973

535

datetime.datetime.utcnow())

980

542

self.current_checker_command = None

981

543

self.approved = None

982

544

self.approvals_pending = 0

983

self.changedstate = multiprocessing_manager.Condition(

984

multiprocessing_manager.Lock())

985

self.client_structure = [attr

986

for attr in self.__dict__.keys()

545

self.changedstate = (multiprocessing_manager

546

.Condition(multiprocessing_manager

547

.Lock()))

548

self.client_structure = [attr for attr in

549

self.__dict__.iterkeys()

987

550

if not attr.startswith("_")]

988

551

self.client_structure.append("client_structure")

989

990

for name, t in inspect.getmembers(

991

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

552

553

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

554

lambda obj:

555

isinstance(obj,

556

property)):

992

557

if not name.startswith("_"):

993

558

self.client_structure.append(name)

994

559

995

560

# Send notice to process children that client state has changed

996

561

def send_changedstate(self):

997

562

with self.changedstate:

998

563

self.changedstate.notify_all()

999

564

1000

565

def enable(self):

1001

566

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

1002

567

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

1003

568

# Already enabled

1004

569

return

570

self.send_changedstate()

1005

571

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

1006

572

self.enabled = True

1007

573

self.last_enabled = datetime.datetime.utcnow()

1008

574

self.init_checker()

1009

self.send_changedstate()

1010

575

1011

576

def disable(self, quiet=True):

1012

577

"""Disable this client."""

1013

578

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

1014

579

return False

1015

580

if not quiet:

581

self.send_changedstate()

582

if not quiet:

1016

583

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

1017

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

1018

GLib.source_remove(self.disable_initiator_tag)

584

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

585

gobject.source_remove(self.disable_initiator_tag)

1019

586

self.disable_initiator_tag = None

1020

587

self.expires = None

1021

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

1022

GLib.source_remove(self.checker_initiator_tag)

588

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

589

gobject.source_remove(self.checker_initiator_tag)

1023

590

self.checker_initiator_tag = None

1024

591

self.stop_checker()

1025

592

self.enabled = False

1026

if not quiet:

1027

self.send_changedstate()

1028

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

593

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

1029

594

return False

1030

595

1031

596

def __del__(self):

1032

597

self.disable()

1033

598

1034

599

def init_checker(self):

1035

600

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

1036

601

# and every interval from then on.

1037

if self.checker_initiator_tag is not None:

1038

GLib.source_remove(self.checker_initiator_tag)

1039

self.checker_initiator_tag = GLib.timeout_add(

1040

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

1041

self.start_checker)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

self.start_checker))

1042

605

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

1043

if self.disable_initiator_tag is not None:

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

self.disable))

1047

609

# Also start a new checker *right now*.

1048

610

self.start_checker()

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

611

612

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

1052

613

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

if self.checker is not None:

1057

self.checker.join()

1058

614

self.checker_callback_tag = None

1059

615

self.checker = None

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

616

if os.WIFEXITED(condition):

617

self.last_checker_status = os.WEXITSTATUS(condition)

1064

618

if self.last_checker_status == 0:

1065

619

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

1066

620

vars(self))

1067

621

self.checked_ok()

1068

622

else:

1069

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

623

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

624

vars(self))

1070

625

else:

1071

626

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

1073

627

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

1074

628

vars(self))

1075

return False

1076

629

1077

630

def checked_ok(self):

1078

631

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

1079

632

self.last_checked_ok = datetime.datetime.utcnow()

1080

633

self.last_checker_status = 0

1081

self.last_checker_signal = None

1082

634

self.bump_timeout()

1083

635

1084

636

def bump_timeout(self, timeout=None):

1085

637

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

1086

638

if timeout is None:

1087

639

timeout = self.timeout

1088

640

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

1090

self.disable_initiator_tag = None

641

gobject.source_remove(self.disable_initiator_tag)

1091

642

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

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1094

646

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

1095

647

1096

648

def need_approval(self):

1097

649

self.last_approval_request = datetime.datetime.utcnow()

1098

650

1099

651

def start_checker(self):

1100

652

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

1101

653

1102

654

If a checker already exists, leave it running and do

1103

655

nothing."""

1104

656

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

1105

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

1106

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

1107

# would inevitably timeout, since no checker would get a

1108

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

657

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

658

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

659

# client would inevitably timeout, since no checker would get

660

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

1109

661

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

1110

662

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

1111

663

# should be.

1112

1113

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

1114

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

1115

self.checker.join()

1116

self.checker = None

664

665

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

666

try:

667

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

668

except (AttributeError, OSError) as error:

669

if (isinstance(error, OSError)

670

and error.errno != errno.ECHILD):

671

raise error

672

else:

673

if pid:

674

logger.warning("Checker was a zombie")

675

gobject.source_remove(self.checker_callback_tag)

676

self.checker_callback(pid, status,

677

self.current_checker_command)

1117

678

# Start a new checker if needed

1118

679

if self.checker is None:

1119

# Escape attributes for the shell

1120

escaped_attrs = {

1121

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

1122

for attr in self.runtime_expansions}

1123

680

try:

1124

command = self.checker_command % escaped_attrs

1125

except TypeError as error:

1126

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

1127

self.checker_command,

1128

exc_info=error)

1129

return True # Try again later

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

' %s', self.checker_command, error)

698

return True # Try again later

1130

699

self.current_checker_command = command

1131

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

1132

self.name)

1133

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

1134

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

1135

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

1136

# always replaced by /dev/null.)

1137

# The exception is when not debugging but nevertheless

1138

# running in the foreground; use the previously

1139

# created wnull.

1140

popen_args = {"close_fds": True,

1141

"shell": True,

1142

"cwd": "/"}

1143

if (not self.server_settings["debug"]

1144

and self.server_settings["foreground"]):

1145

popen_args.update({"stdout": wnull,

1146

"stderr": wnull})

1147

pipe = multiprocessing.Pipe(duplex=False)

1148

self.checker = multiprocessing.Process(

1149

target=call_pipe,

1150

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

1151

kwargs=popen_args)

1152

self.checker.start()

1153

self.checker_callback_tag = GLib.io_add_watch(

1154

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

1155

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1156

self.checker_callback, pipe[0], command)

1157

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

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

self.checker = subprocess.Popen(command,

708

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

720

except OSError as error:

721

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

722

error)

723

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

1158

724

return True

1159

725

1160

726

def stop_checker(self):

1161

727

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

1162

728

if self.checker_callback_tag:

1163

GLib.source_remove(self.checker_callback_tag)

729

gobject.source_remove(self.checker_callback_tag)

1164

730

self.checker_callback_tag = None

1165

731

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

1166

732

return

1167

733

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

1168

self.checker.terminate()

734

try:

735

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

736

#time.sleep(0.5)

737

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

738

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

739

except OSError as error:

740

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

741

raise

1169

742

self.checker = None

1170

743

1171

744

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1176

747

"""Decorators for marking methods of a DBusObjectWithProperties to

1177

748

become properties on the D-Bus.

1178

749

1179

750

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

1180

751

and with one argument by "Set".

1181

752

1182

753

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

1183

754

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

1184

755

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

1187

758

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

1188

759

if byte_arrays and signature != "ay":

1189

760

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

1190

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

1191

761

" signature %r" % signature)

1192

762

def decorator(func):

1193

763

func._dbus_is_property = True

1194

764

func._dbus_interface = dbus_interface

1197

767

func._dbus_name = func.__name__

1198

768

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

1199

769

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

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1201

771

return func

1202

1203

772

return decorator

1204

773

1205

774

1206

775

def dbus_interface_annotations(dbus_interface):

1207

"""Decorator for marking functions returning interface annotations

1208

776

"""Decorator for marking functions returning interface annotations.

777

1209

778

Usage:

1210

779

1211

780

@dbus_interface_annotations("org.example.Interface")

1212

781

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

1213

782

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

1214

783

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

1215

784

"false"}

1216

785

"""

1217

1218

786

def decorator(func):

1219

787

func._dbus_is_interface = True

1220

788

func._dbus_interface = dbus_interface

1221

789

func._dbus_name = dbus_interface

1222

790

return func

1223

1224

return decorator

1225

1226

1227

def dbus_annotations(annotations):

1228

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

1229

Usage:

1230

1231

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

1232

"org.freedesktop.DBus.Property."

1233

"EmitsChangedSignal": "false"})

1234

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

1235

access="r")

1236

def Property_dbus_property(self):

1237

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

1240

"""

1241

1242

def decorator(func):

1243

func._dbus_annotations = annotations

1244

return func

1245

1246

791

return decorator

1247

792

1248

793

1249

794

class DBusPropertyException(dbus.exceptions.DBusException):

1250

795

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

1251

796

"""

1252

pass

797

def __unicode__(self):

798

return unicode(str(self))

1253

799

1254

800

1255

801

class DBusPropertyAccessException(DBusPropertyException):

1264

810

pass

1265

811

1266

812

1267

class DBusObjectWithAnnotations(dbus.service.Object):

1268

"""A D-Bus object with annotations.

1269

1270

Classes inheriting from this can use the dbus_annotations

1271

decorator to add annotations to methods or signals.

813

class DBusObjectWithProperties(dbus.service.Object):

814

"""A D-Bus object with properties.

815

816

Classes inheriting from this can use the dbus_service_property

817

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

818

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

1272

819

"""

1273

820

1274

821

@staticmethod

1275

822

def _is_dbus_thing(thing):

1276

823

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

1277

824

1278

825

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

1279

826

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

1280

827

"""

1281

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

828

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

1282

829

False)

1283

830

1284

831

def _get_all_dbus_things(self, thing):

1285

832

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

1286

833

"""

1287

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

834

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

1288

835

athing.__get__(self))

1289

836

for cls in self.__class__.__mro__

1290

837

for name, athing in

1291

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

1292

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1297

def Introspect(self, object_path, connection):

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts annotation tags on methods and signals.

1301

"""

1302

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

1303

connection)

1304

try:

1305

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

1306

1307

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

1308

# Add annotation tags

1309

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

1310

for tag in if_tag.getElementsByTagName(typ):

1311

annots = dict()

1312

for name, prop in (self.

1313

_get_all_dbus_things(typ)):

1314

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

1315

and prop._dbus_interface

1316

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

1317

annots.update(getattr(

1318

prop, "_dbus_annotations", {}))

1319

for name, value in annots.items():

1320

ann_tag = document.createElement(

1321

"annotation")

1322

ann_tag.setAttribute("name", name)

1323

ann_tag.setAttribute("value", value)

1324

tag.appendChild(ann_tag)

1325

# Add interface annotation tags

1326

for annotation, value in dict(

1327

itertools.chain.from_iterable(

1328

annotations().items()

1329

for name, annotations

1330

in self._get_all_dbus_things("interface")

1331

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

1332

)).items():

1333

ann_tag = document.createElement("annotation")

1334

ann_tag.setAttribute("name", annotation)

1335

ann_tag.setAttribute("value", value)

1336

if_tag.appendChild(ann_tag)

1337

# Fix argument name for the Introspect method itself

1338

if (if_tag.getAttribute("name")

1339

== dbus.INTROSPECTABLE_IFACE):

1340

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

1341

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

1342

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

1343

if (arg.getAttribute("direction")

1344

== "out"):

1345

arg.setAttribute("name",

1346

"xml_data")

1347

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

1348

document.unlink()

1349

except (AttributeError, xml.dom.DOMException,

1350

xml.parsers.expat.ExpatError) as error:

1351

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

1352

exc_info=error)

1353

return xmlstring

1354

1355

1356

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1357

"""A D-Bus object with properties.

1358

1359

Classes inheriting from this can use the dbus_service_property

1360

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

1361

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

1362

"""

1363

838

inspect.getmembers(cls,

839

self._is_dbus_thing(thing)))

840

1364

841

def _get_dbus_property(self, interface_name, property_name):

1365

842

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

1366

843

property with the specified name and interface.

1367

844

"""

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

845

for cls in self.__class__.__mro__:

846

for name, value in (inspect.getmembers

847

(cls,

848

self._is_dbus_thing("property"))):

1371

849

if (value._dbus_name == property_name

1372

850

and value._dbus_interface == interface_name):

1373

851

return value.__get__(self)

1374

852

1375

853

# No such property

1376

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

1377

self.dbus_object_path, interface_name, property_name))

1378

1379

@classmethod

1380

def _get_all_interface_names(cls):

1381

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

1382

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

1383

"_dbus_interface", None)

1384

for x in (inspect.getmro(cls))

1385

for attr in dir(x))

1386

if name is not None)

1387

1388

@dbus.service.method(dbus.PROPERTIES_IFACE,

1389

in_signature="ss",

854

raise DBusPropertyNotFound(self.dbus_object_path + ":"

855

+ interface_name + "."

856

+ property_name)

857

858

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

1390

859

out_signature="v")

1391

860

def Get(self, interface_name, property_name):

1392

861

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

1398

867

if not hasattr(value, "variant_level"):

1399

868

return value

1400

869

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

1401

870

1402

871

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

1403

872

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

1404

873

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

1410

879

# The byte_arrays option is not supported yet on

1411

880

# signatures other than "ay".

1412

881

if prop._dbus_signature != "ay":

1413

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

1414

"'ay' signature {!r}"

1415

.format(prop._dbus_signature))

882

raise ValueError

1416

883

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

1417

884

for byte in value))

1418

885

prop(value)

1419

1420

@dbus.service.method(dbus.PROPERTIES_IFACE,

1421

in_signature="s",

886

887

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

1422

888

out_signature="a{sv}")

1423

889

def GetAll(self, interface_name):

1424

890

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

1425

891

standard.

1426

892

1427

893

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

1428

894

"""

1429

895

properties = {}

1439

905

if not hasattr(value, "variant_level"):

1440

906

properties[name] = value

1441

907

continue

1442

properties[name] = type(value)(

1443

value, variant_level=value.variant_level + 1)

908

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

909

value.variant_level+1)

1444

910

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

1445

1446

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

1447

def PropertiesChanged(self, interface_name, changed_properties,

1448

invalidated_properties):

1449

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

1450

standard.

1451

"""

1452

pass

1453

911

1454

912

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1455

913

out_signature="s",

1456

914

path_keyword='object_path',

1457

915

connection_keyword='connection')

1458

916

def Introspect(self, object_path, connection):

1459

917

"""Overloading of standard D-Bus method.

1460

918

1461

919

Inserts property tags and interface annotation tags.

1462

920

"""

1463

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1464

object_path,

1465

connection)

921

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

922

connection)

1466

923

try:

1467

924

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

1468

1469

925

def make_tag(document, name, prop):

1470

926

e = document.createElement("property")

1471

927

e.setAttribute("name", name)

1472

928

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

1473

929

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

1474

930

return e

1475

1476

931

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

1477

932

# Add property tags

1478

933

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

1481

936

if prop._dbus_interface

1482

937

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

1483

938

if_tag.appendChild(tag)

1484

# Add annotation tags for properties

1485

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

1486

annots = dict()

1487

for name, prop in self._get_all_dbus_things(

1488

"property"):

1489

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

1490

and prop._dbus_interface

1491

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

1492

annots.update(getattr(

1493

prop, "_dbus_annotations", {}))

1494

for name, value in annots.items():

1495

ann_tag = document.createElement(

1496

"annotation")

1497

ann_tag.setAttribute("name", name)

1498

ann_tag.setAttribute("value", value)

1499

tag.appendChild(ann_tag)

939

# Add interface annotation tags

940

for annotation, value in dict(

941

itertools.chain(

942

*(annotations().iteritems()

943

for name, annotations in

944

self._get_all_dbus_things("interface")

945

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

946

))).iteritems():

947

attr_tag = document.createElement("annotation")

948

attr_tag.setAttribute("name", annotation)

949

attr_tag.setAttribute("value", value)

950

if_tag.appendChild(attr_tag)

1500

951

# Add the names to the return values for the

1501

952

# "org.freedesktop.DBus.Properties" methods

1502

953

if (if_tag.getAttribute("name")

1517

968

except (AttributeError, xml.dom.DOMException,

1518

969

xml.parsers.expat.ExpatError) as error:

1519

970

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

1520

exc_info=error)

1521

return xmlstring

1522

1523

1524

try:

1525

dbus.OBJECT_MANAGER_IFACE

1526

except AttributeError:

1527

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

1528

1529

1530

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1531

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

1532

1533

Classes inheriting from this exposes the standard

1534

GetManagedObjects call and the InterfacesAdded and

1535

InterfacesRemoved signals on the standard

1536

"org.freedesktop.DBus.ObjectManager" interface.

1537

1538

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

1539

manually.

1540

"""

1541

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def GetManagedObjects(self):

1544

"""This function must be overridden"""

1545

raise NotImplementedError()

1546

1547

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1548

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

1549

def InterfacesAdded(self, object_path, interfaces_and_properties):

1550

pass

1551

1552

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

1553

def InterfacesRemoved(self, object_path, interfaces):

1554

pass

1555

1556

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1557

out_signature="s",

1558

path_keyword='object_path',

1559

connection_keyword='connection')

1560

def Introspect(self, object_path, connection):

1561

"""Overloading of standard D-Bus method.

1562

1563

Override return argument name of GetManagedObjects to be

1564

"objpath_interfaces_and_properties"

1565

"""

1566

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1567

object_path,

1568

connection)

1569

try:

1570

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

1571

1572

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

1573

# Fix argument name for the GetManagedObjects method

1574

if (if_tag.getAttribute("name")

1575

== dbus.OBJECT_MANAGER_IFACE):

1576

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

1577

if (cn.getAttribute("name")

1578

== "GetManagedObjects"):

1579

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

1580

if (arg.getAttribute("direction")

1581

== "out"):

1582

arg.setAttribute(

1583

"name",

1584

"objpath_interfaces"

1585

"_and_properties")

1586

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

1587

document.unlink()

1588

except (AttributeError, xml.dom.DOMException,

1589

xml.parsers.expat.ExpatError) as error:

1590

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

1591

exc_info=error)

1592

return xmlstring

1593

1594

1595

def datetime_to_dbus(dt, variant_level=0):

971

error)

972

return xmlstring

973

974

975

def datetime_to_dbus (dt, variant_level=0):

1596

976

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

1597

977

if dt is None:

1598

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

1599

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

1600

1601

1602

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1603

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

1604

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

1605

interface names according to the "alt_interface_names" mapping.

1606

Usage:

1607

1608

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

1609

"net.example.AlternateInterface"})

1610

class SampleDBusObject(dbus.service.Object):

1611

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

1612

def SampleDBusMethod():

1613

pass

1614

1615

The above "SampleDBusMethod" on "SampleDBusObject" will be

1616

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

1617

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

1618

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

1619

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

1620

1621

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

1622

(from DBusObjectWithProperties) and interfaces (from the

1623

dbus_interface_annotations decorator).

978

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

979

return dbus.String(dt.isoformat(),

980

variant_level=variant_level)

981

982

983

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

984

.__metaclass__):

985

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

986

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

1624

987

"""

1625

1626

def wrapper(cls):

1627

for orig_interface_name, alt_interface_name in (

1628

alt_interface_names.items()):

1629

attr = {}

1630

interface_names = set()

1631

# Go though all attributes of the class

1632

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

988

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

989

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

990

# methods, signals, or properties in them

991

old_interface_names = []

992

for base in (b for b in bases

993

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

994

# Go though all attributes of the base class

995

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

1633

996

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

1634

997

# with the wrong interface name

1635

998

if (not hasattr(attribute, "_dbus_interface")

1636

or not attribute._dbus_interface.startswith(

1637

orig_interface_name)):

999

or not attribute._dbus_interface

1000

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

1638

1001

continue

1639

1002

# Create an alternate D-Bus interface name based on

1640

1003

# the current name

1641

alt_interface = attribute._dbus_interface.replace(

1642

orig_interface_name, alt_interface_name)

1643

interface_names.add(alt_interface)

1004

alt_interface = (attribute._dbus_interface

1005

.replace("se.recompile.Mandos",

1006

"se.bsnet.fukt.Mandos"))

1007

if alt_interface != attribute._dbus_interface:

1008

old_interface_names.append(alt_interface)

1644

1009

# Is this a D-Bus signal?

1645

1010

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

1646

# Extract the original non-method undecorated

1647

# function by black magic

1648

if sys.version_info.major == 2:

1649

nonmethod_func = (dict(

1011

# Extract the original non-method function by

1012

# black magic

1013

nonmethod_func = (dict(

1650

1014

zip(attribute.func_code.co_freevars,

1651

attribute.__closure__))

1652

["func"].cell_contents)

1653

else:

1654

nonmethod_func = (dict(

1655

zip(attribute.__code__.co_freevars,

1656

attribute.__closure__))

1657

["func"].cell_contents)

1015

attribute.__closure__))["func"]

1016

.cell_contents)

1658

1017

# Create a new, but exactly alike, function

1659

1018

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

1660

1019

# with the alternate D-Bus interface name

1661

new_function = copy_function(nonmethod_func)

1662

new_function = (dbus.service.signal(

1663

alt_interface,

1664

attribute._dbus_signature)(new_function))

1665

# Copy annotations, if any

1666

try:

1667

new_function._dbus_annotations = dict(

1668

attribute._dbus_annotations)

1669

except AttributeError:

1670

pass

1671

1020

new_function = (dbus.service.signal

1021

(alt_interface,

1022

attribute._dbus_signature)

1023

(types.FunctionType(

1024

nonmethod_func.func_code,

1025

nonmethod_func.func_globals,

1026

nonmethod_func.func_name,

1027

nonmethod_func.func_defaults,

1028

nonmethod_func.func_closure)))

1672

1029

# Define a creator of a function to call both the

1673

# original and alternate functions, so both the

1674

# original and alternate signals gets sent when

1675

# the function is called

1030

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

1031

# signals gets sent when the function is called

1676

1032

def fixscope(func1, func2):

1677

1033

"""This function is a scope container to pass

1678

1034

func1 and func2 to the "call_both" function

1679

1035

outside of its arguments"""

1680

1681

@functools.wraps(func2)

1682

1036

def call_both(*args, **kwargs):

1683

1037

"""This function will emit two D-Bus

1684

1038

signals by calling func1 and func2"""

1685

1039

func1(*args, **kwargs)

1686

1040

func2(*args, **kwargs)

1687

# Make wrapper function look like a D-Bus

1688

# signal

1689

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

1690

if name.startswith("_dbus_"):

1691

setattr(call_both, name, attr)

1692

1693

1041

return call_both

1694

1042

# Create the "call_both" function and add it to

1695

1043

# the class

1696

attr[attrname] = fixscope(attribute, new_function)

1044

attr[attrname] = fixscope(attribute,

1045

new_function)

1697

1046

# Is this a D-Bus method?

1698

1047

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

1699

1048

# Create a new, but exactly alike, function

1700

1049

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

1701

1050

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

1702

1051

# to the class.

1703

attr[attrname] = (

1704

dbus.service.method(

1705

alt_interface,

1706

attribute._dbus_in_signature,

1707

attribute._dbus_out_signature)

1708

(copy_function(attribute)))

1709

# Copy annotations, if any

1710

try:

1711

attr[attrname]._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1713

except AttributeError:

1714

pass

1052

attr[attrname] = (dbus.service.method

1053

(alt_interface,

1054

attribute._dbus_in_signature,

1055

attribute._dbus_out_signature)

1056

(types.FunctionType

1057

(attribute.func_code,

1058

attribute.func_globals,

1059

attribute.func_name,

1060

attribute.func_defaults,

1061

attribute.func_closure)))

1715

1062

# Is this a D-Bus property?

1716

1063

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

1717

1064

# Create a new, but exactly alike, function

1718

1065

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

1719

1066

# property with the alternate D-Bus interface

1720

1067

# name. Add it to the class.

1721

attr[attrname] = (dbus_service_property(

1722

alt_interface, attribute._dbus_signature,

1723

attribute._dbus_access,

1724

attribute._dbus_get_args_options

1725

["byte_arrays"])

1726

(copy_function(attribute)))

1727

# Copy annotations, if any

1728

try:

1729

attr[attrname]._dbus_annotations = dict(

1730

attribute._dbus_annotations)

1731

except AttributeError:

1732

pass

1068

attr[attrname] = (dbus_service_property

1069

(alt_interface,

1070

attribute._dbus_signature,

1071

attribute._dbus_access,

1072

attribute

1073

._dbus_get_args_options

1074

["byte_arrays"])

1075

(types.FunctionType

1076

(attribute.func_code,

1077

attribute.func_globals,

1078

attribute.func_name,

1079

attribute.func_defaults,

1080

attribute.func_closure)))

1733

1081

# Is this a D-Bus interface?

1734

1082

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

1735

1083

# Create a new, but exactly alike, function

1736

1084

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

1737

1085

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

1738

1086

# to the class.

1739

attr[attrname] = (

1740

dbus_interface_annotations(alt_interface)

1741

(copy_function(attribute)))

1742

if deprecate:

1743

# Deprecate all alternate interfaces

1744

iname = "_AlternateDBusNames_interface_annotation{}"

1745

for interface_name in interface_names:

1746

1747

@dbus_interface_annotations(interface_name)

1748

def func(self):

1749

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

1750

"true"}

1751

# Find an unused name

1752

for aname in (iname.format(i)

1753

for i in itertools.count()):

1754

if aname not in attr:

1755

attr[aname] = func

1756

break

1757

if interface_names:

1758

# Replace the class with a new subclass of it with

1759

# methods, signals, etc. as created above.

1760

if sys.version_info.major == 2:

1761

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

1762

(cls, ), attr)

1763

else:

1764

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

1765

(cls, ), attr)

1766

return cls

1767

1768

return wrapper

1769

1770

1771

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

1772

"se.bsnet.fukt.Mandos"})

1087

attr[attrname] = (dbus_interface_annotations

1088

(alt_interface)

1089

(types.FunctionType

1090

(attribute.func_code,

1091

attribute.func_globals,

1092

attribute.func_name,

1093

attribute.func_defaults,

1094

attribute.func_closure)))

1095

# Deprecate all old interfaces

1096

basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1097

for old_interface_name in old_interface_names:

1098

@dbus_interface_annotations(old_interface_name)

1099

def func(self):

1100

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

1101

# Find an unused name

1102

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

1103

itertools.count()):

1104

if aname not in attr:

1105

attr[aname] = func

1106

break

1107

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

1108

1109

1773

1110

class ClientDBus(Client, DBusObjectWithProperties):

1774

1111

"""A Client class using D-Bus

1775

1112

1776

1113

Attributes:

1777

1114

dbus_object_path: dbus.ObjectPath

1778

1115

bus: dbus.SystemBus()

1779

1116

"""

1780

1117

1781

1118

runtime_expansions = (Client.runtime_expansions

1782

+ ("dbus_object_path", ))

1783

1784

_interface = "se.recompile.Mandos.Client"

1785

1119

+ ("dbus_object_path",))

1120

1786

1121

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

1787

1788

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

1122

1123

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

1789

1124

self.bus = bus

1790

1125

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

1791

1126

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

1792

1127

# the D-Bus

1793

client_object_name = str(self.name).translate(

1128

client_object_name = unicode(self.name).translate(

1794

1129

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

1795

1130

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

1796

self.dbus_object_path = dbus.ObjectPath(

1797

"/clients/" + client_object_name)

1131

self.dbus_object_path = (dbus.ObjectPath

1132

("/clients/" + client_object_name))

1798

1133

DBusObjectWithProperties.__init__(self, self.bus,

1799

1134

self.dbus_object_path)

1800

1801

def notifychangeproperty(transform_func, dbus_name,

1802

type_func=lambda x: x,

1803

variant_level=1,

1804

invalidate_only=False,

1805

_interface=_interface):

1135

1136

def notifychangeproperty(transform_func,

1137

dbus_name, type_func=lambda x: x,

1138

variant_level=1):

1806

1139

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

1807

1140

its changes to DBus.

1808

1141

1809

1142

transform_fun: Function that takes a value and a variant_level

1810

1143

and transforms it to a D-Bus type.

1811

1144

dbus_name: D-Bus name of the variable

1813

1146

to the D-Bus. Default: no transform

1814

1147

variant_level: D-Bus variant level. Default: 1

1815

1148

"""

1816

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

1817

1149

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

1818

1150

def setter(self, value):

1819

1151

if hasattr(self, "dbus_object_path"):

1820

1152

if (not hasattr(self, attrname) or

1821

1153

type_func(getattr(self, attrname, None))

1822

1154

!= type_func(value)):

1823

if invalidate_only:

1824

self.PropertiesChanged(

1825

_interface, dbus.Dictionary(),

1826

dbus.Array((dbus_name, )))

1827

else:

1828

dbus_value = transform_func(

1829

type_func(value),

1830

variant_level=variant_level)

1831

self.PropertyChanged(dbus.String(dbus_name),

1832

dbus_value)

1833

self.PropertiesChanged(

1834

_interface,

1835

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

1836

dbus_value}),

1837

dbus.Array())

1155

dbus_value = transform_func(type_func(value),

1156

variant_level

1157

=variant_level)

1158

self.PropertyChanged(dbus.String(dbus_name),

1159

dbus_value)

1838

1160

setattr(self, attrname, value)

1839

1161

1840

1162

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

1841

1163

1164

1842

1165

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1843

1166

approvals_pending = notifychangeproperty(dbus.Boolean,

1844

1167

"ApprovalPending",

1845

type_func=bool)

1168

type_func = bool)

1846

1169

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

1847

1170

last_enabled = notifychangeproperty(datetime_to_dbus,

1848

1171

"LastEnabled")

1849

checker = notifychangeproperty(

1850

dbus.Boolean, "CheckerRunning",

1851

type_func=lambda checker: checker is not None)

1172

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

1173

type_func = lambda checker:

1174

checker is not None)

1852

1175

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1853

1176

"LastCheckedOK")

1854

1177

last_checker_status = notifychangeproperty(dbus.Int16,

1857

1180

datetime_to_dbus, "LastApprovalRequest")

1858

1181

approved_by_default = notifychangeproperty(dbus.Boolean,

1859

1182

"ApprovedByDefault")

1860

approval_delay = notifychangeproperty(

1861

dbus.UInt64, "ApprovalDelay",

1862

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

1183

approval_delay = notifychangeproperty(dbus.UInt64,

1184

"ApprovalDelay",

1185

type_func =

1186

timedelta_to_milliseconds)

1863

1187

approval_duration = notifychangeproperty(

1864

1188

dbus.UInt64, "ApprovalDuration",

1865

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

1189

type_func = timedelta_to_milliseconds)

1866

1190

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

1867

timeout = notifychangeproperty(

1868

dbus.UInt64, "Timeout",

1869

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

1191

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

1192

type_func =

1193

timedelta_to_milliseconds)

1870

1194

extended_timeout = notifychangeproperty(

1871

1195

dbus.UInt64, "ExtendedTimeout",

1872

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

1873

interval = notifychangeproperty(

1874

dbus.UInt64, "Interval",

1875

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

1196

type_func = timedelta_to_milliseconds)

1197

interval = notifychangeproperty(dbus.UInt64,

1198

"Interval",

1199

type_func =

1200

timedelta_to_milliseconds)

1876

1201

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

1877

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

1878

invalidate_only=True)

1879

1202

1880

1203

del notifychangeproperty

1881

1204

1882

1205

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

1883

1206

try:

1884

1207

self.remove_from_connection()

1887

1210

if hasattr(DBusObjectWithProperties, "__del__"):

1888

1211

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

1889

1212

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

1890

1891

def checker_callback(self, source, condition,

1892

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

1893

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

1894

connection, command, *args,

1895

**kwargs)

1896

exitstatus = self.last_checker_status

1897

if exitstatus >= 0:

1213

1214

def checker_callback(self, pid, condition, command,

1215

*args, **kwargs):

1216

self.checker_callback_tag = None

1217

self.checker = None

1218

if os.WIFEXITED(condition):

1219

exitstatus = os.WEXITSTATUS(condition)

1898

1220

# Emit D-Bus signal

1899

1221

self.CheckerCompleted(dbus.Int16(exitstatus),

1900

# This is specific to GNU libC

1901

dbus.Int64(exitstatus << 8),

1222

dbus.Int64(condition),

1902

1223

dbus.String(command))

1903

1224

else:

1904

1225

# Emit D-Bus signal

1905

1226

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

1906

dbus.Int64(

1907

# This is specific to GNU libC

1908

(exitstatus << 8)

1909

| self.last_checker_signal),

1227

dbus.Int64(condition),

1910

1228

dbus.String(command))

1911

return ret

1912

1229

1230

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

1231

*args, **kwargs)

1232

1913

1233

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

1914

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

1234

old_checker = self.checker

1235

if self.checker is not None:

1236

old_checker_pid = self.checker.pid

1237

else:

1238

old_checker_pid = None

1915

1239

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

1916

1240

# Only if new checker process was started

1917

1241

if (self.checker is not None

1919

1243

# Emit D-Bus signal

1920

1244

self.CheckerStarted(self.current_checker_command)

1921

1245

return r

1922

1246

1923

1247

def _reset_approved(self):

1924

1248

self.approved = None

1925

1249

return False

1926

1250

1927

1251

def approve(self, value=True):

1252

self.send_changedstate()

1928

1253

self.approved = value

1929

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

1930

* 1000), self._reset_approved)

1931

self.send_changedstate()

1932

1933

# D-Bus methods, signals & properties

1934

1935

# Interfaces

1936

1937

# Signals

1938

1254

gobject.timeout_add(timedelta_to_milliseconds

1255

(self.approval_duration),

1256

self._reset_approved)

1257

1258

1259

## D-Bus methods, signals & properties

1260

_interface = "se.recompile.Mandos.Client"

1261

1262

## Interfaces

1263

1264

@dbus_interface_annotations(_interface)

1265

def _foo(self):

1266

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

1267

"false"}

1268

1269

## Signals

1270

1939

1271

# CheckerCompleted - signal

1940

1272

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

1941

1273

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

1942

1274

"D-Bus signal"

1943

1275

pass

1944

1276

1945

1277

# CheckerStarted - signal

1946

1278

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

1947

1279

def CheckerStarted(self, command):

1948

1280

"D-Bus signal"

1949

1281

pass

1950

1282

1951

1283

# PropertyChanged - signal

1952

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

1953

1284

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

1954

1285

def PropertyChanged(self, property, value):

1955

1286

"D-Bus signal"

1956

1287

pass

1957

1288

1958

1289

# GotSecret - signal

1959

1290

@dbus.service.signal(_interface)

1960

1291

def GotSecret(self):

1963

1294

server to mandos-client

1964

1295

"""

1965

1296

pass

1966

1297

1967

1298

# Rejected - signal

1968

1299

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

1969

1300

def Rejected(self, reason):

1970

1301

"D-Bus signal"

1971

1302

pass

1972

1303

1973

1304

# NeedApproval - signal

1974

1305

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

1975

1306

def NeedApproval(self, timeout, default):

1976

1307

"D-Bus signal"

1977

1308

return self.need_approval()

1978

1979

# Methods

1980

1309

1310

## Methods

1311

1981

1312

# Approve - method

1982

1313

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

1983

1314

def Approve(self, value):

1984

1315

self.approve(value)

1985

1316

1986

1317

# CheckedOK - method

1987

1318

@dbus.service.method(_interface)

1988

1319

def CheckedOK(self):

1989

1320

self.checked_ok()

1990

1321

1991

1322

# Enable - method

1992

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

1993

1323

@dbus.service.method(_interface)

1994

1324

def Enable(self):

1995

1325

"D-Bus method"

1996

1326

self.enable()

1997

1327

1998

1328

# StartChecker - method

1999

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

2000

1329

@dbus.service.method(_interface)

2001

1330

def StartChecker(self):

2002

1331

"D-Bus method"

2003

1332

self.start_checker()

2004

1333

2005

1334

# Disable - method

2006

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

2007

1335

@dbus.service.method(_interface)

2008

1336

def Disable(self):

2009

1337

"D-Bus method"

2010

1338

self.disable()

2011

1339

2012

1340

# StopChecker - method

2013

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

2014

1341

@dbus.service.method(_interface)

2015

1342

def StopChecker(self):

2016

1343

self.stop_checker()

2017

2018

# Properties

2019

1344

1345

## Properties

1346

2020

1347

# ApprovalPending - property

2021

1348

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

2022

1349

def ApprovalPending_dbus_property(self):

2023

1350

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

2024

1351

2025

1352

# ApprovedByDefault - property

2026

@dbus_service_property(_interface,

2027

signature="b",

1353

@dbus_service_property(_interface, signature="b",

2028

1354

access="readwrite")

2029

1355

def ApprovedByDefault_dbus_property(self, value=None):

2030

1356

if value is None: # get

2031

1357

return dbus.Boolean(self.approved_by_default)

2032

1358

self.approved_by_default = bool(value)

2033

1359

2034

1360

# ApprovalDelay - property

2035

@dbus_service_property(_interface,

2036

signature="t",

1361

@dbus_service_property(_interface, signature="t",

2037

1362

access="readwrite")

2038

1363

def ApprovalDelay_dbus_property(self, value=None):

2039

1364

if value is None: # get

2040

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

2041

* 1000)

1365

return dbus.UInt64(self.approval_delay_milliseconds())

2042

1366

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

2043

1367

2044

1368

# ApprovalDuration - property

2045

@dbus_service_property(_interface,

2046

signature="t",

1369

@dbus_service_property(_interface, signature="t",

2047

1370

access="readwrite")

2048

1371

def ApprovalDuration_dbus_property(self, value=None):

2049

1372

if value is None: # get

2050

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

2051

* 1000)

1373

return dbus.UInt64(timedelta_to_milliseconds(

1374

self.approval_duration))

2052

1375

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

2053

1376

2054

1377

# Name - property

2055

@dbus_annotations(

2056

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

2057

1378

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

2058

1379

def Name_dbus_property(self):

2059

1380

return dbus.String(self.name)

2060

2061

# KeyID - property

2062

@dbus_annotations(

2063

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

2064

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

2065

def KeyID_dbus_property(self):

2066

return dbus.String(self.key_id)

2067

1381

2068

1382

# Fingerprint - property

2069

@dbus_annotations(

2070

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

2071

1383

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

2072

1384

def Fingerprint_dbus_property(self):

2073

1385

return dbus.String(self.fingerprint)

2074

1386

2075

1387

# Host - property

2076

@dbus_service_property(_interface,

2077

signature="s",

1388

@dbus_service_property(_interface, signature="s",

2078

1389

access="readwrite")

2079

1390

def Host_dbus_property(self, value=None):

2080

1391

if value is None: # get

2081

1392

return dbus.String(self.host)

2082

self.host = str(value)

2083

1393

self.host = unicode(value)

1394

2084

1395

# Created - property

2085

@dbus_annotations(

2086

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

2087

1396

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

2088

1397

def Created_dbus_property(self):

2089

1398

return datetime_to_dbus(self.created)

2090

1399

2091

1400

# LastEnabled - property

2092

1401

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

2093

1402

def LastEnabled_dbus_property(self):

2094

1403

return datetime_to_dbus(self.last_enabled)

2095

1404

2096

1405

# Enabled - property

2097

@dbus_service_property(_interface,

2098

signature="b",

1406

@dbus_service_property(_interface, signature="b",

2099

1407

access="readwrite")

2100

1408

def Enabled_dbus_property(self, value=None):

2101

1409

if value is None: # get

2104

1412

self.enable()

2105

1413

else:

2106

1414

self.disable()

2107

1415

2108

1416

# LastCheckedOK - property

2109

@dbus_service_property(_interface,

2110

signature="s",

1417

@dbus_service_property(_interface, signature="s",

2111

1418

access="readwrite")

2112

1419

def LastCheckedOK_dbus_property(self, value=None):

2113

1420

if value is not None:

2114

1421

self.checked_ok()

2115

1422

return

2116

1423

return datetime_to_dbus(self.last_checked_ok)

2117

1424

2118

1425

# LastCheckerStatus - property

2119

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

1426

@dbus_service_property(_interface, signature="n",

1427

access="read")

2120

1428

def LastCheckerStatus_dbus_property(self):

2121

1429

return dbus.Int16(self.last_checker_status)

2122

1430

2123

1431

# Expires - property

2124

1432

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

2125

1433

def Expires_dbus_property(self):

2126

1434

return datetime_to_dbus(self.expires)

2127

1435

2128

1436

# LastApprovalRequest - property

2129

1437

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

2130

1438

def LastApprovalRequest_dbus_property(self):

2131

1439

return datetime_to_dbus(self.last_approval_request)

2132

1440

2133

1441

# Timeout - property

2134

@dbus_service_property(_interface,

2135

signature="t",

1442

@dbus_service_property(_interface, signature="t",

2136

1443

access="readwrite")

2137

1444

def Timeout_dbus_property(self, value=None):

2138

1445

if value is None: # get

2139

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

2140

old_timeout = self.timeout

1446

return dbus.UInt64(self.timeout_milliseconds())

2141

1447

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

2142

# Reschedule disabling

1448

# Reschedule timeout

2143

1449

if self.enabled:

2144

1450

now = datetime.datetime.utcnow()

2145

self.expires += self.timeout - old_timeout

2146

if self.expires <= now:

1451

time_to_die = timedelta_to_milliseconds(

1452

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

1453

if time_to_die <= 0:

2147

1454

# The timeout has passed

2148

1455

self.disable()

2149

1456

else:

1457

self.expires = (now +

1458

datetime.timedelta(milliseconds =

1459

time_to_die))

2150

1460

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

2151

1461

is None):

2152

1462

return

2153

GLib.source_remove(self.disable_initiator_tag)

2154

self.disable_initiator_tag = GLib.timeout_add(

2155

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

2156

self.disable)

2157

1463

gobject.source_remove(self.disable_initiator_tag)

1464

self.disable_initiator_tag = (gobject.timeout_add

1465

(time_to_die,

1466

self.disable))

1467

2158

1468

# ExtendedTimeout - property

2159

@dbus_service_property(_interface,

2160

signature="t",

1469

@dbus_service_property(_interface, signature="t",

2161

1470

access="readwrite")

2162

1471

def ExtendedTimeout_dbus_property(self, value=None):

2163

1472

if value is None: # get

2164

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

2165

* 1000)

1473

return dbus.UInt64(self.extended_timeout_milliseconds())

2166

1474

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

2167

1475

2168

1476

# Interval - property

2169

@dbus_service_property(_interface,

2170

signature="t",

1477

@dbus_service_property(_interface, signature="t",

2171

1478

access="readwrite")

2172

1479

def Interval_dbus_property(self, value=None):

2173

1480

if value is None: # get

2174

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

1481

return dbus.UInt64(self.interval_milliseconds())

2175

1482

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

2176

1483

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

2177

1484

return

2178

1485

if self.enabled:

2179

1486

# Reschedule checker run

2180

GLib.source_remove(self.checker_initiator_tag)

2181

self.checker_initiator_tag = GLib.timeout_add(

2182

value, self.start_checker)

2183

self.start_checker() # Start one now, too

2184

1487

gobject.source_remove(self.checker_initiator_tag)

1488

self.checker_initiator_tag = (gobject.timeout_add

1489

(value, self.start_checker))

1490

self.start_checker() # Start one now, too

1491

2185

1492

# Checker - property

2186

@dbus_service_property(_interface,

2187

signature="s",

1493

@dbus_service_property(_interface, signature="s",

2188

1494

access="readwrite")

2189

1495

def Checker_dbus_property(self, value=None):

2190

1496

if value is None: # get

2191

1497

return dbus.String(self.checker_command)

2192

self.checker_command = str(value)

2193

1498

self.checker_command = unicode(value)

1499

2194

1500

# CheckerRunning - property

2195

@dbus_service_property(_interface,

2196

signature="b",

1501

@dbus_service_property(_interface, signature="b",

2197

1502

access="readwrite")

2198

1503

def CheckerRunning_dbus_property(self, value=None):

2199

1504

if value is None: # get

2202

1507

self.start_checker()

2203

1508

else:

2204

1509

self.stop_checker()

2205

1510

2206

1511

# ObjectPath - property

2207

@dbus_annotations(

2208

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

2209

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

2210

1512

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

2211

1513

def ObjectPath_dbus_property(self):

2212

return self.dbus_object_path # is already a dbus.ObjectPath

2213

1514

return self.dbus_object_path # is already a dbus.ObjectPath

1515

2214

1516

# Secret = property

2215

@dbus_annotations(

2216

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

2217

"invalidates"})

2218

@dbus_service_property(_interface,

2219

signature="ay",

2220

access="write",

2221

byte_arrays=True)

1517

@dbus_service_property(_interface, signature="ay",

1518

access="write", byte_arrays=True)

2222

1519

def Secret_dbus_property(self, value):

2223

self.secret = bytes(value)

2224

1520

self.secret = str(value)

1521

2225

1522

del _interface

2226

1523

2227

1524

2228

class ProxyClient:

2229

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

1525

class ProxyClient(object):

1526

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

2230

1527

self._pipe = child_pipe

2231

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

1528

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

2232

1529

if not self._pipe.recv():

2233

raise KeyError(key_id or fpr)

2234

1530

raise KeyError()

1531

2235

1532

def __getattribute__(self, name):

2236

1533

if name == '_pipe':

2237

1534

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

2240

1537

if data[0] == 'data':

2241

1538

return data[1]

2242

1539

if data[0] == 'function':

2243

2244

1540

def func(*args, **kwargs):

2245

1541

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

2246

1542

return self._pipe.recv()[1]

2247

2248

1543

return func

2249

1544

2250

1545

def __setattr__(self, name, value):

2251

1546

if name == '_pipe':

2252

1547

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

2253

1548

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

2254

1549

2255

1550

1551

class ClientDBusTransitional(ClientDBus):

1552

__metaclass__ = AlternateDBusNamesMetaclass

1553

1554

2256

1555

class ClientHandler(socketserver.BaseRequestHandler, object):

2257

1556

"""A class to handle client connections.

2258

1557

2259

1558

Instantiated once for each connection to handle it.

2260

1559

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

2261

1560

2262

1561

def handle(self):

2263

1562

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

2264

1563

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

2265

str(self.client_address))

1564

unicode(self.client_address))

2266

1565

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

2267

1566

self.server.child_pipe.fileno())

2268

2269

session = gnutls.ClientSession(self.request)

2270

2271

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

2272

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

2273

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

2274

# "+DHE-DSS"))

1567

1568

session = (gnutls.connection

1569

.ClientSession(self.request,

1570

gnutls.connection

1571

.X509Credentials()))

1572

1573

# Note: gnutls.connection.X509Credentials is really a

1574

# generic GnuTLS certificate credentials object so long as

1575

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

1576

# here despite using OpenPGP certificates.

1577

1578

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

1579

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

1580

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

1581

# "+DHE-DSS"))

2275

1582

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

2276

1583

priority = self.server.gnutls_priority

2277

1584

if priority is None:

2278

1585

priority = "NORMAL"

2279

gnutls.priority_set_direct(session._c_object,

2280

priority.encode("utf-8"),

2281

None)

2282

1586

(gnutls.library.functions

1587

.gnutls_priority_set_direct(session._c_object,

1588

priority, None))

1589

2283

1590

# Start communication using the Mandos protocol

2284

1591

# Get protocol number

2285

1592

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

2286

1593

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

2287

1594

try:

2288

1595

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

2289

raise RuntimeError(line)

1596

raise RuntimeError

2290

1597

except (ValueError, IndexError, RuntimeError) as error:

2291

1598

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

2292

1599

return

2293

1600

2294

1601

# Start GnuTLS connection

2295

1602

try:

2296

1603

session.handshake()

2297

except gnutls.Error as error:

1604

except gnutls.errors.GNUTLSError as error:

2298

1605

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

2299

1606

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

2300

1607

# established. Just abandon the request.

2301

1608

return

2302

1609

logger.debug("Handshake succeeded")

2303

1610

2304

1611

approval_required = False

2305

1612

try:

2306

if gnutls.has_rawpk:

2307

fpr = b""

2308

try:

2309

key_id = self.key_id(

2310

self.peer_certificate(session))

2311

except (TypeError, gnutls.Error) as error:

2312

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

2313

return

2314

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

2315

2316

else:

2317

key_id = b""

2318

try:

2319

fpr = self.fingerprint(

2320

self.peer_certificate(session))

2321

except (TypeError, gnutls.Error) as error:

2322

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

2323

return

2324

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

2325

2326

try:

2327

client = ProxyClient(child_pipe, key_id, fpr,

1613

try:

1614

fpr = self.fingerprint(self.peer_certificate

1615

(session))

1616

except (TypeError,

1617

gnutls.errors.GNUTLSError) as error:

1618

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

1619

return

1620

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

1621

1622

try:

1623

client = ProxyClient(child_pipe, fpr,

2328

1624

self.client_address)

2329

1625

except KeyError:

2330

1626

return

2331

1627

2332

1628

if client.approval_delay:

2333

1629

delay = client.approval_delay

2334

1630

client.approvals_pending += 1

2335

1631

approval_required = True

2336

1632

2337

1633

while True:

2338

1634

if not client.enabled:

2339

1635

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

2340

client.name)

1636

client.name)

2341

1637

if self.server.use_dbus:

2342

1638

# Emit D-Bus signal

2343

1639

client.Rejected("Disabled")

2344

1640

return

2345

1641

2346

1642

if client.approved or not client.approval_delay:

2347

# We are approved or approval is disabled

1643

#We are approved or approval is disabled

2348

1644

break

2349

1645

elif client.approved is None:

2350

1646

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

2352

1648

if self.server.use_dbus:

2353

1649

# Emit D-Bus signal

2354

1650

client.NeedApproval(

2355

client.approval_delay.total_seconds()

2356

* 1000, client.approved_by_default)

1651

client.approval_delay_milliseconds(),

1652

client.approved_by_default)

2357

1653

else:

2358

1654

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

2359

1655

client.name)

2361

1657

# Emit D-Bus signal

2362

1658

client.Rejected("Denied")

2363

1659

return

2364

2365

# wait until timeout or approved

1660

1661

#wait until timeout or approved

2366

1662

time = datetime.datetime.now()

2367

1663

client.changedstate.acquire()

2368

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

1664

(client.changedstate.wait

1665

(float(client.timedelta_to_milliseconds(delay)

1666

/ 1000)))

2369

1667

client.changedstate.release()

2370

1668

time2 = datetime.datetime.now()

2371

1669

if (time2 - time) >= delay:

2381

1679

break

2382

1680

else:

2383

1681

delay -= time2 - time

2384

2385

try:

2386

session.send(client.secret)

2387

except gnutls.Error as error:

2388

logger.warning("gnutls send failed",

2389

exc_info=error)

2390

return

2391

1682

1683

sent_size = 0

1684

while sent_size < len(client.secret):

1685

try:

1686

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

1687

except gnutls.errors.GNUTLSError as error:

1688

logger.warning("gnutls send failed")

1689

return

1690

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

1691

sent, len(client.secret)

1692

- (sent_size + sent))

1693

sent_size += sent

1694

2392

1695

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

2393

1696

# bump the timeout using extended_timeout

2394

1697

client.bump_timeout(client.extended_timeout)

2395

1698

if self.server.use_dbus:

2396

1699

# Emit D-Bus signal

2397

1700

client.GotSecret()

2398

1701

2399

1702

finally:

2400

1703

if approval_required:

2401

1704

client.approvals_pending -= 1

2402

1705

try:

2403

1706

session.bye()

2404

except gnutls.Error as error:

2405

logger.warning("GnuTLS bye failed",

2406

exc_info=error)

2407

1707

except gnutls.errors.GNUTLSError as error:

1708

logger.warning("GnuTLS bye failed")

1709

2408

1710

@staticmethod

2409

1711

def peer_certificate(session):

2410

"Return the peer's certificate as a bytestring"

2411

try:

2412

cert_type = gnutls.certificate_type_get2(session._c_object,

2413

gnutls.CTYPE_PEERS)

2414

except AttributeError:

2415

cert_type = gnutls.certificate_type_get(session._c_object)

2416

if gnutls.has_rawpk:

2417

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2418

else:

2419

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2420

# If not a valid certificate type...

2421

if cert_type not in valid_cert_types:

2422

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

2423

valid_cert_types)

2424

# ...return invalid data

2425

return b""

1712

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

1713

# If not an OpenPGP certificate...

1714

if (gnutls.library.functions

1715

.gnutls_certificate_type_get(session._c_object)

1716

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1717

# ...do the normal thing

1718

return session.peer_certificate

2426

1719

list_size = ctypes.c_uint(1)

2427

cert_list = (gnutls.certificate_get_peers

1720

cert_list = (gnutls.library.functions

1721

.gnutls_certificate_get_peers

2428

1722

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

2429

1723

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

2430

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

1724

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

1725

" certificate")

2431

1726

if list_size.value == 0:

2432

1727

return None

2433

1728

cert = cert_list[0]

2434

1729

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

2435

2436

@staticmethod

2437

def key_id(certificate):

2438

"Convert a certificate bytestring to a hexdigit key ID"

2439

# New GnuTLS "datum" with the public key

2440

datum = gnutls.datum_t(

2441

ctypes.cast(ctypes.c_char_p(certificate),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.c_uint(len(certificate)))

2444

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

2445

# New empty GnuTLS certificate

2446

pubkey = gnutls.pubkey_t()

2447

gnutls.pubkey_init(ctypes.byref(pubkey))

2448

# Import the raw public key into the certificate

2449

gnutls.pubkey_import(pubkey,

2450

ctypes.byref(datum),

2451

gnutls.X509_FMT_DER)

2452

# New buffer for the key ID

2453

buf = ctypes.create_string_buffer(32)

2454

buf_len = ctypes.c_size_t(len(buf))

2455

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

2456

gnutls.pubkey_get_key_id(pubkey,

2457

gnutls.KEYID_USE_SHA256,

2458

ctypes.cast(ctypes.byref(buf),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.byref(buf_len))

2461

# Deinit the certificate

2462

gnutls.pubkey_deinit(pubkey)

2463

2464

# Convert the buffer to a Python bytestring

2465

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

2466

# Convert the bytestring to hexadecimal notation

2467

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

2468

return hex_key_id

2469

1730

2470

1731

@staticmethod

2471

1732

def fingerprint(openpgp):

2472

1733

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2473

1734

# New GnuTLS "datum" with the OpenPGP public key

2474

datum = gnutls.datum_t(

2475

ctypes.cast(ctypes.c_char_p(openpgp),

2476

ctypes.POINTER(ctypes.c_ubyte)),

2477

ctypes.c_uint(len(openpgp)))

1735

datum = (gnutls.library.types

1736

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

1737

ctypes.POINTER

1738

(ctypes.c_ubyte)),

1739

ctypes.c_uint(len(openpgp))))

2478

1740

# New empty GnuTLS certificate

2479

crt = gnutls.openpgp_crt_t()

2480

gnutls.openpgp_crt_init(ctypes.byref(crt))

1741

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1742

(gnutls.library.functions

1743

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2481

1744

# Import the OpenPGP public key into the certificate

2482

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

2483

gnutls.OPENPGP_FMT_RAW)

1745

(gnutls.library.functions

1746

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

1747

gnutls.library.constants

1748

.GNUTLS_OPENPGP_FMT_RAW))

2484

1749

# Verify the self signature in the key

2485

1750

crtverify = ctypes.c_uint()

2486

gnutls.openpgp_crt_verify_self(crt, 0,

2487

ctypes.byref(crtverify))

1751

(gnutls.library.functions

1752

.gnutls_openpgp_crt_verify_self(crt, 0,

1753

ctypes.byref(crtverify)))

2488

1754

if crtverify.value != 0:

2489

gnutls.openpgp_crt_deinit(crt)

2490

raise gnutls.CertificateSecurityError(code

2491

=crtverify.value)

1755

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1756

raise (gnutls.errors.CertificateSecurityError

1757

("Verify failed"))

2492

1758

# New buffer for the fingerprint

2493

1759

buf = ctypes.create_string_buffer(20)

2494

1760

buf_len = ctypes.c_size_t()

2495

1761

# Get the fingerprint from the certificate into the buffer

2496

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

2497

ctypes.byref(buf_len))

1762

(gnutls.library.functions

1763

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

1764

ctypes.byref(buf_len)))

2498

1765

# Deinit the certificate

2499

gnutls.openpgp_crt_deinit(crt)

1766

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2500

1767

# Convert the buffer to a Python bytestring

2501

1768

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

2502

1769

# Convert the bytestring to hexadecimal notation

2504

1771

return hex_fpr

2505

1772

2506

1773

2507

class MultiprocessingMixIn:

1774

class MultiprocessingMixIn(object):

2508

1775

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

2509

2510

1776

def sub_process_main(self, request, address):

2511

1777

try:

2512

1778

self.finish_request(request, address)

2513

1779

except Exception:

2514

1780

self.handle_error(request, address)

2515

1781

self.close_request(request)

2516

1782

2517

1783

def process_request(self, request, address):

2518

1784

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

2519

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

2520

args=(request, address))

1785

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

1786

args = (request,

1787

address))

2521

1788

proc.start()

2522

1789

return proc

2523

1790

2524

1791

2525

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1792

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2526

1793

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

2527

2528

1794

def process_request(self, request, client_address):

2529

1795

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

2530

1796

2531

1797

This function creates a new pipe in self.pipe

2532

1798

"""

2533

1799

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2534

1800

2535

1801

proc = MultiprocessingMixIn.process_request(self, request,

2536

1802

client_address)

2537

1803

self.child_pipe.close()

2538

1804

self.add_pipe(parent_pipe, proc)

2539

1805

2540

1806

def add_pipe(self, parent_pipe, proc):

2541

1807

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

2542

raise NotImplementedError()

1808

raise NotImplementedError

2543

1809

2544

1810

2545

1811

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2546

socketserver.TCPServer):

1812

socketserver.TCPServer, object):

2547

1813

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

2548

1814

2549

1815

Attributes:

2550

1816

enabled: Boolean; whether this server is activated yet

2551

1817

interface: None or a network interface name (string)

2552

1818

use_ipv6: Boolean; to use IPv6 or not

2553

1819

"""

2554

2555

1820

def __init__(self, server_address, RequestHandlerClass,

2556

interface=None,

2557

use_ipv6=True,

2558

socketfd=None):

2559

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

2560

creating a new one with socket.socket().

2561

"""

1821

interface=None, use_ipv6=True):

2562

1822

self.interface = interface

2563

1823

if use_ipv6:

2564

1824

self.address_family = socket.AF_INET6

2565

if socketfd is not None:

2566

# Save the file descriptor

2567

self.socketfd = socketfd

2568

# Save the original socket.socket() function

2569

self.socket_socket = socket.socket

2570

2571

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

2572

#

2573

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

2574

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

2575

# patching socket.socket.)

2576

#

2577

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

2578

@functools.wraps(socket.socket)

2579

def socket_wrapper(*args, **kwargs):

2580

# Restore original function so subsequent calls are

2581

# not affected.

2582

socket.socket = self.socket_socket

2583

del self.socket_socket

2584

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

2585

# saved file descriptor.

2586

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

2587

# Replace socket.socket() function with wrapper

2588

socket.socket = socket_wrapper

2589

# The socketserver.TCPServer.__init__ will call

2590

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

2591

# socket_wrapper(), if socketfd was set.

2592

1825

socketserver.TCPServer.__init__(self, server_address,

2593

1826

RequestHandlerClass)

2594

2595

1827

def server_bind(self):

2596

1828

"""This overrides the normal server_bind() function

2597

1829

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

2598

1830

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

2599

global SO_BINDTODEVICE

2600

1831

if self.interface is not None:

2601

1832

if SO_BINDTODEVICE is None:

2602

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

2603

# common enough.

2604

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

2605

SO_BINDTODEVICE = 25

2606

try:

2607

self.socket.setsockopt(

2608

socket.SOL_SOCKET, SO_BINDTODEVICE,

2609

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

2610

except socket.error as error:

2611

if error.errno == errno.EPERM:

2612

logger.error("No permission to bind to"

2613

" interface %s", self.interface)

2614

elif error.errno == errno.ENOPROTOOPT:

2615

logger.error("SO_BINDTODEVICE not available;"

2616

" cannot bind to interface %s",

2617

self.interface)

2618

elif error.errno == errno.ENODEV:

2619

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

2620

" cannot bind", self.interface)

2621

else:

2622

raise

1833

logger.error("SO_BINDTODEVICE does not exist;"

1834

" cannot bind to interface %s",

1835

self.interface)

1836

else:

1837

try:

1838

self.socket.setsockopt(socket.SOL_SOCKET,

1839

SO_BINDTODEVICE,

1840

str(self.interface

1841

+ '\0'))

1842

except socket.error as error:

1843

if error[0] == errno.EPERM:

1844

logger.error("No permission to"

1845

" bind to interface %s",

1846

self.interface)

1847

elif error[0] == errno.ENOPROTOOPT:

1848

logger.error("SO_BINDTODEVICE not available;"

1849

" cannot bind to interface %s",

1850

self.interface)

1851

else:

1852

raise

2623

1853

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

2624

1854

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

2625

if self.server_address[1]:

2626

self.allow_reuse_address = True

2627

1855

if not self.server_address[0]:

2628

1856

if self.address_family == socket.AF_INET6:

2629

any_address = "::" # in6addr_any

1857

any_address = "::" # in6addr_any

2630

1858

else:

2631

any_address = "0.0.0.0" # INADDR_ANY

1859

any_address = socket.INADDR_ANY

2632

1860

self.server_address = (any_address,

2633

1861

self.server_address[1])

2634

1862

elif not self.server_address[1]:

2635

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

1863

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

1864

0)

2636

1865

# if self.interface:

2637

1866

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

2638

1867

# 0, # port

2644

1873

2645

1874

class MandosServer(IPv6_TCPServer):

2646

1875

"""Mandos server.

2647

1876

2648

1877

Attributes:

2649

1878

clients: set of Client objects

2650

1879

gnutls_priority GnuTLS priority string

2651

1880

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

2652

2653

Assumes a GLib.MainLoop event loop.

1881

1882

Assumes a gobject.MainLoop event loop.

2654

1883

"""

2655

2656

1884

def __init__(self, server_address, RequestHandlerClass,

2657

interface=None,

2658

use_ipv6=True,

2659

clients=None,

2660

gnutls_priority=None,

2661

use_dbus=True,

2662

socketfd=None):

1885

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

1886

gnutls_priority=None, use_dbus=True):

2663

1887

self.enabled = False

2664

1888

self.clients = clients

2665

1889

if self.clients is None:

2668

1892

self.gnutls_priority = gnutls_priority

2669

1893

IPv6_TCPServer.__init__(self, server_address,

2670

1894

RequestHandlerClass,

2671

interface=interface,

2672

use_ipv6=use_ipv6,

2673

socketfd=socketfd)

2674

1895

interface = interface,

1896

use_ipv6 = use_ipv6)

2675

1897

def server_activate(self):

2676

1898

if self.enabled:

2677

1899

return socketserver.TCPServer.server_activate(self)

2678

1900

2679

1901

def enable(self):

2680

1902

self.enabled = True

2681

1903

2682

1904

def add_pipe(self, parent_pipe, proc):

2683

1905

# Call "handle_ipc" for both data and EOF events

2684

GLib.io_add_watch(

2685

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

2686

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

2687

functools.partial(self.handle_ipc,

2688

parent_pipe=parent_pipe,

2689

proc=proc))

2690

2691

def handle_ipc(self, source, condition,

2692

parent_pipe=None,

2693

proc=None,

2694

client_object=None):

1906

gobject.io_add_watch(parent_pipe.fileno(),

1907

gobject.IO_IN | gobject.IO_HUP,

1908

functools.partial(self.handle_ipc,

1909

parent_pipe =

1910

parent_pipe,

1911

proc = proc))

1912

1913

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

1914

proc = None, client_object=None):

1915

condition_names = {

1916

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

1917

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

1918

# blocking).

1919

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

1920

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

1921

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

1922

# broken, usually for pipes and

1923

# sockets).

1924

}

1925

conditions_string = ' | '.join(name

1926

for cond, name in

1927

condition_names.iteritems()

1928

if cond & condition)

2695

1929

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

2696

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

1930

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

2697

1931

# Wait for other process to exit

2698

1932

proc.join()

2699

1933

return False

2700

1934

2701

1935

# Read a request from the child

2702

1936

request = parent_pipe.recv()

2703

1937

command = request[0]

2704

1938

2705

1939

if command == 'init':

2706

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

2707

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

2708

address = request[3]

2709

2710

for c in self.clients.values():

2711

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2712

continue

2713

if key_id and c.key_id == key_id:

2714

client = c

2715

break

2716

if fpr and c.fingerprint == fpr:

1940

fpr = request[1]

1941

address = request[2]

1942

1943

for c in self.clients.itervalues():

1944

if c.fingerprint == fpr:

2717

1945

client = c

2718

1946

break

2719

1947

else:

2720

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

2721

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

1948

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

1949

"dress: %s", fpr, address)

2722

1950

if self.use_dbus:

2723

1951

# Emit D-Bus signal

2724

mandos_dbus_service.ClientNotFound(key_id or fpr,

1952

mandos_dbus_service.ClientNotFound(fpr,

2725

1953

address[0])

2726

1954

parent_pipe.send(False)

2727

1955

return False

2728

2729

GLib.io_add_watch(

2730

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

2731

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

2732

functools.partial(self.handle_ipc,

2733

parent_pipe=parent_pipe,

2734

proc=proc,

2735

client_object=client))

1956

1957

gobject.io_add_watch(parent_pipe.fileno(),

1958

gobject.IO_IN | gobject.IO_HUP,

1959

functools.partial(self.handle_ipc,

1960

parent_pipe =

1961

parent_pipe,

1962

proc = proc,

1963

client_object =

1964

client))

2736

1965

parent_pipe.send(True)

2737

1966

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

2738

1967

# same fileno

2741

1970

funcname = request[1]

2742

1971

args = request[2]

2743

1972

kwargs = request[3]

2744

1973

2745

1974

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

2746

1975

funcname)(*args,

2747

**kwargs)))

2748

1976

**kwargs)))

1977

2749

1978

if command == 'getattr':

2750

1979

attrname = request[1]

2751

if isinstance(client_object.__getattribute__(attrname),

2752

collections.Callable):

2753

parent_pipe.send(('function', ))

1980

if callable(client_object.__getattribute__(attrname)):

1981

parent_pipe.send(('function',))

2754

1982

else:

2755

parent_pipe.send((

2756

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

2757

1983

parent_pipe.send(('data', client_object

1984

.__getattribute__(attrname)))

1985

2758

1986

if command == 'setattr':

2759

1987

attrname = request[1]

2760

1988

value = request[2]

2761

1989

setattr(client_object, attrname, value)

2762

1990

2763

1991

return True

2764

1992

2765

1993

2766

def rfc3339_duration_to_delta(duration):

2767

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

2768

2769

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

2770

True

2771

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

2772

True

2773

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

2774

True

2775

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

2776

True

2777

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

2778

True

2779

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

2780

True

2781

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

2782

True

2783

"""

2784

2785

# Parsing an RFC 3339 duration with regular expressions is not

2786

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

2787

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

2788

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

2789

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

2790

# avoid excessive use of external libraries.

2791

2792

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

2793

Token = collections.namedtuple("Token", (

2794

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

2795

# a "group" containing digits

2796

"value", # datetime.timedelta or None

2797

"followers")) # Tokens valid after this token

2798

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

2799

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

2800

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

2801

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

2802

datetime.timedelta(seconds=1),

2803

frozenset((token_end, )))

2804

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

2805

datetime.timedelta(minutes=1),

2806

frozenset((token_second, token_end)))

2807

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

2808

datetime.timedelta(hours=1),

2809

frozenset((token_minute, token_end)))

2810

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

2811

None,

2812

frozenset((token_hour, token_minute,

2813

token_second)))

2814

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

2815

datetime.timedelta(days=1),

2816

frozenset((token_time, token_end)))

2817

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

2818

datetime.timedelta(weeks=4),

2819

frozenset((token_day, token_end)))

2820

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

2821

datetime.timedelta(weeks=52),

2822

frozenset((token_month, token_end)))

2823

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

2824

datetime.timedelta(weeks=1),

2825

frozenset((token_end, )))

2826

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

2827

frozenset((token_year, token_month,

2828

token_day, token_time,

2829

token_week)))

2830

# Define starting values:

2831

# Value so far

2832

value = datetime.timedelta()

2833

found_token = None

2834

# Following valid tokens

2835

followers = frozenset((token_duration, ))

2836

# String left to parse

2837

s = duration

2838

# Loop until end token is found

2839

while found_token is not token_end:

2840

# Search for any currently valid tokens

2841

for token in followers:

2842

match = token.regexp.match(s)

2843

if match is not None:

2844

# Token found

2845

if token.value is not None:

2846

# Value found, parse digits

2847

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

2848

# Add to value so far

2849

value += factor * token.value

2850

# Strip token from string

2851

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

2852

# Go to found token

2853

found_token = token

2854

# Set valid next tokens

2855

followers = found_token.followers

2856

break

2857

else:

2858

# No currently valid tokens were found

2859

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

2860

.format(duration))

2861

# End token found

2862

return value

2863

2864

2865

1994

def string_to_delta(interval):

2866

1995

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

2867

2868

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

2869

True

2870

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

2871

True

2872

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

2873

True

2874

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

2875

True

2876

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

2877

True

2878

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

2879

True

1996

1997

>>> string_to_delta('7d')

1998

datetime.timedelta(7)

1999

>>> string_to_delta('60s')

2000

datetime.timedelta(0, 60)

2001

>>> string_to_delta('60m')

2002

datetime.timedelta(0, 3600)

2003

>>> string_to_delta('24h')

2004

datetime.timedelta(1)

2005

>>> string_to_delta('1w')

2006

datetime.timedelta(7)

2007

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

2008

datetime.timedelta(0, 330)

2880

2009

"""

2881

2882

try:

2883

return rfc3339_duration_to_delta(interval)

2884

except ValueError:

2885

pass

2886

2887

2010

timevalue = datetime.timedelta(0)

2888

2011

for s in interval.split():

2889

2012

try:

2890

suffix = s[-1]

2013

suffix = unicode(s[-1])

2891

2014

value = int(s[:-1])

2892

2015

if suffix == "d":

2893

2016

delta = datetime.timedelta(value)

2900

2023

elif suffix == "w":

2901

2024

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

2902

2025

else:

2903

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

2904

except IndexError as e:

2026

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

2027

except (ValueError, IndexError) as e:

2905

2028

raise ValueError(*(e.args))

2906

2029

timevalue += delta

2907

2030

return timevalue

2908

2031

2909

2032

2910

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

2033

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

2911

2034

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

2912

2035

2913

2036

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

2914

2037

if os.fork():

2915

2038

sys.exit()

2923

2046

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

2924

2047

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

2925

2048

raise OSError(errno.ENODEV,

2926

"{} not a character device"

2927

.format(os.devnull))

2049

"%s not a character device"

2050

% os.devnull)

2928

2051

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

2929

2052

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

2930

2053

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

2933

2056

2934

2057

2935

2058

def main():

2936

2059

2937

2060

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

2938

2061

# Parsing of options, both command line and config file

2939

2062

2940

2063

parser = argparse.ArgumentParser()

2941

2064

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

2942

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

2065

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

2943

2066

help="show version number and exit")

2944

2067

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

2945

2068

help="Bind to interface IF")

2951

2074

help="Run self-test")

2952

2075

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

2953

2076

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

2954

" to terminal", default=None)

2077

" to terminal")

2955

2078

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

2956

2079

help="Debug level for stdout output")

2957

2080

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

2964

2087

" files")

2965

2088

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

2966

2089

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

2967

" system bus interface", default=None)

2090

" system bus interface")

2968

2091

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

2969

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

2970

default=None)

2092

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

2971

2093

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

2972

2094

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

2973

" state", default=None)

2974

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

2975

help="Specify a file descriptor to a network"

2976

" socket to use instead of creating one")

2095

" state")

2977

2096

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

2978

2097

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

2979

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

2980

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

2981

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

2982

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

2983

default=None)

2984

2098

2985

2099

options = parser.parse_args()

2986

2100

2101

if options.check:

2102

import doctest

2103

doctest.testmod()

2104

sys.exit()

2105

2987

2106

# Default values for config file for server-global settings

2988

if gnutls.has_rawpk:

2989

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

2990

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

2991

else:

2992

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

2993

":+SIGN-DSA-SHA256")

2994

server_defaults = {"interface": "",

2995

"address": "",

2996

"port": "",

2997

"debug": "False",

2998

"priority": priority,

2999

"servicename": "Mandos",

3000

"use_dbus": "True",

3001

"use_ipv6": "True",

3002

"debuglevel": "",

3003

"restore": "True",

3004

"socket": "",

3005

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

3006

"foreground": "False",

3007

"zeroconf": "True",

3008

}

3009

del priority

3010

2107

server_defaults = { "interface": "",

2108

"address": "",

2109

"port": "",

2110

"debug": "False",

2111

"priority":

2112

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

2113

"servicename": "Mandos",

2114

"use_dbus": "True",

2115

"use_ipv6": "True",

2116

"debuglevel": "",

2117

"restore": "True",

2118

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

2119

}

2120

3011

2121

# Parse config file for server-global settings

3012

server_config = configparser.ConfigParser(server_defaults)

2122

server_config = configparser.SafeConfigParser(server_defaults)

3013

2123

del server_defaults

3014

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

3015

# Convert the ConfigParser object to a dict

2124

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

2125

"mandos.conf"))

2126

# Convert the SafeConfigParser object to a dict

3016

2127

server_settings = server_config.defaults()

3017

2128

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

3018

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

3019

"foreground", "zeroconf"):

2129

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

3020

2130

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

3021

2131

option)

3022

2132

if server_settings["port"]:

3023

2133

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

3024

2134

"port")

3025

if server_settings["socket"]:

3026

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

3027

"socket")

3028

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

3029

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

3030

# happen with a supplied network socket.

3031

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

3032

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

3033

["socket"])

3034

2135

del server_config

3035

2136

3036

2137

# Override the settings from the config file with command line

3037

2138

# options, if set.

3038

2139

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

3039

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

3040

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

3041

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

2140

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

2141

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

2142

"statedir"):

3042

2143

value = getattr(options, option)

3043

2144

if value is not None:

3044

2145

server_settings[option] = value

3045

2146

del options

3046

2147

# Force all strings to be unicode

3047

2148

for option in server_settings.keys():

3048

if isinstance(server_settings[option], bytes):

3049

server_settings[option] = (server_settings[option]

3050

.decode("utf-8"))

3051

# Force all boolean options to be boolean

3052

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

3053

"foreground", "zeroconf"):

3054

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

3055

# Debug implies foreground

3056

if server_settings["debug"]:

3057

server_settings["foreground"] = True

2149

if type(server_settings[option]) is str:

2150

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

3058

2151

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

3059

2152

3060

2153

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

3061

3062

if (not server_settings["zeroconf"]

3063

and not (server_settings["port"]

3064

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

3065

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

3066

2154

3067

2155

# For convenience

3068

2156

debug = server_settings["debug"]

3069

2157

debuglevel = server_settings["debuglevel"]

3071

2159

use_ipv6 = server_settings["use_ipv6"]

3072

2160

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

3073

2161

stored_state_file)

3074

foreground = server_settings["foreground"]

3075

zeroconf = server_settings["zeroconf"]

3076

2162

3077

2163

if debug:

3078

2164

initlogger(debug, logging.DEBUG)

3079

2165

else:

3082

2168

else:

3083

2169

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

3084

2170

initlogger(debug, level)

3085

2171

3086

2172

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

3087

syslogger.setFormatter(

3088

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

3089

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

3090

server_settings["servicename"])))

3091

2173

syslogger.setFormatter(logging.Formatter

2174

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

2175

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

2176

% server_settings["servicename"]))

2177

3092

2178

# Parse config file with clients

3093

client_config = configparser.ConfigParser(Client.client_defaults)

2179

client_config = configparser.SafeConfigParser(Client

2180

.client_defaults)

3094

2181

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

3095

2182

"clients.conf"))

3096

2183

3097

2184

global mandos_dbus_service

3098

2185

mandos_dbus_service = None

3099

3100

socketfd = None

3101

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

3102

socketfd = server_settings["socket"]

3103

tcp_server = MandosServer(

3104

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

3105

ClientHandler,

3106

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

3107

use_ipv6=use_ipv6,

3108

gnutls_priority=server_settings["priority"],

3109

use_dbus=use_dbus,

3110

socketfd=socketfd)

3111

if not foreground:

3112

pidfilename = "/run/mandos.pid"

3113

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

3114

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

3115

pidfile = None

3116

try:

3117

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

3118

except IOError as e:

3119

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

3120

exc_info=e)

3121

3122

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

3123

("mandos", "mandos"),

3124

("nobody", "nogroup")):

3125

try:

3126

uid = pwd.getpwnam(name).pw_uid

3127

gid = pwd.getpwnam(group).pw_gid

3128

break

2186

2187

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

2188

server_settings["port"]),

2189

ClientHandler,

2190

interface=(server_settings["interface"]

2191

or None),

2192

use_ipv6=use_ipv6,

2193

gnutls_priority=

2194

server_settings["priority"],

2195

use_dbus=use_dbus)

2196

if not debug:

2197

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

2198

try:

2199

pidfile = open(pidfilename, "w")

2200

except IOError:

2201

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

2202

2203

try:

2204

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

2205

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

2206

except KeyError:

2207

try:

2208

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

2209

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

3129

2210

except KeyError:

3130

continue

3131

else:

3132

uid = 65534

3133

gid = 65534

2211

try:

2212

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

2213

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

2214

except KeyError:

2215

uid = 65534

2216

gid = 65534

3134

2217

try:

3135

2218

os.setgid(gid)

3136

2219

os.setuid(uid)

3137

if debug:

3138

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

3139

gid))

3140

2220

except OSError as error:

3141

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

3142

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

3143

if error.errno != errno.EPERM:

3144

raise

3145

2221

if error[0] != errno.EPERM:

2222

raise error

2223

3146

2224

if debug:

3147

2225

# Enable all possible GnuTLS debugging

3148

2226

3149

2227

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

3150

2228

# - GnuTLS manual

3151

gnutls.global_set_log_level(11)

3152

3153

@gnutls.log_func

2229

gnutls.library.functions.gnutls_global_set_log_level(11)

2230

2231

@gnutls.library.types.gnutls_log_func

3154

2232

def debug_gnutls(level, string):

3155

2233

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

3156

3157

gnutls.global_set_log_function(debug_gnutls)

3158

2234

2235

(gnutls.library.functions

2236

.gnutls_global_set_log_function(debug_gnutls))

2237

3159

2238

# Redirect stdin so all checkers get /dev/null

3160

2239

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

3161

2240

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

3162

2241

if null > 2:

3163

2242

os.close(null)

3164

2243

3165

2244

# Need to fork before connecting to D-Bus

3166

if not foreground:

2245

if not debug:

3167

2246

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

3168

2247

daemon()

3169

3170

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

3171

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

3172

# need to inform GLib that threads will be used.

3173

GLib.threads_init()

3174

2248

2249

gobject.threads_init()

2250

3175

2251

global main_loop

3176

2252

# From the Avahi example code

3177

2253

DBusGMainLoop(set_as_default=True)

3178

main_loop = GLib.MainLoop()

2254

main_loop = gobject.MainLoop()

3179

2255

bus = dbus.SystemBus()

3180

2256

# End of Avahi example code

3181

2257

if use_dbus:

3182

2258

try:

3183

2259

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

3184

bus,

3185

do_not_queue=True)

3186

old_bus_name = dbus.service.BusName(

3187

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

3188

do_not_queue=True)

3189

except dbus.exceptions.DBusException as e:

3190

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

2260

bus, do_not_queue=True)

2261

old_bus_name = (dbus.service.BusName

2262

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

2263

do_not_queue=True))

2264

except dbus.exceptions.NameExistsException as e:

2265

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

3191

2266

use_dbus = False

3192

2267

server_settings["use_dbus"] = False

3193

2268

tcp_server.use_dbus = False

3194

if zeroconf:

3195

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3196

service = AvahiServiceToSyslog(

3197

name=server_settings["servicename"],

3198

servicetype="_mandos._tcp",

3199

protocol=protocol,

3200

bus=bus)

3201

if server_settings["interface"]:

3202

service.interface = if_nametoindex(

3203

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

3204

2269

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2270

service = AvahiServiceToSyslog(name =

2271

server_settings["servicename"],

2272

servicetype = "_mandos._tcp",

2273

protocol = protocol, bus = bus)

2274

if server_settings["interface"]:

2275

service.interface = (if_nametoindex

2276

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

2277

3205

2278

global multiprocessing_manager

3206

2279

multiprocessing_manager = multiprocessing.Manager()

3207

2280

3208

2281

client_class = Client

3209

2282

if use_dbus:

3210

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

3211

2283

client_class = functools.partial(ClientDBusTransitional,

2284

bus = bus)

2285

3212

2286

client_settings = Client.config_parser(client_config)

3213

2287

old_client_settings = {}

3214

2288

clients_data = {}

3215

3216

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

3217

global wnull

3218

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

3219

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

3220

# mode

3221

if debug or not foreground:

3222

wnull.close()

3223

2289

3224

2290

# Get client data and settings from last running state.

3225

2291

if server_settings["restore"]:

3226

2292

try:

3227

2293

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

3228

if sys.version_info.major == 2:

3229

clients_data, old_client_settings = pickle.load(

3230

stored_state)

3231

else:

3232

bytes_clients_data, bytes_old_client_settings = (

3233

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

3234

# Fix bytes to strings

3235

# clients_data

3236

# .keys()

3237

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

3238

if isinstance(key, bytes)

3239

else key): value

3240

for key, value in

3241

bytes_clients_data.items()}

3242

del bytes_clients_data

3243

for key in clients_data:

3244

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

3245

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

3246

for k, v in

3247

clients_data[key].items()}

3248

clients_data[key] = value

3249

# .client_structure

3250

value["client_structure"] = [

3251

(s.decode("utf-8")

3252

if isinstance(s, bytes)

3253

else s) for s in

3254

value["client_structure"]]

3255

# .name, .host, and .checker_command

3256

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

3257

if isinstance(value[k], bytes):

3258

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

3259

if "key_id" not in value:

3260

value["key_id"] = ""

3261

elif "fingerprint" not in value:

3262

value["fingerprint"] = ""

3263

# old_client_settings

3264

# .keys()

3265

old_client_settings = {

3266

(key.decode("utf-8")

3267

if isinstance(key, bytes)

3268

else key): value

3269

for key, value in

3270

bytes_old_client_settings.items()}

3271

del bytes_old_client_settings

3272

# .host and .checker_command

3273

for value in old_client_settings.values():

3274

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

3275

if isinstance(value[attribute], bytes):

3276

value[attribute] = (value[attribute]

3277

.decode("utf-8"))

2294

clients_data, old_client_settings = (pickle.load

2295

(stored_state))

3278

2296

os.remove(stored_state_path)

3279

2297

except IOError as e:

3280

if e.errno == errno.ENOENT:

3281

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

3282

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

3283

else:

3284

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

3285

exc_info=e)

2298

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

2299

.format(e))

2300

if e.errno != errno.ENOENT:

3286

2301

raise

3287

2302

except EOFError as e:

3288

2303

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

3289

"EOFError:",

3290

exc_info=e)

3291

2304

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

2305

3292

2306

with PGPEngine() as pgp:

3293

for client_name, client in clients_data.items():

3294

# Skip removed clients

3295

if client_name not in client_settings:

3296

continue

3297

2307

for client_name, client in clients_data.iteritems():

3298

2308

# Decide which value to use after restoring saved state.

3299

2309

# We have three different values: Old config file,

3300

2310

# new config file, and saved state.

3305

2315

# For each value in new config, check if it

3306

2316

# differs from the old config value (Except for

3307

2317

# the "secret" attribute)

3308

if (name != "secret"

3309

and (value !=

3310

old_client_settings[client_name][name])):

2318

if (name != "secret" and

2319

value != old_client_settings[client_name]

2320

[name]):

3311

2321

client[name] = value

3312

2322

except KeyError:

3313

2323

pass

3314

2324

3315

2325

# Clients who has passed its expire date can still be

3316

# enabled if its last checker was successful. A Client

2326

# enabled if its last checker was successful. Clients

3317

2327

# whose checker succeeded before we stored its state is

3318

2328

# assumed to have successfully run all checkers during

3319

2329

# downtime.

3321

2331

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

3322

2332

if not client["last_checked_ok"]:

3323

2333

logger.warning(

3324

"disabling client {} - Client never "

3325

"performed a successful checker".format(

3326

client_name))

2334

"disabling client {0} - Client never "

2335

"performed a successful checker"

2336

.format(client_name))

3327

2337

client["enabled"] = False

3328

2338

elif client["last_checker_status"] != 0:

3329

2339

logger.warning(

3330

"disabling client {} - Client last"

3331

" checker failed with error code"

3332

" {}".format(

3333

client_name,

3334

client["last_checker_status"]))

2340

"disabling client {0} - Client "

2341

"last checker failed with error code {1}"

2342

.format(client_name,

2343

client["last_checker_status"]))

3335

2344

client["enabled"] = False

3336

2345

else:

3337

client["expires"] = (

3338

datetime.datetime.utcnow()

3339

+ client["timeout"])

2346

client["expires"] = (datetime.datetime

2347

.utcnow()

2348

+ client["timeout"])

3340

2349

logger.debug("Last checker succeeded,"

3341

" keeping {} enabled".format(

3342

client_name))

2350

" keeping {0} enabled"

2351

.format(client_name))

3343

2352

try:

3344

client["secret"] = pgp.decrypt(

3345

client["encrypted_secret"],

3346

client_settings[client_name]["secret"])

2353

client["secret"] = (

2354

pgp.decrypt(client["encrypted_secret"],

2355

client_settings[client_name]

2356

["secret"]))

3347

2357

except PGPError:

3348

2358

# If decryption fails, we use secret from new settings

3349

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

3350

client_name))

3351

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

3352

["secret"])

2359

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

2360

.format(client_name))

2361

client["secret"] = (

2362

client_settings[client_name]["secret"])

3353

2363

2364

3354

2365

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

3355

2366

for client_name in (set(old_client_settings)

3356

2367

- set(client_settings)):

3360

2371

clients_data[client_name] = client_settings[client_name]

3361

2372

3362

2373

# Create all client objects

3363

for client_name, client in clients_data.items():

2374

for client_name, client in clients_data.iteritems():

3364

2375

tcp_server.clients[client_name] = client_class(

3365

name=client_name,

3366

settings=client,

3367

server_settings=server_settings)

3368

2376

name = client_name, settings = client)

2377

3369

2378

if not tcp_server.clients:

3370

2379

logger.warning("No clients defined")

3371

3372

if not foreground:

3373

if pidfile is not None:

3374

pid = os.getpid()

3375

try:

3376

with pidfile:

3377

print(pid, file=pidfile)

3378

except IOError:

3379

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

3380

pidfilename, pid)

3381

del pidfile

2380

2381

if not debug:

2382

try:

2383

with pidfile:

2384

pid = os.getpid()

2385

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

2386

del pidfile

2387

except IOError:

2388

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

2389

pidfilename, pid)

2390

except NameError:

2391

# "pidfile" was never created

2392

pass

3382

2393

del pidfilename

3383

3384

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

3385

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3386

lambda: main_loop.quit() and False)

3387

2394

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

2395

2396

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

2397

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

2398

3388

2399

if use_dbus:

3389

3390

@alternate_dbus_interfaces(

3391

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

3392

class MandosDBusService(DBusObjectWithObjectManager):

2400

class MandosDBusService(DBusObjectWithProperties):

3393

2401

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

3394

3395

2402

def __init__(self):

3396

2403

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

3397

3398

2404

_interface = "se.recompile.Mandos"

3399

2405

2406

@dbus_interface_annotations(_interface)

2407

def _foo(self):

2408

return { "org.freedesktop.DBus.Property"

2409

".EmitsChangedSignal":

2410

"false"}

2411

3400

2412

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

3401

2413

def ClientAdded(self, objpath):

3402

2414

"D-Bus signal"

3403

2415

pass

3404

2416

3405

2417

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

3406

def ClientNotFound(self, key_id, address):

2418

def ClientNotFound(self, fingerprint, address):

3407

2419

"D-Bus signal"

3408

2420

pass

3409

3410

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

3411

"true"})

2421

3412

2422

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

3413

2423

def ClientRemoved(self, objpath, name):

3414

2424

"D-Bus signal"

3415

2425

pass

3416

3417

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

3418

"true"})

2426

3419

2427

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

3420

2428

def GetAllClients(self):

3421

2429

"D-Bus method"

3422

return dbus.Array(c.dbus_object_path for c in

3423

tcp_server.clients.values())

3424

3425

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

3426

"true"})

2430

return dbus.Array(c.dbus_object_path

2431

for c in

2432

tcp_server.clients.itervalues())

2433

3427

2434

@dbus.service.method(_interface,

3428

2435

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

3429

2436

def GetAllClientsWithProperties(self):

3430

2437

"D-Bus method"

3431

2438

return dbus.Dictionary(

3432

{c.dbus_object_path: c.GetAll(

3433

"se.recompile.Mandos.Client")

3434

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

2439

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

2440

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

3435

2441

signature="oa{sv}")

3436

2442

3437

2443

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

3438

2444

def RemoveClient(self, object_path):

3439

2445

"D-Bus method"

3440

for c in tcp_server.clients.values():

2446

for c in tcp_server.clients.itervalues():

3441

2447

if c.dbus_object_path == object_path:

3442

2448

del tcp_server.clients[c.name]

3443

2449

c.remove_from_connection()

3444

# Don't signal the disabling

2450

# Don't signal anything except ClientRemoved

3445

2451

c.disable(quiet=True)

3446

# Emit D-Bus signal for removal

3447

self.client_removed_signal(c)

2452

# Emit D-Bus signal

2453

self.ClientRemoved(object_path, c.name)

3448

2454

return

3449

2455

raise KeyError(object_path)

3450

2456

3451

2457

del _interface

3452

3453

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3454

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

3455

def GetManagedObjects(self):

3456

"""D-Bus method"""

3457

return dbus.Dictionary(

3458

{client.dbus_object_path:

3459

dbus.Dictionary(

3460

{interface: client.GetAll(interface)

3461

for interface in

3462

client._get_all_interface_names()})

3463

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

3464

3465

def client_added_signal(self, client):

3466

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

3467

if use_dbus:

3468

# New standard signal

3469

self.InterfacesAdded(

3470

client.dbus_object_path,

3471

dbus.Dictionary(

3472

{interface: client.GetAll(interface)

3473

for interface in

3474

client._get_all_interface_names()}))

3475

# Old signal

3476

self.ClientAdded(client.dbus_object_path)

3477

3478

def client_removed_signal(self, client):

3479

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

3480

if use_dbus:

3481

# New standard signal

3482

self.InterfacesRemoved(

3483

client.dbus_object_path,

3484

client._get_all_interface_names())

3485

# Old signal

3486

self.ClientRemoved(client.dbus_object_path,

3487

client.name)

3488

3489

mandos_dbus_service = MandosDBusService()

3490

3491

# Save modules to variables to exempt the modules from being

3492

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

3493

mp = multiprocessing

3494

wn = wnull

3495

2458

2459

class MandosDBusServiceTransitional(MandosDBusService):

2460

__metaclass__ = AlternateDBusNamesMetaclass

2461

mandos_dbus_service = MandosDBusServiceTransitional()

2462

3496

2463

def cleanup():

3497

2464

"Cleanup function; run on exit"

3498

if zeroconf:

3499

service.cleanup()

3500

3501

mp.active_children()

3502

wn.close()

2465

service.cleanup()

2466

2467

multiprocessing.active_children()

3503

2468

if not (tcp_server.clients or client_settings):

3504

2469

return

3505

2470

3506

2471

# Store client before exiting. Secrets are encrypted with key

3507

2472

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

3508

2473

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

3509

2474

clients = {}

3510

2475

with PGPEngine() as pgp:

3511

for client in tcp_server.clients.values():

2476

for client in tcp_server.clients.itervalues():

3512

2477

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

3513

2478

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

3514

2479

key)

3515

2480

client_dict = {}

3516

2481

3517

2482

# A list of attributes that can not be pickled

3518

2483

# + secret.

3519

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

3520

"checker", "server_settings"}

3521

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

3522

.Object):

2484

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

2485

"checker"))

2486

for name, typ in (inspect.getmembers

2487

(dbus.service.Object)):

3523

2488

exclude.add(name)

3524

2489

3525

2490

client_dict["encrypted_secret"] = (client

3526

2491

.encrypted_secret)

3527

2492

for attr in client.client_structure:

3528

2493

if attr not in exclude:

3529

2494

client_dict[attr] = getattr(client, attr)

3530

2495

3531

2496

clients[client.name] = client_dict

3532

2497

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

3533

2498

3534

2499

try:

3535

with tempfile.NamedTemporaryFile(

3536

mode='wb',

3537

suffix=".pickle",

3538

prefix='clients-',

3539

dir=os.path.dirname(stored_state_path),

3540

delete=False) as stored_state:

3541

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

3542

protocol=2)

3543

tempname = stored_state.name

2500

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

2501

prefix="clients-",

2502

dir=os.path.dirname

2503

(stored_state_path))

2504

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

2505

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

3544

2506

os.rename(tempname, stored_state_path)

3545

2507

except (IOError, OSError) as e:

2508

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

2509

.format(e))

3546

2510

if not debug:

3547

2511

try:

3548

2512

os.remove(tempname)

3549

2513

except NameError:

3550

2514

pass

3551

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

3552

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

3553

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

3554

else:

3555

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

3556

exc_info=e)

3557

raise

3558

2515

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

2516

errno.EEXIST)):

2517

raise e

2518

3559

2519

# Delete all clients, and settings from config

3560

2520

while tcp_server.clients:

3561

2521

name, client = tcp_server.clients.popitem()

3562

2522

if use_dbus:

3563

2523

client.remove_from_connection()

3564

# Don't signal the disabling

2524

# Don't signal anything except ClientRemoved

3565

2525

client.disable(quiet=True)

3566

# Emit D-Bus signal for removal

3567

2526

if use_dbus:

3568

mandos_dbus_service.client_removed_signal(client)

2527

# Emit D-Bus signal

2528

mandos_dbus_service.ClientRemoved(client

2529

.dbus_object_path,

2530

client.name)

3569

2531

client_settings.clear()

3570

2532

3571

2533

atexit.register(cleanup)

3572

3573

for client in tcp_server.clients.values():

2534

2535

for client in tcp_server.clients.itervalues():

3574

2536

if use_dbus:

3575

# Emit D-Bus signal for adding

3576

mandos_dbus_service.client_added_signal(client)

2537

# Emit D-Bus signal

2538

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3577

2539

# Need to initiate checking of clients

3578

2540

if client.enabled:

3579

2541

client.init_checker()

3580

2542

3581

2543

tcp_server.enable()

3582

2544

tcp_server.server_activate()

3583

2545

3584

2546

# Find out what port we got

3585

if zeroconf:

3586

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

2547

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

3587

2548

if use_ipv6:

3588

2549

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

3589

" flowinfo %d, scope_id %d",

3590

*tcp_server.socket.getsockname())

2550

" flowinfo %d, scope_id %d"

2551

% tcp_server.socket.getsockname())

3591

2552

else: # IPv4

3592

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

3593

*tcp_server.socket.getsockname())

3594

3595

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

3596

2553

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

2554

% tcp_server.socket.getsockname())

2555

2556

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

2557

3597

2558

try:

3598

if zeroconf:

3599

# From the Avahi example code

3600

try:

3601

service.activate()

3602

except dbus.exceptions.DBusException as error:

3603

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

3604

cleanup()

3605

sys.exit(1)

3606

# End of Avahi example code

3607

3608

GLib.io_add_watch(

3609

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

3610

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3611

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

3612

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

3613

2559

# From the Avahi example code

2560

try:

2561

service.activate()

2562

except dbus.exceptions.DBusException as error:

2563

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

2564

cleanup()

2565

sys.exit(1)

2566

# End of Avahi example code

2567

2568

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

2569

lambda *args, **kwargs:

2570

(tcp_server.handle_request

2571

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

2572

3614

2573

logger.debug("Starting main loop")

3615

2574

main_loop.run()

3616

2575

except AvahiError as error:

3617

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

2576

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

3618

2577

cleanup()

3619

2578

sys.exit(1)

3620

2579

except KeyboardInterrupt:

3625

2584

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

3626

2585

cleanup()

3627

2586

3628

3629

def should_only_run_tests():

3630

parser = argparse.ArgumentParser(add_help=False)

3631

parser.add_argument("--check", action='store_true')

3632

args, unknown_args = parser.parse_known_args()

3633

run_tests = args.check

3634

if run_tests:

3635

# Remove --check argument from sys.argv

3636

sys.argv[1:] = unknown_args

3637

return run_tests

3638

3639

# Add all tests from doctest strings

3640

def load_tests(loader, tests, none):

3641

import doctest

3642

tests.addTests(doctest.DocTestSuite())

3643

return tests

3644

3645

2587

if __name__ == '__main__':

3646

try:

3647

if should_only_run_tests():

3648

# Call using ./mandos --check [--verbose]

3649

unittest.main()

3650

else:

3651

main()

3652

finally:

3653

logging.shutdown()

2588

main()