/mandos/trunk : revision 738.1.1

1

#!/usr/bin/python3 -b

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

72

82

73

import dbus

83

74

import dbus.service

84

import gi

85

from gi.repository import GLib

75

import gobject

76

import avahi

86

77

from dbus.mainloop.glib import DBusGMainLoop

87

78

import ctypes

88

79

import ctypes.util

89

80

import xml.dom.minidom

90

81

import inspect

91

82

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

95

# Show warnings by default

96

if not sys.warnoptions:

97

import warnings

98

warnings.simplefilter("default")

99

100

# Try to find the value of SO_BINDTODEVICE:

101

83

try:

102

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

103

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

104

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

105

85

except AttributeError:

106

86

try:

107

# This is where SO_BINDTODEVICE was up to and including Python

108

# 2.6, and also 3.2:

109

87

from IN import SO_BINDTODEVICE

110

88

except ImportError:

111

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

112

# Try running the C preprocessor:

113

try:

114

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

115

"/dev/stdin"],

116

stdin=subprocess.PIPE,

117

stdout=subprocess.PIPE)

118

stdout = cc.communicate(

119

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

120

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

121

except (OSError, ValueError, IndexError):

122

# No value found

123

SO_BINDTODEVICE = None

89

SO_BINDTODEVICE = None

124

90

125

91

if sys.version_info.major == 2:

126

92

str = unicode

127

93

128

if sys.version_info < (3, 2):

129

configparser.Configparser = configparser.SafeConfigParser

130

131

version = "1.8.8"

94

version = "1.6.9"

132

95

stored_state_file = "clients.pickle"

133

96

134

97

logger = logging.getLogger()

135

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

136

98

syslogger = None

137

99

138

100

try:

139

if_nametoindex = ctypes.cdll.LoadLibrary(

140

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

141

104

except (OSError, AttributeError):

142

143

105

def if_nametoindex(interface):

144

106

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

145

107

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

150

112

return interface_index

151

113

152

114

153

def copy_function(func):

154

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

155

if sys.version_info.major == 2:

156

return types.FunctionType(func.func_code,

157

func.func_globals,

158

func.func_name,

159

func.func_defaults,

160

func.func_closure)

161

else:

162

return types.FunctionType(func.__code__,

163

func.__globals__,

164

func.__name__,

165

func.__defaults__,

166

func.__closure__)

167

168

169

115

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

170

116

"""init logger and add loglevel"""

171

117

172

118

global syslogger

173

syslogger = (logging.handlers.SysLogHandler(

174

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

175

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

176

123

syslogger.setFormatter(logging.Formatter

177

124

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

178

125

' %(message)s'))

179

126

logger.addHandler(syslogger)

180

127

181

128

if debug:

182

129

console = logging.StreamHandler()

183

130

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

193

140

pass

194

141

195

142

196

class PGPEngine:

143

class PGPEngine(object):

197

144

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

198

199

145

def __init__(self):

200

146

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

201

self.gpg = "gpg"

202

try:

203

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

204

for line in output.splitlines():

205

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

206

if name == b"gpg":

207

self.gpg = path

208

break

209

except OSError as e:

210

if e.errno != errno.ENOENT:

211

raise

212

147

self.gnupgargs = ['--batch',

213

'--homedir', self.tempdir,

148

'--home', self.tempdir,

214

149

'--force-mdc',

215

'--quiet']

216

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

217

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

218

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

219

150

'--quiet',

151

'--no-use-agent']

152

220

153

def __enter__(self):

221

154

return self

222

155

223

156

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

224

157

self._cleanup()

225

158

return False

226

159

227

160

def __del__(self):

228

161

self._cleanup()

229

162

230

163

def _cleanup(self):

231

164

if self.tempdir is not None:

232

165

# Delete contents of tempdir

233

166

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

234

topdown=False):

167

topdown = False):

235

168

for filename in files:

236

169

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

237

170

for dirname in dirs:

239

172

# Remove tempdir

240

173

os.rmdir(self.tempdir)

241

174

self.tempdir = None

242

175

243

176

def password_encode(self, password):

244

177

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

245

178

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

250

183

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

251

184

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

252

185

return encoded

253

186

254

187

def encrypt(self, data, password):

255

188

passphrase = self.password_encode(password)

256

with tempfile.NamedTemporaryFile(

257

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

258

191

passfile.write(passphrase)

259

192

passfile.flush()

260

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

193

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

261

194

'--passphrase-file',

262

195

passfile.name]

263

196

+ self.gnupgargs,

264

stdin=subprocess.PIPE,

265

stdout=subprocess.PIPE,

266

stderr=subprocess.PIPE)

267

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)

268

201

if proc.returncode != 0:

269

202

raise PGPError(err)

270

203

return ciphertext

271

204

272

205

def decrypt(self, data, password):

273

206

passphrase = self.password_encode(password)

274

with tempfile.NamedTemporaryFile(

275

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

276

209

passfile.write(passphrase)

277

210

passfile.flush()

278

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

211

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

279

212

'--passphrase-file',

280

213

passfile.name]

281

214

+ self.gnupgargs,

282

stdin=subprocess.PIPE,

283

stdout=subprocess.PIPE,

284

stderr=subprocess.PIPE)

285

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)

286

220

if proc.returncode != 0:

287

221

raise PGPError(err)

288

222

return decrypted_plaintext

289

223

290

224

291

# Pretend that we have an Avahi module

292

class avahi:

293

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

294

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

295

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

296

PROTO_INET = 0 # avahi-common/address.h

297

PROTO_INET6 = 1 # avahi-common/address.h

298

DBUS_NAME = "org.freedesktop.Avahi"

299

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

300

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

301

DBUS_PATH_SERVER = "/"

302

303

@staticmethod

304

def string_array_to_txt_array(t):

305

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

306

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

307

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

308

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

309

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

310

SERVER_INVALID = 0 # avahi-common/defs.h

311

SERVER_REGISTERING = 1 # avahi-common/defs.h

312

SERVER_RUNNING = 2 # avahi-common/defs.h

313

SERVER_COLLISION = 3 # avahi-common/defs.h

314

SERVER_FAILURE = 4 # avahi-common/defs.h

315

316

317

225

class AvahiError(Exception):

318

226

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

319

227

self.value = value

320

228

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

321

229

**kwargs)

322

230

323

324

231

class AvahiServiceError(AvahiError):

325

232

pass

326

233

327

328

234

class AvahiGroupError(AvahiError):

329

235

pass

330

236

331

237

332

class AvahiService:

238

class AvahiService(object):

333

239

"""An Avahi (Zeroconf) service.

334

240

335

241

Attributes:

336

242

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

337

243

Used to optionally bind to the specified interface.

349

255

server: D-Bus Server

350

256

bus: dbus.SystemBus()

351

257

"""

352

353

def __init__(self,

354

interface=avahi.IF_UNSPEC,

355

name=None,

356

servicetype=None,

357

port=None,

358

TXT=None,

359

domain="",

360

host="",

361

max_renames=32768,

362

protocol=avahi.PROTO_UNSPEC,

363

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

364

263

self.interface = interface

365

264

self.name = name

366

265

self.type = servicetype

375

274

self.server = None

376

275

self.bus = bus

377

276

self.entry_group_state_changed_match = None

378

277

379

278

def rename(self, remove=True):

380

279

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

381

280

if self.rename_count >= self.max_renames:

383

282

" after %i retries, exiting.",

384

283

self.rename_count)

385

284

raise AvahiServiceError("Too many renames")

386

self.name = str(

387

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

388

287

self.rename_count += 1

389

288

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

390

289

self.name)

401

300

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

402

301

self.cleanup()

403

302

os._exit(1)

404

303

405

304

def remove(self):

406

305

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

407

306

if self.entry_group_state_changed_match is not None:

409

308

self.entry_group_state_changed_match = None

410

309

if self.group is not None:

411

310

self.group.Reset()

412

311

413

312

def add(self):

414

313

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

415

314

self.remove()

432

331

dbus.UInt16(self.port),

433

332

avahi.string_array_to_txt_array(self.TXT))

434

333

self.group.Commit()

435

334

436

335

def entry_group_state_changed(self, state, error):

437

336

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

438

337

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

439

338

440

339

if state == avahi.ENTRY_GROUP_ESTABLISHED:

441

340

logger.debug("Zeroconf service established.")

442

341

elif state == avahi.ENTRY_GROUP_COLLISION:

445

344

elif state == avahi.ENTRY_GROUP_FAILURE:

446

345

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

447

346

str(error))

448

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

449

347

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

348

.format(error))

349

450

350

def cleanup(self):

451

351

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

452

352

if self.group is not None:

457

357

pass

458

358

self.group = None

459

359

self.remove()

460

360

461

361

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

462

362

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

463

363

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

464

bad_states = {

465

avahi.SERVER_INVALID: "Zeroconf server invalid",

466

avahi.SERVER_REGISTERING: None,

467

avahi.SERVER_COLLISION: "Zeroconf server name collision",

468

avahi.SERVER_FAILURE: "Zeroconf server failure",

469

}

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

470

371

if state in bad_states:

471

372

if bad_states[state] is not None:

472

373

if error is None:

475

376

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

476

377

self.cleanup()

477

378

elif state == avahi.SERVER_RUNNING:

478

try:

479

self.add()

480

except dbus.exceptions.DBusException as error:

481

if (error.get_dbus_name()

482

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

483

logger.info("Local Zeroconf service name"

484

" collision.")

485

return self.rename(remove=False)

486

else:

487

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

488

self.cleanup()

489

os._exit(1)

379

self.add()

490

380

else:

491

381

if error is None:

492

382

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

493

383

else:

494

384

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

495

385

496

386

def activate(self):

497

387

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

498

388

if self.server is None:

502

392

follow_name_owner_changes=True),

503

393

avahi.DBUS_INTERFACE_SERVER)

504

394

self.server.connect_to_signal("StateChanged",

505

self.server_state_changed)

395

self.server_state_changed)

506

396

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

507

397

508

398

509

399

class AvahiServiceToSyslog(AvahiService):

510

400

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

511

401

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

512

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

513

syslogger.setFormatter(logging.Formatter(

514

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

515

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

516

407

return ret

517

408

518

409

519

# Pretend that we have a GnuTLS module

520

class gnutls:

521

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

522

523

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

524

if library is None:

525

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

526

_library = ctypes.cdll.LoadLibrary(library)

527

del library

528

529

# Unless otherwise indicated, the constants and types below are

530

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

531

532

# Constants

533

E_SUCCESS = 0

534

E_INTERRUPTED = -52

535

E_AGAIN = -28

536

CRT_OPENPGP = 2

537

CRT_RAWPK = 3

538

CLIENT = 2

539

SHUT_RDWR = 0

540

CRD_CERTIFICATE = 1

541

E_NO_CERTIFICATE_FOUND = -49

542

X509_FMT_DER = 0

543

NO_TICKETS = 1<<10

544

ENABLE_RAWPK = 1<<18

545

CTYPE_PEERS = 3

546

KEYID_USE_SHA256 = 1 # gnutls/x509.h

547

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

548

549

# Types

550

class session_int(ctypes.Structure):

551

_fields_ = []

552

session_t = ctypes.POINTER(session_int)

553

554

class certificate_credentials_st(ctypes.Structure):

555

_fields_ = []

556

certificate_credentials_t = ctypes.POINTER(

557

certificate_credentials_st)

558

certificate_type_t = ctypes.c_int

559

560

class datum_t(ctypes.Structure):

561

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

562

('size', ctypes.c_uint)]

563

564

class openpgp_crt_int(ctypes.Structure):

565

_fields_ = []

566

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

567

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

568

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

569

credentials_type_t = ctypes.c_int

570

transport_ptr_t = ctypes.c_void_p

571

close_request_t = ctypes.c_int

572

573

# Exceptions

574

class Error(Exception):

575

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

576

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

577

# code is passed, convert it to a string with

578

# gnutls.strerror()

579

self.code = code

580

if message is None and code is not None:

581

message = gnutls.strerror(code)

582

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

583

message, *args)

