/mandos/trunk : revision 738.1.1

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

72

84

73

import dbus

85

74

import dbus.service

86

import gi

87

from gi.repository import GLib

75

import gobject

76

import avahi

88

77

from dbus.mainloop.glib import DBusGMainLoop

89

78

import ctypes

90

79

import ctypes.util

91

80

import xml.dom.minidom

92

81

import inspect

93

82

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.14"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

147

95

stored_state_file = "clients.pickle"

148

96

149

97

logger = logging.getLogger()

150

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

151

98

syslogger = None

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

165

112

return interface_index

166

113

167

114

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

115

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

185

116

"""init logger and add loglevel"""

186

117

187

118

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

191

123

syslogger.setFormatter(logging.Formatter

192

124

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

193

125

' %(message)s'))

194

126

logger.addHandler(syslogger)

195

127

196

128

if debug:

197

129

console = logging.StreamHandler()

198

130

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

208

140

pass

209

141

210

142

211

class PGPEngine:

143

class PGPEngine(object):

212

144

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

213

214

145

def __init__(self):

215

146

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

147

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

148

'--home', self.tempdir,

229

149

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

150

'--quiet',

151

'--no-use-agent']

152

235

153

def __enter__(self):

236

154

return self

237

155

238

156

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

239

157

self._cleanup()

240

158

return False

241

159

242

160

def __del__(self):

243

161

self._cleanup()

244

162

245

163

def _cleanup(self):

246

164

if self.tempdir is not None:

247

165

# Delete contents of tempdir

248

166

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

249

topdown=False):

167

topdown = False):

250

168

for filename in files:

251

169

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

252

170

for dirname in dirs:

254

172

# Remove tempdir

255

173

os.rmdir(self.tempdir)

256

174

self.tempdir = None

257

175

258

176

def password_encode(self, password):

259

177

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

260

178

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

265

183

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

266

184

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

267

185

return encoded

268

186

269

187

def encrypt(self, data, password):

270

188

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

273

191

passfile.write(passphrase)

274

192

passfile.flush()

275

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

193

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

276

194

'--passphrase-file',

277

195

passfile.name]

278

196

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

283

201

if proc.returncode != 0:

284

202

raise PGPError(err)

285

203

return ciphertext

286

204

287

205

def decrypt(self, data, password):

288

206

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

291

209

passfile.write(passphrase)

292

210

passfile.flush()

293

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

211

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

294

212

'--passphrase-file',

295

213

passfile.name]

296

214

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

301

220

if proc.returncode != 0:

302

221

raise PGPError(err)

303

222

return decrypted_plaintext

304

223

305

224

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

225

class AvahiError(Exception):

333

226

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

334

227

self.value = value

335

228

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

336

229

**kwargs)

337

230

338

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

277

394

278

def rename(self, remove=True):

395

279

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

396

280

if self.rename_count >= self.max_renames:

398

282

" after %i retries, exiting.",

399

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

403

287

self.rename_count += 1

404

288

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

405

289

self.name)

416

300

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

417

301

self.cleanup()

418

302

os._exit(1)

419

303

420

304

def remove(self):

421

305

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

422

306

if self.entry_group_state_changed_match is not None:

424

308

self.entry_group_state_changed_match = None

425

309

if self.group is not None:

426

310

self.group.Reset()

427

311

428

312

def add(self):

429

313

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

430

314

self.remove()

447

331

dbus.UInt16(self.port),

448

332

avahi.string_array_to_txt_array(self.TXT))

449

333

self.group.Commit()

450

334

451

335

def entry_group_state_changed(self, state, error):

452

336

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

453

337

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

454

338

455

339

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

340

logger.debug("Zeroconf service established.")

457

341

elif state == avahi.ENTRY_GROUP_COLLISION:

460

344

elif state == avahi.ENTRY_GROUP_FAILURE:

461

345

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

462

346

str(error))

463

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

464

347

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

348

.format(error))

349

465

350

def cleanup(self):

466

351

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

467

352

if self.group is not None:

472

357

pass

473

358

self.group = None

474

359

self.remove()

475

360

476

361

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

477

362

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

478

363

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

485

371

if state in bad_states:

486

372

if bad_states[state] is not None:

487

373

if error is None:

490

376

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

491

377

self.cleanup()

492

378

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

379

self.add()

505

380

else:

506

381

if error is None:

507

382

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

508

383

else:

509

384

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

510

385

511

386

def activate(self):

512

387

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

513

388

if self.server is None:

517

392

follow_name_owner_changes=True),

518

393

avahi.DBUS_INTERFACE_SERVER)

519

394

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

395

self.server_state_changed)

521

396

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

522

397

523

398

524

399

class AvahiServiceToSyslog(AvahiService):

525

400

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

526

401

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

402

ret = AvahiService.rename(self, *args, **kwargs)

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

532

407

return ret

533

408

534

409

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class _session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(_session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class _openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code).decode(

598

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

599

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

600

message, *args)

601

602

class CertificateSecurityError(Error):

603

pass

604

605

class PointerTo:

606

def __init__(self, cls):

607

self.cls = cls

608

609

def from_param(self, obj):

610

if not isinstance(obj, self.cls):

611

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

612

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

613

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

614

615

class CastToVoidPointer:

616

def __init__(self, cls):

617

self.cls = cls

618

619

def from_param(self, obj):

620

if not isinstance(obj, self.cls):

621

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

622

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

623

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

624

625

class With_from_param:

626

@classmethod

627

def from_param(cls, obj):

628

return obj._as_parameter_

629

630

# Classes

631

class Credentials(With_from_param):

632

def __init__(self):

633

self._as_parameter_ = gnutls.certificate_credentials_t()

634

gnutls.certificate_allocate_credentials(self)

635

self.type = gnutls.CRD_CERTIFICATE

636

637

def __del__(self):

638

gnutls.certificate_free_credentials(self)

639

640

class ClientSession(With_from_param):

641

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

642

self._as_parameter_ = gnutls.session_t()

643

gnutls_flags = gnutls.CLIENT

644

if gnutls.check_version(b"3.5.6"):

645

gnutls_flags |= gnutls.NO_TICKETS

646

if gnutls.has_rawpk:

647

gnutls_flags |= gnutls.ENABLE_RAWPK

648

gnutls.init(self, gnutls_flags)

649

del gnutls_flags

650

gnutls.set_default_priority(self)

651

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

652

gnutls.handshake_set_private_extensions(self, True)

653

self.socket = socket

654

if credentials is None:

655

credentials = gnutls.Credentials()

656

gnutls.credentials_set(self, credentials.type,

657

credentials)

658

self.credentials = credentials

659

660

def __del__(self):

661

gnutls.deinit(self)

662

663

def handshake(self):

664

return gnutls.handshake(self)

665

666

def send(self, data):

667

data = bytes(data)

668

data_len = len(data)

669

while data_len > 0:

670

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

671

data_len)

672

673

def bye(self):

674

return gnutls.bye(self, gnutls.SHUT_RDWR)

675

676

# Error handling functions

677

def _error_code(result):

678

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

679

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

680

if result >= gnutls.E_SUCCESS:

681

return result

682

if result == gnutls.E_NO_CERTIFICATE_FOUND:

683

raise gnutls.CertificateSecurityError(code=result)

684

raise gnutls.Error(code=result)

685

686

def _retry_on_error(result, func, arguments,

687

_error_code=_error_code):

688

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

689

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

690

while result < gnutls.E_SUCCESS:

691

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

692

return _error_code(result)

693

result = func(*arguments)

694

return result

695

696

# Unless otherwise indicated, the function declarations below are

697

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

698

699

# Functions

700

priority_set_direct = _library.gnutls_priority_set_direct

701

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

702

ctypes.POINTER(ctypes.c_char_p)]

703

priority_set_direct.restype = _error_code

704

705

init = _library.gnutls_init

706

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

707

init.restype = _error_code

708

709

set_default_priority = _library.gnutls_set_default_priority

710

set_default_priority.argtypes = [ClientSession]

711

set_default_priority.restype = _error_code

712

713

record_send = _library.gnutls_record_send

714

record_send.argtypes = [ClientSession, ctypes.c_void_p,

715

ctypes.c_size_t]

716

record_send.restype = ctypes.c_ssize_t

717

record_send.errcheck = _retry_on_error

718

719

certificate_allocate_credentials = (

720

_library.gnutls_certificate_allocate_credentials)

721

certificate_allocate_credentials.argtypes = [

722

PointerTo(Credentials)]

723

certificate_allocate_credentials.restype = _error_code

724

725

certificate_free_credentials = (

726

_library.gnutls_certificate_free_credentials)

727

certificate_free_credentials.argtypes = [Credentials]

728

certificate_free_credentials.restype = None

729

730

handshake_set_private_extensions = (

731

_library.gnutls_handshake_set_private_extensions)

732

handshake_set_private_extensions.argtypes = [ClientSession,

733

ctypes.c_int]

734

handshake_set_private_extensions.restype = None

735

736

credentials_set = _library.gnutls_credentials_set

737

credentials_set.argtypes = [ClientSession, credentials_type_t,

738

CastToVoidPointer(Credentials)]

739

credentials_set.restype = _error_code

740

741

strerror = _library.gnutls_strerror

742

strerror.argtypes = [ctypes.c_int]

743

strerror.restype = ctypes.c_char_p

744

745

certificate_type_get = _library.gnutls_certificate_type_get

746

certificate_type_get.argtypes = [ClientSession]

747

certificate_type_get.restype = _error_code

748

749

certificate_get_peers = _library.gnutls_certificate_get_peers

750

certificate_get_peers.argtypes = [ClientSession,

751

ctypes.POINTER(ctypes.c_uint)]

752

certificate_get_peers.restype = ctypes.POINTER(datum_t)

753

754

global_set_log_level = _library.gnutls_global_set_log_level

755

global_set_log_level.argtypes = [ctypes.c_int]

756

global_set_log_level.restype = None

757

758

global_set_log_function = _library.gnutls_global_set_log_function

759

global_set_log_function.argtypes = [log_func]

760

global_set_log_function.restype = None

761

762

deinit = _library.gnutls_deinit

763

deinit.argtypes = [ClientSession]

764

deinit.restype = None

765

766

handshake = _library.gnutls_handshake

767

handshake.argtypes = [ClientSession]

768

handshake.restype = ctypes.c_int

769

handshake.errcheck = _retry_on_error

770

771

transport_set_ptr = _library.gnutls_transport_set_ptr

772

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

773

transport_set_ptr.restype = None

774

775

bye = _library.gnutls_bye

776

bye.argtypes = [ClientSession, close_request_t]

777

bye.restype = ctypes.c_int

778

bye.errcheck = _retry_on_error

779

780

check_version = _library.gnutls_check_version

781

check_version.argtypes = [ctypes.c_char_p]

782

check_version.restype = ctypes.c_char_p

783

784

_need_version = b"3.3.0"

785

if check_version(_need_version) is None:

786

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

787

.format(_need_version))

788

789

_tls_rawpk_version = b"3.6.6"

790

has_rawpk = bool(check_version(_tls_rawpk_version))

791

792

if has_rawpk:

793

# Types

794

class pubkey_st(ctypes.Structure):

795

_fields = []

796

pubkey_t = ctypes.POINTER(pubkey_st)

797

798

x509_crt_fmt_t = ctypes.c_int

799

800

# All the function declarations below are from

801

# gnutls/abstract.h

802

pubkey_init = _library.gnutls_pubkey_init

803

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

804

pubkey_init.restype = _error_code

805

806

pubkey_import = _library.gnutls_pubkey_import

807

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

808

x509_crt_fmt_t]

809

pubkey_import.restype = _error_code

810

811

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

812

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

813

ctypes.POINTER(ctypes.c_ubyte),

814

ctypes.POINTER(ctypes.c_size_t)]

815

pubkey_get_key_id.restype = _error_code

816

817

pubkey_deinit = _library.gnutls_pubkey_deinit

818

pubkey_deinit.argtypes = [pubkey_t]

819

pubkey_deinit.restype = None

820

else:

821

# All the function declarations below are from

822

# gnutls/openpgp.h

823

824

