/mandos/trunk : revision 723.1.6

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

# Show warnings by default

98

if not sys.warnoptions:

99

import warnings

100

warnings.simplefilter("default")

101

102

# Try to find the value of SO_BINDTODEVICE:

103

83

try:

104

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

105

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

106

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

107

85

except AttributeError:

108

86

try:

109

# This is where SO_BINDTODEVICE was up to and including Python

110

# 2.6, and also 3.2:

111

87

from IN import SO_BINDTODEVICE

112

88

except ImportError:

113

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

114

# Try running the C preprocessor:

115

try:

116

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

117

"/dev/stdin"],

118

stdin=subprocess.PIPE,

119

stdout=subprocess.PIPE)

120

stdout = cc.communicate(

121

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

122

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

123

except (OSError, ValueError, IndexError):

124

# No value found

125

SO_BINDTODEVICE = None

126

127

if sys.version_info < (3, 2):

128

configparser.Configparser = configparser.SafeConfigParser

129

130

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

131

92

stored_state_file = "clients.pickle"

132

93

133

94

logger = logging.getLogger()

134

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

135

95

syslogger = None

136

96

137

97

try:

138

if_nametoindex = ctypes.cdll.LoadLibrary(

139

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

140

101

except (OSError, AttributeError):

141

142

102

def if_nametoindex(interface):

143

103

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

144

104

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

145

105

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

146

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

147

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

148

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

149

111

return interface_index

150

112

151

113

152

def copy_function(func):

153

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

154

if sys.version_info.major == 2:

155

return types.FunctionType(func.func_code,

156

func.func_globals,

157

func.func_name,

158

func.func_defaults,

159

func.func_closure)

160

else:

161

return types.FunctionType(func.__code__,

162

func.__globals__,

163

func.__name__,

164

func.__defaults__,

165

func.__closure__)

166

167

168

114

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

169

115

"""init logger and add loglevel"""

170

116

171

117

global syslogger

172

syslogger = (logging.handlers.SysLogHandler(

173

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

174

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

175

122

syslogger.setFormatter(logging.Formatter

176

123

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

177

124

' %(message)s'))

178

125

logger.addHandler(syslogger)

179

126

180

127

if debug:

181

128

console = logging.StreamHandler()

182

129

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

192

139

pass

193

140

194

141

195

class PGPEngine:

142

class PGPEngine(object):

196

143

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

197

198

144

def __init__(self):

199

145

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

200

self.gpg = "gpg"

201

try:

202

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

203

for line in output.splitlines():

204

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

205

if name == b"gpg":

206

self.gpg = path

207

break

208

except OSError as e:

209

if e.errno != errno.ENOENT:

210

raise

211

146

self.gnupgargs = ['--batch',

212

'--homedir', self.tempdir,

147

'--home', self.tempdir,

213

148

'--force-mdc',

214

'--quiet']

215

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

216

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

217

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

218

149

'--quiet',

150

'--no-use-agent']

151

219

152

def __enter__(self):

220

153

return self

221

154

222

155

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

223

156

self._cleanup()

224

157

return False

225

158

226

159

def __del__(self):

227

160

self._cleanup()

228

161

229

162

def _cleanup(self):

230

163

if self.tempdir is not None:

231

164

# Delete contents of tempdir

232

165

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

233

topdown=False):

166

topdown = False):

234

167

for filename in files:

235

168

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

236

169

for dirname in dirs:

238

171

# Remove tempdir

239

172

os.rmdir(self.tempdir)

240

173

self.tempdir = None

241

174

242

175

def password_encode(self, password):

243

176

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

244

177

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

249

182

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

250

183

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

251

184

return encoded

252

185

253

186

def encrypt(self, data, password):

254

187

passphrase = self.password_encode(password)

255

with tempfile.NamedTemporaryFile(

256

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

257

190

passfile.write(passphrase)

258

191

passfile.flush()

259

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

192

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

260

193

'--passphrase-file',

261

194

passfile.name]

262

195

+ self.gnupgargs,

263

stdin=subprocess.PIPE,

264

stdout=subprocess.PIPE,

265

stderr=subprocess.PIPE)

266

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

267

200

if proc.returncode != 0:

268

201

raise PGPError(err)

269

202

return ciphertext

270

203

271

204

def decrypt(self, data, password):

272

205

passphrase = self.password_encode(password)

273

with tempfile.NamedTemporaryFile(

274

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

275

208

passfile.write(passphrase)

276

209

passfile.flush()

277

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

210

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

278

211

'--passphrase-file',

279

212

passfile.name]

280

213

+ self.gnupgargs,

281

stdin=subprocess.PIPE,

282

stdout=subprocess.PIPE,

283

stderr=subprocess.PIPE)

284

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

285

219

if proc.returncode != 0:

286

220

raise PGPError(err)

287

221

return decrypted_plaintext

288

222

289

223

290

# Pretend that we have an Avahi module

291

class avahi:

292

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

293

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

294

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

295

PROTO_INET = 0 # avahi-common/address.h

296

PROTO_INET6 = 1 # avahi-common/address.h

297

DBUS_NAME = "org.freedesktop.Avahi"

298

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

299

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

300

DBUS_PATH_SERVER = "/"

301

302

@staticmethod

303

def string_array_to_txt_array(t):

304

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

305

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

306

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

307

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

308

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

309

SERVER_INVALID = 0 # avahi-common/defs.h

310

SERVER_REGISTERING = 1 # avahi-common/defs.h

311

SERVER_RUNNING = 2 # avahi-common/defs.h

312

SERVER_COLLISION = 3 # avahi-common/defs.h

313

SERVER_FAILURE = 4 # avahi-common/defs.h

314

315

316

224

class AvahiError(Exception):

317

225

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

318

226

self.value = value

319

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

320

**kwargs)

321

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

322

230

323

231

class AvahiServiceError(AvahiError):

324

232

pass

325

233

326

327

234

class AvahiGroupError(AvahiError):

328

235

pass

329

236

330

237

331

class AvahiService:

238

class AvahiService(object):

332

239

"""An Avahi (Zeroconf) service.

333

240

334

241

Attributes:

335

242

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

336

243

Used to optionally bind to the specified interface.

348

255

server: D-Bus Server

349

256

bus: dbus.SystemBus()

350

257

"""

351

352

def __init__(self,

353

interface=avahi.IF_UNSPEC,

354

name=None,

355

servicetype=None,

356

port=None,

357

TXT=None,

358

domain="",

359

host="",

360

max_renames=32768,

361

protocol=avahi.PROTO_UNSPEC,

362

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

363

263

self.interface = interface

364

264

self.name = name

365

265

self.type = servicetype

374

274

self.server = None

375

275

self.bus = bus

376

276

self.entry_group_state_changed_match = None

377

378

def rename(self, remove=True):

277

278

def rename(self):

379

279

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

380

280

if self.rename_count >= self.max_renames:

381

281

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

382

282

" after %i retries, exiting.",

383

283

self.rename_count)

384

284

raise AvahiServiceError("Too many renames")

385

self.name = str(

386

self.server.GetAlternativeServiceName(self.name))

387

self.rename_count += 1

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

388

287

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

389

288

self.name)

390

if remove:

391

self.remove()

289

self.remove()

392

290

try:

393

291

self.add()

394

292

except dbus.exceptions.DBusException as error:

395

if (error.get_dbus_name()

396

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

397

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

398

return self.rename(remove=False)

399

else:

400

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

401

self.cleanup()

402

os._exit(1)

403

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

404

298

def remove(self):

405

299

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

406

300

if self.entry_group_state_changed_match is not None:

408

302

self.entry_group_state_changed_match = None

409

303

if self.group is not None:

410

304

self.group.Reset()

411

305

412

306

def add(self):

413

307

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

414

308

self.remove()

431

325

dbus.UInt16(self.port),

432

326

avahi.string_array_to_txt_array(self.TXT))

433

327

self.group.Commit()

434

328

435

329

def entry_group_state_changed(self, state, error):

436

330

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

437

331

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

438

332

439

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

440

334

logger.debug("Zeroconf service established.")

441

335

elif state == avahi.ENTRY_GROUP_COLLISION:

443

337

self.rename()

444

338

elif state == avahi.ENTRY_GROUP_FAILURE:

445

339

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

446

str(error))

447

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

448

340

unicode(error))

341

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

342

.format(error))

343

449

344

def cleanup(self):

450

345

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

451

346

if self.group is not None:

456

351

pass

457

352

self.group = None

458

353

self.remove()

459

354

460

355

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

461

356

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

462

357

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

463

bad_states = {

464

avahi.SERVER_INVALID: "Zeroconf server invalid",

465

avahi.SERVER_REGISTERING: None,

466

avahi.SERVER_COLLISION: "Zeroconf server name collision",

467

avahi.SERVER_FAILURE: "Zeroconf server failure",

468

}

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

469

365

if state in bad_states:

470

366

if bad_states[state] is not None:

471

367

if error is None:

474

370

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

475

371

self.cleanup()

476

372

elif state == avahi.SERVER_RUNNING:

477

try:

478

self.add()

479

except dbus.exceptions.DBusException as error:

480

if (error.get_dbus_name()

481

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

482

logger.info("Local Zeroconf service name"

483

" collision.")

484

return self.rename(remove=False)

485

else:

486

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

487

self.cleanup()

488

os._exit(1)

373

self.add()

489

374

else:

490

375

if error is None:

491

376

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

492

377

else:

493

378

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

494

379

495

380

def activate(self):

496

381

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

497

382

if self.server is None:

501

386

follow_name_owner_changes=True),

502

387

avahi.DBUS_INTERFACE_SERVER)

503

388

self.server.connect_to_signal("StateChanged",

504

self.server_state_changed)

389

self.server_state_changed)

505

390

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

506

391

507

392

508

393

class AvahiServiceToSyslog(AvahiService):

509

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

394

def rename(self):

510

395

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

511

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

512

syslogger.setFormatter(logging.Formatter(

513

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

514

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

515

401

return ret

516

402

517

403

518

# Pretend that we have a GnuTLS module

519

class gnutls:

520

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

521

522

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

523

if library is None:

524

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

525

_library = ctypes.cdll.LoadLibrary(library)

526

del library

527

528

# Unless otherwise indicated, the constants and types below are

529

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

530

531

# Constants

532

E_SUCCESS = 0

533

E_INTERRUPTED = -52

534

E_AGAIN = -28

535

CRT_OPENPGP = 2

536

CRT_RAWPK = 3

537

CLIENT = 2

538

SHUT_RDWR = 0

539

CRD_CERTIFICATE = 1

540

E_NO_CERTIFICATE_FOUND = -49

541

X509_FMT_DER = 0

542

NO_TICKETS = 1<<10

543

ENABLE_RAWPK = 1<<18

544

CTYPE_PEERS = 3

545

KEYID_USE_SHA256 = 1 # gnutls/x509.h

546

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

547

548

# Types

549

class session_int(ctypes.Structure):

550

_fields_ = []

551

session_t = ctypes.POINTER(session_int)

552

553

class certificate_credentials_st(ctypes.Structure):

554

_fields_ = []

555

certificate_credentials_t = ctypes.POINTER(

556

certificate_credentials_st)

557

certificate_type_t = ctypes.c_int

558

559

class datum_t(ctypes.Structure):

560

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

561

('size', ctypes.c_uint)]

562

563

class openpgp_crt_int(ctypes.Structure):

564

_fields_ = []

565

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

566

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

567

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

568

credentials_type_t = ctypes.c_int

569

transport_ptr_t = ctypes.c_void_p

570

close_request_t = ctypes.c_int

571

572

# Exceptions

573

class Error(Exception):

574

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

575

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

576

# code is passed, convert it to a string with

577

# gnutls.strerror()

578

self.code = code

579

if message is None and code is not None:

580

message = gnutls.strerror(code)

581

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

582

message, *args)

583

584

class CertificateSecurityError(Error):

585

pass

586

587

# Classes

588

class Credentials:

589

def __init__(self):

590

self._c_object = gnutls.certificate_credentials_t()

591

gnutls.certificate_allocate_credentials(

592

ctypes.byref(self._c_object))

593

self.type = gnutls.CRD_CERTIFICATE

594

595

def __del__(self):

596

gnutls.certificate_free_credentials(self._c_object)

597

598

class ClientSession:

599

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

600

self._c_object = gnutls.session_t()

601

gnutls_flags = gnutls.CLIENT

602

if gnutls.check_version(b"3.5.6"):

603

gnutls_flags |= gnutls.NO_TICKETS

604

if gnutls.has_rawpk:

605

gnutls_flags |= gnutls.ENABLE_RAWPK

606

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

607

del gnutls_flags

608

gnutls.set_default_priority(self._c_object)

609

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

610

gnutls.handshake_set_private_extensions(self._c_object,

611

True)

612

self.socket = socket

613

if credentials is None:

614

credentials = gnutls.Credentials()

615

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

616

ctypes.cast(credentials._c_object,

617

ctypes.c_void_p))

618

self.credentials = credentials

619

620

def __del__(self):

621

gnutls.deinit(self._c_object)

622

623

def handshake(self):

624

return gnutls.handshake(self._c_object)

625

626

def send(self, data):

627

data = bytes(data)

628

data_len = len(data)

629

while data_len > 0:

630

data_len -= gnutls.record_send(self._c_object,

631

data[-data_len:],

632

data_len)

633

634

def bye(self):

635

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

636

637

# Error handling functions

638

def _error_code(result):

639

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

640

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

641

if result >= 0:

642

return result

643

if result == gnutls.E_NO_CERTIFICATE_FOUND:

644

raise gnutls.CertificateSecurityError(code=result)

645

raise gnutls.Error(code=result)

646

