/mandos/release : revision 237.7.278

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

72

82

73

import dbus

83

74

import dbus.service

84

import gi

85

from gi.repository import GLib

75

import gobject

76

import avahi

86

77

from dbus.mainloop.glib import DBusGMainLoop

87

78

import ctypes

88

79

import ctypes.util

89

80

import xml.dom.minidom

90

81

import inspect

91

82

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

str = unicode

95

96

# Show warnings by default

97

if not sys.warnoptions:

98

import warnings

99

warnings.simplefilter("default")

100

101

# Try to find the value of SO_BINDTODEVICE:

102

83

try:

103

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

104

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

105

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

106

85

except AttributeError:

107

86

try:

108

# This is where SO_BINDTODEVICE was up to and including Python

109

# 2.6, and also 3.2:

110

87

from IN import SO_BINDTODEVICE

111

88

except ImportError:

112

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

113

# Try running the C preprocessor:

114

try:

115

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

116

"/dev/stdin"],

117

stdin=subprocess.PIPE,

118

stdout=subprocess.PIPE)

119

stdout = cc.communicate(

120

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

121

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

122

except (OSError, ValueError, IndexError):

123

# No value found

124

SO_BINDTODEVICE = None

125

126

if sys.version_info < (3, 2):

127

configparser.Configparser = configparser.SafeConfigParser

128

129

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.8"

130

95

stored_state_file = "clients.pickle"

131

96

132

97

logger = logging.getLogger()

133

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

134

98

syslogger = None

135

99

136

100

try:

137

if_nametoindex = ctypes.cdll.LoadLibrary(

138

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

139

104

except (OSError, AttributeError):

140

141

105

def if_nametoindex(interface):

142

106

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

143

107

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

148

112

return interface_index

149

113

150

114

151

def copy_function(func):

152

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

153

if sys.version_info.major == 2:

154

return types.FunctionType(func.func_code,

155

func.func_globals,

156

func.func_name,

157

func.func_defaults,

158

func.func_closure)

159

else:

160

return types.FunctionType(func.__code__,

161

func.__globals__,

162

func.__name__,

163

func.__defaults__,

164

func.__closure__)

165

166

167

115

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

168

116

"""init logger and add loglevel"""

169

117

170

118

global syslogger

171

syslogger = (logging.handlers.SysLogHandler(

172

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

173

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

174

123

syslogger.setFormatter(logging.Formatter

175

124

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

176

125

' %(message)s'))

177

126

logger.addHandler(syslogger)

178

127

179

128

if debug:

180

129

console = logging.StreamHandler()

181

130

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

191

140

pass

192

141

193

142

194

class PGPEngine:

143

class PGPEngine(object):

195

144

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

196

197

145

def __init__(self):

198

146

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

199

self.gpg = "gpg"

200

try:

201

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

202

for line in output.splitlines():

203

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

204

if name == b"gpg":

205

self.gpg = path

206

break

207

except OSError as e:

208

if e.errno != errno.ENOENT:

209

raise

210

147

self.gnupgargs = ['--batch',

211

'--homedir', self.tempdir,

148

'--home', self.tempdir,

212

149

'--force-mdc',

213

'--quiet']

214

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

215

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

216

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

217

150

'--quiet',

151

'--no-use-agent']

152

218

153

def __enter__(self):

219

154

return self

220

155

221

156

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

222

157

self._cleanup()

223

158

return False

224

159

225

160

def __del__(self):

226

161

self._cleanup()

227

162

228

163

def _cleanup(self):

229

164

if self.tempdir is not None:

230

165

# Delete contents of tempdir

231

166

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

232

topdown=False):

167

topdown = False):

233

168

for filename in files:

234

169

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

235

170

for dirname in dirs:

237

172

# Remove tempdir

238

173

os.rmdir(self.tempdir)

239

174

self.tempdir = None

240

175

241

176

def password_encode(self, password):

242

177

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

243

178

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

248

183

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

249

184

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

250

185

return encoded

251

186

252

187

def encrypt(self, data, password):

253

188

passphrase = self.password_encode(password)

254

with tempfile.NamedTemporaryFile(

255

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

256

191

passfile.write(passphrase)

257

192

passfile.flush()

258

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

193

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

259

194

'--passphrase-file',

260

195

passfile.name]

261

196

+ self.gnupgargs,

262

stdin=subprocess.PIPE,

263

stdout=subprocess.PIPE,

264

stderr=subprocess.PIPE)

265

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)

266

201

if proc.returncode != 0:

267

202

raise PGPError(err)

268

203

return ciphertext

269

204

270

205

def decrypt(self, data, password):

271

206

passphrase = self.password_encode(password)

272

with tempfile.NamedTemporaryFile(

273

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

274

209

passfile.write(passphrase)

275

210

passfile.flush()

276

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

211

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

277

212

'--passphrase-file',

278

213

passfile.name]

279

214

+ self.gnupgargs,

280

stdin=subprocess.PIPE,

281

stdout=subprocess.PIPE,

282

stderr=subprocess.PIPE)

283

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)

284

220

if proc.returncode != 0:

285

221

raise PGPError(err)

286

222

return decrypted_plaintext

287

223

288

224

289

# Pretend that we have an Avahi module

290

class avahi:

291

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

292

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

293

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

294

PROTO_INET = 0 # avahi-common/address.h

295

PROTO_INET6 = 1 # avahi-common/address.h

296

DBUS_NAME = "org.freedesktop.Avahi"

297

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

298

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

299

DBUS_PATH_SERVER = "/"

300

301

@staticmethod

302

def string_array_to_txt_array(t):

303

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

304

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

305

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

306

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

307

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

308

SERVER_INVALID = 0 # avahi-common/defs.h

309

SERVER_REGISTERING = 1 # avahi-common/defs.h

310

SERVER_RUNNING = 2 # avahi-common/defs.h

311

SERVER_COLLISION = 3 # avahi-common/defs.h

312

SERVER_FAILURE = 4 # avahi-common/defs.h

313

314

315

225

class AvahiError(Exception):

316

226

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

317

227

self.value = value

318

228

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

319

229

**kwargs)

320

230

321

322

231

class AvahiServiceError(AvahiError):

323

232

pass

324

233

325

326

234

class AvahiGroupError(AvahiError):

327

235

pass

328

236

329

237

330

class AvahiService:

238

class AvahiService(object):

331

239

"""An Avahi (Zeroconf) service.

332

240

333

241

Attributes:

334

242

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

335

243

Used to optionally bind to the specified interface.

347

255

server: D-Bus Server

348

256

bus: dbus.SystemBus()

349

257

"""

350

351

def __init__(self,

352

interface=avahi.IF_UNSPEC,

353

name=None,

354

servicetype=None,

355

port=None,

356

TXT=None,

357

domain="",

358

host="",

359

max_renames=32768,

360

protocol=avahi.PROTO_UNSPEC,

361

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

362

263

self.interface = interface

363

264

self.name = name

364

265

self.type = servicetype

373

274

self.server = None

374

275

self.bus = bus

375

276

self.entry_group_state_changed_match = None

376

377

def rename(self, remove=True):

277

278

def rename(self):

378

279

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

379

280

if self.rename_count >= self.max_renames:

380

281

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

381

282

" after %i retries, exiting.",

382

283

self.rename_count)

383

284

raise AvahiServiceError("Too many renames")

384

self.name = str(

385

self.server.GetAlternativeServiceName(self.name))

386

self.rename_count += 1

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

387

287

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

388

288

self.name)

389

if remove:

390

self.remove()

289

self.remove()

391

290

try:

392

291

self.add()

393

292

except dbus.exceptions.DBusException as error:

394

if (error.get_dbus_name()

395

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

396

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

397

return self.rename(remove=False)

398

else:

399

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

400

self.cleanup()

401

os._exit(1)

402

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

403

298

def remove(self):

404

299

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

405

300

if self.entry_group_state_changed_match is not None:

407

302

self.entry_group_state_changed_match = None

408

303

if self.group is not None:

409

304

self.group.Reset()

410

305

411

306

def add(self):

412

307

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

413

308

self.remove()

430

325

dbus.UInt16(self.port),

431

326

avahi.string_array_to_txt_array(self.TXT))

432

327

self.group.Commit()

433

328

434

329

def entry_group_state_changed(self, state, error):

435

330

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

436

331

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

437

332

438

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

439

334

logger.debug("Zeroconf service established.")

440

335

elif state == avahi.ENTRY_GROUP_COLLISION:

443

338

elif state == avahi.ENTRY_GROUP_FAILURE:

444

339

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

445

340

str(error))

446

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

447

341

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

342

.format(error))

343

448

344

def cleanup(self):

449

345

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

450

346

if self.group is not None:

455

351

pass

456

352

self.group = None

457

353

self.remove()

458

354

459

355

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

460

356

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

461

357

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

462

bad_states = {

463

avahi.SERVER_INVALID: "Zeroconf server invalid",

464

avahi.SERVER_REGISTERING: None,

465

avahi.SERVER_COLLISION: "Zeroconf server name collision",

466

avahi.SERVER_FAILURE: "Zeroconf server failure",

467

}

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" }

468

365

if state in bad_states:

469

366

if bad_states[state] is not None:

470

367

if error is None:

473

370

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

474

371

self.cleanup()

475

372

elif state == avahi.SERVER_RUNNING:

476

try:

477

self.add()

478

except dbus.exceptions.DBusException as error:

479

if (error.get_dbus_name()

480

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

481

logger.info("Local Zeroconf service name"

482

" collision.")

483

return self.rename(remove=False)

484

else:

485

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

486

self.cleanup()

487

os._exit(1)

373

self.add()

488

374

else:

489

375

if error is None:

490

376

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

491

377

else:

492

378

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

493

379

494

380

def activate(self):

495

381

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

496

382

if self.server is None:

500

386

follow_name_owner_changes=True),

501

387

avahi.DBUS_INTERFACE_SERVER)

502

388

self.server.connect_to_signal("StateChanged",

503

self.server_state_changed)

389

self.server_state_changed)

504

390

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

505

391

506

392

507

393

class AvahiServiceToSyslog(AvahiService):

508

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

394

def rename(self):

509

395

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

510

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

511

syslogger.setFormatter(logging.Formatter(

512

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

513

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

514

401

return ret

515

402

516

403

517

# Pretend that we have a GnuTLS module

518

class gnutls:

519

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

520

521

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

522

if library is None:

523

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

524

_library = ctypes.cdll.LoadLibrary(library)

525

del library

526

527

# Unless otherwise indicated, the constants and types below are

528

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

529

530

# Constants

531

E_SUCCESS = 0

532

E_INTERRUPTED = -52

533

E_AGAIN = -28

534

CRT_OPENPGP = 2

535

CRT_RAWPK = 3

536

CLIENT = 2

537

SHUT_RDWR = 0

538

CRD_CERTIFICATE = 1

539

E_NO_CERTIFICATE_FOUND = -49

540

X509_FMT_DER = 0

541

NO_TICKETS = 1<<10

542

ENABLE_RAWPK = 1<<18

543

CTYPE_PEERS = 3

544

KEYID_USE_SHA256 = 1 # gnutls/x509.h

545

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

546

547

# Types

548

class session_int(ctypes.Structure):

549

_fields_ = []

550

session_t = ctypes.POINTER(session_int)

551

552

class certificate_credentials_st(ctypes.Structure):

553

_fields_ = []

554

certificate_credentials_t = ctypes.POINTER(

555

certificate_credentials_st)

556

certificate_type_t = ctypes.c_int

557

558

class datum_t(ctypes.Structure):

559

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

560

('size', ctypes.c_uint)]

561

562

class openpgp_crt_int(ctypes.Structure):

563

_fields_ = []

564

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

565

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

566

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

567

credentials_type_t = ctypes.c_int

568

transport_ptr_t = ctypes.c_void_p

569

close_request_t = ctypes.c_int

570

571

# Exceptions

572

class Error(Exception):

573

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

574

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

575

# code is passed, convert it to a string with

576

# gnutls.strerror()

577

self.code = code

578

if message is None and code is not None:

579

message = gnutls.strerror(code)

580

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

581

message, *args)

582

583

class CertificateSecurityError(Error):

584

pass

585

586

# Classes

587

class Credentials:

588

def __init__(self):

589

self._c_object = gnutls.certificate_credentials_t()

590

gnutls.certificate_allocate_credentials(

591

ctypes.byref(self._c_object))

592

self.type = gnutls.CRD_CERTIFICATE

593

594

def __del__(self):

595

gnutls.certificate_free_credentials(self._c_object)

596

597

class ClientSession:

598

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

599

self._c_object = gnutls.session_t()

600

gnutls_flags = gnutls.CLIENT

601

if gnutls.check_version(b"3.5.6"):

602

gnutls_flags |= gnutls.NO_TICKETS

603

if gnutls.has_rawpk:

604

gnutls_flags |= gnutls.ENABLE_RAWPK

605

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

606

del gnutls_flags

607

gnutls.set_default_priority(self._c_object)

608

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

609

gnutls.handshake_set_private_extensions(self._c_object,

610

True)

611

self.socket = socket

612

if credentials is None:

613

credentials = gnutls.Credentials()

614

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

615

ctypes.cast(credentials._c_object,

616

ctypes.c_void_p))

617

self.credentials = credentials

618

619

def __del__(self):

620

gnutls.deinit(self._c_object)

621

622

def handshake(self):

623

return gnutls.handshake(self._c_object)

624

625

def send(self, data):

626

data = bytes(data)

627

data_len = len(data)

628

while data_len > 0:

629

data_len -= gnutls.record_send(self._c_object,

630

data[-data_len:],

631

data_len)

632

633

def bye(self):

634

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

635

636

# Error handling functions

637

def _error_code(result):

638

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

639

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

640

if result >= 0:

641

return result

642

if result == gnutls.E_NO_CERTIFICATE_FOUND:

643

raise gnutls.CertificateSecurityError(code=result)

644

raise gnutls.Error(code=result)

645

646

