/mandos/release : revision 237.7.749

1

#!/usr/bin/python2.7

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

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

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

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

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import unittest

81

import random

72

82

73

83

import dbus

74

84

import dbus.service

75

import gobject

76

import avahi

85

import gi

86

from gi.repository import GLib

77

87

from dbus.mainloop.glib import DBusGMainLoop

78

88

import ctypes

79

89

import ctypes.util

80

90

import xml.dom.minidom

81

91

import inspect

82

92

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

# Show warnings by default

98

if not sys.warnoptions:

99

import warnings

100

warnings.simplefilter("default")

101

102

# Try to find the value of SO_BINDTODEVICE:

83

103

try:

104

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

105

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

84

106

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

107

except AttributeError:

86

108

try:

109

# This is where SO_BINDTODEVICE was up to and including Python

110

# 2.6, and also 3.2:

87

111

from IN import SO_BINDTODEVICE

88

112

except ImportError:

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

113

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

114

# Try running the C preprocessor:

115

try:

116

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

117

"/dev/stdin"],

118

stdin=subprocess.PIPE,

119

stdout=subprocess.PIPE)

120

stdout = cc.communicate(

121

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

122

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

123

except (OSError, ValueError, IndexError):

124

# No value found

125

SO_BINDTODEVICE = None

126

127

if sys.version_info < (3, 2):

128

configparser.Configparser = configparser.SafeConfigParser

129

130

version = "1.8.9"

95

131

stored_state_file = "clients.pickle"

96

132

97

133

logger = logging.getLogger()

134

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

98

135

syslogger = None

99

136

100

137

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

138

if_nametoindex = ctypes.cdll.LoadLibrary(

139

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

104

140

except (OSError, AttributeError):

141

105

142

def if_nametoindex(interface):

106

143

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

107

144

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

112

149

return interface_index

113

150

114

151

152

def copy_function(func):

153

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

154

if sys.version_info.major == 2:

155

return types.FunctionType(func.func_code,

156

func.func_globals,

157

func.func_name,

158

func.func_defaults,

159

func.func_closure)

160

else:

161

return types.FunctionType(func.__code__,

162

func.__globals__,

163

func.__name__,

164

func.__defaults__,

165

func.__closure__)

166

167

115

168

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

116

169

"""init logger and add loglevel"""

117

170

118

171

global syslogger

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

172

syslogger = (logging.handlers.SysLogHandler(

173

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

174

address="/dev/log"))

123

175

syslogger.setFormatter(logging.Formatter

124

176

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

125

177

' %(message)s'))

126

178

logger.addHandler(syslogger)

127

179

128

180

if debug:

129

181

console = logging.StreamHandler()

130

182

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

140

192

pass

141

193

142

194

143

class PGPEngine(object):

195

class PGPEngine:

144

196

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

197

145

198

def __init__(self):

146

199

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

200

self.gpg = "gpg"

201

try:

202

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

203

for line in output.splitlines():

204

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

205

if name == b"gpg":

206

self.gpg = path

207

break

208

except OSError as e:

209

if e.errno != errno.ENOENT:

210

raise

147

211

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

212

'--homedir', self.tempdir,

149

213

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

214

'--quiet']

215

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

216

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

217

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

218

153

219

def __enter__(self):

154

220

return self

155

221

156

222

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

157

223

self._cleanup()

158

224

return False

159

225

160

226

def __del__(self):

161

227

self._cleanup()

162

228

163

229

def _cleanup(self):

164

230

if self.tempdir is not None:

165

231

# Delete contents of tempdir

166

232

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

167

topdown = False):

233

topdown=False):

168

234

for filename in files:

169

235

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

170

236

for dirname in dirs:

172

238

# Remove tempdir

173

239

os.rmdir(self.tempdir)

174

240

self.tempdir = None

175

241

176

242

def password_encode(self, password):

177

243

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

178

244

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

183

249

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

184

250

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

185

251

return encoded

186

252

187

253

def encrypt(self, data, password):

188

254

passphrase = self.password_encode(password)

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

255

with tempfile.NamedTemporaryFile(

256

dir=self.tempdir) as passfile:

191

257

passfile.write(passphrase)

192

258

passfile.flush()

193

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

259

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

194

260

'--passphrase-file',

195

261

passfile.name]

196

262

+ self.gnupgargs,

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

263

stdin=subprocess.PIPE,

264

stdout=subprocess.PIPE,

265

stderr=subprocess.PIPE)

266

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

201

267

if proc.returncode != 0:

202

268

raise PGPError(err)

203

269

return ciphertext

204

270

205

271

def decrypt(self, data, password):

206

272

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

273

with tempfile.NamedTemporaryFile(

274

dir=self.tempdir) as passfile:

209

275

passfile.write(passphrase)

210

276

passfile.flush()

211

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

277

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

212

278

'--passphrase-file',

213

279

passfile.name]

214

280

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

281

stdin=subprocess.PIPE,

282

stdout=subprocess.PIPE,

283

stderr=subprocess.PIPE)

284

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

220

285

if proc.returncode != 0:

221

286

raise PGPError(err)

222

287

return decrypted_plaintext

223

288

224

289

290

# Pretend that we have an Avahi module

291

class avahi:

292

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

293

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

294

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

295

PROTO_INET = 0 # avahi-common/address.h

296

PROTO_INET6 = 1 # avahi-common/address.h

297

DBUS_NAME = "org.freedesktop.Avahi"

298

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

299

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

300

DBUS_PATH_SERVER = "/"

301

302

@staticmethod

303

def string_array_to_txt_array(t):

304

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

305

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

306

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

307

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

308

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

309

SERVER_INVALID = 0 # avahi-common/defs.h

310

SERVER_REGISTERING = 1 # avahi-common/defs.h

311

SERVER_RUNNING = 2 # avahi-common/defs.h

312

SERVER_COLLISION = 3 # avahi-common/defs.h

313

SERVER_FAILURE = 4 # avahi-common/defs.h

314

315

225

316

class AvahiError(Exception):

226

317

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

227

318

self.value = value

228

319

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

229

320

**kwargs)

230

321

322

231

323

class AvahiServiceError(AvahiError):

232

324

pass

233

325

326

234

327

class AvahiGroupError(AvahiError):

235

328

pass

236

329

237

330

238

class AvahiService(object):

331

class AvahiService:

239

332

"""An Avahi (Zeroconf) service.

240

333

241

334

Attributes:

242

335

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

243

336

Used to optionally bind to the specified interface.

255

348

server: D-Bus Server

256

349

bus: dbus.SystemBus()

257

350

"""

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

351

352

def __init__(self,

353

interface=avahi.IF_UNSPEC,

354

name=None,

355

servicetype=None,

356

port=None,

357

TXT=None,

358

domain="",

359

host="",

360

max_renames=32768,

361

protocol=avahi.PROTO_UNSPEC,

362

bus=None):

263

363

self.interface = interface

264

364

self.name = name

265

365

self.type = servicetype

274

374

self.server = None

275

375

self.bus = bus

276

376

self.entry_group_state_changed_match = None

277

377

278

378

def rename(self, remove=True):

279

379

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

280

380

if self.rename_count >= self.max_renames:

282

382

" after %i retries, exiting.",

283

383

self.rename_count)

284

384

raise AvahiServiceError("Too many renames")

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

385

self.name = str(

386

self.server.GetAlternativeServiceName(self.name))

287

387

self.rename_count += 1

288

388

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

289

389

self.name)

300

400

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

301

401

self.cleanup()

302

402

os._exit(1)

303

403

304

404

def remove(self):

305

405

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

306

406

if self.entry_group_state_changed_match is not None:

308

408

self.entry_group_state_changed_match = None

309

409

if self.group is not None:

310

410

self.group.Reset()

311

411

312

412

def add(self):

313

413

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

314

414

self.remove()

331

431

dbus.UInt16(self.port),

332

432

avahi.string_array_to_txt_array(self.TXT))

333

433

self.group.Commit()

334

434

335

435

def entry_group_state_changed(self, state, error):

336

436

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

337

437

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

338

438

339

439

if state == avahi.ENTRY_GROUP_ESTABLISHED:

340

440

logger.debug("Zeroconf service established.")

341

441

elif state == avahi.ENTRY_GROUP_COLLISION:

344

444

elif state == avahi.ENTRY_GROUP_FAILURE:

345

445

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

346

446

str(error))

347

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

348

.format(error))

349

447

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

448

350

449

def cleanup(self):

351

450

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

352

451

if self.group is not None:

357

456

pass

358

457

self.group = None

359

458

self.remove()

360

459

361

460

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

362

461

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

363

462

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

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

463

bad_states = {

464

avahi.SERVER_INVALID: "Zeroconf server invalid",

465

avahi.SERVER_REGISTERING: None,

466

avahi.SERVER_COLLISION: "Zeroconf server name collision",

467

avahi.SERVER_FAILURE: "Zeroconf server failure",

468

}

371

469

if state in bad_states:

372

470

if bad_states[state] is not None:

373

471

if error is None:

376

474

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

377

475

self.cleanup()

378

476

elif state == avahi.SERVER_RUNNING:

379

self.add()

477

try:

478

self.add()

479

except dbus.exceptions.DBusException as error:

480

if (error.get_dbus_name()

481

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

482

logger.info("Local Zeroconf service name"

483

" collision.")

484

return self.rename(remove=False)

485

else:

486

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

487

self.cleanup()

488

os._exit(1)

380

489

else:

381

490

if error is None:

382

491

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

383

492

else:

384

493

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

385

494

386

495

def activate(self):

387

496

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

388

497

if self.server is None:

392

501

follow_name_owner_changes=True),

393

502

avahi.DBUS_INTERFACE_SERVER)

394

503

self.server.connect_to_signal("StateChanged",

395

self.server_state_changed)

504

self.server_state_changed)

396

505

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

397

506

398

507

399

508

class AvahiServiceToSyslog(AvahiService):

400

509

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

401

510

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

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

511

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

512

syslogger.setFormatter(logging.Formatter(

513

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

514

.format(self.name)))

407

515

return ret

408

516

409

517

410

class Client(object):

518

# Pretend that we have a GnuTLS module

519

class gnutls:

520

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

521

522

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

523

if library is None:

524

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

525

_library = ctypes.cdll.LoadLibrary(library)

526

del library

527

528

# Unless otherwise indicated, the constants and types below are

529

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

530

531