647

def _retry_on_error(result, func, arguments):

648

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

649

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

650

while result < 0:

651

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

652

return _error_code(result)

653

result = func(*arguments)

654

return result

655

656

# Unless otherwise indicated, the function declarations below are

657

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

658

659

# Functions

660

priority_set_direct = _library.gnutls_priority_set_direct

661

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

662

ctypes.POINTER(ctypes.c_char_p)]

663

priority_set_direct.restype = _error_code

664

665

init = _library.gnutls_init

666

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

667

init.restype = _error_code

668

669

set_default_priority = _library.gnutls_set_default_priority

670

set_default_priority.argtypes = [session_t]

671

set_default_priority.restype = _error_code

672

673

record_send = _library.gnutls_record_send

674

record_send.argtypes = [session_t, ctypes.c_void_p,

675

ctypes.c_size_t]

676

record_send.restype = ctypes.c_ssize_t

677

record_send.errcheck = _retry_on_error

678

679

certificate_allocate_credentials = (

680

_library.gnutls_certificate_allocate_credentials)

681

certificate_allocate_credentials.argtypes = [

682

ctypes.POINTER(certificate_credentials_t)]

683

certificate_allocate_credentials.restype = _error_code

684

685

certificate_free_credentials = (

686

_library.gnutls_certificate_free_credentials)

687

certificate_free_credentials.argtypes = [

688

certificate_credentials_t]

689

certificate_free_credentials.restype = None

690

691

handshake_set_private_extensions = (

692

_library.gnutls_handshake_set_private_extensions)

693

handshake_set_private_extensions.argtypes = [session_t,

694

ctypes.c_int]

695

handshake_set_private_extensions.restype = None

696

697

credentials_set = _library.gnutls_credentials_set

698

credentials_set.argtypes = [session_t, credentials_type_t,

699

ctypes.c_void_p]

700

credentials_set.restype = _error_code

701

702

strerror = _library.gnutls_strerror

703

strerror.argtypes = [ctypes.c_int]

704

strerror.restype = ctypes.c_char_p

705

706

certificate_type_get = _library.gnutls_certificate_type_get

707

certificate_type_get.argtypes = [session_t]

708

certificate_type_get.restype = _error_code

709

710

certificate_get_peers = _library.gnutls_certificate_get_peers

711

certificate_get_peers.argtypes = [session_t,

712

ctypes.POINTER(ctypes.c_uint)]

713

certificate_get_peers.restype = ctypes.POINTER(datum_t)

714

715

global_set_log_level = _library.gnutls_global_set_log_level

716

global_set_log_level.argtypes = [ctypes.c_int]

717

global_set_log_level.restype = None

718

719

global_set_log_function = _library.gnutls_global_set_log_function

720

global_set_log_function.argtypes = [log_func]

721

global_set_log_function.restype = None

722

723

deinit = _library.gnutls_deinit

724

deinit.argtypes = [session_t]

725

deinit.restype = None

726

727

handshake = _library.gnutls_handshake

728

handshake.argtypes = [session_t]

729

handshake.restype = _error_code

730

handshake.errcheck = _retry_on_error

731

732

transport_set_ptr = _library.gnutls_transport_set_ptr

733

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

734

transport_set_ptr.restype = None

735

736

bye = _library.gnutls_bye

737

bye.argtypes = [session_t, close_request_t]

738

bye.restype = _error_code

739

bye.errcheck = _retry_on_error

740

741

check_version = _library.gnutls_check_version

742

check_version.argtypes = [ctypes.c_char_p]

743

check_version.restype = ctypes.c_char_p

744

745

_need_version = b"3.3.0"

746

if check_version(_need_version) is None:

747

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

748

.format(_need_version))

749

750

_tls_rawpk_version = b"3.6.6"

751

has_rawpk = bool(check_version(_tls_rawpk_version))

752

753

if has_rawpk:

754

# Types

755

class pubkey_st(ctypes.Structure):

756

_fields = []

757

pubkey_t = ctypes.POINTER(pubkey_st)

758

759

x509_crt_fmt_t = ctypes.c_int

760

761

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

762

pubkey_init = _library.gnutls_pubkey_init

763

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

764

pubkey_init.restype = _error_code

765

766

pubkey_import = _library.gnutls_pubkey_import

767

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

768

x509_crt_fmt_t]

769

pubkey_import.restype = _error_code

770

771

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

772

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

773

ctypes.POINTER(ctypes.c_ubyte),

774

ctypes.POINTER(ctypes.c_size_t)]

775

pubkey_get_key_id.restype = _error_code

776

777

pubkey_deinit = _library.gnutls_pubkey_deinit

778

pubkey_deinit.argtypes = [pubkey_t]

779

pubkey_deinit.restype = None

780

else:

781

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

782

783

openpgp_crt_init = _library.gnutls_openpgp_crt_init

784

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

785

openpgp_crt_init.restype = _error_code

786

787

openpgp_crt_import = _library.gnutls_openpgp_crt_import

788

openpgp_crt_import.argtypes = [openpgp_crt_t,

789

ctypes.POINTER(datum_t),

790

openpgp_crt_fmt_t]

791

openpgp_crt_import.restype = _error_code

792

793

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

794

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

795

ctypes.POINTER(ctypes.c_uint)]

796

openpgp_crt_verify_self.restype = _error_code

797

798

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

799

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

800

openpgp_crt_deinit.restype = None

801

802

openpgp_crt_get_fingerprint = (

803

_library.gnutls_openpgp_crt_get_fingerprint)

804

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

805

ctypes.c_void_p,

806

ctypes.POINTER(

807

ctypes.c_size_t)]

808

openpgp_crt_get_fingerprint.restype = _error_code

809

810

if check_version(b"3.6.4"):

811

certificate_type_get2 = _library.gnutls_certificate_type_get2

812

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

813

certificate_type_get2.restype = _error_code

814

815

# Remove non-public functions

816

del _error_code, _retry_on_error

817

818

819

def call_pipe(connection, # : multiprocessing.Connection

820

func, *args, **kwargs):

821

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

822

823

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

824

return value on the provided multiprocessing.Connection.

825

"""

826

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

827

connection.close()

828

829

830

class Client:

404

class Client(object):

831

405

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

832

406

833

407

Attributes:

834

408

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

835

409

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

836

410

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

837

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

838

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

839

running.

840

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

841

415

checker_command: string; External command which is run to check

842

416

if client lives. %() expansions are done at

843

417

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

844

418

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

845

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

846

420

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

847

421

client_structure: Object describing what attributes a client has

848

422

and is used for storing the client at exit

849

423

current_checker_command: string; current running checker_command

850

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

851

425

enabled: bool()

852

426

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

853

uniquely identify an OpenPGP client

854

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

855

a client using raw public keys

427

uniquely identify the client

856

428

host: string; available for use by the checker command

857

429

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

858

430

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

860

432

last_checker_status: integer between 0 and 255 reflecting exit

861

433

status of last checker. -1 reflects crashed

862

434

checker, -2 means no checker completed yet.

863

last_checker_signal: The signal which killed the last checker, if

864

last_checker_status is -1

865

435

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

866

436

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

867

437

D-Bus identifiers

874

444

disabled, or None

875

445

server_settings: The server_settings dict from main()

876

446

"""

877

447

878

448

runtime_expansions = ("approval_delay", "approval_duration",

879

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

449

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

880

450

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

881

451

"last_approval_request", "last_checked_ok",

882

452

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

883

client_defaults = {

884

"timeout": "PT5M",

885

"extended_timeout": "PT15M",

886

"interval": "PT2M",

887

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

888

"host": "",

889

"approval_delay": "PT0S",

890

"approval_duration": "PT1S",

891

"approved_by_default": "True",

892

"enabled": "True",

893

}

894

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

895

464

@staticmethod

896

465

def config_parser(config):

897

466

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

904

473

for client_name in config.sections():

905

474

section = dict(config.items(client_name))

906

475

client = settings[client_name] = {}

907

476

908

477

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

909

478

# Reformat values from string types to Python types

910

479

client["approved_by_default"] = config.getboolean(

911

480

client_name, "approved_by_default")

912

481

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

913

482

"enabled")

914

915

# Uppercase and remove spaces from key_id and fingerprint

916

# for later comparison purposes with return value from the

917

# key_id() and fingerprint() functions

918

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

919

.replace(" ", ""))

483

920

484

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

921

485

.replace(" ", ""))

922

486

if "secret" in section:

923

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

924

.encode("utf-8"),

925

"base64")

487

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

926

488

elif "secfile" in section:

927

489

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

928

490

(section["secfile"])),

943

505

client["last_approval_request"] = None

944

506

client["last_checked_ok"] = None

945

507

client["last_checker_status"] = -2

946

508

947

509

return settings

948

949

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

510

511

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

950

512

self.name = name

951

513

if server_settings is None:

952

514

server_settings = {}

954

516

# adding all client settings

955

517

for setting, value in settings.items():

956

518

setattr(self, setting, value)

957

519

958

520

if self.enabled:

959

521

if not hasattr(self, "last_enabled"):

960

522

self.last_enabled = datetime.datetime.utcnow()

964

526

else:

965

527

self.last_enabled = None

966

528

self.expires = None

967

529

968

530

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

969

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

970

534

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

971

535

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

972

536

datetime.datetime.utcnow())

973

537

974

538

# attributes specific for this server instance

975

539

self.checker = None

976

540

self.checker_initiator_tag = None

979

543

self.current_checker_command = None

980

544

self.approved = None

981

545

self.approvals_pending = 0

982

self.changedstate = multiprocessing_manager.Condition(

983

multiprocessing_manager.Lock())

984

self.client_structure = [attr

985

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

986

551

if not attr.startswith("_")]

987

552

self.client_structure.append("client_structure")

988

989

for name, t in inspect.getmembers(

990

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

991

558

if not name.startswith("_"):

992

559

self.client_structure.append(name)

993

560

994

561

# Send notice to process children that client state has changed

995

562

def send_changedstate(self):

996

563

with self.changedstate:

997

564

self.changedstate.notify_all()

998

565

999

566

def enable(self):

1000

567

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

1001

568

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

1006

573

self.last_enabled = datetime.datetime.utcnow()

1007

574

self.init_checker()

1008

575

self.send_changedstate()

1009

576

1010

577

def disable(self, quiet=True):

1011

578

"""Disable this client."""

1012

579

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

1014

581

if not quiet:

1015

582

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

1016

583

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

1017

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1018

585

self.disable_initiator_tag = None

1019

586

self.expires = None

1020

587

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

1021

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1022

589

self.checker_initiator_tag = None

1023

590

self.stop_checker()

1024

591

self.enabled = False

1025

592

if not quiet:

1026

593

self.send_changedstate()

1027

# 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

1028

595

return False

1029

596

1030

597

def __del__(self):

1031

598

self.disable()

1032

599

1033

600

def init_checker(self):

1034

601

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

1035

602

# and every interval from then on.

1036

603

if self.checker_initiator_tag is not None:

1037

GLib.source_remove(self.checker_initiator_tag)

1038

self.checker_initiator_tag = GLib.timeout_add(

1039

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

1040

+ 1)),

1041

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

1042

609

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

1043

610

if self.disable_initiator_tag is not None:

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

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

1047

616

# Also start a new checker *right now*.

1048

617

self.start_checker()

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

618

619

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

1052

620

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

if self.checker is not None:

1057

self.checker.join()

1058

621

self.checker_callback_tag = None

1059

622

self.checker = None

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1064

625

if self.last_checker_status == 0:

1065

626

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

1066

627

vars(self))

1067

628

self.checked_ok()

1068

629

else:

1069

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

630

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

631

vars(self))

1070

632

else:

1071

633

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

1073

634

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

1074

635

vars(self))

1075

return False

1076

636

1077

637

def checked_ok(self):

1078

638

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

1079

639

self.last_checked_ok = datetime.datetime.utcnow()

1080

640

self.last_checker_status = 0

1081

self.last_checker_signal = None

1082

641

self.bump_timeout()

1083

642

1084

643

def bump_timeout(self, timeout=None):

1085

644

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

1086

645

if timeout is None:

1087

646

timeout = self.timeout

1088

647

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1090

649

self.disable_initiator_tag = None

1091

650

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

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1094

654

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

1095

655

1096

656

def need_approval(self):

1097

657

self.last_approval_request = datetime.datetime.utcnow()

1098

658

1099

659

def start_checker(self):

1100

660

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

1101

661

1102

662

If a checker already exists, leave it running and do

1103

663