openpgp_crt_init = _library.gnutls_openpgp_crt_init

825

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

826

openpgp_crt_init.restype = _error_code

827

828

openpgp_crt_import = _library.gnutls_openpgp_crt_import

829

openpgp_crt_import.argtypes = [openpgp_crt_t,

830

ctypes.POINTER(datum_t),

831

openpgp_crt_fmt_t]

832

openpgp_crt_import.restype = _error_code

833

834

openpgp_crt_verify_self = \

835

_library.gnutls_openpgp_crt_verify_self

836

openpgp_crt_verify_self.argtypes = [

837

openpgp_crt_t,

838

ctypes.c_uint,

839

ctypes.POINTER(ctypes.c_uint),

840

]

841

openpgp_crt_verify_self.restype = _error_code

842

843

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

844

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

845

openpgp_crt_deinit.restype = None

846

847

openpgp_crt_get_fingerprint = (

848

_library.gnutls_openpgp_crt_get_fingerprint)

849

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

850

ctypes.c_void_p,

851

ctypes.POINTER(

852

ctypes.c_size_t)]

853

openpgp_crt_get_fingerprint.restype = _error_code

854

855

if check_version(b"3.6.4"):

856

certificate_type_get2 = _library.gnutls_certificate_type_get2

857

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

858

certificate_type_get2.restype = _error_code

859

860

# Remove non-public functions

861

del _error_code, _retry_on_error

862

863

864

def call_pipe(connection, # : multiprocessing.Connection

865

func, *args, **kwargs):

866

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

867

868

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

869

return value on the provided multiprocessing.Connection.

870

"""

871

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

872

connection.close()

873

874

875

class Client:

410

class Client(object):

876

411

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

877

412

878

413

Attributes:

879

414

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

880

415

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

881

416

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

882

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

883

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

884

running.

885

checker_callback_tag: a GLib event source tag, or None

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

886

421

checker_command: string; External command which is run to check

887

422

if client lives. %() expansions are done at

888

423

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

889

424

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

890

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

891

426

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

892

427

client_structure: Object describing what attributes a client has

893

428

and is used for storing the client at exit

894

429

current_checker_command: string; current running checker_command

895

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

896

431

enabled: bool()

897

432

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

898

uniquely identify an OpenPGP client

899

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

900

a client using raw public keys

433

uniquely identify the client

901

434

host: string; available for use by the checker command

902

435

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

903

436

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

905

438

last_checker_status: integer between 0 and 255 reflecting exit

906

439

status of last checker. -1 reflects crashed

907

440

checker, -2 means no checker completed yet.

908

last_checker_signal: The signal which killed the last checker, if

909

last_checker_status is -1

910

441

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

911

442

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

912

443

D-Bus identifiers

919

450

disabled, or None

920

451

server_settings: The server_settings dict from main()

921

452

"""

922

453

923

454

runtime_expansions = ("approval_delay", "approval_duration",

924

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

455

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

925

456

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

926

457

"last_approval_request", "last_checked_ok",

927

458

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

928

client_defaults = {

929

"timeout": "PT5M",

930

"extended_timeout": "PT15M",

931

"interval": "PT2M",

932

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

933

"host": "",

934

"approval_delay": "PT0S",

935

"approval_duration": "PT1S",

936

"approved_by_default": "True",

937

"enabled": "True",

938

}

939

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

940

470

@staticmethod

941

471

def config_parser(config):

942

472

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

949

479

for client_name in config.sections():

950

480

section = dict(config.items(client_name))

951

481

client = settings[client_name] = {}

952

482

953

483

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

954

484

# Reformat values from string types to Python types

955

485

client["approved_by_default"] = config.getboolean(

956

486

client_name, "approved_by_default")

957

487

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

958

488

"enabled")

959

960

# Uppercase and remove spaces from key_id and fingerprint

961

# for later comparison purposes with return value from the

962

# key_id() and fingerprint() functions

963

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

964

.replace(" ", ""))

489

965

490

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

966

491

.replace(" ", ""))

967

492

if "secret" in section:

968

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

969

.encode("utf-8"),

970

"base64")

493

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

971

494

elif "secfile" in section:

972

495

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

973

496

(section["secfile"])),

988

511

client["last_approval_request"] = None

989

512

client["last_checked_ok"] = None

990

513

client["last_checker_status"] = -2

991

514

992

515

return settings

993

994

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

516

517

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

995

518

self.name = name

996

519

if server_settings is None:

997

520

server_settings = {}

999

522

# adding all client settings

1000

523

for setting, value in settings.items():

1001

524

setattr(self, setting, value)

1002

525

1003

526

if self.enabled:

1004

527

if not hasattr(self, "last_enabled"):

1005

528

self.last_enabled = datetime.datetime.utcnow()

1009

532

else:

1010

533

self.last_enabled = None

1011

534

self.expires = None

1012

535

1013

536

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

1014

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

537

# Uppercase and remove spaces from fingerprint for later

538

# comparison purposes with return value from the fingerprint()

539

# function

1015

540

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

1016

541

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

1017

542

datetime.datetime.utcnow())

1018

543

1019

544

# attributes specific for this server instance

1020

545

self.checker = None

1021

546

self.checker_initiator_tag = None

1024

549

self.current_checker_command = None

1025

550

self.approved = None

1026

551

self.approvals_pending = 0

1027

self.changedstate = multiprocessing_manager.Condition(

1028

multiprocessing_manager.Lock())

1029

self.client_structure = [attr

1030

for attr in self.__dict__.keys()

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

1031

557

if not attr.startswith("_")]

1032

558

self.client_structure.append("client_structure")

1033

1034

for name, t in inspect.getmembers(

1035

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

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

1036

564

if not name.startswith("_"):

1037

565

self.client_structure.append(name)

1038

566

1039

567

# Send notice to process children that client state has changed

1040

568

def send_changedstate(self):

1041

569

with self.changedstate:

1042

570

self.changedstate.notify_all()

1043

571

1044

572

def enable(self):

1045

573

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

1046

574

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

1051

579

self.last_enabled = datetime.datetime.utcnow()

1052

580

self.init_checker()

1053

581

self.send_changedstate()

1054

582

1055

583

def disable(self, quiet=True):

1056

584

"""Disable this client."""

1057

585

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

1059

587

if not quiet:

1060

588

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

1061

589

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

1062

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

1063

591

self.disable_initiator_tag = None

1064

592

self.expires = None

1065

593

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

1066

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

1067

595

self.checker_initiator_tag = None

1068

596

self.stop_checker()

1069

597

self.enabled = False

1070

598

if not quiet:

1071

599

self.send_changedstate()

1072

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

600

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

1073

601

return False

1074

602

1075

603

def __del__(self):

1076

604

self.disable()

1077

605

1078

606

def init_checker(self):

1079

607

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

1080

608

# and every interval from then on.

1081

609

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

self.checker_initiator_tag = GLib.timeout_add(

1084

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

1085

+ 1)),

1086

self.start_checker)

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

1087

615

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

1088

616

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

1092

622

# Also start a new checker *right now*.

1093

623

self.start_checker()

1094

1095

def checker_callback(self, source, condition, connection,

1096

command):

624

625

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

1097

626

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

1098

# Read return code from connection (see call_pipe)

1099

returncode = connection.recv()

1100

connection.close()

1101

if self.checker is not None:

1102

self.checker.join()

1103

627

self.checker_callback_tag = None

1104

628

self.checker = None

1105

1106

if returncode >= 0:

1107

self.last_checker_status = returncode

1108

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1109

631

if self.last_checker_status == 0:

1110

632

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

1111

633

vars(self))

1112

634

self.checked_ok()

1113

635

else:

1114

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

636

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

637

vars(self))

1115

638

else:

1116

639

self.last_checker_status = -1

1117

self.last_checker_signal = -returncode

1118

640

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

1119

641

vars(self))

1120

return False

1121

642

1122

643

def checked_ok(self):

1123

644

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

1124

645

self.last_checked_ok = datetime.datetime.utcnow()

1125

646

self.last_checker_status = 0

1126

self.last_checker_signal = None

1127

647

self.bump_timeout()

1128

648

1129

649

def bump_timeout(self, timeout=None):

1130

650

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

1131

651

if timeout is None:

1132

652

timeout = self.timeout

1133

653

if self.disable_initiator_tag is not None:

1134

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1135

655

self.disable_initiator_tag = None

1136

656

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

1137

self.disable_initiator_tag = GLib.timeout_add(

1138

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1139

660

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

1140

661

1141

662

def need_approval(self):

1142

663

self.last_approval_request = datetime.datetime.utcnow()

1143

664

1144

665

def start_checker(self):

1145

666

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

1146

667

1147

668

If a checker already exists, leave it running and do

1148

669

nothing."""

1149

670

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

1154

675

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

1155

676

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

1156

677

# should be.

1157

1158

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

1159

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

1160

self.checker.join()

1161

self.checker = None

678

679

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

680

try:

681

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

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1162

693

# Start a new checker if needed

1163

694

if self.checker is None:

1164

695

# Escape attributes for the shell

1165

escaped_attrs = {

1166

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

1167

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1168

699

try:

1169

700

command = self.checker_command % escaped_attrs

1170

701

except TypeError as error:

1171

702

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

1172

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

721

self.checker = subprocess.Popen(command,

722

close_fds=True,

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

1173

727

exc_info=error)

1174

return True # Try again later

1175

self.current_checker_command = command

1176

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

1177

self.name)

1178

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

1179

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

1180

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

1181

# always replaced by /dev/null.)

1182

# The exception is when not debugging but nevertheless

1183

# running in the foreground; use the previously

1184

# created wnull.

1185

popen_args = {"close_fds": True,

1186

"shell": True,

1187

"cwd": "/"}

1188

if (not self.server_settings["debug"]

1189

and self.server_settings["foreground"]):

1190

popen_args.update({"stdout": wnull,

1191

"stderr": wnull})

1192

pipe = multiprocessing.Pipe(duplex=False)

1193

self.checker = multiprocessing.Process(

1194

target=call_pipe,

1195

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

1196

kwargs=popen_args)

1197

self.checker.start()

1198

self.checker_callback_tag = GLib.io_add_watch(

1199

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

1200

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1201

self.checker_callback, pipe[0], command)

1202

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

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

747

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

1203

748

return True

1204

749

1205

750

def stop_checker(self):

1206

751

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

1207

752

if self.checker_callback_tag:

1208

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1209

754

self.checker_callback_tag = None

1210

755

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

1211

756

return

1212

757

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

1213

self.checker.terminate()

758

try:

759

self.checker.terminate()

760

#time.sleep(0.5)

761

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

762

# self.checker.kill()

763

except OSError as error:

764

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

765

raise

1214

766

self.checker = None

1215

767

1216

768

1217

def dbus_service_property(dbus_interface,

1218

signature="v",

1219

access="readwrite",

1220

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1221

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1222

772

become properties on the D-Bus.

1223

773

1224

774

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

1225

775

and with one argument by "Set".

1226

776

1227

777

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

1228

778

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

1229

779

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

1233

783

if byte_arrays and signature != "ay":

1234

784

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

1235

785

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

1236

1237

786

def decorator(func):

1238

787

func._dbus_is_property = True

1239

788

func._dbus_interface = dbus_interface

1242

791

func._dbus_name = func.__name__

1243

792

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

1244

793

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

1245

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1246

795

return func

1247

1248

796

return decorator

1249

797

1250

798

1251

799

def dbus_interface_annotations(dbus_interface):

1252

800

"""Decorator for marking functions returning interface annotations

1253

801

1254

802

Usage:

1255

803

1256

804

@dbus_interface_annotations("org.example.Interface")

1257

805

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

1258

806

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

1259

807

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

1260

808

"false"}

1261

809

"""

1262

1263

810

def decorator(func):

1264

811

func._dbus_is_interface = True

1265

812

func._dbus_interface = dbus_interface

1266

813

func._dbus_name = dbus_interface

1267

814

return func

1268

1269

815

return decorator

1270

816

1271

817

1272

818

def dbus_annotations(annotations):

1273

819

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

1274

820

Usage:

1275

821

1276

822

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

1277

823

"org.freedesktop.DBus.Property."

1278

824

"EmitsChangedSignal": "false"})

1280

826

access="r")

1281

827

def Property_dbus_property(self):

1282

828

return dbus.Boolean(False)

1283

1284

See also the DBusObjectWithAnnotations class.

1285

829

"""

