/mandos/trunk : revision 723.1.7

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

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

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

72

84

73

import dbus

85

74

import dbus.service

86

import gi

87

from gi.repository import GLib

75

import gobject

76

import avahi

88

77

from dbus.mainloop.glib import DBusGMainLoop

89

78

import ctypes

90

79

import ctypes.util

91

80

import xml.dom.minidom

92

81

import inspect

93

82

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

147

92

stored_state_file = "clients.pickle"

148

93

149

94

logger = logging.getLogger()

150

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

151

95

syslogger = None

152

96

153

97

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

156

101

except (OSError, AttributeError):

157

158

102

def if_nametoindex(interface):

159

103

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

160

104

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

161

105

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

162

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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]

165

111

return interface_index

166

112

167

113

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

114

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

185

115

"""init logger and add loglevel"""

186

116

187

117

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

191

122

syslogger.setFormatter(logging.Formatter

192

123

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

193

124

' %(message)s'))

194

125

logger.addHandler(syslogger)

195

126

196

127

if debug:

197

128

console = logging.StreamHandler()

198

129

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

208

139

pass

209

140

210

141

211

class PGPEngine:

142

class PGPEngine(object):

212

143

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

213

214

144

def __init__(self):

215

145

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

146

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

147

'--home', self.tempdir,

229

148

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

149

'--quiet',

150

'--no-use-agent']

151

235

152

def __enter__(self):

236

153

return self

237

154

238

155

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

239

156

self._cleanup()

240

157

return False

241

158

242

159

def __del__(self):

243

160

self._cleanup()

244

161

245

162

def _cleanup(self):

246

163

if self.tempdir is not None:

247

164

# Delete contents of tempdir

248

165

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

249

topdown=False):

166

topdown = False):

250

167

for filename in files:

251

168

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

252

169

for dirname in dirs:

254

171

# Remove tempdir

255

172

os.rmdir(self.tempdir)

256

173

self.tempdir = None

257

174

258

175

def password_encode(self, password):

259

176

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

260

177

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

265

182

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

266

183

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

267

184

return encoded

268

185

269

186

def encrypt(self, data, password):

270

187

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

273

190

passfile.write(passphrase)

274

191

passfile.flush()

275

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

192

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

276

193

'--passphrase-file',

277

194

passfile.name]

278

195

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

283

200

if proc.returncode != 0:

284

201

raise PGPError(err)

285

202

return ciphertext

286

203

287

204

def decrypt(self, data, password):

288

205

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

291

208

passfile.write(passphrase)

292

209

passfile.flush()

293

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

210

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

294

211

'--passphrase-file',

295

212

passfile.name]

296

213

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

301

219

if proc.returncode != 0:

302

220

raise PGPError(err)

303

221

return decrypted_plaintext

304

222

305

223

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

224

class AvahiError(Exception):

333

225

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

334

226

self.value = value

335

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

336

**kwargs)

337

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

338

230

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

277

278

def rename(self):

395

279

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

396

280

if self.rename_count >= self.max_renames:

397

281

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

398

282

" after %i retries, exiting.",

399

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

404

287

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

405

288

self.name)

406

if remove:

407

self.remove()

289

self.remove()

408

290

try:

409

291

self.add()

410

292

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

420

298

def remove(self):

421

299

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

422

300

if self.entry_group_state_changed_match is not None:

424

302

self.entry_group_state_changed_match = None

425

303

if self.group is not None:

426

304

self.group.Reset()

427

305

428

306

def add(self):

429

307

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

430

308

self.remove()

447

325

dbus.UInt16(self.port),

448

326

avahi.string_array_to_txt_array(self.TXT))

449

327

self.group.Commit()

450

328

451

329

def entry_group_state_changed(self, state, error):

452

330

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

453

331

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

454

332

455

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

334

logger.debug("Zeroconf service established.")

457

335

elif state == avahi.ENTRY_GROUP_COLLISION:

459

337

self.rename()

460

338

elif state == avahi.ENTRY_GROUP_FAILURE:

461

339

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

462

str(error))

463

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

464

340

unicode(error))

341

raise AvahiGroupError("State changed: {!s}"

342

.format(error))

343

465

344

def cleanup(self):

466

345

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

467

346

if self.group is not None:

472

351

pass

473

352

self.group = None

474

353

self.remove()

475

354

476

355

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

477

356

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

478

357

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

485

365

if state in bad_states:

486

366

if bad_states[state] is not None:

487

367

if error is None:

490

370

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

491

371

self.cleanup()

492

372

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

373

self.add()

505

374

else:

506

375

if error is None:

507

376

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

508

377

else:

509

378

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

510

379

511

380

def activate(self):

512

381

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

513

382

if self.server is None:

517

386

follow_name_owner_changes=True),

518

387

avahi.DBUS_INTERFACE_SERVER)

519

388

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

389

self.server_state_changed)

521

390

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

522

391

523

392

524

393

class AvahiServiceToSyslog(AvahiService):

525

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

394

def rename(self):

526

395

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

527

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

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

531

401

return ret

532

402

533

403

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

('size', ctypes.c_uint)]

578

579

class openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code)

597

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

598

message, *args)

599

600

class CertificateSecurityError(Error):

601

pass

602

603

# Classes

604

class Credentials:

605

def __init__(self):

606

self._c_object = gnutls.certificate_credentials_t()

607

gnutls.certificate_allocate_credentials(

608

ctypes.byref(self._c_object))

609

self.type = gnutls.CRD_CERTIFICATE

610

611

def __del__(self):

612

gnutls.certificate_free_credentials(self._c_object)

613

614

class ClientSession:

615

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

616

self._c_object = gnutls.session_t()

617

gnutls_flags = gnutls.CLIENT

618

if gnutls.check_version(b"3.5.6"):

619

gnutls_flags |= gnutls.NO_TICKETS

620

if gnutls.has_rawpk:

621

gnutls_flags |= gnutls.ENABLE_RAWPK

622

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

623

del gnutls_flags

624

gnutls.set_default_priority(self._c_object)

625

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

626

gnutls.handshake_set_private_extensions(self._c_object,

627

True)

628

self.socket = socket

629

if credentials is None:

630

credentials = gnutls.Credentials()

631

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

632

ctypes.cast(credentials._c_object,

633

ctypes.c_void_p))

634

self.credentials = credentials

635

636

def __del__(self):

637

gnutls.deinit(self._c_object)

638

639

def handshake(self):

640

return gnutls.handshake(self._c_object)

641

642

def send(self, data):

643

data = bytes(data)

644

data_len = len(data)

645

while data_len > 0:

646

data_len -= gnutls.record_send(self._c_object,

647

data[-data_len:],

648

data_len)

649

650

def bye(self):

651

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

652

653

# Error handling functions

654

def _error_code(result):

655

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

656

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

657

if result >= 0:

658

return result

659

if result == gnutls.E_NO_CERTIFICATE_FOUND:

660

raise gnutls.CertificateSecurityError(code=result)

661

raise gnutls.Error(code=result)

662

663

def _retry_on_error(result, func, arguments):

664

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

665

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

666

while result < 0:

667

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

668

return _error_code(result)

669

result = func(*arguments)

670

return result

671

672

# Unless otherwise indicated, the function declarations below are

673

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

674

675

# Functions

676

priority_set_direct = _library.gnutls_priority_set_direct

677

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

678

ctypes.POINTER(ctypes.c_char_p)]

679

priority_set_direct.restype = _error_code

680

681

init = _library.gnutls_init

682

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

683

init.restype = _error_code

684

685

set_default_priority = _library.gnutls_set_default_priority

686

set_default_priority.argtypes = [session_t]

687

set_default_priority.restype = _error_code

688

689

record_send = _library.gnutls_record_send

690

record_send.argtypes = [session_t, ctypes.c_void_p,

691

ctypes.c_size_t]

692

record_send.restype = ctypes.c_ssize_t

693

record_send.errcheck = _retry_on_error

694

695

certificate_allocate_credentials = (

696

_library.gnutls_certificate_allocate_credentials)

697

certificate_allocate_credentials.argtypes = [

698

ctypes.POINTER(certificate_credentials_t)]

699

certificate_allocate_credentials.restype = _error_code

700

701

certificate_free_credentials = (

702

_library.gnutls_certificate_free_credentials)

703

certificate_free_credentials.argtypes = [

704

certificate_credentials_t]

705

certificate_free_credentials.restype = None

706

707

handshake_set_private_extensions = (

708

_library.gnutls_handshake_set_private_extensions)

709

handshake_set_private_extensions.argtypes = [session_t,

710

ctypes.c_int]

711

handshake_set_private_extensions.restype = None

712

713

credentials_set = _library.gnutls_credentials_set

714

credentials_set.argtypes = [session_t, credentials_type_t,

715

ctypes.c_void_p]

716

credentials_set.restype = _error_code

717

718

strerror = _library.gnutls_strerror

719

strerror.argtypes = [ctypes.c_int]

720

strerror.restype = ctypes.c_char_p

721

722

certificate_type_get = _library.gnutls_certificate_type_get

723

certificate_type_get.argtypes = [session_t]

724

certificate_type_get.restype = _error_code

725

726

certificate_get_peers = _library.gnutls_certificate_get_peers

727

certificate_get_peers.argtypes = [session_t,

728

ctypes.POINTER(ctypes.c_uint)]

729

certificate_get_peers.restype = ctypes.POINTER(datum_t)

730

731

global_set_log_level = _library.gnutls_global_set_log_level

732

global_set_log_level.argtypes = [ctypes.c_int]

733

global_set_log_level.restype = None

734

735

global_set_log_function = _library.gnutls_global_set_log_function

736

global_set_log_function.argtypes = [log_func]

737

global_set_log_function.restype = None

738

739

deinit = _library.gnutls_deinit

740

deinit.argtypes = [session_t]

741

deinit.restype = None

742

743

handshake = _library.gnutls_handshake

744

handshake.argtypes = [session_t]

745

handshake.restype = _error_code

746

handshake.errcheck = _retry_on_error

747

748

transport_set_ptr = _library.gnutls_transport_set_ptr

749

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

750

transport_set_ptr.restype = None

751

752

bye = _library.gnutls_bye

753

bye.argtypes = [session_t, close_request_t]

754

bye.restype = _error_code

755

bye.errcheck = _retry_on_error

756

757

check_version = _library.gnutls_check_version

758

check_version.argtypes = [ctypes.c_char_p]

759

check_version.restype = ctypes.c_char_p

760

761

_need_version = b"3.3.0"

762

if check_version(_need_version) is None:

763

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

764

.format(_need_version))

765

766

_tls_rawpk_version = b"3.6.6"

767

has_rawpk = bool(check_version(_tls_rawpk_version))

768

769

if has_rawpk:

770

# Types

771

class pubkey_st(ctypes.Structure):

772

_fields = []

773

pubkey_t = ctypes.POINTER(pubkey_st)

774

775

x509_crt_fmt_t = ctypes.c_int

776

777

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

778

pubkey_init = _library.gnutls_pubkey_init

779

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

780

pubkey_init.restype = _error_code

781

782

pubkey_import = _library.gnutls_pubkey_import

783

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

784

x509_crt_fmt_t]

785

pubkey_import.restype = _error_code

786

787

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

788

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

789

ctypes.POINTER(ctypes.c_ubyte),

790

ctypes.POINTER(ctypes.c_size_t)]

791

pubkey_get_key_id.restype = _error_code

792

793

pubkey_deinit = _library.gnutls_pubkey_deinit

794

pubkey_deinit.argtypes = [pubkey_t]

795

pubkey_deinit.restype = None

796

else:

797

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

798

799

openpgp_crt_init = _library.gnutls_openpgp_crt_init

800

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

801

openpgp_crt_init.restype = _error_code

802

803

openpgp_crt_import = _library.gnutls_openpgp_crt_import

804

openpgp_crt_import.argtypes = [openpgp_crt_t,

805

ctypes.POINTER(datum_t),

806

openpgp_crt_fmt_t]

807

openpgp_crt_import.restype = _error_code

808

809

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

810

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

811

ctypes.POINTER(ctypes.c_uint)]

812

openpgp_crt_verify_self.restype = _error_code

813

814

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

815

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

816

openpgp_crt_deinit.restype = None

817

818

openpgp_crt_get_fingerprint = (

819

_library.gnutls_openpgp_crt_get_fingerprint)

820

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

821

ctypes.c_void_p,

822

ctypes.POINTER(

823

ctypes.c_size_t)]

824

openpgp_crt_get_fingerprint.restype = _error_code

825

826

if check_version(b"3.6.4"):

827

certificate_type_get2 = _library.gnutls_certificate_type_get2

828

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

829

certificate_type_get2.restype = _error_code

830

831

# Remove non-public functions

832

del _error_code, _retry_on_error

833

834

835

def call_pipe(connection, # : multiprocessing.Connection

836

func, *args, **kwargs):

837

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

838

839

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

840

return value on the provided multiprocessing.Connection.

841

"""

842

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

843

connection.close()

844

845

846

class Client:

404

class Client(object):

847

405

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

848

406

849

407

Attributes:

850

408

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

851

409

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

852

410

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

853

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

854

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

855

running.

856

checker_callback_tag: a GLib event source tag, or None

411

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

412

to see if the client lives.

413

'None' if no process is running.

414

checker_callback_tag: a gobject event source tag, or None

857

415

checker_command: string; External command which is run to check

858

416

if client lives. %() expansions are done at

859

417

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

860

418

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

861

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

862

420

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

863

421

client_structure: Object describing what attributes a client has

864

422

and is used for storing the client at exit

865

423

current_checker_command: string; current running checker_command

866

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

867

425

enabled: bool()

868

426

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

869

uniquely identify an OpenPGP client

870

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

871

a client using raw public keys

427

uniquely identify the client

872

428

host: string; available for use by the checker command

873

429

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

874

430

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

876

432

last_checker_status: integer between 0 and 255 reflecting exit

877

433

status of last checker. -1 reflects crashed

878

434

checker, -2 means no checker completed yet.

879

last_checker_signal: The signal which killed the last checker, if

880

last_checker_status is -1

881

435

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

882

436

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

883

437

D-Bus identifiers

890

444

disabled, or None

891

445

server_settings: The server_settings dict from main()

892

446

"""