nothing."""

1104

664

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

1109

669

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

1110

670

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

1111

671

# should be.

1112

1113

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

1114

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

1115

self.checker.join()

1116

self.checker = None

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)

1117

687

# Start a new checker if needed

1118

688

if self.checker is None:

1119

689

# Escape attributes for the shell

1120

escaped_attrs = {

1121

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

1122

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

1123

694

try:

1124

695

command = self.checker_command % escaped_attrs

1125

696

except TypeError as error:

1126

697

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

1127

self.checker_command,

698

self.checker_command, exc_info=error)

699

return True # Try again later

700

self.current_checker_command = command

701

try:

702

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

703

command, self.name)

704

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

705

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

706

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

707

# always replaced by /dev/null.)

708

# The exception is when not debugging but nevertheless

709

# running in the foreground; use the previously

710

# created wnull.

711

popen_args = {}

712

if (not self.server_settings["debug"]

713

and self.server_settings["foreground"]):

714

popen_args.update({"stdout": wnull,

715

"stderr": wnull })

716

self.checker = subprocess.Popen(command,

717

close_fds=True,

718

shell=True, cwd="/",

719

**popen_args)

720

except OSError as error:

721

logger.error("Failed to start subprocess",

1128

722

exc_info=error)

1129

return True # Try again later

1130

self.current_checker_command = command

1131

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

1132

self.name)

1133

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

1134

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

1135

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

1136

# always replaced by /dev/null.)

1137

# The exception is when not debugging but nevertheless

1138

# running in the foreground; use the previously

1139

# created wnull.

1140

popen_args = {"close_fds": True,

1141

"shell": True,

1142

"cwd": "/"}

1143

if (not self.server_settings["debug"]

1144

and self.server_settings["foreground"]):

1145

popen_args.update({"stdout": wnull,

1146

"stderr": wnull})

1147

pipe = multiprocessing.Pipe(duplex=False)

1148

self.checker = multiprocessing.Process(

1149

target=call_pipe,

1150

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

1151

kwargs=popen_args)

1152

self.checker.start()

1153

self.checker_callback_tag = GLib.io_add_watch(

1154

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

1155

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1156

self.checker_callback, pipe[0], command)

1157

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

723

return True

724

self.checker_callback_tag = (gobject.child_watch_add

725

(self.checker.pid,

726

self.checker_callback,

727

data=command))

728

# The checker may have completed before the gobject

729

# watch was added. Check for this.

730

try:

731

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

732

except OSError as error:

733

if error.errno == errno.ECHILD:

734

# This should never happen

735

logger.error("Child process vanished",

736

exc_info=error)

737

return True

738

raise

739

if pid:

740

gobject.source_remove(self.checker_callback_tag)

741

self.checker_callback(pid, status, command)

742

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

1158

743

return True

1159

744

1160

745

def stop_checker(self):

1161

746

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

1162

747

if self.checker_callback_tag:

1163

GLib.source_remove(self.checker_callback_tag)

748

gobject.source_remove(self.checker_callback_tag)

1164

749

self.checker_callback_tag = None

1165

750

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

1166

751

return

1167

752

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

1168

self.checker.terminate()

753

try:

754

self.checker.terminate()

755

#time.sleep(0.5)

756

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

757

# self.checker.kill()

758

except OSError as error:

759

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

760

raise

1169

761

self.checker = None

1170

762

1171

763

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

764

def dbus_service_property(dbus_interface, signature="v",

765

access="readwrite", byte_arrays=False):

1176

766

"""Decorators for marking methods of a DBusObjectWithProperties to

1177

767

become properties on the D-Bus.

1178

768

1179

769

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

1180

770

and with one argument by "Set".

1181

771

1182

772

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

1183

773

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

1184

774

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

1188

778

if byte_arrays and signature != "ay":

1189

779

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

1190

780

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

1191

1192

781

def decorator(func):

1193

782

func._dbus_is_property = True

1194

783

func._dbus_interface = dbus_interface

1197

786

func._dbus_name = func.__name__

1198

787

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

1199

788

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

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

789

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1201

790

return func

1202

1203

791

return decorator

1204

792

1205

793

1206

794

def dbus_interface_annotations(dbus_interface):

1207

795

"""Decorator for marking functions returning interface annotations

1208

796

1209

797

Usage:

1210

798

1211

799

@dbus_interface_annotations("org.example.Interface")

1212

800

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

1213

801

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

1214

802

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

1215

803

"false"}

1216

804

"""

1217

1218

805

def decorator(func):

1219

806

func._dbus_is_interface = True

1220

807

func._dbus_interface = dbus_interface

1221

808

func._dbus_name = dbus_interface

1222

809

return func

1223

1224

810

return decorator

1225

811

1226

812

1227

813

def dbus_annotations(annotations):

1228

814

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

1229

815

Usage:

1230

1231

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

1232

"org.freedesktop.DBus.Property."

1233

"EmitsChangedSignal": "false"})

816

1234

817

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

1235

818

access="r")

819

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

820

"org.freedesktop.DBus.Property."

821

"EmitsChangedSignal": "false"})

1236

822

def Property_dbus_property(self):

1237

823

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

1240

824

"""

1241

1242

825

def decorator(func):

1243

826

func._dbus_annotations = annotations

1244

827

return func

1245

1246

828

return decorator

1247

829

1248

830

1249

831

class DBusPropertyException(dbus.exceptions.DBusException):

1250

832

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

1251

833

"""

1252

pass

834

def __unicode__(self):

835

return unicode(str(self))

1253

836

1254

837

1255

838

class DBusPropertyAccessException(DBusPropertyException):

1264

847

pass

1265

848

1266

849

1267

class DBusObjectWithAnnotations(dbus.service.Object):

1268

"""A D-Bus object with annotations.

1269

1270

Classes inheriting from this can use the dbus_annotations

1271

decorator to add annotations to methods or signals.

850

class DBusObjectWithProperties(dbus.service.Object):

851

"""A D-Bus object with properties.

852

853

Classes inheriting from this can use the dbus_service_property

854

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

855

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

1272

856

"""

1273

857

1274

858

@staticmethod

1275

859

def _is_dbus_thing(thing):

1276

860

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

1277

861

1278

862

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

1279

863

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

1280

864

"""

1281

865

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

1282

866

False)

1283

867

1284

868

def _get_all_dbus_things(self, thing):

1285

869

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

1286

870

"""

1287

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

871

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

872

name),

1288

873

athing.__get__(self))

1289

874

for cls in self.__class__.__mro__

1290

875

for name, athing in

1291

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

1292

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1297

def Introspect(self, object_path, connection):

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts annotation tags on methods and signals.

1301

"""

1302

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

1303

connection)

1304

try:

1305

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

1306

1307

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

1308

# Add annotation tags

1309

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

1310

for tag in if_tag.getElementsByTagName(typ):

1311

annots = dict()

1312

for name, prop in (self.

1313

_get_all_dbus_things(typ)):

1314

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

1315

and prop._dbus_interface

1316

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

1317

annots.update(getattr(

1318

prop, "_dbus_annotations", {}))

1319

for name, value in annots.items():

1320

ann_tag = document.createElement(

1321

"annotation")

1322

ann_tag.setAttribute("name", name)

1323

ann_tag.setAttribute("value", value)

1324

tag.appendChild(ann_tag)

1325

# Add interface annotation tags

1326

for annotation, value in dict(

1327

itertools.chain.from_iterable(

1328

annotations().items()

1329

for name, annotations

1330

in self._get_all_dbus_things("interface")

1331

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

1332

)).items():

1333

ann_tag = document.createElement("annotation")

1334

ann_tag.setAttribute("name", annotation)

1335

ann_tag.setAttribute("value", value)

1336

if_tag.appendChild(ann_tag)

1337

# Fix argument name for the Introspect method itself

1338

if (if_tag.getAttribute("name")

1339

== dbus.INTROSPECTABLE_IFACE):

1340

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

1341

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

1342

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

1343

if (arg.getAttribute("direction")

1344

== "out"):

1345

arg.setAttribute("name",

1346

"xml_data")

1347

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

1348

document.unlink()

1349

except (AttributeError, xml.dom.DOMException,

1350

xml.parsers.expat.ExpatError) as error:

1351

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

1352

exc_info=error)

1353

return xmlstring

1354

1355

1356

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1357

"""A D-Bus object with properties.

1358

1359

Classes inheriting from this can use the dbus_service_property

1360

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

1361

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

1362

"""

1363

876

inspect.getmembers(cls,

877

self._is_dbus_thing(thing)))

878

1364

879

def _get_dbus_property(self, interface_name, property_name):

1365

880

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

1366

881

property with the specified name and interface.

1367

882

"""

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

883

for cls in self.__class__.__mro__:

884

for name, value in (inspect.getmembers

885

(cls,

886

self._is_dbus_thing("property"))):

1371

887

if (value._dbus_name == property_name

1372

888

and value._dbus_interface == interface_name):

1373

889

return value.__get__(self)

1374

890

1375

891

# No such property

1376

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

1377

self.dbus_object_path, interface_name, property_name))

1378

1379

@classmethod

1380

def _get_all_interface_names(cls):

1381

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

1382

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

1383

"_dbus_interface", None)

1384

for x in (inspect.getmro(cls))

1385

for attr in dir(x))

1386

if name is not None)

1387

1388

@dbus.service.method(dbus.PROPERTIES_IFACE,

1389

in_signature="ss",

892

raise DBusPropertyNotFound(self.dbus_object_path + ":"

893

+ interface_name + "."

894

+ property_name)

895

896

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

1390

897

out_signature="v")

1391

898

def Get(self, interface_name, property_name):

1392

899

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

1398

905

if not hasattr(value, "variant_level"):

1399

906

return value

1400

907

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

1401

908

1402

909

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

1403

910

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

1404

911

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

1413

920

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

1414

921

"'ay' signature {!r}"

1415

922

.format(prop._dbus_signature))

1416

value = dbus.ByteArray(bytes(value))

923

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

924

for byte in value))

1417

925

prop(value)

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

926

927

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

1421

928

out_signature="a{sv}")

1422

929

def GetAll(self, interface_name):

1423

930

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

1424

931

standard.

1425

932

1426

933

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

1427

934

"""

1428

935

properties = {}

1438

945

if not hasattr(value, "variant_level"):

1439

946

properties[name] = value

1440

947

continue

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

948

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

949

value.variant_level+1)

1443

950

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

1444

1445

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

1446

def PropertiesChanged(self, interface_name, changed_properties,

1447

invalidated_properties):

1448

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

1449

standard.

1450

"""

1451

pass

1452

951

1453

952

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1454

953

out_signature="s",

1455

954

path_keyword='object_path',

1456

955

connection_keyword='connection')

1457

956

def Introspect(self, object_path, connection):

1458

957

"""Overloading of standard D-Bus method.

1459

958

1460

959

Inserts property tags and interface annotation tags.

1461

960

"""

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

961

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

962

connection)

1465

963

try:

1466

964

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

1467

1468

965

def make_tag(document, name, prop):

1469

966

e = document.createElement("property")

1470

967

e.setAttribute("name", name)

1471

968

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

1472

969

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

1473

970

return e

1474

1475

971

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

1476

972

# Add property tags

1477

973

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

1480

976

if prop._dbus_interface

1481

977

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

1482

978

if_tag.appendChild(tag)

1483

# Add annotation tags for properties

1484

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

1485

annots = dict()

1486

for name, prop in self._get_all_dbus_things(

1487

"property"):

1488

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

1489

and prop._dbus_interface

1490

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

1491

annots.update(getattr(

1492

prop, "_dbus_annotations", {}))

1493

for name, value in annots.items():

1494

ann_tag = document.createElement(

1495

"annotation")

1496

ann_tag.setAttribute("name", name)

1497

ann_tag.setAttribute("value", value)

1498

tag.appendChild(ann_tag)

979

# Add annotation tags

980

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

981

for tag in if_tag.getElementsByTagName(typ):

982

annots = dict()

983

for name, prop in (self.

984

_get_all_dbus_things(typ)):

985

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

986

and prop._dbus_interface

987

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

988

annots.update(getattr

989

(prop,

990

"_dbus_annotations",

991

{}))

992

for name, value in annots.items():

993

ann_tag = document.createElement(

994

"annotation")

995

ann_tag.setAttribute("name", name)

996

ann_tag.setAttribute("value", value)

997

tag.appendChild(ann_tag)

998

# Add interface annotation tags

999

for annotation, value in dict(

1000

itertools.chain.from_iterable(

1001

annotations().items()

1002

for name, annotations in

1003

self._get_all_dbus_things("interface")

1004

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

1005

)).items():

1006

ann_tag = document.createElement("annotation")

1007

ann_tag.setAttribute("name", annotation)

1008

ann_tag.setAttribute("value", value)

1009

if_tag.appendChild(ann_tag)

1499

1010

# Add the names to the return values for the

1500

1011

# "org.freedesktop.DBus.Properties" methods

1501

1012

if (if_tag.getAttribute("name")

1520

1031

return xmlstring

1521

1032

1522

1033

1523

try:

1524

dbus.OBJECT_MANAGER_IFACE

1525

except AttributeError:

1526

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

1527

1528

1529

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1530

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

1531

1532

Classes inheriting from this exposes the standard

1533

GetManagedObjects call and the InterfacesAdded and

1534

InterfacesRemoved signals on the standard

1535

"org.freedesktop.DBus.ObjectManager" interface.

1536

1537

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

1538

manually.

1539

"""

1540

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1541

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

1542

def GetManagedObjects(self):

1543

"""This function must be overridden"""

1544

raise NotImplementedError()

1545

1546

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1547

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

1548

def InterfacesAdded(self, object_path, interfaces_and_properties):

1549

pass

1550

1551

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

1552

def InterfacesRemoved(self, object_path, interfaces):

1553

pass

1554

1555

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1556

out_signature="s",

1557

path_keyword='object_path',

1558

connection_keyword='connection')

1559

def Introspect(self, object_path, connection):

1560

"""Overloading of standard D-Bus method.

1561

1562

Override return argument name of GetManagedObjects to be

1563

"objpath_interfaces_and_properties"

1564

"""

1565

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1566

object_path,

1567

connection)

1568

try:

1569

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

1570

1571

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

1572

# Fix argument name for the GetManagedObjects method

1573

if (if_tag.getAttribute("name")

1574

== dbus.OBJECT_MANAGER_IFACE):

1575

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

1576

if (cn.getAttribute("name")

1577

== "GetManagedObjects"):

1578

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

1579

if (arg.getAttribute("direction")

1580

== "out"):

1581

arg.setAttribute(

1582

"name",

1583

"objpath_interfaces"

1584

"_and_properties")

1585

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

1586

document.unlink()

1587

except (AttributeError, xml.dom.DOMException,

1588

xml.parsers.expat.ExpatError) as error:

1589

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

1590