def _retry_on_error(result, func, arguments):

647

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

648

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

649

while result < 0:

650

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

651

return _error_code(result)

652

result = func(*arguments)

653

return result

654

655

# Unless otherwise indicated, the function declarations below are

656

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

657

658

# Functions

659

priority_set_direct = _library.gnutls_priority_set_direct

660

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

661

ctypes.POINTER(ctypes.c_char_p)]

662

priority_set_direct.restype = _error_code

663

664

init = _library.gnutls_init

665

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

666

init.restype = _error_code

667

668

set_default_priority = _library.gnutls_set_default_priority

669

set_default_priority.argtypes = [session_t]

670

set_default_priority.restype = _error_code

671

672

record_send = _library.gnutls_record_send

673

record_send.argtypes = [session_t, ctypes.c_void_p,

674

ctypes.c_size_t]

675

record_send.restype = ctypes.c_ssize_t

676

record_send.errcheck = _retry_on_error

677

678

certificate_allocate_credentials = (

679

_library.gnutls_certificate_allocate_credentials)

680

certificate_allocate_credentials.argtypes = [

681

ctypes.POINTER(certificate_credentials_t)]

682

certificate_allocate_credentials.restype = _error_code

683

684

certificate_free_credentials = (

685

_library.gnutls_certificate_free_credentials)

686

certificate_free_credentials.argtypes = [

687

certificate_credentials_t]

688

certificate_free_credentials.restype = None

689

690

handshake_set_private_extensions = (

691

_library.gnutls_handshake_set_private_extensions)

692

handshake_set_private_extensions.argtypes = [session_t,

693

ctypes.c_int]

694

handshake_set_private_extensions.restype = None

695

696

credentials_set = _library.gnutls_credentials_set

697

credentials_set.argtypes = [session_t, credentials_type_t,

698

ctypes.c_void_p]

699

credentials_set.restype = _error_code

700

701

strerror = _library.gnutls_strerror

702

strerror.argtypes = [ctypes.c_int]

703

strerror.restype = ctypes.c_char_p

704

705

certificate_type_get = _library.gnutls_certificate_type_get

706

certificate_type_get.argtypes = [session_t]

707

certificate_type_get.restype = _error_code

708

709

certificate_get_peers = _library.gnutls_certificate_get_peers

710

certificate_get_peers.argtypes = [session_t,

711

ctypes.POINTER(ctypes.c_uint)]

712

certificate_get_peers.restype = ctypes.POINTER(datum_t)

713

714

global_set_log_level = _library.gnutls_global_set_log_level

715

global_set_log_level.argtypes = [ctypes.c_int]

716

global_set_log_level.restype = None

717

718

global_set_log_function = _library.gnutls_global_set_log_function

719

global_set_log_function.argtypes = [log_func]

720

global_set_log_function.restype = None

721

722

deinit = _library.gnutls_deinit

723

deinit.argtypes = [session_t]

724

deinit.restype = None

725

726

handshake = _library.gnutls_handshake

727

handshake.argtypes = [session_t]

728

handshake.restype = _error_code

729

handshake.errcheck = _retry_on_error

730

731

transport_set_ptr = _library.gnutls_transport_set_ptr

732

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

733

transport_set_ptr.restype = None

734

735

bye = _library.gnutls_bye

736

bye.argtypes = [session_t, close_request_t]

737

bye.restype = _error_code

738

bye.errcheck = _retry_on_error

739

740

check_version = _library.gnutls_check_version

741

check_version.argtypes = [ctypes.c_char_p]

742

check_version.restype = ctypes.c_char_p

743

744

_need_version = b"3.3.0"

745

if check_version(_need_version) is None:

746

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

747

.format(_need_version))

748

749

_tls_rawpk_version = b"3.6.6"

750

has_rawpk = bool(check_version(_tls_rawpk_version))

751

752

if has_rawpk:

753

# Types

754

class pubkey_st(ctypes.Structure):

755

_fields = []

756

pubkey_t = ctypes.POINTER(pubkey_st)

757

758

x509_crt_fmt_t = ctypes.c_int

759

760

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

761

pubkey_init = _library.gnutls_pubkey_init

762

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

763

pubkey_init.restype = _error_code

764

765

pubkey_import = _library.gnutls_pubkey_import

766

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

767

x509_crt_fmt_t]

768

pubkey_import.restype = _error_code

769

770

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

771

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

772

ctypes.POINTER(ctypes.c_ubyte),

773

ctypes.POINTER(ctypes.c_size_t)]

774

pubkey_get_key_id.restype = _error_code

775

776

pubkey_deinit = _library.gnutls_pubkey_deinit

777

pubkey_deinit.argtypes = [pubkey_t]

778

pubkey_deinit.restype = None

779

else:

780

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

781

782

openpgp_crt_init = _library.gnutls_openpgp_crt_init

783

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

784

openpgp_crt_init.restype = _error_code

785

786

openpgp_crt_import = _library.gnutls_openpgp_crt_import

787

openpgp_crt_import.argtypes = [openpgp_crt_t,

788

ctypes.POINTER(datum_t),

789

openpgp_crt_fmt_t]

790

openpgp_crt_import.restype = _error_code

791

792

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

793

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

794

ctypes.POINTER(ctypes.c_uint)]

795

openpgp_crt_verify_self.restype = _error_code

796

797

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

798

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

799

openpgp_crt_deinit.restype = None

800

801

openpgp_crt_get_fingerprint = (

802

_library.gnutls_openpgp_crt_get_fingerprint)

803

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

804

ctypes.c_void_p,

805

ctypes.POINTER(

806

ctypes.c_size_t)]

807

openpgp_crt_get_fingerprint.restype = _error_code

808

809

if check_version(b"3.6.4"):

810

certificate_type_get2 = _library.gnutls_certificate_type_get2

811

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

812

certificate_type_get2.restype = _error_code

813

814

# Remove non-public functions

815

del _error_code, _retry_on_error

816

817

818

def call_pipe(connection, # : multiprocessing.Connection

819

func, *args, **kwargs):

820

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

821

822

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

823

return value on the provided multiprocessing.Connection.

824

"""

825

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

826

connection.close()

827

828

829

class Client:

404

class Client(object):

830

405

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

831

406

832

407

Attributes:

833

408

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

834

409

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

835

410

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

836

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

837

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

838

running.

839

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

840

415

checker_command: string; External command which is run to check

841

416

if client lives. %() expansions are done at

842

417

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

843

418

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

844

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

845

420

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

846

421

client_structure: Object describing what attributes a client has

847

422

and is used for storing the client at exit

848

423

current_checker_command: string; current running checker_command

849

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

850

425

enabled: bool()

851

426

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

852

uniquely identify an OpenPGP client

853

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

854

a client using raw public keys

427

uniquely identify the client

855

428

host: string; available for use by the checker command

856

429

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

857

430

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

859

432

last_checker_status: integer between 0 and 255 reflecting exit

860

433

status of last checker. -1 reflects crashed

861

434

checker, -2 means no checker completed yet.

862

last_checker_signal: The signal which killed the last checker, if

863

last_checker_status is -1

864

435

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

865

436

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

866

437

D-Bus identifiers

873

444

disabled, or None

874

445

server_settings: The server_settings dict from main()

875

446

"""

876

447

877

448

runtime_expansions = ("approval_delay", "approval_duration",

878

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

449

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

879

450

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

880

451

"last_approval_request", "last_checked_ok",

881

452

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

882

client_defaults = {

883

"timeout": "PT5M",

884

"extended_timeout": "PT15M",

885

"interval": "PT2M",

886

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

887

"host": "",

888

"approval_delay": "PT0S",

889

"approval_duration": "PT1S",

890

"approved_by_default": "True",

891

"enabled": "True",

892

}

893

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

894

464

@staticmethod

895

465

def config_parser(config):

896

466

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

903

473

for client_name in config.sections():

904

474

section = dict(config.items(client_name))

905

475

client = settings[client_name] = {}

906

476

907

477

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

908

478

# Reformat values from string types to Python types

909

479

client["approved_by_default"] = config.getboolean(

910

480

client_name, "approved_by_default")

911

481

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

912

482

"enabled")

913

914

# Uppercase and remove spaces from key_id and fingerprint

915

# for later comparison purposes with return value from the

916

# key_id() and fingerprint() functions

917

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

918

.replace(" ", ""))

483

919

484

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

920

485

.replace(" ", ""))

921

486

if "secret" in section:

922

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

923

.encode("utf-8"),

924

"base64")

487

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

925

488

elif "secfile" in section:

926

489

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

927

490

(section["secfile"])),

942

505

client["last_approval_request"] = None

943

506

client["last_checked_ok"] = None

944

507

client["last_checker_status"] = -2

945

508

946

509

return settings

947

948

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

510

511

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

949

512

self.name = name

950

513

if server_settings is None:

951

514

server_settings = {}

953

516

# adding all client settings

954

517

for setting, value in settings.items():

955

518

setattr(self, setting, value)

956

519

957

520

if self.enabled:

958

521

if not hasattr(self, "last_enabled"):

959

522

self.last_enabled = datetime.datetime.utcnow()

963

526

else:

964

527

self.last_enabled = None

965

528

self.expires = None

966

529

967

530

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

968

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

969

534

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

970

535

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

971

536

datetime.datetime.utcnow())

972

537

973

538

# attributes specific for this server instance

974

539

self.checker = None

975

540

self.checker_initiator_tag = None

978

543

self.current_checker_command = None

979

544

self.approved = None

980

545

self.approvals_pending = 0

981

self.changedstate = multiprocessing_manager.Condition(

982

multiprocessing_manager.Lock())

983

self.client_structure = [attr

984

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

985

551

if not attr.startswith("_")]

986

552

self.client_structure.append("client_structure")

987

988

for name, t in inspect.getmembers(

989

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

990

558

if not name.startswith("_"):

991

559

self.client_structure.append(name)

992

560

993

561

# Send notice to process children that client state has changed

994

562

def send_changedstate(self):

995

563

with self.changedstate:

996

564

self.changedstate.notify_all()

997

565

998

566

def enable(self):

999

567

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

1000

568

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

1005

573

self.last_enabled = datetime.datetime.utcnow()

1006

574

self.init_checker()

1007

575

self.send_changedstate()

1008

576

1009

577

def disable(self, quiet=True):

1010

578

"""Disable this client."""

1011

579

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

1013

581

if not quiet:

1014

582

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

1015

583

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

1016

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1017

585

self.disable_initiator_tag = None

1018

586

self.expires = None

1019

587

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

1020

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1021

589

self.checker_initiator_tag = None

1022

590

self.stop_checker()

1023

591

self.enabled = False

1024

592

if not quiet:

1025

593

self.send_changedstate()

1026

# 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

1027

595

return False

1028

596

1029

597

def __del__(self):

1030

598

self.disable()

1031

599

1032

600

def init_checker(self):

1033

601

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

1034

602

# and every interval from then on.

1035

603

if self.checker_initiator_tag is not None:

1036

GLib.source_remove(self.checker_initiator_tag)

1037

self.checker_initiator_tag = GLib.timeout_add(

1038

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

1039

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

1040

609

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

1041

610

if self.disable_initiator_tag is not None:

1042

GLib.source_remove(self.disable_initiator_tag)

1043

self.disable_initiator_tag = GLib.timeout_add(

1044

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

1045

616

# Also start a new checker *right now*.

1046

617

self.start_checker()

1047

1048

def checker_callback(self, source, condition, connection,

1049

command):

618

619

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

1050

620

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

1051

# Read return code from connection (see call_pipe)

1052

returncode = connection.recv()

1053

connection.close()

1054

if self.checker is not None:

1055

self.checker.join()

1056

621

self.checker_callback_tag = None

1057

622

self.checker = None

1058

1059

if returncode >= 0:

1060

self.last_checker_status = returncode

1061

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1062

625

if self.last_checker_status == 0:

1063

626

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

1064

627

vars(self))

1065

628

self.checked_ok()

1066

629

else:

1067

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

630

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

631

vars(self))

1068

632

else:

1069

633

self.last_checker_status = -1

1070

self.last_checker_signal = -returncode

1071

634

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

1072

635

vars(self))

1073

return False

1074

636

1075

637

def checked_ok(self):

1076

638

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

1077

639

self.last_checked_ok = datetime.datetime.utcnow()

1078

640

self.last_checker_status = 0

1079

self.last_checker_signal = None

1080

641

self.bump_timeout()

1081

642

1082

643

def bump_timeout(self, timeout=None):

1083

644

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

1084

645

if timeout is None:

1085

646

timeout = self.timeout

1086

647

if self.disable_initiator_tag is not None:

1087

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1088

649

self.disable_initiator_tag = None

1089

650

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

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1092

654

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

1093

655

1094

656

def need_approval(self):

1095

657

self.last_approval_request = datetime.datetime.utcnow()

1096

658

1097

659

def start_checker(self):

1098

660

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

1099

661

1100

662

If a checker already exists, leave it running and do

1101

663