584

585

class CertificateSecurityError(Error):

586

pass

587

588

# Classes

589

class Credentials:

590

def __init__(self):

591

self._c_object = gnutls.certificate_credentials_t()

592

gnutls.certificate_allocate_credentials(

593

ctypes.byref(self._c_object))

594

self.type = gnutls.CRD_CERTIFICATE

595

596

def __del__(self):

597

gnutls.certificate_free_credentials(self._c_object)

598

599

class ClientSession:

600

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

601

self._c_object = gnutls.session_t()

602

gnutls_flags = gnutls.CLIENT

603

if gnutls.check_version(b"3.5.6"):

604

gnutls_flags |= gnutls.NO_TICKETS

605

if gnutls.has_rawpk:

606

gnutls_flags |= gnutls.ENABLE_RAWPK

607

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

608

del gnutls_flags

609

gnutls.set_default_priority(self._c_object)

610

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

611

gnutls.handshake_set_private_extensions(self._c_object,

612

True)

613

self.socket = socket

614

if credentials is None:

615

credentials = gnutls.Credentials()

616

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

617

ctypes.cast(credentials._c_object,

618

ctypes.c_void_p))

619

self.credentials = credentials

620

621

def __del__(self):

622

gnutls.deinit(self._c_object)

623

624

def handshake(self):

625

return gnutls.handshake(self._c_object)

626

627

def send(self, data):

628

data = bytes(data)

629

data_len = len(data)

630

while data_len > 0:

631

data_len -= gnutls.record_send(self._c_object,

632

data[-data_len:],

633

data_len)

634

635

def bye(self):

636

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

637

638

# Error handling functions

639

def _error_code(result):

640

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

641

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

642

if result >= 0:

643

return result

644

if result == gnutls.E_NO_CERTIFICATE_FOUND:

645

raise gnutls.CertificateSecurityError(code=result)

646

raise gnutls.Error(code=result)

647

648

def _retry_on_error(result, func, arguments):

649

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

650

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

651

while result < 0:

652

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

653

return _error_code(result)

654

result = func(*arguments)

655

return result

656

657

# Unless otherwise indicated, the function declarations below are

658

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

659

660

# Functions

661

priority_set_direct = _library.gnutls_priority_set_direct

662

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

663

ctypes.POINTER(ctypes.c_char_p)]

664

priority_set_direct.restype = _error_code

665

666

init = _library.gnutls_init

667

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

668

init.restype = _error_code

669

670

set_default_priority = _library.gnutls_set_default_priority

671

set_default_priority.argtypes = [session_t]

672

set_default_priority.restype = _error_code

673

674

record_send = _library.gnutls_record_send

675

record_send.argtypes = [session_t, ctypes.c_void_p,

676

ctypes.c_size_t]

677

record_send.restype = ctypes.c_ssize_t

678

record_send.errcheck = _retry_on_error

679

680

certificate_allocate_credentials = (

681

_library.gnutls_certificate_allocate_credentials)

682

certificate_allocate_credentials.argtypes = [

683

ctypes.POINTER(certificate_credentials_t)]

684

certificate_allocate_credentials.restype = _error_code

685

686

certificate_free_credentials = (

687

_library.gnutls_certificate_free_credentials)

688

certificate_free_credentials.argtypes = [

689

certificate_credentials_t]

690

certificate_free_credentials.restype = None

691

692

handshake_set_private_extensions = (

693

_library.gnutls_handshake_set_private_extensions)

694

handshake_set_private_extensions.argtypes = [session_t,

695

ctypes.c_int]

696

handshake_set_private_extensions.restype = None

697

698

credentials_set = _library.gnutls_credentials_set

699

credentials_set.argtypes = [session_t, credentials_type_t,

700

ctypes.c_void_p]

701

credentials_set.restype = _error_code

702

703

strerror = _library.gnutls_strerror

704

strerror.argtypes = [ctypes.c_int]

705

strerror.restype = ctypes.c_char_p

706

707

certificate_type_get = _library.gnutls_certificate_type_get

708

certificate_type_get.argtypes = [session_t]

709

certificate_type_get.restype = _error_code

710

711

certificate_get_peers = _library.gnutls_certificate_get_peers

712

certificate_get_peers.argtypes = [session_t,

713

ctypes.POINTER(ctypes.c_uint)]

714

certificate_get_peers.restype = ctypes.POINTER(datum_t)

715

716

global_set_log_level = _library.gnutls_global_set_log_level

717

global_set_log_level.argtypes = [ctypes.c_int]

718

global_set_log_level.restype = None

719

720

global_set_log_function = _library.gnutls_global_set_log_function

721

global_set_log_function.argtypes = [log_func]

722

global_set_log_function.restype = None

723

724

deinit = _library.gnutls_deinit

725

deinit.argtypes = [session_t]

726

deinit.restype = None

727

728

handshake = _library.gnutls_handshake

729

handshake.argtypes = [session_t]

730

handshake.restype = _error_code

731

handshake.errcheck = _retry_on_error

732

733

transport_set_ptr = _library.gnutls_transport_set_ptr

734

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

735

transport_set_ptr.restype = None

736

737

bye = _library.gnutls_bye

738

bye.argtypes = [session_t, close_request_t]

739

bye.restype = _error_code

740

bye.errcheck = _retry_on_error

741

742

check_version = _library.gnutls_check_version

743

check_version.argtypes = [ctypes.c_char_p]

744

check_version.restype = ctypes.c_char_p

745

746

_need_version = b"3.3.0"

747

if check_version(_need_version) is None:

748

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

749

.format(_need_version))

750

751

_tls_rawpk_version = b"3.6.6"

752

has_rawpk = bool(check_version(_tls_rawpk_version))

753

754

if has_rawpk:

755

# Types

756

class pubkey_st(ctypes.Structure):

757

_fields = []

758

pubkey_t = ctypes.POINTER(pubkey_st)

759

760

x509_crt_fmt_t = ctypes.c_int

761

762

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

763

pubkey_init = _library.gnutls_pubkey_init

764

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

765

pubkey_init.restype = _error_code

766

767

pubkey_import = _library.gnutls_pubkey_import

768

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

769

x509_crt_fmt_t]

770

pubkey_import.restype = _error_code

771

772

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

773

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

774

ctypes.POINTER(ctypes.c_ubyte),

775

ctypes.POINTER(ctypes.c_size_t)]

776

pubkey_get_key_id.restype = _error_code

777

778

pubkey_deinit = _library.gnutls_pubkey_deinit

779

pubkey_deinit.argtypes = [pubkey_t]

780

pubkey_deinit.restype = None

781

else:

782

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

783

784

openpgp_crt_init = _library.gnutls_openpgp_crt_init

785

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

786

openpgp_crt_init.restype = _error_code

787

788

openpgp_crt_import = _library.gnutls_openpgp_crt_import

789

openpgp_crt_import.argtypes = [openpgp_crt_t,

790

ctypes.POINTER(datum_t),

791

openpgp_crt_fmt_t]

792

openpgp_crt_import.restype = _error_code

793

794

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

795

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

796

ctypes.POINTER(ctypes.c_uint)]

797

openpgp_crt_verify_self.restype = _error_code

798

799

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

800

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

801

openpgp_crt_deinit.restype = None

802

803

openpgp_crt_get_fingerprint = (

804

_library.gnutls_openpgp_crt_get_fingerprint)

805

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

806

ctypes.c_void_p,

807

ctypes.POINTER(

808

ctypes.c_size_t)]

809

openpgp_crt_get_fingerprint.restype = _error_code

810

811

if check_version(b"3.6.4"):

812

certificate_type_get2 = _library.gnutls_certificate_type_get2

813

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

814

certificate_type_get2.restype = _error_code

815

816

# Remove non-public functions

817

del _error_code, _retry_on_error

818

819

820

def call_pipe(connection, # : multiprocessing.Connection

821

func, *args, **kwargs):

822

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

823

824

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

825

return value on the provided multiprocessing.Connection.

826

"""

827

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

828

connection.close()

829

830

831

class Client:

410

class Client(object):

832

411

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

833

412

834

413

Attributes:

835

414

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

836

415

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

837

416

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

838

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

839

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

840

running.

841

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

842

421

checker_command: string; External command which is run to check

843

422

if client lives. %() expansions are done at

844

423

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

845

424

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

846

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

847

426

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

848

427

client_structure: Object describing what attributes a client has

849

428

and is used for storing the client at exit

850

429

current_checker_command: string; current running checker_command

851

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

852

431

enabled: bool()

853

432

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

854

uniquely identify an OpenPGP client

855

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

856

a client using raw public keys

433

uniquely identify the client

857

434

host: string; available for use by the checker command

858

435

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

859

436

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

861

438

last_checker_status: integer between 0 and 255 reflecting exit

862

439

status of last checker. -1 reflects crashed

863

440

checker, -2 means no checker completed yet.

864

last_checker_signal: The signal which killed the last checker, if

865

last_checker_status is -1

866

441

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

867

442

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

868

443

D-Bus identifiers

875

450

disabled, or None

876

451

server_settings: The server_settings dict from main()

877

452

"""

878

453

879

454

runtime_expansions = ("approval_delay", "approval_duration",

880

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

455

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

881

456

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

882

457

"last_approval_request", "last_checked_ok",

883

458

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

884

client_defaults = {

885

"timeout": "PT5M",

886

"extended_timeout": "PT15M",

887

"interval": "PT2M",

888

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

889

"host": "",

890

"approval_delay": "PT0S",

891

"approval_duration": "PT1S",

892

"approved_by_default": "True",

893

"enabled": "True",

894

}

895

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

896

470

@staticmethod

897

471

def config_parser(config):

898

472

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

905

479

for client_name in config.sections():

906

480

section = dict(config.items(client_name))

907

481

client = settings[client_name] = {}

908

482

909

483

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

910

484

# Reformat values from string types to Python types

911

485

client["approved_by_default"] = config.getboolean(

912

486

client_name, "approved_by_default")

913

487

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

914

488

"enabled")

915

916

# Uppercase and remove spaces from key_id and fingerprint

917

# for later comparison purposes with return value from the

918

# key_id() and fingerprint() functions

919

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

920

.replace(" ", ""))

489

921

490

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

922

491

.replace(" ", ""))

923

492

if "secret" in section:

924

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

925

.encode("utf-8"),

926

"base64")

493

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

927

494

elif "secfile" in section:

928

495

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

929

496

(section["secfile"])),

944

511

client["last_approval_request"] = None

945

512

client["last_checked_ok"] = None

946

513

client["last_checker_status"] = -2

947

514

948

515

return settings

949

950

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

516

517

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

951

518

self.name = name

952

519

if server_settings is None:

953

520

server_settings = {}

955

522

# adding all client settings

956

523

for setting, value in settings.items():

957

524

setattr(self, setting, value)

958

525

959

526

if self.enabled:

960

527

if not hasattr(self, "last_enabled"):

961

528