# Constants

532

E_SUCCESS = 0

533

E_INTERRUPTED = -52

534

E_AGAIN = -28

535

CRT_OPENPGP = 2

536

CRT_RAWPK = 3

537

CLIENT = 2

538

SHUT_RDWR = 0

539

CRD_CERTIFICATE = 1

540

E_NO_CERTIFICATE_FOUND = -49

541

X509_FMT_DER = 0

542

NO_TICKETS = 1<<10

543

ENABLE_RAWPK = 1<<18

544

CTYPE_PEERS = 3

545

KEYID_USE_SHA256 = 1 # gnutls/x509.h

546

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

547

548

# Types

549

class session_int(ctypes.Structure):

550

_fields_ = []

551

session_t = ctypes.POINTER(session_int)

552

553

class certificate_credentials_st(ctypes.Structure):

554

_fields_ = []

555

certificate_credentials_t = ctypes.POINTER(

556

certificate_credentials_st)

557

certificate_type_t = ctypes.c_int

558

559

class datum_t(ctypes.Structure):

560

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

561

('size', ctypes.c_uint)]

562

563

class openpgp_crt_int(ctypes.Structure):

564

_fields_ = []

565

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

566

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

567

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

568

credentials_type_t = ctypes.c_int

569

transport_ptr_t = ctypes.c_void_p

570

close_request_t = ctypes.c_int

571

572

# Exceptions

573

class Error(Exception):

574

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

575

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

576

# code is passed, convert it to a string with

577

# gnutls.strerror()

578

self.code = code

579

if message is None and code is not None:

580

message = gnutls.strerror(code)

581

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

582

message, *args)

583

584

class CertificateSecurityError(Error):

585

pass

586

587

# Classes

588

class Credentials:

589

def __init__(self):

590

self._c_object = gnutls.certificate_credentials_t()

591

gnutls.certificate_allocate_credentials(

592

ctypes.byref(self._c_object))

593

self.type = gnutls.CRD_CERTIFICATE

594

595

def __del__(self):

596

gnutls.certificate_free_credentials(self._c_object)

597

598

class ClientSession:

599

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

600

self._c_object = gnutls.session_t()

601

gnutls_flags = gnutls.CLIENT

602

if gnutls.check_version(b"3.5.6"):

603

gnutls_flags |= gnutls.NO_TICKETS

604

if gnutls.has_rawpk:

605

gnutls_flags |= gnutls.ENABLE_RAWPK

606

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

607

del gnutls_flags

608

gnutls.set_default_priority(self._c_object)

609

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

610

gnutls.handshake_set_private_extensions(self._c_object,

611

True)

612

self.socket = socket

613

if credentials is None:

614

credentials = gnutls.Credentials()

615

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

616

ctypes.cast(credentials._c_object,

617

ctypes.c_void_p))

618

self.credentials = credentials

619

620

def __del__(self):

621

gnutls.deinit(self._c_object)

622

623

def handshake(self):

624

return gnutls.handshake(self._c_object)

625

626

def send(self, data):

627

data = bytes(data)

628

data_len = len(data)

629

while data_len > 0:

630

data_len -= gnutls.record_send(self._c_object,

631

data[-data_len:],

632

data_len)

633

634

def bye(self):

635

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

636

637

# Error handling functions

638

def _error_code(result):

639

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

640

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

641

if result >= 0:

642

return result

643

if result == gnutls.E_NO_CERTIFICATE_FOUND:

644

raise gnutls.CertificateSecurityError(code=result)

645

raise gnutls.Error(code=result)

646

647

def _retry_on_error(result, func, arguments):

648

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

649

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

650

while result < 0:

651

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

652

return _error_code(result)

653

result = func(*arguments)

654

return result

655

656

# Unless otherwise indicated, the function declarations below are

657

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

658

659

# Functions

660

priority_set_direct = _library.gnutls_priority_set_direct

661

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

662

ctypes.POINTER(ctypes.c_char_p)]

663

priority_set_direct.restype = _error_code

664

665

init = _library.gnutls_init

666

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

667

init.restype = _error_code

668

669

set_default_priority = _library.gnutls_set_default_priority

670

set_default_priority.argtypes = [session_t]

671

set_default_priority.restype = _error_code

672

673

record_send = _library.gnutls_record_send

674

record_send.argtypes = [session_t, ctypes.c_void_p,

675

ctypes.c_size_t]

676

record_send.restype = ctypes.c_ssize_t

677

record_send.errcheck = _retry_on_error

678

679

certificate_allocate_credentials = (

680

_library.gnutls_certificate_allocate_credentials)

681

certificate_allocate_credentials.argtypes = [

682

ctypes.POINTER(certificate_credentials_t)]

683

certificate_allocate_credentials.restype = _error_code

684

685

certificate_free_credentials = (

686

_library.gnutls_certificate_free_credentials)

687

certificate_free_credentials.argtypes = [

688

certificate_credentials_t]

689

certificate_free_credentials.restype = None

690

691

handshake_set_private_extensions = (

692

_library.gnutls_handshake_set_private_extensions)

693

handshake_set_private_extensions.argtypes = [session_t,

694

ctypes.c_int]

695

handshake_set_private_extensions.restype = None

696

697

credentials_set = _library.gnutls_credentials_set

698

credentials_set.argtypes = [session_t, credentials_type_t,

699

ctypes.c_void_p]

700

credentials_set.restype = _error_code

701

702

strerror = _library.gnutls_strerror

703

strerror.argtypes = [ctypes.c_int]

704

strerror.restype = ctypes.c_char_p

705

706

certificate_type_get = _library.gnutls_certificate_type_get

707

certificate_type_get.argtypes = [session_t]

708

certificate_type_get.restype = _error_code

709

710

certificate_get_peers = _library.gnutls_certificate_get_peers

711

certificate_get_peers.argtypes = [session_t,

712

ctypes.POINTER(ctypes.c_uint)]

713

certificate_get_peers.restype = ctypes.POINTER(datum_t)

714

715

global_set_log_level = _library.gnutls_global_set_log_level

716

global_set_log_level.argtypes = [ctypes.c_int]

717

global_set_log_level.restype = None

718

719

global_set_log_function = _library.gnutls_global_set_log_function

720

global_set_log_function.argtypes = [log_func]

721

global_set_log_function.restype = None

722

723

deinit = _library.gnutls_deinit

724

deinit.argtypes = [session_t]

725

deinit.restype = None

726

727

handshake = _library.gnutls_handshake

728

handshake.argtypes = [session_t]

729

handshake.restype = _error_code

730

handshake.errcheck = _retry_on_error

731

732

transport_set_ptr = _library.gnutls_transport_set_ptr

733

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

734

transport_set_ptr.restype = None

735

736

bye = _library.gnutls_bye

737

bye.argtypes = [session_t, close_request_t]

738

bye.restype = _error_code

739

bye.errcheck = _retry_on_error

740

741

check_version = _library.gnutls_check_version

742

check_version.argtypes = [ctypes.c_char_p]

743

check_version.restype = ctypes.c_char_p

744

745

_need_version = b"3.3.0"

746

if check_version(_need_version) is None:

747

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

748

.format(_need_version))

749

750

_tls_rawpk_version = b"3.6.6"

751

has_rawpk = bool(check_version(_tls_rawpk_version))

752

753

if has_rawpk:

754

# Types

755

class pubkey_st(ctypes.Structure):

756

_fields = []

757

pubkey_t = ctypes.POINTER(pubkey_st)

758

759

x509_crt_fmt_t = ctypes.c_int

760

761

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

762

pubkey_init = _library.gnutls_pubkey_init

763

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

764

pubkey_init.restype = _error_code

765

766

pubkey_import = _library.gnutls_pubkey_import

767

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

768

x509_crt_fmt_t]

769

pubkey_import.restype = _error_code

770

771

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

772

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

773

ctypes.POINTER(ctypes.c_ubyte),

774

ctypes.POINTER(ctypes.c_size_t)]

775

pubkey_get_key_id.restype = _error_code

776

777

pubkey_deinit = _library.gnutls_pubkey_deinit

778

pubkey_deinit.argtypes = [pubkey_t]

779

pubkey_deinit.restype = None

780

else:

781

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

782

783

openpgp_crt_init = _library.gnutls_openpgp_crt_init

784

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

785

openpgp_crt_init.restype = _error_code

786

787

openpgp_crt_import = _library.gnutls_openpgp_crt_import

788

openpgp_crt_import.argtypes = [openpgp_crt_t,

789

ctypes.POINTER(datum_t),

790

openpgp_crt_fmt_t]

791

openpgp_crt_import.restype = _error_code

792

793

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

794

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

795

ctypes.POINTER(ctypes.c_uint)]

796

openpgp_crt_verify_self.restype = _error_code

797

798

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

799

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

800

openpgp_crt_deinit.restype = None

801

802

openpgp_crt_get_fingerprint = (

803

_library.gnutls_openpgp_crt_get_fingerprint)

804

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

805

ctypes.c_void_p,

806

ctypes.POINTER(

807

ctypes.c_size_t)]

808

openpgp_crt_get_fingerprint.restype = _error_code

809

810

if check_version(b"3.6.4"):

811

certificate_type_get2 = _library.gnutls_certificate_type_get2

812

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

813

certificate_type_get2.restype = _error_code

814

815

# Remove non-public functions

816

del _error_code, _retry_on_error

817

818

819

def call_pipe(connection, # : multiprocessing.Connection

820

func, *args, **kwargs):

821

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

822

823

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

824

return value on the provided multiprocessing.Connection.

825

"""

826

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

827

connection.close()

828

829

830

class Client:

411

831

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

412

832

413

833

Attributes:

414

834

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

415

835

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

416

836

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

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

837

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

838

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

839

running.

840

checker_callback_tag: a GLib event source tag, or None

421

841

checker_command: string; External command which is run to check

422

842

if client lives. %() expansions are done at

423

843

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

424

844

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

425

checker_initiator_tag: a gobject event source tag, or None

845

checker_initiator_tag: a GLib event source tag, or None

426

846

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

427

847

client_structure: Object describing what attributes a client has

428

848

and is used for storing the client at exit

429

849

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

850

disable_initiator_tag: a GLib event source tag, or None

431

851

enabled: bool()

432

852

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

433

uniquely identify the client

853

uniquely identify an OpenPGP client

854

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

855

a client using raw public keys

434

856

host: string; available for use by the checker command

435

857

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

436

858

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

438

860

last_checker_status: integer between 0 and 255 reflecting exit

439

861

status of last checker. -1 reflects crashed

440

862

checker, -2 means no checker completed yet.

863

last_checker_signal: The signal which killed the last checker, if

864

last_checker_status is -1

441

865

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

442

866

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

443

867

D-Bus identifiers

450

874

disabled, or None

451

875

server_settings: The server_settings dict from main()

452

876

"""