1286

1287

830

def decorator(func):

1288

831

func._dbus_annotations = annotations

1289

832

return func

1290

1291

833

return decorator

1292

834

1293

835

1296

838

"""

1297

839

pass

1298

840

1299

1300

841

class DBusPropertyAccessException(DBusPropertyException):

1301

842

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

1302

843

"""

1309

850

pass

1310

851

1311

852

1312

class DBusObjectWithAnnotations(dbus.service.Object):

1313

"""A D-Bus object with annotations.

1314

1315

Classes inheriting from this can use the dbus_annotations

1316

decorator to add annotations to methods or signals.

853

class DBusObjectWithProperties(dbus.service.Object):

854

"""A D-Bus object with properties.

855

856

Classes inheriting from this can use the dbus_service_property

857

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

858

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

1317

859

"""

1318

860

1319

861

@staticmethod

1320

862

def _is_dbus_thing(thing):

1321

863

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

1322

864

1323

865

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

1324

866

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

1325

867

"""

1326

868

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

1327

869

False)

1328

870

1329

871

def _get_all_dbus_things(self, thing):

1330

872

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

1331

873

"""

1332

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

874

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

875

name),

1333

876

athing.__get__(self))

1334

877

for cls in self.__class__.__mro__

1335

878

for name, athing in

1336

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

1337

1338

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1339

out_signature="s",

1340

path_keyword='object_path',

1341

connection_keyword='connection')

1342

def Introspect(self, object_path, connection):

1343

"""Overloading of standard D-Bus method.

1344

1345

Inserts annotation tags on methods and signals.

1346

"""

1347

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

1348

connection)

1349

try:

1350

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

1351

1352

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

1353

# Add annotation tags

1354

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

1355

for tag in if_tag.getElementsByTagName(typ):

1356

annots = dict()

1357

for name, prop in (self.

1358

_get_all_dbus_things(typ)):

1359

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

1360

and prop._dbus_interface

1361

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

1362

annots.update(getattr(

1363

prop, "_dbus_annotations", {}))

1364

for name, value in annots.items():

1365

ann_tag = document.createElement(

1366

"annotation")

1367

ann_tag.setAttribute("name", name)

1368

ann_tag.setAttribute("value", value)

1369

tag.appendChild(ann_tag)

1370

# Add interface annotation tags

1371

for annotation, value in dict(

1372

itertools.chain.from_iterable(

1373

annotations().items()

1374

for name, annotations

1375

in self._get_all_dbus_things("interface")

1376

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

1377

)).items():

1378

ann_tag = document.createElement("annotation")

1379

ann_tag.setAttribute("name", annotation)

1380

ann_tag.setAttribute("value", value)

1381

if_tag.appendChild(ann_tag)

1382

# Fix argument name for the Introspect method itself

1383

if (if_tag.getAttribute("name")

1384

== dbus.INTROSPECTABLE_IFACE):

1385

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

1386

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

1387

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

1388

if (arg.getAttribute("direction")

1389

== "out"):

1390

arg.setAttribute("name",

1391

"xml_data")

1392

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

1393

document.unlink()

1394

except (AttributeError, xml.dom.DOMException,

1395

xml.parsers.expat.ExpatError) as error:

1396

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

1397

exc_info=error)

1398

return xmlstring

1399

1400

1401

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1402

"""A D-Bus object with properties.

1403

1404

Classes inheriting from this can use the dbus_service_property

1405

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

1406

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

1407

"""

1408

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1409

882

def _get_dbus_property(self, interface_name, property_name):

1410

883

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

1411

884

property with the specified name and interface.

1412

885

"""

1413

for cls in self.__class__.__mro__:

1414

for name, value in inspect.getmembers(

1415

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

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1416

890

if (value._dbus_name == property_name

1417

891

and value._dbus_interface == interface_name):

1418

892

return value.__get__(self)

1419

893

1420

894

# No such property

1421

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

1422

self.dbus_object_path, interface_name, property_name))

1423

1424

@classmethod

1425

def _get_all_interface_names(cls):

1426

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

1427

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

1428

"_dbus_interface", None)

1429

for x in (inspect.getmro(cls))

1430

for attr in dir(x))

1431

if name is not None)

1432

1433

@dbus.service.method(dbus.PROPERTIES_IFACE,

1434

in_signature="ss",

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1435

900

out_signature="v")

1436

901

def Get(self, interface_name, property_name):

1437

902

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

1443

908

if not hasattr(value, "variant_level"):

1444

909

return value

1445

910

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

1446

911

1447

912

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

1448

913

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

1449

914

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

1458

923

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

1459

924

"'ay' signature {!r}"

1460

925

.format(prop._dbus_signature))

1461

value = dbus.ByteArray(bytes(value))

926

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

927

for byte in value))

1462

928

prop(value)

1463

1464

@dbus.service.method(dbus.PROPERTIES_IFACE,

1465

in_signature="s",

929

930

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

1466

931

out_signature="a{sv}")

1467

932

def GetAll(self, interface_name):

1468

933

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

1469

934

standard.

1470

935

1471

936

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

1472

937

"""

1473

938

properties = {}

1483

948

if not hasattr(value, "variant_level"):

1484

949

properties[name] = value

1485

950

continue

1486

properties[name] = type(value)(

1487

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1488

953

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

1489

954

1490

955

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

1491

956

def PropertiesChanged(self, interface_name, changed_properties,

1492

957

invalidated_properties):

1494

959

standard.

1495

960

"""

1496

961

pass

1497

962

1498

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

964

out_signature="s",

1500

965

path_keyword='object_path',

1501

966

connection_keyword='connection')

1502

967

def Introspect(self, object_path, connection):

1503

968

"""Overloading of standard D-Bus method.

1504

969

1505

970

Inserts property tags and interface annotation tags.

1506

971

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

972

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

973

connection)

1510

974

try:

1511

975

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

1512

1513

976

def make_tag(document, name, prop):

1514

977

e = document.createElement("property")

1515

978

e.setAttribute("name", name)

1516

979

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

1517

980

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

1518

981

return e

1519

1520

982

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

1521

983

# Add property tags

1522

984

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

1525

987

if prop._dbus_interface

1526

988

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

1527

989

if_tag.appendChild(tag)

1528

# Add annotation tags for properties

1529

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

1530

annots = dict()

1531

for name, prop in self._get_all_dbus_things(

1532

"property"):

1533

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

1534

and prop._dbus_interface

1535

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

1536

annots.update(getattr(

1537

prop, "_dbus_annotations", {}))

1538

for name, value in annots.items():

1539

ann_tag = document.createElement(

1540

"annotation")

1541

ann_tag.setAttribute("name", name)

1542

ann_tag.setAttribute("value", value)

1543

tag.appendChild(ann_tag)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

1544

1021

# Add the names to the return values for the

1545

1022

# "org.freedesktop.DBus.Properties" methods

1546

1023

if (if_tag.getAttribute("name")

1565

1042

return xmlstring

1566

1043

1567

1044

1568

try:

1569

dbus.OBJECT_MANAGER_IFACE

1570

except AttributeError:

1571

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

1572

1573

1574

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1575

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

1576

1577

Classes inheriting from this exposes the standard

1578

GetManagedObjects call and the InterfacesAdded and

1579

InterfacesRemoved signals on the standard

1580

"org.freedesktop.DBus.ObjectManager" interface.

1581

1582

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

1583

manually.

1584

"""

1585

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1586

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

1587

def GetManagedObjects(self):

1588

"""This function must be overridden"""

1589

raise NotImplementedError()

1590

1591

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1592

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

1593

def InterfacesAdded(self, object_path, interfaces_and_properties):

1594

pass

1595

1596

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

1597

def InterfacesRemoved(self, object_path, interfaces):

1598

pass

1599

1600

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1601

out_signature="s",

1602

path_keyword='object_path',

1603

connection_keyword='connection')

1604

def Introspect(self, object_path, connection):

1605

"""Overloading of standard D-Bus method.

1606

1607

Override return argument name of GetManagedObjects to be

1608

"objpath_interfaces_and_properties"

1609

"""

1610

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1611

object_path,

1612

connection)

1613

try:

1614

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

1615

1616

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

1617

# Fix argument name for the GetManagedObjects method

1618

if (if_tag.getAttribute("name")

1619

== dbus.OBJECT_MANAGER_IFACE):

1620

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

1621

if (cn.getAttribute("name")

1622

== "GetManagedObjects"):

1623

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

1624

if (arg.getAttribute("direction")

1625

== "out"):

1626

arg.setAttribute(

1627

"name",

1628

"objpath_interfaces"

1629

"_and_properties")

1630

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

1631

document.unlink()

1632

except (AttributeError, xml.dom.DOMException,

1633

xml.parsers.expat.ExpatError) as error:

1634

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

1635

exc_info=error)

1636

return xmlstring

1637

1638

1639

1045

def datetime_to_dbus(dt, variant_level=0):

1640

1046

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

1641

1047

if dt is None:

1642

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

1643

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

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1644

1051

1645

1052

1646

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1648

1055

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

1649

1056

interface names according to the "alt_interface_names" mapping.

1650

1057

Usage:

1651

1058

1652

1059

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

1653

1060

"net.example.AlternateInterface"})

1654

1061

class SampleDBusObject(dbus.service.Object):

1655

1062

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

1656

1063

def SampleDBusMethod():

1657

1064

pass

1658

1065

1659

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1660

1067

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

1661

1068

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

1662

1069

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

1663

1070

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

1664

1071

1665

1072

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

1666

1073

(from DBusObjectWithProperties) and interfaces (from the

1667

1074

dbus_interface_annotations decorator).

1668

1075

"""

1669

1670

1076

def wrapper(cls):

1671

1077

for orig_interface_name, alt_interface_name in (

1672

alt_interface_names.items()):

1078

alt_interface_names.items()):

1673

1079

attr = {}

1674

1080

interface_names = set()

1675

1081

# Go though all attributes of the class

1677

1083

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

1678

1084

# with the wrong interface name

1679

1085

if (not hasattr(attribute, "_dbus_interface")

1680

or not attribute._dbus_interface.startswith(

1681

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1682

1088

continue

1683

1089

# Create an alternate D-Bus interface name based on

1684

1090

# the current name

1685

alt_interface = attribute._dbus_interface.replace(

1686

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1687

1094

interface_names.add(alt_interface)

1688

1095

# Is this a D-Bus signal?

1689

1096

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

1690

1097

# Extract the original non-method undecorated

1691

1098

# function by black magic

1692

if sys.version_info.major == 2:

1693

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1694

1100

zip(attribute.func_code.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1697

else:

1698

nonmethod_func = (dict(

1699

zip(attribute.__code__.co_freevars,

1700

attribute.__closure__))

1701

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1702

1103

# Create a new, but exactly alike, function

1703

1104

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

1704

1105

# with the alternate D-Bus interface name

1705

new_function = copy_function(nonmethod_func)

1706

new_function = (dbus.service.signal(

1707

alt_interface,

1708

attribute._dbus_signature)(new_function))

1106

new_function = (dbus.service.signal

1107

(alt_interface,

1108

attribute._dbus_signature)

1109

(types.FunctionType(

1110

nonmethod_func.func_code,

1111

nonmethod_func.func_globals,

1112

nonmethod_func.func_name,

1113

nonmethod_func.func_defaults,

1114

nonmethod_func.func_closure)))

1709

1115

# Copy annotations, if any

1710

1116

try:

1711

new_function._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1713

1119

except AttributeError:

1714

1120

pass

1715

1716

1121

# Define a creator of a function to call both the

1717

1122

# original and alternate functions, so both the

1718

1123

# original and alternate signals gets sent when

1721

1126

"""This function is a scope container to pass

1722

1127

func1 and func2 to the "call_both" function

1723

1128

outside of its arguments"""

1724

1725

@functools.wraps(func2)

1726

1129

def call_both(*args, **kwargs):

1727

1130

"""This function will emit two D-Bus