self.last_enabled = datetime.datetime.utcnow()

965

532

else:

966

533

self.last_enabled = None

967

534

self.expires = None

968

535

969

536

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

970

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

971

540

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

972

541

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

973

542

datetime.datetime.utcnow())

974

543

975

544

# attributes specific for this server instance

976

545

self.checker = None

977

546

self.checker_initiator_tag = None

980

549

self.current_checker_command = None

981

550

self.approved = None

982

551

self.approvals_pending = 0

983

self.changedstate = multiprocessing_manager.Condition(

984

multiprocessing_manager.Lock())

985

self.client_structure = [attr

986

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

987

557

if not attr.startswith("_")]

988

558

self.client_structure.append("client_structure")

989

990

for name, t in inspect.getmembers(

991

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

992

564

if not name.startswith("_"):

993

565

self.client_structure.append(name)

994

566

995

567

# Send notice to process children that client state has changed

996

568

def send_changedstate(self):

997

569

with self.changedstate:

998

570

self.changedstate.notify_all()

999

571

1000

572

def enable(self):

1001

573

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

1002

574

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

1007

579

self.last_enabled = datetime.datetime.utcnow()

1008

580

self.init_checker()

1009

581

self.send_changedstate()

1010

582

1011

583

def disable(self, quiet=True):

1012

584

"""Disable this client."""

1013

585

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

1015

587

if not quiet:

1016

588

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

1017

589

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

1018

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

1019

591

self.disable_initiator_tag = None

1020

592

self.expires = None

1021

593

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

1022

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

1023

595

self.checker_initiator_tag = None

1024

596

self.stop_checker()

1025

597

self.enabled = False

1026

598

if not quiet:

1027

599

self.send_changedstate()

1028

# 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

1029

601

return False

1030

602

1031

603

def __del__(self):

1032

604

self.disable()

1033

605

1034

606

def init_checker(self):

1035

607

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

1036

608

# and every interval from then on.

1037

609

if self.checker_initiator_tag is not None:

1038

GLib.source_remove(self.checker_initiator_tag)

1039

self.checker_initiator_tag = GLib.timeout_add(

1040

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

1041

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

1042

615

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

1043

616

if self.disable_initiator_tag is not None:

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

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

1047

622

# Also start a new checker *right now*.

1048

623

self.start_checker()

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

624

625

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

1052

626

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

self.checker.join()

1057

627

self.checker_callback_tag = None

1058

628

self.checker = None

1059

1060

if returncode >= 0:

1061

self.last_checker_status = returncode

1062

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1063

631

if self.last_checker_status == 0:

1064

632

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

1065

633

vars(self))

1066

634

self.checked_ok()

1067

635

else:

1068

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

636

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

637

vars(self))

1069

638

else:

1070

639

self.last_checker_status = -1

1071

self.last_checker_signal = -returncode

1072

640

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

1073

641

vars(self))

1074

return False

1075

642

1076

643

def checked_ok(self):

1077

644

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

1078

645

self.last_checked_ok = datetime.datetime.utcnow()

1079

646

self.last_checker_status = 0

1080

self.last_checker_signal = None

1081

647

self.bump_timeout()

1082

648

1083

649

def bump_timeout(self, timeout=None):

1084

650

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

1085

651

if timeout is None:

1086

652

timeout = self.timeout

1087

653

if self.disable_initiator_tag is not None:

1088

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1089

655

self.disable_initiator_tag = None

1090

656

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

1091

self.disable_initiator_tag = GLib.timeout_add(

1092

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1093

660

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

1094

661

1095

662

def need_approval(self):

1096

663

self.last_approval_request = datetime.datetime.utcnow()

1097

664

1098

665

def start_checker(self):

1099

666

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

1100

667

1101

668

If a checker already exists, leave it running and do

1102

669

nothing."""

1103

670

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

1108

675

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

1109

676

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

1110

677

# should be.

1111

1112

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

1113

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

1114

self.checker.join()

1115

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)

1116

693

# Start a new checker if needed

1117

694

if self.checker is None:

1118

695

# Escape attributes for the shell

1119

escaped_attrs = {

1120

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

1121

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1122

699

try:

1123

700

command = self.checker_command % escaped_attrs

1124

701

except TypeError as error:

1125

702

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

1126

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

1127

727

exc_info=error)

1128

return True # Try again later

1129

self.current_checker_command = command

1130

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

1131

self.name)

1132

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

1133

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

1134

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

1135

# always replaced by /dev/null.)

1136

# The exception is when not debugging but nevertheless

1137

# running in the foreground; use the previously

1138

# created wnull.

1139

popen_args = {"close_fds": True,

1140

"shell": True,

1141

"cwd": "/"}

1142

if (not self.server_settings["debug"]

1143

and self.server_settings["foreground"]):

1144

popen_args.update({"stdout": wnull,

1145

"stderr": wnull})

1146

pipe = multiprocessing.Pipe(duplex=False)

1147

self.checker = multiprocessing.Process(

1148

target=call_pipe,

1149

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

1150

kwargs=popen_args)

1151

self.checker.start()

1152

self.checker_callback_tag = GLib.io_add_watch(

1153

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

1154

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1155

self.checker_callback, pipe[0], command)

1156

# 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

1157

748

return True

1158

749

1159

750

def stop_checker(self):

1160

751

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

1161

752

if self.checker_callback_tag:

1162

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1163

754

self.checker_callback_tag = None

1164

755

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

1165

756

return

1166

757

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

1167

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

1168

766

self.checker = None

1169

767

1170

768

1171

def dbus_service_property(dbus_interface,

1172

signature="v",

1173

access="readwrite",

1174

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1175

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1176

772

become properties on the D-Bus.

1177

773

1178

774

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

1179

775

and with one argument by "Set".

1180

776

1181

777

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

1182

778

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

1183

779

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

1187

783

if byte_arrays and signature != "ay":

1188

784

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

1189

785

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

1190

1191

786

def decorator(func):

1192

787

func._dbus_is_property = True

1193

788

func._dbus_interface = dbus_interface

1196

791

func._dbus_name = func.__name__

1197

792

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

1198

793

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

1199

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1200

795

return func

1201

1202

796

return decorator

1203

797

1204

798

1205

799

def dbus_interface_annotations(dbus_interface):

1206

800

"""Decorator for marking functions returning interface annotations

1207

801

1208

802

Usage:

1209

803

1210

804

@dbus_interface_annotations("org.example.Interface")

1211

805

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

1212

806

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

1213

807

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

1214

808

"false"}

1215

809

"""

1216

1217

810

def decorator(func):

1218

811

func._dbus_is_interface = True

1219

812

func._dbus_interface = dbus_interface

1220

813

func._dbus_name = dbus_interface

1221

814

return func

1222

1223

815

return decorator

1224

816

1225

817

1226

818

def dbus_annotations(annotations):

1227

819

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

1228

820

Usage:

1229

821

1230

822

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

1231

823

"org.freedesktop.DBus.Property."

1232

824

"EmitsChangedSignal": "false"})

1234

826

access="r")

1235

827

def Property_dbus_property(self):

1236

828

return dbus.Boolean(False)

1237

1238

See also the DBusObjectWithAnnotations class.

1239

829

"""

1240

1241

830

def decorator(func):

1242

831

func._dbus_annotations = annotations

1243

832

return func

1244

1245

833

return decorator

1246

834

1247

835

1250

838

"""

1251

839

pass

1252

840

1253

1254

841

class DBusPropertyAccessException(DBusPropertyException):

1255

842

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

1256

843

"""

1263

850

pass

1264

851

1265

852

1266

class DBusObjectWithAnnotations(dbus.service.Object):

1267

"""A D-Bus object with annotations.

1268

1269

Classes inheriting from this can use the dbus_annotations

1270

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.

1271

859

"""

1272

860

1273

861

@staticmethod

1274

862

def _is_dbus_thing(thing):

1275

863

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

1276

864

1277

865

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

1278

866

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

1279

867

"""

1280

868

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

1281

869

False)

1282

870

1283

871

def _get_all_dbus_things(self, thing):

1284

872

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

1285

873

"""

1286

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

874

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

875

name),

1287

876

athing.__get__(self))

1288

877

for cls in self.__class__.__mro__

1289

878

for name, athing in

1290

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

1291

1292

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1293

out_signature="s",

1294

path_keyword='object_path',

1295

connection_keyword='connection')

1296

def Introspect(self, object_path, connection):

1297

"""Overloading of standard D-Bus method.

1298

1299

Inserts annotation tags on methods and signals.

1300

"""

1301

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

1302

connection)

1303

try:

1304

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

1305

1306

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

1307

# Add annotation tags

1308

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

1309

for tag in if_tag.getElementsByTagName(typ):

1310

annots = dict()

1311

for name, prop in (self.

1312

_get_all_dbus_things(typ)):

1313

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

1314

and prop._dbus_interface

1315

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

1316

annots.update(getattr(

1317

prop, "_dbus_annotations", {}))

1318

for name, value in annots.items():

1319

ann_tag = document.createElement(

1320

"annotation")

1321

ann_tag.setAttribute("name", name)

1322

ann_tag.setAttribute("value", value)

1323

tag.appendChild(ann_tag)

1324

# Add interface annotation tags

1325

for annotation, value in dict(

1326

itertools.chain.from_iterable(

1327

annotations().items()

1328

for name, annotations

1329

in self._get_all_dbus_things("interface")

1330

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

1331

)).items():

1332

ann_tag = document.createElement("annotation")

1333

ann_tag.setAttribute("name", annotation)

1334

ann_tag.setAttribute("value", value)

1335

if_tag.appendChild(ann_tag)

1336

# Fix argument name for the Introspect method itself

1337

if (if_tag.getAttribute("name")

1338

== dbus.INTROSPECTABLE_IFACE):

1339

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

1340

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

1341

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

1342

if (arg.getAttribute("direction")

1343

== "out"):

1344

arg.setAttribute("name",

1345

"xml_data")

1346

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

1347

document.unlink()

1348

except (AttributeError, xml.dom.DOMException,

1349

xml.parsers.expat.ExpatError) as error:

1350

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

1351

exc_info=error)

1352

return xmlstring

1353

1354

1355

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1356

"""A D-Bus object with properties.

1357

1358

Classes inheriting from this can use the dbus_service_property

1359

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

1360

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

1361

"""

1362

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1363

882

def _get_dbus_property(self, interface_name, property_name):

1364

883

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

1365

884

property with the specified name and interface.

1366

885

"""

1367

for cls in self.__class__.__mro__:

1368

for name, value in inspect.getmembers(

1369

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

1370

890

if (value._dbus_name == property_name

1371

891

and value._dbus_interface == interface_name):

1372

892

return value.__get__(self)

1373

893

1374

894

# No such property

1375

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

1376

self.dbus_object_path, interface_name, property_name))

1377

1378

@classmethod

1379

def _get_all_interface_names(cls):

1380

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

1381

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

1382

"_dbus_interface", None)

1383

for x in (inspect.getmro(cls))

1384

for attr in dir(x))

1385

if name is not None)

1386

1387

@dbus.service.method(dbus.PROPERTIES_IFACE,

1388

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

1389

900

out_signature="v")

1390

901

def Get(self, interface_name, property_name):

1391

902

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

1397

908

if not hasattr(value, "variant_level"):

1398

909

return value

1399

910

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

1400

911

1401

912

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

1402

913

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

1403

914

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

1415

926

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

1416

927

for byte in value))

1417

928

prop(value)

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

929

930

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

1421

931

out_signature="a{sv}")

1422

932

def GetAll(self, interface_name):

1423

933

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

1424

934

standard.

1425

935

1426

936

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

1427

937

"""