453

877

454

878

runtime_expansions = ("approval_delay", "approval_duration",

455

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

879

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

456

880

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

457

881

"last_approval_request", "last_checked_ok",

458

882

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

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

883

client_defaults = {

884

"timeout": "PT5M",

885

"extended_timeout": "PT15M",

886

"interval": "PT2M",

887

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

888

"host": "",

889

"approval_delay": "PT0S",

890

"approval_duration": "PT1S",

891

"approved_by_default": "True",

892

"enabled": "True",

893

}

894

470

895

@staticmethod

471

896

def config_parser(config):

472

897

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

479

904

for client_name in config.sections():

480

905

section = dict(config.items(client_name))

481

906

client = settings[client_name] = {}

482

907

483

908

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

484

909

# Reformat values from string types to Python types

485

910

client["approved_by_default"] = config.getboolean(

486

911

client_name, "approved_by_default")

487

912

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

488

913

"enabled")

489

914

915

# Uppercase and remove spaces from key_id and fingerprint

916

# for later comparison purposes with return value from the

917

# key_id() and fingerprint() functions

918

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

919

.replace(" ", ""))

490

920

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

491

921

.replace(" ", ""))

492

922

if "secret" in section:

493

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

923

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

924

.encode("utf-8"),

925

"base64")

494

926

elif "secfile" in section:

495

927

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

496

928

(section["secfile"])),

511

943

client["last_approval_request"] = None

512

944

client["last_checked_ok"] = None

513

945

client["last_checker_status"] = -2

514

946

515

947

return settings

516

517

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

948

949

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

518

950

self.name = name

519

951

if server_settings is None:

520

952

server_settings = {}

522

954

# adding all client settings

523

955

for setting, value in settings.items():

524

956

setattr(self, setting, value)

525

957

526

958

if self.enabled:

527

959

if not hasattr(self, "last_enabled"):

528

960

self.last_enabled = datetime.datetime.utcnow()

532

964

else:

533

965

self.last_enabled = None

534

966

self.expires = None

535

967

536

968

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

537

# Uppercase and remove spaces from fingerprint for later

538

# comparison purposes with return value from the fingerprint()

539

# function

969

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

540

970

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

541

971

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

542

972

datetime.datetime.utcnow())

543

973

544

974

# attributes specific for this server instance

545

975

self.checker = None

546

976

self.checker_initiator_tag = None

549

979

self.current_checker_command = None

550

980

self.approved = None

551

981

self.approvals_pending = 0

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

982

self.changedstate = multiprocessing_manager.Condition(

983

multiprocessing_manager.Lock())

984

self.client_structure = [attr

985

for attr in self.__dict__.keys()

557

986

if not attr.startswith("_")]

558

987

self.client_structure.append("client_structure")

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

988

989

for name, t in inspect.getmembers(

990

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

564

991

if not name.startswith("_"):

565

992

self.client_structure.append(name)

566

993

567

994

# Send notice to process children that client state has changed

568

995

def send_changedstate(self):

569

996

with self.changedstate:

570

997

self.changedstate.notify_all()

571

998

572

999

def enable(self):

573

1000

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

574

1001

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

579

1006

self.last_enabled = datetime.datetime.utcnow()

580

1007

self.init_checker()

581

1008

self.send_changedstate()

582

1009

583

1010

def disable(self, quiet=True):

584

1011

"""Disable this client."""

585

1012

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

587

1014

if not quiet:

588

1015

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

589

1016

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

590

gobject.source_remove(self.disable_initiator_tag)

1017

GLib.source_remove(self.disable_initiator_tag)

591

1018

self.disable_initiator_tag = None

592

1019

self.expires = None

593

1020

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

594

gobject.source_remove(self.checker_initiator_tag)

1021

GLib.source_remove(self.checker_initiator_tag)

595

1022

self.checker_initiator_tag = None

596

1023

self.stop_checker()

597

1024

self.enabled = False

598

1025

if not quiet:

599

1026

self.send_changedstate()

600

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

1027

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

601

1028

return False

602

1029

603

1030

def __del__(self):

604

1031

self.disable()

605

1032

606

1033

def init_checker(self):

607

1034

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

608

1035

# and every interval from then on.

609

1036

if self.checker_initiator_tag is not None:

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

1037

GLib.source_remove(self.checker_initiator_tag)

1038

self.checker_initiator_tag = GLib.timeout_add(

1039

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

1040

+ 1)),

1041

self.start_checker)

615

1042

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

616

1043

if self.disable_initiator_tag is not None:

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

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)

622

1047

# Also start a new checker *right now*.

623

1048

self.start_checker()

624

625

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

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

626

1052

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

if self.checker is not None:

1057

self.checker.join()

627

1058

self.checker_callback_tag = None

628

1059

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

631

1064

if self.last_checker_status == 0:

632

1065

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

633

1066

vars(self))

634

1067

self.checked_ok()

635

1068

else:

636

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

637

vars(self))

1069

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

638

1070

else:

639

1071

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

640

1073

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

641

1074

vars(self))

642

1075

return False

1076

643

1077

def checked_ok(self):

644

1078

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

645

1079

self.last_checked_ok = datetime.datetime.utcnow()

646

1080

self.last_checker_status = 0

1081

self.last_checker_signal = None

647

1082

self.bump_timeout()

648

1083

649

1084

def bump_timeout(self, timeout=None):

650

1085

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

651

1086

if timeout is None:

652

1087

timeout = self.timeout

653

1088

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1089

GLib.source_remove(self.disable_initiator_tag)

655

1090

self.disable_initiator_tag = None

656

1091

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

660

1094

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

661

1095

662

1096

def need_approval(self):

663

1097

self.last_approval_request = datetime.datetime.utcnow()

664

1098

665

1099

def start_checker(self):

666

1100

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

667

1101

668

1102

If a checker already exists, leave it running and do

669

1103

nothing."""

670

1104

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

675

1109

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

676

1110

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

677

1111

# should be.

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)

1112

1113

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

1114

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

1115

self.checker.join()

1116

self.checker = None

693

1117

# Start a new checker if needed

694

1118

if self.checker is None:

695

1119

# Escape attributes for the shell

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1120

escaped_attrs = {

1121

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

1122

for attr in self.runtime_expansions}

699

1123

try:

700

1124

command = self.checker_command % escaped_attrs

701

1125

except TypeError as error:

702

1126

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1127

self.checker_command,

1128

exc_info=error)

1129

return True # Try again later

705

1130

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

727

exc_info=error)

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

1131

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

1132

self.name)

1133

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

1134

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

1135

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

1136

# always replaced by /dev/null.)

1137

# The exception is when not debugging but nevertheless

1138

# running in the foreground; use the previously

1139

# created wnull.

1140

popen_args = {"close_fds": True,

1141

"shell": True,

1142

"cwd": "/"}

1143

if (not self.server_settings["debug"]

1144

and self.server_settings["foreground"]):

1145

popen_args.update({"stdout": wnull,

1146

"stderr": wnull})

1147

pipe = multiprocessing.Pipe(duplex=False)

1148

self.checker = multiprocessing.Process(

1149

target=call_pipe,

1150

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

1151

kwargs=popen_args)

1152

self.checker.start()

1153

self.checker_callback_tag = GLib.io_add_watch(

1154

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

1155

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1156

self.checker_callback, pipe[0], command)

1157

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

748

1158

return True

749

1159

750

1160

def stop_checker(self):

751

1161

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

752

1162

if self.checker_callback_tag:

753

gobject.source_remove(self.checker_callback_tag)

1163

GLib.source_remove(self.checker_callback_tag)

754

1164

self.checker_callback_tag = None

755

1165

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

756

1166

return

757

1167

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

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

self.checker.terminate()

766

1169

self.checker = None

767

1170

768

1171

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

771

1176

"""Decorators for marking methods of a DBusObjectWithProperties to

772

1177

become properties on the D-Bus.

773

1178

774

1179

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

775

1180

and with one argument by "Set".

776

1181

777

1182

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

778

1183

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

779

1184

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

783

1188

if byte_arrays and signature != "ay":

784

1189

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

785

1190

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

1191

786

1192

def decorator(func):

787

1193

func._dbus_is_property = True

788

1194

func._dbus_interface = dbus_interface

791

1197

func._dbus_name = func.__name__

792

1198

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

793

1199

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

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

795

1201

return func

1202

796

1203

return decorator

797

1204

798

1205

799

1206

def dbus_interface_annotations(dbus_interface):

800

1207

"""Decorator for marking functions returning interface annotations

801

1208

802

1209

Usage:

803

1210

804

1211

@dbus_interface_annotations("org.example.Interface")

805

1212

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

806

1213

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

807

1214

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

808

1215

"false"}

809

1216

"""

1217

810

1218

def decorator(func):

811

1219

func._dbus_is_interface = True

812

1220

func._dbus_interface = dbus_interface

813

1221

func._dbus_name = dbus_interface

814

1222

return func

1223

815

1224

return decorator

816

1225

817

1226

818

1227

def dbus_annotations(annotations):

819

1228

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

820

1229

Usage:

821

1230

822

1231

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

823

1232

"org.freedesktop.DBus.Property."

824

1233

"EmitsChangedSignal": "false"})

826

1235

access="r")

827

1236

def Property_dbus_property(self):

828

1237

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

829

1240

"""

1241

830

1242

def decorator(func):

831

1243

func._dbus_annotations = annotations

832

1244

return func

1245

833

1246

return decorator

834

1247

835

1248

838

1251

"""

839

1252

pass

840

1253

1254

841

1255

class DBusPropertyAccessException(DBusPropertyException):

842

1256

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

843

1257

"""

850

1264

pass

851

1265

852

1266

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.

1267

class DBusObjectWithAnnotations(dbus.service.Object):

1268

"""A D-Bus object with annotations.

1269

1270

Classes inheriting from this can use the dbus_annotations

1271

decorator to add annotations to methods or signals.

859

1272