893

447

894

448

runtime_expansions = ("approval_delay", "approval_duration",

895

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

449

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

896

450

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

897

451

"last_approval_request", "last_checked_ok",

898

452

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

899

client_defaults = {

900

"timeout": "PT5M",

901

"extended_timeout": "PT15M",

902

"interval": "PT2M",

903

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

904

"host": "",

905

"approval_delay": "PT0S",

906

"approval_duration": "PT1S",

907

"approved_by_default": "True",

908

"enabled": "True",

909

}

910

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

463

911

464

@staticmethod

912

465

def config_parser(config):

913

466

"""Construct a new dict of client settings of this form:

920

473

for client_name in config.sections():

921

474

section = dict(config.items(client_name))

922

475

client = settings[client_name] = {}

923

476

924

477

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

925

478

# Reformat values from string types to Python types

926

479

client["approved_by_default"] = config.getboolean(

927

480

client_name, "approved_by_default")

928

481

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

929

482

"enabled")

930

931

# Uppercase and remove spaces from key_id and fingerprint

932

# for later comparison purposes with return value from the

933

# key_id() and fingerprint() functions

934

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

935

.replace(" ", ""))

483

936

484

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

937

485

.replace(" ", ""))

938

486

if "secret" in section:

939

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

940

.encode("utf-8"),

941

"base64")

487

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

942

488

elif "secfile" in section:

943

489

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

944

490

(section["secfile"])),

959

505

client["last_approval_request"] = None

960

506

client["last_checked_ok"] = None

961

507

client["last_checker_status"] = -2

962

508

963

509

return settings

964

965

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

510

511

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

966

512

self.name = name

967

513

if server_settings is None:

968

514

server_settings = {}

970

516

# adding all client settings

971

517

for setting, value in settings.items():

972

518

setattr(self, setting, value)

973

519

974

520

if self.enabled:

975

521

if not hasattr(self, "last_enabled"):

976

522

self.last_enabled = datetime.datetime.utcnow()

980

526

else:

981

527

self.last_enabled = None

982

528

self.expires = None

983

529

984

530

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

985

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

986

534

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

987

535

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

988

536

datetime.datetime.utcnow())

989

537

990

538

# attributes specific for this server instance

991

539

self.checker = None

992

540

self.checker_initiator_tag = None

995

543

self.current_checker_command = None

996

544

self.approved = None

997

545

self.approvals_pending = 0

998

self.changedstate = multiprocessing_manager.Condition(

999

multiprocessing_manager.Lock())

1000

self.client_structure = [attr

1001

for attr in self.__dict__.keys()

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

1002

551

if not attr.startswith("_")]

1003

552

self.client_structure.append("client_structure")

1004

1005

for name, t in inspect.getmembers(

1006

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

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

1007

558

if not name.startswith("_"):

1008

559

self.client_structure.append(name)

1009

560

1010

561

# Send notice to process children that client state has changed

1011

562

def send_changedstate(self):

1012

563

with self.changedstate:

1013

564

self.changedstate.notify_all()

1014

565

1015

566

def enable(self):

1016

567

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

1017

568

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

1022

573

self.last_enabled = datetime.datetime.utcnow()

1023

574

self.init_checker()

1024

575

self.send_changedstate()

1025

576

1026

577

def disable(self, quiet=True):

1027

578

"""Disable this client."""

1028

579

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

1030

581

if not quiet:

1031

582

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

1032

583

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

1033

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1034

585

self.disable_initiator_tag = None

1035

586

self.expires = None

1036

587

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

1037

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1038

589

self.checker_initiator_tag = None

1039

590

self.stop_checker()

1040

591

self.enabled = False

1041

592

if not quiet:

1042

593

self.send_changedstate()

1043

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

594

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

1044

595

return False

1045

596

1046

597

def __del__(self):

1047

598

self.disable()

1048

599

1049

600

def init_checker(self):

1050

601

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

1051

602

# and every interval from then on.

1052

603

if self.checker_initiator_tag is not None:

1053

GLib.source_remove(self.checker_initiator_tag)

1054

self.checker_initiator_tag = GLib.timeout_add(

1055

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

1056

+ 1)),

1057

self.start_checker)

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

self.start_checker))

1058

609

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

1059

610

if self.disable_initiator_tag is not None:

1060

GLib.source_remove(self.disable_initiator_tag)

1061

self.disable_initiator_tag = GLib.timeout_add(

1062

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

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

1063

616

# Also start a new checker *right now*.

1064

617

self.start_checker()

1065

1066

def checker_callback(self, source, condition, connection,

1067

command):

618

619

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

1068

620

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

1069

# Read return code from connection (see call_pipe)

1070

returncode = connection.recv()

1071

connection.close()

1072

if self.checker is not None:

1073

self.checker.join()

1074

621

self.checker_callback_tag = None

1075

622

self.checker = None

1076

1077

if returncode >= 0:

1078

self.last_checker_status = returncode

1079

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1080

625

if self.last_checker_status == 0:

1081

626

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

1082

627

vars(self))

1083

628

self.checked_ok()

1084

629

else:

1085

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

630

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

631

vars(self))

1086

632

else:

1087

633

self.last_checker_status = -1

1088

self.last_checker_signal = -returncode

1089

634

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

1090

635

vars(self))

1091

return False

1092

636

1093

637

def checked_ok(self):

1094

638

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

1095

639

self.last_checked_ok = datetime.datetime.utcnow()

1096

640

self.last_checker_status = 0

1097

self.last_checker_signal = None

1098

641

self.bump_timeout()

1099

642

1100

643

def bump_timeout(self, timeout=None):

1101

644

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

1102

645

if timeout is None:

1103

646

timeout = self.timeout

1104

647

if self.disable_initiator_tag is not None:

1105

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1106

649

self.disable_initiator_tag = None

1107

650

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

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1110

654

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

1111

655

1112

656

def need_approval(self):

1113

657

self.last_approval_request = datetime.datetime.utcnow()

1114

658

1115

659

def start_checker(self):

1116

660

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

1117

661

1118

662

If a checker already exists, leave it running and do

1119

663

nothing."""

1120

664

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

1125

669

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

1126

670

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

1127

671

# should be.

1128

1129

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

1130

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

1131

self.checker.join()

1132

self.checker = None

672

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1133

687

# Start a new checker if needed

1134

688

if self.checker is None:

1135

689

# Escape attributes for the shell

1136

escaped_attrs = {

1137

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

1138

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

1139

694

try:

1140

695

command = self.checker_command % escaped_attrs

1141

696

except TypeError as error:

1142

697

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

1143

self.checker_command,

698

self.checker_command, exc_info=error)

699

return True # Try again later

700

self.current_checker_command = command

701

try:

702

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

703

command, self.name)

704

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

705

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

706

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

707

# always replaced by /dev/null.)

708

# The exception is when not debugging but nevertheless

709

# running in the foreground; use the previously

710

# created wnull.

711

popen_args = {}

712

if (not self.server_settings["debug"]

713

and self.server_settings["foreground"]):

714

popen_args.update({"stdout": wnull,

715

"stderr": wnull })

716

self.checker = subprocess.Popen(command,

717

close_fds=True,

718

shell=True, cwd="/",

719

**popen_args)

720

except OSError as error:

721

logger.error("Failed to start subprocess",

1144

722

exc_info=error)

1145

return True # Try again later

1146

self.current_checker_command = command

1147

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

1148

self.name)

1149

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

1150

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

1151

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

1152

# always replaced by /dev/null.)

1153

# The exception is when not debugging but nevertheless

1154

# running in the foreground; use the previously

1155

# created wnull.

1156

popen_args = {"close_fds": True,

1157

"shell": True,

1158

"cwd": "/"}

1159

if (not self.server_settings["debug"]

1160

and self.server_settings["foreground"]):

1161

popen_args.update({"stdout": wnull,

1162

"stderr": wnull})

1163

pipe = multiprocessing.Pipe(duplex=False)

1164

self.checker = multiprocessing.Process(

1165

target=call_pipe,

1166

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

1167

kwargs=popen_args)

1168

self.checker.start()

1169

self.checker_callback_tag = GLib.io_add_watch(

1170

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

1171

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1172

self.checker_callback, pipe[0], command)

1173

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

723

return True

724

self.checker_callback_tag = (gobject.child_watch_add

725

(self.checker.pid,

726

self.checker_callback,

727

data=command))

728

# The checker may have completed before the gobject

729

# watch was added. Check for this.

730

try:

731

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

732

except OSError as error:

733

if error.errno == errno.ECHILD:

734

# This should never happen

735

logger.error("Child process vanished",

736

exc_info=error)

737

return True

738

raise

739

if pid:

740

gobject.source_remove(self.checker_callback_tag)

741

self.checker_callback(pid, status, command)

742

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

1174

743

return True

1175

744

1176

745

def stop_checker(self):

1177

746

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

1178

747

if self.checker_callback_tag:

1179

GLib.source_remove(self.checker_callback_tag)

748

gobject.source_remove(self.checker_callback_tag)

1180

749

self.checker_callback_tag = None

1181

750

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

1182

751

return

1183

752

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

1184

self.checker.terminate()

753

try:

754

self.checker.terminate()

755

#time.sleep(0.5)

756

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

757

# self.checker.kill()

758

except OSError as error:

759

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

760

raise

1185

761

self.checker = None

1186

762

1187

763

1188

def dbus_service_property(dbus_interface,

1189

signature="v",

1190

access="readwrite",

1191

byte_arrays=False):

764

def dbus_service_property(dbus_interface, signature="v",

765

access="readwrite", byte_arrays=False):

1192

766

"""Decorators for marking methods of a DBusObjectWithProperties to

1193

767

become properties on the D-Bus.

1194

768

1195

769

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

1196

770

and with one argument by "Set".

1197

771

1198

772

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

1199

773

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

1200

774

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

1204

778

if byte_arrays and signature != "ay":

1205

779

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

1206

780

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

1207

1208

781

def decorator(func):

1209

782

func._dbus_is_property = True

1210

783

func._dbus_interface = dbus_interface

1213

786

func._dbus_name = func.__name__

1214

787

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

1215

788

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

1216

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

789

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1217

790

return func

1218

1219

791

return decorator

1220

792

1221

793

1222

794

def dbus_interface_annotations(dbus_interface):

1223

795

"""Decorator for marking functions returning interface annotations

1224

796

1225

797

Usage:

1226

798

1227

799

@dbus_interface_annotations("org.example.Interface")

1228

800

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

1229

801

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

1230

802

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

1231

803

"false"}

1232

804

"""

1233

1234

805

def decorator(func):

1235

806

func._dbus_is_interface = True

1236

807

func._dbus_interface = dbus_interface

1237

808

func._dbus_name = dbus_interface

1238

809

return func

1239

1240

810

return decorator

1241

811

1242

812

1243

813

def dbus_annotations(annotations):

1244

814

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

1245

815

Usage:

1246

1247

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

1248

"org.freedesktop.DBus.Property."

1249

"EmitsChangedSignal": "false"})

816

1250

817

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

1251

818

access="r")

819

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

820

"org.freedesktop.DBus.Property."

821

"EmitsChangedSignal": "false"})

1252

822

def Property_dbus_property(self):

1253

823

return dbus.Boolean(False)

1254

1255

See also the DBusObjectWithAnnotations class.

1256

824

"""

1257

1258

825

def decorator(func):

1259

826

func._dbus_annotations = annotations

1260

827

return func

1261

1262

828

return decorator

1263

829

1264

830

1265

831

class DBusPropertyException(dbus.exceptions.DBusException):

1266

832

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

1267

833

"""

1268

pass

834

def __unicode__(self):

835

return unicode(str(self))

1269

836

1270

837

1271

838

class DBusPropertyAccessException(DBusPropertyException):

1280

847

pass

1281

848

1282

849

1283

class DBusObjectWithAnnotations(dbus.service.Object):

1284

"""A D-Bus object with annotations.

1285

1286

Classes inheriting from this can use the dbus_annotations

1287

decorator to add annotations to methods or signals.

850

class DBusObjectWithProperties(dbus.service.Object):

851

"""A D-Bus object with properties.

852

853

Classes inheriting from this can use the dbus_service_property

854

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

855

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

1288

856

"""

1289

857

1290

858

@staticmethod

1291

859

def _is_dbus_thing(thing):

1292

860

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

1293

861

1294

862

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

1295

863

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

1296

864

"""

1297

865

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

1298

866

False)

1299

867

1300

868

def _get_all_dbus_things(self, thing):

1301

869

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

1302

870

"""

1303

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

871

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

872

name),

1304

873

athing.__get__(self))

1305

874

for cls in self.__class__.__mro__

1306

875

for name, athing in

1307

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

1308

1309

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1310

out_signature="s",

1311

path_keyword='object_path',

1312

connection_keyword='connection')

1313

def Introspect(self, object_path, connection):

1314

"""Overloading of standard D-Bus method.

1315

1316

Inserts annotation tags on methods and signals.

1317

"""

1318

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

1319

connection)

1320

try:

1321

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

1322

1323

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

1324

# Add annotation tags

1325

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

1326

for tag in if_tag.getElementsByTagName(typ):

1327

annots = dict()

1328

for name, prop in (self.

1329

_get_all_dbus_things(typ)):

