/mandos/trunk : revision 237.4.55

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

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

147

95

stored_state_file = "clients.pickle"

148

96

149

97

logger = logging.getLogger()

150

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

151

98

syslogger = None

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

165

112

return interface_index

166

113

167

114

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

115

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

185

116

"""init logger and add loglevel"""

186

117

187

118

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

191

123

syslogger.setFormatter(logging.Formatter

192

124

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

193

125

' %(message)s'))

194

126

logger.addHandler(syslogger)

195

127

196

128

if debug:

197

129

console = logging.StreamHandler()

198

130

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

208

140

pass

209

141

210

142

211

class PGPEngine:

143

class PGPEngine(object):

212

144

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

213

214

145

def __init__(self):

215

146

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

147

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

148

'--home', self.tempdir,

229

149

'--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

150

'--quiet',

151

'--no-use-agent']

152

235

153

def __enter__(self):

236

154

return self

237

155

238

156

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

239

157

self._cleanup()

240

158

return False

241

159

242

160

def __del__(self):

243

161

self._cleanup()

244

162

245

163

def _cleanup(self):

246

164

if self.tempdir is not None:

247

165

# Delete contents of tempdir

248

166

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

249

topdown=False):

167

topdown = False):

250

168

for filename in files:

251

169

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

252

170

for dirname in dirs:

254

172

# Remove tempdir

255

173

os.rmdir(self.tempdir)

256

174

self.tempdir = None

257

175

258

176

def password_encode(self, password):

259

177

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

260

178

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

265

183

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

266

184

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

267

185

return encoded

268

186

269

187

def encrypt(self, data, password):

270

188

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

273

191

passfile.write(passphrase)

274

192

passfile.flush()

275

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

193

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

276

194

'--passphrase-file',

277

195

passfile.name]

278

196

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

283

201

if proc.returncode != 0:

284

202

raise PGPError(err)

285

203

return ciphertext

286

204

287

205

def decrypt(self, data, password):

288

206

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

291

209

passfile.write(passphrase)

292

210

passfile.flush()

293

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

211

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

294

212

'--passphrase-file',

295

213

passfile.name]

296

214

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

301

220

if proc.returncode != 0:

302

221

raise PGPError(err)

303

222

return decrypted_plaintext

304

223

305

224

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

225

class AvahiError(Exception):

333

226

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

334

227

self.value = value

335

228

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

336

229

**kwargs)

337

230

338

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 = str(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:

460

338

elif state == avahi.ENTRY_GROUP_FAILURE:

461

339

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

462

340

str(error))

463

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

464

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,

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

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

532

401

return ret

533

402

534

403

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class _session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(_session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class _openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code).decode(

598

"utf-8", errors="replace")

599

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

600

message, *args)

601

602

class CertificateSecurityError(Error):

603

pass

604

605

class PointerTo:

606

def __init__(self, cls):

607

self.cls = cls

608

609

def from_param(self, obj):

610

if not isinstance(obj, self.cls):

611

raise TypeError("Not of type {}: {!r}"

612

.format(self.cls.__name__, obj))

613

return ctypes.byref(obj.from_param(obj))

614

615

class CastToVoidPointer:

616

def __init__(self, cls):

617

self.cls = cls

618

619

def from_param(self, obj):

620

if not isinstance(obj, self.cls):

621

raise TypeError("Not of type {}: {!r}"

622

.format(self.cls.__name__, obj))

623

return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)

624

625

class With_from_param:

626

@classmethod

627

def from_param(cls, obj):

628

return obj._as_parameter_

629

630

# Classes

631

class Credentials(With_from_param):

632

def __init__(self):

633

self._as_parameter_ = gnutls.certificate_credentials_t()

634

gnutls.certificate_allocate_credentials(self)

635

self.type = gnutls.CRD_CERTIFICATE

636

637

def __del__(self):

638

gnutls.certificate_free_credentials(self)

639

640

class ClientSession(With_from_param):

641

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

642

self._as_parameter_ = gnutls.session_t()

643

gnutls_flags = gnutls.CLIENT

644

if gnutls.check_version(b"3.5.6"):

645

gnutls_flags |= gnutls.NO_TICKETS

646

if gnutls.has_rawpk:

647

gnutls_flags |= gnutls.ENABLE_RAWPK

648

gnutls.init(self, gnutls_flags)

649

del gnutls_flags

650

gnutls.set_default_priority(self)

651

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

652

gnutls.handshake_set_private_extensions(self, True)

653

self.socket = socket

654

if credentials is None:

655

credentials = gnutls.Credentials()

656

gnutls.credentials_set(self, credentials.type,

657

credentials)

658

self.credentials = credentials

659

660

def __del__(self):

661

gnutls.deinit(self)

662

663

def handshake(self):

664

return gnutls.handshake(self)

665

666

def send(self, data):

667

data = bytes(data)

668

data_len = len(data)

669

while data_len > 0:

670

data_len -= gnutls.record_send(self, data[-data_len:],

671

data_len)

672

673

def bye(self):

674

return gnutls.bye(self, gnutls.SHUT_RDWR)

675

676

# Error handling functions

677

def _error_code(result):

678

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

679

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

680

if result >= gnutls.E_SUCCESS:

681

return result

682

if result == gnutls.E_NO_CERTIFICATE_FOUND:

683

raise gnutls.CertificateSecurityError(code=result)

684

raise gnutls.Error(code=result)

685

686

def _retry_on_error(result, func, arguments,

687

_error_code=_error_code):

688

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

689

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

690

while result < gnutls.E_SUCCESS:

691

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

692

return _error_code(result)

693

result = func(*arguments)

694

return result

695

696

# Unless otherwise indicated, the function declarations below are

697

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

698

699

# Functions

700

priority_set_direct = _library.gnutls_priority_set_direct

701

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

702

ctypes.POINTER(ctypes.c_char_p)]

703

priority_set_direct.restype = _error_code

704

705

init = _library.gnutls_init

706

init.argtypes = [PointerTo(ClientSession), ctypes.c_int]

707

init.restype = _error_code

708

709

set_default_priority = _library.gnutls_set_default_priority

710

set_default_priority.argtypes = [ClientSession]

711

set_default_priority.restype = _error_code

712

713

record_send = _library.gnutls_record_send

714

record_send.argtypes = [ClientSession, ctypes.c_void_p,

715

ctypes.c_size_t]

716

record_send.restype = ctypes.c_ssize_t

717

record_send.errcheck = _retry_on_error

718

719

certificate_allocate_credentials = (

720

_library.gnutls_certificate_allocate_credentials)

721

certificate_allocate_credentials.argtypes = [

722

PointerTo(Credentials)]

723

certificate_allocate_credentials.restype = _error_code

724

725

certificate_free_credentials = (

726

_library.gnutls_certificate_free_credentials)

727

certificate_free_credentials.argtypes = [Credentials]

728

certificate_free_credentials.restype = None

729

730

handshake_set_private_extensions = (

731

_library.gnutls_handshake_set_private_extensions)

732

handshake_set_private_extensions.argtypes = [ClientSession,

733

ctypes.c_int]

734

handshake_set_private_extensions.restype = None

735

736

credentials_set = _library.gnutls_credentials_set

737

credentials_set.argtypes = [ClientSession, credentials_type_t,

738

CastToVoidPointer(Credentials)]

739

credentials_set.restype = _error_code

740

741

strerror = _library.gnutls_strerror

742

strerror.argtypes = [ctypes.c_int]

743

strerror.restype = ctypes.c_char_p

744

745

certificate_type_get = _library.gnutls_certificate_type_get

746

certificate_type_get.argtypes = [ClientSession]

747

certificate_type_get.restype = _error_code

748

749

certificate_get_peers = _library.gnutls_certificate_get_peers

750

certificate_get_peers.argtypes = [ClientSession,

751

ctypes.POINTER(ctypes.c_uint)]

752

certificate_get_peers.restype = ctypes.POINTER(datum_t)

753

754

global_set_log_level = _library.gnutls_global_set_log_level

755

global_set_log_level.argtypes = [ctypes.c_int]

756

global_set_log_level.restype = None

757

758

global_set_log_function = _library.gnutls_global_set_log_function

759

global_set_log_function.argtypes = [log_func]

760

global_set_log_function.restype = None

761

762

deinit = _library.gnutls_deinit

763

deinit.argtypes = [ClientSession]

764

deinit.restype = None

765

766

handshake = _library.gnutls_handshake

767

handshake.argtypes = [ClientSession]

768

handshake.restype = ctypes.c_int

769

handshake.errcheck = _retry_on_error

770

771

transport_set_ptr = _library.gnutls_transport_set_ptr

772

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

773

transport_set_ptr.restype = None

774

775

bye = _library.gnutls_bye

776

bye.argtypes = [ClientSession, close_request_t]

777

bye.restype = ctypes.c_int

778

bye.errcheck = _retry_on_error

779

780

check_version = _library.gnutls_check_version

781

check_version.argtypes = [ctypes.c_char_p]

782

check_version.restype = ctypes.c_char_p

783

784

_need_version = b"3.3.0"

785

if check_version(_need_version) is None:

786

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

787

.format(_need_version))

788

789

_tls_rawpk_version = b"3.6.6"

790

has_rawpk = bool(check_version(_tls_rawpk_version))

791

792

if has_rawpk:

793

# Types

794

class pubkey_st(ctypes.Structure):

795

_fields = []

796

pubkey_t = ctypes.POINTER(pubkey_st)

797

798

x509_crt_fmt_t = ctypes.c_int

799

800

# All the function declarations below are from

801

# gnutls/abstract.h

802

pubkey_init = _library.gnutls_pubkey_init

803

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

804

pubkey_init.restype = _error_code

805

806

pubkey_import = _library.gnutls_pubkey_import

807

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

808

x509_crt_fmt_t]

809

pubkey_import.restype = _error_code

810

811

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

812

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

813

ctypes.POINTER(ctypes.c_ubyte),

814

ctypes.POINTER(ctypes.c_size_t)]

815

pubkey_get_key_id.restype = _error_code

816

817

pubkey_deinit = _library.gnutls_pubkey_deinit

818

pubkey_deinit.argtypes = [pubkey_t]

819

pubkey_deinit.restype = None

820

else:

821

# All the function declarations below are from

822

# gnutls/openpgp.h

823

824

openpgp_crt_init = _library.gnutls_openpgp_crt_init

825

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

826

openpgp_crt_init.restype = _error_code

827

828

openpgp_crt_import = _library.gnutls_openpgp_crt_import

829

openpgp_crt_import.argtypes = [openpgp_crt_t,

830

ctypes.POINTER(datum_t),

831

openpgp_crt_fmt_t]

832

openpgp_crt_import.restype = _error_code

833

834

openpgp_crt_verify_self = \

835

_library.gnutls_openpgp_crt_verify_self

836

openpgp_crt_verify_self.argtypes = [

837

openpgp_crt_t,

838

ctypes.c_uint,

839

ctypes.POINTER(ctypes.c_uint),

840

]

841

openpgp_crt_verify_self.restype = _error_code

842

843

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

844

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

845

openpgp_crt_deinit.restype = None

846

847

openpgp_crt_get_fingerprint = (

848

_library.gnutls_openpgp_crt_get_fingerprint)

849

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

850

ctypes.c_void_p,

851

ctypes.POINTER(

852

ctypes.c_size_t)]

853

openpgp_crt_get_fingerprint.restype = _error_code

854

855

if check_version(b"3.6.4"):

856

certificate_type_get2 = _library.gnutls_certificate_type_get2

857

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

858

certificate_type_get2.restype = _error_code

859

860

# Remove non-public functions

861

del _error_code, _retry_on_error

862

863

864

def call_pipe(connection, # : multiprocessing.Connection

865

func, *args, **kwargs):

866

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

867

868

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

869

return value on the provided multiprocessing.Connection.

870

"""

871

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

872

connection.close()

873

874

875

class Client:

404

class Client(object):

876

405

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

877

406

878

407

Attributes:

879

408

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

880

409

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

881

410

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

882

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

883

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

884

running.

885

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

886

415

checker_command: string; External command which is run to check

887

416

if client lives. %() expansions are done at

888

417

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

889

418

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

890

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

891

420

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

892

421

client_structure: Object describing what attributes a client has

893

422

and is used for storing the client at exit

894

423

current_checker_command: string; current running checker_command

895

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

896

425

enabled: bool()

897

426

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

898

uniquely identify an OpenPGP client

899

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

900

a client using raw public keys

427

uniquely identify the client

901

428

host: string; available for use by the checker command

902

429

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

903

430

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

905

432

last_checker_status: integer between 0 and 255 reflecting exit

906

433

status of last checker. -1 reflects crashed

907

434

checker, -2 means no checker completed yet.

908

last_checker_signal: The signal which killed the last checker, if

909

last_checker_status is -1

910

435

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

911

436

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

912

437

D-Bus identifiers

919

444

disabled, or None

920

445

server_settings: The server_settings dict from main()

921

446

"""

922

447

923

448