"""

860

1273

861

1274

@staticmethod

862

1275

def _is_dbus_thing(thing):

863

1276

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

864

1277

865

1278

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

866

1279

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

867

1280

"""

868

1281

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

869

1282

False)

870

1283

871

1284

def _get_all_dbus_things(self, thing):

872

1285

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

873

1286

"""

874

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

875

name),

1287

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

876

1288

athing.__get__(self))

877

1289

for cls in self.__class__.__mro__

878

1290

for name, athing in

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1291

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

1292

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1297

def Introspect(self, object_path, connection):

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts annotation tags on methods and signals.

1301

"""

1302

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

1303

connection)

1304

try:

1305

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

1306

1307

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

1308

# Add annotation tags

1309

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

1310

for tag in if_tag.getElementsByTagName(typ):

1311

annots = dict()

1312

for name, prop in (self.

1313

_get_all_dbus_things(typ)):

1314

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

1315

and prop._dbus_interface

1316

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

1317

annots.update(getattr(

1318

prop, "_dbus_annotations", {}))

1319

for name, value in annots.items():

1320

ann_tag = document.createElement(

1321

"annotation")

1322

ann_tag.setAttribute("name", name)

1323

ann_tag.setAttribute("value", value)

1324

tag.appendChild(ann_tag)

1325

# Add interface annotation tags

1326

for annotation, value in dict(

1327

itertools.chain.from_iterable(

1328

annotations().items()

1329

for name, annotations

1330

in self._get_all_dbus_things("interface")

1331

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

1332

)).items():

1333

ann_tag = document.createElement("annotation")

1334

ann_tag.setAttribute("name", annotation)

1335

ann_tag.setAttribute("value", value)

1336

if_tag.appendChild(ann_tag)

1337

# Fix argument name for the Introspect method itself

1338

if (if_tag.getAttribute("name")

1339

== dbus.INTROSPECTABLE_IFACE):

1340

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

1341

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

1342

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

1343

if (arg.getAttribute("direction")

1344

== "out"):

1345

arg.setAttribute("name",

1346

"xml_data")

1347

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

1348

document.unlink()

1349

except (AttributeError, xml.dom.DOMException,

1350

xml.parsers.expat.ExpatError) as error:

1351

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

1352

exc_info=error)

1353

return xmlstring

1354

1355

1356

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1357

"""A D-Bus object with properties.

1358

1359

Classes inheriting from this can use the dbus_service_property

1360

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

1361

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

1362

"""

1363

882

1364

def _get_dbus_property(self, interface_name, property_name):

883

1365

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

884

1366

property with the specified name and interface.

885

1367

"""

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

890

1371

if (value._dbus_name == property_name

891

1372

and value._dbus_interface == interface_name):

892

1373

return value.__get__(self)

893

1374

894

1375

# No such property

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1376

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

1377

self.dbus_object_path, interface_name, property_name))

1378

1379

@classmethod

1380

def _get_all_interface_names(cls):

1381

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

1382

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

1383

"_dbus_interface", None)

1384

for x in (inspect.getmro(cls))

1385

for attr in dir(x))

1386

if name is not None)

1387

1388

@dbus.service.method(dbus.PROPERTIES_IFACE,

1389

in_signature="ss",

900

1390

out_signature="v")

901

1391

def Get(self, interface_name, property_name):

902

1392

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

908

1398

if not hasattr(value, "variant_level"):

909

1399

return value

910

1400

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

911

1401

912

1402

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

913

1403

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

914

1404

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

923

1413

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

924

1414

"'ay' signature {!r}"

925

1415

.format(prop._dbus_signature))

926

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

927

for byte in value))

1416

value = dbus.ByteArray(bytes(value))

928

1417

prop(value)

929

930

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

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

931

1421

out_signature="a{sv}")

932

1422

def GetAll(self, interface_name):

933

1423

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

934

1424

standard.

935

1425

936

1426

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

937

1427

"""

938

1428

properties = {}

948

1438

if not hasattr(value, "variant_level"):

949

1439

properties[name] = value

950

1440

continue

951

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

952

value.variant_level+1)

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

953

1443

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

954

1444

955

1445

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

956

1446

def PropertiesChanged(self, interface_name, changed_properties,

957

1447

invalidated_properties):

959

1449

standard.

960

1450

"""

961

1451

pass

962

1452

963

1453

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

964

1454

out_signature="s",

965

1455

path_keyword='object_path',

966

1456

connection_keyword='connection')

967

1457

def Introspect(self, object_path, connection):

968

1458

"""Overloading of standard D-Bus method.

969

1459

970

1460

Inserts property tags and interface annotation tags.

971

1461

"""

972

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

973

connection)

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

974

1465

try:

975

1466

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

1467

976

1468

def make_tag(document, name, prop):

977

1469

e = document.createElement("property")

978

1470

e.setAttribute("name", name)

979

1471

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

980

1472

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

981

1473

return e

1474

982

1475

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

983

1476

# Add property tags

984

1477

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

987

1480

if prop._dbus_interface

988

1481

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

989

1482

if_tag.appendChild(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)

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)

1021

1499

# Add the names to the return values for the

1022

1500

# "org.freedesktop.DBus.Properties" methods

1023

1501

if (if_tag.getAttribute("name")

1042

1520

return xmlstring

1043

1521

1044

1522

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

1045

1594

def datetime_to_dbus(dt, variant_level=0):

1046

1595

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

1047

1596

if dt is None:

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1597

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

1598

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

1051

1599

1052

1600

1053

1601

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1055

1603

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

1056

1604

interface names according to the "alt_interface_names" mapping.

1057

1605

Usage:

1058

1606

1059

1607

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

1060

1608

"net.example.AlternateInterface"})

1061

1609

class SampleDBusObject(dbus.service.Object):

1062

1610

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

1063

1611

def SampleDBusMethod():

1064

1612

pass

1065

1613

1066

1614

The above "SampleDBusMethod" on "SampleDBusObject" will be

1067

1615

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

1068

1616

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

1069

1617

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

1070

1618

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

1071

1619

1072

1620

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

1073

1621

(from DBusObjectWithProperties) and interfaces (from the

1074

1622

dbus_interface_annotations decorator).

1075

1623

"""

1624

1076

1625

def wrapper(cls):

1077

1626

for orig_interface_name, alt_interface_name in (

1078

alt_interface_names.items()):

1627

alt_interface_names.items()):

1079

1628

attr = {}

1080

1629

interface_names = set()

1081

1630

# Go though all attributes of the class

1083

1632

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

1084

1633

# with the wrong interface name

1085

1634

if (not hasattr(attribute, "_dbus_interface")

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1088

1637

continue

1089

1638

# Create an alternate D-Bus interface name based on

1090

1639

# the current name

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1094

1642

interface_names.add(alt_interface)

1095

1643

# Is this a D-Bus signal?

1096

1644

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

1097

1645

# Extract the original non-method undecorated

1098

1646

# function by black magic

1099

nonmethod_func = (dict(

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1100

1649

zip(attribute.func_code.co_freevars,

1101

attribute.__closure__))["func"]

1102

.cell_contents)

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)

1103

1657

# Create a new, but exactly alike, function

1104

1658

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

1105

1659

# with the alternate D-Bus interface name

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

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

attribute._dbus_signature)(new_function))

1115

1664

# Copy annotations, if any

1116

1665

try:

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1119

1668

except AttributeError:

1120

1669

pass

1670

1121

1671

# Define a creator of a function to call both the

1122

1672

# original and alternate functions, so both the

1123

1673

# original and alternate signals gets sent when

1126

1676

"""This function is a scope container to pass

1127

1677

func1 and func2 to the "call_both" function

1128

1678

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1129

1681

def call_both(*args, **kwargs):

1130

1682

"""This function will emit two D-Bus

1131

1683

signals by calling func1 and func2"""

1132

1684

func1(*args, **kwargs)

1133

1685

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

1134

1692

return call_both

1135

1693

# Create the "call_both" function and add it to

1136

1694

# the class

1141

1699

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

1142

1700

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

1143

1701

# to the class.

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

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

(copy_function(attribute)))

1154

1708

# Copy annotations, if any

1155

1709

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1158

1712

except AttributeError:

1159

1713

pass

1160

1714

# Is this a D-Bus property?

1163

1717

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

1164

1718

# property with the alternate D-Bus interface

1165

1719

# name. Add it to the class.

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

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

1179

1726

# Copy annotations, if any

1180

1727

try:

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1183

1730

except AttributeError:

1184

1731

pass

1185

1732

# Is this a D-Bus interface?

1188

1735

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

1189

1736

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

1190

1737

# to the class.

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

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

(copy_function(attribute)))

1199

1741

if deprecate:

1200

1742

# Deprecate all alternate interfaces

1201

iname="_AlternateDBusNames_interface_annotation{}"

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1202

1744

for interface_name in interface_names:

1745

1203

1746

@dbus_interface_annotations(interface_name)

1204

1747

def func(self):

1205

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

1206

"true" }

1748

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

1749

"true"}

1207

1750

# Find an unused name

1208

1751

for aname in (iname.format(i)

1209

1752

for i in itertools.count()):

1213

1756

if interface_names:

1214

1757

# Replace the class with a new subclass of it with

1215

1758

# methods, signals, etc. as created above.

1216

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

1217

(cls,), attr)

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)

1218

1765

return cls

1766

1219

1767

return wrapper

1220

1768

1221

1769

1222

1770

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

1223

"se.bsnet.fukt.Mandos"})

1771

"se.bsnet.fukt.Mandos"})

1224

1772

class ClientDBus(Client, DBusObjectWithProperties):

1225

1773

"""A Client class using D-Bus

1226

1774

1227

1775

Attributes:

1228

1776

dbus_object_path: dbus.ObjectPath

1229

1777

bus: dbus.SystemBus()

1230

1778

"""

1231

1779

1232

1780

runtime_expansions = (Client.runtime_expansions

1233

+ ("dbus_object_path",))

1234

1781

+ ("dbus_object_path", ))

1782

1235

1783

_interface = "se.recompile.Mandos.Client"

1236

1784

1237

1785

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

1238

1239

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

1786

1787

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

1240

1788

self.bus = bus

1241

1789

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

1242

1790

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

1244

1792

client_object_name = str(self.name).translate(

1245

1793

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

1246

1794

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

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1249

1797

DBusObjectWithProperties.__init__(self, self.bus,

1250

1798

self.dbus_object_path)

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1255

1804

_interface=_interface):

1256

1805

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

1257

1806

its changes to DBus.

1258

1807

1259

1808

transform_fun: Function that takes a value and a variant_level

1260

1809

and transforms it to a D-Bus type.

1261

1810

dbus_name: D-Bus name of the variable

1264

1813

variant_level: D-Bus variant level. Default: 1

1265

1814

"""