1330

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

1331

and prop._dbus_interface

1332

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

1333

annots.update(getattr(

1334

prop, "_dbus_annotations", {}))

1335

for name, value in annots.items():

1336

ann_tag = document.createElement(

1337

"annotation")

1338

ann_tag.setAttribute("name", name)

1339

ann_tag.setAttribute("value", value)

1340

tag.appendChild(ann_tag)

1341

# Add interface annotation tags

1342

for annotation, value in dict(

1343

itertools.chain.from_iterable(

1344

annotations().items()

1345

for name, annotations

1346

in self._get_all_dbus_things("interface")

1347

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

1348

)).items():

1349

ann_tag = document.createElement("annotation")

1350

ann_tag.setAttribute("name", annotation)

1351

ann_tag.setAttribute("value", value)

1352

if_tag.appendChild(ann_tag)

1353

# Fix argument name for the Introspect method itself

1354

if (if_tag.getAttribute("name")

1355

== dbus.INTROSPECTABLE_IFACE):

1356

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

1357

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

1358

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

1359

if (arg.getAttribute("direction")

1360

== "out"):

1361

arg.setAttribute("name",

1362

"xml_data")

1363

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

1364

document.unlink()

1365

except (AttributeError, xml.dom.DOMException,

1366

xml.parsers.expat.ExpatError) as error:

1367

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

1368

exc_info=error)

1369

return xmlstring

1370

1371

1372

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1373

"""A D-Bus object with properties.

1374

1375

Classes inheriting from this can use the dbus_service_property

1376

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

1377

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

1378

"""

1379

876

inspect.getmembers(cls,

877

self._is_dbus_thing(thing)))

878

1380

879

def _get_dbus_property(self, interface_name, property_name):

1381

880

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

1382

881

property with the specified name and interface.

1383

882

"""

1384

for cls in self.__class__.__mro__:

1385

for name, value in inspect.getmembers(

1386

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

883

for cls in self.__class__.__mro__:

884

for name, value in (inspect.getmembers

885

(cls,

886

self._is_dbus_thing("property"))):

1387

887

if (value._dbus_name == property_name

1388

888

and value._dbus_interface == interface_name):

1389

889

return value.__get__(self)

1390

890

1391

891

# No such property

1392

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

1393

self.dbus_object_path, interface_name, property_name))

1394

1395

@classmethod

1396

def _get_all_interface_names(cls):

1397

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

1398

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

1399

"_dbus_interface", None)

1400

for x in (inspect.getmro(cls))

1401

for attr in dir(x))

1402

if name is not None)

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="ss",

892

raise DBusPropertyNotFound(self.dbus_object_path + ":"

893

+ interface_name + "."

894

+ property_name)

895

896

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

1406

897

out_signature="v")

1407

898

def Get(self, interface_name, property_name):

1408

899

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

1414

905

if not hasattr(value, "variant_level"):

1415

906

return value

1416

907

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

1417

908

1418

909

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

1419

910

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

1420

911

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

1429

920

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

1430

921

"'ay' signature {!r}"

1431

922

.format(prop._dbus_signature))

1432

value = dbus.ByteArray(bytes(value))

923

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

924

for byte in value))

1433

925

prop(value)

1434

1435

@dbus.service.method(dbus.PROPERTIES_IFACE,

1436

in_signature="s",

926

927

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

1437

928

out_signature="a{sv}")

1438

929

def GetAll(self, interface_name):

1439

930

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

1440

931

standard.

1441

932

1442

933

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

1443

934

"""

1444

935

properties = {}

1454

945

if not hasattr(value, "variant_level"):

1455

946

properties[name] = value

1456

947

continue

1457

properties[name] = type(value)(

1458

value, variant_level=value.variant_level + 1)

948

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

949

value.variant_level+1)

1459

950

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

1460

1461

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

1462

def PropertiesChanged(self, interface_name, changed_properties,

1463

invalidated_properties):

1464

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

1465

standard.

1466

"""

1467

pass

1468

951

1469

952

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1470

953

out_signature="s",

1471

954

path_keyword='object_path',

1472

955

connection_keyword='connection')

1473

956

def Introspect(self, object_path, connection):

1474

957

"""Overloading of standard D-Bus method.

1475

958

1476

959

Inserts property tags and interface annotation tags.

1477

960

"""

1478

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1479

object_path,

1480

connection)

961

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

962

connection)

1481

963

try:

1482

964

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

1483

1484

965

def make_tag(document, name, prop):

1485

966

e = document.createElement("property")

1486

967

e.setAttribute("name", name)

1487

968

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

1488

969

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

1489

970

return e

1490

1491

971

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

1492

972

# Add property tags

1493

973

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

1496

976

if prop._dbus_interface

1497

977

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

1498

978

if_tag.appendChild(tag)

1499

# Add annotation tags for properties

1500

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

1501

annots = dict()

1502

for name, prop in self._get_all_dbus_things(

1503

"property"):

1504

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

1505

and prop._dbus_interface

1506

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

1507

annots.update(getattr(

1508

prop, "_dbus_annotations", {}))

1509

for name, value in annots.items():

1510

ann_tag = document.createElement(

1511

"annotation")

1512

ann_tag.setAttribute("name", name)

1513

ann_tag.setAttribute("value", value)

1514

tag.appendChild(ann_tag)

979

# Add annotation tags

980

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

981

for tag in if_tag.getElementsByTagName(typ):

982

annots = dict()

983

for name, prop in (self.

984

_get_all_dbus_things(typ)):

985

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

986

and prop._dbus_interface

987

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

988

annots.update(getattr

989

(prop,

990

"_dbus_annotations",

991

{}))

992

for name, value in annots.items():

993

ann_tag = document.createElement(

994

"annotation")

995

ann_tag.setAttribute("name", name)

996

ann_tag.setAttribute("value", value)

997

tag.appendChild(ann_tag)

998

# Add interface annotation tags

999

for annotation, value in dict(

1000

itertools.chain.from_iterable(

1001

annotations().items()

1002

for name, annotations in

1003

self._get_all_dbus_things("interface")

1004

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

1005

)).items():

1006

ann_tag = document.createElement("annotation")

1007

ann_tag.setAttribute("name", annotation)

1008

ann_tag.setAttribute("value", value)

1009

if_tag.appendChild(ann_tag)

1515

1010

# Add the names to the return values for the

1516

1011

# "org.freedesktop.DBus.Properties" methods

1517

1012

if (if_tag.getAttribute("name")

1536

1031

return xmlstring

1537

1032

1538

1033

1539

try:

1540

dbus.OBJECT_MANAGER_IFACE

1541

except AttributeError:

1542

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

1543

1544

1545

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1546

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

1547

1548

Classes inheriting from this exposes the standard

1549

GetManagedObjects call and the InterfacesAdded and

1550

InterfacesRemoved signals on the standard

1551

"org.freedesktop.DBus.ObjectManager" interface.

1552

1553

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

1554

manually.

1555

"""

1556

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1557

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

1558

def GetManagedObjects(self):

1559

"""This function must be overridden"""

1560

raise NotImplementedError()

1561

1562

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1563

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

1564

def InterfacesAdded(self, object_path, interfaces_and_properties):

1565

pass

1566

1567

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

1568

def InterfacesRemoved(self, object_path, interfaces):

1569

pass

1570

1571

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1572

out_signature="s",

1573

path_keyword='object_path',

1574

connection_keyword='connection')

1575

def Introspect(self, object_path, connection):

1576

"""Overloading of standard D-Bus method.

1577

1578

Override return argument name of GetManagedObjects to be

1579

"objpath_interfaces_and_properties"

1580

"""

1581

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1582

object_path,

1583

connection)

1584

try:

1585

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

1586

1587

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

1588

# Fix argument name for the GetManagedObjects method

1589

if (if_tag.getAttribute("name")

1590

== dbus.OBJECT_MANAGER_IFACE):

1591

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

1592

if (cn.getAttribute("name")

1593

== "GetManagedObjects"):

1594

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

1595

if (arg.getAttribute("direction")

1596

== "out"):

1597

arg.setAttribute(

1598

"name",

1599

"objpath_interfaces"

1600

"_and_properties")

1601

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

1602

document.unlink()

1603

except (AttributeError, xml.dom.DOMException,

1604

xml.parsers.expat.ExpatError) as error:

1605

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

1606

exc_info=error)

1607

return xmlstring

1608

1609

1610

1034

def datetime_to_dbus(dt, variant_level=0):

1611

1035

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

1612

1036

if dt is None:

1613

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

1614

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

1037

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

1038

return dbus.String(dt.isoformat(),

1039

variant_level=variant_level)

1615

1040

1616

1041

1617

1042

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1619

1044

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

1620

1045

interface names according to the "alt_interface_names" mapping.

1621

1046

Usage:

1622

1047

1623

1048

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

1624

1049

"net.example.AlternateInterface"})

1625

1050

class SampleDBusObject(dbus.service.Object):

1626

1051

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

1627

1052

def SampleDBusMethod():

1628

1053

pass

1629

1054

1630

1055

The above "SampleDBusMethod" on "SampleDBusObject" will be

1631

1056

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

1632

1057

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

1633

1058

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

1634

1059

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

1635

1060

1636

1061

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

1637

1062

(from DBusObjectWithProperties) and interfaces (from the

1638

1063

dbus_interface_annotations decorator).

1639

1064

"""

1640

1641

1065

def wrapper(cls):

1642

1066

for orig_interface_name, alt_interface_name in (

1643

alt_interface_names.items()):

1067

alt_interface_names.items()):

1644

1068

attr = {}

1645

1069

interface_names = set()

1646

1070

# Go though all attributes of the class

1648

1072

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

1649

1073

# with the wrong interface name

1650

1074

if (not hasattr(attribute, "_dbus_interface")

1651

or not attribute._dbus_interface.startswith(

1652

orig_interface_name)):

1075

or not attribute._dbus_interface

1076

.startswith(orig_interface_name)):

1653

1077

continue

1654

1078

# Create an alternate D-Bus interface name based on

1655

1079

# the current name

1656

alt_interface = attribute._dbus_interface.replace(

1657

orig_interface_name, alt_interface_name)

1080

alt_interface = (attribute._dbus_interface

1081

.replace(orig_interface_name,

1082

alt_interface_name))

1658

1083

interface_names.add(alt_interface)

1659

1084

# Is this a D-Bus signal?

1660

1085

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

1661

1086

# Extract the original non-method undecorated

1662

1087

# function by black magic

1663

if sys.version_info.major == 2:

1664

nonmethod_func = (dict(

1088

nonmethod_func = (dict(

1665

1089

zip(attribute.func_code.co_freevars,

1666

attribute.__closure__))

1667

["func"].cell_contents)

1668

else:

1669

nonmethod_func = (dict(

1670

zip(attribute.__code__.co_freevars,

1671

attribute.__closure__))

1672

["func"].cell_contents)

1090

attribute.__closure__))["func"]

1091

.cell_contents)

1673

1092

# Create a new, but exactly alike, function

1674

1093

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

1675

1094

# with the alternate D-Bus interface name

1676

new_function = copy_function(nonmethod_func)

1677

new_function = (dbus.service.signal(

1678

alt_interface,

1679

attribute._dbus_signature)(new_function))

1095

new_function = (dbus.service.signal

1096

(alt_interface,

1097

attribute._dbus_signature)

1098

(types.FunctionType(

1099

nonmethod_func.func_code,

1100

nonmethod_func.func_globals,

1101

nonmethod_func.func_name,

1102

nonmethod_func.func_defaults,

1103

nonmethod_func.func_closure)))

1680

1104

# Copy annotations, if any

1681

1105

try:

1682

new_function._dbus_annotations = dict(

1683

attribute._dbus_annotations)

1106

new_function._dbus_annotations = (

1107

dict(attribute._dbus_annotations))

1684

1108

except AttributeError:

1685

1109

pass

1686

1687

1110

# Define a creator of a function to call both the

1688

1111

# original and alternate functions, so both the

1689

1112

# original and alternate signals gets sent when

1692

1115

"""This function is a scope container to pass

1693

1116

func1 and func2 to the "call_both" function

1694

1117

outside of its arguments"""

1695

1696

@functools.wraps(func2)

1697

1118

def call_both(*args, **kwargs):

1698

1119

"""This function will emit two D-Bus

1699

1120