runtime_expansions = ("approval_delay", "approval_duration",

924

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

449

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

925

450

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

926

451

"last_approval_request", "last_checked_ok",

927

452

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

928

client_defaults = {

929

"timeout": "PT5M",

930

"extended_timeout": "PT15M",

931

"interval": "PT2M",

932

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

933

"host": "",

934

"approval_delay": "PT0S",

935

"approval_duration": "PT1S",

936

"approved_by_default": "True",

937

"enabled": "True",

938

}

939

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

940

464

@staticmethod

941

465

def config_parser(config):

942

466

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

949

473

for client_name in config.sections():

950

474

section = dict(config.items(client_name))

951

475

client = settings[client_name] = {}

952

476

953

477

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

954

478

# Reformat values from string types to Python types

955

479

client["approved_by_default"] = config.getboolean(

956

480

client_name, "approved_by_default")

957

481

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

958

482

"enabled")

959

960

# Uppercase and remove spaces from key_id and fingerprint

961

# for later comparison purposes with return value from the

962

# key_id() and fingerprint() functions

963

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

964

.replace(" ", ""))

483

965

484

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

966

485

.replace(" ", ""))

967

486

if "secret" in section:

968

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

969

.encode("utf-8"),

970

"base64")

487

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

971

488

elif "secfile" in section:

972

489

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

973

490

(section["secfile"])),

988

505

client["last_approval_request"] = None

989

506

client["last_checked_ok"] = None

990

507

client["last_checker_status"] = -2

991

508

992

509

return settings

993

994

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

510

511

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

995

512

self.name = name

996

513

if server_settings is None:

997

514

server_settings = {}

999

516

# adding all client settings

1000

517

for setting, value in settings.items():

1001

518

setattr(self, setting, value)

1002

519

1003

520

if self.enabled:

1004

521

if not hasattr(self, "last_enabled"):

1005

522

self.last_enabled = datetime.datetime.utcnow()

1009

526

else:

1010

527

self.last_enabled = None

1011

528

self.expires = None

1012

529

1013

530

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

1014

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

1015

534

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

1016

535

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

1017

536

datetime.datetime.utcnow())

1018

537

1019

538

# attributes specific for this server instance

1020

539

self.checker = None

1021

540

self.checker_initiator_tag = None

1024

543

self.current_checker_command = None

1025

544

self.approved = None

1026

545

self.approvals_pending = 0

1027

self.changedstate = multiprocessing_manager.Condition(

1028

multiprocessing_manager.Lock())

1029

self.client_structure = [attr

1030

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

1031

551

if not attr.startswith("_")]

1032

552

self.client_structure.append("client_structure")

1033

1034

for name, t in inspect.getmembers(

1035

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

1036

558

if not name.startswith("_"):

1037

559

self.client_structure.append(name)

1038

560

1039

561

# Send notice to process children that client state has changed

1040

562

def send_changedstate(self):

1041

563

with self.changedstate:

1042

564

self.changedstate.notify_all()

1043

565

1044

566

def enable(self):

1045

567

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

1046

568

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

1051

573

self.last_enabled = datetime.datetime.utcnow()

1052

574

self.init_checker()

1053

575

self.send_changedstate()

1054

576

1055

577

def disable(self, quiet=True):

1056

578

"""Disable this client."""

1057

579

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

1059

581

if not quiet:

1060

582

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

1061

583

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

1062

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1063

585

self.disable_initiator_tag = None

1064

586

self.expires = None

1065

587

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

1066

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1067

589

self.checker_initiator_tag = None

1068

590

self.stop_checker()

1069

591

self.enabled = False

1070

592

if not quiet:

1071

593

self.send_changedstate()

1072

# 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

1073

595

return False

1074

596

1075

597

def __del__(self):

1076

598

self.disable()

1077

599

1078

600

def init_checker(self):

1079

601

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

1080

602

# and every interval from then on.

1081

603

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

self.checker_initiator_tag = GLib.timeout_add(

1084

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

1085

+ 1)),

1086

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

1087

609

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

1088

610

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

1092

616

# Also start a new checker *right now*.

1093

617

self.start_checker()

1094

1095

def checker_callback(self, source, condition, connection,

1096

command):

618

619

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

1097

620

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

1098

# Read return code from connection (see call_pipe)

1099

returncode = connection.recv()

1100

connection.close()

1101

if self.checker is not None:

1102

self.checker.join()

1103

621

self.checker_callback_tag = None

1104

622

self.checker = None

1105

1106

if returncode >= 0:

1107

self.last_checker_status = returncode

1108

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1109

625

if self.last_checker_status == 0:

1110

626

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

1111

627

vars(self))

1112

628

self.checked_ok()

1113

629

else:

1114

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

630

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

631

vars(self))

1115

632

else:

1116

633

self.last_checker_status = -1

1117

self.last_checker_signal = -returncode

1118

634

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

1119

635

vars(self))

1120

return False

1121

636

1122

637

def checked_ok(self):

1123

638

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

1124

639

self.last_checked_ok = datetime.datetime.utcnow()

1125

640

self.last_checker_status = 0

1126

self.last_checker_signal = None

1127

641

self.bump_timeout()

1128

642

1129

643

def bump_timeout(self, timeout=None):

1130

644

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

1131

645

if timeout is None:

1132

646

timeout = self.timeout

1133

647

if self.disable_initiator_tag is not None:

1134

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1135

649

self.disable_initiator_tag = None

1136

650

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

1137

self.disable_initiator_tag = GLib.timeout_add(

1138

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1139

654

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

1140

655

1141

656

def need_approval(self):

1142

657

self.last_approval_request = datetime.datetime.utcnow()

1143

658

1144

659

def start_checker(self):

1145

660

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

1146

661

1147

662

If a checker already exists, leave it running and do

1148

663

nothing."""

1149

664

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

1154

669

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

1155

670

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

1156

671

# should be.

1157

1158

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

1159

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

1160

self.checker.join()

1161

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)

1162

687

# Start a new checker if needed

1163

688

if self.checker is None:

1164

689

# Escape attributes for the shell

1165

escaped_attrs = {

1166

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

1167

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1168

693

try:

1169

694

command = self.checker_command % escaped_attrs

1170

695

except TypeError as error:

1171

696

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

1172

self.checker_command,

697

self.checker_command, exc_info=error)

698

return True # Try again later

699

self.current_checker_command = command

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

# The exception is when not debugging but nevertheless

708

# running in the foreground; use the previously

709

# created wnull.

710

popen_args = {}

711

if (not self.server_settings["debug"]

712

and self.server_settings["foreground"]):

713

popen_args.update({"stdout": wnull,

714

"stderr": wnull })

715

self.checker = subprocess.Popen(command,

716

close_fds=True,

717

shell=True, cwd="/",

718

**popen_args)

719

except OSError as error:

720

logger.error("Failed to start subprocess",

1173

721

exc_info=error)

1174

return True # Try again later

1175

self.current_checker_command = command

1176

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

1177

self.name)

1178

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

1179

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

1180

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

1181

# always replaced by /dev/null.)

1182

# The exception is when not debugging but nevertheless

1183

# running in the foreground; use the previously

1184

# created wnull.

1185

popen_args = {"close_fds": True,

1186

"shell": True,

1187

"cwd": "/"}

1188

if (not self.server_settings["debug"]

1189

and self.server_settings["foreground"]):

1190

popen_args.update({"stdout": wnull,

1191

"stderr": wnull})

1192

pipe = multiprocessing.Pipe(duplex=False)

1193

self.checker = multiprocessing.Process(

1194

target=call_pipe,

1195

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

1196

kwargs=popen_args)

1197

self.checker.start()

1198

self.checker_callback_tag = GLib.io_add_watch(

1199

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

1200

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1201

self.checker_callback, pipe[0], command)

1202

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

722

return True

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

try:

730

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

731

except OSError as error:

732

if error.errno == errno.ECHILD:

733

# This should never happen

734

logger.error("Child process vanished",

735

exc_info=error)

736

return True

737

raise

738

if pid:

739

gobject.source_remove(self.checker_callback_tag)

740

self.checker_callback(pid, status, command)

741

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

1203

742

return True

1204

743

1205

744

def stop_checker(self):

1206

745

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

1207

746

if self.checker_callback_tag:

1208

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1209

748

self.checker_callback_tag = None

1210

749

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

1211

750

return

1212

751

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

1213

self.checker.terminate()

752

try:

753

self.checker.terminate()

754

#time.sleep(0.5)

755

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

756

# self.checker.kill()

757

except OSError as error:

758

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

759

raise

1214

760

self.checker = None

1215

761

1216

762

1217

def dbus_service_property(dbus_interface,

1218

signature="v",

1219

access="readwrite",

1220

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1221

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1222

766

become properties on the D-Bus.

1223

767

1224

768

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

1225

769

and with one argument by "Set".

1226

770

1227

771

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

1228

772

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

1229

773

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

1233

777

if byte_arrays and signature != "ay":

1234

778

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

1235

779

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

1236

1237

780

def decorator(func):

1238

781

func._dbus_is_property = True

1239

782

func._dbus_interface = dbus_interface

1242

785

func._dbus_name = func.__name__

1243

786

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

1244

787

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

1245

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1246

789

return func

1247

1248

790

return decorator

1249

791

1250

792

1251

793

def dbus_interface_annotations(dbus_interface):

1252

794

"""Decorator for marking functions returning interface annotations

1253

795

1254

796

Usage:

1255

797

1256

798

@dbus_interface_annotations("org.example.Interface")

1257

799

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

1258

800

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

1259

801

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

1260

802

"false"}

1261

803

"""

1262

1263

804

def decorator(func):

1264

805

func._dbus_is_interface = True

1265

806

func._dbus_interface = dbus_interface

1266

807

func._dbus_name = dbus_interface

1267

808

return func

1268

1269

809

return decorator

1270

810

1271

811

1272

812

def dbus_annotations(annotations):

1273

813

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

1274

814

Usage:

1275

815

1276

816

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

1277

817

"org.freedesktop.DBus.Property."

1278

818

"EmitsChangedSignal": "false"})

1280

820

access="r")

1281

821

def Property_dbus_property(self):

1282

822

return dbus.Boolean(False)

1283

1284

See also the DBusObjectWithAnnotations class.

1285

823

"""

1286

1287

824

def decorator(func):

1288

825

func._dbus_annotations = annotations

1289

826

return func

1290

1291

827

return decorator

1292

828

1293

829

1296

832

"""

1297

833

pass

1298

834

1299

1300

835

class DBusPropertyAccessException(DBusPropertyException):

1301

836

"""A property's access permissions disallows an operation.

1302

837

"""

1309

844

pass

1310

845

1311

846

1312

class DBusObjectWithAnnotations(dbus.service.Object):

1313

"""A D-Bus object with annotations.

1314

1315

Classes inheriting from this can use the dbus_annotations

1316

decorator to add annotations to methods or signals.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1317

853

"""

1318

854

1319

855

@staticmethod

1320

856

def _is_dbus_thing(thing):

1321

857

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

1322

858

1323

859

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

1324

860

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

1325

861

"""

1326

862

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

1327

863

False)

1328

864

1329

865

def _get_all_dbus_things(self, thing):

1330

866

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

1331

867

"""

1332

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

868

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

869

name),

1333

870

athing.__get__(self))

1334

871

for cls in self.__class__.__mro__

1335

872

for name, athing in

1336

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

1337

1338

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1339

out_signature="s",

1340

path_keyword='object_path',

1341

connection_keyword='connection')

1342

def Introspect(self, object_path, connection):

1343

"""Overloading of standard D-Bus method.

1344

1345

Inserts annotation tags on methods and signals.

1346

"""

1347

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

1348

connection)

1349

try:

1350

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

1351

1352

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

1353

# Add annotation tags

1354

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

1355

for tag in if_tag.getElementsByTagName(typ):

1356

annots = dict()

1357

for name, prop in (self.

1358

_get_all_dbus_things(typ)):

1359

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

1360

and prop._dbus_interface

1361

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

1362

annots.update(getattr(

1363

prop, "_dbus_annotations", {}))

1364

for name, value in annots.items():

1365

ann_tag = document.createElement(

1366

"annotation")

1367

ann_tag.setAttribute("name", name)

1368

ann_tag.setAttribute("value", value)

1369

tag.appendChild(ann_tag)

1370

# Add interface annotation tags

1371

for annotation, value in dict(

1372

itertools.chain.from_iterable(

1373

annotations().items()

1374

for name, annotations

1375

in self._get_all_dbus_things("interface")

1376

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

1377

)).items():

1378

ann_tag = document.createElement("annotation")

1379

ann_tag.setAttribute("name", annotation)

1380

ann_tag.setAttribute("value", value)

1381

if_tag.appendChild(ann_tag)

1382

# Fix argument name for the Introspect method itself

1383

if (if_tag.getAttribute("name")

1384

== dbus.INTROSPECTABLE_IFACE):

1385

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

1386

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

1387

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

1388

if (arg.getAttribute("direction")

1389

== "out"):

1390

arg.setAttribute("name",

1391

"xml_data")

1392

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

1393

document.unlink()

1394

except (AttributeError, xml.dom.DOMException,

1395

xml.parsers.expat.ExpatError) as error:

1396

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

1397

exc_info=error)

1398

return xmlstring

1399

1400

1401

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1402

"""A D-Bus object with properties.

1403

1404

Classes inheriting from this can use the dbus_service_property

1405

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

1406

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

1407

"""

1408

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1409

876

def _get_dbus_property(self, interface_name, property_name):

1410

877

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

1411

878

property with the specified name and interface.

1412

879

"""