1728

1131

signals by calling func1 and func2"""

1729

1132

func1(*args, **kwargs)

1730

1133

func2(*args, **kwargs)

1731

# Make wrapper function look like a D-Bus

1732

# signal

1733

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

1734

if name.startswith("_dbus_"):

1735

setattr(call_both, name, attr)

1736

1737

1134

return call_both

1738

1135

# Create the "call_both" function and add it to

1739

1136

# the class

1744

1141

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

1745

1142

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

1746

1143

# to the class.

1747

attr[attrname] = (

1748

dbus.service.method(

1749

alt_interface,

1750

attribute._dbus_in_signature,

1751

attribute._dbus_out_signature)

1752

(copy_function(attribute)))

1144

attr[attrname] = (dbus.service.method

1145

(alt_interface,

1146

attribute._dbus_in_signature,

1147

attribute._dbus_out_signature)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1753

1154

# Copy annotations, if any

1754

1155

try:

1755

attr[attrname]._dbus_annotations = dict(

1756

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1757

1158

except AttributeError:

1758

1159

pass

1759

1160

# Is this a D-Bus property?

1762

1163

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

1763

1164

# property with the alternate D-Bus interface

1764

1165

# name. Add it to the class.

1765

attr[attrname] = (dbus_service_property(

1766

alt_interface, attribute._dbus_signature,

1767

attribute._dbus_access,

1768

attribute._dbus_get_args_options

1769

["byte_arrays"])

1770

(copy_function(attribute)))

1166

attr[attrname] = (dbus_service_property

1167

(alt_interface,

1168

attribute._dbus_signature,

1169

attribute._dbus_access,

1170

attribute

1171

._dbus_get_args_options

1172

["byte_arrays"])

1173

(types.FunctionType

1174

(attribute.func_code,

1175

attribute.func_globals,

1176

attribute.func_name,

1177

attribute.func_defaults,

1178

attribute.func_closure)))

1771

1179

# Copy annotations, if any

1772

1180

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1775

1183

except AttributeError:

1776

1184

pass

1777

1185

# Is this a D-Bus interface?

1780

1188

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

1781

1189

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

1782

1190

# to the class.

1783

attr[attrname] = (

1784

dbus_interface_annotations(alt_interface)

1785

(copy_function(attribute)))

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1786

1199

if deprecate:

1787

1200

# Deprecate all alternate interfaces

1788

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1789

1202

for interface_name in interface_names:

1790

1791

1203

@dbus_interface_annotations(interface_name)

1792

1204

def func(self):

1793

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

1794

"true"}

1205

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

1206

"true" }

1795

1207

# Find an unused name

1796

1208

for aname in (iname.format(i)

1797

1209

for i in itertools.count()):

1801

1213

if interface_names:

1802

1214

# Replace the class with a new subclass of it with

1803

1215

# methods, signals, etc. as created above.

1804

if sys.version_info.major == 2:

1805

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

1806

(cls, ), attr)

1807

else:

1808

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

1809

(cls, ), attr)

1216

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

1217

(cls,), attr)

1810

1218

return cls

1811

1812

1219

return wrapper

1813

1220

1814

1221

1815

1222

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

1816

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1817

1224

class ClientDBus(Client, DBusObjectWithProperties):

1818

1225

"""A Client class using D-Bus

1819

1226

1820

1227

Attributes:

1821

1228

dbus_object_path: dbus.ObjectPath

1822

1229

bus: dbus.SystemBus()

1823

1230

"""

1824

1231

1825

1232

runtime_expansions = (Client.runtime_expansions

1826

+ ("dbus_object_path", ))

1827

1233

+ ("dbus_object_path",))

1234

1828

1235

_interface = "se.recompile.Mandos.Client"

1829

1236

1830

1237

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

1831

1832

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

1238

1239

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

1833

1240

self.bus = bus

1834

1241

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

1835

1242

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

1837

1244

client_object_name = str(self.name).translate(

1838

1245

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

1839

1246

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

1840

self.dbus_object_path = dbus.ObjectPath(

1841

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1842

1249

DBusObjectWithProperties.__init__(self, self.bus,

1843

1250

self.dbus_object_path)

1844

1845

def notifychangeproperty(transform_func, dbus_name,

1846

type_func=lambda x: x,

1847

variant_level=1,

1848

invalidate_only=False,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1849

1255

_interface=_interface):

1850

1256

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

1851

1257

its changes to DBus.

1852

1258

1853

1259

transform_fun: Function that takes a value and a variant_level

1854

1260

and transforms it to a D-Bus type.

1855

1261

dbus_name: D-Bus name of the variable

1858

1264

variant_level: D-Bus variant level. Default: 1

1859

1265

"""

1860

1266

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

1861

1862

1267

def setter(self, value):

1863

1268

if hasattr(self, "dbus_object_path"):

1864

1269

if (not hasattr(self, attrname) or

1865

1270

type_func(getattr(self, attrname, None))

1866

1271

!= type_func(value)):

1867

1272

if invalidate_only:

1868

self.PropertiesChanged(

1869

_interface, dbus.Dictionary(),

1870

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1871

1277

else:

1872

dbus_value = transform_func(

1873

type_func(value),

1874

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1875

1281

self.PropertyChanged(dbus.String(dbus_name),

1876

1282

dbus_value)

1877

self.PropertiesChanged(

1878

_interface,

1879

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

1880

dbus_value}),

1881

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1882

1287

setattr(self, attrname, value)

1883

1288

1884

1289

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

1885

1290

1886

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1887

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1888

1293

"ApprovalPending",

1889

type_func=bool)

1294

type_func = bool)

1890

1295

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

1891

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1892

1297

"LastEnabled")

1893

checker = notifychangeproperty(

1894

dbus.Boolean, "CheckerRunning",

1895

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1896

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1897

1302

"LastCheckedOK")

1898

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1901

1306

datetime_to_dbus, "LastApprovalRequest")

1902

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1903

1308

"ApprovedByDefault")

1904