signals by calling func1 and func2"""

1700

1121

func1(*args, **kwargs)

1701

1122

func2(*args, **kwargs)

1702

# Make wrapper function look like a D-Bus

1703

# signal

1704

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

1705

if name.startswith("_dbus_"):

1706

setattr(call_both, name, attr)

1707

1708

1123

return call_both

1709

1124

# Create the "call_both" function and add it to

1710

1125

# the class

1715

1130

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

1716

1131

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

1717

1132

# to the class.

1718

attr[attrname] = (

1719

dbus.service.method(

1720

alt_interface,

1721

attribute._dbus_in_signature,

1722

attribute._dbus_out_signature)

1723

(copy_function(attribute)))

1133

attr[attrname] = (dbus.service.method

1134

(alt_interface,

1135

attribute._dbus_in_signature,

1136

attribute._dbus_out_signature)

1137

(types.FunctionType

1138

(attribute.func_code,

1139

attribute.func_globals,

1140

attribute.func_name,

1141

attribute.func_defaults,

1142

attribute.func_closure)))

1724

1143

# Copy annotations, if any

1725

1144

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1145

attr[attrname]._dbus_annotations = (

1146

dict(attribute._dbus_annotations))

1728

1147

except AttributeError:

1729

1148

pass

1730

1149

# Is this a D-Bus property?

1733

1152

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

1734

1153

# property with the alternate D-Bus interface

1735

1154

# name. Add it to the class.

1736

attr[attrname] = (dbus_service_property(

1737

alt_interface, attribute._dbus_signature,

1738

attribute._dbus_access,

1739

attribute._dbus_get_args_options

1740

["byte_arrays"])

1741

(copy_function(attribute)))

1155

attr[attrname] = (dbus_service_property

1156

(alt_interface,

1157

attribute._dbus_signature,

1158

attribute._dbus_access,

1159

attribute

1160

._dbus_get_args_options

1161

["byte_arrays"])

1162

(types.FunctionType

1163

(attribute.func_code,

1164

attribute.func_globals,

1165

attribute.func_name,

1166

attribute.func_defaults,

1167

attribute.func_closure)))

1742

1168

# Copy annotations, if any

1743

1169

try:

1744

attr[attrname]._dbus_annotations = dict(

1745

attribute._dbus_annotations)

1170

attr[attrname]._dbus_annotations = (

1171

dict(attribute._dbus_annotations))

1746

1172

except AttributeError:

1747

1173

pass

1748

1174

# Is this a D-Bus interface?

1751

1177

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

1752

1178

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

1753

1179

# to the class.

1754

attr[attrname] = (

1755

dbus_interface_annotations(alt_interface)

1756

(copy_function(attribute)))

1180

attr[attrname] = (dbus_interface_annotations

1181

(alt_interface)

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1757

1188

if deprecate:

1758

1189

# Deprecate all alternate interfaces

1759

iname = "_AlternateDBusNames_interface_annotation{}"

1190

iname="_AlternateDBusNames_interface_annotation{}"

1760

1191

for interface_name in interface_names:

1761

1762

1192

@dbus_interface_annotations(interface_name)

1763

1193

def func(self):

1764

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

1765

"true"}

1194

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

1195

"true" }

1766

1196

# Find an unused name

1767

1197

for aname in (iname.format(i)

1768

1198

for i in itertools.count()):

1772

1202

if interface_names:

1773

1203

# Replace the class with a new subclass of it with

1774

1204

# methods, signals, etc. as created above.

1775

if sys.version_info.major == 2:

1776

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

1777

(cls, ), attr)

1778

else:

1779

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

1780

(cls, ), attr)

1205

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

1206

(cls,), attr)

1781

1207

return cls

1782

1783

1208

return wrapper

1784

1209

1785

1210

1786

1211

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

1787

"se.bsnet.fukt.Mandos"})

1212

"se.bsnet.fukt.Mandos"})

1788

1213

class ClientDBus(Client, DBusObjectWithProperties):

1789

1214

"""A Client class using D-Bus

1790

1215

1791

1216

Attributes:

1792

1217

dbus_object_path: dbus.ObjectPath

1793

1218

bus: dbus.SystemBus()

1794

1219

"""

1795

1220

1796

1221

runtime_expansions = (Client.runtime_expansions

1797

+ ("dbus_object_path", ))

1798

1799

_interface = "se.recompile.Mandos.Client"

1800

1222

+ ("dbus_object_path",))

1223

1801

1224

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

1802

1803

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

1225

1226

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

1804

1227

self.bus = bus

1805

1228

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

1806

1229

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

1807

1230

# the D-Bus

1808

client_object_name = str(self.name).translate(

1231

client_object_name = unicode(self.name).translate(

1809

1232

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

1810

1233

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

1811

self.dbus_object_path = dbus.ObjectPath(

1812

"/clients/" + client_object_name)

1234

self.dbus_object_path = (dbus.ObjectPath

1235

("/clients/" + client_object_name))

1813

1236

DBusObjectWithProperties.__init__(self, self.bus,

1814

1237

self.dbus_object_path)

1815

1816

def notifychangeproperty(transform_func, dbus_name,

1817

type_func=lambda x: x,

1818

variant_level=1,

1819

invalidate_only=False,

1820

_interface=_interface):

1238

1239

def notifychangeproperty(transform_func,

1240

dbus_name, type_func=lambda x: x,

1241

variant_level=1):

1821

1242

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

1822

1243

its changes to DBus.

1823

1244

1824

1245

transform_fun: Function that takes a value and a variant_level

1825

1246

and transforms it to a D-Bus type.

1826

1247

dbus_name: D-Bus name of the variable

1829

1250

variant_level: D-Bus variant level. Default: 1

1830

1251

"""

1831

1252

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

1832

1833

1253

def setter(self, value):

1834

1254

if hasattr(self, "dbus_object_path"):

1835

1255

if (not hasattr(self, attrname) or

1836

1256

type_func(getattr(self, attrname, None))

1837

1257

!= type_func(value)):

1838

if invalidate_only:

1839

self.PropertiesChanged(

1840

_interface, dbus.Dictionary(),

1841

dbus.Array((dbus_name, )))

1842

else:

1843

dbus_value = transform_func(

1844

type_func(value),

1845

variant_level=variant_level)

1846

self.PropertyChanged(dbus.String(dbus_name),

1847

dbus_value)

1848

self.PropertiesChanged(

1849

_interface,

1850

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

1851

dbus_value}),

1852

dbus.Array())

1258

dbus_value = transform_func(type_func(value),

1259

variant_level

1260

=variant_level)

1261

self.PropertyChanged(dbus.String(dbus_name),

1262

dbus_value)

1853

1263

setattr(self, attrname, value)

1854

1264

1855

1265

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

1856

1266

1857

1267

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1858

1268

approvals_pending = notifychangeproperty(dbus.Boolean,

1859

1269

"ApprovalPending",

1860

type_func=bool)

1270

type_func = bool)

1861

1271

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

1862

1272

last_enabled = notifychangeproperty(datetime_to_dbus,

1863

1273

"LastEnabled")

1864

checker = notifychangeproperty(

1865

dbus.Boolean, "CheckerRunning",

1866

type_func=lambda checker: checker is not None)

1274

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

1275

type_func = lambda checker:

1276

checker is not None)

1867

1277

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1868

1278

"LastCheckedOK")

1869

1279

last_checker_status = notifychangeproperty(dbus.Int16,

1872

1282

datetime_to_dbus, "LastApprovalRequest")

1873

1283

approved_by_default = notifychangeproperty(dbus.Boolean,

1874

1284

"ApprovedByDefault")

1875

approval_delay = notifychangeproperty(

1876

dbus.UInt64, "ApprovalDelay",

1877

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

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1286

"ApprovalDelay",

1287

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1878

1290

approval_duration = notifychangeproperty(

1879

1291

dbus.UInt64, "ApprovalDuration",

1880

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

1292

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

1881

1293

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

1882

timeout = notifychangeproperty(

1883

dbus.UInt64, "Timeout",

1884

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

1294

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1885

1297

extended_timeout = notifychangeproperty(

1886

1298

dbus.UInt64, "ExtendedTimeout",

1887

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

1888

interval = notifychangeproperty(

1889

dbus.UInt64, "Interval",

1890

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

1299

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

1300

interval = notifychangeproperty(dbus.UInt64,

1301

"Interval",

1302

type_func =

1303

lambda td: td.total_seconds()

1304

* 1000)

1891

1305

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

1892

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

1893

invalidate_only=True)

1894

1306

1895

1307

del notifychangeproperty

1896

1308

1897

1309

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

1898

1310

try:

1899

1311

self.remove_from_connection()

1902

1314

if hasattr(DBusObjectWithProperties, "__del__"):

1903

1315

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

1904

1316

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

1905

1906

def checker_callback(self, source, condition,

1907

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

1908

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

1909

connection, command, *args,

1910

**kwargs)

1911

exitstatus = self.last_checker_status

1912

if exitstatus >= 0:

1317

1318

def checker_callback(self, pid, condition, command,

1319

*args, **kwargs):

1320

self.checker_callback_tag = None

1321

self.checker = None

1322

if os.WIFEXITED(condition):

1323

exitstatus = os.WEXITSTATUS(condition)

1913

1324

# Emit D-Bus signal

1914

1325

self.CheckerCompleted(dbus.Int16(exitstatus),

1915

# This is specific to GNU libC

1916

dbus.Int64(exitstatus << 8),

1326

dbus.Int64(condition),

1917

1327

dbus.String(command))

1918

1328

else:

1919

1329

# Emit D-Bus signal

1920

1330

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

1921

dbus.Int64(

1922

# This is specific to GNU libC

1923

(exitstatus << 8)

1924

| self.last_checker_signal),

1331

dbus.Int64(condition),

1925

1332

dbus.String(command))

1926

return ret

1927

1333

1334

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

1335

*args, **kwargs)

1336

1928

1337

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

1929

1338

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

1930

1339

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

1934

1343

# Emit D-Bus signal

1935

1344

self.CheckerStarted(self.current_checker_command)

1936

1345

return r

1937

1346

1938

1347

def _reset_approved(self):

1939

1348

self.approved = None

1940

1349

return False

1941

1350

1942

1351

def approve(self, value=True):

1943

1352

self.approved = value

1944

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

1945

* 1000), self._reset_approved)

1353

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

1354

* 1000), self._reset_approved)

1946

1355

self.send_changedstate()

1947

1948

# D-Bus methods, signals & properties

1949

1950

# Interfaces

1951

1952

# Signals

1953

1356

1357

## D-Bus methods, signals & properties

1358

_interface = "se.recompile.Mandos.Client"

1359

1360

## Interfaces

1361

1362

@dbus_interface_annotations(_interface)

1363

def _foo(self):

1364

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

1365

"false"}

1366

1367

## Signals

1368

1954

1369

# CheckerCompleted - signal

1955

1370

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

1956

1371

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

1957

1372

"D-Bus signal"

1958

1373

pass

1959

1374

1960

1375

# CheckerStarted - signal

1961

1376

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

1962

1377

def CheckerStarted(self, command):

1963

1378

"D-Bus signal"

1964

1379

pass

1965

1380

1966

1381

# PropertyChanged - signal

1967

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

1968

1382

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

1969

1383

def PropertyChanged(self, property, value):

1970

1384

"D-Bus signal"

1971

1385

pass

1972

1386

1973

1387

# GotSecret - signal

1974

1388

@dbus.service.signal(_interface)

1975

1389

def GotSecret(self):

1978

1392

server to mandos-client

1979

1393