exc_info=error)

1591

return xmlstring

1592

1593

1594

1034

def datetime_to_dbus(dt, variant_level=0):

1595

1035

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

1596

1036

if dt is None:

1597

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

1598

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

1037

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

1038

return dbus.String(dt.isoformat(),

1039

variant_level=variant_level)

1599

1040

1600

1041

1601

1042

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1603

1044

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

1604

1045

interface names according to the "alt_interface_names" mapping.

1605

1046

Usage:

1606

1047

1607

1048

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

1608

1049

"net.example.AlternateInterface"})

1609

1050

class SampleDBusObject(dbus.service.Object):

1610

1051

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

1611

1052

def SampleDBusMethod():

1612

1053

pass

1613

1054

1614

1055

The above "SampleDBusMethod" on "SampleDBusObject" will be

1615

1056

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

1616

1057

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

1617

1058

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

1618

1059

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

1619

1060

1620

1061

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

1621

1062

(from DBusObjectWithProperties) and interfaces (from the

1622

1063

dbus_interface_annotations decorator).

1623

1064

"""

1624

1625

1065

def wrapper(cls):

1626

1066

for orig_interface_name, alt_interface_name in (

1627

alt_interface_names.items()):

1067

alt_interface_names.items()):

1628

1068

attr = {}

1629

1069

interface_names = set()

1630

1070

# Go though all attributes of the class

1632

1072

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

1633

1073

# with the wrong interface name

1634

1074

if (not hasattr(attribute, "_dbus_interface")

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1075

or not attribute._dbus_interface

1076

.startswith(orig_interface_name)):

1637

1077

continue

1638

1078

# Create an alternate D-Bus interface name based on

1639

1079

# the current name

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1080

alt_interface = (attribute._dbus_interface

1081

.replace(orig_interface_name,

1082

alt_interface_name))

1642

1083

interface_names.add(alt_interface)

1643

1084

# Is this a D-Bus signal?

1644

1085

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

1645

1086

# Extract the original non-method undecorated

1646

1087

# function by black magic

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1088

nonmethod_func = (dict(

1649

1089

zip(attribute.func_code.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1652

else:

1653

nonmethod_func = (dict(

1654

zip(attribute.__code__.co_freevars,

1655

attribute.__closure__))

1656

["func"].cell_contents)

1090

attribute.__closure__))["func"]

1091

.cell_contents)

1657

1092

# Create a new, but exactly alike, function

1658

1093

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

1659

1094

# with the alternate D-Bus interface name

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

attribute._dbus_signature)(new_function))

1095

new_function = (dbus.service.signal

1096

(alt_interface,

1097

attribute._dbus_signature)

1098

(types.FunctionType(

1099

nonmethod_func.func_code,

1100

nonmethod_func.func_globals,

1101

nonmethod_func.func_name,

1102

nonmethod_func.func_defaults,

1103

nonmethod_func.func_closure)))

1664

1104

# Copy annotations, if any

1665

1105

try:

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1106

new_function._dbus_annotations = (

1107

dict(attribute._dbus_annotations))

1668

1108

except AttributeError:

1669

1109

pass

1670

1671

1110

# Define a creator of a function to call both the

1672

1111

# original and alternate functions, so both the

1673

1112

# original and alternate signals gets sent when

1676

1115

"""This function is a scope container to pass

1677

1116

func1 and func2 to the "call_both" function

1678

1117

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1681

1118

def call_both(*args, **kwargs):

1682

1119

"""This function will emit two D-Bus

1683

1120

signals by calling func1 and func2"""

1684

1121

func1(*args, **kwargs)

1685

1122

func2(*args, **kwargs)

1686

# Make wrapper function look like a D-Bus

1687

# signal

1688

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

1689

if name.startswith("_dbus_"):

1690

setattr(call_both, name, attr)

1691

1692

1123

return call_both

1693

1124

# Create the "call_both" function and add it to

1694

1125

# the class

1699

1130

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

1700

1131

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

1701

1132

# to the class.

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

(copy_function(attribute)))

1133

attr[attrname] = (dbus.service.method

1134

(alt_interface,

1135

attribute._dbus_in_signature,

1136

attribute._dbus_out_signature)

1137

(types.FunctionType

1138

(attribute.func_code,

1139

attribute.func_globals,

1140

attribute.func_name,

1141

attribute.func_defaults,

1142

attribute.func_closure)))

1708

1143

# Copy annotations, if any

1709

1144

try:

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1145

attr[attrname]._dbus_annotations = (

1146

dict(attribute._dbus_annotations))

1712

1147

except AttributeError:

1713

1148

pass

1714

1149

# Is this a D-Bus property?

1717

1152

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

1718

1153

# property with the alternate D-Bus interface

1719

1154

# name. Add it to the class.

1720

attr[attrname] = (dbus_service_property(

1721

alt_interface, attribute._dbus_signature,

1722

attribute._dbus_access,

1723

attribute._dbus_get_args_options

1724

["byte_arrays"])

1725

(copy_function(attribute)))

1155

attr[attrname] = (dbus_service_property

1156

(alt_interface,

1157

attribute._dbus_signature,

1158

attribute._dbus_access,

1159

attribute

1160

._dbus_get_args_options

1161

["byte_arrays"])

1162

(types.FunctionType

1163

(attribute.func_code,

1164

attribute.func_globals,

1165

attribute.func_name,

1166

attribute.func_defaults,

1167

attribute.func_closure)))

1726

1168

# Copy annotations, if any

1727

1169

try:

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1170

attr[attrname]._dbus_annotations = (

1171

dict(attribute._dbus_annotations))

1730

1172

except AttributeError:

1731

1173

pass

1732

1174

# Is this a D-Bus interface?

1735

1177

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

1736

1178

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

1737

1179

# to the class.

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

(copy_function(attribute)))

1180

attr[attrname] = (dbus_interface_annotations

1181

(alt_interface)

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1741

1188

if deprecate:

1742

1189

# Deprecate all alternate interfaces

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1190

iname="_AlternateDBusNames_interface_annotation{}"

1744

1191

for interface_name in interface_names:

1745

1746

1192

@dbus_interface_annotations(interface_name)

1747

1193

def func(self):

1748

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

1749

"true"}

1194

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

1195

"true" }

1750

1196

# Find an unused name

1751

1197

for aname in (iname.format(i)

1752

1198

for i in itertools.count()):

1756

1202

if interface_names:

1757

1203

# Replace the class with a new subclass of it with

1758

1204

# methods, signals, etc. as created above.

1759

if sys.version_info.major == 2:

1760

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

1761

(cls, ), attr)

1762

else:

1763

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

1764

(cls, ), attr)

1205

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

1206

(cls,), attr)

1765

1207

return cls

1766

1767

1208

return wrapper

1768

1209

1769

1210

1770

1211

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

1771

"se.bsnet.fukt.Mandos"})

1212

"se.bsnet.fukt.Mandos"})

1772

1213

class ClientDBus(Client, DBusObjectWithProperties):

1773

1214

"""A Client class using D-Bus

1774

1215

1775

1216

Attributes:

1776

1217

dbus_object_path: dbus.ObjectPath

1777

1218

bus: dbus.SystemBus()

1778

1219

"""

1779

1220

1780

1221

runtime_expansions = (Client.runtime_expansions

1781

+ ("dbus_object_path", ))

1782

1783

_interface = "se.recompile.Mandos.Client"

1784

1222

+ ("dbus_object_path",))

1223

1785

1224

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

1786

1787

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

1225

1226

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

1788

1227

self.bus = bus

1789

1228

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

1790

1229

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

1791

1230

# the D-Bus

1792