1413

for cls in self.__class__.__mro__:

1414

for name, value in inspect.getmembers(

1415

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1416

884

if (value._dbus_name == property_name

1417

885

and value._dbus_interface == interface_name):

1418

886

return value.__get__(self)

1419

887

1420

888

# No such property

1421

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

1422

self.dbus_object_path, interface_name, property_name))

1423

1424

@classmethod

1425

def _get_all_interface_names(cls):

1426

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

1427

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

1428

"_dbus_interface", None)

1429

for x in (inspect.getmro(cls))

1430

for attr in dir(x))

1431

if name is not None)

1432

1433

@dbus.service.method(dbus.PROPERTIES_IFACE,

1434

in_signature="ss",

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1435

894

out_signature="v")

1436

895

def Get(self, interface_name, property_name):

1437

896

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

1443

902

if not hasattr(value, "variant_level"):

1444

903

return value

1445

904

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

1446

905

1447

906

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

1448

907

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

1449

908

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

1458

917

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

1459

918

"'ay' signature {!r}"

1460

919

.format(prop._dbus_signature))

1461

value = dbus.ByteArray(bytes(value))

920

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

921

for byte in value))

1462

922

prop(value)

1463

1464

@dbus.service.method(dbus.PROPERTIES_IFACE,

1465

in_signature="s",

923

924

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

1466

925

out_signature="a{sv}")

1467

926

def GetAll(self, interface_name):

1468

927

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

1469

928

standard.

1470

929

1471

930

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

1472

931

"""

1473

932

properties = {}

1483

942

if not hasattr(value, "variant_level"):

1484

943

properties[name] = value

1485

944

continue

1486

properties[name] = type(value)(

1487

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1488

947

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

1489

948

1490

949

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

1491

950

def PropertiesChanged(self, interface_name, changed_properties,

1492

951

invalidated_properties):

1494

953

standard.

1495

954

"""

1496

955

pass

1497

956

1498

957

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

958

out_signature="s",

1500

959

path_keyword='object_path',

1501

960

connection_keyword='connection')

1502

961

def Introspect(self, object_path, connection):

1503

962

"""Overloading of standard D-Bus method.

1504

963

1505

964

Inserts property tags and interface annotation tags.

1506

965

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

966

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

967

connection)

1510

968

try:

1511

969

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

1512

1513

970

def make_tag(document, name, prop):

1514

971

e = document.createElement("property")

1515

972

e.setAttribute("name", name)

1516

973

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

1517

974

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

1518

975

return e

1519

1520

976

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

1521

977

# Add property tags

1522

978

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

1525

981

if prop._dbus_interface

1526

982

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

1527

983

if_tag.appendChild(tag)

1528

# Add annotation tags for properties

1529

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

1530

annots = dict()

1531

for name, prop in self._get_all_dbus_things(

1532

"property"):

1533

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

1534

and prop._dbus_interface

1535

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

1536

annots.update(getattr(

1537

prop, "_dbus_annotations", {}))

1538

for name, value in annots.items():

1539

ann_tag = document.createElement(

1540

"annotation")

1541

ann_tag.setAttribute("name", name)

1542

ann_tag.setAttribute("value", value)

1543

tag.appendChild(ann_tag)

984

# Add annotation tags

985

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

986

for tag in if_tag.getElementsByTagName(typ):

987

annots = dict()

988

for name, prop in (self.

989

_get_all_dbus_things(typ)):

990

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

991

and prop._dbus_interface

992

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

993

annots.update(getattr

994

(prop,

995

"_dbus_annotations",

996

{}))

997

for name, value in annots.items():

998

ann_tag = document.createElement(

999

"annotation")

1000

ann_tag.setAttribute("name", name)

1001

ann_tag.setAttribute("value", value)

1002

tag.appendChild(ann_tag)

1003

# Add interface annotation tags

1004

for annotation, value in dict(

1005

itertools.chain.from_iterable(

1006

annotations().items()

1007

for name, annotations in

1008

self._get_all_dbus_things("interface")

1009

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

1010

)).items():

1011

ann_tag = document.createElement("annotation")

1012

ann_tag.setAttribute("name", annotation)

1013

ann_tag.setAttribute("value", value)

1014

if_tag.appendChild(ann_tag)

1544

1015

# Add the names to the return values for the

1545

1016

# "org.freedesktop.DBus.Properties" methods

1546

1017

if (if_tag.getAttribute("name")

1565

1036

return xmlstring

1566

1037

1567

1038

1568

try:

1569

dbus.OBJECT_MANAGER_IFACE

1570

except AttributeError:

1571

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

1572

1573

1574

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1575

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

1576

1577

Classes inheriting from this exposes the standard

1578

GetManagedObjects call and the InterfacesAdded and

1579

InterfacesRemoved signals on the standard

1580

"org.freedesktop.DBus.ObjectManager" interface.

1581

1582

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

1583

manually.

1584

"""

1585

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1586

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

1587

def GetManagedObjects(self):

1588

"""This function must be overridden"""

1589

raise NotImplementedError()

1590

1591

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1592

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

1593

def InterfacesAdded(self, object_path, interfaces_and_properties):

1594

pass

1595

1596

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

1597

def InterfacesRemoved(self, object_path, interfaces):

1598

pass

1599

1600

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1601

out_signature="s",

1602

path_keyword='object_path',

1603

connection_keyword='connection')

1604

def Introspect(self, object_path, connection):

1605

"""Overloading of standard D-Bus method.

1606

1607

Override return argument name of GetManagedObjects to be

1608

"objpath_interfaces_and_properties"

1609

"""

1610

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1611

object_path,

1612

connection)

1613

try:

1614

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

1615

1616

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

1617

# Fix argument name for the GetManagedObjects method

1618

if (if_tag.getAttribute("name")

1619

== dbus.OBJECT_MANAGER_IFACE):

1620

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

1621

if (cn.getAttribute("name")

1622

== "GetManagedObjects"):

1623

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

1624

if (arg.getAttribute("direction")

1625

== "out"):

1626

arg.setAttribute(

1627

"name",

1628

"objpath_interfaces"

1629

"_and_properties")

1630

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

1631

document.unlink()

1632

except (AttributeError, xml.dom.DOMException,

1633

xml.parsers.expat.ExpatError) as error:

1634

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

1635

exc_info=error)

1636

return xmlstring

1637

1638

1639

1039

def datetime_to_dbus(dt, variant_level=0):

1640

1040

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

1641

1041

if dt is None:

1642

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

1643

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

1042

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

1043

return dbus.String(dt.isoformat(),

1044

variant_level=variant_level)

1644

1045

1645

1046

1646

1047

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1648

1049

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

1649

1050

interface names according to the "alt_interface_names" mapping.

1650

1051

Usage:

1651

1052

1652

1053

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

1653

1054

"net.example.AlternateInterface"})

1654

1055

class SampleDBusObject(dbus.service.Object):

1655

1056

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

1656

1057

def SampleDBusMethod():

1657

1058

pass

1658

1059

1659

1060

The above "SampleDBusMethod" on "SampleDBusObject" will be

1660

1061

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

1661

1062

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

1662

1063

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

1663

1064

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

1664

1065

1665

1066

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

1666

1067

(from DBusObjectWithProperties) and interfaces (from the

1667

1068

dbus_interface_annotations decorator).

1668

1069

"""

1669

1670

1070

def wrapper(cls):

1671

1071

for orig_interface_name, alt_interface_name in (

1672

alt_interface_names.items()):

1072

alt_interface_names.items()):

1673

1073

attr = {}

1674

1074

interface_names = set()

1675

1075

# Go though all attributes of the class

1677

1077

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

1678

1078

# with the wrong interface name

1679

1079

if (not hasattr(attribute, "_dbus_interface")

1680

or not attribute._dbus_interface.startswith(

1681

orig_interface_name)):

1080

or not attribute._dbus_interface

1081

.startswith(orig_interface_name)):

1682

1082

continue

1683

1083

# Create an alternate D-Bus interface name based on

1684

1084

# the current name

1685

alt_interface = attribute._dbus_interface.replace(

1686

orig_interface_name, alt_interface_name)

1085

alt_interface = (attribute._dbus_interface

1086

.replace(orig_interface_name,

1087

alt_interface_name))

1687

1088

interface_names.add(alt_interface)

1688

1089

# Is this a D-Bus signal?

1689

1090

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

1690

1091

# Extract the original non-method undecorated

1691

1092

# function by black magic

1692

if sys.version_info.major == 2:

1693

nonmethod_func = (dict(

1093

nonmethod_func = (dict(

1694

1094

zip(attribute.func_code.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1697

else:

1698

nonmethod_func = (dict(

1699

zip(attribute.__code__.co_freevars,

1700

attribute.__closure__))

1701

["func"].cell_contents)

1095

attribute.__closure__))["func"]

1096

.cell_contents)

1702

1097

# Create a new, but exactly alike, function

1703

1098

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

1704

1099

# with the alternate D-Bus interface name

1705

new_function = copy_function(nonmethod_func)

1706

new_function = (dbus.service.signal(

1707

alt_interface,

1708

attribute._dbus_signature)(new_function))

1100

new_function = (dbus.service.signal

1101

(alt_interface,

1102

attribute._dbus_signature)

1103

(types.FunctionType(

1104

nonmethod_func.func_code,

1105

nonmethod_func.func_globals,

1106

nonmethod_func.func_name,

1107

nonmethod_func.func_defaults,

1108

nonmethod_func.func_closure)))

1709

1109

# Copy annotations, if any

1710

1110

try:

1711

new_function._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1111

new_function._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1713

1113

except AttributeError:

1714

1114

pass

1715

1716

1115

# Define a creator of a function to call both the

1717

1116

# original and alternate functions, so both the

1718

1117

# original and alternate signals gets sent when

1721

1120

"""This function is a scope container to pass

1722

1121

func1 and func2 to the "call_both" function

1723

1122

outside of its arguments"""

1724

1725

@functools.wraps(func2)

1726

1123

def call_both(*args, **kwargs):

1727

1124

"""This function will emit two D-Bus

1728

1125

signals by calling func1 and func2"""

1729

1126

func1(*args, **kwargs)

1730

1127

func2(*args, **kwargs)

1731

# Make wrapper function look like a D-Bus

1732

# signal

1733

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

1734

if name.startswith("_dbus_"):

1735

setattr(call_both, name, attr)

1736

1737

1128

return call_both

1738

1129

# Create the "call_both" function and add it to

1739

1130

# the class

1744

1135

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

1745

1136

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

1746

1137

# to the class.

1747

attr[attrname] = (

1748

dbus.service.method(

1749

alt_interface,

1750

attribute._dbus_in_signature,

1751

attribute._dbus_out_signature)

1752

(copy_function(attribute)))

1138

attr[attrname] = (dbus.service.method

1139

(alt_interface,

1140

attribute._dbus_in_signature,

1141

attribute._dbus_out_signature)

1142

(types.FunctionType

1143

(attribute.func_code,

1144

attribute.func_globals,

1145

attribute.func_name,

1146

attribute.func_defaults,

1147

attribute.func_closure)))

1753

1148

# Copy annotations, if any

1754

1149

try:

1755

attr[attrname]._dbus_annotations = dict(

1756

attribute._dbus_annotations)

1150

attr[attrname]._dbus_annotations = (

1151

dict(attribute._dbus_annotations))

1757

1152

except AttributeError:

1758

1153

pass

1759

1154

# Is this a D-Bus property?

1762

1157

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

1763

1158

# property with the alternate D-Bus interface

1764

1159

# name. Add it to the class.

1765

attr[attrname] = (dbus_service_property(

1766

alt_interface, attribute._dbus_signature,

1767

attribute._dbus_access,

1768

attribute._dbus_get_args_options

1769

["byte_arrays"])

1770

(copy_function(attribute)))

1160

attr[attrname] = (dbus_service_property

1161

(alt_interface,

1162

attribute._dbus_signature,

1163

attribute._dbus_access,

1164

attribute

1165

._dbus_get_args_options

1166

["byte_arrays"])

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1771

1173

# Copy annotations, if any

1772

1174

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1175

attr[attrname]._dbus_annotations = (

1176

dict(attribute._dbus_annotations))

1775

1177

except AttributeError:

1776

1178

pass

1777

1179

# Is this a D-Bus interface?

1780

1182

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

1781

1183

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

1782

1184

# to the class.

1783

attr[attrname] = (

1784

dbus_interface_annotations(alt_interface)

1785

(copy_function(attribute)))

1185

attr[attrname] = (dbus_interface_annotations

1186

(alt_interface)

1187

(types.FunctionType

1188

(attribute.func_code,

1189

attribute.func_globals,

1190

attribute.func_name,

1191

attribute.func_defaults,

1192

attribute.func_closure)))

1786

1193

if deprecate:

1787

1194

# Deprecate all alternate interfaces

1788

iname = "_AlternateDBusNames_interface_annotation{}"

1195

iname="_AlternateDBusNames_interface_annotation{}"

1789

1196

for interface_name in interface_names:

1790

1791

1197

@dbus_interface_annotations(interface_name)

1792

1198

def func(self):

1793

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

1794

"true"}

1199

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

1200

"true" }

1795

1201

# Find an unused name

1796

1202

for aname in (iname.format(i)

1797

1203

for i in itertools.count()):

1801

1207

if interface_names:

1802

1208

# Replace the class with a new subclass of it with

1803

1209

# methods, signals, etc. as created above.

1804

if sys.version_info.major == 2:

1805

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

1806

(cls, ), attr)

1807

else:

1808

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

1809

(cls, ), attr)

1210

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

1211

(cls,), attr)

1810

1212

return cls

1811

1812

1213

return wrapper

1813

1214

1814

1215

1815

1216

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

1816

"se.bsnet.fukt.Mandos"})

1217

"se.bsnet.fukt.Mandos"})

1817

1218

class ClientDBus(Client, DBusObjectWithProperties):

1818

1219

"""A Client class using D-Bus