1266

1815

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

1816

1267

1817

def setter(self, value):

1268

1818

if hasattr(self, "dbus_object_path"):

1269

1819

if (not hasattr(self, attrname) or

1270

1820

type_func(getattr(self, attrname, None))

1271

1821

!= type_func(value)):

1272

1822

if invalidate_only:

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1277

1826

else:

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1281

1830

self.PropertyChanged(dbus.String(dbus_name),

1282

1831

dbus_value)

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1287

1837

setattr(self, attrname, value)

1288

1838

1289

1839

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

1290

1840

1291

1841

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1292

1842

approvals_pending = notifychangeproperty(dbus.Boolean,

1293

1843

"ApprovalPending",

1294

type_func = bool)

1844

type_func=bool)

1295

1845

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

1296

1846

last_enabled = notifychangeproperty(datetime_to_dbus,

1297

1847

"LastEnabled")

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1301

1851

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1302

1852

"LastCheckedOK")

1303

1853

last_checker_status = notifychangeproperty(dbus.Int16,

1306

1856

datetime_to_dbus, "LastApprovalRequest")

1307

1857

approved_by_default = notifychangeproperty(dbus.Boolean,

1308

1858

"ApprovedByDefault")

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1314

1862

approval_duration = notifychangeproperty(

1315

1863

dbus.UInt64, "ApprovalDuration",

1316

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

1864

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

1317

1865

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1321

1869

extended_timeout = notifychangeproperty(

1322

1870

dbus.UInt64, "ExtendedTimeout",

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)

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)

1329

1875

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

1330

1876

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

1331

1877

invalidate_only=True)

1332

1878

1333

1879

del notifychangeproperty

1334

1880

1335

1881

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

1336

1882

try:

1337

1883

self.remove_from_connection()

1340

1886

if hasattr(DBusObjectWithProperties, "__del__"):

1341

1887

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

1342

1888

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

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)

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:

1350

1897

# Emit D-Bus signal

1351

1898

self.CheckerCompleted(dbus.Int16(exitstatus),

1352

dbus.Int64(condition),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1353

1901

dbus.String(command))

1354

1902

else:

1355

1903

# Emit D-Bus signal

1356

1904

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

1357

dbus.Int64(condition),

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1358

1909

dbus.String(command))

1359

1360

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

1361

*args, **kwargs)

1362

1910

return ret

1911

1363

1912

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

1364

1913

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

1365

1914

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

1369

1918

# Emit D-Bus signal

1370

1919

self.CheckerStarted(self.current_checker_command)

1371

1920

return r

1372

1921

1373

1922

def _reset_approved(self):

1374

1923

self.approved = None

1375

1924

return False

1376

1925

1377

1926

def approve(self, value=True):

1378

1927

self.approved = value

1379

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

1380

* 1000), self._reset_approved)

1928

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

1929

* 1000), self._reset_approved)

1381

1930

self.send_changedstate()

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1389

1938

# CheckerCompleted - signal

1390

1939

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

1391

1940

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

1392

1941

"D-Bus signal"

1393

1942

pass

1394

1943

1395

1944

# CheckerStarted - signal

1396

1945

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

1397

1946

def CheckerStarted(self, command):

1398

1947

"D-Bus signal"

1399

1948

pass

1400

1949

1401

1950

# PropertyChanged - signal

1402

1951

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

1403

1952

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

1404

1953

def PropertyChanged(self, property, value):

1405

1954

"D-Bus signal"

1406

1955

pass

1407

1956

1408

1957

# GotSecret - signal

1409

1958

@dbus.service.signal(_interface)

1410

1959

def GotSecret(self):

1413

1962

server to mandos-client

1414

1963

"""

1415

1964

pass

1416

1965

1417

1966

# Rejected - signal

1418

1967

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

1419

1968

def Rejected(self, reason):

1420

1969

"D-Bus signal"

1421

1970

pass

1422

1971

1423

1972

# NeedApproval - signal

1424

1973

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

1425

1974

def NeedApproval(self, timeout, default):

1426

1975

"D-Bus signal"

1427

1976

return self.need_approval()

1428

1429

## Methods

1430

1977

1978

# Methods

1979

1431

1980

# Approve - method

1432

1981

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

1433

1982

def Approve(self, value):

1434

1983

self.approve(value)

1435

1984

1436

1985

# CheckedOK - method

1437

1986

@dbus.service.method(_interface)

1438

1987

def CheckedOK(self):

1439

1988

self.checked_ok()

1440

1989

1441

1990

# Enable - method

1991

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

1442

1992

@dbus.service.method(_interface)

1443

1993

def Enable(self):

1444

1994

"D-Bus method"

1445

1995

self.enable()

1446

1996

1447

1997

# StartChecker - method

1998

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

1448

1999

@dbus.service.method(_interface)

1449

2000

def StartChecker(self):

1450

2001

"D-Bus method"

1451

2002

self.start_checker()

1452

2003

1453

2004

# Disable - method

2005

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

1454

2006

@dbus.service.method(_interface)

1455

2007

def Disable(self):

1456

2008

"D-Bus method"

1457

2009

self.disable()

1458

2010

1459

2011

# StopChecker - method

2012

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

1460

2013

@dbus.service.method(_interface)

1461

2014

def StopChecker(self):

1462

2015

self.stop_checker()

1463

1464

## Properties

1465

2016

2017

# Properties

2018

1466

2019

# ApprovalPending - property

1467

2020

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

1468

2021

def ApprovalPending_dbus_property(self):

1469

2022

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

1470

2023

1471

2024

# ApprovedByDefault - property

1472

@dbus_service_property(_interface, signature="b",

2025

@dbus_service_property(_interface,

2026

signature="b",

1473

2027

access="readwrite")

1474

2028

def ApprovedByDefault_dbus_property(self, value=None):

1475

2029

if value is None: # get

1476

2030

return dbus.Boolean(self.approved_by_default)

1477

2031

self.approved_by_default = bool(value)

1478

2032

1479

2033

# ApprovalDelay - property

1480

@dbus_service_property(_interface, signature="t",

2034

@dbus_service_property(_interface,

2035

signature="t",

1481

2036

access="readwrite")

1482

2037

def ApprovalDelay_dbus_property(self, value=None):

1483

2038

if value is None: # get

1484

2039

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

1485

2040

* 1000)

1486

2041

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

1487

2042

1488

2043

# ApprovalDuration - property

1489

@dbus_service_property(_interface, signature="t",

2044

@dbus_service_property(_interface,

2045

signature="t",

1490

2046

access="readwrite")

1491

2047

def ApprovalDuration_dbus_property(self, value=None):

1492

2048

if value is None: # get

1493

2049

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

1494

2050

* 1000)

1495

2051

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

1496

2052

1497

2053

# Name - property

2054

@dbus_annotations(

2055

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

1498

2056

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

1499

2057

def Name_dbus_property(self):

1500

2058

return dbus.String(self.name)

1501

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

1502

2067

# Fingerprint - property

2068

@dbus_annotations(

2069

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

1503

2070

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

1504

2071

def Fingerprint_dbus_property(self):

1505

2072

return dbus.String(self.fingerprint)

1506

2073

1507

2074

# Host - property

1508

@dbus_service_property(_interface, signature="s",

2075

@dbus_service_property(_interface,

2076

signature="s",

1509

2077

access="readwrite")

1510

2078

def Host_dbus_property(self, value=None):

1511

2079

if value is None: # get

1512

2080

return dbus.String(self.host)

1513

2081

self.host = str(value)

1514

2082

1515

2083

# Created - property

2084

@dbus_annotations(

2085

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

1516

2086

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

1517

2087

def Created_dbus_property(self):

1518

2088

return datetime_to_dbus(self.created)

1519

2089

1520

2090

# LastEnabled - property

1521

2091

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

1522

2092

def LastEnabled_dbus_property(self):

1523

2093

return datetime_to_dbus(self.last_enabled)

1524

2094

1525

2095

# Enabled - property

1526

@dbus_service_property(_interface, signature="b",

2096

@dbus_service_property(_interface,

2097

signature="b",

1527

2098

access="readwrite")

1528

2099

def Enabled_dbus_property(self, value=None):

1529

2100

if value is None: # get

1532

2103

self.enable()

1533

2104

else:

1534

2105

self.disable()

1535

2106

1536

2107

# LastCheckedOK - property

1537

@dbus_service_property(_interface, signature="s",

2108

@dbus_service_property(_interface,

2109

signature="s",

1538

2110

access="readwrite")

1539

2111

def LastCheckedOK_dbus_property(self, value=None):

1540

2112

if value is not None:

1541

2113

self.checked_ok()

1542

2114

return

1543

2115

return datetime_to_dbus(self.last_checked_ok)

1544

2116

1545

2117

# LastCheckerStatus - property

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2118

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

1548

2119

def LastCheckerStatus_dbus_property(self):

1549

2120

return dbus.Int16(self.last_checker_status)

1550

2121

1551

2122

# Expires - property

1552

2123

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

1553

2124

def Expires_dbus_property(self):

1554

2125

return datetime_to_dbus(self.expires)

1555

2126

1556

2127

# LastApprovalRequest - property

1557

2128

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

1558

2129

def LastApprovalRequest_dbus_property(self):

1559

2130

return datetime_to_dbus(self.last_approval_request)

1560

2131

1561

2132

# Timeout - property

1562

@dbus_service_property(_interface, signature="t",

2133

@dbus_service_property(_interface,

2134

signature="t",

1563

2135

access="readwrite")

1564

2136

def Timeout_dbus_property(self, value=None):

1565

2137

if value is None: # get

1577

2149

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

1578

2150

is None):

1579

2151

return

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

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

1586

2157

# ExtendedTimeout - property

1587

@dbus_service_property(_interface, signature="t",

2158

@dbus_service_property(_interface,

2159

signature="t",

1588

2160

access="readwrite")

1589

2161

def ExtendedTimeout_dbus_property(self, value=None):

1590

2162

if value is None: # get

1591

2163

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

1592

2164

* 1000)

1593

2165

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

1594

2166

1595

2167

# Interval - property

1596

@dbus_service_property(_interface, signature="t",

2168

@dbus_service_property(_interface,

2169

signature="t",

1597

2170

access="readwrite")

1598

2171

def Interval_dbus_property(self, value=None):

1599

2172

if value is None: # get

1603

2176

return

1604

2177

if self.enabled:

1605

2178

# Reschedule checker run

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

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

1611

2184

# Checker - property

1612

@dbus_service_property(_interface, signature="s",

2185

@dbus_service_property(_interface,

2186

signature="s",

1613

2187

access="readwrite")

1614

2188

def Checker_dbus_property(self, value=None):

1615

2189

if value is None: # get

1616

2190

return dbus.String(self.checker_command)

1617

2191

self.checker_command = str(value)

1618

2192

1619

2193

# CheckerRunning - property

1620

@dbus_service_property(_interface, signature="b",

2194

@dbus_service_property(_interface,

2195

signature="b",

1621

2196

access="readwrite")

1622

2197

def CheckerRunning_dbus_property(self, value=None):

1623

2198

if value is None: # get

1626

2201

self.start_checker()

1627

2202

else:

1628

2203

self.stop_checker()

1629

2204

1630

2205

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

1631

2209

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

1632

2210

def ObjectPath_dbus_property(self):

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1635

2213

# Secret = property

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

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)

1638

2221

def Secret_dbus_property(self, value):

1639

2222

self.secret = bytes(value)

1640

2223

1641

2224

del _interface

1642

2225

1643

2226

1644

class ProxyClient(object):

1645

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

2227

class ProxyClient:

2228

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

1646

2229

self._pipe = child_pipe

1647

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

2230

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

1648

2231

if not self._pipe.recv():

1649

raise KeyError()

1650

2232

raise KeyError(key_id or fpr)

2233

1651

2234

def __getattribute__(self, name):

1652

2235

if name == '_pipe':

1653

2236

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

1656

2239

if data[0] == 'data':

1657

2240

return data[1]

1658

2241

if data[0] == 'function':

2242

1659

2243

def func(*args, **kwargs):

1660

2244

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

1661

2245

return self._pipe.recv()[1]

2246

1662

2247

return func

1663

2248

1664

2249

def __setattr__(self, name, value):

1665

2250

if name == '_pipe':

1666

2251

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

1669

2254

1670

2255

class ClientHandler(socketserver.BaseRequestHandler, object):

1671

2256

"""A class to handle client connections.