client_object_name = str(self.name).translate(

1231

client_object_name = unicode(self.name).translate(

1793

1232

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

1794

1233

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

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1234

self.dbus_object_path = (dbus.ObjectPath

1235

("/clients/" + client_object_name))

1797

1236

DBusObjectWithProperties.__init__(self, self.bus,

1798

1237

self.dbus_object_path)

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1804

_interface=_interface):

1238

1239

def notifychangeproperty(transform_func,

1240

dbus_name, type_func=lambda x: x,

1241

variant_level=1):

1805

1242

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

1806

1243

its changes to DBus.

1807

1244

1808

1245

transform_fun: Function that takes a value and a variant_level

1809

1246

and transforms it to a D-Bus type.

1810

1247

dbus_name: D-Bus name of the variable

1813

1250

variant_level: D-Bus variant level. Default: 1

1814

1251

"""

1815

1252

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

1816

1817

1253

def setter(self, value):

1818

1254

if hasattr(self, "dbus_object_path"):

1819

1255

if (not hasattr(self, attrname) or

1820

1256

type_func(getattr(self, attrname, None))

1821

1257

!= type_func(value)):

1822

if invalidate_only:

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1826

else:

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1830

self.PropertyChanged(dbus.String(dbus_name),

1831

dbus_value)

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1258

dbus_value = transform_func(type_func(value),

1259

variant_level

1260

=variant_level)

1261

self.PropertyChanged(dbus.String(dbus_name),

1262

dbus_value)

1837

1263

setattr(self, attrname, value)

1838

1264

1839

1265

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

1840

1266

1841

1267

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1842

1268

approvals_pending = notifychangeproperty(dbus.Boolean,

1843

1269

"ApprovalPending",

1844

type_func=bool)

1270

type_func = bool)

1845

1271

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

1846

1272

last_enabled = notifychangeproperty(datetime_to_dbus,

1847

1273

"LastEnabled")

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1274

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

1275

type_func = lambda checker:

1276

checker is not None)

1851

1277

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1852

1278

"LastCheckedOK")

1853

1279

last_checker_status = notifychangeproperty(dbus.Int16,

1856

1282

datetime_to_dbus, "LastApprovalRequest")

1857

1283

approved_by_default = notifychangeproperty(dbus.Boolean,

1858

1284

"ApprovedByDefault")

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1286

"ApprovalDelay",

1287

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1862

1290

approval_duration = notifychangeproperty(

1863

1291

dbus.UInt64, "ApprovalDuration",

1864

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

1292

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

1865

1293

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

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1294

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1869

1297

extended_timeout = notifychangeproperty(

1870

1298

dbus.UInt64, "ExtendedTimeout",

1871

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

1872

interval = notifychangeproperty(

1873

dbus.UInt64, "Interval",

1874

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

1299

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

1300

interval = notifychangeproperty(dbus.UInt64,

1301

"Interval",

1302

type_func =

1303

lambda td: td.total_seconds()

1304

* 1000)

1875

1305

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

1876

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

1877

invalidate_only=True)

1878

1306

1879

1307

del notifychangeproperty

1880

1308

1881

1309

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

1882

1310

try:

1883

1311

self.remove_from_connection()

1886

1314

if hasattr(DBusObjectWithProperties, "__del__"):

1887

1315

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

1888

1316

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

1889

1890

def checker_callback(self, source, condition,

1891

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

1892

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

1893

connection, command, *args,

1894

**kwargs)

1895

exitstatus = self.last_checker_status

1896

if exitstatus >= 0:

1317

1318

def checker_callback(self, pid, condition, command,

1319

*args, **kwargs):

1320

self.checker_callback_tag = None

1321

self.checker = None

1322

if os.WIFEXITED(condition):

1323

exitstatus = os.WEXITSTATUS(condition)

1897

1324

# Emit D-Bus signal

1898

1325

self.CheckerCompleted(dbus.Int16(exitstatus),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1326

dbus.Int64(condition),

1901

1327

dbus.String(command))

1902

1328

else:

1903

1329

# Emit D-Bus signal

1904

1330

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

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1331

dbus.Int64(condition),

1909

1332

dbus.String(command))

1910

return ret

1911

1333

1334

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

1335

*args, **kwargs)

1336

1912

1337

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

1913

1338

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

1914

1339

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

1918

1343

# Emit D-Bus signal

1919

1344

self.CheckerStarted(self.current_checker_command)

1920

1345

return r

1921

1346

1922

1347

def _reset_approved(self):

1923

1348

self.approved = None

1924

1349

return False

1925

1350

1926

1351

def approve(self, value=True):

1927

1352

self.approved = value

1928

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

1929

* 1000), self._reset_approved)

1353

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

1354

* 1000), self._reset_approved)

1930

1355

self.send_changedstate()

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1356

1357

## D-Bus methods, signals & properties

1358

_interface = "se.recompile.Mandos.Client"

1359

1360

## Interfaces

1361

1362

@dbus_interface_annotations(_interface)

1363

def _foo(self):

1364

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

1365

"false"}

1366

1367

## Signals

1368

1938

1369

# CheckerCompleted - signal

1939

1370

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

1940

1371

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

1941

1372

"D-Bus signal"

1942

1373

pass

1943

1374

1944

1375

# CheckerStarted - signal

1945

1376

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

1946

1377

def CheckerStarted(self, command):

1947

1378

"D-Bus signal"

1948

1379

pass

1949

1380

1950

1381

# PropertyChanged - signal

1951

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

1952

1382

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

1953

1383

def PropertyChanged(self, property, value):

1954

1384

"D-Bus signal"

1955

1385

pass

1956

1386

1957

1387

# GotSecret - signal

1958

1388

@dbus.service.signal(_interface)

1959

1389

def GotSecret(self):

1962

1392

server to mandos-client

1963

1393

"""

1964

1394

pass

1965

1395

1966

1396

# Rejected - signal

1967

1397

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

1968

1398

def Rejected(self, reason):

1969

1399

"D-Bus signal"

1970

1400

pass

1971

1401

1972

1402

# NeedApproval - signal

1973

1403

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

1974

1404

def NeedApproval(self, timeout, default):

1975

1405

"D-Bus signal"

1976

1406

return self.need_approval()

1977

1978

# Methods

1979

1407

1408

## Methods

1409

1980

1410

# Approve - method

1981

1411

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

1982

1412

def Approve(self, value):

1983

1413

self.approve(value)

1984

1414

1985

1415

# CheckedOK - method

1986

1416

@dbus.service.method(_interface)

1987

1417

def CheckedOK(self):

1988

1418

self.checked_ok()

1989

1419

1990

1420

# Enable - method

1991

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

1992

1421

@dbus.service.method(_interface)

1993

1422

def Enable(self):

1994

1423

"D-Bus method"

1995

1424

self.enable()

1996

1425

1997

1426

# StartChecker - method

1998

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

1999

1427

@dbus.service.method(_interface)

2000

1428

def StartChecker(self):

2001

1429

"D-Bus method"

2002

1430

self.start_checker()

2003

1431

2004

1432

# Disable - method

2005

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

2006

1433

@dbus.service.method(_interface)

2007

1434

def Disable(self):

2008

1435

"D-Bus method"

2009

1436

self.disable()

2010

1437

2011

1438

# StopChecker - method

2012

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

2013

1439

@dbus.service.method(_interface)

2014

1440

def StopChecker(self):

2015

1441

self.stop_checker()

2016

2017

# Properties

2018

1442

1443

## Properties

1444

2019

1445

# ApprovalPending - property

2020

1446

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

2021

1447

def ApprovalPending_dbus_property(self):

2022

1448

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

2023

1449

2024

1450

# ApprovedByDefault - property

2025

@dbus_service_property(_interface,

2026

signature="b",

1451

@dbus_service_property(_interface, signature="b",

2027

1452

access="readwrite")

2028

1453

def ApprovedByDefault_dbus_property(self, value=None):

2029

1454

if value is None: # get

2030

1455

return dbus.Boolean(self.approved_by_default)

2031

1456

self.approved_by_default = bool(value)

2032

1457

2033

1458

# ApprovalDelay - property

2034

@dbus_service_property(_interface,

2035

signature="t",

1459

@dbus_service_property(_interface, signature="t",

2036

1460

access="readwrite")

2037

1461

def ApprovalDelay_dbus_property(self, value=None):

2038

1462

if value is None: # get

2039

1463

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

2040

1464

* 1000)

2041

1465

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

2042

1466

2043

1467

# ApprovalDuration - property

2044

@dbus_service_property(_interface,

2045

signature="t",

1468

@dbus_service_property(_interface, signature="t",

2046

1469

access="readwrite")

2047

1470

def ApprovalDuration_dbus_property(self, value=None):

2048

1471

if value is None: # get

2049

1472

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

2050

1473

* 1000)

2051

1474

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

2052

1475

2053

1476

# Name - property

2054

@dbus_annotations(

2055

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

2056

1477

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

2057

1478

def Name_dbus_property(self):

2058

1479

return dbus.String(self.name)

2059

2060

# KeyID - property

2061

@dbus_annotations(

2062

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

2063

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

2064

def KeyID_dbus_property(self):

2065

return dbus.String(self.key_id)

2066

1480

2067

1481

# Fingerprint - property

2068

@dbus_annotations(

2069

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

2070

1482

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

2071

1483

def Fingerprint_dbus_property(self):

2072

1484

return dbus.String(self.fingerprint)

2073

1485

2074

1486

# Host - property

2075

@dbus_service_property(_interface,

2076

signature="s",

1487

@dbus_service_property(_interface, signature="s",

2077

1488

access="readwrite")

2078

1489

def Host_dbus_property(self, value=None):

2079

1490

if value is None: # get

2080

1491

return dbus.String(self.host)

2081

self.host = str(value)

2082

1492

self.host = unicode(value)

1493

2083

1494

# Created - property

2084

@dbus_annotations(

2085

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

2086

1495

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

2087

1496

def Created_dbus_property(self):

2088

1497

return datetime_to_dbus(self.created)

2089

1498

2090

1499

# LastEnabled - property

2091

1500

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

2092

1501

def LastEnabled_dbus_property(self):

2093

1502

return datetime_to_dbus(self.last_enabled)

2094

1503

2095

1504

# Enabled - property

2096

@dbus_service_property(_interface,

2097

signature="b",

1505

@dbus_service_property(_interface, signature="b",

2098

1506

access="readwrite")

2099

1507

def Enabled_dbus_property(self, value=None):

2100

1508

if value is None: # get

2103

1511

self.enable()

2104

1512

else:

2105

1513

self.disable()

2106

1514

2107

1515

# LastCheckedOK - property

2108

@dbus_service_property(_interface,

2109

signature="s",

1516

@dbus_service_property(_interface, signature="s",

2110

1517

access="readwrite")

2111

1518

def LastCheckedOK_dbus_property(self, value=None):

2112

1519

if value is not None:

2113

1520

self.checked_ok()

2114

1521

return

2115

1522

return datetime_to_dbus(self.last_checked_ok)

2116

1523

2117

1524

# LastCheckerStatus - property

2118

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

1525

@dbus_service_property(_interface, signature="n",

1526

access="read")

2119

1527

def LastCheckerStatus_dbus_property(self):

2120

1528

return dbus.Int16(self.last_checker_status)

2121

1529

2122

1530

# Expires - property

2123

1531

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

2124

1532

def Expires_dbus_property(self):

2125

1533

return datetime_to_dbus(self.expires)

2126

1534

2127

1535

# LastApprovalRequest - property

2128

1536

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

2129

1537

def LastApprovalRequest_dbus_property(self):

2130

1538

return datetime_to_dbus(self.last_approval_request)

2131

1539

2132

1540

# Timeout - property

2133

@dbus_service_property(_interface,

2134

signature="t",

1541

@dbus_service_property(_interface, signature="t",

2135

1542

access="readwrite")

2136

1543

def Timeout_dbus_property(self, value=None):

2137

1544

if value is None: # get

2149

1556

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

2150

1557

is None):

2151

1558

return

2152

GLib.source_remove(self.disable_initiator_tag)

2153

self.disable_initiator_tag = GLib.timeout_add(

2154

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

2155

self.disable)

2156

1559

gobject.source_remove(self.disable_initiator_tag)

1560

self.disable_initiator_tag = (

1561

gobject.timeout_add(

1562

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

1563

* 1000), self.disable))

1564

2157

1565

# ExtendedTimeout - property

2158

@dbus_service_property(_interface,

2159

signature="t",

1566

@dbus_service_property(_interface, signature="t",

2160

1567

access="readwrite")

2161

1568

def ExtendedTimeout_dbus_property(self, value=None):

2162

1569

if value is None: # get

2163

1570

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

2164

1571

* 1000)

2165

1572

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

2166

1573

2167

1574

# Interval - property

2168

@dbus_service_property(_interface,

2169

signature="t",

1575

@dbus_service_property(_interface, signature="t",

2170

1576

access="readwrite")

2171

1577

def Interval_dbus_property(self, value=None):

2172

1578

if value is None: # get

2176

1582

return

2177

1583

if self.enabled:

2178

1584

# Reschedule checker run

2179

GLib.source_remove(self.checker_initiator_tag)

2180

self.checker_initiator_tag = GLib.timeout_add(

2181

value, self.start_checker)

2182

self.start_checker() # Start one now, too

2183

1585

gobject.source_remove(self.checker_initiator_tag)

1586

self.checker_initiator_tag = (gobject.timeout_add

1587

(value, self.start_checker))

1588

self.start_checker() # Start one now, too

1589

2184

1590

# Checker - property

2185

@dbus_service_property(_interface,

2186

signature="s",

1591

@dbus_service_property(_interface, signature="s",

2187

1592

access="readwrite")

2188

1593

def Checker_dbus_property(self, value=None):

2189

1594

if value is None: # get

2190

1595

return dbus.String(self.checker_command)

2191

self.checker_command = str(value)

2192

1596

self.checker_command = unicode(value)

1597

2193

1598

# CheckerRunning - property

2194

@dbus_service_property(_interface,

2195

signature="b",

1599

@dbus_service_property(_interface, signature="b",

2196

1600

access="readwrite")

2197

1601

def CheckerRunning_dbus_property(self, value=None):

2198

1602

if value is None: # get

2201

1605

self.start_checker()

2202

1606

else:

2203

1607

self.stop_checker()

2204

1608

2205

1609

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

2209

1610

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

2210

1611

def ObjectPath_dbus_property(self):

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1612

return self.dbus_object_path # is already a dbus.ObjectPath

1613

2213

1614

# Secret = property

2214

@dbus_annotations(

2215

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

2216

"invalidates"})

2217

@dbus_service_property(_interface,

2218

signature="ay",

2219

access="write",

2220

byte_arrays=True)

1615

@dbus_service_property(_interface, signature="ay",

1616

access="write", byte_arrays=True)

2221

1617

def Secret_dbus_property(self, value):

2222

self.secret = bytes(value)

2223

1618

self.secret = str(value)

1619

2224

1620

del _interface

2225

1621

2226

1622

2227

class ProxyClient:

2228

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

1623

class ProxyClient(object):

1624

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

2229

1625

self._pipe = child_pipe

2230

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

1626

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

2231

1627

if not self._pipe.recv():

2232

raise KeyError(key_id or fpr)

2233

1628

raise KeyError()

1629

2234

1630

def __getattribute__(self, name):

2235

1631

if name == '_pipe':

2236

1632

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

2239

1635

if data[0] == 'data':

2240

1636

return data[1]

2241

1637

if data[0] == 'function':

2242

2243

1638

def func(*args, **kwargs):

2244

1639

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

2245

1640

return self._pipe.recv()[1]

2246

2247

1641

return func

2248

1642

2249

1643

def __setattr__(self, name, value):

2250

1644

if name == '_pipe':

2251

1645

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

2254

1648

2255

1649

class ClientHandler(socketserver.BaseRequestHandler, object):

2256

1650

"""A class to handle client connections.

2257

1651

2258

1652

Instantiated once for each connection to handle it.

2259

1653

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

2260

1654

2261

1655

def handle(self):

2262

1656

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

2263

1657

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

2264

str(self.client_address))

1658

unicode(self.client_address))

2265

1659

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

2266

1660

self.server.child_pipe.fileno())

2267

2268

session = gnutls.ClientSession(self.request)

2269

2270

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

2271

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

2272

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

2273

# "+DHE-DSS"))

1661

1662

session = (gnutls.connection

1663

.ClientSession(self.request,

1664

gnutls.connection

1665

.X509Credentials()))

1666

1667

# Note: gnutls.connection.X509Credentials is really a

1668

# generic GnuTLS certificate credentials object so long as

1669

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

1670

# here despite using OpenPGP certificates.

1671

1672

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

1673

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

1674

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

1675

# "+DHE-DSS"))

2274

1676

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

2275

1677

priority = self.server.gnutls_priority

2276

1678

if priority is None:

2277

1679

priority = "NORMAL"

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1680

(gnutls.library.functions

1681

.gnutls_priority_set_direct(session._c_object,

1682

priority, None))

1683

2282

1684

# Start communication using the Mandos protocol

2283

1685

# Get protocol number

2284

1686

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

2289

1691

except (ValueError, IndexError, RuntimeError) as error:

2290

1692

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

2291

1693

return

2292

1694

2293

1695

# Start GnuTLS connection

2294

1696

try:

2295

1697

session.handshake()

2296

except gnutls.Error as error:

1698

except gnutls.errors.GNUTLSError as error:

2297

1699

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

2298

1700

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

2299

1701

# established. Just abandon the request.

2300

1702

return

2301

1703

logger.debug("Handshake succeeded")

2302

1704

2303

1705

approval_required = False

2304

1706

try:

2305

if gnutls.has_rawpk:

2306

fpr = b""

2307

try:

2308

key_id = self.key_id(

2309

self.peer_certificate(session))

2310

except (TypeError, gnutls.Error) as error:

2311

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

2312

return

2313

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

2314

2315

else:

2316

key_id = b""

2317

try:

2318

fpr = self.fingerprint(

2319

self.peer_certificate(session))

2320

except (TypeError, gnutls.Error) as error:

2321

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

2322

return

2323

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

2324

2325

try:

2326

client = ProxyClient(child_pipe, key_id, fpr,

1707

try:

1708

fpr = self.fingerprint(self.peer_certificate

1709

(session))

1710

except (TypeError,

1711

gnutls.errors.GNUTLSError) as error:

1712

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

1713

return

1714

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

1715

1716

try:

1717

client = ProxyClient(child_pipe, fpr,

2327

1718

self.client_address)

2328

1719

except KeyError:

2329

1720

return

2330

1721

2331

1722

if client.approval_delay:

2332

1723

delay = client.approval_delay

2333

1724

client.approvals_pending += 1

2334

1725

approval_required = True

2335

1726

2336

1727

while True:

2337

1728

if not client.enabled:

2338

1729

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

2339

client.name)

1730

client.name)

2340

1731

if self.server.use_dbus:

2341

1732

# Emit D-Bus signal

2342

1733

client.Rejected("Disabled")

2343

1734

return

2344

1735

2345

1736

if client.approved or not client.approval_delay:

2346

# We are approved or approval is disabled

1737

#We are approved or approval is disabled

2347

1738

break

2348

1739

elif client.approved is None:

2349

1740

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

2360

1751

# Emit D-Bus signal

2361

1752

client.Rejected("Denied")

2362

1753

return

2363

2364

# wait until timeout or approved

1754

1755

#wait until timeout or approved

2365

1756

time = datetime.datetime.now()

2366

1757

client.changedstate.acquire()

2367

1758

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

2380

1771

break

2381

1772

else:

2382

1773

delay -= time2 - time

2383

2384

try:

2385

session.send(client.secret)

2386

except gnutls.Error as error:

2387

logger.warning("gnutls send failed",

2388

exc_info=error)

2389

return

2390

1774

1775

sent_size = 0

1776

while sent_size < len(client.secret):

1777

try:

1778

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

1779

except gnutls.errors.GNUTLSError as error:

1780

logger.warning("gnutls send failed",

1781

exc_info=error)

1782

return

1783

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

1784

sent, len(client.secret)

1785

- (sent_size + sent))

1786

sent_size += sent

1787

2391

1788

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

2392

1789

# bump the timeout using extended_timeout

2393

1790

client.bump_timeout(client.extended_timeout)

2394

1791

if self.server.use_dbus:

2395

1792

# Emit D-Bus signal

2396

1793

client.GotSecret()

2397

1794

2398

1795

finally:

2399

1796

if approval_required:

2400

1797

client.approvals_pending -= 1

2401

1798

try:

2402

1799

session.bye()

2403

except gnutls.Error as error:

1800

except gnutls.errors.GNUTLSError as error:

2404

1801

logger.warning("GnuTLS bye failed",

2405

1802

exc_info=error)

2406

1803

2407

1804

@staticmethod

2408

1805

def peer_certificate(session):

2409

"Return the peer's certificate as a bytestring"

2410

try:

2411

cert_type = gnutls.certificate_type_get2(session._c_object,

2412

gnutls.CTYPE_PEERS)

2413

except AttributeError:

2414

cert_type = gnutls.certificate_type_get(session._c_object)

2415

if gnutls.has_rawpk:

2416

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2417

else:

2418

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2419

# If not a valid certificate type...

2420

if cert_type not in valid_cert_types:

2421

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

2422

valid_cert_types)

2423

# ...return invalid data

2424

return b""

1806

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

1807

# If not an OpenPGP certificate...

1808

if (gnutls.library.functions

1809

.gnutls_certificate_type_get(session._c_object)

1810

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1811

# ...do the normal thing

1812

return session.peer_certificate

2425

1813

list_size = ctypes.c_uint(1)

2426

cert_list = (gnutls.certificate_get_peers

1814

cert_list = (gnutls.library.functions

1815

.gnutls_certificate_get_peers

2427

1816

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

2428

1817

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

2429

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

1818

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

1819

" certificate")

2430

1820

if list_size.value == 0:

2431

1821

return None

2432

1822

cert = cert_list[0]

2433

1823

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

2434

2435

@staticmethod

2436

def key_id(certificate):

2437

"Convert a certificate bytestring to a hexdigit key ID"

2438

# New GnuTLS "datum" with the public key

2439

datum = gnutls.datum_t(

2440

ctypes.cast(ctypes.c_char_p(certificate),

2441

ctypes.POINTER(ctypes.c_ubyte)),

2442

ctypes.c_uint(len(certificate)))

2443

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

2444

# New empty GnuTLS certificate

2445

pubkey = gnutls.pubkey_t()

2446

gnutls.pubkey_init(ctypes.byref(pubkey))

2447

# Import the raw public key into the certificate

2448

gnutls.pubkey_import(pubkey,

2449

ctypes.byref(datum),

2450

gnutls.X509_FMT_DER)

2451

# New buffer for the key ID

2452

buf = ctypes.create_string_buffer(32)

2453

buf_len = ctypes.c_size_t(len(buf))

2454

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

2455

gnutls.pubkey_get_key_id(pubkey,

2456

gnutls.KEYID_USE_SHA256,

2457

ctypes.cast(ctypes.byref(buf),

2458

ctypes.POINTER(ctypes.c_ubyte)),

2459

ctypes.byref(buf_len))

2460

# Deinit the certificate

2461

gnutls.pubkey_deinit(pubkey)

2462

2463

# Convert the buffer to a Python bytestring

2464

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

2465

# Convert the bytestring to hexadecimal notation

2466

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

2467

return hex_key_id

2468

1824

2469

1825

@staticmethod

2470

1826

def fingerprint(openpgp):

2471

1827

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2472

1828

# New GnuTLS "datum" with the OpenPGP public key

2473

datum = gnutls.datum_t(

2474

ctypes.cast(ctypes.c_char_p(openpgp),

2475

ctypes.POINTER(ctypes.c_ubyte)),

2476

ctypes.c_uint(len(openpgp)))

1829

datum = (gnutls.library.types

1830

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

1831

ctypes.POINTER

1832

(ctypes.c_ubyte)),

1833

ctypes.c_uint(len(openpgp))))

2477

1834

# New empty GnuTLS certificate

2478

crt = gnutls.openpgp_crt_t()

2479

gnutls.openpgp_crt_init(ctypes.byref(crt))

1835

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1836

(gnutls.library.functions

1837

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2480

1838

# Import the OpenPGP public key into the certificate

2481

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

2482

gnutls.OPENPGP_FMT_RAW)

1839

(gnutls.library.functions

1840

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

1841

gnutls.library.constants

1842

.GNUTLS_OPENPGP_FMT_RAW))

2483

1843

# Verify the self signature in the key

2484

1844

crtverify = ctypes.c_uint()

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1845

(gnutls.library.functions

1846

.gnutls_openpgp_crt_verify_self(crt, 0,

1847

ctypes.byref(crtverify)))

2487

1848

if crtverify.value != 0:

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1850

raise (gnutls.errors.CertificateSecurityError

1851

("Verify failed"))

2491

1852

# New buffer for the fingerprint

2492

1853

buf = ctypes.create_string_buffer(20)

2493

1854

buf_len = ctypes.c_size_t()

2494

1855

# Get the fingerprint from the certificate into the buffer

2495

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

2496

ctypes.byref(buf_len))

1856

(gnutls.library.functions

1857

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

1858

ctypes.byref(buf_len)))

2497

1859

# Deinit the certificate

2498

gnutls.openpgp_crt_deinit(crt)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2499

1861

# Convert the buffer to a Python bytestring

2500

1862

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

2501

1863

# Convert the bytestring to hexadecimal notation

2503

1865

return hex_fpr

2504

1866

2505

1867

2506

class MultiprocessingMixIn:

1868

class MultiprocessingMixIn(object):

2507

1869

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

2508

2509

1870

def sub_process_main(self, request, address):

2510

1871

try:

2511

1872

self.finish_request(request, address)

2512

1873

except Exception:

2513

1874

self.handle_error(request, address)

2514

1875

self.close_request(request)

2515

1876

2516

1877

def process_request(self, request, address):

2517

1878

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

2518

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

2519

args=(request, address))

1879

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

1880

args = (request, address))

2520

1881

proc.start()

2521

1882

return proc

2522

1883

2523

1884

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1885

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2525

1886

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

2526

2527

1887

def process_request(self, request, client_address):

2528

1888

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

2529

1889

2530

1890

This function creates a new pipe in self.pipe

2531

1891

"""

2532

1892

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2533

1893

2534

1894

proc = MultiprocessingMixIn.process_request(self, request,

2535

1895

client_address)

2536

1896

self.child_pipe.close()

2537

1897

self.add_pipe(parent_pipe, proc)

2538

1898

2539

1899

def add_pipe(self, parent_pipe, proc):

2540

1900

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

2541

1901

raise NotImplementedError()

2542

1902

2543

1903

2544

1904

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2545

socketserver.TCPServer):

1905

socketserver.TCPServer, object):

2546

1906

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

2547

1907

2548

1908

Attributes:

2549

1909

enabled: Boolean; whether this server is activated yet

2550

1910

interface: None or a network interface name (string)

2551

1911

use_ipv6: Boolean; to use IPv6 or not

2552

1912

"""

2553

2554

1913

def __init__(self, server_address, RequestHandlerClass,

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1914

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

2558

1915

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

2559

1916

creating a new one with socket.socket().

2560

1917

"""

2566

1923

self.socketfd = socketfd

2567

1924

# Save the original socket.socket() function

2568

1925

self.socket_socket = socket.socket

2569

2570

1926

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

2571

#

1927

#

2572

1928

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

2573

1929

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

2574

1930

# patching socket.socket.)

2575

#

1931

#

2576

1932

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

2577

1933

@functools.wraps(socket.socket)

2578

1934

def socket_wrapper(*args, **kwargs):

2590

1946

# socket_wrapper(), if socketfd was set.

2591

1947

socketserver.TCPServer.__init__(self, server_address,

2592

1948

RequestHandlerClass)

2593

1949

2594

1950

def server_bind(self):

2595

1951

"""This overrides the normal server_bind() function

2596

1952

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

2597

1953

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

2598

global SO_BINDTODEVICE

2599

1954

if self.interface is not None:

2600

1955

if SO_BINDTODEVICE is None:

2601

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

2602

# common enough.

2603

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

2604

SO_BINDTODEVICE = 25

2605

try:

2606

self.socket.setsockopt(

2607

socket.SOL_SOCKET, SO_BINDTODEVICE,

2608

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

2609

except socket.error as error:

2610

if error.errno == errno.EPERM:

2611

logger.error("No permission to bind to"

2612

" interface %s", self.interface)

2613

elif error.errno == errno.ENOPROTOOPT:

2614

logger.error("SO_BINDTODEVICE not available;"

2615

" cannot bind to interface %s",

2616

self.interface)

2617

elif error.errno == errno.ENODEV:

2618

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

2619

" cannot bind", self.interface)

2620

else:

2621

raise

1956

logger.error("SO_BINDTODEVICE does not exist;"

1957

" cannot bind to interface %s",

1958

self.interface)

1959

else:

1960

try:

1961

self.socket.setsockopt(socket.SOL_SOCKET,

1962

SO_BINDTODEVICE,

1963

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

1964

except socket.error as error:

1965

if error.errno == errno.EPERM:

1966

logger.error("No permission to bind to"

1967

" interface %s", self.interface)

1968

elif error.errno == errno.ENOPROTOOPT:

1969

logger.error("SO_BINDTODEVICE not available;"

1970

" cannot bind to interface %s",

1971

self.interface)

1972

elif error.errno == errno.ENODEV:

1973

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

1974

" cannot bind", self.interface)

1975

else:

1976

raise

2622

1977

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

2623

1978

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

2626

1979

if not self.server_address[0]:

2627

1980

if self.address_family == socket.AF_INET6:

2628

any_address = "::" # in6addr_any

1981

any_address = "::" # in6addr_any

2629

1982

else:

2630

any_address = "0.0.0.0" # INADDR_ANY

1983

any_address = "0.0.0.0" # INADDR_ANY

2631

1984

self.server_address = (any_address,

2632

1985

self.server_address[1])

2633

1986

elif not self.server_address[1]:

2634

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

1987

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

1988

0)

2635

1989

# if self.interface:

2636

1990

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

2637

1991

# 0, # port

2643

1997

2644

1998

class MandosServer(IPv6_TCPServer):

2645

1999

"""Mandos server.

2646

2000

2647

2001

Attributes:

2648

2002

clients: set of Client objects

2649

2003

gnutls_priority GnuTLS priority string

2650

2004

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

2651

2652

Assumes a GLib.MainLoop event loop.

2005

2006

Assumes a gobject.MainLoop event loop.

2653

2007

"""

2654

2655

2008

def __init__(self, server_address, RequestHandlerClass,

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

2009

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

2010

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

2662

2011

self.enabled = False

2663

2012

self.clients = clients

2664

2013

if self.clients is None:

2667

2016

self.gnutls_priority = gnutls_priority

2668

2017

IPv6_TCPServer.__init__(self, server_address,

2669

2018

RequestHandlerClass,

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2019

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

2674

2022

def server_activate(self):

2675

2023

if self.enabled:

2676

2024

return socketserver.TCPServer.server_activate(self)

2677

2025

2678

2026

def enable(self):

2679

2027

self.enabled = True

2680

2028

2681

2029

def add_pipe(self, parent_pipe, proc):

2682

2030

# Call "handle_ipc" for both data and EOF events

2683

GLib.io_add_watch(

2684

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

2685

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

2686

functools.partial(self.handle_ipc,

2687

parent_pipe=parent_pipe,

2688

proc=proc))

2689

2690

def handle_ipc(self, source, condition,

2691

parent_pipe=None,

2692

proc=None,

2693

client_object=None):

2031

gobject.io_add_watch(parent_pipe.fileno(),

2032

gobject.IO_IN | gobject.IO_HUP,

2033

functools.partial(self.handle_ipc,

2034

parent_pipe =

2035

parent_pipe,

2036

proc = proc))

2037

2038

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

2039

proc = None, client_object=None):

2694

2040

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

2695

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

2041

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

2696

2042

# Wait for other process to exit

2697

2043

proc.join()

2698

2044

return False

2699

2045

2700

2046

# Read a request from the child

2701

2047

request = parent_pipe.recv()

2702

2048

command = request[0]

2703

2049

2704

2050

if command == 'init':

2705

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

2706

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

2707

address = request[3]

2708

2709

for c in self.clients.values():

2710

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2711

continue

2712

if key_id and c.key_id == key_id:

2713

client = c

2714

break

2715

if fpr and c.fingerprint == fpr:

2051

fpr = request[1]

2052

address = request[2]

2053

2054

for c in self.clients.itervalues():

2055

if c.fingerprint == fpr:

2716

2056

client = c

2717

2057

break

2718

2058

else:

2719

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

2720

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

2059

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

2060

"dress: %s", fpr, address)

2721

2061

if self.use_dbus:

2722

2062

# Emit D-Bus signal

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2063

mandos_dbus_service.ClientNotFound(fpr,

2724

2064

address[0])

2725

2065

parent_pipe.send(False)

2726

2066

return False

2727

2728

GLib.io_add_watch(

2729

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

2730

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

2731

functools.partial(self.handle_ipc,

2732

parent_pipe=parent_pipe,

2733

proc=proc,

2734

client_object=client))

2067

2068

gobject.io_add_watch(parent_pipe.fileno(),

2069

gobject.IO_IN | gobject.IO_HUP,

2070

functools.partial(self.handle_ipc,

2071

parent_pipe =

2072

parent_pipe,

2073

proc = proc,

2074

client_object =

2075

client))

2735

2076

parent_pipe.send(True)

2736

2077

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

2737

2078

# same fileno

2740

2081

funcname = request[1]

2741

2082

args = request[2]

2742

2083

kwargs = request[3]

2743

2084

2744

2085

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

2745

2086

funcname)(*args,

2746

**kwargs)))

2747

2087

**kwargs)))

2088

2748

2089

if command == 'getattr':

2749

2090

attrname = request[1]

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2091

if callable(client_object.__getattribute__(attrname)):

2092

parent_pipe.send(('function',))

2753

2093

else:

2754

parent_pipe.send((

2755

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

2756

2094

parent_pipe.send(('data', client_object

2095

.__getattribute__(attrname)))

2096

2757

2097

if command == 'setattr':

2758

2098

attrname = request[1]

2759

2099

value = request[2]

2760

2100

setattr(client_object, attrname, value)

2761

2101

2762

2102

return True

2763

2103

2764

2104

2765

2105

def rfc3339_duration_to_delta(duration):

2766

2106

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

2767

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

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

2781

True

2107

2108

>>> rfc3339_duration_to_delta("P7D")

2109

datetime.timedelta(7)

2110

>>> rfc3339_duration_to_delta("PT60S")

2111

datetime.timedelta(0, 60)

2112

>>> rfc3339_duration_to_delta("PT60M")

2113

datetime.timedelta(0, 3600)

2114

>>> rfc3339_duration_to_delta("PT24H")

2115

datetime.timedelta(1)

2116

>>> rfc3339_duration_to_delta("P1W")

2117

datetime.timedelta(7)

2118

>>> rfc3339_duration_to_delta("PT5M30S")

2119

datetime.timedelta(0, 330)

2120

>>> rfc3339_duration_to_delta("P1DT3M20S")

2121

datetime.timedelta(1, 200)

2782

2122

"""

2783

2123

2784

2124

# Parsing an RFC 3339 duration with regular expressions is not

2785

2125

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

2786

2126

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

2787

2127

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

2788

2128

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

2789

2129

# avoid excessive use of external libraries.

2790

2130

2791

2131

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

2792

Token = collections.namedtuple("Token", (

2793

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

2794

# a "group" containing digits

2795

"value", # datetime.timedelta or None

2796

"followers")) # Tokens valid after this token

2132

Token = collections.namedtuple("Token",

2133

("regexp", # To match token; if

2134

# "value" is not None,

2135

# must have a "group"

2136

# containing digits

2137

"value", # datetime.timedelta or

2138

# None

2139

"followers")) # Tokens valid after

2140

# this token

2797

2141

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

2798

2142

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

2799

2143

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

2800

2144

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

2801

2145

datetime.timedelta(seconds=1),

2802

frozenset((token_end, )))

2146

frozenset((token_end,)))

2803

2147

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

2804

2148

datetime.timedelta(minutes=1),

2805

2149

frozenset((token_second, token_end)))

2821

2165

frozenset((token_month, token_end)))

2822

2166

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

2823

2167

datetime.timedelta(weeks=1),

2824

frozenset((token_end, )))

2168

frozenset((token_end,)))

2825

2169

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

2826

2170

frozenset((token_year, token_month,

2827

2171

token_day, token_time,

2828

2172

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2832

2175

found_token = None

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2176

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

2177

s = duration # String left to parse

2837

2178

# Loop until end token is found

2838

2179

while found_token is not token_end:

2839

2180

# Search for any currently valid tokens

2855

2196

break

2856

2197

else:

2857

2198

# No currently valid tokens were found

2858

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

2859

.format(duration))

2199

raise ValueError("Invalid RFC 3339 duration")

2860

2200

# End token found

2861

2201

return value

2862

2202

2863

2203

2864

2204

def string_to_delta(interval):

2865

2205

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

2866

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2877

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

2878

True

2206

2207

>>> string_to_delta('7d')

2208

datetime.timedelta(7)

2209

>>> string_to_delta('60s')

2210

datetime.timedelta(0, 60)

2211

>>> string_to_delta('60m')

2212

datetime.timedelta(0, 3600)

2213

>>> string_to_delta('24h')

2214

datetime.timedelta(1)

2215

>>> string_to_delta('1w')

2216

datetime.timedelta(7)

2217

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

2218

datetime.timedelta(0, 330)

2879

2219

"""

2880

2220

2881

2221

try:

2882

2222

return rfc3339_duration_to_delta(interval)

2883

2223

except ValueError:

2884

2224

pass

2885

2225

2886

2226

timevalue = datetime.timedelta(0)

2887

2227

for s in interval.split():

2888

2228

try:

2889

suffix = s[-1]

2229

suffix = unicode(s[-1])

2890

2230

value = int(s[:-1])

2891

2231

if suffix == "d":

2892

2232

delta = datetime.timedelta(value)

2899

2239

elif suffix == "w":

2900

2240

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

2901

2241

else:

2902

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

2242

raise ValueError("Unknown suffix {!r}"

2243

.format(suffix))

2903

2244

except IndexError as e:

2904

2245

raise ValueError(*(e.args))

2905

2246

timevalue += delta

2906

2247

return timevalue

2907

2248

2908

2249

2909

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

2250

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

2910

2251

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

2911

2252

2912

2253

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

2913

2254

if os.fork():

2914

2255

sys.exit()

2921

2262

# Close all standard open file descriptors

2922

2263

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

2923

2264

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

2924

raise OSError(errno.ENODEV,

2925

"{} not a character device"

2265

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

2926

2266

.format(os.devnull))

2927

2267

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

2928

2268

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

2932

2272

2933

2273

2934

2274

def main():

2935

2275

2936

2276

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

2937

2277

# Parsing of options, both command line and config file

2938

2278

2939

2279

parser = argparse.ArgumentParser()

2940

2280

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

2941

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

2281

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

2942

2282

help="show version number and exit")

2943

2283

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

2944

2284

help="Bind to interface IF")

2980

2320

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

2981

2321

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

2982

2322

default=None)

2983

2323

2984

2324

options = parser.parse_args()

2985

2325

2326

if options.check:

2327

import doctest

2328

fail_count, test_count = doctest.testmod()

2329

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

2330

2986

2331

# Default values for config file for server-global settings

2987

if gnutls.has_rawpk:

2988

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

2989

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

2990

else:

2991

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

2992

":+SIGN-DSA-SHA256")

2993

server_defaults = {"interface": "",

2994

"address": "",

2995

"port": "",

2996

"debug": "False",

2997

"priority": priority,

2998

"servicename": "Mandos",

2999

"use_dbus": "True",

3000

"use_ipv6": "True",

3001

"debuglevel": "",

3002

"restore": "True",

3003

"socket": "",

3004

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

3005

"foreground": "False",

3006

"zeroconf": "True",

3007

}

3008

del priority

3009

2332

server_defaults = { "interface": "",

2333

"address": "",

2334

"port": "",

2335

"debug": "False",

2336

"priority":

2337

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

2338

"servicename": "Mandos",

2339

"use_dbus": "True",

2340

"use_ipv6": "True",

2341

"debuglevel": "",

2342

"restore": "True",

2343

"socket": "",

2344

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

2345

"foreground": "False",

2346

"zeroconf": "True",

2347

}

2348

3010

2349

# Parse config file for server-global settings

3011

server_config = configparser.ConfigParser(server_defaults)

2350

server_config = configparser.SafeConfigParser(server_defaults)

3012

2351

del server_defaults

3013

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

3014

# Convert the ConfigParser object to a dict

2352

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

2353

"mandos.conf"))

2354

# Convert the SafeConfigParser object to a dict

3015

2355

server_settings = server_config.defaults()

3016

2356

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

3017

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

3018

"foreground", "zeroconf"):

2357

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

3019

2358

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

3020

2359

option)

3021

2360

if server_settings["port"]:

3031

2370

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

3032

2371

["socket"])

3033

2372

del server_config

3034

2373

3035

2374

# Override the settings from the config file with command line

3036

2375

# options, if set.

3037

2376

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

3038

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

3039

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

3040

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

2377

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

2378

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

2379

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

3041

2380

value = getattr(options, option)

3042

2381

if value is not None:

3043

2382

server_settings[option] = value

3044

2383

del options

3045

2384

# Force all strings to be unicode

3046

2385

for option in server_settings.keys():

3047

if isinstance(server_settings[option], bytes):

3048

server_settings[option] = (server_settings[option]

3049

.decode("utf-8"))

2386

if type(server_settings[option]) is str:

2387

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

3050

2388

# Force all boolean options to be boolean

3051

2389

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

3052

2390

"foreground", "zeroconf"):

3055

2393

if server_settings["debug"]:

3056

2394

server_settings["foreground"] = True

3057

2395

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

3058

2396

3059

2397

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

3060

3061

if (not server_settings["zeroconf"]

3062

and not (server_settings["port"]

3063

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

3064

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

3065

2398

2399

if (not server_settings["zeroconf"] and

2400

not (server_settings["port"]

2401

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

2402

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

2403

" Zeroconf")

2404

3066

2405

# For convenience

3067

2406

debug = server_settings["debug"]

3068

2407

debuglevel = server_settings["debuglevel"]

3072

2411

stored_state_file)

3073

2412

foreground = server_settings["foreground"]

3074

2413

zeroconf = server_settings["zeroconf"]

3075

2414

3076

2415

if debug:

3077

2416

initlogger(debug, logging.DEBUG)

3078

2417

else:

3081

2420

else:

3082

2421

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

3083

2422

initlogger(debug, level)

3084

2423

3085

2424

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

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2425

syslogger.setFormatter(logging.Formatter

2426

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

2427

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

2428

.format(server_settings

2429

["servicename"])))

2430

3091

2431

# Parse config file with clients

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2432

client_config = configparser.SafeConfigParser(Client

2433

.client_defaults)

3093

2434

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

3094

2435

"clients.conf"))

3095

2436

3096

2437

global mandos_dbus_service

3097

2438

mandos_dbus_service = None

3098

2439

3099

2440

socketfd = None

3100

2441

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

3101

2442

socketfd = server_settings["socket"]

3102

tcp_server = MandosServer(

3103

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

3104

ClientHandler,

3105

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

3106

use_ipv6=use_ipv6,

3107

gnutls_priority=server_settings["priority"],

3108

use_dbus=use_dbus,

3109

socketfd=socketfd)

2443

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

2444

server_settings["port"]),

2445

ClientHandler,

2446

interface=(server_settings["interface"]

2447

or None),

2448

use_ipv6=use_ipv6,

2449

gnutls_priority=

2450

server_settings["priority"],

2451

use_dbus=use_dbus,

2452

socketfd=socketfd)

3110

2453

if not foreground:

3111

2454

pidfilename = "/run/mandos.pid"

3112

2455

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

3113

2456

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

3114

2457

pidfile = None

3115

2458

try:

3116

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

2459

pidfile = open(pidfilename, "w")

3117

2460

except IOError as e:

3118

2461

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

3119

2462

exc_info=e)

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2463

2464

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

3124

2465

try:

3125

2466

uid = pwd.getpwnam(name).pw_uid

3126

gid = pwd.getpwnam(group).pw_gid

2467

gid = pwd.getpwnam(name).pw_gid

3127

2468

break

3128

2469

except KeyError:

3129

2470

continue

3133

2474

try:

3134

2475

os.setgid(gid)

3135

2476

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

3139

2477

except OSError as error:

3140

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

3141

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

3142

2478

if error.errno != errno.EPERM:

3143

2479

raise

3144

2480

3145

2481

if debug:

3146

2482

# Enable all possible GnuTLS debugging

3147

2483

3148

2484

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

3149

2485

# - GnuTLS manual

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2486

gnutls.library.functions.gnutls_global_set_log_level(11)

2487

2488

@gnutls.library.types.gnutls_log_func

3153

2489

def debug_gnutls(level, string):

3154

2490

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

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2491

2492

(gnutls.library.functions

2493

.gnutls_global_set_log_function(debug_gnutls))

2494

3158

2495

# Redirect stdin so all checkers get /dev/null

3159

2496

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

3160

2497

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

3161

2498

if null > 2:

3162

2499

os.close(null)

3163

2500

3164

2501

# Need to fork before connecting to D-Bus

3165

2502

if not foreground:

3166

2503

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

3167

2504

daemon()

3168

3169

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

3170

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

3171

# need to inform GLib that threads will be used.

3172

GLib.threads_init()

3173

2505

2506

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

2507

# need to inform gobject that threads will be used.

2508

gobject.threads_init()

2509

3174

2510

global main_loop

3175

2511

# From the Avahi example code

3176

2512

DBusGMainLoop(set_as_default=True)

3177

main_loop = GLib.MainLoop()

2513

main_loop = gobject.MainLoop()

3178

2514

bus = dbus.SystemBus()

3179

2515

# End of Avahi example code

3180

2516

if use_dbus:

3181

2517

try:

3182

2518

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

3183

bus,

3184

do_not_queue=True)

3185

old_bus_name = dbus.service.BusName(

3186

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

3187

do_not_queue=True)

3188

except dbus.exceptions.DBusException as e:

2519

bus, do_not_queue=True)

2520

old_bus_name = (dbus.service.BusName

2521

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

2522

do_not_queue=True))

2523

except dbus.exceptions.NameExistsException as e:

3189

2524

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

3190

2525

use_dbus = False

3191

2526

server_settings["use_dbus"] = False

3192

2527

tcp_server.use_dbus = False

3193

2528

if zeroconf:

3194

2529

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

2530

service = AvahiServiceToSyslog(name =

2531

server_settings["servicename"],

2532

servicetype = "_mandos._tcp",

2533

protocol = protocol, bus = bus)

3200

2534

if server_settings["interface"]:

3201

service.interface = if_nametoindex(

3202

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

3203

2535

service.interface = (if_nametoindex

2536

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

2537

3204

2538

global multiprocessing_manager

3205

2539

multiprocessing_manager = multiprocessing.Manager()

3206

2540

3207

2541

client_class = Client

3208

2542

if use_dbus:

3209

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

3210

2543

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

2544

3211

2545

client_settings = Client.config_parser(client_config)

3212

2546

old_client_settings = {}

3213

2547

clients_data = {}

3214

2548

3215

2549

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

3216

2550

global wnull

3217

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

2551

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

3218

2552

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

3219

2553

# mode

3220

2554

if debug or not foreground:

3221

2555

wnull.close()

3222

2556

3223

2557

# Get client data and settings from last running state.

3224

2558

if server_settings["restore"]:

3225

2559

try:

3226

2560

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

3227

if sys.version_info.major == 2:

3228

clients_data, old_client_settings = pickle.load(

3229

stored_state)

3230

else:

3231

bytes_clients_data, bytes_old_client_settings = (

3232

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

3233

# Fix bytes to strings

3234

# clients_data

3235

# .keys()

3236

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

3237

if isinstance(key, bytes)

3238

else key): value

3239

for key, value in

3240

bytes_clients_data.items()}

3241

del bytes_clients_data

3242

for key in clients_data:

3243

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

3244

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

3245

for k, v in

3246

clients_data[key].items()}

3247

clients_data[key] = value

3248

# .client_structure

3249

value["client_structure"] = [

3250

(s.decode("utf-8")

3251

if isinstance(s, bytes)

3252

else s) for s in

3253

value["client_structure"]]

3254

# .name, .host, and .checker_command

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host and .checker_command

3272

for value in old_client_settings.values():

3273

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

3274

if isinstance(value[attribute], bytes):

3275

value[attribute] = (value[attribute]

3276

.decode("utf-8"))

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3277

2563

os.remove(stored_state_path)

3278

2564

except IOError as e:

3279

2565

if e.errno == errno.ENOENT:

3280

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

3281

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

2566

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

2567

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

3282

2568

else:

3283

2569

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

3284

2570

exc_info=e)

3285

2571

raise

3286

2572

except EOFError as e:

3287

2573

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

3288

"EOFError:",

3289

exc_info=e)

3290

2574

"EOFError:", exc_info=e)

2575

3291

2576

with PGPEngine() as pgp:

3292

2577

for client_name, client in clients_data.items():

3293

2578

# Skip removed clients

3294

2579

if client_name not in client_settings:

3295

2580

continue

3296

2581

3297

2582

# Decide which value to use after restoring saved state.

3298

2583

# We have three different values: Old config file,

3299

2584

# new config file, and saved state.

3304

2589

# For each value in new config, check if it

3305

2590

# differs from the old config value (Except for

3306

2591

# the "secret" attribute)

3307

if (name != "secret"

3308

and (value !=

3309

old_client_settings[client_name][name])):

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3310

2595

client[name] = value

3311

2596

except KeyError:

3312

2597

pass

3313

2598

3314

2599

# Clients who has passed its expire date can still be

3315

# enabled if its last checker was successful. A Client

2600

# enabled if its last checker was successful. Clients

3316

2601

# whose checker succeeded before we stored its state is

3317

2602

# assumed to have successfully run all checkers during

3318

2603

# downtime.

3321

2606

if not client["last_checked_ok"]:

3322

2607

logger.warning(

3323

2608

"disabling client {} - Client never "

3324

"performed a successful checker".format(

3325

client_name))

2609

"performed a successful checker"

2610

.format(client_name))

3326

2611

client["enabled"] = False

3327

2612

elif client["last_checker_status"] != 0:

3328

2613

logger.warning(

3329

2614

"disabling client {} - Client last"

3330

" checker failed with error code"

3331

" {}".format(

3332

client_name,

3333

client["last_checker_status"]))

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3334

2618

client["enabled"] = False

3335

2619

else:

3336

client["expires"] = (

3337

datetime.datetime.utcnow()

3338

+ client["timeout"])

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3339

2623

logger.debug("Last checker succeeded,"

3340

" keeping {} enabled".format(

3341

client_name))

2624

" keeping {} enabled"

2625

.format(client_name))

3342

2626

try:

3343

client["secret"] = pgp.decrypt(

3344

client["encrypted_secret"],

3345

client_settings[client_name]["secret"])

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3346

2631

except PGPError:

3347

2632

# If decryption fails, we use secret from new settings

3348

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

3349

client_name))

3350

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

3351

["secret"])

3352

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3353

2638

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

3354

2639

for client_name in (set(old_client_settings)

3355

2640

- set(client_settings)):

3357

2642

for client_name in (set(client_settings)

3358

2643

- set(old_client_settings)):

3359

2644

clients_data[client_name] = client_settings[client_name]

3360

2645

3361

2646

# Create all client objects

3362

2647

for client_name, client in clients_data.items():

3363

2648

tcp_server.clients[client_name] = client_class(

3364

name=client_name,

3365

settings=client,

3366

server_settings=server_settings)

3367

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3368

2652

if not tcp_server.clients:

3369

2653

logger.warning("No clients defined")

3370

2654

3371

2655

if not foreground:

3372

2656

if pidfile is not None:

3373

pid = os.getpid()

3374

2657

try:

3375

2658

with pidfile:

3376

print(pid, file=pidfile)

2659

pid = os.getpid()

2660

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

3377

2661

except IOError:

3378

2662

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

3379

2663

pidfilename, pid)

3380

2664

del pidfile

3381

2665

del pidfilename

3382

3383

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

3384

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3385

lambda: main_loop.quit() and False)

3386

2666

2667

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

2668

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

2669

3387

2670

if use_dbus:

3388

3389

@alternate_dbus_interfaces(

3390

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

3391

class MandosDBusService(DBusObjectWithObjectManager):

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3392

2674

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

3393

3394

2675

def __init__(self):

3395

2676

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

3396

3397

2677

_interface = "se.recompile.Mandos"

3398

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3399

2685

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

3400

2686

def ClientAdded(self, objpath):

3401

2687

"D-Bus signal"

3402

2688

pass

3403

2689

3404

2690

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

3405

def ClientNotFound(self, key_id, address):

2691

def ClientNotFound(self, fingerprint, address):

3406

2692

"D-Bus signal"

3407

2693

pass

3408

3409

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

3410

"true"})

2694

3411

2695

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

3412

2696

def ClientRemoved(self, objpath, name):

3413

2697

"D-Bus signal"

3414

2698

pass

3415

3416

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

3417

"true"})

2699

3418

2700

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

3419

2701

def GetAllClients(self):

3420

2702

"D-Bus method"

3421

return dbus.Array(c.dbus_object_path for c in

3422

tcp_server.clients.values())

3423

3424

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

3425

"true"})

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3426

2707

@dbus.service.method(_interface,

3427

2708

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

3428

2709

def GetAllClientsWithProperties(self):

3429

2710

"D-Bus method"

3430

2711

return dbus.Dictionary(

3431

{c.dbus_object_path: c.GetAll(

3432

"se.recompile.Mandos.Client")

3433

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

2712

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

2713

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

3434

2714

signature="oa{sv}")

3435

2715

3436

2716

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

3437

2717

def RemoveClient(self, object_path):

3438

2718

"D-Bus method"

3439

for c in tcp_server.clients.values():

2719

for c in tcp_server.clients.itervalues():

3440

2720

if c.dbus_object_path == object_path:

3441

2721

del tcp_server.clients[c.name]

3442

2722

c.remove_from_connection()

3443

# Don't signal the disabling

2723

# Don't signal anything except ClientRemoved

3444

2724

c.disable(quiet=True)

3445

# Emit D-Bus signal for removal

3446

self.client_removed_signal(c)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3447

2727

return

3448

2728

raise KeyError(object_path)

3449

2729

3450

2730

del _interface

3451

3452

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3453

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

3454

def GetManagedObjects(self):

3455

"""D-Bus method"""

3456

return dbus.Dictionary(

3457

{client.dbus_object_path:

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()})

3462

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

3463

3464

def client_added_signal(self, client):

3465

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

3466

if use_dbus:

3467

# New standard signal

3468

self.InterfacesAdded(

3469

client.dbus_object_path,

3470

dbus.Dictionary(

3471

{interface: client.GetAll(interface)

3472

for interface in

3473

client._get_all_interface_names()}))

3474

# Old signal

3475

self.ClientAdded(client.dbus_object_path)

3476

3477

def client_removed_signal(self, client):

3478

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

3479

if use_dbus:

3480

# New standard signal

3481

self.InterfacesRemoved(

3482

client.dbus_object_path,

3483

client._get_all_interface_names())

3484

# Old signal

3485

self.ClientRemoved(client.dbus_object_path,

3486

client.name)

3487

2731

3488

2732

mandos_dbus_service = MandosDBusService()

3489

3490

# Save modules to variables to exempt the modules from being

3491

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

3492

mp = multiprocessing

3493

wn = wnull

3494

2733

3495

2734

def cleanup():

3496

2735

"Cleanup function; run on exit"

3497

2736

if zeroconf:

3498

2737

service.cleanup()

3499

3500

mp.active_children()

3501

wn.close()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3502

2741

if not (tcp_server.clients or client_settings):

3503

2742

return

3504

2743

3505

2744

# Store client before exiting. Secrets are encrypted with key

3506

2745

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

3507

2746

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

3508

2747

clients = {}

3509

2748

with PGPEngine() as pgp:

3510

for client in tcp_server.clients.values():

2749

for client in tcp_server.clients.itervalues():

3511

2750

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

3512

2751

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

3513

2752

key)

3514

2753

client_dict = {}

3515

2754

3516

2755

# A list of attributes that can not be pickled

3517

2756

# + secret.

3518

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

3519

"checker", "server_settings"}

3520

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

3521

.Object):

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3522

2761

exclude.add(name)

3523

2762

3524

2763

client_dict["encrypted_secret"] = (client

3525

2764

.encrypted_secret)

3526

2765

for attr in client.client_structure:

3527

2766

if attr not in exclude:

3528

2767

client_dict[attr] = getattr(client, attr)

3529

2768

3530

2769

clients[client.name] = client_dict

3531

2770

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

3532

2771

3533

2772

try:

3534

with tempfile.NamedTemporaryFile(

3535

mode='wb',

3536

suffix=".pickle",

3537

prefix='clients-',

3538

dir=os.path.dirname(stored_state_path),

3539

delete=False) as stored_state:

3540

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

3541

protocol=2)

3542

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

3543

2779

os.rename(tempname, stored_state_path)

3544

2780

except (IOError, OSError) as e:

3545

2781

if not debug:

3554

2790

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

3555

2791

exc_info=e)

3556

2792

raise

3557

2793

3558

2794

# Delete all clients, and settings from config

3559

2795

while tcp_server.clients:

3560

2796

name, client = tcp_server.clients.popitem()

3561

2797

if use_dbus:

3562

2798

client.remove_from_connection()

3563

# Don't signal the disabling

2799

# Don't signal anything except ClientRemoved

3564

2800

client.disable(quiet=True)

3565

# Emit D-Bus signal for removal

3566

2801

if use_dbus:

3567

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)

3568

2806

client_settings.clear()

3569

2807

3570

2808

atexit.register(cleanup)

3571

3572

for client in tcp_server.clients.values():

2809

2810

for client in tcp_server.clients.itervalues():

3573

2811

if use_dbus:

3574

# Emit D-Bus signal for adding

3575

mandos_dbus_service.client_added_signal(client)

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3576

2814

# Need to initiate checking of clients

3577

2815

if client.enabled:

3578

2816

client.init_checker()

3579

2817

3580

2818

tcp_server.enable()

3581

2819

tcp_server.server_activate()

3582

2820

3583

2821

# Find out what port we got

3584

2822

if zeroconf:

3585

2823

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

3590

2828

else: # IPv4

3591

2829

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

3592

2830

*tcp_server.socket.getsockname())

3593

3594

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

3595

2831

2832

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

2833

3596

2834

try:

3597

2835

if zeroconf:

3598

2836

# From the Avahi example code

3603

2841

cleanup()

3604

2842

sys.exit(1)

3605

2843

# End of Avahi example code

3606

3607

GLib.io_add_watch(

3608

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

3609

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3610

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

3611

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

3612

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

3613

2850

logger.debug("Starting main loop")

3614

2851

main_loop.run()

3615

2852

except AvahiError as error:

3624

2861

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

3625

2862

cleanup()

3626

2863

3627

3628

def should_only_run_tests():

3629

parser = argparse.ArgumentParser(add_help=False)

3630

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

3631

args, unknown_args = parser.parse_known_args()

3632

run_tests = args.check

3633

if run_tests:

3634

# Remove --check argument from sys.argv

3635

sys.argv[1:] = unknown_args

3636

return run_tests

3637

3638

# Add all tests from doctest strings

3639

def load_tests(loader, tests, none):

3640

import doctest

3641

tests.addTests(doctest.DocTestSuite())

3642

return tests

3643

3644

2864

if __name__ == '__main__':

3645

try:

3646

if should_only_run_tests():

3647

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

3648

unittest.main()

3649

else:

3650

main()

3651

finally:

3652

logging.shutdown()

2865

main()