approval_delay = notifychangeproperty(

1905

dbus.UInt64, "ApprovalDelay",

1906

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

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1907

1314

approval_duration = notifychangeproperty(

1908

1315

dbus.UInt64, "ApprovalDuration",

1909

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

1316

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

1910

1317

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

1911

timeout = notifychangeproperty(

1912

dbus.UInt64, "Timeout",

1913

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1914

1321

extended_timeout = notifychangeproperty(

1915

1322

dbus.UInt64, "ExtendedTimeout",

1916

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

1917

interval = notifychangeproperty(

1918

dbus.UInt64, "Interval",

1919

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

1323

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

1324

interval = notifychangeproperty(dbus.UInt64,

1325

"Interval",

1326

type_func =

1327

lambda td: td.total_seconds()

1328

* 1000)

1920

1329

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

1921

1330

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

1922

1331

invalidate_only=True)

1923

1332

1924

1333

del notifychangeproperty

1925

1334

1926

1335

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

1927

1336

try:

1928

1337

self.remove_from_connection()

1931

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1932

1341

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

1933

1342

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

1934

1935

def checker_callback(self, source, condition,

1936

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

1937

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

1938

connection, command, *args,

1939

**kwargs)

1940

exitstatus = self.last_checker_status

1941

if exitstatus >= 0:

1343

1344

def checker_callback(self, pid, condition, command,

1345

*args, **kwargs):

1346

self.checker_callback_tag = None

1347

self.checker = None

1348

if os.WIFEXITED(condition):

1349

exitstatus = os.WEXITSTATUS(condition)

1942

1350

# Emit D-Bus signal

1943

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1944

# This is specific to GNU libC

1945

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1946

1353

dbus.String(command))

1947

1354

else:

1948

1355

# Emit D-Bus signal

1949

1356

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

1950

dbus.Int64(

1951

# This is specific to GNU libC

1952

(exitstatus << 8)

1953

| self.last_checker_signal),

1357

dbus.Int64(condition),

1954

1358

dbus.String(command))

1955

return ret

1956

1359

1360

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

1361

*args, **kwargs)

1362

1957

1363

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

1958

1364

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

1959

1365

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

1963

1369

# Emit D-Bus signal

1964

1370

self.CheckerStarted(self.current_checker_command)

1965

1371

return r

1966

1372

1967

1373

def _reset_approved(self):

1968

1374

self.approved = None

1969

1375

return False

1970

1376

1971

1377

def approve(self, value=True):

1972

1378

self.approved = value

1973

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

1974

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1975

1381

self.send_changedstate()

1976

1977

# D-Bus methods, signals & properties

1978

1979

# Interfaces

1980

1981

# Signals

1982

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1983

1389

# CheckerCompleted - signal

1984

1390

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

1985

1391

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

1986

1392

"D-Bus signal"

1987

1393

pass

1988

1394

1989

1395

# CheckerStarted - signal

1990

1396

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

1991

1397

def CheckerStarted(self, command):

1992

1398

"D-Bus signal"

1993

1399

pass

1994

1400

1995

1401

# PropertyChanged - signal

1996

1402

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

1997

1403

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

1998

1404

def PropertyChanged(self, property, value):

1999

1405

"D-Bus signal"

2000

1406

pass

2001

1407

2002

1408

# GotSecret - signal

2003

1409

@dbus.service.signal(_interface)

2004

1410

def GotSecret(self):

2007

1413

server to mandos-client

2008

1414

"""

2009

1415

pass

2010

1416

2011

1417

# Rejected - signal

2012

1418

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

2013

1419

def Rejected(self, reason):

2014

1420

"D-Bus signal"

2015

1421

pass

2016

1422

2017

1423

# NeedApproval - signal

2018

1424

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

2019

1425

def NeedApproval(self, timeout, default):

2020

1426

"D-Bus signal"

2021

1427

return self.need_approval()

2022

2023

# Methods

2024

1428

1429

## Methods

1430

2025

1431

# Approve - method

2026

1432

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

2027

1433

def Approve(self, value):

2028

1434

self.approve(value)

2029

1435

2030

1436

# CheckedOK - method

2031

1437

@dbus.service.method(_interface)

2032

1438

def CheckedOK(self):

2033

1439

self.checked_ok()

2034

1440

2035

1441

# Enable - method

2036

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

2037

1442

@dbus.service.method(_interface)

2038

1443

def Enable(self):

2039

1444

"D-Bus method"

2040

1445

self.enable()

2041

1446

2042

1447

# StartChecker - method

2043

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

2044

1448

@dbus.service.method(_interface)

2045

1449

def StartChecker(self):

2046

1450

"D-Bus method"

2047

1451

self.start_checker()

2048

1452

2049

1453

# Disable - method

2050

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

2051

1454

@dbus.service.method(_interface)

2052

1455

def Disable(self):

2053

1456

"D-Bus method"

2054

1457

self.disable()

2055

1458

2056

1459

# StopChecker - method

2057

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

2058

1460

@dbus.service.method(_interface)

2059

1461

def StopChecker(self):

2060

1462

self.stop_checker()

2061

2062

# Properties

2063

1463

1464

## Properties

1465

2064

1466

# ApprovalPending - property

2065

1467

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

2066

1468

def ApprovalPending_dbus_property(self):

2067

1469

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

2068

1470

2069

1471

# ApprovedByDefault - property

2070

@dbus_service_property(_interface,

2071

signature="b",

1472

@dbus_service_property(_interface, signature="b",

2072

1473

access="readwrite")

2073

1474

def ApprovedByDefault_dbus_property(self, value=None):

2074

1475

if value is None: # get

2075

1476

return dbus.Boolean(self.approved_by_default)

2076

1477

self.approved_by_default = bool(value)

2077

1478

2078

1479

# ApprovalDelay - property

2079

@dbus_service_property(_interface,

2080

signature="t",

1480

@dbus_service_property(_interface, signature="t",

2081

1481

access="readwrite")

2082

1482

def ApprovalDelay_dbus_property(self, value=None):

2083

1483

if value is None: # get

2084

1484

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

2085

1485

* 1000)

2086

1486

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

2087

1487

2088

1488

# ApprovalDuration - property

2089

@dbus_service_property(_interface,

2090

signature="t",

1489

@dbus_service_property(_interface, signature="t",

2091

1490

access="readwrite")

2092

1491

def ApprovalDuration_dbus_property(self, value=None):

2093

1492

if value is None: # get

2094

1493

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

2095

1494

* 1000)

2096

1495

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

2097

1496

2098

1497

# Name - property

2099

@dbus_annotations(

2100

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

2101

1498

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

2102

1499

def Name_dbus_property(self):

2103

1500

return dbus.String(self.name)

2104

2105

# KeyID - property

2106

@dbus_annotations(

2107

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

2108

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

2109

def KeyID_dbus_property(self):

2110

return dbus.String(self.key_id)

2111

1501

2112

1502

# Fingerprint - property

2113

@dbus_annotations(

2114

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

2115

1503

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

2116

1504

def Fingerprint_dbus_property(self):

2117

1505

return dbus.String(self.fingerprint)

2118

1506

2119

1507

# Host - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2122

1509

access="readwrite")

2123

1510

def Host_dbus_property(self, value=None):

2124

1511

if value is None: # get

2125

1512

return dbus.String(self.host)

2126

1513

self.host = str(value)

2127

1514

2128

1515

# Created - property

2129

@dbus_annotations(

2130

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

2131

1516

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

2132

1517

def Created_dbus_property(self):

2133

1518

return datetime_to_dbus(self.created)

2134

1519

2135

1520

# LastEnabled - property

2136

1521

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

2137

1522

def LastEnabled_dbus_property(self):

2138

1523

return datetime_to_dbus(self.last_enabled)

2139

1524

2140

1525

# Enabled - property

2141

@dbus_service_property(_interface,

2142

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2143

1527

access="readwrite")

2144

1528

def Enabled_dbus_property(self, value=None):

2145

1529

if value is None: # get

2148

1532

self.enable()

2149

1533

else:

2150

1534

self.disable()

2151

1535

2152

1536

# LastCheckedOK - property

2153

@dbus_service_property(_interface,

2154

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2155

1538

access="readwrite")

2156

1539

def LastCheckedOK_dbus_property(self, value=None):

2157

1540

if value is not None:

2158

1541

self.checked_ok()

2159

1542

return

2160

1543

return datetime_to_dbus(self.last_checked_ok)

2161

1544

2162

1545

# LastCheckerStatus - property

2163

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2164

1548

def LastCheckerStatus_dbus_property(self):

2165

1549

return dbus.Int16(self.last_checker_status)

2166

1550

2167

1551

# Expires - property

2168

1552

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

2169

1553

def Expires_dbus_property(self):

2170

1554

return datetime_to_dbus(self.expires)

2171

1555

2172

1556

# LastApprovalRequest - property

2173

1557

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

2174

1558

def LastApprovalRequest_dbus_property(self):

2175

1559

return datetime_to_dbus(self.last_approval_request)

2176

1560

2177

1561

# Timeout - property

2178

@dbus_service_property(_interface,

2179

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2180

1563

access="readwrite")

2181

1564

def Timeout_dbus_property(self, value=None):

2182

1565

if value is None: # get

2194

1577

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

2195

1578

is None):

2196

1579

return

2197

GLib.source_remove(self.disable_initiator_tag)

2198

self.disable_initiator_tag = GLib.timeout_add(

2199

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

2200

self.disable)

2201

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

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

1584

* 1000), self.disable))

1585

2202

1586

# ExtendedTimeout - property

2203

@dbus_service_property(_interface,

2204

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2205

1588

access="readwrite")

2206

1589

def ExtendedTimeout_dbus_property(self, value=None):

2207

1590

if value is None: # get

2208

1591

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

2209

1592

* 1000)

2210

1593

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

2211

1594

2212

1595

# Interval - property

2213

@dbus_service_property(_interface,

2214

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2215

1597

access="readwrite")

2216

1598

def Interval_dbus_property(self, value=None):

2217

1599

if value is None: # get

2221

1603

return

2222

1604

if self.enabled:

2223

1605

# Reschedule checker run

2224

GLib.source_remove(self.checker_initiator_tag)

2225

self.checker_initiator_tag = GLib.timeout_add(

2226

value, self.start_checker)

2227

self.start_checker() # Start one now, too

2228

1606

gobject.source_remove(self.checker_initiator_tag)

1607

self.checker_initiator_tag = (gobject.timeout_add

1608

(value, self.start_checker))

1609

self.start_checker() # Start one now, too

1610

2229

1611

# Checker - property

2230

@dbus_service_property(_interface,

2231

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2232

1613

access="readwrite")

2233

1614

def Checker_dbus_property(self, value=None):

2234

1615

if value is None: # get

2235

1616

return dbus.String(self.checker_command)

2236

1617

self.checker_command = str(value)

2237

1618

2238

1619

# CheckerRunning - property

2239

@dbus_service_property(_interface,

2240

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2241

1621

access="readwrite")

2242

1622

def CheckerRunning_dbus_property(self, value=None):

2243

1623

if value is None: # get

2246

1626

self.start_checker()

2247

1627

else:

2248

1628

self.stop_checker()

2249

1629

2250

1630

# ObjectPath - property

2251

@dbus_annotations(

2252

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

2253

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

2254

1631

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

2255

1632

def ObjectPath_dbus_property(self):

2256

return self.dbus_object_path # is already a dbus.ObjectPath

2257

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2258

1635

# Secret = property

2259

@dbus_annotations(

2260

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

2261

"invalidates"})

2262

@dbus_service_property(_interface,

2263

signature="ay",

2264

access="write",

2265

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2266

1638

def Secret_dbus_property(self, value):

2267

1639

self.secret = bytes(value)

2268

1640

2269

1641

del _interface

2270

1642

2271

1643

2272

class ProxyClient:

2273

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

1644

class ProxyClient(object):

1645

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

2274

1646

self._pipe = child_pipe

2275

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

1647

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

2276

1648

if not self._pipe.recv():

2277

raise KeyError(key_id or fpr)

2278

1649

raise KeyError()

1650

2279

1651

def __getattribute__(self, name):

2280

1652

if name == '_pipe':

2281

1653

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

2284

1656

if data[0] == 'data':

2285

1657

return data[1]

2286

1658

if data[0] == 'function':

2287

2288

1659

def func(*args, **kwargs):

2289

1660

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

2290

1661

return self._pipe.recv()[1]

2291

2292

1662

return func

2293

1663

2294

1664

def __setattr__(self, name, value):

2295

1665

if name == '_pipe':

2296

1666

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

2299

1669

2300

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2301

1671

"""A class to handle client connections.

2302

1672

2303

1673

Instantiated once for each connection to handle it.

2304

1674

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

2305

1675

2306

1676

def handle(self):

2307

1677

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

2308

1678

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

2309

1679

str(self.client_address))

2310

1680

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

2311

1681

self.server.child_pipe.fileno())

2312

2313

session = gnutls.ClientSession(self.request)

2314

2315

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

2316

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

2317

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

2318

# "+DHE-DSS"))

1682

1683

session = (gnutls.connection

1684

.ClientSession(self.request,

1685

gnutls.connection

1686

.X509Credentials()))

1687

1688

# Note: gnutls.connection.X509Credentials is really a

1689

# generic GnuTLS certificate credentials object so long as

1690

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

1691

# here despite using OpenPGP certificates.

1692

1693

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

1694

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

1695

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

1696

# "+DHE-DSS"))

2319

1697

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

2320

1698

priority = self.server.gnutls_priority

2321

1699

if priority is None:

2322

1700

priority = "NORMAL"

2323

gnutls.priority_set_direct(session,

2324

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

2325

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2326

1705

# Start communication using the Mandos protocol

2327

1706

# Get protocol number

2328

1707

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

2333

1712

except (ValueError, IndexError, RuntimeError) as error:

2334

1713

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

2335

1714

return

2336

1715

2337

1716

# Start GnuTLS connection

2338

1717

try:

2339

1718

session.handshake()

2340

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2341

1720

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

2342

1721

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

2343

1722

# established. Just abandon the request.

2344

1723

return

2345

1724

logger.debug("Handshake succeeded")

2346

1725

2347

1726

approval_required = False

2348

1727

try:

2349

if gnutls.has_rawpk:

2350

fpr = b""

2351

try:

2352

key_id = self.key_id(

2353

self.peer_certificate(session))

2354

except (TypeError, gnutls.Error) as error:

2355

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

2356

return

2357

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

2358

key_id.decode("utf-8",

2359

errors="replace"))

2360

2361

else:

2362

key_id = b""

2363

try:

2364

fpr = self.fingerprint(

2365

self.peer_certificate(session))

2366

except (TypeError, gnutls.Error) as error:

2367

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

2368

return

2369

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

2370

2371

try:

2372

client = ProxyClient(child_pipe, key_id, fpr,

1728

try:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

1733

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

1734

return

1735

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

1736

1737

try:

1738

client = ProxyClient(child_pipe, fpr,

2373

1739

self.client_address)

2374

1740

except KeyError:

2375

1741

return

2376

1742

2377

1743

if client.approval_delay:

2378

1744

delay = client.approval_delay

2379

1745

client.approvals_pending += 1

2380

1746

approval_required = True

2381

1747

2382

1748

while True:

2383

1749

if not client.enabled:

2384

1750

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

2385

client.name)

1751

client.name)

2386

1752

if self.server.use_dbus:

2387

1753

# Emit D-Bus signal

2388

1754

client.Rejected("Disabled")

2389

1755

return

2390

1756

2391

1757

if client.approved or not client.approval_delay:

2392

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2393

1759

break

2394

1760

elif client.approved is None:

2395

1761

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

2406

1772

# Emit D-Bus signal

2407

1773

client.Rejected("Denied")

2408

1774

return

2409

2410

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2411

1777

time = datetime.datetime.now()

2412

1778

client.changedstate.acquire()

2413

1779

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

2426

1792

break

2427

1793

else:

2428

1794

delay -= time2 - time

2429

2430

try:

2431

session.send(client.secret)

2432

except gnutls.Error as error:

2433

logger.warning("gnutls send failed",

2434

exc_info=error)

2435

return

2436

1795

1796

sent_size = 0

1797

while sent_size < len(client.secret):

1798

try:

1799

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

1800

except gnutls.errors.GNUTLSError as error:

1801

logger.warning("gnutls send failed",

1802

exc_info=error)

1803

return

1804

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

1805

sent, len(client.secret)

1806

- (sent_size + sent))

1807

sent_size += sent

1808

2437

1809

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

2438

1810

# bump the timeout using extended_timeout

2439

1811

client.bump_timeout(client.extended_timeout)

2440

1812

if self.server.use_dbus:

2441

1813

# Emit D-Bus signal

2442

1814

client.GotSecret()

2443

1815

2444

1816

finally:

2445

1817

if approval_required:

2446

1818

client.approvals_pending -= 1

2447

1819

try:

2448

1820

session.bye()

2449

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2450

1822

logger.warning("GnuTLS bye failed",

2451

1823

exc_info=error)

2452

1824

2453

1825

@staticmethod

2454

1826

def peer_certificate(session):

2455

"Return the peer's certificate as a bytestring"

2456

try:

2457

cert_type = gnutls.certificate_type_get2(

2458

session, gnutls.CTYPE_PEERS)

2459

except AttributeError:

2460

cert_type = gnutls.certificate_type_get(session)

2461

if gnutls.has_rawpk:

2462

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2463

else:

2464

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2465

# If not a valid certificate type...

2466

if cert_type not in valid_cert_types:

2467

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

2468

valid_cert_types)

2469

# ...return invalid data

2470

return b""

1827

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

1828

# If not an OpenPGP certificate...

1829

if (gnutls.library.functions

1830

.gnutls_certificate_type_get(session._c_object)

1831

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1832

# ...do the normal thing

1833

return session.peer_certificate

2471

1834

list_size = ctypes.c_uint(1)

2472

cert_list = (gnutls.certificate_get_peers

2473

(session, ctypes.byref(list_size)))

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

1837

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

2474

1838

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

2475

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

1839

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

1840

" certificate")

2476

1841

if list_size.value == 0:

2477

1842

return None

2478

1843

cert = cert_list[0]