1672

2257

1673

2258

Instantiated once for each connection to handle it.

1674

2259

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

1675

2260

1676

2261

def handle(self):

1677

2262

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

1678

2263

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

1679

2264

str(self.client_address))

1680

2265

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

1681

2266

self.server.child_pipe.fileno())

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

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

1697

2274

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

1698

2275

priority = self.server.gnutls_priority

1699

2276

if priority is None:

1700

2277

priority = "NORMAL"

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1705

2282

# Start communication using the Mandos protocol

1706

2283

# Get protocol number

1707

2284

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

1712

2289

except (ValueError, IndexError, RuntimeError) as error:

1713

2290

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

1714

2291

return

1715

2292

1716

2293

# Start GnuTLS connection

1717

2294

try:

1718

2295

session.handshake()

1719

except gnutls.errors.GNUTLSError as error:

2296

except gnutls.Error as error:

1720

2297

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

1721

2298

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

1722

2299

# established. Just abandon the request.

1723

2300

return

1724

2301

logger.debug("Handshake succeeded")

1725

2302

1726

2303

approval_required = False

1727

2304

try:

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,

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,

1739

2327

self.client_address)

1740

2328

except KeyError:

1741

2329

return

1742

2330

1743

2331

if client.approval_delay:

1744

2332

delay = client.approval_delay

1745

2333

client.approvals_pending += 1

1746

2334

approval_required = True

1747

2335

1748

2336

while True:

1749

2337

if not client.enabled:

1750

2338

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

1751

client.name)

2339

client.name)

1752

2340

if self.server.use_dbus:

1753

2341

# Emit D-Bus signal

1754

2342

client.Rejected("Disabled")

1755

2343

return

1756

2344

1757

2345

if client.approved or not client.approval_delay:

1758

#We are approved or approval is disabled

2346

# We are approved or approval is disabled

1759

2347

break

1760

2348

elif client.approved is None:

1761

2349

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

1772

2360

# Emit D-Bus signal

1773

2361

client.Rejected("Denied")

1774

2362

return

1775

1776

#wait until timeout or approved

2363

2364

# wait until timeout or approved

1777

2365

time = datetime.datetime.now()

1778

2366

client.changedstate.acquire()

1779

2367

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

1792

2380

break

1793

2381

else:

1794

2382

delay -= time2 - time

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

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

1809

2391

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

1810

2392

# bump the timeout using extended_timeout

1811

2393

client.bump_timeout(client.extended_timeout)

1812

2394

if self.server.use_dbus:

1813

2395

# Emit D-Bus signal

1814

2396

client.GotSecret()

1815

2397

1816

2398

finally:

1817

2399

if approval_required:

1818

2400

client.approvals_pending -= 1

1819

2401

try:

1820

2402

session.bye()

1821

except gnutls.errors.GNUTLSError as error:

2403

except gnutls.Error as error:

1822

2404

logger.warning("GnuTLS bye failed",

1823

2405

exc_info=error)

1824

2406

1825

2407

@staticmethod

1826

2408

def peer_certificate(session):

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

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

1834

2425

list_size = ctypes.c_uint(1)

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2426

cert_list = (gnutls.certificate_get_peers

1837

2427

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

1838

2428

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

1839

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

1840

" certificate")

2429

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

1841

2430

if list_size.value == 0:

1842

2431

return None

1843

2432

cert = cert_list[0]

1844

2433

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

1845

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

1846

2469

@staticmethod

1847

2470

def fingerprint(openpgp):

1848

2471

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1849

2472

# New GnuTLS "datum" with the OpenPGP public key

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

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

1855

2477

# New empty GnuTLS certificate

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

crt = gnutls.openpgp_crt_t()

2479

gnutls.openpgp_crt_init(ctypes.byref(crt))

1859

2480

# Import the OpenPGP public key into the certificate

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2481

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

2482

gnutls.OPENPGP_FMT_RAW)

1864

2483

# Verify the self signature in the key

1865

2484

crtverify = ctypes.c_uint()

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1869

2487

if crtverify.value != 0:

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1873

2491

# New buffer for the fingerprint

1874

2492

buf = ctypes.create_string_buffer(20)

1875

2493

buf_len = ctypes.c_size_t()

1876

2494

# Get the fingerprint from the certificate into the buffer

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2495

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

2496

ctypes.byref(buf_len))

1880

2497

# Deinit the certificate

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2498

gnutls.openpgp_crt_deinit(crt)

1882

2499

# Convert the buffer to a Python bytestring

1883

2500

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

1884

2501

# Convert the bytestring to hexadecimal notation

1886

2503

return hex_fpr

1887

2504

1888

2505

1889

class MultiprocessingMixIn(object):

2506

class MultiprocessingMixIn:

1890

2507

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

2508

1891

2509

def sub_process_main(self, request, address):

1892

2510

try:

1893

2511

self.finish_request(request, address)

1894

2512

except Exception:

1895

2513

self.handle_error(request, address)

1896

2514

self.close_request(request)

1897

2515

1898

2516

def process_request(self, request, address):

1899

2517

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

1900

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

1901

args = (request, address))

2518

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

2519

args=(request, address))

1902

2520

proc.start()

1903

2521

return proc

1904

2522

1905

2523

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1907

2525

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

2526

1908

2527

def process_request(self, request, client_address):

1909

2528

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

1910

2529

1911

2530

This function creates a new pipe in self.pipe

1912

2531

"""

1913

2532

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1914

2533

1915

2534

proc = MultiprocessingMixIn.process_request(self, request,

1916

2535

client_address)

1917

2536

self.child_pipe.close()

1918

2537

self.add_pipe(parent_pipe, proc)

1919

2538

1920

2539

def add_pipe(self, parent_pipe, proc):

1921

2540

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

1922

2541

raise NotImplementedError()

1923

2542

1924

2543

1925

2544

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1926

socketserver.TCPServer, object):

2545

socketserver.TCPServer):

1927

2546

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

1928

2547

1929

2548

Attributes:

1930

2549

enabled: Boolean; whether this server is activated yet

1931

2550

interface: None or a network interface name (string)

1932

2551

use_ipv6: Boolean; to use IPv6 or not

1933

2552

"""

2553

1934

2554

def __init__(self, server_address, RequestHandlerClass,

1935

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

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1936

2558

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

1937

2559

creating a new one with socket.socket().

1938

2560

"""

1944

2566

self.socketfd = socketfd

1945

2567

# Save the original socket.socket() function

1946

2568

self.socket_socket = socket.socket

2569

1947

2570

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

1948

#

2571

#

1949

2572

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

1950

2573

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

1951

2574

# patching socket.socket.)

1952

#

2575

#

1953

2576

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

1954

2577

@functools.wraps(socket.socket)

1955

2578

def socket_wrapper(*args, **kwargs):

1967

2590

# socket_wrapper(), if socketfd was set.

1968

2591

socketserver.TCPServer.__init__(self, server_address,

1969

2592

RequestHandlerClass)

1970

2593

1971

2594

def server_bind(self):

1972

2595

"""This overrides the normal server_bind() function

1973

2596

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

1974

2597

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

2598

global SO_BINDTODEVICE

1975

2599

if self.interface is not None:

1976

2600

if SO_BINDTODEVICE is None:

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

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

1999

2622

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

2000

2623

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

2001

2626

if not self.server_address[0]:

2002

2627

if self.address_family == socket.AF_INET6:

2003

any_address = "::" # in6addr_any

2628

any_address = "::" # in6addr_any

2004

2629

else:

2005

any_address = "0.0.0.0" # INADDR_ANY

2630

any_address = "0.0.0.0" # INADDR_ANY

2006

2631

self.server_address = (any_address,

2007

2632

self.server_address[1])

2008

2633

elif not self.server_address[1]:

2009

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

2010

0)

2634

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

2011

2635

# if self.interface:

2012

2636

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

2013

2637

# 0, # port

2019

2643

2020

2644