1428

938

properties = {}

1438

948

if not hasattr(value, "variant_level"):

1439

949

properties[name] = value

1440

950

continue

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1443

953

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

1444

954

1445

955

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

1446

956

def PropertiesChanged(self, interface_name, changed_properties,

1447

957

invalidated_properties):

1449

959

standard.

1450

960

"""

1451

961

pass

1452

962

1453

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1454

964

out_signature="s",

1455

965

path_keyword='object_path',

1456

966

connection_keyword='connection')

1457

967

def Introspect(self, object_path, connection):

1458

968

"""Overloading of standard D-Bus method.

1459

969

1460

970

Inserts property tags and interface annotation tags.

1461

971

"""

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

972

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

973

connection)

1465

974

try:

1466

975

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

1467

1468

976

def make_tag(document, name, prop):

1469

977

e = document.createElement("property")

1470

978

e.setAttribute("name", name)

1471

979

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

1472

980

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

1473

981

return e

1474

1475

982

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

1476

983

# Add property tags

1477

984

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

1480

987

if prop._dbus_interface

1481

988

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

1482

989

if_tag.appendChild(tag)

1483

# Add annotation tags for properties

1484

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

1485

annots = dict()

1486

for name, prop in self._get_all_dbus_things(

1487

"property"):

1488

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

1489

and prop._dbus_interface

1490

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

1491

annots.update(getattr(

1492

prop, "_dbus_annotations", {}))

1493

for name, value in annots.items():

1494

ann_tag = document.createElement(

1495

"annotation")

1496

ann_tag.setAttribute("name", name)

1497

ann_tag.setAttribute("value", value)

1498

tag.appendChild(ann_tag)

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)

1499

1021

# Add the names to the return values for the

1500

1022

# "org.freedesktop.DBus.Properties" methods

1501

1023

if (if_tag.getAttribute("name")

1520

1042

return xmlstring

1521

1043

1522

1044

1523

try:

1524

dbus.OBJECT_MANAGER_IFACE

1525

except AttributeError:

1526

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

1527

1528

1529

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1530

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

1531

1532

Classes inheriting from this exposes the standard

1533

GetManagedObjects call and the InterfacesAdded and

1534

InterfacesRemoved signals on the standard

1535

"org.freedesktop.DBus.ObjectManager" interface.

1536

1537

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

1538

manually.

1539

"""

1540

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1541

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

1542

def GetManagedObjects(self):

1543

"""This function must be overridden"""

1544

raise NotImplementedError()

1545

1546

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1547

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

1548

def InterfacesAdded(self, object_path, interfaces_and_properties):

1549

pass

1550

1551

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

1552

def InterfacesRemoved(self, object_path, interfaces):

1553

pass

1554

1555

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1556

out_signature="s",

1557

path_keyword='object_path',

1558

connection_keyword='connection')

1559

def Introspect(self, object_path, connection):

1560

"""Overloading of standard D-Bus method.

1561

1562

Override return argument name of GetManagedObjects to be

1563

"objpath_interfaces_and_properties"

1564

"""

1565

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1566

object_path,

1567

connection)

1568

try:

1569

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

1570

1571

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

1572

# Fix argument name for the GetManagedObjects method

1573

if (if_tag.getAttribute("name")

1574

== dbus.OBJECT_MANAGER_IFACE):

1575

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

1576

if (cn.getAttribute("name")

1577

== "GetManagedObjects"):

1578

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

1579

if (arg.getAttribute("direction")

1580

== "out"):

1581

arg.setAttribute(

1582

"name",

1583

"objpath_interfaces"

1584

"_and_properties")

1585

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

1586

document.unlink()

1587

except (AttributeError, xml.dom.DOMException,

1588

xml.parsers.expat.ExpatError) as error:

1589

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

1590

exc_info=error)

1591

return xmlstring

1592

1593

1594

1045

def datetime_to_dbus(dt, variant_level=0):

1595

1046

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

1596

1047

if dt is None:

1597

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

1598

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)

1599

1051

1600

1052

1601

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1603

1055

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

1604

1056

interface names according to the "alt_interface_names" mapping.

1605

1057

Usage:

1606

1058

1607

1059

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

1608

1060

"net.example.AlternateInterface"})

1609

1061

class SampleDBusObject(dbus.service.Object):

1610

1062

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

1611

1063

def SampleDBusMethod():

1612

1064

pass

1613

1065

1614

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1615

1067

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

1616

1068

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

1617

1069

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

1618

1070

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

1619

1071

1620

1072

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

1621

1073

(from DBusObjectWithProperties) and interfaces (from the

1622

1074

dbus_interface_annotations decorator).

1623

1075

"""

1624

1625

1076

def wrapper(cls):

1626

1077

for orig_interface_name, alt_interface_name in (

1627

alt_interface_names.items()):

1078

alt_interface_names.items()):

1628

1079

attr = {}

1629

1080

interface_names = set()

1630

1081

# Go though all attributes of the class

1632

1083

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

1633

1084

# with the wrong interface name

1634

1085

if (not hasattr(attribute, "_dbus_interface")

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1637

1088

continue

1638

1089

# Create an alternate D-Bus interface name based on

1639

1090

# the current name

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1642

1094

interface_names.add(alt_interface)

1643

1095

# Is this a D-Bus signal?

1644

1096

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

1645

1097

# Extract the original non-method undecorated

1646

1098

# function by black magic

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1649

1100

zip(attribute.func_code.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1652

else:

1653

nonmethod_func = (dict(

1654

zip(attribute.__code__.co_freevars,

1655

attribute.__closure__))

1656

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1657

1103

# Create a new, but exactly alike, function

1658

1104

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

1659

1105

# with the alternate D-Bus interface name

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

attribute._dbus_signature)(new_function))

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

1664

1115

# Copy annotations, if any

1665

1116

try:

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1668

1119

except AttributeError:

1669

1120

pass

1670

1671

1121

# Define a creator of a function to call both the

1672

1122

# original and alternate functions, so both the

1673

1123

# original and alternate signals gets sent when

1676

1126

"""This function is a scope container to pass

1677

1127

func1 and func2 to the "call_both" function

1678

1128

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1681

1129

def call_both(*args, **kwargs):

1682

1130

"""This function will emit two D-Bus

1683

1131

signals by calling func1 and func2"""

1684

1132

func1(*args, **kwargs)

1685

1133

func2(*args, **kwargs)

1686

# Make wrapper function look like a D-Bus

1687

# signal

1688

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

1689

if name.startswith("_dbus_"):

1690

setattr(call_both, name, attr)

1691

1692

1134

return call_both

1693

1135

# Create the "call_both" function and add it to

1694

1136

# the class

1699

1141

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

1700

1142

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

1701

1143

# to the class.

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

(copy_function(attribute)))

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

1708

1154

# Copy annotations, if any

1709

1155

try:

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1712

1158

except AttributeError:

1713

1159

pass

1714

1160

# Is this a D-Bus property?

1717

1163

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

1718

1164

# property with the alternate D-Bus interface

1719

1165

# name. Add it to the class.

1720

attr[attrname] = (dbus_service_property(

1721

alt_interface, attribute._dbus_signature,

1722

attribute._dbus_access,

1723

attribute._dbus_get_args_options

1724

["byte_arrays"])

1725

(copy_function(attribute)))

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

1726

1179

# Copy annotations, if any

1727

1180

try:

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1730

1183

except AttributeError:

1731

1184

pass

1732

1185

# Is this a D-Bus interface?

1735

1188

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

1736

1189

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

1737

1190

# to the class.

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

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

1741

1199

if deprecate:

1742

1200

# Deprecate all alternate interfaces

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1744

1202

for interface_name in interface_names:

1745

1746

1203

@dbus_interface_annotations(interface_name)

1747

1204

def func(self):

1748

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

1749

"true"}

1205

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

1206

"true" }

1750

1207

# Find an unused name

1751

1208

for aname in (iname.format(i)

1752

1209

for i in itertools.count()):

1756

1213

if interface_names:

1757

1214

# Replace the class with a new subclass of it with

1758

1215

# methods, signals, etc. as created above.

1759

if sys.version_info.major == 2:

1760

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

1761

(cls, ), attr)

1762

else:

1763

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

1764

(cls, ), attr)

1216

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

1217

(cls,), attr)

1765

1218

return cls

1766

1767

1219

return wrapper

1768

1220

1769

1221

1770

1222

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

1771

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1772

1224

class ClientDBus(Client, DBusObjectWithProperties):

1773

1225

"""A Client class using D-Bus

1774

1226

1775

1227

Attributes:

1776

1228

dbus_object_path: dbus.ObjectPath

1777

1229

bus: dbus.SystemBus()

1778

1230

"""

1779

1231

1780

1232

runtime_expansions = (Client.runtime_expansions

1781

+ ("dbus_object_path", ))

1782

1233

+ ("dbus_object_path",))

1234

1783

1235

_interface = "se.recompile.Mandos.Client"

1784

1236

1785

1237

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

1786

1787

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

1238

1239

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

1788

1240

self.bus = bus

1789

1241

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

1790

1242

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

1792

1244

client_object_name = str(self.name).translate(

1793

1245

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

1794

1246

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

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1797

1249

DBusObjectWithProperties.__init__(self, self.bus,

1798

1250

self.dbus_object_path)

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1804

1255

_interface=_interface):

1805

1256

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

1806

1257

its changes to DBus.

1807

1258

1808

1259

transform_fun: Function that takes a value and a variant_level

1809

1260

and transforms it to a D-Bus type.

1810

1261

dbus_name: D-Bus name of the variable

1813

1264

variant_level: D-Bus variant level. Default: 1

1814

1265

"""

1815

1266

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

1816

1817

1267

def setter(self, value):

1818

1268

if hasattr(self, "dbus_object_path"):

1819

1269

if (not hasattr(self, attrname) or

1820

1270

type_func(getattr(self, attrname, None))

1821

1271

!= type_func(value)):

1822

1272

if invalidate_only:

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1826

1277

else:

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1830

1281

self.PropertyChanged(dbus.String(dbus_name),

1831

1282

dbus_value)

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1837

1287

setattr(self, attrname, value)

1838

1288

1839

1289

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

1840

1290

1841

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1842

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1843

1293

"ApprovalPending",

1844

type_func=bool)

1294

type_func = bool)

1845

1295

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

1846

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1847

1297

"LastEnabled")

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1851

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1852

1302

"LastCheckedOK")

1853

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1856

1306

datetime_to_dbus, "LastApprovalRequest")

1857

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1858

1308

"ApprovedByDefault")

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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)

1862

1314

approval_duration = notifychangeproperty(

1863

1315

dbus.UInt64, "ApprovalDuration",

1864

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

1316

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

1865

1317

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

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1869

1321

extended_timeout = notifychangeproperty(

1870

1322

dbus.UInt64, "ExtendedTimeout",

1871

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

1872

interval = notifychangeproperty(

1873

dbus.UInt64, "Interval",

1874

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

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)

1875

1329

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

1876

1330

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

1877

1331

invalidate_only=True)

1878

1332

1879

1333

del notifychangeproperty

1880

1334

1881

1335

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

1882

1336

try:

1883

1337

self.remove_from_connection()

1886

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1887

1341

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

1888

1342

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

1889

1890

def checker_callback(self, source, condition,

1891

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

1892

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

1893

connection, command, *args,

1894

**kwargs)

1895

exitstatus = self.last_checker_status

1896

if exitstatus >= 0:

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)

1897

1350

# Emit D-Bus signal

1898

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1901

1353

dbus.String(command))

1902

1354

else:

1903

1355

# Emit D-Bus signal

1904

1356

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

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1357

dbus.Int64(condition),

1909

1358

dbus.String(command))

1910

return ret

1911

1359

1360

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

1361

*args, **kwargs)

1362

1912

1363

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

1913

1364

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

1914

1365

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

1918

1369

# Emit D-Bus signal

1919

1370

self.CheckerStarted(self.current_checker_command)

1920

1371

return r

1921

1372

1922

1373

def _reset_approved(self):

1923

1374

self.approved = None

1924

1375

return False

1925

1376

1926

1377

def approve(self, value=True):

1927

1378

self.approved = value

1928

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

1929

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1930

1381

self.send_changedstate()

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1938

1389

# CheckerCompleted - signal

1939

1390

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

1940

1391

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

1941

1392

"D-Bus signal"

1942

1393

pass

1943

1394

1944

1395

# CheckerStarted - signal

1945

1396

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

1946

1397

def CheckerStarted(self, command):

1947

1398

"D-Bus signal"

1948

1399

pass

1949

1400

1950

1401

# PropertyChanged - signal

1951

1402

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

1952

1403

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

1953

1404

def PropertyChanged(self, property, value):

1954

1405

"D-Bus signal"

1955

1406

pass

1956

1407

1957

1408

# GotSecret - signal

1958

1409

@dbus.service.signal(_interface)

1959

1410

def GotSecret(self):

1962

1413

server to mandos-client

1963

1414

"""