"""

1980

1394

pass

1981

1395

1982

1396

# Rejected - signal

1983

1397

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

1984

1398

def Rejected(self, reason):

1985

1399

"D-Bus signal"

1986

1400

pass

1987

1401

1988

1402

# NeedApproval - signal

1989

1403

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

1990

1404

def NeedApproval(self, timeout, default):

1991

1405

"D-Bus signal"

1992

1406

return self.need_approval()

1993

1994

# Methods

1995

1407

1408

## Methods

1409

1996

1410

# Approve - method

1997

1411

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

1998

1412

def Approve(self, value):

1999

1413

self.approve(value)

2000

1414

2001

1415

# CheckedOK - method

2002

1416

@dbus.service.method(_interface)

2003

1417

def CheckedOK(self):

2004

1418

self.checked_ok()

2005

1419

2006

1420

# Enable - method

2007

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

2008

1421

@dbus.service.method(_interface)

2009

1422

def Enable(self):

2010

1423

"D-Bus method"

2011

1424

self.enable()

2012

1425

2013

1426

# StartChecker - method

2014

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

2015

1427

@dbus.service.method(_interface)

2016

1428

def StartChecker(self):

2017

1429

"D-Bus method"

2018

1430

self.start_checker()

2019

1431

2020

1432

# Disable - method

2021

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

2022

1433

@dbus.service.method(_interface)

2023

1434

def Disable(self):

2024

1435

"D-Bus method"

2025

1436

self.disable()

2026

1437

2027

1438

# StopChecker - method

2028

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

2029

1439

@dbus.service.method(_interface)

2030

1440

def StopChecker(self):

2031

1441

self.stop_checker()

2032

2033

# Properties

2034

1442

1443

## Properties

1444

2035

1445

# ApprovalPending - property

2036

1446

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

2037

1447

def ApprovalPending_dbus_property(self):

2038

1448

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

2039

1449

2040

1450

# ApprovedByDefault - property

2041

@dbus_service_property(_interface,

2042

signature="b",

1451

@dbus_service_property(_interface, signature="b",

2043

1452

access="readwrite")

2044

1453

def ApprovedByDefault_dbus_property(self, value=None):

2045

1454

if value is None: # get

2046

1455

return dbus.Boolean(self.approved_by_default)

2047

1456

self.approved_by_default = bool(value)

2048

1457

2049

1458

# ApprovalDelay - property

2050

@dbus_service_property(_interface,

2051

signature="t",

1459

@dbus_service_property(_interface, signature="t",

2052

1460

access="readwrite")

2053

1461

def ApprovalDelay_dbus_property(self, value=None):

2054

1462

if value is None: # get

2055

1463

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

2056

1464

* 1000)

2057

1465

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

2058

1466

2059

1467

# ApprovalDuration - property

2060

@dbus_service_property(_interface,

2061

signature="t",

1468

@dbus_service_property(_interface, signature="t",

2062

1469

access="readwrite")

2063

1470

def ApprovalDuration_dbus_property(self, value=None):

2064

1471

if value is None: # get

2065

1472

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

2066

1473

* 1000)

2067

1474

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

2068

1475

2069

1476

# Name - property

2070

@dbus_annotations(

2071

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

2072

1477

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

2073

1478

def Name_dbus_property(self):

2074

1479

return dbus.String(self.name)

2075

2076

# KeyID - property

2077

@dbus_annotations(

2078

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

2079

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

2080

def KeyID_dbus_property(self):

2081

return dbus.String(self.key_id)

2082

1480

2083

1481

# Fingerprint - property

2084

@dbus_annotations(

2085

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

2086

1482

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

2087

1483

def Fingerprint_dbus_property(self):

2088

1484

return dbus.String(self.fingerprint)

2089

1485

2090

1486

# Host - property

2091

@dbus_service_property(_interface,

2092

signature="s",

1487

@dbus_service_property(_interface, signature="s",

2093

1488

access="readwrite")

2094

1489

def Host_dbus_property(self, value=None):

2095

1490

if value is None: # get

2096

1491

return dbus.String(self.host)

2097

self.host = str(value)

2098

1492

self.host = unicode(value)

1493

2099

1494

# Created - property

2100

@dbus_annotations(

2101

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

2102

1495

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

2103

1496

def Created_dbus_property(self):

2104

1497

return datetime_to_dbus(self.created)

2105

1498

2106

1499

# LastEnabled - property

2107

1500

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

2108

1501

def LastEnabled_dbus_property(self):

2109

1502

return datetime_to_dbus(self.last_enabled)

2110

1503

2111

1504

# Enabled - property

2112

@dbus_service_property(_interface,

2113

signature="b",

1505

@dbus_service_property(_interface, signature="b",

2114

1506

access="readwrite")

2115

1507

def Enabled_dbus_property(self, value=None):

2116

1508

if value is None: # get

2119

1511

self.enable()

2120

1512

else:

2121

1513

self.disable()

2122

1514

2123

1515

# LastCheckedOK - property

2124

@dbus_service_property(_interface,

2125

signature="s",

1516

@dbus_service_property(_interface, signature="s",

2126

1517

access="readwrite")

2127

1518

def LastCheckedOK_dbus_property(self, value=None):

2128

1519

if value is not None:

2129

1520

self.checked_ok()

2130

1521

return

2131

1522

return datetime_to_dbus(self.last_checked_ok)

2132

1523

2133

1524

# LastCheckerStatus - property

2134

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

1525

@dbus_service_property(_interface, signature="n",

1526

access="read")

2135

1527

def LastCheckerStatus_dbus_property(self):

2136

1528

return dbus.Int16(self.last_checker_status)

2137

1529

2138

1530

# Expires - property

2139

1531

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

2140

1532

def Expires_dbus_property(self):

2141

1533

return datetime_to_dbus(self.expires)

2142

1534

2143

1535

# LastApprovalRequest - property

2144

1536

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

2145

1537

def LastApprovalRequest_dbus_property(self):

2146

1538

return datetime_to_dbus(self.last_approval_request)

2147

1539

2148

1540

# Timeout - property

2149

@dbus_service_property(_interface,

2150

signature="t",

1541

@dbus_service_property(_interface, signature="t",

2151

1542

access="readwrite")

2152

1543

def Timeout_dbus_property(self, value=None):

2153

1544

if value is None: # get

2165

1556

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

2166

1557

is None):

2167

1558

return

2168

GLib.source_remove(self.disable_initiator_tag)

2169

self.disable_initiator_tag = GLib.timeout_add(

2170

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

2171

self.disable)

2172

1559

gobject.source_remove(self.disable_initiator_tag)

1560

self.disable_initiator_tag = (

1561

gobject.timeout_add(

1562

int((self.expires - now).total_seconds()

1563

* 1000), self.disable))

1564

2173

1565

# ExtendedTimeout - property

2174

@dbus_service_property(_interface,

2175

signature="t",

1566

@dbus_service_property(_interface, signature="t",

2176

1567

access="readwrite")

2177

1568

def ExtendedTimeout_dbus_property(self, value=None):

2178

1569

if value is None: # get

2179

1570

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

2180

1571

* 1000)

2181

1572

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

2182

1573

2183

1574

# Interval - property

2184

@dbus_service_property(_interface,

2185

signature="t",

1575

@dbus_service_property(_interface, signature="t",

2186

1576

access="readwrite")

2187

1577

def Interval_dbus_property(self, value=None):

2188

1578

if value is None: # get

2192

1582

return

2193

1583

if self.enabled:

2194

1584

# Reschedule checker run

2195

GLib.source_remove(self.checker_initiator_tag)

2196

self.checker_initiator_tag = GLib.timeout_add(

2197

value, self.start_checker)

2198

self.start_checker() # Start one now, too

2199

1585

gobject.source_remove(self.checker_initiator_tag)

1586

self.checker_initiator_tag = (gobject.timeout_add

1587

(value, self.start_checker))

1588

self.start_checker() # Start one now, too

1589

2200

1590

# Checker - property

2201

@dbus_service_property(_interface,

2202

signature="s",

1591

@dbus_service_property(_interface, signature="s",

2203

1592

access="readwrite")

2204

1593

def Checker_dbus_property(self, value=None):

2205

1594

if value is None: # get

2206

1595

return dbus.String(self.checker_command)

2207

self.checker_command = str(value)

2208

1596

self.checker_command = unicode(value)

1597

2209

1598

# CheckerRunning - property

2210

@dbus_service_property(_interface,

2211

signature="b",

1599

@dbus_service_property(_interface, signature="b",

2212

1600

access="readwrite")

2213

1601

def CheckerRunning_dbus_property(self, value=None):

2214

1602

if value is None: # get

2217

1605

self.start_checker()

2218

1606

else:

2219

1607

self.stop_checker()

2220

1608

2221

1609

# ObjectPath - property

2222

@dbus_annotations(

2223

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

2224

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

2225

1610

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

2226

1611

def ObjectPath_dbus_property(self):

2227

return self.dbus_object_path # is already a dbus.ObjectPath

2228

1612

return self.dbus_object_path # is already a dbus.ObjectPath

1613

2229

1614

# Secret = property

2230

@dbus_annotations(

2231

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

2232

"invalidates"})

2233

@dbus_service_property(_interface,

2234

signature="ay",

2235

access="write",

2236

byte_arrays=True)

1615

@dbus_service_property(_interface, signature="ay",

1616

access="write", byte_arrays=True)

2237

1617

def Secret_dbus_property(self, value):

2238

self.secret = bytes(value)

2239

1618

self.secret = str(value)

1619

2240

1620

del _interface

2241

1621

2242

1622

2243

class ProxyClient:

2244

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

1623

class ProxyClient(object):

1624

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

2245

1625

self._pipe = child_pipe

2246

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

1626

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

2247

1627

if not self._pipe.recv():

2248

raise KeyError(key_id or fpr)

2249

1628

raise KeyError()

1629

2250

1630

def __getattribute__(self, name):

2251

1631

if name == '_pipe':

2252

1632

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

2255

1635

if data[0] == 'data':

2256

1636

return data[1]

2257

1637

if data[0] == 'function':

2258

2259

1638

def func(*args, **kwargs):

2260

1639

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

2261

1640

return self._pipe.recv()[1]

2262

2263

1641

return func

2264

1642

2265

1643

def __setattr__(self, name, value):

2266

1644

if name == '_pipe':

2267

1645

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

2270

1648

2271

1649

class ClientHandler(socketserver.BaseRequestHandler, object):

2272

1650

"""A class to handle client connections.

2273

1651

2274

1652

Instantiated once for each connection to handle it.

2275

1653

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

2276

1654

2277

1655

def handle(self):

2278

1656

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

2279

1657

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

2280

str(self.client_address))

1658

unicode(self.client_address))

2281

1659

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

2282

1660

self.server.child_pipe.fileno())

2283

2284

session = gnutls.ClientSession(self.request)

2285

2286

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

2287

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

2288

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

2289

# "+DHE-DSS"))

1661

1662

session = (gnutls.connection

1663

.ClientSession(self.request,

1664

gnutls.connection

1665

.X509Credentials()))

1666

1667

# Note: gnutls.connection.X509Credentials is really a

1668

# generic GnuTLS certificate credentials object so long as

1669

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

1670

# here despite using OpenPGP certificates.

1671

1672

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

1673

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

1674

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

1675

# "+DHE-DSS"))

2290

1676

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

2291

1677

priority = self.server.gnutls_priority

2292

1678

if priority is None:

2293

1679

priority = "NORMAL"

2294

gnutls.priority_set_direct(session._c_object,

2295

priority.encode("utf-8"),

2296

None)

2297

1680

(gnutls.library.functions

1681

.gnutls_priority_set_direct(session._c_object,

1682

priority, None))

1683

2298

1684

# Start communication using the Mandos protocol

2299

1685

# Get protocol number

2300

1686

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

2305

1691

except (ValueError, IndexError, RuntimeError) as error:

2306

1692

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

2307

1693

return

2308

1694

2309

1695

# Start GnuTLS connection

2310

1696

try:

2311

1697

session.handshake()

2312

except gnutls.Error as error:

1698

except gnutls.errors.GNUTLSError as error:

2313

1699

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

2314

1700

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

2315

1701

# established. Just abandon the request.

2316

1702

return

2317

1703

logger.debug("Handshake succeeded")

2318

1704

2319

1705

approval_required = False

2320

1706

try:

2321

if gnutls.has_rawpk:

2322

fpr = b""

2323

try:

2324

key_id = self.key_id(

2325

self.peer_certificate(session))

2326

except (TypeError, gnutls.Error) as error:

2327

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

2328

return

2329

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

2330

2331

else:

2332

key_id = b""

2333

try:

2334

fpr = self.fingerprint(

2335

self.peer_certificate(session))

2336

except (TypeError, gnutls.Error) as error:

2337

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

2338

return

2339

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

2340

2341

try:

2342

client = ProxyClient(child_pipe, key_id, fpr,

1707

try:

1708

fpr = self.fingerprint(self.peer_certificate

1709

(session))

1710

except (TypeError,

1711

gnutls.errors.GNUTLSError) as error:

1712

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

1713

return

1714

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

1715

1716

try:

1717

client = ProxyClient(child_pipe, fpr,

2343

1718

self.client_address)

2344

1719

except KeyError:

2345

1720

return

2346

1721

2347

1722

if client.approval_delay:

2348

1723

delay = client.approval_delay

2349

1724

client.approvals_pending += 1

2350

1725

approval_required = True

2351

1726

2352

1727

while True:

2353

1728

if not client.enabled:

2354

1729

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

2355

client.name)

1730

client.name)

2356

1731

if self.server.use_dbus:

2357

1732

# Emit D-Bus signal

2358

1733

client.Rejected("Disabled")

2359

1734

return

2360

1735

2361

1736

if client.approved or not client.approval_delay:

2362

# We are approved or approval is disabled

1737

#We are approved or approval is disabled

2363

1738

break

2364

1739

elif client.approved is None:

2365

1740

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

2376

1751

# Emit D-Bus signal

2377

1752

client.Rejected("Denied")

2378

1753

return

2379

2380

# wait until timeout or approved

1754

1755

#wait until timeout or approved

2381

1756

time = datetime.datetime.now()

2382

1757

client.changedstate.acquire()

2383

1758

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

2396

1771

break

2397

1772

else:

2398

1773

delay -= time2 - time

2399

2400

try:

2401

session.send(client.secret)

2402

except gnutls.Error as error:

2403

logger.warning("gnutls send failed",

2404

exc_info=error)

2405

return

2406

1774

1775

sent_size = 0

1776

while sent_size < len(client.secret):

1777

try:

1778

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

1779

except gnutls.errors.GNUTLSError as error:

1780

logger.warning("gnutls send failed",

1781

exc_info=error)

1782

return

1783

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

1784

sent, len(client.secret)

1785

- (sent_size + sent))

1786

sent_size += sent

1787

2407

1788

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

2408

1789

# bump the timeout using extended_timeout

2409

1790

client.bump_timeout(client.extended_timeout)

2410

1791

if self.server.use_dbus:

2411

1792

# Emit D-Bus signal

2412

1793

client.GotSecret()

2413

1794

2414

1795

finally:

2415

1796

if approval_required:

2416

1797

client.approvals_pending -= 1

2417

1798

try:

2418

1799

session.bye()

2419

except gnutls.Error as error:

1800

except gnutls.errors.GNUTLSError as error:

2420

1801

logger.warning("GnuTLS bye failed",

2421

1802

exc_info=error)

2422

1803

2423

1804

@staticmethod

2424

1805

def peer_certificate(session):

2425

"Return the peer's certificate as a bytestring"

2426

try:

2427

cert_type = gnutls.certificate_type_get2(session._c_object,

2428

gnutls.CTYPE_PEERS)

2429

except AttributeError:

2430

cert_type = gnutls.certificate_type_get(session._c_object)

2431

if gnutls.has_rawpk:

2432

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2433

else:

2434

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2435

# If not a valid certificate type...

2436

if cert_type not in valid_cert_types:

2437

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

2438

valid_cert_types)

2439

# ...return invalid data

2440

return b""

1806

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

1807

# If not an OpenPGP certificate...

1808