1819

1220

1820

1221

Attributes:

1821

1222

dbus_object_path: dbus.ObjectPath

1822

1223

bus: dbus.SystemBus()

1823

1224

"""

1824

1225

1825

1226

runtime_expansions = (Client.runtime_expansions

1826

+ ("dbus_object_path", ))

1827

1227

+ ("dbus_object_path",))

1228

1828

1229

_interface = "se.recompile.Mandos.Client"

1829

1230

1830

1231

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

1831

1832

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

1232

1233

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

1833

1234

self.bus = bus

1834

1235

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

1835

1236

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

1837

1238

client_object_name = str(self.name).translate(

1838

1239

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

1839

1240

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

1840

self.dbus_object_path = dbus.ObjectPath(

1841

"/clients/" + client_object_name)

1241

self.dbus_object_path = (dbus.ObjectPath

1242

("/clients/" + client_object_name))

1842

1243

DBusObjectWithProperties.__init__(self, self.bus,

1843

1244

self.dbus_object_path)

1844

1845

def notifychangeproperty(transform_func, dbus_name,

1846

type_func=lambda x: x,

1847

variant_level=1,

1848

invalidate_only=False,

1245

1246

def notifychangeproperty(transform_func,

1247

dbus_name, type_func=lambda x: x,

1248

variant_level=1, invalidate_only=False,

1849

1249

_interface=_interface):

1850

1250

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

1851

1251

its changes to DBus.

1852

1252

1853

1253

transform_fun: Function that takes a value and a variant_level

1854

1254

and transforms it to a D-Bus type.

1855

1255

dbus_name: D-Bus name of the variable

1858

1258

variant_level: D-Bus variant level. Default: 1

1859

1259

"""

1860

1260

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

1861

1862

1261

def setter(self, value):

1863

1262

if hasattr(self, "dbus_object_path"):

1864

1263

if (not hasattr(self, attrname) or

1865

1264

type_func(getattr(self, attrname, None))

1866

1265

!= type_func(value)):

1867

1266

if invalidate_only:

1868

self.PropertiesChanged(

1869

_interface, dbus.Dictionary(),

1870

dbus.Array((dbus_name, )))

1267

self.PropertiesChanged(_interface,

1268

dbus.Dictionary(),

1269

dbus.Array

1270

((dbus_name,)))

1871

1271

else:

1872

dbus_value = transform_func(

1873

type_func(value),

1874

variant_level=variant_level)

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1875

1275

self.PropertyChanged(dbus.String(dbus_name),

1876

1276

dbus_value)

1877

self.PropertiesChanged(

1878

_interface,

1879

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

1880

dbus_value}),

1881

dbus.Array())

1277

self.PropertiesChanged(_interface,

1278

dbus.Dictionary({

1279

dbus.String(dbus_name):

1280

dbus_value }), dbus.Array())

1882

1281

setattr(self, attrname, value)

1883

1282

1884

1283

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

1885

1284

1886

1285

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1887

1286

approvals_pending = notifychangeproperty(dbus.Boolean,

1888

1287

"ApprovalPending",

1889

type_func=bool)

1288

type_func = bool)

1890

1289

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

1891

1290

last_enabled = notifychangeproperty(datetime_to_dbus,

1892

1291

"LastEnabled")

1893

checker = notifychangeproperty(

1894

dbus.Boolean, "CheckerRunning",

1895

type_func=lambda checker: checker is not None)

1292

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

1293

type_func = lambda checker:

1294

checker is not None)

1896

1295

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1897

1296

"LastCheckedOK")

1898

1297

last_checker_status = notifychangeproperty(dbus.Int16,

1901

1300

datetime_to_dbus, "LastApprovalRequest")

1902

1301

approved_by_default = notifychangeproperty(dbus.Boolean,

1903

1302

"ApprovedByDefault")

1904

approval_delay = notifychangeproperty(

1905

dbus.UInt64, "ApprovalDelay",

1906

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

1303

approval_delay = notifychangeproperty(dbus.UInt64,

1304

"ApprovalDelay",

1305

type_func =

1306

lambda td: td.total_seconds()

1307

* 1000)

1907

1308

approval_duration = notifychangeproperty(

1908

1309

dbus.UInt64, "ApprovalDuration",

1909

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

1310

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

1910

1311

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

1911

timeout = notifychangeproperty(

1912

dbus.UInt64, "Timeout",

1913

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

1312

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

1313

type_func = lambda td:

1314

td.total_seconds() * 1000)

1914

1315

extended_timeout = notifychangeproperty(

1915

1316

dbus.UInt64, "ExtendedTimeout",

1916

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

1917

interval = notifychangeproperty(

1918

dbus.UInt64, "Interval",

1919

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

1317

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

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

lambda td: td.total_seconds()

1322

* 1000)

1920

1323

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

1921

1324

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

1922

1325

invalidate_only=True)

1923

1326

1924

1327

del notifychangeproperty

1925

1328

1926

1329

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

1927

1330

try:

1928

1331

self.remove_from_connection()

1931

1334

if hasattr(DBusObjectWithProperties, "__del__"):

1932

1335

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

1933

1336

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

1934

1935

def checker_callback(self, source, condition,

1936

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

1937

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

1938

connection, command, *args,

1939

**kwargs)

1940

exitstatus = self.last_checker_status

1941

if exitstatus >= 0:

1337

1338

def checker_callback(self, pid, condition, command,

1339

*args, **kwargs):

1340

self.checker_callback_tag = None

1341

self.checker = None

1342

if os.WIFEXITED(condition):

1343

exitstatus = os.WEXITSTATUS(condition)

1942

1344

# Emit D-Bus signal

1943

1345

self.CheckerCompleted(dbus.Int16(exitstatus),

1944

# This is specific to GNU libC

1945

dbus.Int64(exitstatus << 8),

1346

dbus.Int64(condition),

1946

1347

dbus.String(command))

1947

1348

else:

1948

1349

# Emit D-Bus signal

1949

1350

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

1950

dbus.Int64(

1951

# This is specific to GNU libC

1952

(exitstatus << 8)

1953

| self.last_checker_signal),

1351

dbus.Int64(condition),

1954

1352

dbus.String(command))

1955

return ret

1956

1353

1354

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

1355

*args, **kwargs)

1356

1957

1357

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

1958

1358

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

1959

1359

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

1963

1363

# Emit D-Bus signal

1964

1364

self.CheckerStarted(self.current_checker_command)

1965

1365

return r

1966

1366

1967

1367

def _reset_approved(self):

1968

1368

self.approved = None

1969

1369

return False

1970

1370

1971

1371

def approve(self, value=True):

1972

1372

self.approved = value

1973

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

1974

* 1000), self._reset_approved)

1373

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

1374

* 1000), self._reset_approved)

1975

1375

self.send_changedstate()

1976

1977

# D-Bus methods, signals & properties

1978

1979

# Interfaces

1980

1981

# Signals

1982

1376

1377

## D-Bus methods, signals & properties

1378

1379

## Interfaces

1380

1381

## Signals

1382

1983

1383

# CheckerCompleted - signal

1984

1384

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

1985

1385

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

1986

1386

"D-Bus signal"

1987

1387

pass

1988

1388

1989

1389

# CheckerStarted - signal

1990

1390

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

1991

1391

def CheckerStarted(self, command):

1992

1392

"D-Bus signal"

1993

1393

pass

1994

1394

1995

1395

# PropertyChanged - signal

1996

1396

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

1997

1397

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

1998

1398

def PropertyChanged(self, property, value):

1999

1399

"D-Bus signal"

2000

1400

pass

2001

1401

2002

1402

# GotSecret - signal

2003

1403

@dbus.service.signal(_interface)

2004

1404

def GotSecret(self):

2007

1407

server to mandos-client

2008

1408

"""

2009

1409

pass

2010

1410

2011

1411

# Rejected - signal

2012

1412

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

2013

1413

def Rejected(self, reason):

2014

1414

"D-Bus signal"

2015

1415

pass

2016

1416

2017

1417

# NeedApproval - signal

2018

1418

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

2019

1419

def NeedApproval(self, timeout, default):

2020

1420

"D-Bus signal"

2021

1421

return self.need_approval()

2022

2023

# Methods

2024

1422

1423

## Methods

1424

2025

1425

# Approve - method

2026

1426

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

2027

1427

def Approve(self, value):

2028

1428

self.approve(value)

2029

1429

2030

1430

# CheckedOK - method

2031

1431

@dbus.service.method(_interface)

2032

1432

def CheckedOK(self):

2033

1433

self.checked_ok()

2034

1434

2035

1435

# Enable - method

2036

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

2037

1436

@dbus.service.method(_interface)

2038

1437

def Enable(self):

2039

1438

"D-Bus method"

2040

1439

self.enable()

2041

1440

2042

1441

# StartChecker - method

2043

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

2044

1442

@dbus.service.method(_interface)

2045

1443

def StartChecker(self):

2046

1444

"D-Bus method"

2047

1445

self.start_checker()

2048

1446

2049

1447

# Disable - method

2050

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

2051

1448

@dbus.service.method(_interface)

2052

1449

def Disable(self):

2053

1450

"D-Bus method"

2054

1451

self.disable()

2055

1452

2056

1453

# StopChecker - method

2057

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

2058

1454

@dbus.service.method(_interface)

2059

1455

def StopChecker(self):

2060

1456

self.stop_checker()

2061

2062

# Properties

2063

1457

1458

## Properties

1459

2064

1460

# ApprovalPending - property

2065

1461

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

2066

1462

def ApprovalPending_dbus_property(self):

2067

1463

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

2068

1464

2069

1465

# ApprovedByDefault - property

2070

@dbus_service_property(_interface,

2071

signature="b",

1466

@dbus_service_property(_interface, signature="b",

2072

1467

access="readwrite")

2073

1468

def ApprovedByDefault_dbus_property(self, value=None):

2074

1469

if value is None: # get

2075

1470

return dbus.Boolean(self.approved_by_default)

2076

1471

self.approved_by_default = bool(value)

2077

1472

2078

1473

# ApprovalDelay - property

2079

@dbus_service_property(_interface,

2080

signature="t",

1474

@dbus_service_property(_interface, signature="t",

2081

1475

access="readwrite")

2082

1476

def ApprovalDelay_dbus_property(self, value=None):

2083

1477

if value is None: # get

2084

1478

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

2085

1479

* 1000)

2086

1480

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

2087

1481

2088

1482

# ApprovalDuration - property

2089

@dbus_service_property(_interface,

2090

signature="t",

1483

@dbus_service_property(_interface, signature="t",

2091

1484

access="readwrite")

2092

1485

def ApprovalDuration_dbus_property(self, value=None):

2093

1486

if value is None: # get

2094

1487

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

2095

1488

* 1000)

2096

1489

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

2097

1490

2098

1491

# Name - property

2099

@dbus_annotations(

2100

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

2101

1492

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

2102

1493

def Name_dbus_property(self):

2103

1494

return dbus.String(self.name)

2104

2105

# KeyID - property

2106

@dbus_annotations(

2107

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

2108

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

2109

def KeyID_dbus_property(self):

2110

return dbus.String(self.key_id)

2111

1495

2112

1496

# Fingerprint - property

2113

@dbus_annotations(

2114

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

2115

1497

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

2116

1498

def Fingerprint_dbus_property(self):

2117

1499

return dbus.String(self.fingerprint)

2118

1500

2119

1501

# Host - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2122

1503

access="readwrite")

2123

1504

def Host_dbus_property(self, value=None):

2124

1505

if value is None: # get

2125

1506

return dbus.String(self.host)

2126

1507

self.host = str(value)

2127

1508

2128

1509

# Created - property

2129

@dbus_annotations(

2130

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

2131

1510

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

2132

1511

def Created_dbus_property(self):

2133

1512

return datetime_to_dbus(self.created)

2134

1513

2135

1514

# LastEnabled - property

2136

1515

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

2137

1516

def LastEnabled_dbus_property(self):

2138

1517

return datetime_to_dbus(self.last_enabled)

2139

1518

2140

1519

# Enabled - property

2141

@dbus_service_property(_interface,

2142

signature="b",

1520

@dbus_service_property(_interface, signature="b",

2143

1521

access="readwrite")

2144

1522

def Enabled_dbus_property(self, value=None):

2145

1523

if value is None: # get

2148

1526

self.enable()

2149

1527

else:

2150

1528

self.disable()

2151

1529

2152

1530

# LastCheckedOK - property

2153

@dbus_service_property(_interface,

2154

signature="s",

1531

@dbus_service_property(_interface, signature="s",

2155

1532

access="readwrite")

2156

1533

def LastCheckedOK_dbus_property(self, value=None):

2157

1534

if value is not None:

2158

1535

self.checked_ok()

2159

1536

return

2160

1537

return datetime_to_dbus(self.last_checked_ok)

2161

1538

2162

1539

# LastCheckerStatus - property

2163

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

1540

@dbus_service_property(_interface, signature="n",

1541

access="read")

2164

1542

def LastCheckerStatus_dbus_property(self):

2165

1543

return dbus.Int16(self.last_checker_status)

2166

1544

2167

1545

# Expires - property

2168

1546

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

2169

1547

def Expires_dbus_property(self):

2170

1548

return datetime_to_dbus(self.expires)

2171

1549

2172

1550

# LastApprovalRequest - property

2173

1551

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

2174

1552

def LastApprovalRequest_dbus_property(self):

2175

1553

return datetime_to_dbus(self.last_approval_request)

2176

1554

2177

1555

# Timeout - property

2178

@dbus_service_property(_interface,

2179

signature="t",

1556

@dbus_service_property(_interface, signature="t",

2180

1557

access="readwrite")

2181

1558

def Timeout_dbus_property(self, value=None):

2182

1559

if value is None: # get

2194

1571

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

2195

1572

is None):

2196

1573

return

2197

GLib.source_remove(self.disable_initiator_tag)

2198

self.disable_initiator_tag = GLib.timeout_add(

2199

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

2200

self.disable)

2201

1574

gobject.source_remove(self.disable_initiator_tag)

1575

self.disable_initiator_tag = (

1576

gobject.timeout_add(

1577

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

1578

* 1000), self.disable))

1579

2202

1580

# ExtendedTimeout - property

2203

@dbus_service_property(_interface,

2204

signature="t",

1581

@dbus_service_property(_interface, signature="t",

2205

1582

access="readwrite")

2206

1583

def ExtendedTimeout_dbus_property(self, value=None):

2207

1584

if value is None: # get

2208

1585

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

2209

1586

* 1000)

2210

1587

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

2211

1588

2212

1589

# Interval - property

2213

@dbus_service_property(_interface,

2214

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2215

1591

access="readwrite")

2216

1592

def Interval_dbus_property(self, value=None):

2217

1593

if value is None: # get

2221

1597

return

2222

1598

if self.enabled:

2223

1599

# Reschedule checker run

2224

GLib.source_remove(self.checker_initiator_tag)

2225

self.checker_initiator_tag = GLib.timeout_add(

2226

value, self.start_checker)

2227

self.start_checker() # Start one now, too

2228

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2229

1605

# Checker - property

2230

@dbus_service_property(_interface,

2231

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2232

1607

access="readwrite")

2233

1608

def Checker_dbus_property(self, value=None):

2234

1609

if value is None: # get

2235

1610

return dbus.String(self.checker_command)

2236

1611

self.checker_command = str(value)

2237

1612

2238

1613

# CheckerRunning - property

2239

@dbus_service_property(_interface,

2240

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2241

1615

access="readwrite")

2242

1616

def CheckerRunning_dbus_property(self, value=None):

2243

1617

if value is None: # get

2246

1620

self.start_checker()

2247

1621

else:

2248

1622

self.stop_checker()

2249

1623

2250

1624

# ObjectPath - property

2251

@dbus_annotations(

2252

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

2253

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

2254

1625

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

2255

1626

def ObjectPath_dbus_property(self):

2256

return self.dbus_object_path # is already a dbus.ObjectPath

2257

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2258

1629

# Secret = property

2259

@dbus_annotations(

2260

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

2261

"invalidates"})

2262

@dbus_service_property(_interface,

2263

signature="ay",

2264

access="write",

2265

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2266

1632

def Secret_dbus_property(self, value):

2267

1633

self.secret = bytes(value)

2268

1634

2269

1635

del _interface

2270

1636

2271

1637

2272

class ProxyClient:

2273

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

1638

class ProxyClient(object):

1639

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

2274

1640

self._pipe = child_pipe

2275

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

1641

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

2276

1642

if not self._pipe.recv():

2277

raise KeyError(key_id or fpr)

2278

1643

raise KeyError()

1644

2279

1645

def __getattribute__(self, name):

2280

1646

if name == '_pipe':

2281

1647

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

2284

1650

if data[0] == 'data':

2285

1651

return data[1]

2286

1652

if data[0] == 'function':

2287

2288

1653

def func(*args, **kwargs):

2289

1654

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

2290

1655

return self._pipe.recv()[1]

2291

2292

1656

return func

2293

1657

2294

1658

def __setattr__(self, name, value):

2295

1659

if name == '_pipe':

2296

1660

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

2299

1663

2300

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2301

1665

"""A class to handle client connections.