1964

1415

pass

1965

1416

1966

1417

# Rejected - signal

1967

1418

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

1968

1419

def Rejected(self, reason):

1969

1420

"D-Bus signal"

1970

1421

pass

1971

1422

1972

1423

# NeedApproval - signal

1973

1424

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

1974

1425

def NeedApproval(self, timeout, default):

1975

1426

"D-Bus signal"

1976

1427

return self.need_approval()

1977

1978

# Methods

1979

1428

1429

## Methods

1430

1980

1431

# Approve - method

1981

1432

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

1982

1433

def Approve(self, value):

1983

1434

self.approve(value)

1984

1435

1985

1436

# CheckedOK - method

1986

1437

@dbus.service.method(_interface)

1987

1438

def CheckedOK(self):

1988

1439

self.checked_ok()

1989

1440

1990

1441

# Enable - method

1991

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

1992

1442

@dbus.service.method(_interface)

1993

1443

def Enable(self):

1994

1444

"D-Bus method"

1995

1445

self.enable()

1996

1446

1997

1447

# StartChecker - method

1998

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

1999

1448

@dbus.service.method(_interface)

2000

1449

def StartChecker(self):

2001

1450

"D-Bus method"

2002

1451

self.start_checker()

2003

1452

2004

1453

# Disable - method

2005

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

2006

1454

@dbus.service.method(_interface)

2007

1455

def Disable(self):

2008

1456

"D-Bus method"

2009

1457

self.disable()

2010

1458

2011

1459

# StopChecker - method

2012

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

2013

1460

@dbus.service.method(_interface)

2014

1461

def StopChecker(self):

2015

1462

self.stop_checker()

2016

2017

# Properties

2018

1463

1464

## Properties

1465

2019

1466

# ApprovalPending - property

2020

1467

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

2021

1468

def ApprovalPending_dbus_property(self):

2022

1469

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

2023

1470

2024

1471

# ApprovedByDefault - property

2025