nothing."""

1102

664

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

1107

669

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

1108

670

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

1109

671

# should be.

1110

1111

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

1112

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

1113

self.checker.join()

1114

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)

1115

687

# Start a new checker if needed

1116

688

if self.checker is None:

1117

689

# Escape attributes for the shell

1118

escaped_attrs = {

1119

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

1120

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1121

693

try:

1122

694

command = self.checker_command % escaped_attrs

1123

695

except TypeError as error:

1124

696

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

1125

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",

1126

721

exc_info=error)

1127

return True # Try again later

1128

self.current_checker_command = command

1129

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

1130

self.name)

1131

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

1132

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

1133

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

1134

# always replaced by /dev/null.)

1135

# The exception is when not debugging but nevertheless

1136

# running in the foreground; use the previously

1137

# created wnull.

1138

popen_args = {"close_fds": True,

1139

"shell": True,

1140

"cwd": "/"}

1141

if (not self.server_settings["debug"]

1142

and self.server_settings["foreground"]):

1143

popen_args.update({"stdout": wnull,

1144

"stderr": wnull})

1145

pipe = multiprocessing.Pipe(duplex=False)

1146

self.checker = multiprocessing.Process(

1147

target=call_pipe,

1148

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

1149

kwargs=popen_args)

1150

self.checker.start()

1151

self.checker_callback_tag = GLib.io_add_watch(

1152

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

1153

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1154

self.checker_callback, pipe[0], command)

1155

# 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

1156

742

return True

1157

743

1158

744

def stop_checker(self):

1159

745

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

1160

746

if self.checker_callback_tag:

1161

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1162

748

self.checker_callback_tag = None

1163

749

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

1164

750

return

1165

751

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

1166

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

1167

760

self.checker = None

1168

761

1169

762

1170

def dbus_service_property(dbus_interface,

1171

signature="v",

1172

access="readwrite",

1173

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1174

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1175

766

become properties on the D-Bus.

1176

767

1177

768

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

1178

769

and with one argument by "Set".

1179

770

1180

771

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

1181

772

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

1182

773

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

1186

777

if byte_arrays and signature != "ay":

1187

778

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

1188

779

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

1189

1190

780

def decorator(func):

1191

781

func._dbus_is_property = True

1192

782

func._dbus_interface = dbus_interface

1195

785

func._dbus_name = func.__name__

1196

786

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

1197

787

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

1198

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1199

789

return func

1200

1201

790

return decorator

1202

791

1203

792

1204

793

def dbus_interface_annotations(dbus_interface):

1205

794

"""Decorator for marking functions returning interface annotations

1206

795

1207

796

Usage:

1208

797

1209

798

@dbus_interface_annotations("org.example.Interface")

1210

799

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

1211

800

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

1212

801

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

1213

802

"false"}

1214

803

"""

1215

1216

804

def decorator(func):

1217

805

func._dbus_is_interface = True

1218

806

func._dbus_interface = dbus_interface

1219

807

func._dbus_name = dbus_interface

1220

808

return func

1221

1222

809

return decorator

1223

810

1224

811

1225

812

def dbus_annotations(annotations):

1226

813

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

1227

814

Usage:

1228

1229

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

1230

"org.freedesktop.DBus.Property."

1231

"EmitsChangedSignal": "false"})

815

1232

816

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

1233

817

access="r")

818

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

819

"org.freedesktop.DBus.Property."

820

"EmitsChangedSignal": "false"})

1234

821

def Property_dbus_property(self):

1235

822

return dbus.Boolean(False)

1236

1237

See also the DBusObjectWithAnnotations class.

1238

823

"""

1239

1240

824

def decorator(func):

1241

825

func._dbus_annotations = annotations

1242

826

return func

1243

1244

827

return decorator

1245

828

1246

829

1249

832

"""

1250

833

pass

1251

834

1252

1253

835

class DBusPropertyAccessException(DBusPropertyException):

1254

836

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

1255

837

"""

1262

844

pass

1263

845

1264

846

1265

class DBusObjectWithAnnotations(dbus.service.Object):

1266

"""A D-Bus object with annotations.

1267

1268

Classes inheriting from this can use the dbus_annotations

1269

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.

1270

853

"""

1271

854

1272

855

@staticmethod

1273

856

def _is_dbus_thing(thing):

1274

857

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

1275

858

1276

859

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

1277

860

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

1278

861

"""

1279

862

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

1280

863

False)

1281

864

1282

865

def _get_all_dbus_things(self, thing):

1283

866

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

1284

867

"""

1285

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

868

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

869

name),

1286

870

athing.__get__(self))

1287

871

for cls in self.__class__.__mro__

1288

872

for name, athing in

1289

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

1290

1291

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1292

out_signature="s",

1293

path_keyword='object_path',

1294

connection_keyword='connection')

1295

def Introspect(self, object_path, connection):

1296

"""Overloading of standard D-Bus method.

1297

1298

Inserts annotation tags on methods and signals.

1299

"""

1300

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

1301

connection)

1302

try:

1303

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

1304

1305

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

1306

# Add annotation tags

1307

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

1308

for tag in if_tag.getElementsByTagName(typ):

1309

annots = dict()

1310

for name, prop in (self.

1311

_get_all_dbus_things(typ)):

1312

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

1313

and prop._dbus_interface

1314

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

1315

annots.update(getattr(

1316

prop, "_dbus_annotations", {}))

1317

for name, value in annots.items():

1318

ann_tag = document.createElement(

1319

"annotation")

1320

ann_tag.setAttribute("name", name)

1321

ann_tag.setAttribute("value", value)

1322

tag.appendChild(ann_tag)

1323

# Add interface annotation tags

1324

for annotation, value in dict(

1325

itertools.chain.from_iterable(

1326

annotations().items()

1327

for name, annotations

1328

in self._get_all_dbus_things("interface")

1329

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

1330

)).items():

1331

ann_tag = document.createElement("annotation")

1332

ann_tag.setAttribute("name", annotation)

1333

ann_tag.setAttribute("value", value)

1334

if_tag.appendChild(ann_tag)

1335

# Fix argument name for the Introspect method itself

1336

if (if_tag.getAttribute("name")

1337

== dbus.INTROSPECTABLE_IFACE):

1338

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

1339

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

1340

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

1341

if (arg.getAttribute("direction")

1342

== "out"):

1343

arg.setAttribute("name",

1344

"xml_data")

1345

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

1346

document.unlink()

1347

except (AttributeError, xml.dom.DOMException,

1348

xml.parsers.expat.ExpatError) as error:

1349

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

1350

exc_info=error)

1351

return xmlstring

1352

1353

1354

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1355

"""A D-Bus object with properties.

1356

1357

Classes inheriting from this can use the dbus_service_property

1358

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

1359

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

1360

"""

1361

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1362

876

def _get_dbus_property(self, interface_name, property_name):

1363

877

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

1364

878

property with the specified name and interface.

1365

879

"""

1366

for cls in self.__class__.__mro__:

1367

for name, value in inspect.getmembers(

1368

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

1369

884

if (value._dbus_name == property_name

1370

885

and value._dbus_interface == interface_name):

1371

886

return value.__get__(self)

1372

887

1373

888

# No such property

1374

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

1375

self.dbus_object_path, interface_name, property_name))

1376

1377

@classmethod

1378

def _get_all_interface_names(cls):

1379

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

1380

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

1381

"_dbus_interface", None)

1382

for x in (inspect.getmro(cls))

1383

for attr in dir(x))

1384

if name is not None)

1385

1386

@dbus.service.method(dbus.PROPERTIES_IFACE,

1387

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",

1388

894

out_signature="v")

1389

895

def Get(self, interface_name, property_name):

1390

896

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

1396

902

if not hasattr(value, "variant_level"):

1397

903

return value

1398

904

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

1399

905

1400

906

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

1401

907

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

1402

908

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

1411

917

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

1412

918

"'ay' signature {!r}"

1413

919

.format(prop._dbus_signature))

1414

value = dbus.ByteArray(bytes(value))

920

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

921

for byte in value))

1415

922

prop(value)

1416

1417

@dbus.service.method(dbus.PROPERTIES_IFACE,

1418

in_signature="s",

923

924

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

1419

925

out_signature="a{sv}")

1420

926

def GetAll(self, interface_name):

1421

927

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

1422

928

standard.

1423

929

1424

930

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

1425

931

"""

1426

932

properties = {}

1436

942

if not hasattr(value, "variant_level"):

1437

943

properties[name] = value

1438

944

continue

1439

properties[name] = type(value)(

1440

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1441

947

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

1442

1443

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

1444

def PropertiesChanged(self, interface_name, changed_properties,

1445

invalidated_properties):

1446

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

1447

standard.

1448

"""

1449

pass

1450

948

1451

949

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1452

950

out_signature="s",

1453

951

path_keyword='object_path',

1454

952

connection_keyword='connection')

1455

953

def Introspect(self, object_path, connection):

1456

954

"""Overloading of standard D-Bus method.

1457

955

1458

956

Inserts property tags and interface annotation tags.

1459

957

"""

1460

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1461

object_path,

1462

connection)

958

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

959

connection)

1463

960

try:

1464

961

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

1465

1466

962

def make_tag(document, name, prop):

1467

963

e = document.createElement("property")

1468

964

e.setAttribute("name", name)

1469

965

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

1470

966

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

1471

967

return e

1472

1473

968

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

1474

969

# Add property tags

1475

970

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

1478

973

if prop._dbus_interface

1479

974

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

1480

975

if_tag.appendChild(tag)

1481

# Add annotation tags for properties

1482

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

1483

annots = dict()

1484

for name, prop in self._get_all_dbus_things(

1485

"property"):

1486

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

1487

and prop._dbus_interface

1488

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

1489

annots.update(getattr(

1490

prop, "_dbus_annotations", {}))

1491

for name, value in annots.items():

1492

ann_tag = document.createElement(

1493

"annotation")

1494

ann_tag.setAttribute("name", name)

1495

ann_tag.setAttribute("value", value)

1496

tag.appendChild(ann_tag)

976

# Add annotation tags

977

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

978

for tag in if_tag.getElementsByTagName(typ):

979

annots = dict()

980

for name, prop in (self.

981

_get_all_dbus_things(typ)):

982

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

983

and prop._dbus_interface

984

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

985

annots.update(getattr

986

(prop,

987

"_dbus_annotations",

988

{}))

989

for name, value in annots.items():

990

ann_tag = document.createElement(

991

"annotation")

992

ann_tag.setAttribute("name", name)

993

ann_tag.setAttribute("value", value)

994

tag.appendChild(ann_tag)

995

# Add interface annotation tags

996

for annotation, value in dict(

997

itertools.chain.from_iterable(

998

annotations().items()

999

for name, annotations in

1000

self._get_all_dbus_things("interface")

1001

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

1002

)).items():

1003

ann_tag = document.createElement("annotation")

1004

ann_tag.setAttribute("name", annotation)

1005

ann_tag.setAttribute("value", value)

1006

if_tag.appendChild(ann_tag)

1497

1007

# Add the names to the return values for the

1498

1008

# "org.freedesktop.DBus.Properties" methods

1499

1009

if (if_tag.getAttribute("name")

1518

1028

return xmlstring

1519

1029

1520

1030

1521

try:

1522

dbus.OBJECT_MANAGER_IFACE

1523

except AttributeError:

1524

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

1525

1526

1527

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1528

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

1529

1530

Classes inheriting from this exposes the standard

1531

GetManagedObjects call and the InterfacesAdded and

1532

InterfacesRemoved signals on the standard

1533

"org.freedesktop.DBus.ObjectManager" interface.

1534

1535

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

1536

manually.

1537

"""

1538

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def GetManagedObjects(self):

1541

"""This function must be overridden"""

1542

raise NotImplementedError()

1543

1544

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1545

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

1546

def InterfacesAdded(self, object_path, interfaces_and_properties):

1547

pass

1548

1549

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

1550

def InterfacesRemoved(self, object_path, interfaces):

1551

pass

1552

1553

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1554

out_signature="s",

1555

path_keyword='object_path',

1556

connection_keyword='connection')

1557

def Introspect(self, object_path, connection):

1558

"""Overloading of standard D-Bus method.

1559

1560

Override return argument name of GetManagedObjects to be

1561

"objpath_interfaces_and_properties"

1562

"""

1563

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1564

object_path,

1565

connection)

1566

try:

1567

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

1568

1569

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

1570

# Fix argument name for the GetManagedObjects method

1571

if (if_tag.getAttribute("name")

1572

== dbus.OBJECT_MANAGER_IFACE):

1573

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

1574

if (cn.getAttribute("name")

1575

== "GetManagedObjects"):

1576

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

1577

if (arg.getAttribute("direction")

1578

== "out"):

1579

arg.setAttribute(

1580

"name",

1581

"objpath_interfaces"

1582

"_and_properties")

1583

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

1584

document.unlink()

1585

except (AttributeError, xml.dom.DOMException,

1586

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

1031

def datetime_to_dbus(dt, variant_level=0):

1593

1032

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

1594

1033

if dt is None:

1595

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

1596

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

1034

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

1035

return dbus.String(dt.isoformat(),

1036

variant_level=variant_level)

1597

1037

1598

1038

1599

1039

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1601

1041

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

1602

1042

interface names according to the "alt_interface_names" mapping.

1603

1043

Usage:

1604

1044

1605

1045

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

1606

1046

"net.example.AlternateInterface"})

1607

1047

class SampleDBusObject(dbus.service.Object):

1608

1048

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

1609

1049

def SampleDBusMethod():

1610

1050

pass

1611

1051

1612

1052

The above "SampleDBusMethod" on "SampleDBusObject" will be

1613

1053

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

1614

1054

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

1615

1055

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

1616

1056

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

1617

1057

1618

1058

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

1619

1059

(from DBusObjectWithProperties) and interfaces (from the

1620

1060

dbus_interface_annotations decorator).

1621

1061