if (gnutls.library.functions

1809

.gnutls_certificate_type_get(session._c_object)

1810

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1811

# ...do the normal thing

1812

return session.peer_certificate

2441

1813

list_size = ctypes.c_uint(1)

2442

cert_list = (gnutls.certificate_get_peers

1814

cert_list = (gnutls.library.functions

1815

.gnutls_certificate_get_peers

2443

1816

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

2444

1817

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

2445

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

1818

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

1819

" certificate")

2446

1820

if list_size.value == 0:

2447

1821

return None

2448

1822

cert = cert_list[0]

2449

1823

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

2450

2451

@staticmethod

2452

def key_id(certificate):

2453

"Convert a certificate bytestring to a hexdigit key ID"

2454

# New GnuTLS "datum" with the public key

2455

datum = gnutls.datum_t(

2456

ctypes.cast(ctypes.c_char_p(certificate),

2457

ctypes.POINTER(ctypes.c_ubyte)),

2458

ctypes.c_uint(len(certificate)))

2459

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

2460

# New empty GnuTLS certificate

2461

pubkey = gnutls.pubkey_t()

2462

gnutls.pubkey_init(ctypes.byref(pubkey))

2463

# Import the raw public key into the certificate

2464

gnutls.pubkey_import(pubkey,

2465

ctypes.byref(datum),

2466

gnutls.X509_FMT_DER)

2467

# New buffer for the key ID

2468

buf = ctypes.create_string_buffer(32)

2469

buf_len = ctypes.c_size_t(len(buf))

2470

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

2471

gnutls.pubkey_get_key_id(pubkey,

2472

gnutls.KEYID_USE_SHA256,

2473

ctypes.cast(ctypes.byref(buf),

2474

ctypes.POINTER(ctypes.c_ubyte)),

2475

ctypes.byref(buf_len))

2476

# Deinit the certificate

2477

gnutls.pubkey_deinit(pubkey)

2478

2479

# Convert the buffer to a Python bytestring

2480

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

2481

# Convert the bytestring to hexadecimal notation

2482

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

2483

return hex_key_id

2484

1824

2485

1825

@staticmethod

2486

1826

def fingerprint(openpgp):

2487

1827

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2488

1828

# New GnuTLS "datum" with the OpenPGP public key

2489

datum = gnutls.datum_t(

2490

ctypes.cast(ctypes.c_char_p(openpgp),

2491

ctypes.POINTER(ctypes.c_ubyte)),

2492

ctypes.c_uint(len(openpgp)))

1829

datum = (gnutls.library.types

1830

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

1831

ctypes.POINTER

1832

(ctypes.c_ubyte)),

1833

ctypes.c_uint(len(openpgp))))

2493

1834

# New empty GnuTLS certificate

2494

crt = gnutls.openpgp_crt_t()

2495

gnutls.openpgp_crt_init(ctypes.byref(crt))

1835

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1836

(gnutls.library.functions

1837

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2496

1838

# Import the OpenPGP public key into the certificate

2497

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

2498

gnutls.OPENPGP_FMT_RAW)

1839

(gnutls.library.functions

1840

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

1841

gnutls.library.constants

1842

.GNUTLS_OPENPGP_FMT_RAW))

2499

1843

# Verify the self signature in the key

2500

1844

crtverify = ctypes.c_uint()

2501

gnutls.openpgp_crt_verify_self(crt, 0,

2502

ctypes.byref(crtverify))

1845

(gnutls.library.functions

1846

.gnutls_openpgp_crt_verify_self(crt, 0,

1847

ctypes.byref(crtverify)))

2503

1848

if crtverify.value != 0:

2504

gnutls.openpgp_crt_deinit(crt)

2505

raise gnutls.CertificateSecurityError(code

2506

=crtverify.value)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1850

raise (gnutls.errors.CertificateSecurityError

1851

("Verify failed"))

2507

1852

# New buffer for the fingerprint

2508

1853

buf = ctypes.create_string_buffer(20)

2509

1854

buf_len = ctypes.c_size_t()

2510

1855

# Get the fingerprint from the certificate into the buffer

2511

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

2512

ctypes.byref(buf_len))

1856

(gnutls.library.functions

1857

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

1858

ctypes.byref(buf_len)))

2513

1859

# Deinit the certificate

2514

gnutls.openpgp_crt_deinit(crt)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2515

1861

# Convert the buffer to a Python bytestring

2516

1862

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

2517

1863

# Convert the bytestring to hexadecimal notation

2519

1865

return hex_fpr

2520

1866

2521

1867

2522

class MultiprocessingMixIn:

1868

class MultiprocessingMixIn(object):

2523

1869

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

2524

2525

1870

def sub_process_main(self, request, address):

2526

1871

try:

2527

1872

self.finish_request(request, address)

2528

1873

except Exception:

2529

1874

self.handle_error(request, address)

2530

1875

self.close_request(request)

2531

1876

2532

1877

def process_request(self, request, address):

2533

1878

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

2534

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

2535

args=(request, address))

1879

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

1880

args = (request, address))

2536

1881

proc.start()

2537

1882

return proc

2538

1883

2539

1884

2540

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1885

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2541

1886

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

2542

2543

1887

def process_request(self, request, client_address):

2544

1888

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

2545

1889

2546

1890

This function creates a new pipe in self.pipe

2547

1891

"""

2548

1892

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2549

1893

2550

1894

proc = MultiprocessingMixIn.process_request(self, request,

2551

1895

client_address)

2552

1896

self.child_pipe.close()

2553

1897

self.add_pipe(parent_pipe, proc)

2554

1898

2555

1899

def add_pipe(self, parent_pipe, proc):

2556

1900

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

2557

1901

raise NotImplementedError()

2558

1902

2559

1903

2560

1904

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2561

socketserver.TCPServer):

1905

socketserver.TCPServer, object):

2562

1906

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

2563

1907

2564

1908

Attributes:

2565

1909

enabled: Boolean; whether this server is activated yet

2566

1910

interface: None or a network interface name (string)

2567

1911

use_ipv6: Boolean; to use IPv6 or not

2568

1912

"""

2569

2570

1913

def __init__(self, server_address, RequestHandlerClass,

2571

interface=None,

2572

use_ipv6=True,

2573

socketfd=None):

1914

interface=None, use_ipv6=True, socketfd=None):

2574

1915

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

2575

1916

creating a new one with socket.socket().

2576

1917

"""

2582

1923

self.socketfd = socketfd

2583

1924

# Save the original socket.socket() function

2584

1925

self.socket_socket = socket.socket

2585

2586

1926

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

2587

#

1927

#

2588

1928

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

2589

1929

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

2590

1930

# patching socket.socket.)

2591

#

1931

#

2592

1932

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

2593

1933

@functools.wraps(socket.socket)

2594

1934

def socket_wrapper(*args, **kwargs):

2606

1946

# socket_wrapper(), if socketfd was set.

2607

1947

socketserver.TCPServer.__init__(self, server_address,

2608

1948

RequestHandlerClass)

2609

1949

2610

1950

def server_bind(self):

2611

1951

"""This overrides the normal server_bind() function

2612

1952

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

2613

1953

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

2614

global SO_BINDTODEVICE

2615

1954

if self.interface is not None:

2616

1955

if SO_BINDTODEVICE is None:

2617

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

2618

# common enough.

2619

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

2620

SO_BINDTODEVICE = 25

2621

try:

2622

self.socket.setsockopt(

2623

socket.SOL_SOCKET, SO_BINDTODEVICE,

2624

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

2625

except socket.error as error:

2626

if error.errno == errno.EPERM:

2627

logger.error("No permission to bind to"

2628

" interface %s", self.interface)

2629

elif error.errno == errno.ENOPROTOOPT:

2630

logger.error("SO_BINDTODEVICE not available;"

2631

" cannot bind to interface %s",

2632

self.interface)

2633

elif error.errno == errno.ENODEV:

2634

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

2635

" cannot bind", self.interface)

2636

else:

2637

raise

1956

logger.error("SO_BINDTODEVICE does not exist;"

1957

" cannot bind to interface %s",

1958

self.interface)

1959

else:

1960

try:

1961

self.socket.setsockopt(socket.SOL_SOCKET,

1962

SO_BINDTODEVICE,

1963

str(self.interface + '\0'))

1964

except socket.error as error:

1965

if error.errno == errno.EPERM:

1966

logger.error("No permission to bind to"

1967

" interface %s", self.interface)

1968

elif error.errno == errno.ENOPROTOOPT:

1969

logger.error("SO_BINDTODEVICE not available;"

1970

" cannot bind to interface %s",

1971

self.interface)

1972

elif error.errno == errno.ENODEV:

1973

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

1974

" cannot bind", self.interface)

1975

else:

1976

raise

2638

1977

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

2639

1978

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

2640

if self.server_address[1]:

2641

self.allow_reuse_address = True

2642

1979

if not self.server_address[0]:

2643

1980

if self.address_family == socket.AF_INET6:

2644

any_address = "::" # in6addr_any

1981

any_address = "::" # in6addr_any

2645

1982

else:

2646

any_address = "0.0.0.0" # INADDR_ANY

1983

any_address = "0.0.0.0" # INADDR_ANY

2647

1984

self.server_address = (any_address,

2648

1985

self.server_address[1])

2649

1986

elif not self.server_address[1]:

2650

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

1987

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

1988

0)

2651

1989

# if self.interface:

2652

1990

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

2653

1991

# 0, # port

2659

1997

2660

1998

class MandosServer(IPv6_TCPServer):

2661

1999

"""Mandos server.

2662

2000

2663

2001

Attributes:

2664

2002

clients: set of Client objects

2665

2003

gnutls_priority GnuTLS priority string

2666

2004

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

2667

2668

Assumes a GLib.MainLoop event loop.

2005

2006

Assumes a gobject.MainLoop event loop.

2669

2007

"""

2670

2671

2008

def __init__(self, server_address, RequestHandlerClass,

2672

interface=None,

2673

use_ipv6=True,

2674

clients=None,

2675

gnutls_priority=None,

2676

use_dbus=True,

2677

socketfd=None):

2009

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

2010

gnutls_priority=None, use_dbus=True, socketfd=None):

2678

2011

self.enabled = False

2679

2012

self.clients = clients

2680

2013

if self.clients is None:

2683

2016

self.gnutls_priority = gnutls_priority

2684

2017

IPv6_TCPServer.__init__(self, server_address,

2685

2018

RequestHandlerClass,

2686

interface=interface,

2687

use_ipv6=use_ipv6,

2688

socketfd=socketfd)

2689

2019

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

2690

2022

def server_activate(self):

2691

2023

if self.enabled:

2692

2024

return socketserver.TCPServer.server_activate(self)

2693

2025

2694

2026

def enable(self):

2695

2027

self.enabled = True

2696

2028

2697

2029

def add_pipe(self, parent_pipe, proc):

2698

2030

# Call "handle_ipc" for both data and EOF events

2699

GLib.io_add_watch(

2700

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

2701

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

2702

functools.partial(self.handle_ipc,

2703

parent_pipe=parent_pipe,

2704

proc=proc))

2705

2706

def handle_ipc(self, source, condition,

2707

parent_pipe=None,

2708

proc=None,

2709

client_object=None):

2031

gobject.io_add_watch(parent_pipe.fileno(),

2032

gobject.IO_IN | gobject.IO_HUP,

2033

functools.partial(self.handle_ipc,

2034

parent_pipe =

2035

parent_pipe,

2036

proc = proc))

2037

2038

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

2039

proc = None, client_object=None):

2710

2040

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

2711

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

2041

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

2712

2042

# Wait for other process to exit

2713

2043

proc.join()

2714

2044

return False

2715

2045

2716

2046

# Read a request from the child

2717

2047

request = parent_pipe.recv()

2718

2048

command = request[0]

2719

2049

2720

2050

if command == 'init':

2721

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

2722

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

2723

address = request[3]

2724

2725

for c in self.clients.values():

2726

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2727

continue

2728

if key_id and c.key_id == key_id:

2729

client = c

2730

break

2731

if fpr and c.fingerprint == fpr:

2051

fpr = request[1]

2052

address = request[2]

2053

2054

for c in self.clients.itervalues():

2055

if c.fingerprint == fpr:

2732

2056

client = c

2733

2057

break

2734

2058

else:

2735

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

2736

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

2059

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

2060

"dress: %s", fpr, address)

2737

2061

if self.use_dbus:

2738

2062

# Emit D-Bus signal

2739

mandos_dbus_service.ClientNotFound(key_id or fpr,

2063

mandos_dbus_service.ClientNotFound(fpr,

2740

2064

address[0])

2741

2065

parent_pipe.send(False)

2742

2066

return False

2743

2744

GLib.io_add_watch(

2745

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

2746

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

2747

functools.partial(self.handle_ipc,

2748

parent_pipe=parent_pipe,

2749

proc=proc,

2750

client_object=client))

2067

2068

gobject.io_add_watch(parent_pipe.fileno(),

2069

gobject.IO_IN | gobject.IO_HUP,

2070

functools.partial(self.handle_ipc,

2071

parent_pipe =

2072

parent_pipe,

2073

proc = proc,

2074

client_object =

2075

client))

2751

2076

parent_pipe.send(True)

2752

2077

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

2753

2078

# same fileno

2756

2081

funcname = request[1]

2757

2082

args = request[2]

2758

2083

kwargs = request[3]

2759

2084

2760

2085

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

2761

2086

funcname)(*args,

2762

**kwargs)))

2763

2087

**kwargs)))

2088

2764

2089

if command == 'getattr':

2765

2090

attrname = request[1]

2766

if isinstance(client_object.__getattribute__(attrname),

2767

collections.abc.Callable):

2768

parent_pipe.send(('function', ))

2091

if callable(client_object.__getattribute__(attrname)):

2092

parent_pipe.send(('function',))

2769

2093

else:

2770