@dbus_service_property(_interface,

2026

signature="b",

1472

@dbus_service_property(_interface, signature="b",

2027

1473

access="readwrite")

2028

1474

def ApprovedByDefault_dbus_property(self, value=None):

2029

1475

if value is None: # get

2030

1476

return dbus.Boolean(self.approved_by_default)

2031

1477

self.approved_by_default = bool(value)

2032

1478

2033

1479

# ApprovalDelay - property

2034

@dbus_service_property(_interface,

2035

signature="t",

1480

@dbus_service_property(_interface, signature="t",

2036

1481

access="readwrite")

2037

1482

def ApprovalDelay_dbus_property(self, value=None):

2038

1483

if value is None: # get

2039

1484

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

2040

1485

* 1000)

2041

1486

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

2042

1487

2043

1488

# ApprovalDuration - property

2044

@dbus_service_property(_interface,

2045

signature="t",

1489

@dbus_service_property(_interface, signature="t",

2046

1490

access="readwrite")

2047

1491

def ApprovalDuration_dbus_property(self, value=None):

2048

1492

if value is None: # get

2049

1493

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

2050

1494

* 1000)

2051

1495

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

2052

1496

2053

1497

# Name - property

2054

@dbus_annotations(

2055

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

2056

1498

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

2057

1499

def Name_dbus_property(self):

2058

1500

return dbus.String(self.name)

2059

2060

# KeyID - property

2061

@dbus_annotations(

2062

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

2063

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

2064

def KeyID_dbus_property(self):

2065

return dbus.String(self.key_id)

2066

1501

2067

1502

# Fingerprint - property

2068

@dbus_annotations(

2069

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

2070

1503

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

2071

1504

def Fingerprint_dbus_property(self):

2072

1505

return dbus.String(self.fingerprint)

2073

1506

2074

1507

# Host - property

2075

@dbus_service_property(_interface,

2076

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2077

1509

access="readwrite")

2078

1510

def Host_dbus_property(self, value=None):

2079

1511

if value is None: # get

2080

1512

return dbus.String(self.host)

2081

1513

self.host = str(value)

2082

1514

2083

1515

# Created - property

2084

@dbus_annotations(

2085

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

2086

1516

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

2087

1517

def Created_dbus_property(self):

2088

1518

return datetime_to_dbus(self.created)

2089

1519

2090

1520

# LastEnabled - property

2091

1521

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

2092

1522

def LastEnabled_dbus_property(self):

2093

1523

return datetime_to_dbus(self.last_enabled)

2094

1524

2095

1525

# Enabled - property

2096

@dbus_service_property(_interface,

2097

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2098

1527

access="readwrite")

2099

1528

def Enabled_dbus_property(self, value=None):

2100

1529

if value is None: # get

2103

1532

self.enable()

2104

1533

else:

2105

1534

self.disable()

2106

1535

2107

1536

# LastCheckedOK - property

2108

@dbus_service_property(_interface,

2109

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2110

1538

access="readwrite")

2111

1539

def LastCheckedOK_dbus_property(self, value=None):

2112

1540

if value is not None:

2113

1541

self.checked_ok()

2114

1542

return

2115

1543

return datetime_to_dbus(self.last_checked_ok)

2116

1544

2117

1545

# LastCheckerStatus - property

2118

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2119

1548

def LastCheckerStatus_dbus_property(self):

2120

1549

return dbus.Int16(self.last_checker_status)

2121

1550

2122

1551

# Expires - property

2123

1552

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

2124

1553

def Expires_dbus_property(self):

2125

1554

return datetime_to_dbus(self.expires)

2126

1555

2127

1556

# LastApprovalRequest - property

2128

1557

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

2129

1558

def LastApprovalRequest_dbus_property(self):

2130

1559

return datetime_to_dbus(self.last_approval_request)

2131

1560

2132

1561

# Timeout - property

2133

@dbus_service_property(_interface,

2134

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2135

1563

access="readwrite")

2136

1564

def Timeout_dbus_property(self, value=None):

2137

1565

if value is None: # get

2149

1577

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

2150

1578

is None):

2151

1579

return

2152

GLib.source_remove(self.disable_initiator_tag)

2153

self.disable_initiator_tag = GLib.timeout_add(

2154

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

2155

self.disable)

2156

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

2157

1586

# ExtendedTimeout - property

2158

@dbus_service_property(_interface,

2159

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2160

1588

access="readwrite")

2161

1589

def ExtendedTimeout_dbus_property(self, value=None):

2162

1590

if value is None: # get

2163

1591

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

2164

1592

* 1000)

2165

1593

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

2166

1594

2167

1595

# Interval - property

2168

@dbus_service_property(_interface,

2169

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2170

1597

access="readwrite")

2171

1598

def Interval_dbus_property(self, value=None):

2172

1599

if value is None: # get

2176

1603

return

2177

1604

if self.enabled:

2178

1605

# Reschedule checker run

2179

GLib.source_remove(self.checker_initiator_tag)

2180

self.checker_initiator_tag = GLib.timeout_add(

2181

value, self.start_checker)

2182

self.start_checker() # Start one now, too

2183

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

2184

1611

# Checker - property

2185

@dbus_service_property(_interface,

2186

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2187

1613

access="readwrite")

2188

1614

def Checker_dbus_property(self, value=None):

2189

1615

if value is None: # get

2190

1616

return dbus.String(self.checker_command)

2191

1617

self.checker_command = str(value)

2192

1618

2193

1619

# CheckerRunning - property

2194

@dbus_service_property(_interface,

2195

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2196

1621

access="readwrite")

2197

1622

def CheckerRunning_dbus_property(self, value=None):

2198

1623

if value is None: # get

2201

1626

self.start_checker()

2202

1627

else:

2203

1628

self.stop_checker()

2204

1629

2205

1630

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

2209

1631

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

2210

1632

def ObjectPath_dbus_property(self):

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2213

1635

# Secret = property

2214

@dbus_annotations(

2215

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

2216

"invalidates"})

2217

@dbus_service_property(_interface,

2218

signature="ay",

2219

access="write",

2220

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2221

1638

def Secret_dbus_property(self, value):

2222

1639

self.secret = bytes(value)

2223

1640

2224

1641

del _interface

2225

1642

2226

1643

2227

class ProxyClient:

2228

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

1644

class ProxyClient(object):

1645

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

2229

1646

self._pipe = child_pipe

2230

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

1647

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

2231

1648

if not self._pipe.recv():

2232

raise KeyError(key_id or fpr)

2233

1649

raise KeyError()

1650

2234

1651

def __getattribute__(self, name):

2235

1652

if name == '_pipe':

2236

1653

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

2239

1656

if data[0] == 'data':

2240

1657

return data[1]

2241

1658

if data[0] == 'function':

2242

2243

1659

def func(*args, **kwargs):

2244

1660

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

2245

1661

return self._pipe.recv()[1]

2246

2247

1662

return func

2248

1663

2249

1664

def __setattr__(self, name, value):

2250

1665

if name == '_pipe':

2251

1666

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

2254

1669

2255

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2256

1671

"""A class to handle client connections.

2257

1672

2258

1673

Instantiated once for each connection to handle it.

2259

1674

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

2260

1675

2261

1676

def handle(self):

2262

1677

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

2263

1678

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

2264

1679

str(self.client_address))

2265

1680

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

2266

1681

self.server.child_pipe.fileno())

2267

2268

session = gnutls.ClientSession(self.request)

2269

2270

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

2271

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

2272

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

2273

# "+DHE-DSS"))

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

2274

1697

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

2275

1698

priority = self.server.gnutls_priority

2276

1699

if priority is None:

2277

1700

priority = "NORMAL"

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2282

1705

# Start communication using the Mandos protocol

2283

1706

# Get protocol number

2284

1707

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

2289

1712

except (ValueError, IndexError, RuntimeError) as error:

2290

1713

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

2291

1714

return

2292

1715

2293

1716

# Start GnuTLS connection

2294

1717

try:

2295

1718

session.handshake()

2296

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2297

1720

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

2298

1721

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

2299

1722

# established. Just abandon the request.

2300

1723

return

2301

1724

logger.debug("Handshake succeeded")

2302

1725

2303

1726

approval_required = False

2304

1727

try:

2305

if gnutls.has_rawpk:

2306

fpr = b""

2307

try:

2308

key_id = self.key_id(

2309

self.peer_certificate(session))

2310

except (TypeError, gnutls.Error) as error:

2311

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

2312

return

2313

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

2314

2315

else:

2316

key_id = b""

2317

try:

2318

fpr = self.fingerprint(

2319

self.peer_certificate(session))

2320

except (TypeError, gnutls.Error) as error:

2321

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

2322

return

2323

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

2324

2325

try:

2326

client = ProxyClient(child_pipe, key_id, fpr,

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,

2327

1739

self.client_address)

2328

1740

except KeyError:

2329

1741

return

2330

1742

2331

1743

if client.approval_delay:

2332

1744

delay = client.approval_delay

2333

1745

client.approvals_pending += 1

2334

1746

approval_required = True

2335

1747

2336

1748

while True:

2337

1749

if not client.enabled:

2338

1750

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

2339

client.name)

1751

client.name)

2340

1752

if self.server.use_dbus:

2341

1753

# Emit D-Bus signal

2342

1754

client.Rejected("Disabled")

2343

1755

return

2344

1756

2345

1757

if client.approved or not client.approval_delay:

2346

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2347

1759

break

2348

1760

elif client.approved is None:

2349

1761

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

2360

1772

# Emit D-Bus signal

2361

1773

client.Rejected("Denied")

2362

1774

return

2363

2364

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2365

1777

time = datetime.datetime.now()

2366

1778

client.changedstate.acquire()

2367

1779

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

2380

1792

break

2381

1793

else:

2382

1794

delay -= time2 - time

2383

2384

try:

2385

session.send(client.secret)

2386

except gnutls.Error as error:

2387

logger.warning("gnutls send failed",

2388

exc_info=error)

2389

return

2390

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

2391

1809

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

2392

1810

# bump the timeout using extended_timeout

2393

1811

client.bump_timeout(client.extended_timeout)

2394

1812

if self.server.use_dbus:

2395

1813

# Emit D-Bus signal

2396

1814

client.GotSecret()

2397

1815

2398

1816

finally:

2399

1817

if approval_required:

2400

1818

client.approvals_pending -= 1

2401

1819

try:

2402

1820

session.bye()

2403

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2404

1822

logger.warning("GnuTLS bye failed",

2405

1823

exc_info=error)

2406

1824

2407

1825

@staticmethod

2408

1826

def peer_certificate(session):

2409

"Return the peer's certificate as a bytestring"

2410

try:

2411

cert_type = gnutls.certificate_type_get2(session._c_object,

2412

gnutls.CTYPE_PEERS)

2413

except AttributeError:

2414

cert_type = gnutls.certificate_type_get(session._c_object)

2415

if gnutls.has_rawpk:

2416

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2417

else:

2418

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2419

# If not a valid certificate type...

2420

if cert_type not in valid_cert_types:

2421

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

2422

valid_cert_types)

2423

# ...return invalid data

2424

return b""

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

2425

1834

list_size = ctypes.c_uint(1)

2426

cert_list = (gnutls.certificate_get_peers

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2427

1837

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

2428

1838

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

2429

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

1839

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

1840

" certificate")

2430

1841

if list_size.value == 0:

2431

1842

return None

2432

1843

cert = cert_list[0]

2433

1844

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

2434

2435

@staticmethod

2436

def key_id(certificate):

2437

"Convert a certificate bytestring to a hexdigit key ID"

2438

# New GnuTLS "datum" with the public key

2439

datum = gnutls.datum_t(

2440

ctypes.cast(ctypes.c_char_p(certificate),

2441

ctypes.POINTER(ctypes.c_ubyte)),

2442

ctypes.c_uint(len(certificate)))

2443

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

2444

# New empty GnuTLS certificate

2445

pubkey = gnutls.pubkey_t()

2446

gnutls.pubkey_init(ctypes.byref(pubkey))

2447

# Import the raw public key into the certificate

2448

gnutls.pubkey_import(pubkey,

2449

ctypes.byref(datum),

2450

gnutls.X509_FMT_DER)

2451

# New buffer for the key ID

2452

buf = ctypes.create_string_buffer(32)

2453

buf_len = ctypes.c_size_t(len(buf))

2454

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

2455

gnutls.pubkey_get_key_id(pubkey,

2456

gnutls.KEYID_USE_SHA256,

2457

ctypes.cast(ctypes.byref(buf),

2458

ctypes.POINTER(ctypes.c_ubyte)),

2459

ctypes.byref(buf_len))

2460

# Deinit the certificate

2461

gnutls.pubkey_deinit(pubkey)

2462

2463

# Convert the buffer to a Python bytestring

2464

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

2465

# Convert the bytestring to hexadecimal notation

2466

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

2467

return hex_key_id

2468

1845

2469

1846

@staticmethod

2470

1847

def fingerprint(openpgp):

2471

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2472

1849

# New GnuTLS "datum" with the OpenPGP public key

2473

datum = gnutls.datum_t(

2474

ctypes.cast(ctypes.c_char_p(openpgp),

2475

ctypes.POINTER(ctypes.c_ubyte)),

2476

ctypes.c_uint(len(openpgp)))

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

2477

1855

# New empty GnuTLS certificate

2478

crt = gnutls.openpgp_crt_t()

2479

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

2480

1859

# Import the OpenPGP public key into the certificate

2481

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

2482

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

2483

1864

# Verify the self signature in the key

2484

1865

crtverify = ctypes.c_uint()

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2487

1869

if crtverify.value != 0:

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2491

1873

# New buffer for the fingerprint

2492

1874

buf = ctypes.create_string_buffer(20)

2493

1875

buf_len = ctypes.c_size_t()

2494

1876

# Get the fingerprint from the certificate into the buffer

2495

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

2496

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2497

1880

# Deinit the certificate

2498

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2499

1882

# Convert the buffer to a Python bytestring

2500

1883

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

2501

1884

# Convert the bytestring to hexadecimal notation

2503

1886

return hex_fpr

2504

1887

2505

1888

2506

class MultiprocessingMixIn:

1889

class MultiprocessingMixIn(object):

2507

1890

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

2508

2509

1891

def sub_process_main(self, request, address):

2510

1892

try:

2511

1893

self.finish_request(request, address)

2512

1894

except Exception:

2513

1895

self.handle_error(request, address)

2514

1896

self.close_request(request)

2515

1897

2516

1898

def process_request(self, request, address):

2517

1899

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

2518

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

2519

args=(request, address))

1900

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

1901

args = (request, address))

2520

1902

proc.start()

2521

1903

return proc

2522

1904

2523

1905

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2525

1907

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

2526

2527

1908

def process_request(self, request, client_address):

2528

1909

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

2529

1910

2530

1911

This function creates a new pipe in self.pipe

2531

1912

"""

2532

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2533

1914

2534

1915

proc = MultiprocessingMixIn.process_request(self, request,

2535

1916

client_address)

2536

1917

self.child_pipe.close()

2537

1918

self.add_pipe(parent_pipe, proc)

2538

1919

2539

1920

def add_pipe(self, parent_pipe, proc):

2540

1921

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

2541

1922

raise NotImplementedError()

2542

1923

2543

1924

2544

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2545

socketserver.TCPServer):

1926

socketserver.TCPServer, object):

2546

1927

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

2547

1928

2548

1929

Attributes:

2549

1930

enabled: Boolean; whether this server is activated yet

2550

1931

interface: None or a network interface name (string)

2551

1932

use_ipv6: Boolean; to use IPv6 or not

2552

1933

"""

2553

2554

1934

def __init__(self, server_address, RequestHandlerClass,

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1935

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

2558

1936

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

2559

1937

creating a new one with socket.socket().

2560

1938

"""

2566

1944

self.socketfd = socketfd

2567

1945

# Save the original socket.socket() function

2568

1946

self.socket_socket = socket.socket

2569

2570

1947

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

2571

#

1948

#

2572

1949

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

2573

1950

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

2574

1951

# patching socket.socket.)

2575

#

1952

#

2576

1953

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

2577

1954

@functools.wraps(socket.socket)

2578

1955

def socket_wrapper(*args, **kwargs):

2590

1967

# socket_wrapper(), if socketfd was set.

2591

1968

socketserver.TCPServer.__init__(self, server_address,

2592

1969

RequestHandlerClass)

2593

1970

2594

1971

def server_bind(self):

2595

1972

"""This overrides the normal server_bind() function

2596

1973

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

2597

1974

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

2598

global SO_BINDTODEVICE

2599

1975

if self.interface is not None:

2600

1976

if SO_BINDTODEVICE is None:

2601

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

2602

# common enough.

2603

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

2604

SO_BINDTODEVICE = 25

2605

try:

2606

self.socket.setsockopt(

2607

socket.SOL_SOCKET, SO_BINDTODEVICE,

2608

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

2609

except socket.error as error:

2610

if error.errno == errno.EPERM:

2611

logger.error("No permission to bind to"

2612

" interface %s", self.interface)

2613

elif error.errno == errno.ENOPROTOOPT:

2614

logger.error("SO_BINDTODEVICE not available;"

2615

" cannot bind to interface %s",

2616

self.interface)

2617

elif error.errno == errno.ENODEV:

2618

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

2619

" cannot bind", self.interface)

2620

else:

2621

raise

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

2622

1999

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

2623

2000

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

2626

2001

if not self.server_address[0]:

2627

2002

if self.address_family == socket.AF_INET6:

2628

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2629

2004

else:

2630

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2631

2006

self.server_address = (any_address,

2632

2007

self.server_address[1])

2633

2008

elif not self.server_address[1]:

2634

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

2009

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

2010

0)

2635

2011

# if self.interface:

2636

2012

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

2637

2013

# 0, # port

2643

2019

2644

2020

class MandosServer(IPv6_TCPServer):

2645

2021

"""Mandos server.

2646

2022

2647

2023

Attributes:

2648

2024

clients: set of Client objects

2649

2025

gnutls_priority GnuTLS priority string

2650

2026

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

2651

2652

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2653

2029

"""

2654

2655

2030

def __init__(self, server_address, RequestHandlerClass,

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

2031

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

2032

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

2662

2033

self.enabled = False

2663

2034

self.clients = clients

2664

2035

if self.clients is None:

2667

2038

self.gnutls_priority = gnutls_priority

2668

2039

IPv6_TCPServer.__init__(self, server_address,

2669

2040

RequestHandlerClass,

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2674

2044

def server_activate(self):

2675

2045

if self.enabled:

2676

2046

return socketserver.TCPServer.server_activate(self)

2677

2047

2678

2048

def enable(self):

2679

2049

self.enabled = True

2680

2050

2681

2051

def add_pipe(self, parent_pipe, proc):

2682

2052

# Call "handle_ipc" for both data and EOF events

2683

GLib.io_add_watch(

2684

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

2685

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

2686

functools.partial(self.handle_ipc,

2687

parent_pipe=parent_pipe,

2688

proc=proc))

2689

2690

def handle_ipc(self, source, condition,

2691

parent_pipe=None,

2692

proc=None,

2693

client_object=None):

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

2694

2062

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

2695

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

2063

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

2696

2064

# Wait for other process to exit

2697

2065

proc.join()

2698

2066

return False

2699

2067

2700

2068

# Read a request from the child

2701

2069

request = parent_pipe.recv()

2702

2070

command = request[0]

2703

2071

2704

2072

if command == 'init':

2705

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

2706

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

2707

address = request[3]

2708

2709

for c in self.clients.values():

2710

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2711

continue

2712

if key_id and c.key_id == key_id:

2713

client = c

2714

break

2715

if fpr and c.fingerprint == fpr:

2073

fpr = request[1]

2074

address = request[2]

2075

2076

for c in self.clients.itervalues():

2077

if c.fingerprint == fpr:

2716

2078

client = c

2717

2079

break

2718

2080

else:

2719

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

2720

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

2081

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

2082

"dress: %s", fpr, address)

2721

2083

if self.use_dbus:

2722

2084

# Emit D-Bus signal

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2085

mandos_dbus_service.ClientNotFound(fpr,

2724

2086

address[0])

2725

2087

parent_pipe.send(False)

2726

2088

return False

2727

2728

GLib.io_add_watch(

2729

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

2730

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

2731

functools.partial(self.handle_ipc,

2732

parent_pipe=parent_pipe,

2733

proc=proc,

2734

client_object=client))

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

2735

2098

parent_pipe.send(True)

2736

2099

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

2737

2100

# same fileno

2740

2103

funcname = request[1]

2741

2104

args = request[2]

2742

2105

kwargs = request[3]

2743

2106

2744

2107

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

2745

2108

funcname)(*args,

2746

**kwargs)))

2747

2109

**kwargs)))

2110

2748

2111

if command == 'getattr':

2749

2112

attrname = request[1]

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2753

2115

else:

2754

parent_pipe.send((

2755

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

2756

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2757

2119

if command == 'setattr':

2758

2120

attrname = request[1]

2759

2121

value = request[2]

2760

2122

setattr(client_object, attrname, value)

2761

2123

2762

2124

return True

2763

2125

2764

2126

2765

2127

def rfc3339_duration_to_delta(duration):

2766

2128

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

2767

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

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

2781

True

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)

2782

2144

"""

2783

2145

2784

2146

# Parsing an RFC 3339 duration with regular expressions is not

2785

2147

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

2786

2148

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

2787

2149

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

2788

2150

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

2789

2151

# avoid excessive use of external libraries.

2790

2152

2791

2153

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

2792

Token = collections.namedtuple("Token", (

2793

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

2794

# a "group" containing digits

2795

"value", # datetime.timedelta or None

2796

"followers")) # Tokens valid after this token

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

2797

2163

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

2798

2164

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

2799

2165

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

2800

2166

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

2801

2167

datetime.timedelta(seconds=1),

2802

frozenset((token_end, )))