2302

1666

2303

1667

Instantiated once for each connection to handle it.

2304

1668

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

2305

1669

2306

1670

def handle(self):

2307

1671

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

2308

1672

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

2309

1673

str(self.client_address))

2310

1674

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

2311

1675

self.server.child_pipe.fileno())

2312

2313

session = gnutls.ClientSession(self.request)

2314

2315

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

2316

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

2317

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

2318

# "+DHE-DSS"))

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2319

1691

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

2320

1692

priority = self.server.gnutls_priority

2321

1693

if priority is None:

2322

1694

priority = "NORMAL"

2323

gnutls.priority_set_direct(session,

2324

priority.encode("utf-8"), None)

2325

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2326

1699

# Start communication using the Mandos protocol

2327

1700

# Get protocol number

2328

1701

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

2333

1706

except (ValueError, IndexError, RuntimeError) as error:

2334

1707

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

2335

1708

return

2336

1709

2337

1710

# Start GnuTLS connection

2338

1711

try:

2339

1712

session.handshake()

2340

except gnutls.Error as error:

1713

except gnutls.errors.GNUTLSError as error:

2341

1714

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

2342

1715

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

2343

1716

# established. Just abandon the request.

2344

1717

return

2345

1718

logger.debug("Handshake succeeded")

2346

1719

2347

1720

approval_required = False

2348

1721

try:

2349

if gnutls.has_rawpk:

2350

fpr = b""

2351

try:

2352

key_id = self.key_id(

2353

self.peer_certificate(session))

2354

except (TypeError, gnutls.Error) as error:

2355

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

2356

return

2357

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

2358

key_id.decode("utf-8",

2359

errors="replace"))

2360

2361

else:

2362

key_id = b""

2363

try:

2364

fpr = self.fingerprint(

2365

self.peer_certificate(session))

2366

except (TypeError, gnutls.Error) as error:

2367

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

2368

return

2369

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

2370

2371

try:

2372

client = ProxyClient(child_pipe, key_id, fpr,

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

2373

1733

self.client_address)

2374

1734

except KeyError:

2375

1735

return

2376

1736

2377

1737

if client.approval_delay:

2378

1738

delay = client.approval_delay

2379

1739

client.approvals_pending += 1

2380

1740

approval_required = True

2381

1741

2382

1742

while True:

2383

1743

if not client.enabled:

2384

1744

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

2385

client.name)

1745

client.name)

2386

1746

if self.server.use_dbus:

2387

1747

# Emit D-Bus signal

2388

1748

client.Rejected("Disabled")

2389

1749

return

2390

1750

2391

1751

if client.approved or not client.approval_delay:

2392

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2393

1753

break

2394

1754

elif client.approved is None:

2395

1755

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

2406

1766

# Emit D-Bus signal

2407

1767

client.Rejected("Denied")

2408

1768

return

2409

2410

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2411

1771

time = datetime.datetime.now()

2412

1772

client.changedstate.acquire()

2413

1773

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

2426

1786

break

2427

1787

else:

2428

1788

delay -= time2 - time

2429

2430

try:

2431

session.send(client.secret)

2432

except gnutls.Error as error:

2433

logger.warning("gnutls send failed",

2434

exc_info=error)

2435

return

2436

1789

1790

sent_size = 0

1791

while sent_size < len(client.secret):

1792

try:

1793

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

1794

except gnutls.errors.GNUTLSError as error:

1795

logger.warning("gnutls send failed",

1796

exc_info=error)

1797

return

1798

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

1799

sent, len(client.secret)

1800

- (sent_size + sent))

1801

sent_size += sent

1802

2437

1803

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

2438

1804

# bump the timeout using extended_timeout

2439

1805

client.bump_timeout(client.extended_timeout)

2440

1806

if self.server.use_dbus:

2441

1807

# Emit D-Bus signal

2442

1808

client.GotSecret()

2443

1809

2444

1810

finally:

2445

1811

if approval_required:

2446

1812

client.approvals_pending -= 1

2447

1813

try:

2448

1814

session.bye()

2449

except gnutls.Error as error:

1815

except gnutls.errors.GNUTLSError as error:

2450

1816

logger.warning("GnuTLS bye failed",

2451

1817

exc_info=error)

2452

1818

2453

1819

@staticmethod

2454

1820

def peer_certificate(session):

2455

"Return the peer's certificate as a bytestring"

2456

try:

2457

cert_type = gnutls.certificate_type_get2(

2458

session, gnutls.CTYPE_PEERS)

2459

except AttributeError:

2460

cert_type = gnutls.certificate_type_get(session)

2461

if gnutls.has_rawpk:

2462

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2463

else:

2464

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2465

# If not a valid certificate type...

2466

if cert_type not in valid_cert_types:

2467

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

2468

valid_cert_types)

2469

# ...return invalid data

2470

return b""

1821

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

1822

# If not an OpenPGP certificate...

1823

if (gnutls.library.functions

1824

.gnutls_certificate_type_get(session._c_object)

1825

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1826

# ...do the normal thing

1827

return session.peer_certificate

2471

1828

list_size = ctypes.c_uint(1)

2472

cert_list = (gnutls.certificate_get_peers

2473

(session, ctypes.byref(list_size)))

1829

cert_list = (gnutls.library.functions

1830

.gnutls_certificate_get_peers

1831

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

2474

1832

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

2475

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

1833

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

1834

" certificate")

2476

1835

if list_size.value == 0:

2477

1836

return None

2478

1837

cert = cert_list[0]

2479

1838

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

2480

2481

@staticmethod

2482

def key_id(certificate):

2483

"Convert a certificate bytestring to a hexdigit key ID"

2484

# New GnuTLS "datum" with the public key

2485

datum = gnutls.datum_t(

2486

ctypes.cast(ctypes.c_char_p(certificate),

2487

ctypes.POINTER(ctypes.c_ubyte)),

2488

ctypes.c_uint(len(certificate)))

2489

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

2490

# New empty GnuTLS certificate

2491

pubkey = gnutls.pubkey_t()

2492

gnutls.pubkey_init(ctypes.byref(pubkey))

2493

# Import the raw public key into the certificate

2494

gnutls.pubkey_import(pubkey,

2495

ctypes.byref(datum),

2496

gnutls.X509_FMT_DER)

2497

# New buffer for the key ID

2498

buf = ctypes.create_string_buffer(32)

2499

buf_len = ctypes.c_size_t(len(buf))

2500

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

2501

gnutls.pubkey_get_key_id(

2502

pubkey,

2503

gnutls.KEYID_USE_SHA256,

2504

ctypes.cast(ctypes.byref(buf),

2505

ctypes.POINTER(ctypes.c_ubyte)),

2506

ctypes.byref(buf_len))

2507

# Deinit the certificate

2508

gnutls.pubkey_deinit(pubkey)

2509

2510

# Convert the buffer to a Python bytestring

2511

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

2512

# Convert the bytestring to hexadecimal notation

2513

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

2514

return hex_key_id

2515

1839

2516

1840

@staticmethod

2517

1841

def fingerprint(openpgp):

2518

1842

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2519

1843

# New GnuTLS "datum" with the OpenPGP public key

2520

datum = gnutls.datum_t(

2521

ctypes.cast(ctypes.c_char_p(openpgp),

2522

ctypes.POINTER(ctypes.c_ubyte)),

2523

ctypes.c_uint(len(openpgp)))

1844

datum = (gnutls.library.types

1845

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

1846

ctypes.POINTER

1847

(ctypes.c_ubyte)),

1848

ctypes.c_uint(len(openpgp))))

2524

1849

# New empty GnuTLS certificate

2525

crt = gnutls.openpgp_crt_t()

2526

gnutls.openpgp_crt_init(ctypes.byref(crt))

1850

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1851

(gnutls.library.functions

1852

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2527

1853

# Import the OpenPGP public key into the certificate

2528

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

2529

gnutls.OPENPGP_FMT_RAW)

1854

(gnutls.library.functions

1855

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

1856

gnutls.library.constants

1857

.GNUTLS_OPENPGP_FMT_RAW))

2530

1858

# Verify the self signature in the key

2531

1859

crtverify = ctypes.c_uint()

2532

gnutls.openpgp_crt_verify_self(crt, 0,

2533

ctypes.byref(crtverify))

1860

(gnutls.library.functions

1861

.gnutls_openpgp_crt_verify_self(crt, 0,

1862

ctypes.byref(crtverify)))

2534

1863

if crtverify.value != 0:

2535

gnutls.openpgp_crt_deinit(crt)

2536

raise gnutls.CertificateSecurityError(code

2537

=crtverify.value)