class MandosServer(IPv6_TCPServer):

2021

2645

"""Mandos server.

2022

2646

2023

2647

Attributes:

2024

2648

clients: set of Client objects

2025

2649

gnutls_priority GnuTLS priority string

2026

2650

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

2027

2028

Assumes a gobject.MainLoop event loop.

2651

2652

Assumes a GLib.MainLoop event loop.

2029

2653

"""

2654

2030

2655

def __init__(self, server_address, RequestHandlerClass,

2031

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

2032

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

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

2033

2662

self.enabled = False

2034

2663

self.clients = clients

2035

2664

if self.clients is None:

2038

2667

self.gnutls_priority = gnutls_priority

2039

2668

IPv6_TCPServer.__init__(self, server_address,

2040

2669

RequestHandlerClass,

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2044

2674

def server_activate(self):

2045

2675

if self.enabled:

2046

2676

return socketserver.TCPServer.server_activate(self)

2047

2677

2048

2678

def enable(self):

2049

2679

self.enabled = True

2050

2680

2051

2681

def add_pipe(self, parent_pipe, proc):

2052

2682

# Call "handle_ipc" for both data and EOF events

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

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

2062

2694

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

2063

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

2695

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

2064

2696

# Wait for other process to exit

2065

2697

proc.join()

2066

2698

return False

2067

2699

2068

2700

# Read a request from the child

2069

2701

request = parent_pipe.recv()

2070

2702

command = request[0]

2071

2703

2072

2704

if command == 'init':

2073

fpr = request[1]

2074

address = request[2]

2075

2076

for c in self.clients.itervalues():

2077

if c.fingerprint == fpr:

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:

2078

2716

client = c

2079

2717

break

2080

2718

else:

2081

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

2082

"dress: %s", fpr, address)

2719

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

2720

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

2083

2721

if self.use_dbus:

2084

2722

# Emit D-Bus signal

2085

mandos_dbus_service.ClientNotFound(fpr,

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2086

2724

address[0])

2087

2725

parent_pipe.send(False)

2088

2726

return False

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

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

2098

2735

parent_pipe.send(True)

2099

2736

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

2100

2737

# same fileno

2103

2740

funcname = request[1]

2104

2741

args = request[2]

2105

2742

kwargs = request[3]

2106

2743

2107

2744

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

2108

2745

funcname)(*args,

2109

**kwargs)))

2110

2746

**kwargs)))

2747

2111

2748

if command == 'getattr':

2112

2749

attrname = request[1]

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2115

2753

else:

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2754

parent_pipe.send((

2755

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

2756

2119

2757

if command == 'setattr':

2120

2758

attrname = request[1]

2121

2759

value = request[2]

2122

2760

setattr(client_object, attrname, value)

2123

2761

2124

2762

return True

2125

2763

2126

2764

2127

2765

def rfc3339_duration_to_delta(duration):

2128

2766

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

2129

2130

>>> rfc3339_duration_to_delta("P7D")

2131

datetime.timedelta(7)

2132

>>> rfc3339_duration_to_delta("PT60S")

2133

datetime.timedelta(0, 60)

2134

>>> rfc3339_duration_to_delta("PT60M")

2135

datetime.timedelta(0, 3600)

2136

>>> rfc3339_duration_to_delta("PT24H")

2137

datetime.timedelta(1)

2138

>>> rfc3339_duration_to_delta("P1W")

2139

datetime.timedelta(7)

2140

>>> rfc3339_duration_to_delta("PT5M30S")

2141

datetime.timedelta(0, 330)

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

datetime.timedelta(1, 200)

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

2144

2782

"""

2145

2783

2146

2784

# Parsing an RFC 3339 duration with regular expressions is not

2147

2785

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

2148

2786

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

2149

2787

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

2150

2788

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

2151

2789

# avoid excessive use of external libraries.

2152

2790

2153

2791

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

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

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

2163

2797

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

2164

2798

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

2165

2799

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

2166

2800

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

2167

2801

datetime.timedelta(seconds=1),

2168

frozenset((token_end,)))

2802

frozenset((token_end, )))

2169

2803

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

2170

2804

datetime.timedelta(minutes=1),

2171

2805

frozenset((token_second, token_end)))

2187

2821

frozenset((token_month, token_end)))

2188

2822

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

2189

2823

datetime.timedelta(weeks=1),

2190

frozenset((token_end,)))

2824

frozenset((token_end, )))

2191

2825

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

2192

2826

frozenset((token_year, token_month,

2193

2827

token_day, token_time,

2194

2828

token_week)))

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2197

2832

found_token = None

2198

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

2199

s = duration # String left to parse

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2200

2837

# Loop until end token is found

2201

2838

while found_token is not token_end:

2202

2839

# Search for any currently valid tokens

2218

2855

break

2219

2856

else:

2220

2857

# No currently valid tokens were found

2221

raise ValueError("Invalid RFC 3339 duration")

2858

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

2859

.format(duration))

2222

2860

# End token found

2223

2861

return value

2224

2862

2225

2863

2226

2864

def string_to_delta(interval):

2227

2865

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

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)

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

2241

2879

"""

2242

2880

2243

2881

try:

2244

2882

return rfc3339_duration_to_delta(interval)

2245

2883

except ValueError:

2246

2884

pass

2247

2885

2248

2886

timevalue = datetime.timedelta(0)

2249

2887

for s in interval.split():

2250

2888

try:

2261

2899

elif suffix == "w":

2262

2900

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

2263

2901

else:

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2902

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

2266

2903

except IndexError as e:

2267

2904

raise ValueError(*(e.args))

2268

2905

timevalue += delta

2269

2906

return timevalue

2270

2907

2271

2908

2272

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

2909

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

2273

2910

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

2274

2911

2275

2912

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

2276

2913

if os.fork():

2277

2914

sys.exit()

2284

2921

# Close all standard open file descriptors

2285

2922

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

2286

2923

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

2287

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

2924

raise OSError(errno.ENODEV,

2925

"{} not a character device"

2288

2926

.format(os.devnull))

2289

2927

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

2290

2928

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

2294

2932

2295

2933

2296

2934

def main():

2297

2935

2298

2936

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

2299

2937

# Parsing of options, both command line and config file

2300

2938

2301

2939

parser = argparse.ArgumentParser()

2302

2940

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

2303

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

2941

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

2304

2942

help="show version number and exit")

2305

2943

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

2306

2944

help="Bind to interface IF")

2342

2980

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

2343

2981

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

2344

2982

default=None)

2345

2983

2346

2984

options = parser.parse_args()

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

2985

2353

2986

# Default values for config file for server-global settings

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

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

2371

3010

# Parse config file for server-global settings

2372

server_config = configparser.SafeConfigParser(server_defaults)

3011

server_config = configparser.ConfigParser(server_defaults)

2373

3012

del server_defaults

2374

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

2375

"mandos.conf"))

2376

# Convert the SafeConfigParser object to a dict

3013

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

3014

# Convert the ConfigParser object to a dict

2377

3015

server_settings = server_config.defaults()

2378

3016

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

2379

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

3017

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

3018

"foreground", "zeroconf"):

2380

3019

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

2381

3020

option)

2382

3021

if server_settings["port"]:

2392

3031

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

2393

3032

["socket"])

2394

3033

del server_config

2395

3034

2396

3035

# Override the settings from the config file with command line

2397

3036

# options, if set.

2398

3037

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

2399

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

2400

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

2401

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

3038

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

3039

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

3040

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

2402

3041

value = getattr(options, option)

2403

3042

if value is not None:

2404

3043

server_settings[option] = value

2416

3055

if server_settings["debug"]:

2417

3056

server_settings["foreground"] = True

2418

3057

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

2419

3058

2420

3059

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

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

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

2428

3066

# For convenience

2429

3067

debug = server_settings["debug"]

2430

3068

debuglevel = server_settings["debuglevel"]

2434

3072

stored_state_file)

2435

3073

foreground = server_settings["foreground"]

2436

3074

zeroconf = server_settings["zeroconf"]

2437

3075

2438

3076

if debug:

2439

3077

initlogger(debug, logging.DEBUG)

2440

3078

else:

2443

3081

else:

2444

3082

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

2445

3083

initlogger(debug, level)

2446

3084

2447

3085

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

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2454

3091

# Parse config file with clients

2455

client_config = configparser.SafeConfigParser(Client

2456

.client_defaults)

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2457

3093

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

2458

3094

"clients.conf"))

2459

3095

2460

3096

global mandos_dbus_service

2461

3097

mandos_dbus_service = None

2462

3098

2463

3099

socketfd = None

2464

3100

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

2465

3101

socketfd = server_settings["socket"]

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)

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)

2476

3110

if not foreground:

2477

3111

pidfilename = "/run/mandos.pid"

2478

3112

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

2479

3113

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

2480

3114

pidfile = None

2481

3115

try:

2482

pidfile = open(pidfilename, "w")

3116

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

2483

3117

except IOError as e:

2484

3118

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

2485

3119

exc_info=e)

2486

2487

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

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2488

3124

try:

2489

3125

uid = pwd.getpwnam(name).pw_uid

2490

gid = pwd.getpwnam(name).pw_gid

3126

gid = pwd.getpwnam(group).pw_gid

2491

3127

break

2492

3128

except KeyError:

2493

3129

continue

2497

3133

try:

2498

3134

os.setgid(gid)

2499

3135

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

2500

3139

except OSError as error:

3140

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

3141

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

2501

3142

if error.errno != errno.EPERM:

2502

3143

raise

2503

3144

2504

3145

if debug:

2505

3146

# Enable all possible GnuTLS debugging

2506

3147

2507

3148

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

2508

3149

# - GnuTLS manual

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2512

3153

def debug_gnutls(level, string):

2513

3154

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

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2518

3158

# Redirect stdin so all checkers get /dev/null

2519

3159

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

2520

3160

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

2521

3161

if null > 2:

2522

3162

os.close(null)

2523

3163

2524

3164

# Need to fork before connecting to D-Bus

2525

3165

if not foreground:

2526

3166

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

2527

3167

daemon()

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

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

2533

3174

global main_loop

2534

3175

# From the Avahi example code

2535

3176

DBusGMainLoop(set_as_default=True)

2536

main_loop = gobject.MainLoop()

3177

main_loop = GLib.MainLoop()

2537

3178

bus = dbus.SystemBus()

2538

3179

# End of Avahi example code

2539

3180