"""

1622

1623

1062

def wrapper(cls):

1624

1063

for orig_interface_name, alt_interface_name in (

1625

alt_interface_names.items()):

1064

alt_interface_names.items()):

1626

1065

attr = {}

1627

1066

interface_names = set()

1628

1067

# Go though all attributes of the class

1630

1069

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

1631

1070

# with the wrong interface name

1632

1071

if (not hasattr(attribute, "_dbus_interface")

1633

or not attribute._dbus_interface.startswith(

1634

orig_interface_name)):

1072

or not attribute._dbus_interface

1073

.startswith(orig_interface_name)):

1635

1074

continue

1636

1075

# Create an alternate D-Bus interface name based on

1637

1076

# the current name

1638

alt_interface = attribute._dbus_interface.replace(

1639

orig_interface_name, alt_interface_name)

1077

alt_interface = (attribute._dbus_interface

1078

.replace(orig_interface_name,

1079

alt_interface_name))

1640

1080

interface_names.add(alt_interface)

1641

1081

# Is this a D-Bus signal?

1642

1082

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

1643

1083

# Extract the original non-method undecorated

1644

1084

# function by black magic

1645

if sys.version_info.major == 2:

1646

nonmethod_func = (dict(

1085

nonmethod_func = (dict(

1647

1086

zip(attribute.func_code.co_freevars,

1648

attribute.__closure__))

1649

["func"].cell_contents)

1650

else:

1651

nonmethod_func = (dict(

1652

zip(attribute.__code__.co_freevars,

1653

attribute.__closure__))

1654

["func"].cell_contents)

1087

attribute.__closure__))["func"]

1088

.cell_contents)

1655

1089

# Create a new, but exactly alike, function

1656

1090

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

1657

1091

# with the alternate D-Bus interface name

1658

new_function = copy_function(nonmethod_func)

1659

new_function = (dbus.service.signal(

1660

alt_interface,

1661

attribute._dbus_signature)(new_function))

1092

new_function = (dbus.service.signal

1093

(alt_interface,

1094

attribute._dbus_signature)

1095

(types.FunctionType(

1096

nonmethod_func.func_code,

1097

nonmethod_func.func_globals,

1098

nonmethod_func.func_name,

1099

nonmethod_func.func_defaults,

1100

nonmethod_func.func_closure)))

1662

1101

# Copy annotations, if any

1663

1102

try:

1664

new_function._dbus_annotations = dict(

1665

attribute._dbus_annotations)

1103

new_function._dbus_annotations = (

1104

dict(attribute._dbus_annotations))

1666

1105

except AttributeError:

1667

1106

pass

1668

1669

1107

# Define a creator of a function to call both the

1670

1108

# original and alternate functions, so both the

1671

1109

# original and alternate signals gets sent when

1674

1112

"""This function is a scope container to pass

1675

1113

func1 and func2 to the "call_both" function

1676

1114

outside of its arguments"""

1677

1678

@functools.wraps(func2)

1679

1115

def call_both(*args, **kwargs):

1680

1116

"""This function will emit two D-Bus

1681

1117

signals by calling func1 and func2"""

1682

1118

func1(*args, **kwargs)

1683

1119

func2(*args, **kwargs)

1684

# Make wrapper function look like a D-Bus

1685

# signal

1686

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

1687

if name.startswith("_dbus_"):

1688

setattr(call_both, name, attr)

1689

1690

1120

return call_both

1691

1121

# Create the "call_both" function and add it to

1692

1122

# the class

1697

1127

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

1698

1128

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

1699

1129

# to the class.

1700

attr[attrname] = (

1701

dbus.service.method(

1702

alt_interface,

1703

attribute._dbus_in_signature,

1704

attribute._dbus_out_signature)

1705

(copy_function(attribute)))

1130

attr[attrname] = (dbus.service.method

1131

(alt_interface,

1132

attribute._dbus_in_signature,

1133

attribute._dbus_out_signature)

1134

(types.FunctionType

1135

(attribute.func_code,

1136

attribute.func_globals,

1137

attribute.func_name,

1138

attribute.func_defaults,

1139

attribute.func_closure)))

1706

1140

# Copy annotations, if any

1707

1141

try:

1708

attr[attrname]._dbus_annotations = dict(

1709

attribute._dbus_annotations)

1142

attr[attrname]._dbus_annotations = (

1143

dict(attribute._dbus_annotations))

1710

1144

except AttributeError:

1711

1145

pass

1712

1146

# Is this a D-Bus property?

1715

1149

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

1716

1150

# property with the alternate D-Bus interface

1717

1151

# name. Add it to the class.

1718

attr[attrname] = (dbus_service_property(

1719

alt_interface, attribute._dbus_signature,

1720

attribute._dbus_access,

1721

attribute._dbus_get_args_options

1722

["byte_arrays"])

1723

(copy_function(attribute)))

1152

attr[attrname] = (dbus_service_property

1153

(alt_interface,

1154

attribute._dbus_signature,

1155

attribute._dbus_access,

1156

attribute

1157

._dbus_get_args_options

1158

["byte_arrays"])

1159

(types.FunctionType

1160

(attribute.func_code,

1161

attribute.func_globals,

1162

attribute.func_name,

1163

attribute.func_defaults,

1164

attribute.func_closure)))

1724

1165

# Copy annotations, if any

1725

1166

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1167

attr[attrname]._dbus_annotations = (

1168

dict(attribute._dbus_annotations))

1728

1169

except AttributeError:

1729

1170

pass

1730

1171

# Is this a D-Bus interface?

1733

1174

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

1734

1175

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

1735

1176

# to the class.

1736

attr[attrname] = (

1737

dbus_interface_annotations(alt_interface)

1738

(copy_function(attribute)))

1177

attr[attrname] = (dbus_interface_annotations

1178

(alt_interface)

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

attribute.func_closure)))

1739

1185

if deprecate:

1740

1186

# Deprecate all alternate interfaces

1741

iname = "_AlternateDBusNames_interface_annotation{}"

1187

iname="_AlternateDBusNames_interface_annotation{}"

1742

1188

for interface_name in interface_names:

1743

1744

1189

@dbus_interface_annotations(interface_name)

1745

1190

def func(self):

1746

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

1747

"true"}

1191

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

1192

"true" }

1748

1193

# Find an unused name

1749

1194

for aname in (iname.format(i)

1750

1195

for i in itertools.count()):

1754

1199

if interface_names:

1755

1200

# Replace the class with a new subclass of it with

1756

1201

# methods, signals, etc. as created above.

1757

if sys.version_info.major == 2:

1758

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

1759

(cls, ), attr)

1760

else:

1761

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

1762

(cls, ), attr)

1202

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

1203

(cls,), attr)

1763

1204

return cls

1764

1765

1205

return wrapper

1766

1206

1767

1207

1768

1208

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

1769

"se.bsnet.fukt.Mandos"})

1209

"se.bsnet.fukt.Mandos"})

1770

1210

class ClientDBus(Client, DBusObjectWithProperties):

1771

1211

"""A Client class using D-Bus

1772

1212

1773

1213

Attributes:

1774

1214

dbus_object_path: dbus.ObjectPath

1775

1215

bus: dbus.SystemBus()

1776

1216

"""

1777

1217

1778

1218

runtime_expansions = (Client.runtime_expansions

1779

+ ("dbus_object_path", ))

1780

1781

_interface = "se.recompile.Mandos.Client"

1782

1219

+ ("dbus_object_path",))

1220

1783

1221

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

1784

1785

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

1222

1223

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

1786

1224

self.bus = bus

1787

1225

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

1788

1226

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

1790

1228

client_object_name = str(self.name).translate(

1791

1229

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

1792

1230

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

1793

self.dbus_object_path = dbus.ObjectPath(

1794

"/clients/" + client_object_name)

1231

self.dbus_object_path = (dbus.ObjectPath

1232

("/clients/" + client_object_name))

1795

1233

DBusObjectWithProperties.__init__(self, self.bus,

1796

1234

self.dbus_object_path)

1797

1798

def notifychangeproperty(transform_func, dbus_name,

1799

type_func=lambda x: x,

1800

variant_level=1,

1801

invalidate_only=False,

1802

_interface=_interface):

1235

1236

def notifychangeproperty(transform_func,

1237

dbus_name, type_func=lambda x: x,

1238

variant_level=1):

1803

1239

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

1804

1240

its changes to DBus.

1805

1241

1806

1242

transform_fun: Function that takes a value and a variant_level

1807

1243

and transforms it to a D-Bus type.

1808

1244

dbus_name: D-Bus name of the variable

1811

1247

variant_level: D-Bus variant level. Default: 1

1812

1248

"""

1813

1249

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

1814

1815

1250

def setter(self, value):

1816

1251

if hasattr(self, "dbus_object_path"):

1817

1252

if (not hasattr(self, attrname) or

1818

1253

type_func(getattr(self, attrname, None))

1819

1254

!= type_func(value)):

1820

if invalidate_only:

1821

self.PropertiesChanged(

1822

_interface, dbus.Dictionary(),

1823

dbus.Array((dbus_name, )))

1824

else:

1825

dbus_value = transform_func(

1826

type_func(value),

1827

variant_level=variant_level)

1828

self.PropertyChanged(dbus.String(dbus_name),

1829

dbus_value)

1830

self.PropertiesChanged(

1831

_interface,

1832

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

1833

dbus_value}),

1834

dbus.Array())

1255

dbus_value = transform_func(type_func(value),

1256

variant_level

1257

=variant_level)

1258

self.PropertyChanged(dbus.String(dbus_name),

1259

dbus_value)

1835

1260

setattr(self, attrname, value)

1836

1261

1837

1262

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

1838

1263

1839

1264

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1840

1265

approvals_pending = notifychangeproperty(dbus.Boolean,

1841

1266

"ApprovalPending",

1842

type_func=bool)

1267

type_func = bool)

1843

1268

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

1844

1269

last_enabled = notifychangeproperty(datetime_to_dbus,

1845

1270

"LastEnabled")

1846

checker = notifychangeproperty(

1847

dbus.Boolean, "CheckerRunning",

1848

type_func=lambda checker: checker is not None)

1271

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

1272

type_func = lambda checker:

1273

checker is not None)

1849

1274

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1850

1275

"LastCheckedOK")

1851

1276

last_checker_status = notifychangeproperty(dbus.Int16,

1854

1279

datetime_to_dbus, "LastApprovalRequest")

1855

1280

approved_by_default = notifychangeproperty(dbus.Boolean,

1856

1281

"ApprovedByDefault")

1857

approval_delay = notifychangeproperty(

1858

dbus.UInt64, "ApprovalDelay",

1859

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

1282

approval_delay = notifychangeproperty(dbus.UInt64,

1283

"ApprovalDelay",

1284

type_func =

1285

lambda td: td.total_seconds()

1286

* 1000)

1860

1287

approval_duration = notifychangeproperty(

1861

1288

dbus.UInt64, "ApprovalDuration",

1862

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

1289

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

1863

1290

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

1864

timeout = notifychangeproperty(

1865

dbus.UInt64, "Timeout",

1866

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

1291

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

1292

type_func = lambda td:

1293

td.total_seconds() * 1000)

1867

1294

extended_timeout = notifychangeproperty(

1868

1295

dbus.UInt64, "ExtendedTimeout",

1869

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

1870

interval = notifychangeproperty(

1871

dbus.UInt64, "Interval",

1872

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

1296

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

1297

interval = notifychangeproperty(dbus.UInt64,

1298

"Interval",

1299

type_func =

1300

lambda td: td.total_seconds()

1301

* 1000)

1873

1302

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

1874

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

1875

invalidate_only=True)

1876

1303

1877

1304

del notifychangeproperty

1878

1305

1879

1306

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

1880

1307

try:

1881

1308

self.remove_from_connection()

1884

1311

if hasattr(DBusObjectWithProperties, "__del__"):

1885

1312

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

1886

1313

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

1887

1888

def checker_callback(self, source, condition,

1889

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

1890

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

1891

connection, command, *args,

1892

**kwargs)

1893

exitstatus = self.last_checker_status

1894

if exitstatus >= 0:

1314

1315

def checker_callback(self, pid, condition, command,

1316

*args, **kwargs):

1317

self.checker_callback_tag = None

1318

self.checker = None

1319

if os.WIFEXITED(condition):

1320

exitstatus = os.WEXITSTATUS(condition)

1895

1321

# Emit D-Bus signal

1896

1322

self.CheckerCompleted(dbus.Int16(exitstatus),

1897

# This is specific to GNU libC

1898

dbus.Int64(exitstatus << 8),

1323

dbus.Int64(condition),

1899

1324

dbus.String(command))

1900

1325

else:

1901

1326

# Emit D-Bus signal

1902

1327

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

1903

dbus.Int64(

1904

# This is specific to GNU libC

1905

(exitstatus << 8)

1906

| self.last_checker_signal),

1328

dbus.Int64(condition),

1907

1329

dbus.String(command))

1908

return ret

1909

1330

1331

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

1332

*args, **kwargs)

1333

1910

1334

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

1911

1335

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

1912

1336

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

1916

1340

# Emit D-Bus signal

1917

1341

self.CheckerStarted(self.current_checker_command)

1918

1342

return r

1919

1343

1920

1344

def _reset_approved(self):

1921

1345

self.approved = None

1922

1346

return False

1923

1347

1924

1348

def approve(self, value=True):

1925

1349

self.approved = value

1926

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

1927

* 1000), self._reset_approved)

1350

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

1351

* 1000), self._reset_approved)

1928

1352

self.send_changedstate()

1929

1930

# D-Bus methods, signals & properties

1931

1932

# Interfaces

1933

1934

# Signals

1935

1353

1354

## D-Bus methods, signals & properties

1355

_interface = "se.recompile.Mandos.Client"

1356

1357

## Interfaces

1358

1359

@dbus_interface_annotations(_interface)

1360

def _foo(self):

1361

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

1362

"false"}

1363

1364

## Signals

1365

1936

1366

# CheckerCompleted - signal

1937

1367

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

1938

1368

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

1939

1369

"D-Bus signal"

1940

1370

pass

1941

1371

1942

1372

# CheckerStarted - signal

1943

1373

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

1944

1374

def CheckerStarted(self, command):

1945

1375

"D-Bus signal"

1946

1376

pass

1947

1377

1948

1378

# PropertyChanged - signal

1949

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

1950

1379

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

1951

1380

def PropertyChanged(self, property, value):

1952

1381

"D-Bus signal"

1953

1382

pass

1954

1383

1955

1384

# GotSecret - signal

1956

1385

@dbus.service.signal(_interface)

1957

1386

def GotSecret(self):

1960

1389

server to mandos-client

1961

1390