parent_pipe.send((

2771

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

2772

2094

parent_pipe.send(('data', client_object

2095

.__getattribute__(attrname)))

2096

2773

2097

if command == 'setattr':

2774

2098

attrname = request[1]

2775

2099

value = request[2]

2776

2100

setattr(client_object, attrname, value)

2777

2101

2778

2102

return True

2779

2103

2780

2104

2781

2105

def rfc3339_duration_to_delta(duration):

2782

2106

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

2783

2784

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

2785

True

2786

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

2787

True

2788

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

2789

True

2790

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

2791

True

2792

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

2793

True

2794

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

2795

True

2796

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

2797

True

2107

2108

>>> rfc3339_duration_to_delta("P7D")

2109

datetime.timedelta(7)

2110

>>> rfc3339_duration_to_delta("PT60S")

2111

datetime.timedelta(0, 60)

2112

>>> rfc3339_duration_to_delta("PT60M")

2113

datetime.timedelta(0, 3600)

2114

>>> rfc3339_duration_to_delta("PT24H")

2115

datetime.timedelta(1)

2116

>>> rfc3339_duration_to_delta("P1W")

2117

datetime.timedelta(7)

2118

>>> rfc3339_duration_to_delta("PT5M30S")

2119

datetime.timedelta(0, 330)

2120

>>> rfc3339_duration_to_delta("P1DT3M20S")

2121

datetime.timedelta(1, 200)

2798

2122

"""

2799

2123

2800

2124

# Parsing an RFC 3339 duration with regular expressions is not

2801

2125

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

2802

2126

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

2803

2127

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

2804

2128

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

2805

2129

# avoid excessive use of external libraries.

2806

2130

2807

2131

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

2808

Token = collections.namedtuple("Token", (

2809

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

2810

# a "group" containing digits

2811

"value", # datetime.timedelta or None

2812

"followers")) # Tokens valid after this token

2132

Token = collections.namedtuple("Token",

2133

("regexp", # To match token; if

2134

# "value" is not None,

2135

# must have a "group"

2136

# containing digits

2137

"value", # datetime.timedelta or

2138

# None

2139

"followers")) # Tokens valid after

2140

# this token

2813

2141

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

2814

2142

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

2815

2143

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

2816

2144

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

2817

2145

datetime.timedelta(seconds=1),

2818

frozenset((token_end, )))

2146

frozenset((token_end,)))

2819

2147

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

2820

2148

datetime.timedelta(minutes=1),

2821

2149

frozenset((token_second, token_end)))

2837

2165

frozenset((token_month, token_end)))

2838

2166

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

2839

2167

datetime.timedelta(weeks=1),

2840

frozenset((token_end, )))

2168

frozenset((token_end,)))

2841

2169

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

2842

2170

frozenset((token_year, token_month,

2843

2171

token_day, token_time,

2844

2172

token_week)))

2845

# Define starting values:

2846

# Value so far

2847

value = datetime.timedelta()

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2848

2175

found_token = None

2849

# Following valid tokens

2850

followers = frozenset((token_duration, ))

2851

# String left to parse

2852

s = duration

2176

followers = frozenset((token_duration,)) # Following valid tokens

2177

s = duration # String left to parse

2853

2178

# Loop until end token is found

2854

2179

while found_token is not token_end:

2855

2180

# Search for any currently valid tokens

2871

2196

break

2872

2197

else:

2873

2198

# No currently valid tokens were found

2874

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

2875

.format(duration))

2199

raise ValueError("Invalid RFC 3339 duration")

2876

2200

# End token found

2877

2201

return value

2878

2202

2879

2203

2880

2204

def string_to_delta(interval):

2881

2205

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

2882

2883

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

2884

True

2885

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

2886

True

2887

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

2888

True

2889

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

2890

True

2891

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

2892

True

2893

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

2894

True

2206

2207

>>> string_to_delta('7d')

2208

datetime.timedelta(7)

2209

>>> string_to_delta('60s')

2210

datetime.timedelta(0, 60)

2211

>>> string_to_delta('60m')

2212

datetime.timedelta(0, 3600)

2213

>>> string_to_delta('24h')

2214

datetime.timedelta(1)

2215

>>> string_to_delta('1w')

2216

datetime.timedelta(7)

2217

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

2218

datetime.timedelta(0, 330)

2895

2219

"""

2896

2220

2897

2221

try:

2898

2222

return rfc3339_duration_to_delta(interval)

2899

2223

except ValueError:

2900

2224

pass

2901

2225

2902

2226

timevalue = datetime.timedelta(0)

2903

2227

for s in interval.split():

2904

2228

try:

2905

suffix = s[-1]

2229

suffix = unicode(s[-1])

2906

2230

value = int(s[:-1])

2907

2231

if suffix == "d":

2908

2232

delta = datetime.timedelta(value)

2915

2239

elif suffix == "w":

2916

2240

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

2917

2241

else:

2918

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

2242

raise ValueError("Unknown suffix {!r}"

2243

.format(suffix))

2919

2244

except IndexError as e:

2920

2245

raise ValueError(*(e.args))

2921

2246

timevalue += delta

2922

2247

return timevalue

2923

2248

2924

2249

2925

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

2250

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

2926

2251

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

2927

2252

2928

2253

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

2929

2254

if os.fork():

2930

2255

sys.exit()

2937

2262

# Close all standard open file descriptors

2938

2263

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

2939

2264

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

2940

raise OSError(errno.ENODEV,

2941

"{} not a character device"

2265

raise OSError(errno.ENODEV, "{} not a character device"

2942

2266

.format(os.devnull))

2943

2267

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

2944

2268

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

2948

2272

2949

2273

2950

2274

def main():

2951

2275

2952

2276

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

2953

2277

# Parsing of options, both command line and config file

2954

2278

2955

2279

parser = argparse.ArgumentParser()

2956

2280

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

2957

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

2281

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

2958

2282

help="show version number and exit")

2959

2283

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

2960

2284

help="Bind to interface IF")

2996

2320

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

2997

2321

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

2998

2322

default=None)

2999

2323

3000

2324

options = parser.parse_args()

3001

2325

2326

if options.check:

2327

import doctest

2328

fail_count, test_count = doctest.testmod()

2329

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

2330

3002

2331

# Default values for config file for server-global settings

3003

if gnutls.has_rawpk:

3004

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

3005

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

3006

else:

3007

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

3008

":+SIGN-DSA-SHA256")

3009

server_defaults = {"interface": "",

3010

"address": "",

3011

"port": "",

3012

"debug": "False",

3013

"priority": priority,

3014

"servicename": "Mandos",

3015

"use_dbus": "True",

3016

"use_ipv6": "True",

3017

"debuglevel": "",

3018

"restore": "True",

3019

"socket": "",

3020

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

3021

"foreground": "False",

3022

"zeroconf": "True",

3023

}

3024

del priority

3025

2332

server_defaults = { "interface": "",

2333

"address": "",

2334

"port": "",

2335

"debug": "False",

2336

"priority":

2337

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2338

"servicename": "Mandos",

2339

"use_dbus": "True",

2340

"use_ipv6": "True",

2341

"debuglevel": "",

2342

"restore": "True",

2343

"socket": "",

2344

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

2345

"foreground": "False",

2346

"zeroconf": "True",

2347

}

2348

3026

2349

# Parse config file for server-global settings

3027

server_config = configparser.ConfigParser(server_defaults)

2350

server_config = configparser.SafeConfigParser(server_defaults)

3028

2351

del server_defaults

3029

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

3030

# Convert the ConfigParser object to a dict

2352

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

2353

"mandos.conf"))

2354

# Convert the SafeConfigParser object to a dict

3031

2355

server_settings = server_config.defaults()

3032

2356

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

3033

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

3034

"foreground", "zeroconf"):

2357

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

3035

2358

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

3036

2359

option)

3037

2360

if server_settings["port"]:

3047

2370

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

3048

2371

["socket"])

3049

2372

del server_config

3050

2373

3051

2374

# Override the settings from the config file with command line

3052

2375

# options, if set.

3053

2376

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

3054

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

3055

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

3056

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

2377

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

2378

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

2379

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

3057

2380

value = getattr(options, option)

3058

2381

if value is not None:

3059

2382

server_settings[option] = value

3060

2383

del options

3061

2384

# Force all strings to be unicode

3062

2385

for option in server_settings.keys():

3063

if isinstance(server_settings[option], bytes):

3064

server_settings[option] = (server_settings[option]

3065

.decode("utf-8"))

2386

if type(server_settings[option]) is str:

2387

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

3066

2388

# Force all boolean options to be boolean

3067

2389

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

3068

2390

"foreground", "zeroconf"):

3071

2393

if server_settings["debug"]:

3072

2394

server_settings["foreground"] = True

3073

2395

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

3074

2396

3075

2397

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

3076

3077

if (not server_settings["zeroconf"]

3078

and not (server_settings["port"]

3079

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

3080

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

3081

2398

2399

if (not server_settings["zeroconf"] and

2400

not (server_settings["port"]

2401

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

2402

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

2403

" Zeroconf")

2404

3082

2405

# For convenience

3083

2406

debug = server_settings["debug"]

3084

2407

debuglevel = server_settings["debuglevel"]

3088

2411

stored_state_file)

3089

2412

foreground = server_settings["foreground"]

3090

2413

zeroconf = server_settings["zeroconf"]

3091

2414

3092

2415

if debug:

3093

2416

initlogger(debug, logging.DEBUG)

3094

2417

else:

3097

2420

else:

3098

2421

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

3099

2422

initlogger(debug, level)

3100

2423

3101

2424

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

3102

syslogger.setFormatter(

3103

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

3104

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

3105

server_settings["servicename"])))

3106

2425

syslogger.setFormatter(logging.Formatter

2426

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

2427

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

2428

.format(server_settings

2429

["servicename"])))

2430

3107

2431

# Parse config file with clients

3108

client_config = configparser.ConfigParser(Client.client_defaults)

2432

client_config = configparser.SafeConfigParser(Client

2433

.client_defaults)

3109

2434

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

3110

2435

"clients.conf"))

3111

2436

3112

2437

global mandos_dbus_service

3113

2438

mandos_dbus_service = None

3114

2439

3115

2440

socketfd = None

3116

2441

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

3117

2442

socketfd = server_settings["socket"]

3118

tcp_server = MandosServer(

3119

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

3120

ClientHandler,

3121

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

3122

use_ipv6=use_ipv6,

3123

gnutls_priority=server_settings["priority"],

3124

use_dbus=use_dbus,

3125

socketfd=socketfd)

2443

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

2444

server_settings["port"]),

2445

ClientHandler,

2446

interface=(server_settings["interface"]

2447

or None),

2448

use_ipv6=use_ipv6,

2449

gnutls_priority=

2450

server_settings["priority"],

2451

use_dbus=use_dbus,

2452

socketfd=socketfd)

3126

2453

if not foreground:

3127

2454

pidfilename = "/run/mandos.pid"

3128

2455

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

3129

2456

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

3130

2457

pidfile = None

3131

2458

try:

3132

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

2459

pidfile = open(pidfilename, "w")

3133

2460

except IOError as e:

3134

2461

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

3135

2462

exc_info=e)

3136

3137

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

3138

("mandos", "mandos"),

3139

("nobody", "nogroup")):

2463

2464

for name in ("_mandos", "mandos", "nobody"):

3140

2465

try:

3141

2466

uid = pwd.getpwnam(name).pw_uid

3142

gid = pwd.getpwnam(group).pw_gid

2467

gid = pwd.getpwnam(name).pw_gid

3143

2468

break

3144

2469

except KeyError:

3145

2470

continue

3149

2474

try:

3150

2475

os.setgid(gid)

3151

2476

os.setuid(uid)

3152

if debug:

3153

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

3154

gid))

3155

2477

except OSError as error:

3156

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

3157

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

3158

2478

if error.errno != errno.EPERM:

3159

2479

raise

3160

2480

3161

2481

if debug:

3162

2482

# Enable all possible GnuTLS debugging

3163

2483

3164

2484

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

3165

2485

# - GnuTLS manual

3166

gnutls.global_set_log_level(11)

3167

3168

@gnutls.log_func

2486

gnutls.library.functions.gnutls_global_set_log_level(11)

2487

2488

@gnutls.library.types.gnutls_log_func

3169

2489

def debug_gnutls(level, string):

3170

2490

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

3171

3172

gnutls.global_set_log_function(debug_gnutls)

3173

2491

2492

(gnutls.library.functions

2493

.gnutls_global_set_log_function(debug_gnutls))

2494

3174

2495

# Redirect stdin so all checkers get /dev/null

3175

2496

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

3176

2497

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

3177

2498

if null > 2:

3178

2499

os.close(null)

3179

2500

3180

2501

# Need to fork before connecting to D-Bus

3181

2502

if not foreground:

3182

2503

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

3183

2504

daemon()

3184

3185

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

3186

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

3187

# need to inform GLib that threads will be used.

3188

GLib.threads_init()

3189

2505

2506

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

2507

# need to inform gobject that threads will be used.

2508

gobject.threads_init()

2509

3190

2510

global main_loop

3191

2511

# From the Avahi example code

3192

2512

DBusGMainLoop(set_as_default=True)

3193

main_loop = GLib.MainLoop()

2513

main_loop = gobject.MainLoop()

3194

2514

bus = dbus.SystemBus()

3195

2515

# End of Avahi example code

3196

2516

if use_dbus:

3197

2517

try:

3198

2518

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

3199

bus,

3200

do_not_queue=True)

3201

old_bus_name = dbus.service.BusName(

3202

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

3203

do_not_queue=True)

3204

except dbus.exceptions.DBusException as e:

2519

bus, do_not_queue=True)

2520

old_bus_name = (dbus.service.BusName

2521

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

2522

do_not_queue=True))

2523

except dbus.exceptions.NameExistsException as e:

3205

2524

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

3206

2525

use_dbus = False

3207

2526

server_settings["use_dbus"] = False

3208

2527

tcp_server.use_dbus = False

3209

2528

if zeroconf:

3210

2529

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3211

service = AvahiServiceToSyslog(

3212

name=server_settings["servicename"],

3213

servicetype="_mandos._tcp",

3214

protocol=protocol,

3215

bus=bus)

2530

service = AvahiServiceToSyslog(name =

2531

server_settings["servicename"],

2532

servicetype = "_mandos._tcp",

2533

protocol = protocol, bus = bus)

3216

2534

if server_settings["interface"]:

3217