2479

1844

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

2480

2481

@staticmethod

2482

def key_id(certificate):

2483

"Convert a certificate bytestring to a hexdigit key ID"

2484

# New GnuTLS "datum" with the public key

2485

datum = gnutls.datum_t(

2486

ctypes.cast(ctypes.c_char_p(certificate),

2487

ctypes.POINTER(ctypes.c_ubyte)),

2488

ctypes.c_uint(len(certificate)))

2489

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

2490

# New empty GnuTLS certificate

2491

pubkey = gnutls.pubkey_t()

2492

gnutls.pubkey_init(ctypes.byref(pubkey))

2493

# Import the raw public key into the certificate

2494

gnutls.pubkey_import(pubkey,

2495

ctypes.byref(datum),

2496

gnutls.X509_FMT_DER)

2497

# New buffer for the key ID

2498

buf = ctypes.create_string_buffer(32)

2499

buf_len = ctypes.c_size_t(len(buf))

2500

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

2501

gnutls.pubkey_get_key_id(

2502

pubkey,

2503

gnutls.KEYID_USE_SHA256,

2504

ctypes.cast(ctypes.byref(buf),

2505

ctypes.POINTER(ctypes.c_ubyte)),

2506

ctypes.byref(buf_len))

2507

# Deinit the certificate

2508

gnutls.pubkey_deinit(pubkey)

2509

2510

# Convert the buffer to a Python bytestring

2511

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

2512

# Convert the bytestring to hexadecimal notation

2513

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

2514

return hex_key_id

2515

1845

2516

1846

@staticmethod

2517

1847

def fingerprint(openpgp):

2518

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2519

1849

# New GnuTLS "datum" with the OpenPGP public key

2520

datum = gnutls.datum_t(

2521

ctypes.cast(ctypes.c_char_p(openpgp),

2522

ctypes.POINTER(ctypes.c_ubyte)),

2523

ctypes.c_uint(len(openpgp)))

1850

datum = (gnutls.library.types

1851

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

1852

ctypes.POINTER

1853

(ctypes.c_ubyte)),

1854

ctypes.c_uint(len(openpgp))))

2524

1855

# New empty GnuTLS certificate

2525

crt = gnutls.openpgp_crt_t()

2526

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2527

1859

# Import the OpenPGP public key into the certificate

2528

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

2529

gnutls.OPENPGP_FMT_RAW)

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2530

1864

# Verify the self signature in the key

2531

1865

crtverify = ctypes.c_uint()

2532

gnutls.openpgp_crt_verify_self(crt, 0,

2533

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2534

1869

if crtverify.value != 0:

2535

gnutls.openpgp_crt_deinit(crt)

2536

raise gnutls.CertificateSecurityError(code

2537

=crtverify.value)

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2538

1873

# New buffer for the fingerprint

2539

1874

buf = ctypes.create_string_buffer(20)

2540

1875

buf_len = ctypes.c_size_t()

2541

1876

# Get the fingerprint from the certificate into the buffer

2542

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

2543

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2544

1880

# Deinit the certificate

2545

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2546

1882

# Convert the buffer to a Python bytestring

2547

1883

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

2548

1884

# Convert the bytestring to hexadecimal notation

2550

1886

return hex_fpr

2551

1887

2552

1888

2553

class MultiprocessingMixIn:

1889

class MultiprocessingMixIn(object):

2554

1890

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

2555

2556

1891

def sub_process_main(self, request, address):

2557

1892

try:

2558

1893

self.finish_request(request, address)

2559

1894

except Exception:

2560

1895

self.handle_error(request, address)

2561

1896

self.close_request(request)

2562

1897

2563

1898

def process_request(self, request, address):

2564

1899

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

2565

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

2566

args=(request, address))

1900

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

1901

args = (request, address))

2567

1902

proc.start()

2568

1903

return proc

2569

1904

2570

1905

2571

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2572

1907

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

2573

2574

1908

def process_request(self, request, client_address):

2575

1909

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

2576

1910

2577

1911

This function creates a new pipe in self.pipe

2578

1912

"""

2579

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2580

1914

2581

1915

proc = MultiprocessingMixIn.process_request(self, request,

2582

1916

client_address)

2583

1917

self.child_pipe.close()

2584

1918

self.add_pipe(parent_pipe, proc)

2585

1919

2586

1920

def add_pipe(self, parent_pipe, proc):

2587

1921

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

2588

1922

raise NotImplementedError()

2589

1923

2590

1924

2591

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2592

socketserver.TCPServer):

1926

socketserver.TCPServer, object):

2593

1927

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

2594

1928

2595

1929

Attributes:

2596

1930

enabled: Boolean; whether this server is activated yet

2597

1931

interface: None or a network interface name (string)

2598

1932

use_ipv6: Boolean; to use IPv6 or not

2599

1933

"""

2600

2601

1934

def __init__(self, server_address, RequestHandlerClass,

2602

interface=None,

2603

use_ipv6=True,

2604

socketfd=None):

1935

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

2605

1936

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

2606

1937

creating a new one with socket.socket().

2607

1938

"""

2613

1944

self.socketfd = socketfd

2614

1945

# Save the original socket.socket() function

2615

1946

self.socket_socket = socket.socket

2616

2617

1947

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

2618

#

1948

#

2619

1949

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

2620

1950

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

2621

1951

# patching socket.socket.)

2622

#

1952

#

2623

1953

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

2624

1954

@functools.wraps(socket.socket)

2625

1955

def socket_wrapper(*args, **kwargs):

2637

1967

# socket_wrapper(), if socketfd was set.

2638

1968

socketserver.TCPServer.__init__(self, server_address,

2639

1969

RequestHandlerClass)

2640

1970

2641

1971

def server_bind(self):

2642

1972

"""This overrides the normal server_bind() function

2643

1973

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

2644

1974

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

2645

global SO_BINDTODEVICE

2646

1975

if self.interface is not None:

2647

1976

if SO_BINDTODEVICE is None:

2648

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

2649

# common enough.

2650

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

2651

SO_BINDTODEVICE = 25

2652

try:

2653

self.socket.setsockopt(

2654

socket.SOL_SOCKET, SO_BINDTODEVICE,

2655

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

2656

except socket.error as error:

2657

if error.errno == errno.EPERM:

2658

logger.error("No permission to bind to"

2659

" interface %s", self.interface)

2660

elif error.errno == errno.ENOPROTOOPT:

2661

logger.error("SO_BINDTODEVICE not available;"

2662

" cannot bind to interface %s",

2663

self.interface)

2664

elif error.errno == errno.ENODEV:

2665

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

2666

" cannot bind", self.interface)

2667

else:

2668

raise

1977

logger.error("SO_BINDTODEVICE does not exist;"

1978

" cannot bind to interface %s",

1979

self.interface)

1980

else:

1981

try:

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1983

SO_BINDTODEVICE,

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2669

1999

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

2670

2000

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

2671

if self.server_address[1]:

2672

self.allow_reuse_address = True

2673

2001

if not self.server_address[0]:

2674

2002

if self.address_family == socket.AF_INET6:

2675

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2676

2004

else:

2677

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2678

2006

self.server_address = (any_address,

2679

2007

self.server_address[1])

2680

2008

elif not self.server_address[1]:

2681

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

2009

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

2010

0)

2682

2011

# if self.interface:

2683

2012

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

2684

2013

# 0, # port

2690

2019

2691

2020

class MandosServer(IPv6_TCPServer):

2692

2021

"""Mandos server.

2693

2022

2694

2023

Attributes:

2695

2024

clients: set of Client objects

2696

2025

gnutls_priority GnuTLS priority string

2697

2026

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

2698

2699

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2700

2029

"""

2701

2702

2030

def __init__(self, server_address, RequestHandlerClass,

2703

interface=None,

2704

use_ipv6=True,

2705

clients=None,

2706

gnutls_priority=None,

2707

use_dbus=True,

2708

socketfd=None):

2031

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

2032

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

2709

2033

self.enabled = False

2710

2034

self.clients = clients

2711

2035

if self.clients is None:

2714

2038

self.gnutls_priority = gnutls_priority

2715

2039

IPv6_TCPServer.__init__(self, server_address,

2716

2040

RequestHandlerClass,

2717

interface=interface,

2718

use_ipv6=use_ipv6,

2719

socketfd=socketfd)

2720

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2721

2044

def server_activate(self):

2722

2045

if self.enabled:

2723

2046

return socketserver.TCPServer.server_activate(self)

2724

2047

2725

2048

def enable(self):

2726

2049

self.enabled = True

2727

2050

2728

2051

def add_pipe(self, parent_pipe, proc):

2729

2052

# Call "handle_ipc" for both data and EOF events

2730

GLib.io_add_watch(

2731

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

2732

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

2733

functools.partial(self.handle_ipc,

2734

parent_pipe=parent_pipe,

2735

proc=proc))

2736

2737

def handle_ipc(self, source, condition,

2738

parent_pipe=None,

2739

proc=None,

2740

client_object=None):

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2059

2060

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

2061

proc = None, client_object=None):

2741

2062

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

2742

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

2063

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

2743

2064

# Wait for other process to exit

2744

2065

proc.join()

2745

2066

return False

2746

2067

2747

2068

# Read a request from the child

2748

2069

request = parent_pipe.recv()

2749

2070

command = request[0]

2750

2071

2751

2072

if command == 'init':

2752

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

2753

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

2754

address = request[3]

2755

2756

for c in self.clients.values():

2757

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2758

"27AE41E4649B934CA495991B7852B855"):

2759

continue

2760

if key_id and c.key_id == key_id:

2761

client = c

2762

break

2763

if fpr and c.fingerprint == fpr:

2073

fpr = request[1]

2074

address = request[2]

2075

2076

for c in self.clients.itervalues():

2077

if c.fingerprint == fpr:

2764

2078

client = c

2765

2079

break

2766

2080

else:

2767

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

2768

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

2081

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

2082

"dress: %s", fpr, address)

2769

2083

if self.use_dbus:

2770

2084

# Emit D-Bus signal

2771

mandos_dbus_service.ClientNotFound(key_id or fpr,

2085

mandos_dbus_service.ClientNotFound(fpr,

2772

2086

address[0])

2773

2087

parent_pipe.send(False)

2774

2088

return False

2775

2776

GLib.io_add_watch(

2777

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

2778

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

2779

functools.partial(self.handle_ipc,

2780

parent_pipe=parent_pipe,

2781

proc=proc,

2782

client_object=client))

2089

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2783

2098

parent_pipe.send(True)

2784

2099

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

2785

2100

# same fileno

2788

2103

funcname = request[1]

2789

2104

args = request[2]

2790

2105

kwargs = request[3]

2791

2106

2792

2107

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

2793

2108

funcname)(*args,

2794

**kwargs)))

2795

2109

**kwargs)))

2110

2796

2111

if command == 'getattr':

2797

2112

attrname = request[1]

2798

if isinstance(client_object.__getattribute__(attrname),

2799

collections.abc.Callable):

2800

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2801

2115

else:

2802