1864

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1865

raise (gnutls.errors.CertificateSecurityError

1866

("Verify failed"))

2538

1867

# New buffer for the fingerprint

2539

1868

buf = ctypes.create_string_buffer(20)

2540

1869

buf_len = ctypes.c_size_t()

2541

1870

# Get the fingerprint from the certificate into the buffer

2542

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

2543

ctypes.byref(buf_len))

1871

(gnutls.library.functions

1872

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

1873

ctypes.byref(buf_len)))

2544

1874

# Deinit the certificate

2545

gnutls.openpgp_crt_deinit(crt)

1875

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2546

1876

# Convert the buffer to a Python bytestring

2547

1877

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

2548

1878

# Convert the bytestring to hexadecimal notation

2550

1880

return hex_fpr

2551

1881

2552

1882

2553

class MultiprocessingMixIn:

1883

class MultiprocessingMixIn(object):

2554

1884

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

2555

2556

1885

def sub_process_main(self, request, address):

2557

1886

try:

2558

1887

self.finish_request(request, address)

2559

1888

except Exception:

2560

1889

self.handle_error(request, address)

2561

1890

self.close_request(request)

2562

1891

2563

1892

def process_request(self, request, address):

2564

1893

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

2565

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

2566

args=(request, address))

1894

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

1895

args = (request, address))

2567

1896

proc.start()

2568

1897

return proc

2569

1898

2570

1899

2571

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1900

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2572

1901

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

2573

2574

1902

def process_request(self, request, client_address):

2575

1903

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

2576

1904

2577

1905

This function creates a new pipe in self.pipe

2578

1906

"""

2579

1907

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2580

1908

2581

1909

proc = MultiprocessingMixIn.process_request(self, request,

2582

1910

client_address)

2583

1911

self.child_pipe.close()

2584

1912

self.add_pipe(parent_pipe, proc)

2585

1913

2586

1914

def add_pipe(self, parent_pipe, proc):

2587

1915

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

2588

1916

raise NotImplementedError()

2589

1917

2590

1918

2591

1919

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2592

socketserver.TCPServer):

1920

socketserver.TCPServer, object):

2593

1921

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

2594

1922

2595

1923

Attributes:

2596

1924

enabled: Boolean; whether this server is activated yet

2597

1925

interface: None or a network interface name (string)

2598

1926

use_ipv6: Boolean; to use IPv6 or not

2599

1927

"""

2600

2601

1928

def __init__(self, server_address, RequestHandlerClass,

2602

interface=None,

2603

use_ipv6=True,

2604

socketfd=None):

1929

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

2605

1930

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

2606

1931

creating a new one with socket.socket().

2607

1932

"""

2613

1938

self.socketfd = socketfd

2614

1939

# Save the original socket.socket() function

2615

1940

self.socket_socket = socket.socket

2616

2617

1941

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

2618

#

1942

#

2619

1943

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

2620

1944

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

2621

1945

# patching socket.socket.)

2622

#

1946

#

2623

1947

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

2624

1948

@functools.wraps(socket.socket)

2625

1949

def socket_wrapper(*args, **kwargs):

2637

1961

# socket_wrapper(), if socketfd was set.

2638

1962

socketserver.TCPServer.__init__(self, server_address,

2639

1963

RequestHandlerClass)

2640

1964

2641

1965

def server_bind(self):

2642

1966

"""This overrides the normal server_bind() function

2643

1967

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

2644

1968

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

2645

global SO_BINDTODEVICE

2646

1969

if self.interface is not None:

2647

1970

if SO_BINDTODEVICE is None:

2648

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

2649

# common enough.

2650

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

2651

SO_BINDTODEVICE = 25

2652

try:

2653

self.socket.setsockopt(

2654

socket.SOL_SOCKET, SO_BINDTODEVICE,

2655

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

2656

except socket.error as error:

2657

if error.errno == errno.EPERM:

2658

logger.error("No permission to bind to"

2659

" interface %s", self.interface)

2660

elif error.errno == errno.ENOPROTOOPT:

2661

logger.error("SO_BINDTODEVICE not available;"

2662

" cannot bind to interface %s",

2663

self.interface)

2664

elif error.errno == errno.ENODEV:

2665

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

2666

" cannot bind", self.interface)

2667

else:

2668

raise

1971

logger.error("SO_BINDTODEVICE does not exist;"

1972

" cannot bind to interface %s",

1973

self.interface)

1974

else:

1975

try:

1976

self.socket.setsockopt(socket.SOL_SOCKET,

1977

SO_BINDTODEVICE,

1978

(self.interface + "\0")

1979

.encode("utf-8"))

1980

except socket.error as error:

1981

if error.errno == errno.EPERM:

1982

logger.error("No permission to bind to"

1983

" interface %s", self.interface)

1984

elif error.errno == errno.ENOPROTOOPT:

1985

logger.error("SO_BINDTODEVICE not available;"

1986

" cannot bind to interface %s",

1987

self.interface)

1988

elif error.errno == errno.ENODEV:

1989

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

1990

" cannot bind", self.interface)

1991

else:

1992

raise

2669

1993

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

2670

1994

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

2671

if self.server_address[1]:

2672

self.allow_reuse_address = True

2673

1995

if not self.server_address[0]:

2674

1996

if self.address_family == socket.AF_INET6:

2675

any_address = "::" # in6addr_any

1997

any_address = "::" # in6addr_any

2676

1998

else:

2677

any_address = "0.0.0.0" # INADDR_ANY

1999

any_address = "0.0.0.0" # INADDR_ANY

2678

2000

self.server_address = (any_address,

2679

2001

self.server_address[1])

2680

2002

elif not self.server_address[1]:

2681

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

2003

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

2004

0)

2682

2005

# if self.interface:

2683

2006

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

2684

2007

# 0, # port

2690

2013

2691

2014

class MandosServer(IPv6_TCPServer):

2692

2015

"""Mandos server.

2693

2016

2694

2017

Attributes:

2695

2018

clients: set of Client objects

2696

2019

gnutls_priority GnuTLS priority string

2697

2020

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

2698

2699

Assumes a GLib.MainLoop event loop.

2021

2022

Assumes a gobject.MainLoop event loop.

2700

2023

"""

2701

2702

2024

def __init__(self, server_address, RequestHandlerClass,

2703

interface=None,

2704

use_ipv6=True,

2705

clients=None,

2706

gnutls_priority=None,

2707

use_dbus=True,

2708

socketfd=None):

2025

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

2026

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

2709

2027

self.enabled = False

2710

2028

self.clients = clients

2711

2029

if self.clients is None:

2714

2032

self.gnutls_priority = gnutls_priority

2715

2033

IPv6_TCPServer.__init__(self, server_address,

2716

2034

RequestHandlerClass,

2717

interface=interface,

2718

use_ipv6=use_ipv6,

2719

socketfd=socketfd)

2720

2035

interface = interface,

2036

use_ipv6 = use_ipv6,

2037

socketfd = socketfd)

2721

2038

def server_activate(self):

2722

2039

if self.enabled:

2723

2040

return socketserver.TCPServer.server_activate(self)

2724

2041

2725

2042

def enable(self):

2726

2043

self.enabled = True

2727

2044

2728

2045

def add_pipe(self, parent_pipe, proc):

2729

2046

# Call "handle_ipc" for both data and EOF events

2730

GLib.io_add_watch(

2731

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

2732

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

2733

functools.partial(self.handle_ipc,

2734

parent_pipe=parent_pipe,

2735

proc=proc))

2736

2737

def handle_ipc(self, source, condition,

2738

parent_pipe=None,

2739

proc=None,

2740

client_object=None):

2047

gobject.io_add_watch(parent_pipe.fileno(),

2048

gobject.IO_IN | gobject.IO_HUP,

2049

functools.partial(self.handle_ipc,

2050

parent_pipe =

2051

parent_pipe,

2052

proc = proc))

2053

2054

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

2055

proc = None, client_object=None):

2741

2056

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

2742

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

2057

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

2743

2058

# Wait for other process to exit

2744

2059

proc.join()

2745

2060

return False

2746

2061

2747

2062

# Read a request from the child

2748

2063

request = parent_pipe.recv()

2749

2064

command = request[0]

2750

2065

2751

2066

if command == 'init':

2752

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

2753

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

2754

address = request[3]

2755

2756

for c in self.clients.values():

2757

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2758

"27AE41E4649B934CA495991B7852B855"):

2759

continue

2760

if key_id and c.key_id == key_id:

2761

client = c

2762

break

2763

if fpr and c.fingerprint == fpr:

2067

fpr = request[1]

2068

address = request[2]

2069

2070

for c in self.clients.itervalues():

2071

if c.fingerprint == fpr:

2764

2072

client = c

2765

2073

break

2766

2074

else:

2767

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

2768

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

2075

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

2076

"dress: %s", fpr, address)

2769

2077

if self.use_dbus:

2770

2078

# Emit D-Bus signal

2771

mandos_dbus_service.ClientNotFound(key_id or fpr,

2079

mandos_dbus_service.ClientNotFound(fpr,

2772

2080

address[0])

2773

2081

parent_pipe.send(False)

2774

2082

return False

2775

2776

GLib.io_add_watch(

2777

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

2778

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

2779

functools.partial(self.handle_ipc,

2780

parent_pipe=parent_pipe,

2781

proc=proc,

2782

client_object=client))

2083

2084

gobject.io_add_watch(parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2086

functools.partial(self.handle_ipc,

2087

parent_pipe =

2088

parent_pipe,

2089

proc = proc,

2090

client_object =

2091

client))

2783

2092

parent_pipe.send(True)

2784

2093

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

2785

2094

# same fileno

2788

2097

funcname = request[1]

2789

2098

args = request[2]

2790

2099

kwargs = request[3]

2791

2100

2792

2101

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

2793

2102

funcname)(*args,

2794

**kwargs)))

2795

2103

**kwargs)))

2104

2796

2105

if command == 'getattr':

2797

2106

attrname = request[1]

2798

if isinstance(client_object.__getattribute__(attrname),

2799

collections.abc.Callable):

2800

parent_pipe.send(('function', ))

2107

if callable(client_object.__getattribute__(attrname)):

2108

parent_pipe.send(('function',))

2801

2109

else:

2802

parent_pipe.send((

2803

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

2804

2110

parent_pipe.send(('data', client_object

2111

.__getattribute__(attrname)))

2112

2805

2113

if command == 'setattr':

2806

2114

attrname = request[1]

2807

2115

value = request[2]

2808

2116

setattr(client_object, attrname, value)

2809

2117

2810

2118

return True

2811

2119

2812

2120

2813

2121

def rfc3339_duration_to_delta(duration):

2814

2122

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

2815

2816

>>> timedelta = datetime.timedelta

2817

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

2818

True

2819

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

2820

True

2821

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

2822

True

2823

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

2824

True

2825

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

2826

True

2827

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

2828

True

2829

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

2830

True

2831

>>> del timedelta

2123

2124

>>> rfc3339_duration_to_delta("P7D")

2125

datetime.timedelta(7)

2126

>>> rfc3339_duration_to_delta("PT60S")

2127

datetime.timedelta(0, 60)

2128

>>> rfc3339_duration_to_delta("PT60M")

2129

datetime.timedelta(0, 3600)

2130

>>> rfc3339_duration_to_delta("PT24H")

2131

datetime.timedelta(1)

2132

>>> rfc3339_duration_to_delta("P1W")

2133

datetime.timedelta(7)

2134

>>> rfc3339_duration_to_delta("PT5M30S")

2135

datetime.timedelta(0, 330)

2136

>>> rfc3339_duration_to_delta("P1DT3M20S")

2137

datetime.timedelta(1, 200)

2832

2138

"""

2833

2139

2834

2140

# Parsing an RFC 3339 duration with regular expressions is not

2835

2141

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

2836

2142

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

2837

2143

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

2838

2144

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

2839

2145

# avoid excessive use of external libraries.

2840

2146

2841

2147

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

2842

Token = collections.namedtuple("Token", (

2843

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

2844

# a "group" containing digits

2845

"value", # datetime.timedelta or None

2846

"followers")) # Tokens valid after this token

2148

Token = collections.namedtuple("Token",

2149

("regexp", # To match token; if

2150

# "value" is not None,

2151

# must have a "group"

2152

# containing digits

2153

"value", # datetime.timedelta or

2154

# None

2155

"followers")) # Tokens valid after

2156

# this token

2847

2157

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

2848

2158

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

2849

2159

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

2850

2160

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

2851

2161

datetime.timedelta(seconds=1),

2852

frozenset((token_end, )))

2162

frozenset((token_end,)))

2853

2163

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

2854

2164

datetime.timedelta(minutes=1),

2855

2165

frozenset((token_second, token_end)))

2871

2181

frozenset((token_month, token_end)))

2872

2182

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

2873

2183

datetime.timedelta(weeks=1),

2874

frozenset((token_end, )))

2184

frozenset((token_end,)))

2875

2185

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

2876

2186

frozenset((token_year, token_month,

2877

2187

token_day, token_time,

2878

2188

token_week)))

2879

# Define starting values:

2880

# Value so far

2881

value = datetime.timedelta()

2189

# Define starting values

2190

value = datetime.timedelta() # Value so far

2882

2191

found_token = None

2883

# Following valid tokens

2884

followers = frozenset((token_duration, ))

2885

# String left to parse

2886

s = duration

2192

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

2193

s = duration # String left to parse

2887

2194

# Loop until end token is found

2888

2195

while found_token is not token_end:

2889

2196

# Search for any currently valid tokens

2905

2212

break

2906

2213

else:

2907

2214

# No currently valid tokens were found

2908

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

2909

.format(duration))

2215

raise ValueError("Invalid RFC 3339 duration")

2910

2216

# End token found

2911

2217

return value

2912

2218

2913

2219

2914

2220

def string_to_delta(interval):

2915

2221

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

2916

2917

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

2918

True

2919

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

2920

True

2921

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

2922

True

2923

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

2924

True

2925

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

2926

True

2927

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

2928

True

2222

2223

>>> string_to_delta('7d')

2224

datetime.timedelta(7)

2225

>>> string_to_delta('60s')

2226

datetime.timedelta(0, 60)

2227

>>> string_to_delta('60m')

2228

datetime.timedelta(0, 3600)

2229

>>> string_to_delta('24h')

2230

datetime.timedelta(1)

2231

>>> string_to_delta('1w')

2232

datetime.timedelta(7)

2233

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

2234

datetime.timedelta(0, 330)

2929

2235

"""

2930

2236

2931

2237

try:

2932

2238

return rfc3339_duration_to_delta(interval)

2933

2239

except ValueError:

2934

2240

pass

2935

2241

2936

2242

timevalue = datetime.timedelta(0)

2937

2243

for s in interval.split():

2938

2244

try:

2949

2255

elif suffix == "w":

2950

2256

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

2951

2257

else:

2952

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

2258

raise ValueError("Unknown suffix {!r}"

2259

.format(suffix))

2953

2260

except IndexError as e:

2954

2261

raise ValueError(*(e.args))

2955

2262

timevalue += delta

2956

2263

return timevalue

2957

2264

2958

2265

2959

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

2266

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

2960

2267

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

2961

2268

2962

2269

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

2963

2270

if os.fork():

2964

2271

sys.exit()

2971

2278

# Close all standard open file descriptors

2972

2279

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

2973

2280

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

2974

raise OSError(errno.ENODEV,

2975

"{} not a character device"

2281

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

2976

2282

.format(os.devnull))

2977

2283

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

2978

2284

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

2982

2288

2983

2289

2984

2290

def main():

2985

2291

2986

2292

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

2987

2293

# Parsing of options, both command line and config file

2988

2294

2989

2295

parser = argparse.ArgumentParser()

2990

2296

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

2991

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

2297

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

2992

2298

help="show version number and exit")

2993

2299

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

2994

2300

help="Bind to interface IF")