"""

1962

1391

pass

1963

1392

1964

1393

# Rejected - signal

1965

1394

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

1966

1395

def Rejected(self, reason):

1967

1396

"D-Bus signal"

1968

1397

pass

1969

1398

1970

1399

# NeedApproval - signal

1971

1400

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

1972

1401

def NeedApproval(self, timeout, default):

1973

1402

"D-Bus signal"

1974

1403

return self.need_approval()

1975

1976

# Methods

1977

1404

1405

## Methods

1406

1978

1407

# Approve - method

1979

1408

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

1980

1409

def Approve(self, value):

1981

1410

self.approve(value)

1982

1411

1983

1412

# CheckedOK - method

1984

1413

@dbus.service.method(_interface)

1985

1414

def CheckedOK(self):

1986

1415

self.checked_ok()

1987

1416

1988

1417

# Enable - method

1989

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

1990

1418

@dbus.service.method(_interface)

1991

1419

def Enable(self):

1992

1420

"D-Bus method"

1993

1421

self.enable()

1994

1422

1995

1423

# StartChecker - method

1996

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

1997

1424

@dbus.service.method(_interface)

1998

1425

def StartChecker(self):

1999

1426

"D-Bus method"

2000

1427

self.start_checker()

2001

1428

2002

1429

# Disable - method

2003

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

2004

1430

@dbus.service.method(_interface)

2005

1431

def Disable(self):

2006

1432

"D-Bus method"

2007

1433

self.disable()

2008

1434

2009

1435

# StopChecker - method

2010

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

2011

1436

@dbus.service.method(_interface)

2012

1437

def StopChecker(self):

2013

1438

self.stop_checker()

2014

2015

# Properties

2016

1439

1440

## Properties

1441

2017

1442

# ApprovalPending - property

2018

1443

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

2019

1444

def ApprovalPending_dbus_property(self):

2020

1445

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

2021

1446

2022

1447

# ApprovedByDefault - property

2023

@dbus_service_property(_interface,

2024

signature="b",

1448

@dbus_service_property(_interface, signature="b",

2025

1449

access="readwrite")

2026

1450

def ApprovedByDefault_dbus_property(self, value=None):

2027

1451

if value is None: # get

2028

1452

return dbus.Boolean(self.approved_by_default)

2029

1453

self.approved_by_default = bool(value)

2030

1454

2031

1455

# ApprovalDelay - property

2032

@dbus_service_property(_interface,

2033

signature="t",

1456

@dbus_service_property(_interface, signature="t",

2034

1457

access="readwrite")

2035

1458

def ApprovalDelay_dbus_property(self, value=None):

2036

1459

if value is None: # get

2037

1460

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

2038

1461

* 1000)

2039

1462

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

2040

1463

2041

1464

# ApprovalDuration - property

2042

@dbus_service_property(_interface,

2043

signature="t",

1465

@dbus_service_property(_interface, signature="t",

2044

1466

access="readwrite")

2045

1467

def ApprovalDuration_dbus_property(self, value=None):

2046

1468

if value is None: # get

2047

1469

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

2048

1470

* 1000)

2049

1471

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

2050

1472

2051

1473

# Name - property

2052

@dbus_annotations(

2053

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

2054

1474

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

2055

1475

def Name_dbus_property(self):

2056

1476

return dbus.String(self.name)

2057

2058

# KeyID - property

2059

@dbus_annotations(

2060

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

2061

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

2062

def KeyID_dbus_property(self):

2063

return dbus.String(self.key_id)

2064

1477

2065

1478

# Fingerprint - property

2066

@dbus_annotations(

2067

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

2068

1479

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

2069

1480

def Fingerprint_dbus_property(self):

2070

1481

return dbus.String(self.fingerprint)

2071

1482

2072

1483

# Host - property

2073

@dbus_service_property(_interface,

2074

signature="s",

1484

@dbus_service_property(_interface, signature="s",

2075

1485

access="readwrite")

2076

1486

def Host_dbus_property(self, value=None):

2077

1487

if value is None: # get

2078

1488

return dbus.String(self.host)

2079

1489

self.host = str(value)

2080

1490

2081

1491

# Created - property

2082

@dbus_annotations(

2083

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

2084

1492

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

2085

1493

def Created_dbus_property(self):

2086

1494

return datetime_to_dbus(self.created)

2087

1495

2088

1496

# LastEnabled - property

2089

1497

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

2090

1498

def LastEnabled_dbus_property(self):

2091

1499

return datetime_to_dbus(self.last_enabled)

2092

1500

2093

1501

# Enabled - property

2094

@dbus_service_property(_interface,

2095

signature="b",

1502

@dbus_service_property(_interface, signature="b",

2096

1503

access="readwrite")

2097

1504

def Enabled_dbus_property(self, value=None):

2098

1505

if value is None: # get

2101

1508

self.enable()

2102

1509

else:

2103

1510

self.disable()

2104

1511

2105

1512

# LastCheckedOK - property

2106

@dbus_service_property(_interface,

2107

signature="s",

1513

@dbus_service_property(_interface, signature="s",

2108

1514

access="readwrite")

2109

1515

def LastCheckedOK_dbus_property(self, value=None):

2110

1516

if value is not None:

2111

1517

self.checked_ok()

2112

1518

return

2113

1519

return datetime_to_dbus(self.last_checked_ok)

2114

1520

2115

1521

# LastCheckerStatus - property

2116

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

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2117

1524

def LastCheckerStatus_dbus_property(self):

2118

1525

return dbus.Int16(self.last_checker_status)

2119

1526

2120

1527

# Expires - property

2121

1528

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

2122

1529

def Expires_dbus_property(self):

2123

1530

return datetime_to_dbus(self.expires)

2124

1531

2125

1532

# LastApprovalRequest - property

2126

1533

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

2127

1534

def LastApprovalRequest_dbus_property(self):

2128

1535

return datetime_to_dbus(self.last_approval_request)

2129

1536

2130

1537

# Timeout - property

2131

@dbus_service_property(_interface,

2132

signature="t",

1538

@dbus_service_property(_interface, signature="t",

2133

1539

access="readwrite")

2134

1540

def Timeout_dbus_property(self, value=None):

2135

1541

if value is None: # get

2147

1553

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

2148

1554

is None):

2149

1555

return

2150

GLib.source_remove(self.disable_initiator_tag)

2151

self.disable_initiator_tag = GLib.timeout_add(

2152

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

2153

self.disable)

2154

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

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

1560

* 1000), self.disable))

1561

2155

1562

# ExtendedTimeout - property

2156

@dbus_service_property(_interface,

2157

signature="t",

1563

@dbus_service_property(_interface, signature="t",

2158

1564

access="readwrite")

2159

1565

def ExtendedTimeout_dbus_property(self, value=None):

2160

1566

if value is None: # get

2161

1567

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

2162

1568

* 1000)

2163

1569

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

2164

1570

2165

1571

# Interval - property

2166

@dbus_service_property(_interface,

2167

signature="t",

1572

@dbus_service_property(_interface, signature="t",

2168

1573

access="readwrite")

2169

1574

def Interval_dbus_property(self, value=None):

2170

1575

if value is None: # get

2174

1579

return

2175

1580

if self.enabled:

2176

1581

# Reschedule checker run

2177

GLib.source_remove(self.checker_initiator_tag)

2178

self.checker_initiator_tag = GLib.timeout_add(

2179

value, self.start_checker)

2180

self.start_checker() # Start one now, too

2181

1582

gobject.source_remove(self.checker_initiator_tag)

1583

self.checker_initiator_tag = (gobject.timeout_add

1584

(value, self.start_checker))

1585

self.start_checker() # Start one now, too

1586

2182

1587

# Checker - property

2183

@dbus_service_property(_interface,

2184

signature="s",

1588

@dbus_service_property(_interface, signature="s",

2185

1589

access="readwrite")

2186

1590

def Checker_dbus_property(self, value=None):

2187

1591

if value is None: # get

2188

1592

return dbus.String(self.checker_command)

2189

1593

self.checker_command = str(value)

2190

1594

2191

1595

# CheckerRunning - property

2192

@dbus_service_property(_interface,

2193

signature="b",

1596

@dbus_service_property(_interface, signature="b",

2194

1597

access="readwrite")

2195

1598

def CheckerRunning_dbus_property(self, value=None):

2196

1599

if value is None: # get

2199

1602

self.start_checker()

2200

1603

else:

2201

1604

self.stop_checker()

2202

1605

2203

1606

# ObjectPath - property

2204

@dbus_annotations(

2205

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

2206

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

2207

1607

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

2208

1608

def ObjectPath_dbus_property(self):

2209

return self.dbus_object_path # is already a dbus.ObjectPath

2210

1609

return self.dbus_object_path # is already a dbus.ObjectPath

1610

2211

1611

# Secret = property

2212

@dbus_annotations(

2213

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

2214

"invalidates"})

2215

@dbus_service_property(_interface,

2216

signature="ay",

2217

access="write",

2218

byte_arrays=True)

1612

@dbus_service_property(_interface, signature="ay",

1613

access="write", byte_arrays=True)

2219

1614

def Secret_dbus_property(self, value):

2220

1615

self.secret = bytes(value)

2221

1616

2222

1617

del _interface

2223

1618

2224

1619

2225

class ProxyClient:

2226

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

1620

class ProxyClient(object):

1621

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

2227

1622

self._pipe = child_pipe

2228

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

1623

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

2229

1624

if not self._pipe.recv():

2230

raise KeyError(key_id or fpr)

2231

1625

raise KeyError()

1626

2232

1627

def __getattribute__(self, name):

2233

1628

if name == '_pipe':

2234

1629

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

2237

1632

if data[0] == 'data':

2238

1633

return data[1]

2239

1634

if data[0] == 'function':

2240

2241

1635

def func(*args, **kwargs):

2242

1636

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

2243

1637

return self._pipe.recv()[1]

2244

2245

1638

return func

2246

1639

2247

1640

def __setattr__(self, name, value):

2248

1641

if name == '_pipe':

2249

1642

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

2252

1645

2253

1646

class ClientHandler(socketserver.BaseRequestHandler, object):

2254

1647

"""A class to handle client connections.

2255

1648

2256

1649

Instantiated once for each connection to handle it.

2257

1650

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

2258

1651

2259

1652

def handle(self):

2260

1653

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

2261

1654

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

2262

1655

str(self.client_address))

2263

1656

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

2264

1657

self.server.child_pipe.fileno())

2265

2266

session = gnutls.ClientSession(self.request)

2267

2268

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

2269

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

2270

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

2271

# "+DHE-DSS"))

1658

1659

session = (gnutls.connection

1660

.ClientSession(self.request,

1661

gnutls.connection

1662

.X509Credentials()))

1663

1664

# Note: gnutls.connection.X509Credentials is really a

1665

# generic GnuTLS certificate credentials object so long as

1666

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

1667

# here despite using OpenPGP certificates.

1668

1669

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

1670

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

1671

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

1672

# "+DHE-DSS"))

2272

1673

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

2273

1674

priority = self.server.gnutls_priority

2274

1675

if priority is None:

2275

1676

priority = "NORMAL"

2276

gnutls.priority_set_direct(session._c_object,

2277

priority.encode("utf-8"),

2278

None)

2279

1677

(gnutls.library.functions

1678

.gnutls_priority_set_direct(session._c_object,

1679

priority, None))

1680

2280

1681

# Start communication using the Mandos protocol

2281

1682

# Get protocol number

2282

1683

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

2287

1688

except (ValueError, IndexError, RuntimeError) as error:

2288

1689

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

2289

1690

return

2290

1691

2291

1692

# Start GnuTLS connection

2292

1693

try:

2293

1694

session.handshake()

2294

except gnutls.Error as error:

1695

except gnutls.errors.GNUTLSError as error:

2295

1696

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

2296

1697

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

2297

1698

# established. Just abandon the request.

2298

1699

return

2299

1700

logger.debug("Handshake succeeded")

2300

1701

2301

1702

approval_required = False

2302

1703

try:

2303

if gnutls.has_rawpk:

2304

fpr = b""

2305

try:

2306

key_id = self.key_id(

2307

self.peer_certificate(session))

2308

except (TypeError, gnutls.Error) as error:

2309

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

2310

return

2311

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

2312

2313

else:

2314

key_id = b""

2315

try:

2316

fpr = self.fingerprint(

2317

self.peer_certificate(session))

2318

except (TypeError, gnutls.Error) as error:

2319

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

2320

return

2321

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

2322

2323

try:

2324

client = ProxyClient(child_pipe, key_id, fpr,

1704

try:

1705

fpr = self.fingerprint(self.peer_certificate

1706

(session))

1707

except (TypeError,

1708

gnutls.errors.GNUTLSError) as error:

1709

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

1710

return

1711

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

1712

1713

try:

1714

client = ProxyClient(child_pipe, fpr,

2325

1715

self.client_address)

2326

1716

except KeyError:

2327

1717

return

2328

1718

2329

1719

if client.approval_delay:

2330

1720

delay = client.approval_delay

2331

1721

client.approvals_pending += 1

2332

1722

approval_required = True

2333

1723

2334

1724

while True:

2335

1725

if not client.enabled:

2336

1726

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

2337

client.name)

1727

client.name)

2338

1728

if self.server.use_dbus:

2339

1729

# Emit D-Bus signal

2340

1730

client.Rejected("Disabled")

2341

1731

return

2342

1732

2343

1733

if client.approved or not client.approval_delay:

2344

# We are approved or approval is disabled

1734

#We are approved or approval is disabled

2345

1735

break

2346

1736

elif client.approved is None:

2347

1737

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

2358

1748

# Emit D-Bus signal

2359

1749

client.Rejected("Denied")

2360

1750

return

2361

2362

# wait until timeout or approved

1751

1752

#wait until timeout or approved

2363

1753

time = datetime.datetime.now()

2364

1754

client.changedstate.acquire()

2365

1755

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

2378

1768

break

2379

1769

else:

2380

1770

delay -= time2 - time

2381

2382

try:

2383

session.send(client.secret)

2384

except gnutls.Error as error:

2385

logger.warning("gnutls send failed",

2386

exc_info=error)

2387

return

2388

1771

1772

sent_size = 0

1773

while sent_size < len(client.secret):

1774

try:

1775

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

1776