parent_pipe.send((

2803

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

2804

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2805

2119

if command == 'setattr':

2806

2120

attrname = request[1]

2807

2121

value = request[2]

2808

2122

setattr(client_object, attrname, value)

2809

2123

2810

2124

return True

2811

2125

2812

2126

2813

2127

def rfc3339_duration_to_delta(duration):

2814

2128

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

2815

2816

>>> timedelta = datetime.timedelta

2817

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

2818

True

2819

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

2820

True

2821

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

2822

True

2823

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

2824

True

2825

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

2826

True

2827

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

2828

True

2829

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

2830

True

2831

>>> del timedelta

2129

2130

>>> rfc3339_duration_to_delta("P7D")

2131

datetime.timedelta(7)

2132

>>> rfc3339_duration_to_delta("PT60S")

2133

datetime.timedelta(0, 60)

2134

>>> rfc3339_duration_to_delta("PT60M")

2135

datetime.timedelta(0, 3600)

2136

>>> rfc3339_duration_to_delta("PT24H")

2137

datetime.timedelta(1)

2138

>>> rfc3339_duration_to_delta("P1W")

2139

datetime.timedelta(7)

2140

>>> rfc3339_duration_to_delta("PT5M30S")

2141

datetime.timedelta(0, 330)

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

datetime.timedelta(1, 200)

2832

2144

"""

2833

2145

2834

2146

# Parsing an RFC 3339 duration with regular expressions is not

2835

2147

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

2836

2148

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

2837

2149

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

2838

2150

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

2839

2151

# avoid excessive use of external libraries.

2840

2152

2841

2153

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

2842

Token = collections.namedtuple("Token", (

2843

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

2844

# a "group" containing digits

2845

"value", # datetime.timedelta or None

2846

"followers")) # Tokens valid after this token

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2847

2163

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

2848

2164

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

2849

2165

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

2850

2166

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

2851

2167

datetime.timedelta(seconds=1),

2852

frozenset((token_end, )))

2168

frozenset((token_end,)))

2853

2169

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

2854

2170

datetime.timedelta(minutes=1),

2855

2171

frozenset((token_second, token_end)))

2871

2187

frozenset((token_month, token_end)))

2872

2188

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

2873

2189

datetime.timedelta(weeks=1),

2874

frozenset((token_end, )))

2190

frozenset((token_end,)))

2875

2191

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

2876

2192

frozenset((token_year, token_month,

2877

2193

token_day, token_time,

2878

2194

token_week)))

2879

# Define starting values:

2880

# Value so far

2881

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2882

2197

found_token = None

2883

# Following valid tokens

2884

followers = frozenset((token_duration, ))

2885

# String left to parse

2886

s = duration

2198

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

2199

s = duration # String left to parse

2887

2200

# Loop until end token is found

2888

2201

while found_token is not token_end:

2889

2202

# Search for any currently valid tokens

2905

2218

break

2906

2219

else:

2907

2220

# No currently valid tokens were found

2908

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

2909

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2910

2222

# End token found

2911

2223

return value

2912

2224

2913

2225

2914

2226

def string_to_delta(interval):

2915

2227

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

2916

2917

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

2918

True

2919

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

2920

True

2921

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

2922

True

2923

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

2924

True

2925

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

2926

True

2927

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

2928

True

2228

2229

>>> string_to_delta('7d')

2230

datetime.timedelta(7)

2231

>>> string_to_delta('60s')

2232

datetime.timedelta(0, 60)

2233

>>> string_to_delta('60m')

2234

datetime.timedelta(0, 3600)

2235

>>> string_to_delta('24h')

2236

datetime.timedelta(1)

2237

>>> string_to_delta('1w')

2238

datetime.timedelta(7)

2239

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

2240

datetime.timedelta(0, 330)

2929

2241

"""

2930

2242

2931

2243

try:

2932

2244

return rfc3339_duration_to_delta(interval)

2933

2245

except ValueError:

2934

2246

pass

2935

2247

2936

2248

timevalue = datetime.timedelta(0)

2937

2249

for s in interval.split():

2938

2250

try:

2949

2261

elif suffix == "w":

2950

2262

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

2951

2263

else:

2952

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2953

2266

except IndexError as e:

2954

2267

raise ValueError(*(e.args))

2955

2268

timevalue += delta

2956

2269

return timevalue

2957

2270

2958

2271

2959

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

2272

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

2960

2273

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

2961

2274

2962

2275

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

2963

2276

if os.fork():

2964

2277

sys.exit()

2971

2284

# Close all standard open file descriptors

2972

2285

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

2973

2286

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

2974

raise OSError(errno.ENODEV,

2975

"{} not a character device"

2287

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

2976

2288

.format(os.devnull))

2977

2289

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

2978

2290

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

2982

2294

2983

2295

2984

2296

def main():

2985

2297

2986

2298

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

2987

2299

# Parsing of options, both command line and config file

2988

2300

2989

2301

parser = argparse.ArgumentParser()

2990

2302

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

2991

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

2303

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

2992

2304

help="show version number and exit")

2993

2305

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

2994

2306

help="Bind to interface IF")

3030

2342

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

3031

2343

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

3032

2344

default=None)

3033

2345

3034

2346

options = parser.parse_args()

3035

2347

2348

if options.check:

2349

import doctest

2350

fail_count, test_count = doctest.testmod()

2351

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

2352

3036

2353

# Default values for config file for server-global settings

3037

if gnutls.has_rawpk:

3038

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

3039

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

3040

else:

3041

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

3042

":+SIGN-DSA-SHA256")

3043

server_defaults = {"interface": "",

3044

"address": "",

3045

"port": "",

3046

"debug": "False",

3047

"priority": priority,

3048

"servicename": "Mandos",

3049

"use_dbus": "True",

3050

"use_ipv6": "True",

3051

"debuglevel": "",

3052

"restore": "True",

3053

"socket": "",

3054

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

3055

"foreground": "False",

3056

"zeroconf": "True",

3057

}

3058

del priority

3059

2354

server_defaults = { "interface": "",

2355

"address": "",

2356

"port": "",

2357

"debug": "False",

2358

"priority":

2359

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

2360

"servicename": "Mandos",

2361

"use_dbus": "True",

2362

"use_ipv6": "True",

2363

"debuglevel": "",

2364

"restore": "True",

2365

"socket": "",

2366

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

2367

"foreground": "False",

2368

"zeroconf": "True",

2369

}

2370

3060

2371

# Parse config file for server-global settings

3061

server_config = configparser.ConfigParser(server_defaults)

2372

server_config = configparser.SafeConfigParser(server_defaults)

3062

2373

del server_defaults

3063

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

3064

# Convert the ConfigParser object to a dict

2374

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

2375

"mandos.conf"))

2376

# Convert the SafeConfigParser object to a dict

3065

2377

server_settings = server_config.defaults()

3066

2378

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

3067

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

3068

"foreground", "zeroconf"):

2379

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

3069

2380

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

3070

2381

option)

3071

2382

if server_settings["port"]:

3081

2392

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

3082

2393

["socket"])

3083

2394

del server_config

3084

2395

3085

2396

# Override the settings from the config file with command line

3086

2397

# options, if set.

3087

2398

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

3088

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

3089

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

3090

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

2399

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

2400

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

2401

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

3091

2402

value = getattr(options, option)

3092

2403

if value is not None:

3093

2404

server_settings[option] = value

3105

2416

if server_settings["debug"]:

3106

2417

server_settings["foreground"] = True

3107

2418

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

3108

2419

3109

2420

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

3110

3111

if (not server_settings["zeroconf"]

3112

and not (server_settings["port"]

3113

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

3114

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

3115

2421

2422

if (not server_settings["zeroconf"] and

2423

not (server_settings["port"]

2424

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

2425

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

2426

" Zeroconf")

2427

3116

2428

# For convenience

3117

2429

debug = server_settings["debug"]

3118

2430

debuglevel = server_settings["debuglevel"]

3122

2434

stored_state_file)

3123

2435

foreground = server_settings["foreground"]

3124

2436

zeroconf = server_settings["zeroconf"]

3125

2437

3126

2438

if debug:

3127

2439

initlogger(debug, logging.DEBUG)

3128

2440

else:

3131

2443

else:

3132

2444

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

3133

2445

initlogger(debug, level)

3134

2446

3135

2447

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

3136

syslogger.setFormatter(

3137

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

3138

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

3139

server_settings["servicename"])))

3140

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3141

2454

# Parse config file with clients

3142

client_config = configparser.ConfigParser(Client.client_defaults)

2455

client_config = configparser.SafeConfigParser(Client

2456

.client_defaults)

3143

2457

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

3144

2458

"clients.conf"))

3145

2459

3146

2460

global mandos_dbus_service

3147

2461

mandos_dbus_service = None

3148

2462

3149

2463

socketfd = None

3150

2464

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

3151

2465

socketfd = server_settings["socket"]

3152

tcp_server = MandosServer(

3153

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

3154

ClientHandler,

3155

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

3156

use_ipv6=use_ipv6,

3157

gnutls_priority=server_settings["priority"],

3158

use_dbus=use_dbus,

3159

socketfd=socketfd)

2466

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

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

3160

2476

if not foreground:

3161

2477

pidfilename = "/run/mandos.pid"

3162

2478

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

3163

2479

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

3164

2480

pidfile = None

3165

2481

try:

3166

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

2482

pidfile = open(pidfilename, "w")

3167

2483

except IOError as e:

3168

2484

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

3169

2485

exc_info=e)

3170

3171

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

3172

("mandos", "mandos"),

3173

("nobody", "nogroup")):

2486

2487

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

3174

2488

try:

3175

2489

uid = pwd.getpwnam(name).pw_uid

3176

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

3177

2491

break

3178

2492

except KeyError:

3179

2493

continue

3183

2497

try:

3184

2498

os.setgid(gid)

3185

2499

os.setuid(uid)

3186

if debug:

3187

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

3188

gid))

3189

2500

except OSError as error:

3190

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

3191

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

3192

2501

if error.errno != errno.EPERM:

3193

2502

raise

3194

2503

3195

2504

if debug:

3196

2505

# Enable all possible GnuTLS debugging

3197

2506

3198

2507

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

3199

2508

# - GnuTLS manual

3200

gnutls.global_set_log_level(11)

3201

3202

@gnutls.log_func

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3203

2512

def debug_gnutls(level, string):

3204

logger.debug("GnuTLS: %s",

3205

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

3206

errors="replace"))

3207

3208

gnutls.global_set_log_function(debug_gnutls)

3209

2513

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

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3210

2518

# Redirect stdin so all checkers get /dev/null

3211

2519

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

3212

2520

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

3213

2521

if null > 2:

3214

2522

os.close(null)

3215

2523

3216

2524

# Need to fork before connecting to D-Bus

3217

2525

if not foreground:

3218

2526

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

3219

2527

daemon()

3220

3221

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

3222

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

3223

# need to inform GLib that threads will be used.

3224

GLib.threads_init()

3225

2528

2529

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

2530

# need to inform gobject that threads will be used.

2531

gobject.threads_init()

2532

3226

2533

global main_loop

3227

2534

# From the Avahi example code

3228

2535

DBusGMainLoop(set_as_default=True)

3229

main_loop = GLib.MainLoop()

2536

main_loop = gobject.MainLoop()

3230

2537

bus = dbus.SystemBus()

3231

2538

# End of Avahi example code

3232

2539

if use_dbus:

3233

2540

try:

3234

2541

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

3235

bus,

3236

do_not_queue=True)

3237

old_bus_name = dbus.service.BusName(

3238

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

3239

do_not_queue=True)

3240

except dbus.exceptions.DBusException as e:

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

3241

2547

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

3242

2548

use_dbus = False

3243

2549

server_settings["use_dbus"] = False

3244

2550

tcp_server.use_dbus = False

3245

2551

if zeroconf:

3246

2552

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3247

service = AvahiServiceToSyslog(

3248

name=server_settings["servicename"],

3249

servicetype="_mandos._tcp",

3250

protocol=protocol,

3251

bus=bus)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3252

2557

if server_settings["interface"]:

3253

service.interface = if_nametoindex(

3254

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

3255

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3256

2562

global multiprocessing_manager

3257

2563

multiprocessing_manager = multiprocessing.Manager()

3258

2564

3259

2565

client_class = Client

3260

2566

if use_dbus:

3261

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

3262

2567

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

2568

3263

2569

client_settings = Client.config_parser(client_config)

3264

2570

old_client_settings = {}

3265

2571

clients_data = {}

3266

2572

3267

2573

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

3268

2574

global wnull

3269

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

2575

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

3270

2576

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

3271

2577

# mode

3272

2578

if debug or not foreground:

3273

2579

wnull.close()

3274

2580

3275

2581

# Get client data and settings from last running state.

3276

2582

if server_settings["restore"]:

3277

2583

try:

3278

2584

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

3279

if sys.version_info.major == 2:

3280

clients_data, old_client_settings = pickle.load(

3281

stored_state)

3282

else:

3283

bytes_clients_data, bytes_old_client_settings = (

3284

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

3285

# Fix bytes to strings

3286

# clients_data

3287

# .keys()

3288

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

3289

if isinstance(key, bytes)

3290

else key): value

3291

for key, value in

3292

bytes_clients_data.items()}