3030

2336

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

3031

2337

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

3032

2338

default=None)

3033

2339

3034

2340

options = parser.parse_args()

3035

2341

2342

if options.check:

2343

import doctest

2344

fail_count, test_count = doctest.testmod()

2345

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

2346

3036

2347

# Default values for config file for server-global settings

3037

if gnutls.has_rawpk:

3038

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

3039

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

3040

else:

3041

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

3042

":+SIGN-DSA-SHA256")

3043

server_defaults = {"interface": "",

3044

"address": "",

3045

"port": "",

3046

"debug": "False",

3047

"priority": priority,

3048

"servicename": "Mandos",

3049

"use_dbus": "True",

3050

"use_ipv6": "True",

3051

"debuglevel": "",

3052

"restore": "True",

3053

"socket": "",

3054

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

3055

"foreground": "False",

3056

"zeroconf": "True",

3057

}

3058

del priority

3059

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

"zeroconf": "True",

2363

}

2364

3060

2365

# Parse config file for server-global settings

3061

server_config = configparser.ConfigParser(server_defaults)

2366

server_config = configparser.SafeConfigParser(server_defaults)

3062

2367

del server_defaults

3063

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

3064

# Convert the ConfigParser object to a dict

2368

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

2369

"mandos.conf"))

2370

# Convert the SafeConfigParser object to a dict

3065

2371

server_settings = server_config.defaults()

3066

2372

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

3067

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

3068

"foreground", "zeroconf"):

2373

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

3069

2374

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

3070

2375

option)

3071

2376

if server_settings["port"]:

3081

2386

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

3082

2387

["socket"])

3083

2388

del server_config

3084

2389

3085

2390

# Override the settings from the config file with command line

3086

2391

# options, if set.

3087

2392

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

3088

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

3089

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

3090

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

2393

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

2394

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

2395

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

3091

2396

value = getattr(options, option)

3092

2397

if value is not None:

3093

2398

server_settings[option] = value

3105

2410

if server_settings["debug"]:

3106

2411

server_settings["foreground"] = True

3107

2412

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

3108

2413

3109

2414

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

3110

3111

if (not server_settings["zeroconf"]

3112

and not (server_settings["port"]

3113

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

3114

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

3115

2415

2416

if (not server_settings["zeroconf"] and

2417

not (server_settings["port"]

2418

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

2419

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

2420

" Zeroconf")

2421

3116

2422

# For convenience

3117

2423

debug = server_settings["debug"]

3118

2424

debuglevel = server_settings["debuglevel"]

3122

2428

stored_state_file)

3123

2429

foreground = server_settings["foreground"]

3124

2430

zeroconf = server_settings["zeroconf"]

3125

2431

3126

2432

if debug:

3127

2433

initlogger(debug, logging.DEBUG)

3128

2434

else:

3131

2437

else:

3132

2438

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

3133

2439

initlogger(debug, level)

3134

2440

3135

2441

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

3136

syslogger.setFormatter(

3137

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

3138

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

3139

server_settings["servicename"])))

3140

2442

syslogger.setFormatter(logging.Formatter

2443

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

2444

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

2445

.format(server_settings

2446

["servicename"])))

2447

3141

2448

# Parse config file with clients

3142

client_config = configparser.ConfigParser(Client.client_defaults)

2449

client_config = configparser.SafeConfigParser(Client

2450

.client_defaults)

3143

2451

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

3144

2452

"clients.conf"))

3145

2453

3146

2454

global mandos_dbus_service

3147

2455

mandos_dbus_service = None

3148

2456

3149

2457

socketfd = None

3150

2458

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

3151

2459

socketfd = server_settings["socket"]

3152

tcp_server = MandosServer(

3153

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

3154

ClientHandler,

3155

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

3156

use_ipv6=use_ipv6,

3157

gnutls_priority=server_settings["priority"],

3158

use_dbus=use_dbus,

3159

socketfd=socketfd)

2460

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

2461

server_settings["port"]),

2462

ClientHandler,

2463

interface=(server_settings["interface"]

2464

or None),

2465

use_ipv6=use_ipv6,

2466

gnutls_priority=

2467

server_settings["priority"],

2468

use_dbus=use_dbus,

2469

socketfd=socketfd)

3160

2470

if not foreground:

3161

2471

pidfilename = "/run/mandos.pid"

3162

2472

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

3163

2473

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

3164

2474

pidfile = None

3165

2475

try:

3166

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

2476

pidfile = open(pidfilename, "w")

3167

2477

except IOError as e:

3168

2478

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

3169

2479

exc_info=e)

3170

3171

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

3172

("mandos", "mandos"),

3173

("nobody", "nogroup")):

2480

2481

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

3174

2482

try:

3175

2483

uid = pwd.getpwnam(name).pw_uid

3176

gid = pwd.getpwnam(group).pw_gid

2484

gid = pwd.getpwnam(name).pw_gid

3177

2485

break

3178

2486

except KeyError:

3179

2487

continue

3183

2491

try:

3184

2492

os.setgid(gid)

3185

2493

os.setuid(uid)

3186

if debug:

3187

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

3188

gid))

3189

2494

except OSError as error:

3190

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

3191

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

3192

2495

if error.errno != errno.EPERM:

3193

2496

raise

3194

2497

3195

2498

if debug:

3196

2499

# Enable all possible GnuTLS debugging

3197

2500

3198

2501

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

3199

2502

# - GnuTLS manual

3200

gnutls.global_set_log_level(11)

3201

3202

@gnutls.log_func

2503

gnutls.library.functions.gnutls_global_set_log_level(11)

2504

2505

@gnutls.library.types.gnutls_log_func

3203

2506

def debug_gnutls(level, string):

3204

logger.debug("GnuTLS: %s",

3205

string[:-1].decode("utf-8",

3206

errors="replace"))

3207

3208

gnutls.global_set_log_function(debug_gnutls)

3209

2507

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

2508

2509

(gnutls.library.functions

2510

.gnutls_global_set_log_function(debug_gnutls))

2511

3210

2512

# Redirect stdin so all checkers get /dev/null

3211

2513

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

3212

2514

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

3213

2515

if null > 2:

3214

2516

os.close(null)

3215

2517

3216

2518

# Need to fork before connecting to D-Bus

3217

2519

if not foreground:

3218

2520

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

3219

2521

daemon()

3220

3221

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

3222

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

3223

# need to inform GLib that threads will be used.

3224

GLib.threads_init()

3225

2522

2523

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

2524

# need to inform gobject that threads will be used.

2525

gobject.threads_init()

2526

3226

2527

global main_loop

3227

2528

# From the Avahi example code

3228

2529

DBusGMainLoop(set_as_default=True)

3229

main_loop = GLib.MainLoop()

2530

main_loop = gobject.MainLoop()

3230

2531

bus = dbus.SystemBus()

3231

2532

# End of Avahi example code

3232

2533

if use_dbus:

3233

2534

try:

3234

2535

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

3235

bus,

3236

do_not_queue=True)

3237

old_bus_name = dbus.service.BusName(

3238

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

3239

do_not_queue=True)

3240

except dbus.exceptions.DBusException as e:

2536

bus, do_not_queue=True)

2537

old_bus_name = (dbus.service.BusName

2538

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

2539

do_not_queue=True))

2540

except dbus.exceptions.NameExistsException as e:

3241

2541

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

3242

2542

use_dbus = False

3243

2543

server_settings["use_dbus"] = False

3244

2544

tcp_server.use_dbus = False

3245

2545

if zeroconf:

3246

2546

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3247

service = AvahiServiceToSyslog(

3248

name=server_settings["servicename"],

3249

servicetype="_mandos._tcp",

3250

protocol=protocol,

3251

bus=bus)

2547

service = AvahiServiceToSyslog(name =

2548

server_settings["servicename"],

2549

servicetype = "_mandos._tcp",

2550

protocol = protocol, bus = bus)

3252

2551

if server_settings["interface"]:

3253

service.interface = if_nametoindex(

3254

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

3255

2552

service.interface = (if_nametoindex

2553

(server_settings["interface"]

2554

.encode("utf-8")))

2555

3256

2556

global multiprocessing_manager

3257

2557

multiprocessing_manager = multiprocessing.Manager()

3258

2558

3259

2559

client_class = Client

3260

2560

if use_dbus:

3261

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

3262

2561

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

2562

3263

2563

client_settings = Client.config_parser(client_config)

3264

2564

old_client_settings = {}

3265

2565

clients_data = {}

3266

2566

3267

2567

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

3268

2568

global wnull

3269

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

2569

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

3270

2570

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

3271

2571

# mode

3272

2572

if debug or not foreground:

3273

2573

wnull.close()

3274

2574

3275

2575

# Get client data and settings from last running state.

3276

2576

if server_settings["restore"]:

3277

2577

try:

3278

2578

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

3279

if sys.version_info.major == 2:

3280

clients_data, old_client_settings = pickle.load(

3281

stored_state)

3282

else:

3283

bytes_clients_data, bytes_old_client_settings = (

3284

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

3285

# Fix bytes to strings

3286

# clients_data

3287

# .keys()

3288

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

3289

if isinstance(key, bytes)

3290

else key): value

3291

for key, value in

3292

bytes_clients_data.items()}

3293

del bytes_clients_data

3294

for key in clients_data:

3295

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

3296

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

3297

for k, v in

3298

clients_data[key].items()}

3299

clients_data[key] = value

3300

# .client_structure

3301

value["client_structure"] = [

3302

(s.decode("utf-8")

3303

if isinstance(s, bytes)

3304

else s) for s in

3305

value["client_structure"]]

3306

# .name, .host, and .checker_command

3307

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

3308

if isinstance(value[k], bytes):

3309

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

3310

if "key_id" not in value:

3311

value["key_id"] = ""

3312

elif "fingerprint" not in value:

3313

value["fingerprint"] = ""

3314

# old_client_settings

3315

# .keys()

3316

old_client_settings = {

3317

(key.decode("utf-8")

3318

if isinstance(key, bytes)

3319

else key): value

3320

for key, value in

3321

bytes_old_client_settings.items()}

3322

del bytes_old_client_settings

3323

# .host and .checker_command

3324

for value in old_client_settings.values():

3325

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

3326

if isinstance(value[attribute], bytes):

3327

value[attribute] = (value[attribute]

3328

.decode("utf-8"))

2579

clients_data, old_client_settings = (pickle.load

2580

(stored_state))

3329

2581

os.remove(stored_state_path)

3330

2582

except IOError as e:

3331

2583

if e.errno == errno.ENOENT:

3332

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

3333

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

2584

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

2585

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

3334

2586

else:

3335

2587

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

3336

2588

exc_info=e)

3337

2589

raise

3338

2590

except EOFError as e:

3339

2591

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

3340

"EOFError:",

3341

exc_info=e)

3342

2592

"EOFError:", exc_info=e)

2593

3343

2594

with PGPEngine() as pgp:

3344

2595

for client_name, client in clients_data.items():

3345

2596

# Skip removed clients

3346

2597

if client_name not in client_settings:

3347

2598

continue

3348

2599

3349

2600

# Decide which value to use after restoring saved state.

3350

2601

# We have three different values: Old config file,

3351

2602

# new config file, and saved state.

3356

2607

# For each value in new config, check if it

3357

2608

# differs from the old config value (Except for

3358

2609

# the "secret" attribute)

3359

if (name != "secret"

3360

and (value !=

3361

old_client_settings[client_name][name])):

2610

if (name != "secret" and

2611

value != old_client_settings[client_name]

2612

[name]):

3362

2613

client[name] = value

3363

2614

except KeyError:

3364

2615

pass

3365

2616

3366

2617

# Clients who has passed its expire date can still be

3367

# enabled if its last checker was successful. A Client

2618

# enabled if its last checker was successful. Clients

3368

2619

# whose checker succeeded before we stored its state is

3369

2620

# assumed to have successfully run all checkers during

3370

2621

# downtime.

3373

2624

if not client["last_checked_ok"]:

3374

2625

logger.warning(

3375

2626

"disabling client {} - Client never "

3376

"performed a successful checker".format(

3377

client_name))

2627

"performed a successful checker"

2628

.format(client_name))

3378

2629

client["enabled"] = False

3379

2630

elif client["last_checker_status"] != 0:

3380

2631

logger.warning(

3381

2632

"disabling client {} - Client last"

3382

" checker failed with error code"

3383

" {}".format(

3384

client_name,

3385

client["last_checker_status"]))

2633

" checker failed with error code {}"

2634

.format(client_name,

2635

client["last_checker_status"]))

3386

2636

client["enabled"] = False

3387

2637

else:

3388

client["expires"] = (

3389

datetime.datetime.utcnow()

3390

+ client["timeout"])

2638

client["expires"] = (datetime.datetime

2639

.utcnow()

2640

+ client["timeout"])

3391

2641

logger.debug("Last checker succeeded,"

3392

" keeping {} enabled".format(

3393

client_name))

2642

" keeping {} enabled"

2643

.format(client_name))

3394

2644

try:

3395

client["secret"] = pgp.decrypt(

3396

client["encrypted_secret"],

3397

client_settings[client_name]["secret"])

2645

client["secret"] = (

2646

pgp.decrypt(client["encrypted_secret"],

2647

client_settings[client_name]

2648

["secret"]))

3398

2649

except PGPError:

3399

2650

# If decryption fails, we use secret from new settings

3400

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

3401

client_name))

3402

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

3403

["secret"])

3404

2651

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

2652

.format(client_name))

2653

client["secret"] = (

2654

client_settings[client_name]["secret"])

2655

3405

2656

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

3406

2657

for client_name in (set(old_client_settings)

3407

2658

- set(client_settings)):

3409

2660

for client_name in (set(client_settings)

3410

2661

- set(old_client_settings)):

3411

2662

clients_data[client_name] = client_settings[client_name]

3412

2663

3413

2664

# Create all client objects

3414

2665

for client_name, client in clients_data.items():

3415

2666

tcp_server.clients[client_name] = client_class(

3416

name=client_name,

3417

settings=client,

3418

server_settings=server_settings)

3419

2667

name = client_name, settings = client,

2668

server_settings = server_settings)

2669

3420

2670

if not tcp_server.clients:

3421

2671

logger.warning("No clients defined")

3422

2672

3423

2673

if not foreground:

3424

2674

if pidfile is not None:

3425

pid = os.getpid()

3426

2675

try:

3427

2676

with pidfile:

3428

print(pid, file=pidfile)

2677

pid = os.getpid()

2678

pidfile.write("{}\n".format(pid).encode("utf-8"))

3429

2679

except IOError:

3430

2680

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

3431

2681

pidfilename, pid)

3432

2682

del pidfile

3433

2683

del pidfilename

3434

3435

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

3436

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3437

lambda: main_loop.quit() and False)

3438

2684

2685

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

2686

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

2687

3439

2688

if use_dbus:

3440

3441

@alternate_dbus_interfaces(

3442

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

3443

class MandosDBusService(DBusObjectWithObjectManager):

2689

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

2690

"se.bsnet.fukt.Mandos"})

2691

class MandosDBusService(DBusObjectWithProperties):

3444

2692

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

3445

3446

2693

def __init__(self):

3447

2694

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

3448

3449

2695

_interface = "se.recompile.Mandos"

3450

2696

2697

@dbus_interface_annotations(_interface)

2698

def _foo(self):

2699

return { "org.freedesktop.DBus.Property"

2700

".EmitsChangedSignal":

2701

"false"}

2702

3451

2703

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

3452

2704

def ClientAdded(self, objpath):

3453

2705

"D-Bus signal"

3454

2706

pass

3455

2707

3456

2708

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

3457

def ClientNotFound(self, key_id, address):

2709

def ClientNotFound(self, fingerprint, address):

3458

2710

"D-Bus signal"

3459

2711

pass

3460

3461

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

3462

"true"})

2712

3463

2713

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

3464

2714

def ClientRemoved(self, objpath, name):

3465

2715

"D-Bus signal"

3466

2716

pass

3467

3468

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

3469

"true"})

2717

3470

2718

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

3471

2719

def GetAllClients(self):

3472

2720

"D-Bus method"

3473

return dbus.Array(c.dbus_object_path for c in

3474

tcp_server.clients.values())

3475

3476

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

3477

"true"})

2721

return dbus.Array(c.dbus_object_path

2722

for c in

2723

tcp_server.clients.itervalues())

2724

3478

2725

@dbus.service.method(_interface,

3479

2726

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

3480

2727

def GetAllClientsWithProperties(self):

3481

2728

"D-Bus method"

3482

2729

return dbus.Dictionary(

3483

{c.dbus_object_path: c.GetAll(

3484

"se.recompile.Mandos.Client")

3485

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

2730

{ c.dbus_object_path: c.GetAll("")

2731

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

3486

2732

signature="oa{sv}")

3487

2733

3488

2734

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

3489

2735

def RemoveClient(self, object_path):

3490

2736

"D-Bus method"

3491

for c in tcp_server.clients.values():

2737

for c in tcp_server.clients.itervalues():

3492

2738

if c.dbus_object_path == object_path:

3493

2739

del tcp_server.clients[c.name]

3494

2740

c.remove_from_connection()

3495

# Don't signal the disabling

2741

# Don't signal anything except ClientRemoved

3496

2742

c.disable(quiet=True)

3497

# Emit D-Bus signal for removal

3498

self.client_removed_signal(c)

2743

# Emit D-Bus signal

2744

self.ClientRemoved(object_path, c.name)

3499

2745

return

3500

2746

raise KeyError(object_path)

3501

2747

3502

2748

del _interface

3503

3504

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3505

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

3506

def GetManagedObjects(self):

3507

"""D-Bus method"""

3508

return dbus.Dictionary(

3509

{client.dbus_object_path:

3510

dbus.Dictionary(

3511

{interface: client.GetAll(interface)

3512

for interface in

3513

client._get_all_interface_names()})

3514

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

3515

3516

def client_added_signal(self, client):

3517

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

3518

if use_dbus:

3519

# New standard signal

3520

self.InterfacesAdded(

3521

client.dbus_object_path,

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()}))

3526

# Old signal

3527

self.ClientAdded(client.dbus_object_path)

3528

3529

def client_removed_signal(self, client):

3530

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

3531

if use_dbus:

3532

# New standard signal

3533

self.InterfacesRemoved(

3534

client.dbus_object_path,

3535

client._get_all_interface_names())

3536

# Old signal

3537

self.ClientRemoved(client.dbus_object_path,

3538

client.name)

3539

2749

3540

2750

mandos_dbus_service = MandosDBusService()

3541

3542

# Save modules to variables to exempt the modules from being

3543

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

3544

mp = multiprocessing

3545

wn = wnull

3546

2751

3547

2752

def cleanup():

3548

2753

"Cleanup function; run on exit"

3549

2754

if zeroconf:

3550

2755

service.cleanup()

3551

3552

mp.active_children()

3553

wn.close()

2756

2757

multiprocessing.active_children()

2758

wnull.close()

3554

2759

if not (tcp_server.clients or client_settings):

3555

2760

return

3556

2761

3557

2762

# Store client before exiting. Secrets are encrypted with key

3558

2763

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

3559

2764

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

3560

2765

clients = {}

3561

2766

with PGPEngine() as pgp:

3562

for client in tcp_server.clients.values():

2767

for client in tcp_server.clients.itervalues():

3563

2768

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

3564

2769

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

3565

2770

key)

3566

2771

client_dict = {}

3567

2772

3568

2773

# A list of attributes that can not be pickled

3569

2774

# + secret.

3570

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

3571

"checker", "server_settings"}

3572

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

3573

.Object):

2775

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

2776

"checker", "server_settings" }

2777

for name, typ in (inspect.getmembers

2778

(dbus.service.Object)):

3574

2779

exclude.add(name)

3575

2780

3576

2781

client_dict["encrypted_secret"] = (client

3577

2782

.encrypted_secret)

3578

2783

for attr in client.client_structure:

3579

2784

if attr not in exclude:

3580

2785

client_dict[attr] = getattr(client, attr)

3581

2786

3582

2787

clients[client.name] = client_dict

3583

2788

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

3584

2789

3585

2790

try:

3586

with tempfile.NamedTemporaryFile(

3587

mode='wb',

3588

suffix=".pickle",

3589

prefix='clients-',

3590

dir=os.path.dirname(stored_state_path),

3591

delete=False) as stored_state:

3592

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

3593

protocol=2)

3594

tempname = stored_state.name

2791

with (tempfile.NamedTemporaryFile

2792

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

2793

dir=os.path.dirname(stored_state_path),

2794

delete=False)) as stored_state:

2795

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

2796

tempname=stored_state.name

3595

2797

os.rename(tempname, stored_state_path)

3596

2798

except (IOError, OSError) as e:

3597

2799

if not debug:

3606

2808

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

3607

2809

exc_info=e)

3608

2810

raise

3609

2811

3610

2812

# Delete all clients, and settings from config

3611

2813

while tcp_server.clients:

3612

2814

name, client = tcp_server.clients.popitem()

3613

2815

if use_dbus:

3614

2816

client.remove_from_connection()

3615

# Don't signal the disabling

2817

# Don't signal anything except ClientRemoved

3616

2818

client.disable(quiet=True)

3617

# Emit D-Bus signal for removal

3618

2819

if use_dbus:

3619

mandos_dbus_service.client_removed_signal(client)

2820

# Emit D-Bus signal

2821

mandos_dbus_service.ClientRemoved(client

2822

.dbus_object_path,

2823

client.name)

3620

2824

client_settings.clear()

3621

2825

3622

2826

atexit.register(cleanup)

3623

3624

for client in tcp_server.clients.values():

2827

2828

for client in tcp_server.clients.itervalues():

3625

2829

if use_dbus:

3626

# Emit D-Bus signal for adding

3627

mandos_dbus_service.client_added_signal(client)

2830

# Emit D-Bus signal

2831

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3628

2832

# Need to initiate checking of clients

3629

2833

if client.enabled:

3630

2834

client.init_checker()

3631

2835

3632

2836

tcp_server.enable()

3633

2837

tcp_server.server_activate()

3634

2838

3635

2839

# Find out what port we got

3636

2840

if zeroconf:

3637

2841

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

3642

2846

else: # IPv4

3643

2847

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

3644

2848

*tcp_server.socket.getsockname())

3645

3646

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

3647

2849

2850

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

2851

3648

2852

try:

3649

2853

if zeroconf:

3650

2854

# From the Avahi example code

3655

2859

cleanup()

3656

2860

sys.exit(1)

3657

2861

# End of Avahi example code

3658

3659

GLib.io_add_watch(

3660

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

3661

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3662

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

3663

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

3664

2862

2863

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

2864

lambda *args, **kwargs:

2865

(tcp_server.handle_request

2866

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

2867

3665

2868

logger.debug("Starting main loop")

3666

2869

main_loop.run()

3667

2870

except AvahiError as error:

3676

2879

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

3677

2880

cleanup()

3678

2881

3679

3680

def should_only_run_tests():

3681

parser = argparse.ArgumentParser(add_help=False)

3682

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

3683

args, unknown_args = parser.parse_known_args()

3684

run_tests = args.check

3685

if run_tests:

3686

# Remove --check argument from sys.argv

3687

sys.argv[1:] = unknown_args

3688

return run_tests

3689

3690

# Add all tests from doctest strings

3691

def load_tests(loader, tests, none):

3692

import doctest

3693

tests.addTests(doctest.DocTestSuite())

3694

return tests

3695

3696

2882

if __name__ == '__main__':

3697

try:

3698

if should_only_run_tests():

3699

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

3700

unittest.main()

3701

else:

3702

main()

3703

finally:

3704

logging.shutdown()

2883

main()