except gnutls.errors.GNUTLSError as error:

1777

logger.warning("gnutls send failed",

1778

exc_info=error)

1779

return

1780

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

1781

sent, len(client.secret)

1782

- (sent_size + sent))

1783

sent_size += sent

1784

2389

1785

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

2390

1786

# bump the timeout using extended_timeout

2391

1787

client.bump_timeout(client.extended_timeout)

2392

1788

if self.server.use_dbus:

2393

1789

# Emit D-Bus signal

2394

1790

client.GotSecret()

2395

1791

2396

1792

finally:

2397

1793

if approval_required:

2398

1794

client.approvals_pending -= 1

2399

1795

try:

2400

1796

session.bye()

2401

except gnutls.Error as error:

1797

except gnutls.errors.GNUTLSError as error:

2402

1798

logger.warning("GnuTLS bye failed",

2403

1799

exc_info=error)

2404

1800

2405

1801

@staticmethod

2406

1802

def peer_certificate(session):

2407

"Return the peer's certificate as a bytestring"

2408

try:

2409

cert_type = gnutls.certificate_type_get2(session._c_object,

2410

gnutls.CTYPE_PEERS)

2411

except AttributeError:

2412

cert_type = gnutls.certificate_type_get(session._c_object)

2413

if gnutls.has_rawpk:

2414

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2415

else:

2416

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2417

# If not a valid certificate type...

2418

if cert_type not in valid_cert_types:

2419

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

2420

valid_cert_types)

2421

# ...return invalid data

2422

return b""

1803

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

1804

# If not an OpenPGP certificate...

1805

if (gnutls.library.functions

1806

.gnutls_certificate_type_get(session._c_object)

1807

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1808

# ...do the normal thing

1809

return session.peer_certificate

2423

1810

list_size = ctypes.c_uint(1)

2424

cert_list = (gnutls.certificate_get_peers

1811

cert_list = (gnutls.library.functions

1812

.gnutls_certificate_get_peers

2425

1813

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

2426

1814

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

2427

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

1815

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

1816

" certificate")

2428

1817

if list_size.value == 0:

2429

1818

return None

2430

1819

cert = cert_list[0]

2431

1820

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

2432

2433

@staticmethod

2434

def key_id(certificate):

2435

"Convert a certificate bytestring to a hexdigit key ID"

2436

# New GnuTLS "datum" with the public key

2437

datum = gnutls.datum_t(

2438

ctypes.cast(ctypes.c_char_p(certificate),

2439

ctypes.POINTER(ctypes.c_ubyte)),

2440

ctypes.c_uint(len(certificate)))

2441

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

2442

# New empty GnuTLS certificate

2443

pubkey = gnutls.pubkey_t()

2444

gnutls.pubkey_init(ctypes.byref(pubkey))

2445

# Import the raw public key into the certificate

2446

gnutls.pubkey_import(pubkey,

2447

ctypes.byref(datum),

2448

gnutls.X509_FMT_DER)

2449

# New buffer for the key ID

2450

buf = ctypes.create_string_buffer(32)

2451

buf_len = ctypes.c_size_t(len(buf))

2452

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

2453

gnutls.pubkey_get_key_id(pubkey,

2454

gnutls.KEYID_USE_SHA256,

2455

ctypes.cast(ctypes.byref(buf),

2456

ctypes.POINTER(ctypes.c_ubyte)),

2457

ctypes.byref(buf_len))

2458

# Deinit the certificate

2459

gnutls.pubkey_deinit(pubkey)

2460

2461

# Convert the buffer to a Python bytestring

2462

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

2463

# Convert the bytestring to hexadecimal notation

2464

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

2465

return hex_key_id

2466

1821

2467

1822

@staticmethod

2468

1823

def fingerprint(openpgp):

2469

1824

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2470

1825

# New GnuTLS "datum" with the OpenPGP public key

2471

datum = gnutls.datum_t(

2472

ctypes.cast(ctypes.c_char_p(openpgp),

2473

ctypes.POINTER(ctypes.c_ubyte)),

2474

ctypes.c_uint(len(openpgp)))

1826

datum = (gnutls.library.types

1827

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

1828

ctypes.POINTER

1829

(ctypes.c_ubyte)),

1830

ctypes.c_uint(len(openpgp))))

2475

1831

# New empty GnuTLS certificate

2476

crt = gnutls.openpgp_crt_t()

2477

gnutls.openpgp_crt_init(ctypes.byref(crt))

1832

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

1835

# Import the OpenPGP public key into the certificate

2479

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

2480

gnutls.OPENPGP_FMT_RAW)

1836

(gnutls.library.functions

1837

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

1838

gnutls.library.constants

1839

.GNUTLS_OPENPGP_FMT_RAW))

2481

1840

# Verify the self signature in the key

2482

1841

crtverify = ctypes.c_uint()

2483

gnutls.openpgp_crt_verify_self(crt, 0,

2484

ctypes.byref(crtverify))

1842

(gnutls.library.functions

1843

.gnutls_openpgp_crt_verify_self(crt, 0,

1844

ctypes.byref(crtverify)))

2485

1845

if crtverify.value != 0:

2486

gnutls.openpgp_crt_deinit(crt)

2487

raise gnutls.CertificateSecurityError(code

2488

=crtverify.value)

1846

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1847

raise (gnutls.errors.CertificateSecurityError

1848

("Verify failed"))

2489

1849

# New buffer for the fingerprint

2490

1850

buf = ctypes.create_string_buffer(20)

2491

1851

buf_len = ctypes.c_size_t()

2492

1852

# Get the fingerprint from the certificate into the buffer

2493

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

2494

ctypes.byref(buf_len))

1853

(gnutls.library.functions

1854

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

1855

ctypes.byref(buf_len)))

2495

1856

# Deinit the certificate

2496

gnutls.openpgp_crt_deinit(crt)

1857

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2497

1858

# Convert the buffer to a Python bytestring

2498

1859

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

2499

1860

# Convert the bytestring to hexadecimal notation

2501

1862

return hex_fpr

2502

1863

2503

1864

2504

class MultiprocessingMixIn:

1865

class MultiprocessingMixIn(object):

2505

1866

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

2506

2507

1867

def sub_process_main(self, request, address):

2508

1868

try:

2509

1869

self.finish_request(request, address)

2510

1870

except Exception:

2511

1871

self.handle_error(request, address)

2512

1872

self.close_request(request)

2513

1873

2514

1874

def process_request(self, request, address):

2515

1875

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

2516

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

2517

args=(request, address))

1876

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

1877

args = (request, address))

2518

1878

proc.start()

2519

1879

return proc

2520

1880

2521

1881

2522

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1882

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2523

1883

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

2524

2525

1884

def process_request(self, request, client_address):

2526

1885

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

2527

1886

2528

1887

This function creates a new pipe in self.pipe

2529

1888

"""

2530

1889

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2531

1890

2532

1891

proc = MultiprocessingMixIn.process_request(self, request,

2533

1892

client_address)

2534

1893

self.child_pipe.close()

2535

1894

self.add_pipe(parent_pipe, proc)

2536

1895

2537

1896

def add_pipe(self, parent_pipe, proc):

2538

1897

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

2539

1898

raise NotImplementedError()

2540

1899

2541

1900

2542

1901

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2543

socketserver.TCPServer):

1902

socketserver.TCPServer, object):

2544

1903

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

2545

1904

2546

1905

Attributes:

2547

1906

enabled: Boolean; whether this server is activated yet

2548

1907

interface: None or a network interface name (string)

2549

1908

use_ipv6: Boolean; to use IPv6 or not

2550

1909

"""

2551

2552

1910

def __init__(self, server_address, RequestHandlerClass,

2553

interface=None,

2554

use_ipv6=True,

2555

socketfd=None):

1911

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

2556

1912

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

2557

1913

creating a new one with socket.socket().

2558

1914

"""

2564

1920

self.socketfd = socketfd

2565

1921

# Save the original socket.socket() function

2566

1922

self.socket_socket = socket.socket

2567

2568

1923

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

2569

#

1924

#

2570

1925

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

2571

1926

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

2572

1927

# patching socket.socket.)

2573

#

1928

#

2574

1929

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

2575

1930

@functools.wraps(socket.socket)

2576

1931

def socket_wrapper(*args, **kwargs):

2588

1943

# socket_wrapper(), if socketfd was set.

2589

1944

socketserver.TCPServer.__init__(self, server_address,

2590

1945

RequestHandlerClass)

2591

1946

2592

1947

def server_bind(self):

2593

1948

"""This overrides the normal server_bind() function

2594

1949

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

2595

1950

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

2596

global SO_BINDTODEVICE

2597

1951

if self.interface is not None:

2598

1952

if SO_BINDTODEVICE is None:

2599

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

2600

# common enough.

2601

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

2602

SO_BINDTODEVICE = 25

2603

try:

2604

self.socket.setsockopt(

2605

socket.SOL_SOCKET, SO_BINDTODEVICE,

2606

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

2607

except socket.error as error:

2608

if error.errno == errno.EPERM:

2609

logger.error("No permission to bind to"

2610

" interface %s", self.interface)

2611

elif error.errno == errno.ENOPROTOOPT:

2612

logger.error("SO_BINDTODEVICE not available;"

2613

" cannot bind to interface %s",

2614

self.interface)

2615

elif error.errno == errno.ENODEV:

2616

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

2617

" cannot bind", self.interface)

2618

else:

2619

raise

1953

logger.error("SO_BINDTODEVICE does not exist;"

1954

" cannot bind to interface %s",

1955

self.interface)

1956

else:

1957

try:

1958

self.socket.setsockopt(socket.SOL_SOCKET,

1959

SO_BINDTODEVICE,

1960

(self.interface + "\0")

1961

.encode("utf-8"))

1962

except socket.error as error:

1963

if error.errno == errno.EPERM:

1964

logger.error("No permission to bind to"

1965

" interface %s", self.interface)

1966

elif error.errno == errno.ENOPROTOOPT:

1967

logger.error("SO_BINDTODEVICE not available;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

elif error.errno == errno.ENODEV:

1971

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

1972

" cannot bind", self.interface)

1973

else:

1974

raise

2620

1975

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

2621

1976

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

2622

if self.server_address[1]:

2623

self.allow_reuse_address = True

2624

1977

if not self.server_address[0]:

2625

1978

if self.address_family == socket.AF_INET6:

2626

any_address = "::" # in6addr_any

1979

any_address = "::" # in6addr_any

2627

1980

else:

2628

any_address = "0.0.0.0" # INADDR_ANY

1981

any_address = "0.0.0.0" # INADDR_ANY

2629

1982

self.server_address = (any_address,

2630

1983

self.server_address[1])

2631

1984

elif not self.server_address[1]:

2632

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

1985

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

1986

0)

2633

1987

# if self.interface:

2634

1988

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

2635

1989

# 0, # port

2641

1995

2642

1996

class MandosServer(IPv6_TCPServer):

2643

1997

"""Mandos server.

2644

1998

2645

1999

Attributes:

2646

2000

clients: set of Client objects

2647

2001

gnutls_priority GnuTLS priority string

2648

2002

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

2649

2650

Assumes a GLib.MainLoop event loop.

2003

2004

Assumes a gobject.MainLoop event loop.

2651

2005

"""

2652

2653

2006

def __init__(self, server_address, RequestHandlerClass,

2654

interface=None,

2655

use_ipv6=True,

2656

clients=None,

2657

gnutls_priority=None,

2658

use_dbus=True,

2659

socketfd=None):

2007

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

2008

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

2660

2009

self.enabled = False

2661

2010

self.clients = clients

2662

2011

if self.clients is None:

2665

2014

self.gnutls_priority = gnutls_priority

2666

2015

IPv6_TCPServer.__init__(self, server_address,

2667

2016

RequestHandlerClass,

2668

interface=interface,

2669

use_ipv6=use_ipv6,

2670

socketfd=socketfd)

2671

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2672

2020

def server_activate(self):

2673

2021

if self.enabled:

2674

2022

return socketserver.TCPServer.server_activate(self)

2675

2023

2676

2024

def enable(self):

2677

2025

self.enabled = True

2678

2026

2679

2027

def add_pipe(self, parent_pipe, proc):

2680

2028

# Call "handle_ipc" for both data and EOF events

2681

GLib.io_add_watch(

2682

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

2683

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

2684

functools.partial(self.handle_ipc,

2685

parent_pipe=parent_pipe,

2686

proc=proc))

2687

2688

def handle_ipc(self, source, condition,

2689

parent_pipe=None,

2690

proc=None,

2691

client_object=None):

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2035

2036

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

2037

proc = None, client_object=None):

2692

2038

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

2693

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

2039

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

2694

2040

# Wait for other process to exit

2695

2041

proc.join()

2696

2042

return False

2697

2043

2698

2044

# Read a request from the child

2699

2045

request = parent_pipe.recv()

2700

2046

command = request[0]

2701

2047

2702

2048

if command == 'init':

2703

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

2704

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

2705

address = request[3]

2706

2707

for c in self.clients.values():

2708

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2709

continue

2710

if key_id and c.key_id == key_id:

2711

client = c

2712

break

2713

if fpr and c.fingerprint == fpr:

2049

fpr = request[1]

2050

address = request[2]

2051

2052

for c in self.clients.itervalues():

2053

if c.fingerprint == fpr:

2714

2054

client = c

2715

2055

break

2716

2056

else:

2717

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

2718

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

2057

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

2058

"dress: %s", fpr, address)

2719

2059

if self.use_dbus:

2720

2060

# Emit D-Bus signal

2721

mandos_dbus_service.ClientNotFound(key_id or fpr,

2061

mandos_dbus_service.ClientNotFound(fpr,

2722

2062

address[0])

2723

2063

parent_pipe.send(False)

2724

2064

return False

2725

2726

GLib.io_add_watch(

2727

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

2728

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

2729

functools.partial(self.handle_ipc,

2730

parent_pipe=parent_pipe,

2731

proc=proc,

2732

client_object=client))

2065

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2733

2074

parent_pipe.send(True)

2734

2075

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

2735

2076

# same fileno

2738

2079

funcname = request[1]

2739

2080

args = request[2]

2740

2081

kwargs = request[3]

2741

2082

2742

2083

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

2743

2084

funcname)(*args,

2744

**kwargs)))