3293

del bytes_clients_data

3294

for key in clients_data:

3295

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

3296

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

3297

for k, v in

3298

clients_data[key].items()}

3299

clients_data[key] = value

3300

# .client_structure

3301

value["client_structure"] = [

3302

(s.decode("utf-8")

3303

if isinstance(s, bytes)

3304

else s) for s in

3305

value["client_structure"]]

3306

# .name, .host, and .checker_command

3307

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

3308

if isinstance(value[k], bytes):

3309

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

3310

if "key_id" not in value:

3311

value["key_id"] = ""

3312

elif "fingerprint" not in value:

3313

value["fingerprint"] = ""

3314

# old_client_settings

3315

# .keys()

3316

old_client_settings = {

3317

(key.decode("utf-8")

3318

if isinstance(key, bytes)

3319

else key): value

3320

for key, value in

3321

bytes_old_client_settings.items()}

3322

del bytes_old_client_settings

3323

# .host and .checker_command

3324

for value in old_client_settings.values():

3325

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

3326

if isinstance(value[attribute], bytes):

3327

value[attribute] = (value[attribute]

3328

.decode("utf-8"))

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3329

2587

os.remove(stored_state_path)

3330

2588

except IOError as e:

3331

2589

if e.errno == errno.ENOENT:

3332

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

3333

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

2590

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

2591

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

3334

2592

else:

3335

2593

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

3336

2594

exc_info=e)

3337

2595

raise

3338

2596

except EOFError as e:

3339

2597

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

3340

"EOFError:",

3341

exc_info=e)

3342

2598

"EOFError:", exc_info=e)

2599

3343

2600

with PGPEngine() as pgp:

3344

2601

for client_name, client in clients_data.items():

3345

2602

# Skip removed clients

3346

2603

if client_name not in client_settings:

3347

2604

continue

3348

2605

3349

2606

# Decide which value to use after restoring saved state.

3350

2607

# We have three different values: Old config file,

3351

2608

# new config file, and saved state.

3356

2613

# For each value in new config, check if it

3357

2614

# differs from the old config value (Except for

3358

2615

# the "secret" attribute)

3359

if (name != "secret"

3360

and (value !=

3361

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3362

2619

client[name] = value

3363

2620

except KeyError:

3364

2621

pass

3365

2622

3366

2623

# Clients who has passed its expire date can still be

3367

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3368

2625

# whose checker succeeded before we stored its state is

3369

2626

# assumed to have successfully run all checkers during

3370

2627

# downtime.

3373

2630

if not client["last_checked_ok"]:

3374

2631

logger.warning(

3375

2632

"disabling client {} - Client never "

3376

"performed a successful checker".format(

3377

client_name))

2633

"performed a successful checker"

2634

.format(client_name))

3378

2635

client["enabled"] = False

3379

2636

elif client["last_checker_status"] != 0:

3380

2637

logger.warning(

3381

2638

"disabling client {} - Client last"

3382

" checker failed with error code"

3383

" {}".format(

3384

client_name,

3385

client["last_checker_status"]))

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3386

2642

client["enabled"] = False

3387

2643

else:

3388

client["expires"] = (

3389

datetime.datetime.utcnow()

3390

+ client["timeout"])

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3391

2647

logger.debug("Last checker succeeded,"

3392

" keeping {} enabled".format(

3393

client_name))

2648

" keeping {} enabled"

2649

.format(client_name))

3394

2650

try:

3395

client["secret"] = pgp.decrypt(

3396

client["encrypted_secret"],

3397

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3398

2655

except PGPError:

3399

2656

# If decryption fails, we use secret from new settings

3400

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

3401

client_name))

3402

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

3403

["secret"])

3404

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3405

2662

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

3406

2663

for client_name in (set(old_client_settings)

3407

2664

- set(client_settings)):

3409

2666

for client_name in (set(client_settings)

3410

2667

- set(old_client_settings)):

3411

2668

clients_data[client_name] = client_settings[client_name]

3412

2669

3413

2670

# Create all client objects

3414

2671

for client_name, client in clients_data.items():

3415

2672

tcp_server.clients[client_name] = client_class(

3416

name=client_name,

3417

settings=client,

3418

server_settings=server_settings)

3419

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3420

2676

if not tcp_server.clients:

3421

2677

logger.warning("No clients defined")

3422

2678

3423

2679

if not foreground:

3424

2680

if pidfile is not None:

3425

pid = os.getpid()

3426

2681

try:

3427

2682

with pidfile:

3428

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3429

2685

except IOError:

3430

2686

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

3431

2687

pidfilename, pid)

3432

2688

del pidfile

3433

2689

del pidfilename

3434

3435

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

3436

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3437

lambda: main_loop.quit() and False)

3438

2690

2691

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

2692

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

2693

3439

2694

if use_dbus:

3440

3441

@alternate_dbus_interfaces(

3442

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

3443

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3444

2698

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

3445

3446

2699

def __init__(self):

3447

2700

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

3448

3449

2701

_interface = "se.recompile.Mandos"

3450

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3451

2709

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

3452

2710

def ClientAdded(self, objpath):

3453

2711

"D-Bus signal"

3454

2712

pass

3455

2713

3456

2714

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

3457

def ClientNotFound(self, key_id, address):

2715

def ClientNotFound(self, fingerprint, address):

3458

2716

"D-Bus signal"

3459

2717

pass

3460

3461

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

3462

"true"})

2718

3463

2719

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

3464

2720

def ClientRemoved(self, objpath, name):

3465

2721

"D-Bus signal"

3466

2722

pass

3467

3468

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

3469

"true"})

2723

3470

2724

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

3471

2725

def GetAllClients(self):

3472

2726

"D-Bus method"

3473

return dbus.Array(c.dbus_object_path for c in

3474

tcp_server.clients.values())

3475

3476

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

3477

"true"})

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3478

2731

@dbus.service.method(_interface,

3479

2732

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

3480

2733

def GetAllClientsWithProperties(self):

3481

2734

"D-Bus method"

3482

2735

return dbus.Dictionary(

3483

{c.dbus_object_path: c.GetAll(

3484

"se.recompile.Mandos.Client")

3485

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

2736

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

2737

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

3486

2738

signature="oa{sv}")

3487

2739

3488

2740

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

3489

2741

def RemoveClient(self, object_path):

3490

2742

"D-Bus method"

3491

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3492

2744

if c.dbus_object_path == object_path:

3493

2745

del tcp_server.clients[c.name]

3494

2746

c.remove_from_connection()

3495

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3496

2748

c.disable(quiet=True)

3497

# Emit D-Bus signal for removal

3498

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3499

2751

return

3500

2752

raise KeyError(object_path)

3501

2753

3502

2754

del _interface

3503

3504

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3505

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

3506

def GetManagedObjects(self):

3507

"""D-Bus method"""

3508

return dbus.Dictionary(

3509

{client.dbus_object_path:

3510

dbus.Dictionary(

3511

{interface: client.GetAll(interface)

3512

for interface in

3513

client._get_all_interface_names()})

3514

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

3515

3516

def client_added_signal(self, client):

3517

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

3518

if use_dbus:

3519

# New standard signal

3520

self.InterfacesAdded(

3521

client.dbus_object_path,

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()}))

3526

# Old signal

3527

self.ClientAdded(client.dbus_object_path)

3528

3529

def client_removed_signal(self, client):

3530

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

3531

if use_dbus:

3532

# New standard signal

3533

self.InterfacesRemoved(

3534

client.dbus_object_path,

3535

client._get_all_interface_names())

3536

# Old signal

3537

self.ClientRemoved(client.dbus_object_path,

3538

client.name)

3539

2755

3540

2756

mandos_dbus_service = MandosDBusService()

3541

3542

# Save modules to variables to exempt the modules from being

3543

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

3544

mp = multiprocessing

3545

wn = wnull

3546

2757

3547

2758

def cleanup():

3548

2759

"Cleanup function; run on exit"

3549

2760

if zeroconf:

3550

2761

service.cleanup()

3551

3552

mp.active_children()

3553

wn.close()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3554

2765

if not (tcp_server.clients or client_settings):

3555

2766

return

3556

2767

3557

2768

# Store client before exiting. Secrets are encrypted with key

3558

2769

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

3559

2770

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

3560

2771

clients = {}

3561

2772

with PGPEngine() as pgp:

3562

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3563

2774

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

3564

2775

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

3565

2776

key)

3566

2777

client_dict = {}

3567

2778

3568

2779

# A list of attributes that can not be pickled

3569

2780

# + secret.

3570

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

3571

"checker", "server_settings"}

3572

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

3573

.Object):

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3574

2785

exclude.add(name)

3575

2786

3576

2787

client_dict["encrypted_secret"] = (client

3577

2788

.encrypted_secret)

3578

2789

for attr in client.client_structure:

3579

2790

if attr not in exclude:

3580

2791

client_dict[attr] = getattr(client, attr)

3581

2792

3582

2793

clients[client.name] = client_dict

3583

2794

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

3584

2795

3585

2796

try:

3586

with tempfile.NamedTemporaryFile(

3587

mode='wb',

3588

suffix=".pickle",

3589

prefix='clients-',

3590

dir=os.path.dirname(stored_state_path),

3591

delete=False) as stored_state:

3592

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

3593

protocol=2)

3594

tempname = stored_state.name

2797

with (tempfile.NamedTemporaryFile

2798

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

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3595

2803

os.rename(tempname, stored_state_path)

3596

2804

except (IOError, OSError) as e:

3597

2805

if not debug:

3606

2814

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

3607

2815

exc_info=e)

3608

2816

raise

3609

2817

3610

2818

# Delete all clients, and settings from config

3611

2819

while tcp_server.clients:

3612

2820

name, client = tcp_server.clients.popitem()

3613

2821

if use_dbus:

3614

2822

client.remove_from_connection()

3615

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3616

2824

client.disable(quiet=True)

3617

# Emit D-Bus signal for removal

3618

2825

if use_dbus:

3619

mandos_dbus_service.client_removed_signal(client)

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3620

2830

client_settings.clear()

3621

2831

3622

2832

atexit.register(cleanup)

3623

3624

for client in tcp_server.clients.values():

2833

2834

for client in tcp_server.clients.itervalues():

3625

2835

if use_dbus:

3626

# Emit D-Bus signal for adding

3627

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3628

2838

# Need to initiate checking of clients

3629

2839

if client.enabled:

3630

2840

client.init_checker()

3631

2841

3632

2842

tcp_server.enable()

3633

2843

tcp_server.server_activate()

3634

2844

3635

2845

# Find out what port we got

3636

2846

if zeroconf:

3637

2847

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

3642

2852

else: # IPv4

3643

2853

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

3644

2854

*tcp_server.socket.getsockname())

3645

3646

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

3647

2855

2856

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

2857

3648

2858

try:

3649

2859

if zeroconf:

3650

2860

# From the Avahi example code

3655

2865

cleanup()

3656

2866

sys.exit(1)

3657

2867

# End of Avahi example code

3658

3659

GLib.io_add_watch(

3660

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

3661

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3662

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

3663

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

3664

2868

2869

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

2870

lambda *args, **kwargs:

2871

(tcp_server.handle_request

2872

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

2873

3665

2874

logger.debug("Starting main loop")

3666

2875

main_loop.run()

3667

2876

except AvahiError as error:

3676

2885

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

3677

2886

cleanup()

3678

2887

3679

3680

def should_only_run_tests():

3681

parser = argparse.ArgumentParser(add_help=False)

3682

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

3683

args, unknown_args = parser.parse_known_args()

3684

run_tests = args.check

3685

if run_tests:

3686

# Remove --check argument from sys.argv

3687

sys.argv[1:] = unknown_args

3688

return run_tests

3689

3690

# Add all tests from doctest strings

3691

def load_tests(loader, tests, none):

3692

import doctest

3693

tests.addTests(doctest.DocTestSuite())

3694

return tests

3695

3696

2888

if __name__ == '__main__':

3697

try:

3698

if should_only_run_tests():

3699

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

3700

unittest.main()

3701

else:

3702

main()

3703

finally:

3704

logging.shutdown()

2889

main()