if use_dbus:

2540

3181

try:

2541

3182

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

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:

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:

2547

3189

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

2548

3190

use_dbus = False

2549

3191

server_settings["use_dbus"] = False

2550

3192

tcp_server.use_dbus = False

2551

3193

if zeroconf:

2552

3194

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

2557

3200

if server_settings["interface"]:

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3201

service.interface = if_nametoindex(

3202

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

3203

2562

3204

global multiprocessing_manager

2563

3205

multiprocessing_manager = multiprocessing.Manager()

2564

3206

2565

3207

client_class = Client

2566

3208

if use_dbus:

2567

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

2568

3209

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

3210

2569

3211

client_settings = Client.config_parser(client_config)

2570

3212

old_client_settings = {}

2571

3213

clients_data = {}

2572

3214

2573

3215

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

2574

3216

global wnull

2575

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

3217

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

2576

3218

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

2577

3219

# mode

2578

3220

if debug or not foreground:

2579

3221

wnull.close()

2580

3222

2581

3223

# Get client data and settings from last running state.

2582

3224

if server_settings["restore"]:

2583

3225

try:

2584

3226

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

2585

clients_data, old_client_settings = (pickle.load

2586

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

2587

3277

os.remove(stored_state_path)

2588

3278

except IOError as e:

2589

3279

if e.errno == errno.ENOENT:

2590

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

2591

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

3280

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

3281

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

2592

3282

else:

2593

3283

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

2594

3284

exc_info=e)

2595

3285

raise

2596

3286

except EOFError as e:

2597

3287

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

2598

"EOFError:", exc_info=e)

2599

3288

"EOFError:",

3289

exc_info=e)

3290

2600

3291

with PGPEngine() as pgp:

2601

3292

for client_name, client in clients_data.items():

2602

3293

# Skip removed clients

2603

3294

if client_name not in client_settings:

2604

3295

continue

2605

3296

2606

3297

# Decide which value to use after restoring saved state.

2607

3298

# We have three different values: Old config file,

2608

3299

# new config file, and saved state.

2613

3304

# For each value in new config, check if it

2614

3305

# differs from the old config value (Except for

2615

3306

# the "secret" attribute)

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3307

if (name != "secret"

3308

and (value !=

3309

old_client_settings[client_name][name])):

2619

3310

client[name] = value

2620

3311

except KeyError:

2621

3312

pass

2622

3313

2623

3314

# Clients who has passed its expire date can still be

2624

# enabled if its last checker was successful. Clients

3315

# enabled if its last checker was successful. A Client

2625

3316

# whose checker succeeded before we stored its state is

2626

3317

# assumed to have successfully run all checkers during

2627

3318

# downtime.

2630

3321

if not client["last_checked_ok"]:

2631

3322

logger.warning(

2632

3323

"disabling client {} - Client never "

2633

"performed a successful checker"

2634

.format(client_name))

3324

"performed a successful checker".format(

3325

client_name))

2635

3326

client["enabled"] = False

2636

3327

elif client["last_checker_status"] != 0:

2637

3328

logger.warning(

2638

3329

"disabling client {} - Client last"

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3330

" checker failed with error code"

3331

" {}".format(

3332

client_name,

3333

client["last_checker_status"]))

2642

3334

client["enabled"] = False

2643

3335

else:

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3336

client["expires"] = (

3337

datetime.datetime.utcnow()

3338

+ client["timeout"])

2647

3339

logger.debug("Last checker succeeded,"

2648

" keeping {} enabled"

2649

.format(client_name))

3340

" keeping {} enabled".format(

3341

client_name))

2650

3342

try:

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3343

client["secret"] = pgp.decrypt(

3344

client["encrypted_secret"],

3345

client_settings[client_name]["secret"])

2655

3346

except PGPError:

2656

3347

# If decryption fails, we use secret from new settings

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3348

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

3349

client_name))

3350

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

3351

["secret"])

3352

2662

3353

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

2663

3354

for client_name in (set(old_client_settings)

2664

3355

- set(client_settings)):

2666

3357

for client_name in (set(client_settings)

2667

3358

- set(old_client_settings)):

2668

3359

clients_data[client_name] = client_settings[client_name]

2669

3360

2670

3361

# Create all client objects

2671

3362

for client_name, client in clients_data.items():

2672

3363

tcp_server.clients[client_name] = client_class(

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3364

name=client_name,

3365

settings=client,

3366

server_settings=server_settings)

3367

2676

3368

if not tcp_server.clients:

2677

3369

logger.warning("No clients defined")

2678

3370

2679

3371

if not foreground:

2680

3372

if pidfile is not None:

3373

pid = os.getpid()

2681

3374

try:

2682

3375

with pidfile:

2683

pid = os.getpid()

2684

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

3376

print(pid, file=pidfile)

2685

3377

except IOError:

2686

3378

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

2687

3379

pidfilename, pid)

2688

3380

del pidfile

2689

3381

del pidfilename

2690

2691

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

2692

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

2693

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

2694

3387

if use_dbus:

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3388

3389

@alternate_dbus_interfaces(

3390

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

3391

class MandosDBusService(DBusObjectWithObjectManager):

2698

3392

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

3393

2699

3394

def __init__(self):

2700

3395

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

3396

2701

3397

_interface = "se.recompile.Mandos"

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3398

2709

3399

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

2710

3400

def ClientAdded(self, objpath):

2711

3401

"D-Bus signal"

2712

3402

pass

2713

3403

2714

3404

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

2715

def ClientNotFound(self, fingerprint, address):

3405

def ClientNotFound(self, key_id, address):

2716

3406

"D-Bus signal"

2717

3407

pass

2718

3408

3409

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

3410

"true"})

2719

3411

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

2720

3412

def ClientRemoved(self, objpath, name):

2721

3413

"D-Bus signal"

2722

3414

pass

2723

3415

3416

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

3417

"true"})

2724

3418

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

2725

3419

def GetAllClients(self):

2726

3420

"D-Bus method"

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

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

2731

3426

@dbus.service.method(_interface,

2732

3427

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

2733

3428

def GetAllClientsWithProperties(self):

2734

3429

"D-Bus method"

2735

3430

return dbus.Dictionary(

2736

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

2737

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

3431

{c.dbus_object_path: c.GetAll(

3432

"se.recompile.Mandos.Client")

3433

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

2738

3434

signature="oa{sv}")

2739

3435

2740

3436

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

2741

3437

def RemoveClient(self, object_path):

2742

3438

"D-Bus method"

2743

for c in tcp_server.clients.itervalues():

3439

for c in tcp_server.clients.values():

2744

3440

if c.dbus_object_path == object_path:

2745

3441

del tcp_server.clients[c.name]

2746

3442

c.remove_from_connection()

2747

# Don't signal anything except ClientRemoved

3443

# Don't signal the disabling

2748

3444

c.disable(quiet=True)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3445

# Emit D-Bus signal for removal

3446

self.client_removed_signal(c)

2751

3447

return

2752

3448

raise KeyError(object_path)

2753

3449

2754

3450

del _interface

2755

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

2756

3488

mandos_dbus_service = MandosDBusService()

2757

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

2758

3495

def cleanup():

2759

3496

"Cleanup function; run on exit"

2760

3497

if zeroconf:

2761

3498

service.cleanup()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3499

3500

mp.active_children()

3501

wn.close()

2765

3502

if not (tcp_server.clients or client_settings):

2766

3503

return

2767

3504

2768

3505

# Store client before exiting. Secrets are encrypted with key

2769

3506

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

2770

3507

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

2771

3508

clients = {}

2772

3509

with PGPEngine() as pgp:

2773

for client in tcp_server.clients.itervalues():

3510

for client in tcp_server.clients.values():

2774

3511

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

2775

3512

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

2776

3513

key)

2777

3514

client_dict = {}

2778

3515

2779

3516

# A list of attributes that can not be pickled

2780

3517

# + secret.

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3518

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

3519

"checker", "server_settings"}

3520

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

3521

.Object):

2785

3522

exclude.add(name)

2786

3523

2787

3524

client_dict["encrypted_secret"] = (client

2788

3525

.encrypted_secret)

2789

3526

for attr in client.client_structure:

2790

3527

if attr not in exclude:

2791

3528

client_dict[attr] = getattr(client, attr)

2792

3529

2793

3530

clients[client.name] = client_dict

2794

3531

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

2795

3532

2796

3533

try:

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

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

2803

3543

os.rename(tempname, stored_state_path)

2804

3544

except (IOError, OSError) as e:

2805

3545

if not debug:

2814

3554

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

2815

3555

exc_info=e)

2816

3556

raise

2817

3557

2818

3558

# Delete all clients, and settings from config

2819

3559

while tcp_server.clients:

2820

3560

name, client = tcp_server.clients.popitem()

2821

3561

if use_dbus:

2822

3562

client.remove_from_connection()

2823

# Don't signal anything except ClientRemoved

3563

# Don't signal the disabling

2824

3564

client.disable(quiet=True)

3565

# Emit D-Bus signal for removal

2825

3566

if use_dbus:

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3567

mandos_dbus_service.client_removed_signal(client)

2830

3568

client_settings.clear()

2831

3569

2832

3570

atexit.register(cleanup)

2833

2834

for client in tcp_server.clients.itervalues():

3571

3572

for client in tcp_server.clients.values():

2835

3573

if use_dbus:

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3574

# Emit D-Bus signal for adding

3575

mandos_dbus_service.client_added_signal(client)

2838

3576

# Need to initiate checking of clients

2839

3577

if client.enabled:

2840

3578

client.init_checker()

2841

3579

2842

3580

tcp_server.enable()

2843

3581

tcp_server.server_activate()

2844

3582

2845

3583

# Find out what port we got

2846

3584

if zeroconf:

2847

3585

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

2852

3590

else: # IPv4

2853

3591

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

2854

3592

*tcp_server.socket.getsockname())

2855

2856

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

2857

3593

3594

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

3595

2858

3596

try:

2859

3597

if zeroconf:

2860

3598

# From the Avahi example code

2865

3603

cleanup()

2866

3604

sys.exit(1)

2867

3605

# End of Avahi example code

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

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

2874

3613

logger.debug("Starting main loop")

2875

3614

main_loop.run()

2876

3615

except AvahiError as error:

2885

3624

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

2886

3625

cleanup()

2887

3626

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

2888

3644

if __name__ == '__main__':

2889

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