2745

2085

**kwargs)))

2086

2746

2087

if command == 'getattr':

2747

2088

attrname = request[1]

2748

if isinstance(client_object.__getattribute__(attrname),

2749

collections.Callable):

2750

parent_pipe.send(('function', ))

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2751

2091

else:

2752

parent_pipe.send((

2753

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

2754

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2755

2095

if command == 'setattr':

2756

2096

attrname = request[1]

2757

2097

value = request[2]

2758

2098

setattr(client_object, attrname, value)

2759

2099

2760

2100

return True

2761

2101

2762

2102

2763

2103

def rfc3339_duration_to_delta(duration):

2764

2104

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

2765

2766

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

2767

True

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2105

2106

>>> rfc3339_duration_to_delta("P7D")

2107

datetime.timedelta(7)

2108

>>> rfc3339_duration_to_delta("PT60S")

2109

datetime.timedelta(0, 60)

2110

>>> rfc3339_duration_to_delta("PT60M")

2111

datetime.timedelta(0, 3600)

2112

>>> rfc3339_duration_to_delta("PT24H")

2113

datetime.timedelta(1)

2114

>>> rfc3339_duration_to_delta("P1W")

2115

datetime.timedelta(7)

2116

>>> rfc3339_duration_to_delta("PT5M30S")

2117

datetime.timedelta(0, 330)

2118

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

datetime.timedelta(1, 200)

2780

2120

"""

2781

2121

2782

2122

# Parsing an RFC 3339 duration with regular expressions is not

2783

2123

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

2784

2124

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

2785

2125

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

2786

2126

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

2787

2127

# avoid excessive use of external libraries.

2788

2128

2789

2129

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

2790

Token = collections.namedtuple("Token", (

2791

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

2792

# a "group" containing digits

2793

"value", # datetime.timedelta or None

2794

"followers")) # Tokens valid after this token

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2795

2139

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

2796

2140

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

2797

2141

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

2798

2142

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

2799

2143

datetime.timedelta(seconds=1),

2800

frozenset((token_end, )))

2144

frozenset((token_end,)))

2801

2145

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

2802

2146

datetime.timedelta(minutes=1),

2803

2147

frozenset((token_second, token_end)))

2819

2163

frozenset((token_month, token_end)))

2820

2164

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

2821

2165

datetime.timedelta(weeks=1),

2822

frozenset((token_end, )))

2166

frozenset((token_end,)))

2823

2167

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

2824

2168

frozenset((token_year, token_month,

2825

2169

token_day, token_time,

2826

2170

token_week)))

2827

# Define starting values:

2828

# Value so far

2829

value = datetime.timedelta()

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2830

2173

found_token = None

2831

# Following valid tokens

2832

followers = frozenset((token_duration, ))

2833

# String left to parse

2834

s = duration

2174

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

2175

s = duration # String left to parse

2835

2176

# Loop until end token is found

2836

2177

while found_token is not token_end:

2837

2178

# Search for any currently valid tokens

2853

2194

break

2854

2195

else:

2855

2196

# No currently valid tokens were found

2856

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

2857

.format(duration))

2197

raise ValueError("Invalid RFC 3339 duration")

2858

2198

# End token found

2859

2199

return value

2860

2200

2861

2201

2862

2202

def string_to_delta(interval):

2863

2203

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

2864

2865

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

2866

True

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2204

2205

>>> string_to_delta('7d')

2206

datetime.timedelta(7)

2207

>>> string_to_delta('60s')

2208

datetime.timedelta(0, 60)

2209

>>> string_to_delta('60m')

2210

datetime.timedelta(0, 3600)

2211

>>> string_to_delta('24h')

2212

datetime.timedelta(1)

2213

>>> string_to_delta('1w')

2214

datetime.timedelta(7)

2215

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

2216

datetime.timedelta(0, 330)

2877

2217

"""

2878

2218

2879

2219

try:

2880

2220

return rfc3339_duration_to_delta(interval)

2881

2221

except ValueError:

2882

2222

pass

2883

2223

2884

2224

timevalue = datetime.timedelta(0)

2885

2225

for s in interval.split():

2886

2226

try:

2897

2237

elif suffix == "w":

2898

2238

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

2899

2239

else:

2900

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

2240

raise ValueError("Unknown suffix {!r}"

2241

.format(suffix))

2901

2242

except IndexError as e:

2902

2243

raise ValueError(*(e.args))

2903

2244

timevalue += delta

2904

2245

return timevalue

2905

2246

2906

2247

2907

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

2248

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

2908

2249

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

2909

2250

2910

2251

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

2911

2252

if os.fork():

2912

2253

sys.exit()

2919

2260

# Close all standard open file descriptors

2920

2261

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

2921

2262

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

2922

raise OSError(errno.ENODEV,

2923

"{} not a character device"

2263

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

2924

2264

.format(os.devnull))

2925

2265

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

2926

2266

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

2930

2270

2931

2271

2932

2272

def main():

2933

2273

2934

2274

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

2935

2275

# Parsing of options, both command line and config file

2936

2276

2937

2277

parser = argparse.ArgumentParser()

2938

2278

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

2939

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

2279

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

2940

2280

help="show version number and exit")

2941

2281

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

2942

2282

help="Bind to interface IF")

2978

2318

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

2979

2319

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

2980

2320

default=None)

2981

2321

2982

2322

options = parser.parse_args()

2983

2323

2324

if options.check:

2325

import doctest

2326

fail_count, test_count = doctest.testmod()

2327

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

2328

2984

2329

# Default values for config file for server-global settings

2985

if gnutls.has_rawpk:

2986

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

2987

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

2988

else:

2989

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

2990

":+SIGN-DSA-SHA256")

2991

server_defaults = {"interface": "",

2992

"address": "",

2993

"port": "",

2994

"debug": "False",

2995

"priority": priority,

2996

"servicename": "Mandos",

2997

"use_dbus": "True",

2998

"use_ipv6": "True",

2999

"debuglevel": "",

3000

"restore": "True",

3001

"socket": "",

3002

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

3003

"foreground": "False",

3004

"zeroconf": "True",

3005

}

3006

del priority

3007

2330

server_defaults = { "interface": "",

2331

"address": "",

2332

"port": "",

2333

"debug": "False",

2334

"priority":

2335

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

2336

"servicename": "Mandos",

2337

"use_dbus": "True",

2338

"use_ipv6": "True",

2339

"debuglevel": "",

2340

"restore": "True",

2341

"socket": "",

2342

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

2343

"foreground": "False",

2344

"zeroconf": "True",

2345

}

2346

3008

2347

# Parse config file for server-global settings

3009

server_config = configparser.ConfigParser(server_defaults)

2348

server_config = configparser.SafeConfigParser(server_defaults)

3010

2349

del server_defaults

3011

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

3012

# Convert the ConfigParser object to a dict

2350

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

2351

"mandos.conf"))

2352

# Convert the SafeConfigParser object to a dict

3013

2353

server_settings = server_config.defaults()

3014

2354

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

3015

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

3016

"foreground", "zeroconf"):

2355

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

3017

2356

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

3018

2357

option)

3019

2358

if server_settings["port"]:

3029

2368

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

3030

2369

["socket"])

3031

2370

del server_config

3032

2371

3033

2372

# Override the settings from the config file with command line

3034

2373

# options, if set.

3035

2374

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

3036

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

3037

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

3038

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

2375

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

2376

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

2377

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

3039

2378

value = getattr(options, option)

3040

2379

if value is not None:

3041

2380

server_settings[option] = value

3053

2392

if server_settings["debug"]:

3054

2393

server_settings["foreground"] = True

3055

2394

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

3056

2395

3057

2396

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

3058

3059

if (not server_settings["zeroconf"]

3060

and not (server_settings["port"]

3061

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

3062

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

3063

2397

2398

if (not server_settings["zeroconf"] and

2399

not (server_settings["port"]

2400

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

2401

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

2402

" Zeroconf")

2403

3064

2404

# For convenience

3065

2405

debug = server_settings["debug"]

3066

2406

debuglevel = server_settings["debuglevel"]

3070

2410

stored_state_file)

3071

2411

foreground = server_settings["foreground"]

3072

2412

zeroconf = server_settings["zeroconf"]

3073

2413

3074

2414

if debug:

3075

2415

initlogger(debug, logging.DEBUG)

3076

2416

else:

3079

2419

else:

3080

2420

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

3081

2421

initlogger(debug, level)

3082

2422

3083

2423

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

3084

syslogger.setFormatter(

3085

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

3086

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

3087

server_settings["servicename"])))

3088

2424

syslogger.setFormatter(logging.Formatter

2425

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

2426

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

2427

.format(server_settings

2428

["servicename"])))

2429

3089

2430

# Parse config file with clients

3090

client_config = configparser.ConfigParser(Client.client_defaults)

2431

client_config = configparser.SafeConfigParser(Client

2432

.client_defaults)

3091

2433

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

3092

2434

"clients.conf"))

3093

2435

3094

2436

global mandos_dbus_service

3095

2437

mandos_dbus_service = None

3096

2438

3097

2439

socketfd = None

3098

2440

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

3099

2441

socketfd = server_settings["socket"]

3100

tcp_server = MandosServer(

3101

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

3102

ClientHandler,

3103

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

3104

use_ipv6=use_ipv6,

3105

gnutls_priority=server_settings["priority"],

3106

use_dbus=use_dbus,

3107

socketfd=socketfd)

2442

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

2443

server_settings["port"]),

2444

ClientHandler,

2445

interface=(server_settings["interface"]

2446

or None),

2447

use_ipv6=use_ipv6,

2448

gnutls_priority=

2449

server_settings["priority"],

2450

use_dbus=use_dbus,

2451

socketfd=socketfd)

3108

2452

if not foreground:

3109

2453

pidfilename = "/run/mandos.pid"

3110

2454

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

3111

2455

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

3112

2456

pidfile = None

3113

2457

try:

3114

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

2458

pidfile = open(pidfilename, "w")

3115

2459

except IOError as e:

3116

2460

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

3117

2461

exc_info=e)

3118

3119

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

3120

("mandos", "mandos"),

3121

("nobody", "nogroup")):

2462

2463

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

3122

2464

try:

3123

2465

uid = pwd.getpwnam(name).pw_uid

3124

gid = pwd.getpwnam(group).pw_gid

2466

gid = pwd.getpwnam(name).pw_gid

3125

2467

break

3126

2468

except KeyError:

3127

2469

continue

3131

2473

try:

3132

2474

os.setgid(gid)

3133

2475

os.setuid(uid)

3134

if debug:

3135

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

3136

gid))

3137

2476

except OSError as error:

3138

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

3139

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

3140

2477

if error.errno != errno.EPERM:

3141

2478

raise

3142

2479

3143

2480

if debug:

3144

2481

# Enable all possible GnuTLS debugging

3145

2482

3146

2483

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

3147

2484

# - GnuTLS manual

3148

gnutls.global_set_log_level(11)

3149

3150

@gnutls.log_func

2485

gnutls.library.functions.gnutls_global_set_log_level(11)

2486

2487

@gnutls.library.types.gnutls_log_func

3151

2488

def debug_gnutls(level, string):

3152

2489

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

3153

3154

gnutls.global_set_log_function(debug_gnutls)

3155

2490

2491

(gnutls.library.functions

2492

.gnutls_global_set_log_function(debug_gnutls))

2493

3156

2494

# Redirect stdin so all checkers get /dev/null

3157

2495

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

3158

2496

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

3159

2497

if null > 2:

3160

2498

os.close(null)

3161

2499

3162

2500

# Need to fork before connecting to D-Bus

3163

2501

if not foreground:

3164

2502

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

3165

2503

daemon()

3166

3167

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

3168

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

3169

# need to inform GLib that threads will be used.

3170

GLib.threads_init()

3171

2504

2505

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

2506

# need to inform gobject that threads will be used.

2507

gobject.threads_init()

2508

3172

2509

global main_loop

3173

2510

# From the Avahi example code

3174

2511

DBusGMainLoop(set_as_default=True)

3175

main_loop = GLib.MainLoop()

2512

main_loop = gobject.MainLoop()

3176

2513

bus = dbus.SystemBus()

3177

2514

# End of Avahi example code

3178

2515

if use_dbus:

3179

2516

try:

3180

2517

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

3181

bus,

3182

do_not_queue=True)

3183

old_bus_name = dbus.service.BusName(

3184

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

3185

do_not_queue=True)

3186

except dbus.exceptions.DBusException as e:

2518

bus, do_not_queue=True)

2519

old_bus_name = (dbus.service.BusName

2520

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

2521

do_not_queue=True))

2522

except dbus.exceptions.NameExistsException as e:

3187

2523

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

3188

2524

use_dbus = False

3189

2525

server_settings["use_dbus"] = False

3190

2526

tcp_server.use_dbus = False

3191

2527

if zeroconf:

3192

2528

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3193

service = AvahiServiceToSyslog(

3194

name=server_settings["servicename"],

3195

servicetype="_mandos._tcp",

3196

protocol=protocol,

3197

bus=bus)

2529

service = AvahiServiceToSyslog(name =

2530

server_settings["servicename"],

2531

servicetype = "_mandos._tcp",

2532

protocol = protocol, bus = bus)

3198

2533

if server_settings["interface"]:

3199