2168

frozenset((token_end,)))

2803

2169

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

2804

2170

datetime.timedelta(minutes=1),

2805

2171

frozenset((token_second, token_end)))

2821

2187

frozenset((token_month, token_end)))

2822

2188

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

2823

2189

datetime.timedelta(weeks=1),

2824

frozenset((token_end, )))

2190

frozenset((token_end,)))

2825

2191

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

2826

2192

frozenset((token_year, token_month,

2827

2193

token_day, token_time,

2828

2194

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2832

2197

found_token = None

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2198

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

2199

s = duration # String left to parse

2837

2200

# Loop until end token is found

2838

2201

while found_token is not token_end:

2839

2202

# Search for any currently valid tokens

2855

2218

break

2856

2219

else:

2857

2220

# No currently valid tokens were found

2858

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

2859

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2860

2222

# End token found

2861

2223

return value

2862

2224

2863

2225

2864

2226

def string_to_delta(interval):

2865

2227

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

2866

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2877

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

2878

True

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)

2879

2241

"""

2880

2242

2881

2243

try:

2882

2244

return rfc3339_duration_to_delta(interval)

2883

2245

except ValueError:

2884

2246

pass

2885

2247

2886

2248

timevalue = datetime.timedelta(0)

2887

2249

for s in interval.split():

2888

2250

try:

2899

2261

elif suffix == "w":

2900

2262

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

2901

2263

else:

2902

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2903

2266

except IndexError as e:

2904

2267

raise ValueError(*(e.args))

2905

2268

timevalue += delta

2906

2269

return timevalue

2907

2270

2908

2271

2909

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

2272

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

2910

2273

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

2911

2274

2912

2275

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

2913

2276

if os.fork():

2914

2277

sys.exit()

2921

2284

# Close all standard open file descriptors

2922

2285

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

2923

2286

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

2924

raise OSError(errno.ENODEV,

2925

"{} not a character device"

2287

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

2926

2288

.format(os.devnull))

2927

2289

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

2928

2290

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

2932

2294

2933

2295

2934

2296

def main():

2935

2297

2936

2298

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

2937

2299

# Parsing of options, both command line and config file

2938

2300

2939

2301

parser = argparse.ArgumentParser()

2940

2302

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

2941

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

2303

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

2942

2304

help="show version number and exit")

2943

2305

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

2944

2306

help="Bind to interface IF")

2980

2342

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

2981

2343

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

2982

2344

default=None)

2983

2345

2984

2346

options = parser.parse_args()

2985

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

2986

2353

# Default values for config file for server-global settings

2987

if gnutls.has_rawpk:

2988

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

2989

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

2990

else:

2991

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

2992

":+SIGN-DSA-SHA256")

2993

server_defaults = {"interface": "",

2994

"address": "",

2995

"port": "",

2996

"debug": "False",

2997

"priority": priority,

2998

"servicename": "Mandos",

2999

"use_dbus": "True",

3000

"use_ipv6": "True",

3001

"debuglevel": "",

3002

"restore": "True",

3003

"socket": "",

3004

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

3005

"foreground": "False",

3006

"zeroconf": "True",

3007

}

3008

del priority

3009

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

3010

2371

# Parse config file for server-global settings

3011

server_config = configparser.ConfigParser(server_defaults)

2372

server_config = configparser.SafeConfigParser(server_defaults)

3012

2373

del server_defaults

3013

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

3014

# 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

3015

2377

server_settings = server_config.defaults()

3016

2378

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

3017

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

3018

"foreground", "zeroconf"):

2379

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

3019

2380

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

3020

2381

option)

3021

2382

if server_settings["port"]:

3031

2392

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

3032

2393

["socket"])

3033

2394

del server_config

3034

2395

3035

2396

# Override the settings from the config file with command line

3036

2397

# options, if set.

3037

2398

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

3038

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

3039

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

3040

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

2399

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

2400

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

2401

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

3041

2402

value = getattr(options, option)

3042

2403

if value is not None:

3043

2404

server_settings[option] = value

3055

2416

if server_settings["debug"]:

3056

2417

server_settings["foreground"] = True

3057

2418

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

3058

2419

3059

2420

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

3060

3061

if (not server_settings["zeroconf"]

3062

and not (server_settings["port"]

3063

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

3064

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

3065

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

3066

2428

# For convenience

3067

2429

debug = server_settings["debug"]

3068

2430

debuglevel = server_settings["debuglevel"]

3072

2434

stored_state_file)

3073

2435

foreground = server_settings["foreground"]

3074

2436

zeroconf = server_settings["zeroconf"]

3075

2437

3076

2438

if debug:

3077

2439

initlogger(debug, logging.DEBUG)

3078

2440

else:

3081

2443

else:

3082

2444

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

3083

2445

initlogger(debug, level)

3084

2446

3085

2447

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

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3091

2454

# Parse config file with clients

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2455

client_config = configparser.SafeConfigParser(Client

2456

.client_defaults)

3093

2457

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

3094

2458

"clients.conf"))

3095

2459

3096

2460

global mandos_dbus_service

3097

2461

mandos_dbus_service = None

3098

2462

3099

2463

socketfd = None

3100

2464

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

3101

2465

socketfd = server_settings["socket"]

3102

tcp_server = MandosServer(

3103

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

3104

ClientHandler,

3105

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

3106

use_ipv6=use_ipv6,

3107

gnutls_priority=server_settings["priority"],

3108

use_dbus=use_dbus,

3109

socketfd=socketfd)

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)

3110

2476

if not foreground:

3111

2477

pidfilename = "/run/mandos.pid"

3112

2478

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

3113

2479

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

3114

2480

pidfile = None

3115

2481

try:

3116

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

2482

pidfile = open(pidfilename, "w")

3117

2483

except IOError as e:

3118

2484

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

3119

2485

exc_info=e)

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2486

2487

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

3124

2488

try:

3125

2489

uid = pwd.getpwnam(name).pw_uid

3126

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

3127

2491

break

3128

2492

except KeyError:

3129

2493

continue

3133

2497

try:

3134

2498

os.setgid(gid)

3135

2499

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

3139

2500

except OSError as error:

3140

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

3141

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

3142

2501

if error.errno != errno.EPERM:

3143

2502

raise

3144

2503

3145

2504

if debug:

3146

2505

# Enable all possible GnuTLS debugging

3147

2506

3148

2507

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

3149

2508

# - GnuTLS manual

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3153

2512

def debug_gnutls(level, string):

3154

2513

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

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3158

2518

# Redirect stdin so all checkers get /dev/null

3159

2519

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

3160

2520

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

3161

2521

if null > 2:

3162

2522

os.close(null)

3163

2523

3164

2524

# Need to fork before connecting to D-Bus

3165

2525

if not foreground:

3166

2526

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

3167

2527

daemon()

3168

3169

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

3170

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

3171

# need to inform GLib that threads will be used.

3172

GLib.threads_init()

3173

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

3174

2533

global main_loop

3175

2534

# From the Avahi example code

3176

2535

DBusGMainLoop(set_as_default=True)

3177

main_loop = GLib.MainLoop()

2536

main_loop = gobject.MainLoop()

3178

2537

bus = dbus.SystemBus()

3179

2538

# End of Avahi example code

3180

2539

if use_dbus:

3181

2540

try:

3182

2541

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

3183

bus,

3184

do_not_queue=True)

3185

old_bus_name = dbus.service.BusName(

3186

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

3187

do_not_queue=True)

3188

except dbus.exceptions.DBusException as e:

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:

3189

2547

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

3190

2548

use_dbus = False

3191

2549

server_settings["use_dbus"] = False

3192

2550

tcp_server.use_dbus = False

3193

2551

if zeroconf:

3194

2552

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3200

2557

if server_settings["interface"]:

3201

service.interface = if_nametoindex(

3202

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

3203

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3204

2562

global multiprocessing_manager

3205

2563

multiprocessing_manager = multiprocessing.Manager()

3206

2564

3207

2565

client_class = Client

3208

2566

if use_dbus:

3209

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

3210

2567

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

2568

3211

2569

client_settings = Client.config_parser(client_config)

3212

2570

old_client_settings = {}

3213

2571

clients_data = {}

3214

2572

3215

2573

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

3216

2574

global wnull

3217

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

2575

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

3218

2576

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

3219

2577

# mode

3220

2578

if debug or not foreground:

3221

2579

wnull.close()

3222

2580

3223

2581

# Get client data and settings from last running state.

3224

2582

if server_settings["restore"]:

3225

2583

try:

3226

2584

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

3227

if sys.version_info.major == 2:

3228

clients_data, old_client_settings = pickle.load(

3229

stored_state)

3230

else:

3231

bytes_clients_data, bytes_old_client_settings = (

3232

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

3233

# Fix bytes to strings

3234

# clients_data

3235

# .keys()

3236

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

3237

if isinstance(key, bytes)

3238

else key): value

3239

for key, value in

3240

bytes_clients_data.items()}

3241

del bytes_clients_data

3242

for key in clients_data:

3243

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

3244

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

3245

for k, v in

3246

clients_data[key].items()}

3247

clients_data[key] = value

3248

# .client_structure

3249

value["client_structure"] = [

3250

(s.decode("utf-8")

3251

if isinstance(s, bytes)

3252

else s) for s in

3253

value["client_structure"]]

3254

# .name, .host, and .checker_command

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host and .checker_command

3272

for value in old_client_settings.values():

3273

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

3274

if isinstance(value[attribute], bytes):

3275

value[attribute] = (value[attribute]

3276

.decode("utf-8"))

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3277

2587

os.remove(stored_state_path)

3278

2588

except IOError as e:

3279

2589

if e.errno == errno.ENOENT:

3280

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

3281

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

2590

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

2591

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

3282

2592

else:

3283

2593

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

3284

2594

exc_info=e)

3285

2595

raise

3286

2596

except EOFError as e:

3287

2597

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

3288

"EOFError:",

3289

exc_info=e)

3290

2598

"EOFError:", exc_info=e)

2599

3291

2600

with PGPEngine() as pgp:

3292

2601

for client_name, client in clients_data.items():

3293

2602

# Skip removed clients

3294

2603

if client_name not in client_settings:

3295

2604

continue

3296

2605

3297

2606

# Decide which value to use after restoring saved state.

3298

2607

# We have three different values: Old config file,

3299

2608

# new config file, and saved state.

3304

2613

# For each value in new config, check if it

3305

2614

# differs from the old config value (Except for

3306

2615

# the "secret" attribute)

3307

if (name != "secret"

3308

and (value !=

3309

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3310

2619

client[name] = value

3311

2620

except KeyError:

3312

2621

pass

3313

2622

3314

2623

# Clients who has passed its expire date can still be

3315

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3316

2625

# whose checker succeeded before we stored its state is

3317

2626

# assumed to have successfully run all checkers during

3318

2627

# downtime.

3321

2630

if not client["last_checked_ok"]:

3322

2631

logger.warning(

3323

2632

"disabling client {} - Client never "

3324

"performed a successful checker".format(

3325

client_name))

2633

"performed a successful checker"

2634

.format(client_name))

3326

2635

client["enabled"] = False

3327

2636

elif client["last_checker_status"] != 0:

3328

2637

logger.warning(

3329

2638

"disabling client {} - Client last"

3330

" checker failed with error code"

3331

" {}".format(

3332

client_name,

3333

client["last_checker_status"]))

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3334

2642

client["enabled"] = False

3335

2643

else:

3336

client["expires"] = (

3337

datetime.datetime.utcnow()

3338

+ client["timeout"])

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3339

2647

logger.debug("Last checker succeeded,"

3340

" keeping {} enabled".format(

3341

client_name))

2648

" keeping {} enabled"

2649

.format(client_name))

3342

2650

try:

3343

client["secret"] = pgp.decrypt(

3344

client["encrypted_secret"],

3345

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3346

2655

except PGPError:

3347

2656

# If decryption fails, we use secret from new settings

3348

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

3349

client_name))

3350

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

3351

["secret"])

3352

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3353

2662

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

3354

2663

for client_name in (set(old_client_settings)

3355

2664

- set(client_settings)):

3357

2666

for client_name in (set(client_settings)

3358

2667

- set(old_client_settings)):

3359

2668

clients_data[client_name] = client_settings[client_name]

3360

2669

3361

2670

# Create all client objects

3362

2671

for client_name, client in clients_data.items():

3363

2672

tcp_server.clients[client_name] = client_class(

3364

name=client_name,

3365

settings=client,

3366

server_settings=server_settings)

3367

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3368

2676

if not tcp_server.clients:

3369

2677

logger.warning("No clients defined")

3370

2678

3371

2679

if not foreground:

3372

2680

if pidfile is not None:

3373

pid = os.getpid()

3374

2681

try:

3375

2682

with pidfile:

3376

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3377

2685

except IOError:

3378

2686

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

3379

2687

pidfilename, pid)

3380

2688

del pidfile

3381

2689

del pidfilename

3382

3383

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

3384

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3385

lambda: main_loop.quit() and False)

3386

2690

2691

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

2692

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

2693

3387

2694

if use_dbus:

3388

3389

@alternate_dbus_interfaces(

3390

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

3391

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3392

2698

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

3393

3394

2699

def __init__(self):

3395

2700

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

3396

3397

2701

_interface = "se.recompile.Mandos"

3398

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3399

2709

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

3400

2710

def ClientAdded(self, objpath):

3401

2711

"D-Bus signal"

3402

2712

pass

3403

2713

3404

2714

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

3405

def ClientNotFound(self, key_id, address):

2715

def ClientNotFound(self, fingerprint, address):

3406

2716

"D-Bus signal"

3407

2717

pass

3408

3409

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

3410

"true"})

2718

3411

2719

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

3412

2720

def ClientRemoved(self, objpath, name):

3413

2721

"D-Bus signal"

3414

2722

pass

3415

3416

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

3417

"true"})

2723

3418

2724

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

3419

2725

def GetAllClients(self):

3420

2726

"D-Bus method"

3421

return dbus.Array(c.dbus_object_path for c in

3422

tcp_server.clients.values())

3423

3424

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

3425

"true"})

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3426

2731

@dbus.service.method(_interface,

3427

2732

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

3428

2733

def GetAllClientsWithProperties(self):

3429

2734

"D-Bus method"

3430

2735

return dbus.Dictionary(

3431

{c.dbus_object_path: c.GetAll(

3432

"se.recompile.Mandos.Client")

3433

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

2736

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

2737

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

3434

2738

signature="oa{sv}")

3435

2739

3436

2740

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

3437

2741

def RemoveClient(self, object_path):

3438

2742

"D-Bus method"

3439

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3440

2744

if c.dbus_object_path == object_path:

3441

2745

del tcp_server.clients[c.name]

3442

2746

c.remove_from_connection()

3443

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3444

2748

c.disable(quiet=True)

3445

# Emit D-Bus signal for removal

3446

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3447

2751

return

3448

2752

raise KeyError(object_path)

3449

2753

3450

2754

del _interface

3451

3452

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3453

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

3454

def GetManagedObjects(self):

3455

"""D-Bus method"""

3456

return dbus.Dictionary(

3457

{client.dbus_object_path:

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()})

3462

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

3463

3464

def client_added_signal(self, client):

3465

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

3466

if use_dbus:

3467

# New standard signal

3468

self.InterfacesAdded(

3469

client.dbus_object_path,

3470

dbus.Dictionary(

3471

{interface: client.GetAll(interface)

3472

for interface in

3473

client._get_all_interface_names()}))

3474

# Old signal

3475

self.ClientAdded(client.dbus_object_path)

3476

3477

def client_removed_signal(self, client):

3478

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

3479

if use_dbus:

3480

# New standard signal

3481

self.InterfacesRemoved(

3482

client.dbus_object_path,

3483

client._get_all_interface_names())

3484

# Old signal

3485

self.ClientRemoved(client.dbus_object_path,

3486

client.name)

3487

2755

3488

2756

mandos_dbus_service = MandosDBusService()

3489

3490

# Save modules to variables to exempt the modules from being

3491

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

3492

mp = multiprocessing

3493

wn = wnull

3494

2757

3495

2758

def cleanup():

3496

2759

"Cleanup function; run on exit"

3497

2760

if zeroconf:

3498

2761

service.cleanup()

3499

3500

mp.active_children()

3501

wn.close()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3502

2765

if not (tcp_server.clients or client_settings):

3503

2766

return

3504

2767

3505

2768

# Store client before exiting. Secrets are encrypted with key

3506

2769

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

3507

2770

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

3508

2771

clients = {}

3509

2772

with PGPEngine() as pgp:

3510

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3511

2774

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

3512

2775

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

3513

2776

key)

3514

2777

client_dict = {}

3515

2778

3516

2779

# A list of attributes that can not be pickled

3517

2780

# + secret.

3518

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

3519

"checker", "server_settings"}

3520

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

3521

.Object):

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3522

2785

exclude.add(name)

3523

2786

3524

2787

client_dict["encrypted_secret"] = (client

3525

2788

.encrypted_secret)

3526

2789

for attr in client.client_structure:

3527

2790

if attr not in exclude:

3528

2791

client_dict[attr] = getattr(client, attr)

3529

2792

3530

2793

clients[client.name] = client_dict

3531

2794

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

3532

2795

3533

2796

try:

3534

with tempfile.NamedTemporaryFile(

3535

mode='wb',

3536

suffix=".pickle",

3537

prefix='clients-',

3538

dir=os.path.dirname(stored_state_path),

3539

delete=False) as stored_state:

3540

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

3541

protocol=2)

3542

tempname = stored_state.name

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

3543

2803

os.rename(tempname, stored_state_path)

3544

2804

except (IOError, OSError) as e:

3545

2805

if not debug:

3554

2814

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

3555

2815

exc_info=e)

3556

2816

raise

3557

2817

3558

2818

# Delete all clients, and settings from config

3559

2819

while tcp_server.clients:

3560

2820

name, client = tcp_server.clients.popitem()

3561

2821

if use_dbus:

3562

2822

client.remove_from_connection()

3563

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3564

2824

client.disable(quiet=True)

3565

# Emit D-Bus signal for removal

3566

2825

if use_dbus:

3567

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)

3568

2830

client_settings.clear()

3569

2831

3570

2832

atexit.register(cleanup)

3571

3572

for client in tcp_server.clients.values():

2833

2834

for client in tcp_server.clients.itervalues():

3573

2835

if use_dbus:

3574

# Emit D-Bus signal for adding

3575

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3576

2838

# Need to initiate checking of clients

3577

2839

if client.enabled:

3578

2840

client.init_checker()

3579

2841

3580

2842

tcp_server.enable()

3581

2843

tcp_server.server_activate()

3582

2844

3583

2845

# Find out what port we got

3584

2846

if zeroconf:

3585

2847

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

3590

2852

else: # IPv4

3591

2853

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

3592

2854

*tcp_server.socket.getsockname())

3593

3594

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

3595

2855

2856

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

2857

3596

2858

try:

3597

2859

if zeroconf:

3598

2860

# From the Avahi example code

3603

2865

cleanup()

3604

2866

sys.exit(1)

3605

2867

# End of Avahi example code

3606

3607

GLib.io_add_watch(

3608

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

3609

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3610

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

3611

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

3612

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

3613

2874

logger.debug("Starting main loop")

3614

2875

main_loop.run()

3615

2876

except AvahiError as error:

3624

2885

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

3625

2886

cleanup()

3626

2887

3627

3628

def should_only_run_tests():

3629

parser = argparse.ArgumentParser(add_help=False)

3630

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

3631

args, unknown_args = parser.parse_known_args()

3632

run_tests = args.check

3633

if run_tests:

3634

# Remove --check argument from sys.argv

3635

sys.argv[1:] = unknown_args

3636

return run_tests

3637

3638

# Add all tests from doctest strings

3639

def load_tests(loader, tests, none):

3640

import doctest

3641

tests.addTests(doctest.DocTestSuite())

3642

return tests

3643

3644

2888

if __name__ == '__main__':

3645

try:

3646

if should_only_run_tests():

3647

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

3648

unittest.main()

3649

else:

3650

main()

3651

finally:

3652

logging.shutdown()

2889

main()