service.interface = if_nametoindex(

3218

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

3219

2535

service.interface = (if_nametoindex

2536

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

2537

3220

2538

global multiprocessing_manager

3221

2539

multiprocessing_manager = multiprocessing.Manager()

3222

2540

3223

2541

client_class = Client

3224

2542

if use_dbus:

3225

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

3226

2543

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

2544

3227

2545

client_settings = Client.config_parser(client_config)

3228

2546

old_client_settings = {}

3229

2547

clients_data = {}

3230

2548

3231

2549

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

3232

2550

global wnull

3233

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

2551

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

3234

2552

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

3235

2553

# mode

3236

2554

if debug or not foreground:

3237

2555

wnull.close()

3238

2556

3239

2557

# Get client data and settings from last running state.

3240

2558

if server_settings["restore"]:

3241

2559

try:

3242

2560

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

3243

if sys.version_info.major == 2:

3244

clients_data, old_client_settings = pickle.load(

3245

stored_state)

3246

else:

3247

bytes_clients_data, bytes_old_client_settings = (

3248

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

3249

# Fix bytes to strings

3250

# clients_data

3251

# .keys()

3252

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

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_clients_data.items()}

3257

del bytes_clients_data

3258

for key in clients_data:

3259

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

3260

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

3261

for k, v in

3262

clients_data[key].items()}

3263

clients_data[key] = value

3264

# .client_structure

3265

value["client_structure"] = [

3266

(s.decode("utf-8")

3267

if isinstance(s, bytes)

3268

else s) for s in

3269

value["client_structure"]]

3270

# .name, .host, and .checker_command

3271

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

3272

if isinstance(value[k], bytes):

3273

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

3274

if "key_id" not in value:

3275

value["key_id"] = ""

3276

elif "fingerprint" not in value:

3277

value["fingerprint"] = ""

3278

# old_client_settings

3279

# .keys()

3280

old_client_settings = {

3281

(key.decode("utf-8")

3282

if isinstance(key, bytes)

3283

else key): value

3284

for key, value in

3285

bytes_old_client_settings.items()}

3286

del bytes_old_client_settings

3287

# .host and .checker_command

3288

for value in old_client_settings.values():

3289

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

3290

if isinstance(value[attribute], bytes):

3291

value[attribute] = (value[attribute]

3292

.decode("utf-8"))

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3293

2563

os.remove(stored_state_path)

3294

2564

except IOError as e:

3295

2565

if e.errno == errno.ENOENT:

3296

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

3297

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

2566

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

2567

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

3298

2568

else:

3299

2569

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

3300

2570

exc_info=e)

3301

2571

raise

3302

2572

except EOFError as e:

3303

2573

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

3304

"EOFError:",

3305

exc_info=e)

3306

2574

"EOFError:", exc_info=e)

2575

3307

2576

with PGPEngine() as pgp:

3308

2577

for client_name, client in clients_data.items():

3309

2578

# Skip removed clients

3310

2579

if client_name not in client_settings:

3311

2580

continue

3312

2581

3313

2582

# Decide which value to use after restoring saved state.

3314

2583

# We have three different values: Old config file,

3315

2584

# new config file, and saved state.

3320

2589

# For each value in new config, check if it

3321

2590

# differs from the old config value (Except for

3322

2591

# the "secret" attribute)

3323

if (name != "secret"

3324

and (value !=

3325

old_client_settings[client_name][name])):

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3326

2595

client[name] = value

3327

2596

except KeyError:

3328

2597

pass

3329

2598

3330

2599

# Clients who has passed its expire date can still be

3331

# enabled if its last checker was successful. A Client

2600

# enabled if its last checker was successful. Clients

3332

2601

# whose checker succeeded before we stored its state is

3333

2602

# assumed to have successfully run all checkers during

3334

2603

# downtime.

3337

2606

if not client["last_checked_ok"]:

3338

2607

logger.warning(

3339

2608

"disabling client {} - Client never "

3340

"performed a successful checker".format(

3341

client_name))

2609

"performed a successful checker"

2610

.format(client_name))

3342

2611

client["enabled"] = False

3343

2612

elif client["last_checker_status"] != 0:

3344

2613

logger.warning(

3345

2614

"disabling client {} - Client last"

3346

" checker failed with error code"

3347

" {}".format(

3348

client_name,

3349

client["last_checker_status"]))

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3350

2618

client["enabled"] = False

3351

2619

else:

3352

client["expires"] = (

3353

datetime.datetime.utcnow()

3354

+ client["timeout"])

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3355

2623

logger.debug("Last checker succeeded,"

3356

" keeping {} enabled".format(

3357

client_name))

2624

" keeping {} enabled"

2625

.format(client_name))

3358

2626

try:

3359

client["secret"] = pgp.decrypt(

3360

client["encrypted_secret"],

3361

client_settings[client_name]["secret"])

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3362

2631

except PGPError:

3363

2632

# If decryption fails, we use secret from new settings

3364

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

3365

client_name))

3366

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

3367

["secret"])

3368

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3369

2638

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

3370

2639

for client_name in (set(old_client_settings)

3371

2640

- set(client_settings)):

3373

2642

for client_name in (set(client_settings)

3374

2643

- set(old_client_settings)):

3375

2644

clients_data[client_name] = client_settings[client_name]

3376

2645

3377

2646

# Create all client objects

3378

2647

for client_name, client in clients_data.items():

3379

2648

tcp_server.clients[client_name] = client_class(

3380

name=client_name,

3381

settings=client,

3382

server_settings=server_settings)

3383

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3384

2652

if not tcp_server.clients:

3385

2653

logger.warning("No clients defined")

3386

2654

3387

2655

if not foreground:

3388

2656

if pidfile is not None:

3389

pid = os.getpid()

3390

2657

try:

3391

2658

with pidfile:

3392

print(pid, file=pidfile)

2659

pid = os.getpid()

2660

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

3393

2661

except IOError:

3394

2662

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

3395

2663

pidfilename, pid)

3396

2664

del pidfile

3397

2665

del pidfilename

3398

3399

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

3400

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3401

lambda: main_loop.quit() and False)

3402

2666

2667

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

2668

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

2669

3403

2670

if use_dbus:

3404

3405

@alternate_dbus_interfaces(

3406

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

3407

class MandosDBusService(DBusObjectWithObjectManager):

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3408

2674

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

3409

3410

2675

def __init__(self):

3411

2676

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

3412

3413

2677

_interface = "se.recompile.Mandos"

3414

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3415

2685

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

3416

2686

def ClientAdded(self, objpath):

3417

2687

"D-Bus signal"

3418

2688

pass

3419

2689

3420

2690

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

3421

def ClientNotFound(self, key_id, address):

2691

def ClientNotFound(self, fingerprint, address):

3422

2692

"D-Bus signal"

3423

2693

pass

3424

3425

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

3426

"true"})

2694

3427

2695

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

3428

2696

def ClientRemoved(self, objpath, name):

3429

2697

"D-Bus signal"

3430

2698

pass

3431

3432

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

3433

"true"})

2699

3434

2700

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

3435

2701

def GetAllClients(self):

3436

2702

"D-Bus method"

3437

return dbus.Array(c.dbus_object_path for c in

3438

tcp_server.clients.values())

3439

3440

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

3441

"true"})

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3442

2707

@dbus.service.method(_interface,

3443

2708

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

3444

2709

def GetAllClientsWithProperties(self):

3445

2710

"D-Bus method"

3446

2711

return dbus.Dictionary(

3447

{c.dbus_object_path: c.GetAll(

3448

"se.recompile.Mandos.Client")

3449

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

2712

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

2713

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

3450

2714

signature="oa{sv}")

3451

2715

3452

2716

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

3453

2717

def RemoveClient(self, object_path):

3454

2718

"D-Bus method"

3455

for c in tcp_server.clients.values():

2719

for c in tcp_server.clients.itervalues():

3456

2720

if c.dbus_object_path == object_path:

3457

2721

del tcp_server.clients[c.name]

3458

2722

c.remove_from_connection()

3459

# Don't signal the disabling

2723

# Don't signal anything except ClientRemoved

3460

2724

c.disable(quiet=True)

3461

# Emit D-Bus signal for removal

3462

self.client_removed_signal(c)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3463

2727

return

3464

2728

raise KeyError(object_path)

3465

2729

3466

2730

del _interface

3467

3468

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3469

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

3470

def GetManagedObjects(self):

3471

"""D-Bus method"""

3472

return dbus.Dictionary(

3473

{client.dbus_object_path:

3474

dbus.Dictionary(

3475

{interface: client.GetAll(interface)

3476

for interface in

3477

client._get_all_interface_names()})

3478

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

3479

3480

def client_added_signal(self, client):

3481

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

3482

if use_dbus:

3483

# New standard signal

3484

self.InterfacesAdded(

3485

client.dbus_object_path,

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()}))

3490

# Old signal

3491

self.ClientAdded(client.dbus_object_path)

3492

3493

def client_removed_signal(self, client):

3494

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

3495

if use_dbus:

3496

# New standard signal

3497

self.InterfacesRemoved(

3498

client.dbus_object_path,

3499

client._get_all_interface_names())

3500

# Old signal

3501

self.ClientRemoved(client.dbus_object_path,

3502

client.name)

3503

2731

3504

2732

mandos_dbus_service = MandosDBusService()

3505

3506

# Save modules to variables to exempt the modules from being

3507

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

3508

mp = multiprocessing

3509

wn = wnull

3510

2733

3511

2734

def cleanup():

3512

2735

"Cleanup function; run on exit"

3513

2736

if zeroconf:

3514

2737

service.cleanup()

3515

3516

mp.active_children()

3517

wn.close()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3518

2741

if not (tcp_server.clients or client_settings):

3519

2742

return

3520

2743

3521

2744

# Store client before exiting. Secrets are encrypted with key

3522

2745

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

3523

2746

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

3524

2747

clients = {}

3525

2748

with PGPEngine() as pgp:

3526

for client in tcp_server.clients.values():

2749

for client in tcp_server.clients.itervalues():

3527

2750

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

3528

2751

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

3529

2752

key)

3530

2753

client_dict = {}

3531

2754

3532

2755

# A list of attributes that can not be pickled

3533

2756

# + secret.

3534

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

3535

"checker", "server_settings"}

3536

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

3537

.Object):

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3538

2761

exclude.add(name)

3539

2762

3540

2763

client_dict["encrypted_secret"] = (client

3541

2764

.encrypted_secret)

3542

2765

for attr in client.client_structure:

3543

2766

if attr not in exclude:

3544

2767

client_dict[attr] = getattr(client, attr)

3545

2768

3546

2769

clients[client.name] = client_dict

3547

2770

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

3548

2771

3549

2772

try:

3550

with tempfile.NamedTemporaryFile(

3551

mode='wb',

3552

suffix=".pickle",

3553

prefix='clients-',

3554

dir=os.path.dirname(stored_state_path),

3555

delete=False) as stored_state:

3556

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

3557

protocol=2)

3558

tempname = stored_state.name

2773

with (tempfile.NamedTemporaryFile

2774

(mode='wb', suffix=".pickle", prefix='clients-',

2775

dir=os.path.dirname(stored_state_path),

2776

delete=False)) as stored_state:

2777

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

2778

tempname=stored_state.name

3559

2779

os.rename(tempname, stored_state_path)

3560

2780

except (IOError, OSError) as e:

3561

2781

if not debug:

3570

2790

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

3571

2791

exc_info=e)

3572

2792

raise

3573

2793

3574

2794

# Delete all clients, and settings from config

3575

2795

while tcp_server.clients:

3576

2796

name, client = tcp_server.clients.popitem()

3577

2797

if use_dbus:

3578

2798

client.remove_from_connection()

3579

# Don't signal the disabling

2799

# Don't signal anything except ClientRemoved

3580

2800

client.disable(quiet=True)

3581

# Emit D-Bus signal for removal

3582

2801

if use_dbus:

3583

mandos_dbus_service.client_removed_signal(client)

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3584

2806

client_settings.clear()

3585

2807

3586

2808

atexit.register(cleanup)

3587

3588

for client in tcp_server.clients.values():

2809

2810

for client in tcp_server.clients.itervalues():

3589

2811

if use_dbus:

3590

# Emit D-Bus signal for adding

3591

mandos_dbus_service.client_added_signal(client)

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3592

2814

# Need to initiate checking of clients

3593

2815

if client.enabled:

3594

2816

client.init_checker()

3595

2817

3596

2818

tcp_server.enable()

3597

2819

tcp_server.server_activate()

3598

2820

3599

2821

# Find out what port we got

3600

2822

if zeroconf:

3601

2823

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

3606

2828

else: # IPv4

3607

2829

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

3608

2830

*tcp_server.socket.getsockname())

3609

3610

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

3611

2831

2832

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

2833

3612

2834

try:

3613

2835

if zeroconf:

3614

2836

# From the Avahi example code

3619

2841

cleanup()

3620

2842

sys.exit(1)

3621

2843

# End of Avahi example code

3622

3623

GLib.io_add_watch(

3624

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

3625

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3626

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

3627

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

3628

2844

2845

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

2846

lambda *args, **kwargs:

2847

(tcp_server.handle_request

2848

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

2849

3629

2850

logger.debug("Starting main loop")

3630

2851

main_loop.run()

3631

2852

except AvahiError as error:

3640

2861

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

3641

2862

cleanup()

3642

2863

3643

3644

def should_only_run_tests():

3645

parser = argparse.ArgumentParser(add_help=False)

3646

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

3647

args, unknown_args = parser.parse_known_args()

3648

run_tests = args.check

3649

if run_tests:

3650

# Remove --check argument from sys.argv

3651

sys.argv[1:] = unknown_args

3652

return run_tests

3653

3654

# Add all tests from doctest strings

3655

def load_tests(loader, tests, none):

3656

import doctest

3657

tests.addTests(doctest.DocTestSuite())

3658

return tests

3659

3660

2864

if __name__ == '__main__':

3661

try:

3662

if should_only_run_tests():

3663

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

3664

unittest.main()

3665

else:

3666

main()

3667

finally:

3668

logging.shutdown()

2865

main()