service.interface = if_nametoindex(

3200

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

3201

2534

service.interface = (if_nametoindex

2535

(server_settings["interface"]

2536

.encode("utf-8")))

2537

3202

2538

global multiprocessing_manager

3203

2539

multiprocessing_manager = multiprocessing.Manager()

3204

2540

3205

2541

client_class = Client

3206

2542

if use_dbus:

3207

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

3208

2543

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

2544

3209

2545

client_settings = Client.config_parser(client_config)

3210

2546

old_client_settings = {}

3211

2547

clients_data = {}

3212

2548

3213

2549

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

3214

2550

global wnull

3215

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

2551

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

3216

2552

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

3217

2553

# mode

3218

2554

if debug or not foreground:

3219

2555

wnull.close()

3220

2556

3221

2557

# Get client data and settings from last running state.

3222

2558

if server_settings["restore"]:

3223

2559

try:

3224

2560

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

3225

if sys.version_info.major == 2:

3226

clients_data, old_client_settings = pickle.load(

3227

stored_state)

3228

else:

3229

bytes_clients_data, bytes_old_client_settings = (

3230

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

3231

# Fix bytes to strings

3232

# clients_data

3233

# .keys()

3234

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

3235

if isinstance(key, bytes)

3236

else key): value

3237

for key, value in

3238

bytes_clients_data.items()}

3239

del bytes_clients_data

3240

for key in clients_data:

3241

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

3242

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

3243

for k, v in

3244

clients_data[key].items()}

3245

clients_data[key] = value

3246

# .client_structure

3247

value["client_structure"] = [

3248

(s.decode("utf-8")

3249

if isinstance(s, bytes)

3250

else s) for s in

3251

value["client_structure"]]

3252

# .name, .host, and .checker_command

3253

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

3254

if isinstance(value[k], bytes):

3255

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

3256

if "key_id" not in value:

3257

value["key_id"] = ""

3258

elif "fingerprint" not in value:

3259

value["fingerprint"] = ""

3260

# old_client_settings

3261

# .keys()

3262

old_client_settings = {

3263

(key.decode("utf-8")

3264

if isinstance(key, bytes)

3265

else key): value

3266

for key, value in

3267

bytes_old_client_settings.items()}

3268

del bytes_old_client_settings

3269

# .host and .checker_command

3270

for value in old_client_settings.values():

3271

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

3272

if isinstance(value[attribute], bytes):

3273

value[attribute] = (value[attribute]

3274

.decode("utf-8"))

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3275

2563

os.remove(stored_state_path)

3276

2564

except IOError as e:

3277

2565

if e.errno == errno.ENOENT:

3278

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

3279

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

2566

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

2567

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

3280

2568

else:

3281

2569

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

3282

2570

exc_info=e)

3283

2571

raise

3284

2572

except EOFError as e:

3285

2573

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

3286

"EOFError:",

3287

exc_info=e)

3288

2574

"EOFError:", exc_info=e)

2575

3289

2576

with PGPEngine() as pgp:

3290

2577

for client_name, client in clients_data.items():

3291

2578

# Skip removed clients

3292

2579

if client_name not in client_settings:

3293

2580

continue

3294

2581

3295

2582

# Decide which value to use after restoring saved state.

3296

2583

# We have three different values: Old config file,

3297

2584

# new config file, and saved state.

3302

2589

# For each value in new config, check if it

3303

2590

# differs from the old config value (Except for

3304

2591

# the "secret" attribute)

3305

if (name != "secret"

3306

and (value !=

3307

old_client_settings[client_name][name])):

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3308

2595

client[name] = value

3309

2596

except KeyError:

3310

2597

pass

3311

2598

3312

2599

# Clients who has passed its expire date can still be

3313

# enabled if its last checker was successful. A Client

2600

# enabled if its last checker was successful. Clients

3314

2601

# whose checker succeeded before we stored its state is

3315

2602

# assumed to have successfully run all checkers during

3316

2603

# downtime.

3319

2606

if not client["last_checked_ok"]:

3320

2607

logger.warning(

3321

2608

"disabling client {} - Client never "

3322

"performed a successful checker".format(

3323

client_name))

2609

"performed a successful checker"

2610

.format(client_name))

3324

2611

client["enabled"] = False

3325

2612

elif client["last_checker_status"] != 0:

3326

2613

logger.warning(

3327

2614

"disabling client {} - Client last"

3328

" checker failed with error code"

3329

" {}".format(

3330

client_name,

3331

client["last_checker_status"]))

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3332

2618

client["enabled"] = False

3333

2619

else:

3334

client["expires"] = (

3335

datetime.datetime.utcnow()

3336

+ client["timeout"])

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3337

2623

logger.debug("Last checker succeeded,"

3338

" keeping {} enabled".format(

3339

client_name))

2624

" keeping {} enabled"

2625

.format(client_name))

3340

2626

try:

3341

client["secret"] = pgp.decrypt(

3342

client["encrypted_secret"],

3343

client_settings[client_name]["secret"])

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3344

2631

except PGPError:

3345

2632

# If decryption fails, we use secret from new settings

3346

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

3347

client_name))

3348

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

3349

["secret"])

3350

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3351

2638

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

3352

2639

for client_name in (set(old_client_settings)

3353

2640

- set(client_settings)):

3355

2642

for client_name in (set(client_settings)

3356

2643

- set(old_client_settings)):

3357

2644

clients_data[client_name] = client_settings[client_name]

3358

2645

3359

2646

# Create all client objects

3360

2647

for client_name, client in clients_data.items():

3361

2648

tcp_server.clients[client_name] = client_class(

3362

name=client_name,

3363

settings=client,

3364

server_settings=server_settings)

3365

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3366

2652

if not tcp_server.clients:

3367

2653

logger.warning("No clients defined")

3368

2654

3369

2655

if not foreground:

3370

2656

if pidfile is not None:

3371

pid = os.getpid()

3372

2657

try:

3373

2658

with pidfile:

3374

print(pid, file=pidfile)

2659

pid = os.getpid()

2660

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

3375

2661

except IOError:

3376

2662

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

3377

2663

pidfilename, pid)

3378

2664

del pidfile

3379

2665

del pidfilename

3380

3381

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

3382

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3383

lambda: main_loop.quit() and False)

3384

2666

2667

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

2668

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

2669

3385

2670

if use_dbus:

3386

3387

@alternate_dbus_interfaces(

3388

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

3389

class MandosDBusService(DBusObjectWithObjectManager):

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3390

2674

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

3391

3392

2675

def __init__(self):

3393

2676

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

3394

3395

2677

_interface = "se.recompile.Mandos"

3396

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3397

2685

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

3398

2686

def ClientAdded(self, objpath):

3399

2687

"D-Bus signal"

3400

2688

pass

3401

2689

3402

2690

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

3403

def ClientNotFound(self, key_id, address):

2691

def ClientNotFound(self, fingerprint, address):

3404

2692

"D-Bus signal"

3405

2693

pass

3406

3407

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

3408

"true"})

2694

3409

2695

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

3410

2696

def ClientRemoved(self, objpath, name):

3411

2697

"D-Bus signal"

3412

2698

pass

3413

3414

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

3415

"true"})

2699

3416

2700

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

3417

2701

def GetAllClients(self):

3418

2702

"D-Bus method"

3419

return dbus.Array(c.dbus_object_path for c in

3420

tcp_server.clients.values())

3421

3422

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

3423

"true"})

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3424

2707

@dbus.service.method(_interface,

3425

2708

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

3426

2709

def GetAllClientsWithProperties(self):

3427

2710

"D-Bus method"

3428

2711

return dbus.Dictionary(

3429

{c.dbus_object_path: c.GetAll(

3430

"se.recompile.Mandos.Client")

3431

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

2712

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

2713

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

3432

2714

signature="oa{sv}")

3433

2715

3434

2716

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

3435

2717

def RemoveClient(self, object_path):

3436

2718

"D-Bus method"

3437

for c in tcp_server.clients.values():

2719

for c in tcp_server.clients.itervalues():

3438

2720

if c.dbus_object_path == object_path:

3439

2721

del tcp_server.clients[c.name]

3440

2722

c.remove_from_connection()

3441

# Don't signal the disabling

2723

# Don't signal anything except ClientRemoved

3442

2724

c.disable(quiet=True)

3443

# Emit D-Bus signal for removal

3444

self.client_removed_signal(c)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3445

2727

return

3446

2728

raise KeyError(object_path)

3447

2729

3448

2730

del _interface

3449

3450

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3451

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

3452

def GetManagedObjects(self):

3453

"""D-Bus method"""

3454

return dbus.Dictionary(

3455

{client.dbus_object_path:

3456

dbus.Dictionary(

3457

{interface: client.GetAll(interface)

3458

for interface in

3459

client._get_all_interface_names()})

3460

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

3461

3462

def client_added_signal(self, client):

3463

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

3464

if use_dbus:

3465

# New standard signal

3466

self.InterfacesAdded(

3467

client.dbus_object_path,

3468

dbus.Dictionary(

3469

{interface: client.GetAll(interface)

3470

for interface in

3471

client._get_all_interface_names()}))

3472

# Old signal

3473

self.ClientAdded(client.dbus_object_path)

3474

3475

def client_removed_signal(self, client):

3476

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

3477

if use_dbus:

3478

# New standard signal

3479

self.InterfacesRemoved(

3480

client.dbus_object_path,

3481

client._get_all_interface_names())

3482

# Old signal

3483

self.ClientRemoved(client.dbus_object_path,

3484

client.name)

3485

2731

3486

2732

mandos_dbus_service = MandosDBusService()

3487

3488

# Save modules to variables to exempt the modules from being

3489

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

3490

mp = multiprocessing

3491

wn = wnull

3492

2733

3493

2734

def cleanup():

3494

2735

"Cleanup function; run on exit"

3495

2736

if zeroconf:

3496

2737

service.cleanup()

3497

3498

mp.active_children()

3499

wn.close()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3500

2741

if not (tcp_server.clients or client_settings):

3501

2742

return

3502

2743

3503

2744

# Store client before exiting. Secrets are encrypted with key

3504

2745

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

3505

2746

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

3506

2747

clients = {}

3507

2748

with PGPEngine() as pgp:

3508

for client in tcp_server.clients.values():

2749

for client in tcp_server.clients.itervalues():

3509

2750

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

3510

2751

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

3511

2752

key)

3512

2753

client_dict = {}

3513

2754

3514

2755

# A list of attributes that can not be pickled

3515

2756

# + secret.

3516

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

3517

"checker", "server_settings"}

3518

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

3519

.Object):

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3520

2761

exclude.add(name)

3521

2762

3522

2763

client_dict["encrypted_secret"] = (client

3523

2764

.encrypted_secret)

3524

2765

for attr in client.client_structure:

3525

2766

if attr not in exclude:

3526

2767

client_dict[attr] = getattr(client, attr)

3527

2768

3528

2769

clients[client.name] = client_dict

3529

2770

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

3530

2771

3531

2772

try:

3532

with tempfile.NamedTemporaryFile(

3533

mode='wb',

3534

suffix=".pickle",

3535

prefix='clients-',

3536

dir=os.path.dirname(stored_state_path),

3537

delete=False) as stored_state:

3538

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

3539

protocol=2)

3540

tempname = stored_state.name

2773

with (tempfile.NamedTemporaryFile

2774

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

2775

dir=os.path.dirname(stored_state_path),

2776

delete=False)) as stored_state:

2777

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

2778

tempname=stored_state.name

3541

2779

os.rename(tempname, stored_state_path)

3542

2780

except (IOError, OSError) as e:

3543

2781

if not debug:

3552

2790

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

3553

2791

exc_info=e)

3554

2792

raise

3555

2793

3556

2794

# Delete all clients, and settings from config

3557

2795

while tcp_server.clients:

3558

2796

name, client = tcp_server.clients.popitem()

3559

2797

if use_dbus:

3560

2798

client.remove_from_connection()

3561

# Don't signal the disabling

2799

# Don't signal anything except ClientRemoved

3562

2800

client.disable(quiet=True)

3563

# Emit D-Bus signal for removal

3564

2801

if use_dbus:

3565

mandos_dbus_service.client_removed_signal(client)

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3566

2806

client_settings.clear()

3567

2807

3568

2808

atexit.register(cleanup)

3569

3570

for client in tcp_server.clients.values():

2809

2810

for client in tcp_server.clients.itervalues():

3571

2811

if use_dbus:

3572

# Emit D-Bus signal for adding

3573

mandos_dbus_service.client_added_signal(client)

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3574

2814

# Need to initiate checking of clients

3575

2815

if client.enabled:

3576

2816

client.init_checker()

3577

2817

3578

2818

tcp_server.enable()

3579

2819

tcp_server.server_activate()

3580

2820

3581

2821

# Find out what port we got

3582

2822

if zeroconf:

3583

2823

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

3588

2828

else: # IPv4

3589

2829

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

3590

2830

*tcp_server.socket.getsockname())

3591

3592

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

3593

2831

2832

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

2833

3594

2834

try:

3595

2835

if zeroconf:

3596

2836

# From the Avahi example code

3601

2841

cleanup()

3602

2842

sys.exit(1)

3603

2843

# End of Avahi example code

3604

3605

GLib.io_add_watch(

3606

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

3607

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3608

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

3609

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

3610

2844

2845

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

2846

lambda *args, **kwargs:

2847

(tcp_server.handle_request

2848

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

2849

3611

2850

logger.debug("Starting main loop")

3612

2851

main_loop.run()

3613

2852

except AvahiError as error:

3622

2861

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

3623

2862

cleanup()

3624

2863

3625

3626

def should_only_run_tests():

3627

parser = argparse.ArgumentParser(add_help=False)

3628

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

3629

args, unknown_args = parser.parse_known_args()

3630

run_tests = args.check

3631

if run_tests:

3632

# Remove --check argument from sys.argv

3633

sys.argv[1:] = unknown_args

3634

return run_tests

3635

3636

# Add all tests from doctest strings

3637

def load_tests(loader, tests, none):

3638

import doctest

3639

tests.addTests(doctest.DocTestSuite())

3640

return tests

3641

3642

2864

if __name__ == '__main__':

3643

try:

3644

if should_only_run_tests():

3645

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

3646

unittest.main()

3647

else:

3648

main()

3649

finally:

3650

logging.shutdown()

2865

main()