/mandos/trunk : revision 738.1.2

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

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

98

try:

99

collections.abc.Callable

100

except AttributeError:

101

class abc:

102

Callable = collections.Callable

103

collections.abc = abc

104

del abc

105

106

# Show warnings by default

107

if not sys.warnoptions:

108

import warnings

109

warnings.simplefilter("default")

110

111

# Try to find the value of SO_BINDTODEVICE:

112

try:

113

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

114

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

83

try:

115

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

116

85

except AttributeError:

117

86

try:

118

# This is where SO_BINDTODEVICE was up to and including Python

119

# 2.6, and also 3.2:

120

87

from IN import SO_BINDTODEVICE

121

88

except ImportError:

122

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

123

# Try running the C preprocessor:

124

try:

125

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

126

"/dev/stdin"],

127

stdin=subprocess.PIPE,

128

stdout=subprocess.PIPE)

129

stdout = cc.communicate(

130

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

131

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

132

except (OSError, ValueError, IndexError):

133

# No value found

134

SO_BINDTODEVICE = None

135

136

if sys.version_info < (3, 2):

137

configparser.Configparser = configparser.SafeConfigParser

138

139

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

140

95

stored_state_file = "clients.pickle"

141

96

142

97

logger = logging.getLogger()

143

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

144

98

syslogger = None

145

99

146

100

try:

147

if_nametoindex = ctypes.cdll.LoadLibrary(

148

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

149

104

except (OSError, AttributeError):

150

151

105

def if_nametoindex(interface):

152

106

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

153

107

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

158

112

return interface_index

159

113

160

114

161

def copy_function(func):

162

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

163

if sys.version_info.major == 2:

164

return types.FunctionType(func.func_code,

165

func.func_globals,

166

func.func_name,

167

func.func_defaults,

168

func.func_closure)

169

else:

170

return types.FunctionType(func.__code__,

171

func.__globals__,

172

func.__name__,

173

func.__defaults__,

174

func.__closure__)

175

176

177

115

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

178

116

"""init logger and add loglevel"""

179

117

180

118

global syslogger

181

syslogger = (logging.handlers.SysLogHandler(

182

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

183

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

184

123

syslogger.setFormatter(logging.Formatter

185

124

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

186

125

' %(message)s'))

187

126

logger.addHandler(syslogger)

188

127

189

128

if debug:

190

129

console = logging.StreamHandler()

191

130

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

201

140

pass

202

141

203

142

204

class PGPEngine:

143

class PGPEngine(object):

205

144

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

206

207

145

def __init__(self):

208

146

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

209

self.gpg = "gpg"

210

try:

211

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

212

for line in output.splitlines():

213

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

214

if name == b"gpg":

215

self.gpg = path

216

break

217

except OSError as e:

218

if e.errno != errno.ENOENT:

219

raise

220

147

self.gnupgargs = ['--batch',

221

'--homedir', self.tempdir,

148

'--home', self.tempdir,

222

149

'--force-mdc',

223

'--quiet']

224

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

225

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

226

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

227

150

'--quiet',

151

'--no-use-agent']

152

228

153

def __enter__(self):

229

154

return self

230

155

231

156

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

232

157

self._cleanup()

233

158

return False

234

159

235

160

def __del__(self):

236

161

self._cleanup()

237

162

238

163

def _cleanup(self):

239

164

if self.tempdir is not None:

240

165

# Delete contents of tempdir

241

166

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

242

topdown=False):

167

topdown = False):

243

168

for filename in files:

244

169

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

245

170

for dirname in dirs:

247

172

# Remove tempdir

248

173

os.rmdir(self.tempdir)

249

174

self.tempdir = None

250

175

251

176

def password_encode(self, password):

252

177

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

253

178

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

258

183

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

259

184

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

260

185

return encoded

261

186

262

187

def encrypt(self, data, password):

263

188

passphrase = self.password_encode(password)

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

266

191

passfile.write(passphrase)

267

192

passfile.flush()

268

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

193

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

269

194

'--passphrase-file',

270

195

passfile.name]

271

196

+ self.gnupgargs,

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

276

201

if proc.returncode != 0:

277

202

raise PGPError(err)

278

203

return ciphertext

279

204

280

205

def decrypt(self, data, password):

281

206

passphrase = self.password_encode(password)

282

with tempfile.NamedTemporaryFile(

283

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

284

209

passfile.write(passphrase)

285

210

passfile.flush()

286

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

211

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

287

212

'--passphrase-file',

288

213

passfile.name]

289

214

+ self.gnupgargs,

290

stdin=subprocess.PIPE,

291

stdout=subprocess.PIPE,

292

stderr=subprocess.PIPE)

293

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

294

220

if proc.returncode != 0:

295

221

raise PGPError(err)

296

222

return decrypted_plaintext

297

223

298

224

299

# Pretend that we have an Avahi module

300

class avahi:

301

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

302

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

303

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

304

PROTO_INET = 0 # avahi-common/address.h

305

PROTO_INET6 = 1 # avahi-common/address.h

306

DBUS_NAME = "org.freedesktop.Avahi"

307

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

308

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

309

DBUS_PATH_SERVER = "/"

310

311

@staticmethod

312

def string_array_to_txt_array(t):

313

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

314

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

315

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

316

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

317

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

318

SERVER_INVALID = 0 # avahi-common/defs.h

319

SERVER_REGISTERING = 1 # avahi-common/defs.h

320

SERVER_RUNNING = 2 # avahi-common/defs.h

321

SERVER_COLLISION = 3 # avahi-common/defs.h

322

SERVER_FAILURE = 4 # avahi-common/defs.h

323

324

325

225

class AvahiError(Exception):

326

226

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

327

227

self.value = value

328

228

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

329

229

**kwargs)

330

230

331

332

231

class AvahiServiceError(AvahiError):

333

232

pass

334

233

335

336

234

class AvahiGroupError(AvahiError):

337

235

pass

338

236

339

237

340

class AvahiService:

238

class AvahiService(object):

341

239

"""An Avahi (Zeroconf) service.

342

240

343

241

Attributes:

344

242

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

345

243

Used to optionally bind to the specified interface.

357

255

server: D-Bus Server

358

256

bus: dbus.SystemBus()

359

257

"""

360

361

def __init__(self,

362

interface=avahi.IF_UNSPEC,

363

name=None,

364

servicetype=None,

365

port=None,

366

TXT=None,

367

domain="",

368

host="",

369

max_renames=32768,

370

protocol=avahi.PROTO_UNSPEC,

371

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

372

263

self.interface = interface

373

264

self.name = name

374

265

self.type = servicetype

383

274

self.server = None

384

275

self.bus = bus

385

276

self.entry_group_state_changed_match = None

386

277

387

278

def rename(self, remove=True):

388

279

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

389

280

if self.rename_count >= self.max_renames:

391

282

" after %i retries, exiting.",

392

283

self.rename_count)

393

284

raise AvahiServiceError("Too many renames")

394

self.name = str(

395

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

396

287

self.rename_count += 1

397

288

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

398

289

self.name)

409

300

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

410

301

self.cleanup()

411

302

os._exit(1)

412

303

413

304

def remove(self):

414

305

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

415

306

if self.entry_group_state_changed_match is not None:

417

308

self.entry_group_state_changed_match = None

418

309

if self.group is not None:

419

310

self.group.Reset()

420

311

421

312

def add(self):

422

313

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

423

314

self.remove()

440

331

dbus.UInt16(self.port),

441

332

avahi.string_array_to_txt_array(self.TXT))

442

333

self.group.Commit()

443

334

444

335

def entry_group_state_changed(self, state, error):

445

336

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

446

337

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

447

338

448

339

if state == avahi.ENTRY_GROUP_ESTABLISHED:

449

340

logger.debug("Zeroconf service established.")

450

341

elif state == avahi.ENTRY_GROUP_COLLISION:

453

344

elif state == avahi.ENTRY_GROUP_FAILURE:

454

345

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

455

346

str(error))

456

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

457

347

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

348

.format(error))

349

458

350

def cleanup(self):

459

351

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

460

352

if self.group is not None:

465

357

pass

466

358

self.group = None

467

359

self.remove()

468

360

469

361

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

470

362

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

471

363

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

472

bad_states = {

473

avahi.SERVER_INVALID: "Zeroconf server invalid",

474

avahi.SERVER_REGISTERING: None,

475

avahi.SERVER_COLLISION: "Zeroconf server name collision",

476

avahi.SERVER_FAILURE: "Zeroconf server failure",

477

}

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

478

371

if state in bad_states:

479

372

if bad_states[state] is not None:

480

373

if error is None:

483

376

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

484

377

self.cleanup()

485

378

elif state == avahi.SERVER_RUNNING:

486

try:

487

self.add()

488

except dbus.exceptions.DBusException as error:

489

if (error.get_dbus_name()

490

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

491

logger.info("Local Zeroconf service name"

492

" collision.")

493

return self.rename(remove=False)

494

else:

495

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

496

self.cleanup()

497

os._exit(1)

379

self.add()

498

380

else:

499

381

if error is None:

500

382

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

501

383

else:

502

384

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

503

385

504

386

def activate(self):

505

387

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

506

388

if self.server is None:

510

392

follow_name_owner_changes=True),

511

393

avahi.DBUS_INTERFACE_SERVER)

512

394

self.server.connect_to_signal("StateChanged",

513

self.server_state_changed)

395

self.server_state_changed)

514

396

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

515

397

516

398

517

399

class AvahiServiceToSyslog(AvahiService):

518

400

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

519

401

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

520

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

521

syslogger.setFormatter(logging.Formatter(

522

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

523

.format(self.name)))

402

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

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

524

407

return ret

525

408

526

409

527

# Pretend that we have a GnuTLS module

528

class gnutls:

529

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

530

531

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

532

if library is None:

533

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

534

_library = ctypes.cdll.LoadLibrary(library)

535

del library

536

537

# Unless otherwise indicated, the constants and types below are

538

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

539

540

# Constants

541

E_SUCCESS = 0

542

E_INTERRUPTED = -52

543

E_AGAIN = -28

544

CRT_OPENPGP = 2

545

CRT_RAWPK = 3

546

CLIENT = 2

547

SHUT_RDWR = 0

548

CRD_CERTIFICATE = 1

549

E_NO_CERTIFICATE_FOUND = -49

550

X509_FMT_DER = 0

551

NO_TICKETS = 1<<10

552

ENABLE_RAWPK = 1<<18

553

CTYPE_PEERS = 3

554

KEYID_USE_SHA256 = 1 # gnutls/x509.h

555

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

556

557

# Types

558

class session_int(ctypes.Structure):

559

_fields_ = []

560

session_t = ctypes.POINTER(session_int)

561

562

class certificate_credentials_st(ctypes.Structure):

563

_fields_ = []

564

certificate_credentials_t = ctypes.POINTER(

565

certificate_credentials_st)

566

certificate_type_t = ctypes.c_int

567

568

class datum_t(ctypes.Structure):

569

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

570

('size', ctypes.c_uint)]

571

572

class openpgp_crt_int(ctypes.Structure):

573

_fields_ = []

574

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

575

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

576

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

577

credentials_type_t = ctypes.c_int

578

transport_ptr_t = ctypes.c_void_p

579

close_request_t = ctypes.c_int

580

581

# Exceptions

582

class Error(Exception):

583

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

584

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

585

# code is passed, convert it to a string with

586

# gnutls.strerror()

587

self.code = code

588

if message is None and code is not None:

589

message = gnutls.strerror(code)

590

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

591

message, *args)

592

593

class CertificateSecurityError(Error):

594

pass

595

596

# Classes

597

class Credentials:

598

def __init__(self):

599

self._c_object = gnutls.certificate_credentials_t()

600

gnutls.certificate_allocate_credentials(

601

ctypes.byref(self._c_object))

602

self.type = gnutls.CRD_CERTIFICATE

603

604

def __del__(self):

605

gnutls.certificate_free_credentials(self._c_object)

606

607

class ClientSession:

608

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

609

self._c_object = gnutls.session_t()

610

gnutls_flags = gnutls.CLIENT

611

if gnutls.check_version(b"3.5.6"):

612

gnutls_flags |= gnutls.NO_TICKETS

613

if gnutls.has_rawpk:

614

gnutls_flags |= gnutls.ENABLE_RAWPK

615

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

616

del gnutls_flags

617

gnutls.set_default_priority(self._c_object)

618

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

619

gnutls.handshake_set_private_extensions(self._c_object,

620

True)

621

self.socket = socket

622

if credentials is None:

623

credentials = gnutls.Credentials()

624

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

625

ctypes.cast(credentials._c_object,

626

ctypes.c_void_p))

627

self.credentials = credentials

628

629

def __del__(self):

630

gnutls.deinit(self._c_object)

631

632

def handshake(self):

633

return gnutls.handshake(self._c_object)

634

635

def send(self, data):

636

data = bytes(data)

637

data_len = len(data)

638

while data_len > 0:

639

data_len -= gnutls.record_send(self._c_object,

640

data[-data_len:],

641

data_len)

642

643

def bye(self):

644

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

645

646

# Error handling functions

647

def _error_code(result):

648

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

649

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

650

if result >= 0:

651

return result

652

if result == gnutls.E_NO_CERTIFICATE_FOUND:

653

raise gnutls.CertificateSecurityError(code=result)

654

raise gnutls.Error(code=result)

655

656

def _retry_on_error(result, func, arguments):

657

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

658

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

659

while result < 0:

660

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

661

return _error_code(result)

662

result = func(*arguments)

663

return result

664

665

# Unless otherwise indicated, the function declarations below are

666

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

667

668

# Functions

669

priority_set_direct = _library.gnutls_priority_set_direct

670

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

671

ctypes.POINTER(ctypes.c_char_p)]

672

priority_set_direct.restype = _error_code

673

674

init = _library.gnutls_init

675

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

676

init.restype = _error_code

677

678

set_default_priority = _library.gnutls_set_default_priority

679

set_default_priority.argtypes = [session_t]

680

set_default_priority.restype = _error_code

681

682

record_send = _library.gnutls_record_send

683

record_send.argtypes = [session_t, ctypes.c_void_p,

684

ctypes.c_size_t]

685

record_send.restype = ctypes.c_ssize_t

686

record_send.errcheck = _retry_on_error

687

688

certificate_allocate_credentials = (

689

_library.gnutls_certificate_allocate_credentials)

690

certificate_allocate_credentials.argtypes = [

691

ctypes.POINTER(certificate_credentials_t)]

692

certificate_allocate_credentials.restype = _error_code

693

694

certificate_free_credentials = (

695

_library.gnutls_certificate_free_credentials)

696

certificate_free_credentials.argtypes = [

697

certificate_credentials_t]

698

certificate_free_credentials.restype = None

699

700

handshake_set_private_extensions = (

701

_library.gnutls_handshake_set_private_extensions)

702

handshake_set_private_extensions.argtypes = [session_t,

703

ctypes.c_int]

704

handshake_set_private_extensions.restype = None

705

706

credentials_set = _library.gnutls_credentials_set

707

credentials_set.argtypes = [session_t, credentials_type_t,

708

ctypes.c_void_p]

709

credentials_set.restype = _error_code

710

711

strerror = _library.gnutls_strerror

712

strerror.argtypes = [ctypes.c_int]

713

strerror.restype = ctypes.c_char_p

714

715

certificate_type_get = _library.gnutls_certificate_type_get

716

certificate_type_get.argtypes = [session_t]

717

certificate_type_get.restype = _error_code

718

719

certificate_get_peers = _library.gnutls_certificate_get_peers

720

certificate_get_peers.argtypes = [session_t,

721

ctypes.POINTER(ctypes.c_uint)]

722

certificate_get_peers.restype = ctypes.POINTER(datum_t)

723

724

global_set_log_level = _library.gnutls_global_set_log_level

725

global_set_log_level.argtypes = [ctypes.c_int]

726

global_set_log_level.restype = None

727

728

global_set_log_function = _library.gnutls_global_set_log_function

729

global_set_log_function.argtypes = [log_func]

730

global_set_log_function.restype = None

731

732

deinit = _library.gnutls_deinit

733

deinit.argtypes = [session_t]

734

deinit.restype = None

735

736

handshake = _library.gnutls_handshake

737

handshake.argtypes = [session_t]

738

handshake.restype = _error_code

739

handshake.errcheck = _retry_on_error

740

741

transport_set_ptr = _library.gnutls_transport_set_ptr

742

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

743

transport_set_ptr.restype = None

744

745

bye = _library.gnutls_bye

746

bye.argtypes = [session_t, close_request_t]

747

bye.restype = _error_code

748

bye.errcheck = _retry_on_error

749

750

check_version = _library.gnutls_check_version

751

check_version.argtypes = [ctypes.c_char_p]

752

check_version.restype = ctypes.c_char_p

753

754

_need_version = b"3.3.0"

755

if check_version(_need_version) is None:

756

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

757

.format(_need_version))

758

759

_tls_rawpk_version = b"3.6.6"

760

has_rawpk = bool(check_version(_tls_rawpk_version))

761

762

if has_rawpk:

763

# Types

764

class pubkey_st(ctypes.Structure):

765

_fields = []

766

pubkey_t = ctypes.POINTER(pubkey_st)

767

768

x509_crt_fmt_t = ctypes.c_int

769

770

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

771

pubkey_init = _library.gnutls_pubkey_init

772

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

773

pubkey_init.restype = _error_code

774

775

pubkey_import = _library.gnutls_pubkey_import

776

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

777

x509_crt_fmt_t]

778

pubkey_import.restype = _error_code

779

780

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

781

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

782

ctypes.POINTER(ctypes.c_ubyte),

783

ctypes.POINTER(ctypes.c_size_t)]

784

pubkey_get_key_id.restype = _error_code

785

786

pubkey_deinit = _library.gnutls_pubkey_deinit

787

pubkey_deinit.argtypes = [pubkey_t]

788

pubkey_deinit.restype = None

789

else:

790

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

791

792

openpgp_crt_init = _library.gnutls_openpgp_crt_init

793

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

794

openpgp_crt_init.restype = _error_code

795

796

openpgp_crt_import = _library.gnutls_openpgp_crt_import

797

openpgp_crt_import.argtypes = [openpgp_crt_t,

798

ctypes.POINTER(datum_t),

799

openpgp_crt_fmt_t]

800

openpgp_crt_import.restype = _error_code

801

802

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

803

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

804

ctypes.POINTER(ctypes.c_uint)]

805

openpgp_crt_verify_self.restype = _error_code

806

807

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

808

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

809

openpgp_crt_deinit.restype = None

810

811

openpgp_crt_get_fingerprint = (

812

_library.gnutls_openpgp_crt_get_fingerprint)

813

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

814

ctypes.c_void_p,

815

ctypes.POINTER(

816

ctypes.c_size_t)]

817

openpgp_crt_get_fingerprint.restype = _error_code

818

819

if check_version(b"3.6.4"):

820

certificate_type_get2 = _library.gnutls_certificate_type_get2

821

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

822

certificate_type_get2.restype = _error_code

823

824

# Remove non-public functions

825

del _error_code, _retry_on_error

826

827

828

def call_pipe(connection, # : multiprocessing.Connection

829

func, *args, **kwargs):

830

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

831

832

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

833

return value on the provided multiprocessing.Connection.

834

"""

835

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

836

connection.close()

837

838

839

class Client:

410

class Client(object):

840

411

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

841

412

842

413

Attributes:

843

414

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

844

415

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

845

416

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

846

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

847

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

848

running.

849

checker_callback_tag: a GLib event source tag, or None

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

850

421

checker_command: string; External command which is run to check

851

422

if client lives. %() expansions are done at

852

423

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

853

424

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

854

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

855

426

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

856

427

client_structure: Object describing what attributes a client has

857

428

and is used for storing the client at exit

858

429

current_checker_command: string; current running checker_command

859

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

860

431

enabled: bool()

861

432

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

862

uniquely identify an OpenPGP client

863

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

864

a client using raw public keys

433

uniquely identify the client

865

434

host: string; available for use by the checker command

866

435

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

867

436

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

869

438

last_checker_status: integer between 0 and 255 reflecting exit

870

439

status of last checker. -1 reflects crashed

871

440

checker, -2 means no checker completed yet.

872

last_checker_signal: The signal which killed the last checker, if

873

last_checker_status is -1

874

441

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

875

442

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

876

443

D-Bus identifiers

883

450

disabled, or None

884

451

server_settings: The server_settings dict from main()

885

452

"""

886

453

887

454

runtime_expansions = ("approval_delay", "approval_duration",

888

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

455

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

889

456

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

890

457

"last_approval_request", "last_checked_ok",

891

458

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

892

client_defaults = {

893

"timeout": "PT5M",

894

"extended_timeout": "PT15M",

895

"interval": "PT2M",

896

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

897

"host": "",

898

"approval_delay": "PT0S",

899

"approval_duration": "PT1S",

900

"approved_by_default": "True",

901

"enabled": "True",

902

}

903

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

904

470

@staticmethod

905

471

def config_parser(config):

906

472

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

913

479

for client_name in config.sections():

914

480

section = dict(config.items(client_name))

915

481

client = settings[client_name] = {}

916

482

917

483

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

918

484

# Reformat values from string types to Python types

919

485

client["approved_by_default"] = config.getboolean(

920

486

client_name, "approved_by_default")

921

487

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

922

488

"enabled")

923

924

# Uppercase and remove spaces from key_id and fingerprint

925

# for later comparison purposes with return value from the

926

# key_id() and fingerprint() functions

927

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

928

.replace(" ", ""))

489

929

490

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

930

491

.replace(" ", ""))

931

492

if "secret" in section:

932

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

933

.encode("utf-8"),

934

"base64")

493

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

935

494

elif "secfile" in section:

936

495

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

937

496

(section["secfile"])),

952

511

client["last_approval_request"] = None

953

512

client["last_checked_ok"] = None

954

513

client["last_checker_status"] = -2

955

514

956

515

return settings

957

958

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

516

517

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

959

518

self.name = name

960

519

if server_settings is None:

961

520

server_settings = {}

963

522

# adding all client settings

964

523

for setting, value in settings.items():

965

524

setattr(self, setting, value)

966

525

967

526

if self.enabled:

968

527

if not hasattr(self, "last_enabled"):

969

528

self.last_enabled = datetime.datetime.utcnow()

973

532

else:

974

533

self.last_enabled = None

975

534

self.expires = None

976

535

977

536

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

978

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

537

# Uppercase and remove spaces from fingerprint for later

538

# comparison purposes with return value from the fingerprint()

539

# function

979

540

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

980

541

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

981

542

datetime.datetime.utcnow())

982

543

983

544

# attributes specific for this server instance

984

545

self.checker = None

985

546

self.checker_initiator_tag = None

988

549

self.current_checker_command = None

989

550

self.approved = None

990

551

self.approvals_pending = 0

991

self.changedstate = multiprocessing_manager.Condition(

992

multiprocessing_manager.Lock())

993

self.client_structure = [attr

994

for attr in self.__dict__.keys()

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

995

557

if not attr.startswith("_")]

996

558

self.client_structure.append("client_structure")

997

998

for name, t in inspect.getmembers(

999

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

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

1000

564

if not name.startswith("_"):

1001

565

self.client_structure.append(name)

1002

566

1003

567

# Send notice to process children that client state has changed

1004

568

def send_changedstate(self):

1005

569

with self.changedstate:

1006

570

self.changedstate.notify_all()

1007

571

1008

572

def enable(self):

1009

573

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

1010

574

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

1015

579

self.last_enabled = datetime.datetime.utcnow()

1016

580

self.init_checker()

1017

581

self.send_changedstate()

1018

582

1019

583

def disable(self, quiet=True):

1020

584

"""Disable this client."""

1021

585

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

1023

587

if not quiet:

1024

588

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

1025

589

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

1026

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

1027

591

self.disable_initiator_tag = None

1028

592

self.expires = None

1029

593

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

1030

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

1031

595

self.checker_initiator_tag = None

1032

596

self.stop_checker()

1033

597

self.enabled = False

1034

598

if not quiet:

1035

599

self.send_changedstate()

1036

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

600

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

1037

601

return False

1038

602

1039

603

def __del__(self):

1040

604

self.disable()

1041

605

1042

606

def init_checker(self):

1043

607

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

1044

608

# and every interval from then on.

1045

609

if self.checker_initiator_tag is not None:

1046

GLib.source_remove(self.checker_initiator_tag)

1047

self.checker_initiator_tag = GLib.timeout_add(

1048

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

1049

+ 1)),

1050

self.start_checker)

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

1051

615

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

1052

616

if self.disable_initiator_tag is not None:

1053

GLib.source_remove(self.disable_initiator_tag)

1054

self.disable_initiator_tag = GLib.timeout_add(

1055

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

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

1056

622

# Also start a new checker *right now*.

1057

623

self.start_checker()

1058

1059

def checker_callback(self, source, condition, connection,

1060

command):

624

625

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

1061

626

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

1062

# Read return code from connection (see call_pipe)

1063

returncode = connection.recv()

1064

connection.close()

1065

if self.checker is not None:

1066

self.checker.join()

1067

627

self.checker_callback_tag = None

1068

628

self.checker = None

1069

1070

if returncode >= 0:

1071

self.last_checker_status = returncode

1072

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1073

631

if self.last_checker_status == 0:

1074

632

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

1075

633

vars(self))

1076

634

self.checked_ok()

1077

635

else:

1078

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

636

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

637

vars(self))

1079

638

else:

1080

639

self.last_checker_status = -1

1081

self.last_checker_signal = -returncode

1082

640

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

1083

641

vars(self))

1084

return False

1085

642

1086

643

def checked_ok(self):

1087

644

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

1088

645

self.last_checked_ok = datetime.datetime.utcnow()

1089

646

self.last_checker_status = 0

1090

self.last_checker_signal = None

1091

647

self.bump_timeout()

1092

648

1093

649

def bump_timeout(self, timeout=None):

1094

650

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

1095

651

if timeout is None:

1096

652

timeout = self.timeout

1097

653

if self.disable_initiator_tag is not None:

1098

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1099

655

self.disable_initiator_tag = None

1100

656

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

1101

self.disable_initiator_tag = GLib.timeout_add(

1102

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1103

660

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

1104

661

1105

662

def need_approval(self):

1106

663

self.last_approval_request = datetime.datetime.utcnow()

1107

664

1108

665

def start_checker(self):

1109

666

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

1110

667

1111

668

If a checker already exists, leave it running and do

1112

669

nothing."""

1113

670

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

1118

675

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

1119

676

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

1120

677

# should be.

1121

1122

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

1123

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

1124

self.checker.join()

1125

self.checker = None

678

679

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

680

try:

681

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

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1126

693

# Start a new checker if needed

1127

694

if self.checker is None:

1128

695

# Escape attributes for the shell

1129

escaped_attrs = {

1130

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

1131

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1132

699

try:

1133

700

command = self.checker_command % escaped_attrs

1134

701

except TypeError as error:

1135

702

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

1136

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

721

self.checker = subprocess.Popen(command,

722

close_fds=True,

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

1137

727

exc_info=error)

1138

return True # Try again later

1139

self.current_checker_command = command

1140

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

1141

self.name)

1142

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

1143

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

1144

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

1145

# always replaced by /dev/null.)

1146

# The exception is when not debugging but nevertheless

1147

# running in the foreground; use the previously

1148

# created wnull.

1149

popen_args = {"close_fds": True,

1150

"shell": True,

1151

"cwd": "/"}

1152

if (not self.server_settings["debug"]

1153

and self.server_settings["foreground"]):

1154

popen_args.update({"stdout": wnull,

1155

"stderr": wnull})

1156

pipe = multiprocessing.Pipe(duplex=False)

1157

self.checker = multiprocessing.Process(

1158

target=call_pipe,

1159

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

1160

kwargs=popen_args)

1161

self.checker.start()

1162

self.checker_callback_tag = GLib.io_add_watch(

1163

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

1164

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1165

self.checker_callback, pipe[0], command)

1166

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

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

747

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

1167

748

return True

1168

749

1169

750

def stop_checker(self):

1170

751

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

1171

752

if self.checker_callback_tag:

1172

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1173

754

self.checker_callback_tag = None

1174

755

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

1175

756

return

1176

757

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

1177

self.checker.terminate()

758

try:

759

self.checker.terminate()

760

#time.sleep(0.5)

761

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

762

# self.checker.kill()

763

except OSError as error:

764

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

765

raise

1178

766

self.checker = None

1179

767

1180

768

1181

def dbus_service_property(dbus_interface,

1182

signature="v",

1183

access="readwrite",

1184

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1185

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1186

772

become properties on the D-Bus.

1187

773

1188

774

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

1189

775

and with one argument by "Set".

1190

776

1191

777

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

1192

778

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

1193

779

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

1197

783

if byte_arrays and signature != "ay":

1198

784

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

1199

785

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

1200

1201

786

def decorator(func):

1202

787

func._dbus_is_property = True

1203

788

func._dbus_interface = dbus_interface

1206

791

func._dbus_name = func.__name__

1207

792

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

1208

793

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

1209

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1210

795

return func

1211

1212

796

return decorator

1213

797

1214

798

1215

799

def dbus_interface_annotations(dbus_interface):

1216

800

"""Decorator for marking functions returning interface annotations

1217

801

1218

802

Usage:

1219

803

1220

804

@dbus_interface_annotations("org.example.Interface")

1221

805

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

1222

806

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

1223

807

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

1224

808

"false"}

1225

809

"""

1226

1227

810

def decorator(func):

1228

811

func._dbus_is_interface = True

1229

812

func._dbus_interface = dbus_interface

1230

813

func._dbus_name = dbus_interface

1231

814

return func

1232

1233

815

return decorator

1234

816

1235

817

1236

818

def dbus_annotations(annotations):

1237

819

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

1238

820

Usage:

1239

821

1240

822

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

1241

823

"org.freedesktop.DBus.Property."

1242

824

"EmitsChangedSignal": "false"})

1244

826

access="r")

1245

827

def Property_dbus_property(self):

1246

828

return dbus.Boolean(False)

1247

1248

See also the DBusObjectWithAnnotations class.

1249

829

"""

1250

1251

830

def decorator(func):

1252

831

func._dbus_annotations = annotations

1253

832

return func

1254

1255

833

return decorator

1256

834

1257

835

1260

838

"""

1261

839

pass

1262

840

1263

1264

841

class DBusPropertyAccessException(DBusPropertyException):

1265

842

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

1266

843

"""

1273

850

pass

1274

851

1275

852

1276

class DBusObjectWithAnnotations(dbus.service.Object):

1277

"""A D-Bus object with annotations.

1278

1279

Classes inheriting from this can use the dbus_annotations

1280

decorator to add annotations to methods or signals.

853

class DBusObjectWithProperties(dbus.service.Object):

854

"""A D-Bus object with properties.

855

856

Classes inheriting from this can use the dbus_service_property

857

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

858

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

1281

859

"""

1282

860

1283

861

@staticmethod

1284

862

def _is_dbus_thing(thing):

1285

863

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

1286

864

1287

865

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

1288

866

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

1289

867

"""

1290

868

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

1291

869

False)

1292

870

1293

871

def _get_all_dbus_things(self, thing):

1294

872

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

1295

873

"""

1296

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

874

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

875

name),

1297

876

athing.__get__(self))

1298

877

for cls in self.__class__.__mro__

1299

878

for name, athing in

1300

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

1301

1302

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1303

out_signature="s",

1304

path_keyword='object_path',

1305

connection_keyword='connection')

1306

def Introspect(self, object_path, connection):

1307

"""Overloading of standard D-Bus method.

1308

1309

Inserts annotation tags on methods and signals.

1310

"""

1311

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

1312

connection)

1313

try:

1314

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

1315

1316

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

1317

# Add annotation tags

1318

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

1319

for tag in if_tag.getElementsByTagName(typ):

1320

annots = dict()

1321

for name, prop in (self.

1322

_get_all_dbus_things(typ)):

1323

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

1324

and prop._dbus_interface

1325

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

1326

annots.update(getattr(

1327

prop, "_dbus_annotations", {}))

1328

for name, value in annots.items():

1329

ann_tag = document.createElement(

1330

"annotation")

1331

ann_tag.setAttribute("name", name)

1332

ann_tag.setAttribute("value", value)

1333

tag.appendChild(ann_tag)

1334

# Add interface annotation tags

1335

for annotation, value in dict(

1336

itertools.chain.from_iterable(

1337

annotations().items()

1338

for name, annotations

1339

in self._get_all_dbus_things("interface")

1340

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

1341

)).items():

1342

ann_tag = document.createElement("annotation")

1343

ann_tag.setAttribute("name", annotation)

1344

ann_tag.setAttribute("value", value)

1345

if_tag.appendChild(ann_tag)

1346

# Fix argument name for the Introspect method itself

1347

if (if_tag.getAttribute("name")

1348

== dbus.INTROSPECTABLE_IFACE):

1349

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

1350

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

1351

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

1352

if (arg.getAttribute("direction")

1353

== "out"):

1354

arg.setAttribute("name",

1355

"xml_data")

1356

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

1357

document.unlink()

1358

except (AttributeError, xml.dom.DOMException,

1359

xml.parsers.expat.ExpatError) as error:

1360

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

1361

exc_info=error)

1362

return xmlstring

1363

1364

1365

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1366

"""A D-Bus object with properties.

1367

1368

Classes inheriting from this can use the dbus_service_property

1369

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

1370

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

1371

"""

1372

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1373

882

def _get_dbus_property(self, interface_name, property_name):

1374

883

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

1375

884

property with the specified name and interface.

1376

885

"""

1377

for cls in self.__class__.__mro__:

1378

for name, value in inspect.getmembers(

1379

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

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1380

890

if (value._dbus_name == property_name

1381

891

and value._dbus_interface == interface_name):

1382

892

return value.__get__(self)

1383

893

1384

894

# No such property

1385

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

1386

self.dbus_object_path, interface_name, property_name))

1387

1388

@classmethod

1389

def _get_all_interface_names(cls):

1390

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

1391

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

1392

"_dbus_interface", None)

1393

for x in (inspect.getmro(cls))

1394

for attr in dir(x))

1395

if name is not None)

1396

1397

@dbus.service.method(dbus.PROPERTIES_IFACE,

1398

in_signature="ss",

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1399

900

out_signature="v")

1400

901

def Get(self, interface_name, property_name):

1401

902

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

1407

908

if not hasattr(value, "variant_level"):

1408

909

return value

1409

910

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

1410

911

1411

912

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

1412

913

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

1413

914

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

1422

923

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

1423

924

"'ay' signature {!r}"

1424

925

.format(prop._dbus_signature))

1425

value = dbus.ByteArray(bytes(value))

926

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

927

for byte in value))

1426

928

prop(value)

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="s",

929

930

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

1430

931

out_signature="a{sv}")

1431

932

def GetAll(self, interface_name):

1432

933

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

1433

934

standard.

1434

935

1435

936

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

1436

937

"""

1437

938

properties = {}

1447

948

if not hasattr(value, "variant_level"):

1448

949

properties[name] = value

1449

950

continue

1450

properties[name] = type(value)(

1451

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1452

953

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

1453

954

1454

955

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

1455

956

def PropertiesChanged(self, interface_name, changed_properties,

1456

957

invalidated_properties):

1458

959

standard.

1459

960

"""

1460

961

pass

1461

962

1462

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1463

964

out_signature="s",

1464

965

path_keyword='object_path',

1465

966

connection_keyword='connection')

1466

967

def Introspect(self, object_path, connection):

1467

968

"""Overloading of standard D-Bus method.

1468

969

1469

970

Inserts property tags and interface annotation tags.

1470

971

"""

1471

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1472

object_path,

1473

connection)

972

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

973

connection)

1474

974

try:

1475

975

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

1476

1477

976

def make_tag(document, name, prop):

1478

977

e = document.createElement("property")

1479

978

e.setAttribute("name", name)

1480

979

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

1481

980

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

1482

981

return e

1483

1484

982

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

1485

983

# Add property tags

1486

984

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

1489

987

if prop._dbus_interface

1490

988

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

1491

989

if_tag.appendChild(tag)

1492

# Add annotation tags for properties

1493

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

1494

annots = dict()

1495

for name, prop in self._get_all_dbus_things(

1496

"property"):

1497

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

1498

and prop._dbus_interface

1499

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

1500

annots.update(getattr(

1501

prop, "_dbus_annotations", {}))

1502

for name, value in annots.items():

1503

ann_tag = document.createElement(

1504

"annotation")

1505

ann_tag.setAttribute("name", name)

1506

ann_tag.setAttribute("value", value)

1507

tag.appendChild(ann_tag)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

1508

1021

# Add the names to the return values for the

1509

1022

# "org.freedesktop.DBus.Properties" methods

1510

1023

if (if_tag.getAttribute("name")

1529

1042

return xmlstring

1530

1043

1531

1044

1532

try:

1533

dbus.OBJECT_MANAGER_IFACE

1534

except AttributeError:

1535

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

1536

1537

1538

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1539

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

1540

1541

Classes inheriting from this exposes the standard

1542

GetManagedObjects call and the InterfacesAdded and

1543

InterfacesRemoved signals on the standard

1544

"org.freedesktop.DBus.ObjectManager" interface.

1545

1546

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

1547

manually.

1548

"""

1549

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1550

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

1551

def GetManagedObjects(self):

1552

"""This function must be overridden"""

1553

raise NotImplementedError()

1554

1555

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1556

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

1557

def InterfacesAdded(self, object_path, interfaces_and_properties):

1558

pass

1559

1560

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

1561

def InterfacesRemoved(self, object_path, interfaces):

1562

pass

1563

1564

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1565

out_signature="s",

1566

path_keyword='object_path',

1567

connection_keyword='connection')

1568

def Introspect(self, object_path, connection):

1569

"""Overloading of standard D-Bus method.

1570

1571

Override return argument name of GetManagedObjects to be

1572

"objpath_interfaces_and_properties"

1573

"""

1574

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1575

object_path,

1576

connection)

1577

try:

1578

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

1579

1580

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

1581

# Fix argument name for the GetManagedObjects method

1582

if (if_tag.getAttribute("name")

1583

== dbus.OBJECT_MANAGER_IFACE):

1584

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

1585

if (cn.getAttribute("name")

1586

== "GetManagedObjects"):

1587

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

1588

if (arg.getAttribute("direction")

1589

== "out"):

1590

arg.setAttribute(

1591

"name",

1592

"objpath_interfaces"

1593

"_and_properties")

1594

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

1595

document.unlink()

1596

except (AttributeError, xml.dom.DOMException,

1597

xml.parsers.expat.ExpatError) as error:

1598

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

1599

exc_info=error)

1600

return xmlstring

1601

1602

1603

1045

def datetime_to_dbus(dt, variant_level=0):

1604

1046

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

1605

1047

if dt is None:

1606

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

1607

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

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1608

1051

1609

1052

1610

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1612

1055

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

1613

1056

interface names according to the "alt_interface_names" mapping.

1614

1057

Usage:

1615

1058

1616

1059

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

1617

1060

"net.example.AlternateInterface"})

1618

1061

class SampleDBusObject(dbus.service.Object):

1619

1062

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

1620

1063

def SampleDBusMethod():

1621

1064

pass

1622

1065

1623

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1624

1067

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

1625

1068

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

1626

1069

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

1627

1070

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

1628

1071

1629

1072

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

1630

1073

(from DBusObjectWithProperties) and interfaces (from the

1631

1074

dbus_interface_annotations decorator).

1632

1075

"""

1633

1634

1076

def wrapper(cls):

1635

1077

for orig_interface_name, alt_interface_name in (

1636

alt_interface_names.items()):

1078

alt_interface_names.items()):

1637

1079

attr = {}

1638

1080

interface_names = set()

1639

1081

# Go though all attributes of the class

1641

1083

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

1642

1084

# with the wrong interface name

1643

1085

if (not hasattr(attribute, "_dbus_interface")

1644

or not attribute._dbus_interface.startswith(

1645

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1646

1088

continue

1647

1089

# Create an alternate D-Bus interface name based on

1648

1090

# the current name

1649

alt_interface = attribute._dbus_interface.replace(

1650

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1651

1094

interface_names.add(alt_interface)

1652

1095

# Is this a D-Bus signal?

1653

1096

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

1654

1097

# Extract the original non-method undecorated

1655

1098

# function by black magic

1656

if sys.version_info.major == 2:

1657

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1658

1100

zip(attribute.func_code.co_freevars,

1659

attribute.__closure__))

1660

["func"].cell_contents)

1661

else:

1662

nonmethod_func = (dict(

1663

zip(attribute.__code__.co_freevars,

1664

attribute.__closure__))

1665

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1666

1103

# Create a new, but exactly alike, function

1667

1104

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

1668

1105

# with the alternate D-Bus interface name

1669

new_function = copy_function(nonmethod_func)

1670

new_function = (dbus.service.signal(

1671

alt_interface,

1672

attribute._dbus_signature)(new_function))

1106

new_function = (dbus.service.signal

1107

(alt_interface,

1108

attribute._dbus_signature)

1109

(types.FunctionType(

1110

nonmethod_func.func_code,

1111

nonmethod_func.func_globals,

1112

nonmethod_func.func_name,

1113

nonmethod_func.func_defaults,

1114

nonmethod_func.func_closure)))

1673

1115

# Copy annotations, if any

1674

1116

try:

1675

new_function._dbus_annotations = dict(

1676

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1677

1119

except AttributeError:

1678

1120

pass

1679

1680

1121

# Define a creator of a function to call both the

1681

1122

# original and alternate functions, so both the

1682

1123

# original and alternate signals gets sent when

1685

1126

"""This function is a scope container to pass

1686

1127

func1 and func2 to the "call_both" function

1687

1128

outside of its arguments"""

1688

1689

@functools.wraps(func2)

1690

1129

def call_both(*args, **kwargs):

1691

1130

"""This function will emit two D-Bus

1692

1131

signals by calling func1 and func2"""

1693

1132

func1(*args, **kwargs)

1694

1133

func2(*args, **kwargs)

1695

# Make wrapper function look like a D-Bus

1696

# signal

1697

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

1698

if name.startswith("_dbus_"):

1699

setattr(call_both, name, attr)

1700

1701

1134

return call_both

1702

1135

# Create the "call_both" function and add it to

1703

1136

# the class

1708

1141

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

1709

1142

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

1710

1143

# to the class.

1711

attr[attrname] = (

1712

dbus.service.method(

1713

alt_interface,

1714

attribute._dbus_in_signature,

1715

attribute._dbus_out_signature)

1716

(copy_function(attribute)))

1144

attr[attrname] = (dbus.service.method

1145

(alt_interface,

1146

attribute._dbus_in_signature,

1147

attribute._dbus_out_signature)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1717

1154

# Copy annotations, if any

1718

1155

try:

1719

attr[attrname]._dbus_annotations = dict(

1720

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1721

1158

except AttributeError:

1722

1159

pass

1723

1160

# Is this a D-Bus property?

1726

1163

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

1727

1164

# property with the alternate D-Bus interface

1728

1165

# name. Add it to the class.

1729

attr[attrname] = (dbus_service_property(

1730

alt_interface, attribute._dbus_signature,

1731

attribute._dbus_access,

1732

attribute._dbus_get_args_options

1733

["byte_arrays"])

1734

(copy_function(attribute)))

1166

attr[attrname] = (dbus_service_property

1167

(alt_interface,

1168

attribute._dbus_signature,

1169

attribute._dbus_access,

1170

attribute

1171

._dbus_get_args_options

1172

["byte_arrays"])

1173

(types.FunctionType

1174

(attribute.func_code,

1175

attribute.func_globals,

1176

attribute.func_name,

1177

attribute.func_defaults,

1178

attribute.func_closure)))

1735

1179

# Copy annotations, if any

1736

1180

try:

1737

attr[attrname]._dbus_annotations = dict(

1738

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1739

1183

except AttributeError:

1740

1184

pass

1741

1185

# Is this a D-Bus interface?

1744

1188

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

1745

1189

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

1746

1190

# to the class.

1747

attr[attrname] = (

1748

dbus_interface_annotations(alt_interface)

1749

(copy_function(attribute)))

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1750

1199

if deprecate:

1751

1200

# Deprecate all alternate interfaces

1752

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1753

1202

for interface_name in interface_names:

1754

1755

1203

@dbus_interface_annotations(interface_name)

1756

1204

def func(self):

1757

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

1758

"true"}

1205

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

1206

"true" }

1759

1207

# Find an unused name

1760

1208

for aname in (iname.format(i)

1761

1209

for i in itertools.count()):

1765

1213

if interface_names:

1766

1214

# Replace the class with a new subclass of it with

1767

1215

# methods, signals, etc. as created above.

1768

if sys.version_info.major == 2:

1769

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

1770

(cls, ), attr)

1771

else:

1772

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

1773

(cls, ), attr)

1216

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

1217

(cls,), attr)

1774

1218

return cls

1775

1776

1219

return wrapper

1777

1220

1778

1221

1779

1222

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

1780

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1781

1224

class ClientDBus(Client, DBusObjectWithProperties):

1782

1225

"""A Client class using D-Bus

1783

1226

1784

1227

Attributes:

1785

1228

dbus_object_path: dbus.ObjectPath

1786

1229

bus: dbus.SystemBus()

1787

1230

"""

1788

1231

1789

1232

runtime_expansions = (Client.runtime_expansions

1790

+ ("dbus_object_path", ))

1791

1233

+ ("dbus_object_path",))

1234

1792

1235

_interface = "se.recompile.Mandos.Client"

1793

1236

1794

1237

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

1795

1796

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

1238

1239

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

1797

1240

self.bus = bus

1798

1241

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

1799

1242

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

1801

1244

client_object_name = str(self.name).translate(

1802

1245

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

1803

1246

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

1804

self.dbus_object_path = dbus.ObjectPath(

1805

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1806

1249

DBusObjectWithProperties.__init__(self, self.bus,

1807

1250

self.dbus_object_path)

1808

1809

def notifychangeproperty(transform_func, dbus_name,

1810

type_func=lambda x: x,

1811

variant_level=1,

1812

invalidate_only=False,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1813

1255

_interface=_interface):

1814

1256

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

1815

1257

its changes to DBus.

1816

1258

1817

1259

transform_fun: Function that takes a value and a variant_level

1818

1260

and transforms it to a D-Bus type.

1819

1261

dbus_name: D-Bus name of the variable

1822

1264

variant_level: D-Bus variant level. Default: 1

1823

1265

"""

1824

1266

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

1825

1826

1267

def setter(self, value):

1827

1268

if hasattr(self, "dbus_object_path"):

1828

1269

if (not hasattr(self, attrname) or

1829

1270

type_func(getattr(self, attrname, None))

1830

1271

!= type_func(value)):

1831

1272

if invalidate_only:

1832

self.PropertiesChanged(

1833

_interface, dbus.Dictionary(),

1834

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1835

1277

else:

1836

dbus_value = transform_func(

1837

type_func(value),

1838

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1839

1281

self.PropertyChanged(dbus.String(dbus_name),

1840

1282

dbus_value)

1841

self.PropertiesChanged(

1842

_interface,

1843

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

1844

dbus_value}),

1845

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1846

1287

setattr(self, attrname, value)

1847

1288

1848

1289

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

1849

1290

1850

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1851

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1852

1293

"ApprovalPending",

1853

type_func=bool)

1294

type_func = bool)

1854

1295

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

1855

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1856

1297

"LastEnabled")

1857

checker = notifychangeproperty(

1858

dbus.Boolean, "CheckerRunning",

1859

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1860

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1861

1302

"LastCheckedOK")

1862

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1865

1306

datetime_to_dbus, "LastApprovalRequest")

1866

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1867

1308

"ApprovedByDefault")

1868

approval_delay = notifychangeproperty(

1869

dbus.UInt64, "ApprovalDelay",

1870

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

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1871

1314

approval_duration = notifychangeproperty(

1872

1315

dbus.UInt64, "ApprovalDuration",

1873

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

1316

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

1874

1317

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

1875

timeout = notifychangeproperty(

1876

dbus.UInt64, "Timeout",

1877

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1878

1321

extended_timeout = notifychangeproperty(

1879

1322

dbus.UInt64, "ExtendedTimeout",

1880

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

1881

interval = notifychangeproperty(

1882

dbus.UInt64, "Interval",

1883

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

1323

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

1324

interval = notifychangeproperty(dbus.UInt64,

1325

"Interval",

1326

type_func =

1327

lambda td: td.total_seconds()

1328

* 1000)

1884

1329

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

1885

1330

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

1886

1331

invalidate_only=True)

1887

1332

1888

1333

del notifychangeproperty

1889

1334

1890

1335

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

1891

1336

try:

1892

1337

self.remove_from_connection()

1895

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1896

1341

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

1897

1342

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

1898

1899

def checker_callback(self, source, condition,

1900

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

1901

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

1902

connection, command, *args,

1903

**kwargs)

1904

exitstatus = self.last_checker_status

1905

if exitstatus >= 0:

1343

1344

def checker_callback(self, pid, condition, command,

1345

*args, **kwargs):

1346

self.checker_callback_tag = None

1347

self.checker = None

1348

if os.WIFEXITED(condition):

1349

exitstatus = os.WEXITSTATUS(condition)

1906

1350

# Emit D-Bus signal

1907

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1908

# This is specific to GNU libC

1909

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1910

1353

dbus.String(command))

1911

1354

else:

1912

1355

# Emit D-Bus signal

1913

1356

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

1914

dbus.Int64(

1915

# This is specific to GNU libC

1916

(exitstatus << 8)

1917

| self.last_checker_signal),

1357

dbus.Int64(condition),

1918

1358

dbus.String(command))

1919

return ret

1920

1359

1360

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

1361

*args, **kwargs)

1362

1921

1363

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

1922

1364

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

1923

1365

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

1927

1369

# Emit D-Bus signal

1928

1370

self.CheckerStarted(self.current_checker_command)

1929

1371

return r

1930

1372

1931

1373

def _reset_approved(self):

1932

1374

self.approved = None

1933

1375

return False

1934

1376

1935

1377

def approve(self, value=True):

1936

1378

self.approved = value

1937

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

1938

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1939

1381

self.send_changedstate()

1940

1941

# D-Bus methods, signals & properties

1942

1943

# Interfaces

1944

1945

# Signals

1946

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1947

1389

# CheckerCompleted - signal

1948

1390

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

1949

1391

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

1950

1392

"D-Bus signal"

1951

1393

pass

1952

1394

1953

1395

# CheckerStarted - signal

1954

1396

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

1955

1397

def CheckerStarted(self, command):

1956

1398

"D-Bus signal"

1957

1399

pass

1958

1400

1959

1401

# PropertyChanged - signal

1960

1402

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

1961

1403

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

1962

1404

def PropertyChanged(self, property, value):

1963

1405

"D-Bus signal"

1964

1406

pass

1965

1407

1966

1408

# GotSecret - signal

1967

1409

@dbus.service.signal(_interface)

1968

1410

def GotSecret(self):

1971

1413

server to mandos-client

1972

1414

"""

1973

1415

pass

1974

1416

1975

1417

# Rejected - signal

1976

1418

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

1977

1419

def Rejected(self, reason):

1978

1420

"D-Bus signal"

1979

1421

pass

1980

1422

1981

1423

# NeedApproval - signal

1982

1424

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

1983

1425

def NeedApproval(self, timeout, default):

1984

1426

"D-Bus signal"

1985

1427

return self.need_approval()

1986

1987

# Methods

1988

1428

1429

## Methods

1430

1989

1431

# Approve - method

1990

1432

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

1991

1433

def Approve(self, value):

1992

1434

self.approve(value)

1993

1435

1994

1436

# CheckedOK - method

1995

1437

@dbus.service.method(_interface)

1996

1438

def CheckedOK(self):

1997

1439

self.checked_ok()

1998

1440

1999

1441

# Enable - method

2000

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

2001

1442

@dbus.service.method(_interface)

2002

1443

def Enable(self):

2003

1444

"D-Bus method"

2004

1445

self.enable()

2005

1446

2006

1447

# StartChecker - method

2007

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

2008

1448

@dbus.service.method(_interface)

2009

1449

def StartChecker(self):

2010

1450

"D-Bus method"

2011

1451

self.start_checker()

2012

1452

2013

1453

# Disable - method

2014

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

2015

1454

@dbus.service.method(_interface)

2016

1455

def Disable(self):

2017

1456

"D-Bus method"

2018

1457

self.disable()

2019

1458

2020

1459

# StopChecker - method

2021

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

2022

1460

@dbus.service.method(_interface)

2023

1461

def StopChecker(self):

2024

1462

self.stop_checker()

2025

2026

# Properties

2027

1463

1464

## Properties

1465

2028

1466

# ApprovalPending - property

2029

1467

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

2030

1468

def ApprovalPending_dbus_property(self):

2031

1469

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

2032

1470

2033

1471

# ApprovedByDefault - property

2034

@dbus_service_property(_interface,

2035

signature="b",

1472

@dbus_service_property(_interface, signature="b",

2036

1473

access="readwrite")

2037

1474

def ApprovedByDefault_dbus_property(self, value=None):

2038

1475

if value is None: # get

2039

1476

return dbus.Boolean(self.approved_by_default)

2040

1477

self.approved_by_default = bool(value)

2041

1478

2042

1479

# ApprovalDelay - property

2043

@dbus_service_property(_interface,

2044

signature="t",

1480

@dbus_service_property(_interface, signature="t",

2045

1481

access="readwrite")

2046

1482

def ApprovalDelay_dbus_property(self, value=None):

2047

1483

if value is None: # get

2048

1484

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

2049

1485

* 1000)

2050

1486

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

2051

1487

2052

1488

# ApprovalDuration - property

2053

@dbus_service_property(_interface,

2054

signature="t",

1489

@dbus_service_property(_interface, signature="t",

2055

1490

access="readwrite")

2056

1491

def ApprovalDuration_dbus_property(self, value=None):

2057

1492

if value is None: # get

2058

1493

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

2059

1494

* 1000)

2060

1495

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

2061

1496

2062

1497

# Name - property

2063

@dbus_annotations(

2064

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

2065

1498

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

2066

1499

def Name_dbus_property(self):

2067

1500

return dbus.String(self.name)

2068

2069

# KeyID - property

2070

@dbus_annotations(

2071

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

2072

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

2073

def KeyID_dbus_property(self):

2074

return dbus.String(self.key_id)

2075

1501

2076

1502

# Fingerprint - property

2077

@dbus_annotations(

2078

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

2079

1503

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

2080

1504

def Fingerprint_dbus_property(self):

2081

1505

return dbus.String(self.fingerprint)

2082

1506

2083

1507

# Host - property

2084

@dbus_service_property(_interface,

2085

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2086

1509

access="readwrite")

2087

1510

def Host_dbus_property(self, value=None):

2088

1511

if value is None: # get

2089

1512

return dbus.String(self.host)

2090

1513

self.host = str(value)

2091

1514

2092

1515

# Created - property

2093

@dbus_annotations(

2094

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

2095

1516

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

2096

1517

def Created_dbus_property(self):

2097

1518

return datetime_to_dbus(self.created)

2098

1519

2099

1520

# LastEnabled - property

2100

1521

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

2101

1522

def LastEnabled_dbus_property(self):

2102

1523

return datetime_to_dbus(self.last_enabled)

2103

1524

2104

1525

# Enabled - property

2105

@dbus_service_property(_interface,

2106

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2107

1527

access="readwrite")

2108

1528

def Enabled_dbus_property(self, value=None):

2109

1529

if value is None: # get

2112

1532

self.enable()

2113

1533

else:

2114

1534

self.disable()

2115

1535

2116

1536

# LastCheckedOK - property

2117

@dbus_service_property(_interface,

2118

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2119

1538

access="readwrite")

2120

1539

def LastCheckedOK_dbus_property(self, value=None):

2121

1540

if value is not None:

2122

1541

self.checked_ok()

2123

1542

return

2124

1543

return datetime_to_dbus(self.last_checked_ok)

2125

1544

2126

1545

# LastCheckerStatus - property

2127

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2128

1548

def LastCheckerStatus_dbus_property(self):

2129

1549

return dbus.Int16(self.last_checker_status)

2130

1550

2131

1551

# Expires - property

2132

1552

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

2133

1553

def Expires_dbus_property(self):

2134

1554

return datetime_to_dbus(self.expires)

2135

1555

2136

1556

# LastApprovalRequest - property

2137

1557

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

2138

1558

def LastApprovalRequest_dbus_property(self):

2139

1559

return datetime_to_dbus(self.last_approval_request)

2140

1560

2141

1561

# Timeout - property

2142

@dbus_service_property(_interface,

2143

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2144

1563

access="readwrite")

2145

1564

def Timeout_dbus_property(self, value=None):

2146

1565

if value is None: # get

2158

1577

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

2159

1578

is None):

2160

1579

return

2161

GLib.source_remove(self.disable_initiator_tag)

2162

self.disable_initiator_tag = GLib.timeout_add(

2163

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

2164

self.disable)

2165

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

2166

1586

# ExtendedTimeout - property

2167

@dbus_service_property(_interface,

2168

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2169

1588

access="readwrite")

2170

1589

def ExtendedTimeout_dbus_property(self, value=None):

2171

1590

if value is None: # get

2172

1591

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

2173

1592

* 1000)

2174

1593

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

2175

1594

2176

1595

# Interval - property

2177

@dbus_service_property(_interface,

2178

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2179

1597

access="readwrite")

2180

1598

def Interval_dbus_property(self, value=None):

2181

1599

if value is None: # get

2185

1603

return

2186

1604

if self.enabled:

2187

1605

# Reschedule checker run

2188

GLib.source_remove(self.checker_initiator_tag)

2189

self.checker_initiator_tag = GLib.timeout_add(

2190

value, self.start_checker)

2191

self.start_checker() # Start one now, too

2192

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

2193

1611

# Checker - property

2194

@dbus_service_property(_interface,

2195

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2196

1613

access="readwrite")

2197

1614

def Checker_dbus_property(self, value=None):

2198

1615

if value is None: # get

2199

1616

return dbus.String(self.checker_command)

2200

1617

self.checker_command = str(value)

2201

1618

2202

1619

# CheckerRunning - property

2203

@dbus_service_property(_interface,

2204

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2205

1621

access="readwrite")

2206

1622

def CheckerRunning_dbus_property(self, value=None):

2207

1623

if value is None: # get

2210

1626

self.start_checker()

2211

1627

else:

2212

1628

self.stop_checker()

2213

1629

2214

1630

# ObjectPath - property

2215

@dbus_annotations(

2216

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

2217

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

2218

1631

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

2219

1632

def ObjectPath_dbus_property(self):

2220

return self.dbus_object_path # is already a dbus.ObjectPath

2221

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2222

1635

# Secret = property

2223

@dbus_annotations(

2224

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

2225

"invalidates"})

2226

@dbus_service_property(_interface,

2227

signature="ay",

2228

access="write",

2229

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2230

1638

def Secret_dbus_property(self, value):

2231

1639

self.secret = bytes(value)

2232

1640

2233

1641

del _interface

2234

1642

2235

1643

2236

class ProxyClient:

2237

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

1644

class ProxyClient(object):

1645

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

2238

1646

self._pipe = child_pipe

2239

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

1647

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

2240

1648

if not self._pipe.recv():

2241

raise KeyError(key_id or fpr)

2242

1649

raise KeyError()

1650

2243

1651

def __getattribute__(self, name):

2244

1652

if name == '_pipe':

2245

1653

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

2248

1656

if data[0] == 'data':

2249

1657

return data[1]

2250

1658

if data[0] == 'function':

2251

2252

1659

def func(*args, **kwargs):

2253

1660

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

2254

1661

return self._pipe.recv()[1]

2255

2256

1662

return func

2257

1663

2258

1664

def __setattr__(self, name, value):

2259

1665

if name == '_pipe':

2260

1666

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

2263

1669

2264

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2265

1671

"""A class to handle client connections.

2266

1672

2267

1673

Instantiated once for each connection to handle it.

2268

1674

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

2269

1675

2270

1676

def handle(self):

2271

1677

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

2272

1678

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

2273

1679

str(self.client_address))

2274

1680

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

2275

1681

self.server.child_pipe.fileno())

2276

2277

session = gnutls.ClientSession(self.request)

2278

2279

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

2280

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

2281

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

2282

# "+DHE-DSS"))

1682

1683

session = (gnutls.connection

1684

.ClientSession(self.request,

1685

gnutls.connection

1686

.X509Credentials()))

1687

1688

# Note: gnutls.connection.X509Credentials is really a

1689

# generic GnuTLS certificate credentials object so long as

1690

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

1691

# here despite using OpenPGP certificates.

1692

1693

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

1694

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

1695

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

1696

# "+DHE-DSS"))

2283

1697

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

2284

1698

priority = self.server.gnutls_priority

2285

1699

if priority is None:

2286

1700

priority = "NORMAL"

2287

gnutls.priority_set_direct(session._c_object,

2288

priority.encode("utf-8"),

2289

None)

2290

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2291

1705

# Start communication using the Mandos protocol

2292

1706

# Get protocol number

2293

1707

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

2298

1712

except (ValueError, IndexError, RuntimeError) as error:

2299

1713

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

2300

1714

return

2301

1715

2302

1716

# Start GnuTLS connection

2303

1717

try:

2304

1718

session.handshake()

2305

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2306

1720

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

2307

1721

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

2308

1722

# established. Just abandon the request.

2309

1723

return

2310

1724

logger.debug("Handshake succeeded")

2311

1725

2312

1726

approval_required = False

2313

1727

try:

2314

if gnutls.has_rawpk:

2315

fpr = b""

2316

try:

2317

key_id = self.key_id(

2318

self.peer_certificate(session))

2319

except (TypeError, gnutls.Error) as error:

2320

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

2321

return

2322

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

2323

2324

else:

2325

key_id = b""

2326

try:

2327

fpr = self.fingerprint(

2328

self.peer_certificate(session))

2329

except (TypeError, gnutls.Error) as error:

2330

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

2331

return

2332

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

2333

2334

try:

2335

client = ProxyClient(child_pipe, key_id, fpr,

1728

try:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

1733

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

1734

return

1735

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

1736

1737

try:

1738

client = ProxyClient(child_pipe, fpr,

2336

1739

self.client_address)

2337

1740

except KeyError:

2338

1741

return

2339

1742

2340

1743

if client.approval_delay:

2341

1744

delay = client.approval_delay

2342

1745

client.approvals_pending += 1

2343

1746

approval_required = True

2344

1747

2345

1748

while True:

2346

1749

if not client.enabled:

2347

1750

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

2348

client.name)

1751

client.name)

2349

1752

if self.server.use_dbus:

2350

1753

# Emit D-Bus signal

2351

1754

client.Rejected("Disabled")

2352

1755

return

2353

1756

2354

1757

if client.approved or not client.approval_delay:

2355

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2356

1759

break

2357

1760

elif client.approved is None:

2358

1761

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

2369

1772

# Emit D-Bus signal

2370

1773

client.Rejected("Denied")

2371

1774

return

2372

2373

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2374

1777

time = datetime.datetime.now()

2375

1778

client.changedstate.acquire()

2376

1779

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

2389

1792

break

2390

1793

else:

2391

1794

delay -= time2 - time

2392

2393

try:

2394

session.send(client.secret)

2395

except gnutls.Error as error:

2396

logger.warning("gnutls send failed",

2397

exc_info=error)

2398

return

2399

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

2400

1809

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

2401

1810

# bump the timeout using extended_timeout

2402

1811

client.bump_timeout(client.extended_timeout)

2403

1812

if self.server.use_dbus:

2404

1813

# Emit D-Bus signal

2405

1814

client.GotSecret()

2406

1815

2407

1816

finally:

2408

1817

if approval_required:

2409

1818

client.approvals_pending -= 1

2410

1819

try:

2411

1820

session.bye()

2412

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2413

1822

logger.warning("GnuTLS bye failed",

2414

1823

exc_info=error)

2415

1824

2416

1825

@staticmethod

2417

1826

def peer_certificate(session):

2418

"Return the peer's certificate as a bytestring"

2419

try:

2420

cert_type = gnutls.certificate_type_get2(session._c_object,

2421

gnutls.CTYPE_PEERS)

2422

except AttributeError:

2423

cert_type = gnutls.certificate_type_get(session._c_object)

2424

if gnutls.has_rawpk:

2425

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2426

else:

2427

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2428

# If not a valid certificate type...

2429

if cert_type not in valid_cert_types:

2430

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

2431

valid_cert_types)

2432

# ...return invalid data

2433

return b""

1827

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

1828

# If not an OpenPGP certificate...

1829

if (gnutls.library.functions

1830

.gnutls_certificate_type_get(session._c_object)

1831

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1832

# ...do the normal thing

1833

return session.peer_certificate

2434

1834

list_size = ctypes.c_uint(1)

2435

cert_list = (gnutls.certificate_get_peers

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2436

1837

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

2437

1838

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

2438

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

1839

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

1840

" certificate")

2439

1841

if list_size.value == 0:

2440

1842

return None

2441

1843

cert = cert_list[0]

2442

1844

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

2443

2444

@staticmethod

2445

def key_id(certificate):

2446

"Convert a certificate bytestring to a hexdigit key ID"

2447

# New GnuTLS "datum" with the public key

2448

datum = gnutls.datum_t(

2449

ctypes.cast(ctypes.c_char_p(certificate),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.c_uint(len(certificate)))

2452

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

2453

# New empty GnuTLS certificate

2454

pubkey = gnutls.pubkey_t()

2455

gnutls.pubkey_init(ctypes.byref(pubkey))

2456

# Import the raw public key into the certificate

2457

gnutls.pubkey_import(pubkey,

2458

ctypes.byref(datum),

2459

gnutls.X509_FMT_DER)

2460

# New buffer for the key ID

2461

buf = ctypes.create_string_buffer(32)

2462

buf_len = ctypes.c_size_t(len(buf))

2463

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

2464

gnutls.pubkey_get_key_id(pubkey,

2465

gnutls.KEYID_USE_SHA256,

2466

ctypes.cast(ctypes.byref(buf),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.byref(buf_len))

2469

# Deinit the certificate

2470

gnutls.pubkey_deinit(pubkey)

2471

2472

# Convert the buffer to a Python bytestring

2473

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

2474

# Convert the bytestring to hexadecimal notation

2475

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

2476

return hex_key_id

2477

1845

2478

1846

@staticmethod

2479

1847

def fingerprint(openpgp):

2480

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2481

1849

# New GnuTLS "datum" with the OpenPGP public key

2482

datum = gnutls.datum_t(

2483

ctypes.cast(ctypes.c_char_p(openpgp),

2484

ctypes.POINTER(ctypes.c_ubyte)),

2485

ctypes.c_uint(len(openpgp)))

1850

datum = (gnutls.library.types

1851

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

1852

ctypes.POINTER

1853

(ctypes.c_ubyte)),

1854

ctypes.c_uint(len(openpgp))))

2486

1855

# New empty GnuTLS certificate

2487

crt = gnutls.openpgp_crt_t()

2488

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2489

1859

# Import the OpenPGP public key into the certificate

2490

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

2491

gnutls.OPENPGP_FMT_RAW)

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2492

1864

# Verify the self signature in the key

2493

1865

crtverify = ctypes.c_uint()

2494

gnutls.openpgp_crt_verify_self(crt, 0,

2495

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2496

1869

if crtverify.value != 0:

2497

gnutls.openpgp_crt_deinit(crt)

2498

raise gnutls.CertificateSecurityError(code

2499

=crtverify.value)

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2500

1873

# New buffer for the fingerprint

2501

1874

buf = ctypes.create_string_buffer(20)

2502

1875

buf_len = ctypes.c_size_t()

2503

1876

# Get the fingerprint from the certificate into the buffer

2504

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

2505

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2506

1880

# Deinit the certificate

2507

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2508

1882

# Convert the buffer to a Python bytestring

2509

1883

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

2510

1884

# Convert the bytestring to hexadecimal notation

2512

1886

return hex_fpr

2513

1887

2514

1888

2515

class MultiprocessingMixIn:

1889

class MultiprocessingMixIn(object):

2516

1890

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

2517

2518

1891

def sub_process_main(self, request, address):

2519

1892

try:

2520

1893

self.finish_request(request, address)

2521

1894

except Exception:

2522

1895

self.handle_error(request, address)

2523

1896

self.close_request(request)

2524

1897

2525

1898

def process_request(self, request, address):

2526

1899

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

2527

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

2528

args=(request, address))

1900

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

1901

args = (request, address))

2529

1902

proc.start()

2530

1903

return proc

2531

1904

2532

1905

2533

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2534

1907

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

2535

2536

1908

def process_request(self, request, client_address):

2537

1909

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

2538

1910

2539

1911

This function creates a new pipe in self.pipe

2540

1912

"""

2541

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2542

1914

2543

1915

proc = MultiprocessingMixIn.process_request(self, request,

2544

1916

client_address)

2545

1917

self.child_pipe.close()

2546

1918

self.add_pipe(parent_pipe, proc)

2547

1919

2548

1920

def add_pipe(self, parent_pipe, proc):

2549

1921

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

2550

1922

raise NotImplementedError()

2551

1923

2552

1924

2553

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2554

socketserver.TCPServer):

1926

socketserver.TCPServer, object):

2555

1927

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

2556

1928

2557

1929

Attributes:

2558

1930

enabled: Boolean; whether this server is activated yet

2559

1931

interface: None or a network interface name (string)

2560

1932

use_ipv6: Boolean; to use IPv6 or not

2561

1933

"""

2562

2563

1934

def __init__(self, server_address, RequestHandlerClass,

2564

interface=None,

2565

use_ipv6=True,

2566

socketfd=None):

1935

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

2567

1936

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

2568

1937

creating a new one with socket.socket().

2569

1938

"""

2575

1944

self.socketfd = socketfd

2576

1945

# Save the original socket.socket() function

2577

1946

self.socket_socket = socket.socket

2578

2579

1947

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

2580

#

1948

#

2581

1949

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

2582

1950

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

2583

1951

# patching socket.socket.)

2584

#

1952

#

2585

1953

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

2586

1954

@functools.wraps(socket.socket)

2587

1955

def socket_wrapper(*args, **kwargs):

2599

1967

# socket_wrapper(), if socketfd was set.

2600

1968

socketserver.TCPServer.__init__(self, server_address,

2601

1969

RequestHandlerClass)

2602

1970

2603

1971

def server_bind(self):

2604

1972

"""This overrides the normal server_bind() function

2605

1973

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

2606

1974

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

2607

global SO_BINDTODEVICE

2608

1975

if self.interface is not None:

2609

1976

if SO_BINDTODEVICE is None:

2610

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

2611

# common enough.

2612

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

2613

SO_BINDTODEVICE = 25

2614

try:

2615

self.socket.setsockopt(

2616

socket.SOL_SOCKET, SO_BINDTODEVICE,

2617

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

2618

except socket.error as error:

2619

if error.errno == errno.EPERM:

2620

logger.error("No permission to bind to"

2621

" interface %s", self.interface)

2622

elif error.errno == errno.ENOPROTOOPT:

2623

logger.error("SO_BINDTODEVICE not available;"

2624

" cannot bind to interface %s",

2625

self.interface)

2626

elif error.errno == errno.ENODEV:

2627

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

2628

" cannot bind", self.interface)

2629

else:

2630

raise

1977

logger.error("SO_BINDTODEVICE does not exist;"

1978

" cannot bind to interface %s",

1979

self.interface)

1980

else:

1981

try:

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1983

SO_BINDTODEVICE,

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2631

1999

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

2632

2000

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

2633

if self.server_address[1]:

2634

self.allow_reuse_address = True

2635

2001

if not self.server_address[0]:

2636

2002

if self.address_family == socket.AF_INET6:

2637

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2638

2004

else:

2639

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2640

2006

self.server_address = (any_address,

2641

2007

self.server_address[1])

2642

2008

elif not self.server_address[1]:

2643

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

2009

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

2010

0)

2644

2011

# if self.interface:

2645

2012

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

2646

2013

# 0, # port

2652

2019

2653

2020

class MandosServer(IPv6_TCPServer):

2654

2021

"""Mandos server.

2655

2022

2656

2023

Attributes:

2657

2024

clients: set of Client objects

2658

2025

gnutls_priority GnuTLS priority string

2659

2026

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

2660

2661

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2662

2029

"""

2663

2664

2030

def __init__(self, server_address, RequestHandlerClass,

2665

interface=None,

2666

use_ipv6=True,

2667

clients=None,

2668

gnutls_priority=None,

2669

use_dbus=True,

2670

socketfd=None):

2031

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

2032

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

2671

2033

self.enabled = False

2672

2034

self.clients = clients

2673

2035

if self.clients is None:

2676

2038

self.gnutls_priority = gnutls_priority

2677

2039

IPv6_TCPServer.__init__(self, server_address,

2678

2040

RequestHandlerClass,

2679

interface=interface,

2680

use_ipv6=use_ipv6,

2681

socketfd=socketfd)

2682

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2683

2044

def server_activate(self):

2684

2045

if self.enabled:

2685

2046

return socketserver.TCPServer.server_activate(self)

2686

2047

2687

2048

def enable(self):

2688

2049

self.enabled = True

2689

2050

2690

2051

def add_pipe(self, parent_pipe, proc):

2691

2052

# Call "handle_ipc" for both data and EOF events

2692

GLib.io_add_watch(

2693

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

2694

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

2695

functools.partial(self.handle_ipc,

2696

parent_pipe=parent_pipe,

2697

proc=proc))

2698

2699

def handle_ipc(self, source, condition,

2700

parent_pipe=None,

2701

proc=None,

2702

client_object=None):

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2059

2060

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

2061

proc = None, client_object=None):

2703

2062

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

2704

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

2063

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

2705

2064

# Wait for other process to exit

2706

2065

proc.join()

2707

2066

return False

2708

2067

2709

2068

# Read a request from the child

2710

2069

request = parent_pipe.recv()

2711

2070

command = request[0]

2712

2071

2713

2072

if command == 'init':

2714

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

2715

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

2716

address = request[3]

2717

2718

for c in self.clients.values():

2719

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2720

continue

2721

if key_id and c.key_id == key_id:

2722

client = c

2723

break

2724

if fpr and c.fingerprint == fpr:

2073

fpr = request[1]

2074

address = request[2]

2075

2076

for c in self.clients.itervalues():

2077

if c.fingerprint == fpr:

2725

2078

client = c

2726

2079

break

2727

2080

else:

2728

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

2729

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

2081

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

2082

"dress: %s", fpr, address)

2730

2083

if self.use_dbus:

2731

2084

# Emit D-Bus signal

2732

mandos_dbus_service.ClientNotFound(key_id or fpr,

2085

mandos_dbus_service.ClientNotFound(fpr,

2733

2086

address[0])

2734

2087

parent_pipe.send(False)

2735

2088

return False

2736

2737

GLib.io_add_watch(

2738

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

2739

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

2740

functools.partial(self.handle_ipc,

2741

parent_pipe=parent_pipe,

2742

proc=proc,

2743

client_object=client))

2089

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2744

2098

parent_pipe.send(True)

2745

2099

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

2746

2100

# same fileno

2749

2103

funcname = request[1]

2750

2104

args = request[2]

2751

2105

kwargs = request[3]

2752

2106

2753

2107

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

2754

2108

funcname)(*args,

2755

**kwargs)))

2756

2109

**kwargs)))

2110

2757

2111

if command == 'getattr':

2758

2112

attrname = request[1]

2759

if isinstance(client_object.__getattribute__(attrname),

2760

collections.abc.Callable):

2761

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2762

2115

else:

2763

parent_pipe.send((

2764

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

2765

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2766

2119

if command == 'setattr':

2767

2120

attrname = request[1]

2768

2121

value = request[2]

2769

2122

setattr(client_object, attrname, value)

2770

2123

2771

2124

return True

2772

2125

2773

2126

2774

2127

def rfc3339_duration_to_delta(duration):

2775

2128

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

2776

2777

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

2778

True

2779

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

2780

True

2781

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

2782

True

2783

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

2784

True

2785

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

2786

True

2787

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

2788

True

2789

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

2790

True

2129

2130

>>> rfc3339_duration_to_delta("P7D")

2131

datetime.timedelta(7)

2132

>>> rfc3339_duration_to_delta("PT60S")

2133

datetime.timedelta(0, 60)

2134

>>> rfc3339_duration_to_delta("PT60M")

2135

datetime.timedelta(0, 3600)

2136

>>> rfc3339_duration_to_delta("PT24H")

2137

datetime.timedelta(1)

2138

>>> rfc3339_duration_to_delta("P1W")

2139

datetime.timedelta(7)

2140

>>> rfc3339_duration_to_delta("PT5M30S")

2141

datetime.timedelta(0, 330)

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

datetime.timedelta(1, 200)

2791

2144

"""

2792

2145

2793

2146

# Parsing an RFC 3339 duration with regular expressions is not

2794

2147

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

2795

2148

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

2796

2149

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

2797

2150

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

2798

2151

# avoid excessive use of external libraries.

2799

2152

2800

2153

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

2801

Token = collections.namedtuple("Token", (

2802

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

2803

# a "group" containing digits

2804

"value", # datetime.timedelta or None

2805

"followers")) # Tokens valid after this token

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2806

2163

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

2807

2164

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

2808

2165

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

2809

2166

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

2810

2167

datetime.timedelta(seconds=1),

2811

frozenset((token_end, )))

2168

frozenset((token_end,)))

2812

2169

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

2813

2170

datetime.timedelta(minutes=1),

2814

2171

frozenset((token_second, token_end)))

2830

2187

frozenset((token_month, token_end)))

2831

2188

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

2832

2189

datetime.timedelta(weeks=1),

2833

frozenset((token_end, )))

2190

frozenset((token_end,)))

2834

2191

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

2835

2192

frozenset((token_year, token_month,

2836

2193

token_day, token_time,

2837

2194

token_week)))

2838

# Define starting values:

2839

# Value so far

2840

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2841

2197

found_token = None

2842

# Following valid tokens

2843

followers = frozenset((token_duration, ))

2844

# String left to parse

2845

s = duration

2198

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

2199

s = duration # String left to parse

2846

2200

# Loop until end token is found

2847

2201

while found_token is not token_end:

2848

2202

# Search for any currently valid tokens

2864

2218

break

2865

2219

else:

2866

2220

# No currently valid tokens were found

2867

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

2868

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2869

2222

# End token found

2870

2223

return value

2871

2224

2872

2225

2873

2226

def string_to_delta(interval):

2874

2227

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

2875

2876

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

2877

True

2878

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

2879

True

2880

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

2881

True

2882

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

2883

True

2884

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

2885

True

2886

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

2887

True

2228

2229

>>> string_to_delta('7d')

2230

datetime.timedelta(7)

2231

>>> string_to_delta('60s')

2232

datetime.timedelta(0, 60)

2233

>>> string_to_delta('60m')

2234

datetime.timedelta(0, 3600)

2235

>>> string_to_delta('24h')

2236

datetime.timedelta(1)

2237

>>> string_to_delta('1w')

2238

datetime.timedelta(7)

2239

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

2240

datetime.timedelta(0, 330)

2888

2241

"""

2889

2242

2890

2243

try:

2891

2244

return rfc3339_duration_to_delta(interval)

2892

2245

except ValueError:

2893

2246

pass

2894

2247

2895

2248

timevalue = datetime.timedelta(0)

2896

2249

for s in interval.split():

2897

2250

try:

2908

2261

elif suffix == "w":

2909

2262

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

2910

2263

else:

2911

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2912

2266

except IndexError as e:

2913

2267

raise ValueError(*(e.args))

2914

2268

timevalue += delta

2915

2269

return timevalue

2916

2270

2917

2271

2918

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

2272

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

2919

2273

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

2920

2274

2921

2275

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

2922

2276

if os.fork():

2923

2277

sys.exit()

2930

2284

# Close all standard open file descriptors

2931

2285

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

2932

2286

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

2933

raise OSError(errno.ENODEV,

2934

"{} not a character device"

2287

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

2935

2288

.format(os.devnull))

2936

2289

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

2937

2290

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

2941

2294

2942

2295

2943

2296

def main():

2944

2297

2945

2298

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

2946

2299

# Parsing of options, both command line and config file

2947

2300

2948

2301

parser = argparse.ArgumentParser()

2949

2302

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

2950

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

2303

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

2951

2304

help="show version number and exit")

2952

2305

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

2953

2306

help="Bind to interface IF")

2989

2342

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

2990

2343

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

2991

2344

default=None)

2992

2345

2993

2346

options = parser.parse_args()

2994

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

2995

2353

# Default values for config file for server-global settings

2996

if gnutls.has_rawpk:

2997

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

2998

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

2999

else:

3000

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

3001

":+SIGN-DSA-SHA256")

3002

server_defaults = {"interface": "",

3003

"address": "",

3004

"port": "",

3005

"debug": "False",

3006

"priority": priority,

3007

"servicename": "Mandos",

3008

"use_dbus": "True",

3009

"use_ipv6": "True",

3010

"debuglevel": "",

3011

"restore": "True",

3012

"socket": "",

3013

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

3014

"foreground": "False",

3015

"zeroconf": "True",

3016

}

3017

del priority

3018

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

3019

2371

# Parse config file for server-global settings

3020

server_config = configparser.ConfigParser(server_defaults)

2372

server_config = configparser.SafeConfigParser(server_defaults)

3021

2373

del server_defaults

3022

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

3023

# Convert the ConfigParser object to a dict

2374

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

2375

"mandos.conf"))

2376

# Convert the SafeConfigParser object to a dict

3024

2377

server_settings = server_config.defaults()

3025

2378

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

3026

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

3027

"foreground", "zeroconf"):

2379

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

3028

2380

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

3029

2381

option)

3030

2382

if server_settings["port"]:

3040

2392

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

3041

2393

["socket"])

3042

2394

del server_config

3043

2395

3044

2396

# Override the settings from the config file with command line

3045

2397

# options, if set.

3046

2398

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

3047

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

3048

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

3049

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

2399

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

2400

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

2401

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

3050

2402

value = getattr(options, option)

3051

2403

if value is not None:

3052

2404

server_settings[option] = value

3064

2416

if server_settings["debug"]:

3065

2417

server_settings["foreground"] = True

3066

2418

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

3067

2419

3068

2420

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

3069

3070

if (not server_settings["zeroconf"]

3071

and not (server_settings["port"]

3072

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

3073

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

3074

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

3075

2428

# For convenience

3076

2429

debug = server_settings["debug"]

3077

2430

debuglevel = server_settings["debuglevel"]

3081

2434

stored_state_file)

3082

2435

foreground = server_settings["foreground"]

3083

2436

zeroconf = server_settings["zeroconf"]

3084

2437

3085

2438

if debug:

3086

2439

initlogger(debug, logging.DEBUG)

3087

2440

else:

3090

2443

else:

3091

2444

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

3092

2445

initlogger(debug, level)

3093

2446

3094

2447

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

3095

syslogger.setFormatter(

3096

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

3097

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

3098

server_settings["servicename"])))

3099

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3100

2454

# Parse config file with clients

3101

client_config = configparser.ConfigParser(Client.client_defaults)

2455

client_config = configparser.SafeConfigParser(Client

2456

.client_defaults)

3102

2457

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

3103

2458

"clients.conf"))

3104

2459

3105

2460

global mandos_dbus_service

3106

2461

mandos_dbus_service = None

3107

2462

3108

2463

socketfd = None

3109

2464

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

3110

2465

socketfd = server_settings["socket"]

3111

tcp_server = MandosServer(

3112

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

3113

ClientHandler,

3114

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

3115

use_ipv6=use_ipv6,

3116

gnutls_priority=server_settings["priority"],

3117

use_dbus=use_dbus,

3118

socketfd=socketfd)

2466

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

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

3119

2476

if not foreground:

3120

2477

pidfilename = "/run/mandos.pid"

3121

2478

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

3122

2479

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

3123

2480

pidfile = None

3124

2481

try:

3125

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

2482

pidfile = open(pidfilename, "w")

3126

2483

except IOError as e:

3127

2484

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

3128

2485

exc_info=e)

3129

3130

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

3131

("mandos", "mandos"),

3132

("nobody", "nogroup")):

2486

2487

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

3133

2488

try:

3134

2489

uid = pwd.getpwnam(name).pw_uid

3135

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

3136

2491

break

3137

2492

except KeyError:

3138

2493

continue

3142

2497

try:

3143

2498

os.setgid(gid)

3144

2499

os.setuid(uid)

3145

if debug:

3146

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

3147

gid))

3148

2500

except OSError as error:

3149

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

3150

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

3151

2501

if error.errno != errno.EPERM:

3152

2502

raise

3153

2503

3154

2504

if debug:

3155

2505

# Enable all possible GnuTLS debugging

3156

2506

3157

2507

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

3158

2508

# - GnuTLS manual

3159

gnutls.global_set_log_level(11)

3160

3161

@gnutls.log_func

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3162

2512

def debug_gnutls(level, string):

3163

2513

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

3164

3165

gnutls.global_set_log_function(debug_gnutls)

3166

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3167

2518

# Redirect stdin so all checkers get /dev/null

3168

2519

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

3169

2520

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

3170

2521

if null > 2:

3171

2522

os.close(null)

3172

2523

3173

2524

# Need to fork before connecting to D-Bus

3174

2525

if not foreground:

3175

2526

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

3176

2527

daemon()

3177

3178

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

3179

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

3180

# need to inform GLib that threads will be used.

3181

GLib.threads_init()

3182

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

3183

2533

global main_loop

3184

2534

# From the Avahi example code

3185

2535

DBusGMainLoop(set_as_default=True)

3186

main_loop = GLib.MainLoop()

2536

main_loop = gobject.MainLoop()

3187

2537

bus = dbus.SystemBus()

3188

2538

# End of Avahi example code

3189

2539

if use_dbus:

3190

2540

try:

3191

2541

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

3192

bus,

3193

do_not_queue=True)

3194

old_bus_name = dbus.service.BusName(

3195

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

3196

do_not_queue=True)

3197

except dbus.exceptions.DBusException as e:

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

3198

2547

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

3199

2548

use_dbus = False

3200

2549

server_settings["use_dbus"] = False

3201

2550

tcp_server.use_dbus = False

3202

2551

if zeroconf:

3203

2552

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3204

service = AvahiServiceToSyslog(

3205

name=server_settings["servicename"],

3206

servicetype="_mandos._tcp",

3207

protocol=protocol,

3208

bus=bus)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3209

2557

if server_settings["interface"]:

3210

service.interface = if_nametoindex(

3211

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

3212

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3213

2562

global multiprocessing_manager

3214

2563

multiprocessing_manager = multiprocessing.Manager()

3215

2564

3216

2565

client_class = Client

3217

2566

if use_dbus:

3218

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

3219

2567

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

2568

3220

2569

client_settings = Client.config_parser(client_config)

3221

2570

old_client_settings = {}

3222

2571

clients_data = {}

3223

2572

3224

2573

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

3225

2574

global wnull

3226

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

2575

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

3227

2576

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

3228

2577

# mode

3229

2578

if debug or not foreground:

3230

2579

wnull.close()

3231

2580

3232

2581

# Get client data and settings from last running state.

3233

2582

if server_settings["restore"]:

3234

2583

try:

3235

2584

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

3236

if sys.version_info.major == 2:

3237

clients_data, old_client_settings = pickle.load(

3238

stored_state)

3239

else:

3240

bytes_clients_data, bytes_old_client_settings = (

3241

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

3242

# Fix bytes to strings

3243

# clients_data

3244

# .keys()

3245

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

3246

if isinstance(key, bytes)

3247

else key): value

3248

for key, value in

3249

bytes_clients_data.items()}

3250

del bytes_clients_data

3251

for key in clients_data:

3252

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

3253

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

3254

for k, v in

3255

clients_data[key].items()}

3256

clients_data[key] = value

3257

# .client_structure

3258

value["client_structure"] = [

3259

(s.decode("utf-8")

3260

if isinstance(s, bytes)

3261

else s) for s in

3262

value["client_structure"]]

3263

# .name, .host, and .checker_command

3264

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

3265

if isinstance(value[k], bytes):

3266

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

3267

if "key_id" not in value:

3268

value["key_id"] = ""

3269

elif "fingerprint" not in value:

3270

value["fingerprint"] = ""

3271

# old_client_settings

3272

# .keys()

3273

old_client_settings = {

3274

(key.decode("utf-8")

3275

if isinstance(key, bytes)

3276

else key): value

3277

for key, value in

3278

bytes_old_client_settings.items()}

3279

del bytes_old_client_settings

3280

# .host and .checker_command

3281

for value in old_client_settings.values():

3282

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

3283

if isinstance(value[attribute], bytes):

3284

value[attribute] = (value[attribute]

3285

.decode("utf-8"))

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3286

2587

os.remove(stored_state_path)

3287

2588

except IOError as e:

3288

2589

if e.errno == errno.ENOENT:

3289

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

3290

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

2590

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

2591

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

3291

2592

else:

3292

2593

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

3293

2594

exc_info=e)

3294

2595

raise

3295

2596

except EOFError as e:

3296

2597

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

3297

"EOFError:",

3298

exc_info=e)

3299

2598

"EOFError:", exc_info=e)

2599

3300

2600

with PGPEngine() as pgp:

3301

2601

for client_name, client in clients_data.items():

3302

2602

# Skip removed clients

3303

2603

if client_name not in client_settings:

3304

2604

continue

3305

2605

3306

2606

# Decide which value to use after restoring saved state.

3307

2607

# We have three different values: Old config file,

3308

2608

# new config file, and saved state.

3313

2613

# For each value in new config, check if it

3314

2614

# differs from the old config value (Except for

3315

2615

# the "secret" attribute)

3316

if (name != "secret"

3317

and (value !=

3318

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3319

2619

client[name] = value

3320

2620

except KeyError:

3321

2621

pass

3322

2622

3323

2623

# Clients who has passed its expire date can still be

3324

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3325

2625

# whose checker succeeded before we stored its state is

3326

2626

# assumed to have successfully run all checkers during

3327

2627

# downtime.

3330

2630

if not client["last_checked_ok"]:

3331

2631

logger.warning(

3332

2632

"disabling client {} - Client never "

3333

"performed a successful checker".format(

3334

client_name))

2633

"performed a successful checker"

2634

.format(client_name))

3335

2635

client["enabled"] = False

3336

2636

elif client["last_checker_status"] != 0:

3337

2637

logger.warning(

3338

2638

"disabling client {} - Client last"

3339

" checker failed with error code"

3340

" {}".format(

3341

client_name,

3342

client["last_checker_status"]))

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3343

2642

client["enabled"] = False

3344

2643

else:

3345

client["expires"] = (

3346

datetime.datetime.utcnow()

3347

+ client["timeout"])

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3348

2647

logger.debug("Last checker succeeded,"

3349

" keeping {} enabled".format(

3350

client_name))

2648

" keeping {} enabled"

2649

.format(client_name))

3351

2650

try:

3352

client["secret"] = pgp.decrypt(

3353

client["encrypted_secret"],

3354

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3355

2655

except PGPError:

3356

2656

# If decryption fails, we use secret from new settings

3357

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

3358

client_name))

3359

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

3360

["secret"])

3361

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3362

2662

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

3363

2663

for client_name in (set(old_client_settings)

3364

2664

- set(client_settings)):

3366

2666

for client_name in (set(client_settings)

3367

2667

- set(old_client_settings)):

3368

2668

clients_data[client_name] = client_settings[client_name]

3369

2669

3370

2670

# Create all client objects

3371

2671

for client_name, client in clients_data.items():

3372

2672

tcp_server.clients[client_name] = client_class(

3373

name=client_name,

3374

settings=client,

3375

server_settings=server_settings)

3376

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3377

2676

if not tcp_server.clients:

3378

2677

logger.warning("No clients defined")

3379

2678

3380

2679

if not foreground:

3381

2680

if pidfile is not None:

3382

pid = os.getpid()

3383

2681

try:

3384

2682

with pidfile:

3385

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3386

2685

except IOError:

3387

2686

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

3388

2687

pidfilename, pid)

3389

2688

del pidfile

3390

2689

del pidfilename

3391

3392

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

3393

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3394

lambda: main_loop.quit() and False)

3395

2690

2691

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

2692

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

2693

3396

2694

if use_dbus:

3397

3398

@alternate_dbus_interfaces(

3399

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

3400

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3401

2698

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

3402

3403

2699

def __init__(self):

3404

2700

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

3405

3406

2701

_interface = "se.recompile.Mandos"

3407

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3408

2709

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

3409

2710

def ClientAdded(self, objpath):

3410

2711

"D-Bus signal"

3411

2712

pass

3412

2713

3413

2714

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

3414

def ClientNotFound(self, key_id, address):

2715

def ClientNotFound(self, fingerprint, address):

3415

2716

"D-Bus signal"

3416

2717

pass

3417

3418

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

3419

"true"})

2718

3420

2719

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

3421

2720

def ClientRemoved(self, objpath, name):

3422

2721

"D-Bus signal"

3423

2722

pass

3424

3425

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

3426

"true"})

2723

3427

2724

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

3428

2725

def GetAllClients(self):

3429

2726

"D-Bus method"

3430

return dbus.Array(c.dbus_object_path for c in

3431

tcp_server.clients.values())

3432

3433

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

3434

"true"})

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3435

2731

@dbus.service.method(_interface,

3436

2732

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

3437

2733

def GetAllClientsWithProperties(self):

3438

2734

"D-Bus method"

3439

2735

return dbus.Dictionary(

3440

{c.dbus_object_path: c.GetAll(

3441

"se.recompile.Mandos.Client")

3442

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

2736

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

2737

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

3443

2738

signature="oa{sv}")

3444

2739

3445

2740

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

3446

2741

def RemoveClient(self, object_path):

3447

2742

"D-Bus method"

3448

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3449

2744

if c.dbus_object_path == object_path:

3450

2745

del tcp_server.clients[c.name]

3451

2746

c.remove_from_connection()

3452

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3453

2748

c.disable(quiet=True)

3454

# Emit D-Bus signal for removal

3455

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3456

2751

return

3457

2752

raise KeyError(object_path)

3458

2753

3459

2754

del _interface

3460

3461

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3462

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

3463

def GetManagedObjects(self):

3464

"""D-Bus method"""

3465

return dbus.Dictionary(

3466

{client.dbus_object_path:

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()})

3471

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

3472

3473

def client_added_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesAdded(

3478

client.dbus_object_path,

3479

dbus.Dictionary(

3480

{interface: client.GetAll(interface)

3481

for interface in

3482

client._get_all_interface_names()}))

3483

# Old signal

3484

self.ClientAdded(client.dbus_object_path)

3485

3486

def client_removed_signal(self, client):

3487

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

3488

if use_dbus:

3489

# New standard signal

3490

self.InterfacesRemoved(

3491

client.dbus_object_path,

3492

client._get_all_interface_names())

3493

# Old signal

3494

self.ClientRemoved(client.dbus_object_path,

3495

client.name)

3496

2755

3497

2756

mandos_dbus_service = MandosDBusService()

3498

3499

# Save modules to variables to exempt the modules from being

3500

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

3501

mp = multiprocessing

3502

wn = wnull

3503

2757

3504

2758

def cleanup():

3505

2759

"Cleanup function; run on exit"

3506

2760

if zeroconf:

3507

2761

service.cleanup()

3508

3509

mp.active_children()

3510

wn.close()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3511

2765

if not (tcp_server.clients or client_settings):

3512

2766

return

3513

2767

3514

2768

# Store client before exiting. Secrets are encrypted with key

3515

2769

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

3516

2770

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

3517

2771

clients = {}

3518

2772

with PGPEngine() as pgp:

3519

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3520

2774

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

3521

2775

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

3522

2776

key)

3523

2777

client_dict = {}

3524

2778

3525

2779

# A list of attributes that can not be pickled

3526

2780

# + secret.

3527

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

3528

"checker", "server_settings"}

3529

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

3530

.Object):

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3531

2785

exclude.add(name)

3532

2786

3533

2787

client_dict["encrypted_secret"] = (client

3534

2788

.encrypted_secret)

3535

2789

for attr in client.client_structure:

3536

2790

if attr not in exclude:

3537

2791

client_dict[attr] = getattr(client, attr)

3538

2792

3539

2793

clients[client.name] = client_dict

3540

2794

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

3541

2795

3542

2796

try:

3543

with tempfile.NamedTemporaryFile(

3544

mode='wb',

3545

suffix=".pickle",

3546

prefix='clients-',

3547

dir=os.path.dirname(stored_state_path),

3548

delete=False) as stored_state:

3549

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

3550

protocol=2)

3551

tempname = stored_state.name

2797

with (tempfile.NamedTemporaryFile

2798

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

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3552

2803

os.rename(tempname, stored_state_path)

3553

2804

except (IOError, OSError) as e:

3554

2805

if not debug:

3563

2814

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

3564

2815

exc_info=e)

3565

2816

raise

3566

2817

3567

2818

# Delete all clients, and settings from config

3568

2819

while tcp_server.clients:

3569

2820

name, client = tcp_server.clients.popitem()

3570

2821

if use_dbus:

3571

2822

client.remove_from_connection()

3572

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3573

2824

client.disable(quiet=True)

3574

# Emit D-Bus signal for removal

3575

2825

if use_dbus:

3576

mandos_dbus_service.client_removed_signal(client)

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3577

2830

client_settings.clear()

3578

2831

3579

2832

atexit.register(cleanup)

3580

3581

for client in tcp_server.clients.values():

2833

2834

for client in tcp_server.clients.itervalues():

3582

2835

if use_dbus:

3583

# Emit D-Bus signal for adding

3584

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3585

2838

# Need to initiate checking of clients

3586

2839

if client.enabled:

3587

2840

client.init_checker()

3588

2841

3589

2842

tcp_server.enable()

3590

2843

tcp_server.server_activate()

3591

2844

3592

2845

# Find out what port we got

3593

2846

if zeroconf:

3594

2847

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

3599

2852

else: # IPv4

3600

2853

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

3601

2854

*tcp_server.socket.getsockname())

3602

3603

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

3604

2855

2856

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

2857

3605

2858

try:

3606

2859

if zeroconf:

3607

2860

# From the Avahi example code

3612

2865

cleanup()

3613

2866

sys.exit(1)

3614

2867

# End of Avahi example code

3615

3616

GLib.io_add_watch(

3617

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

3618

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3619

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

3620

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

3621

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

3622

2874

logger.debug("Starting main loop")

3623

2875

main_loop.run()

3624

2876

except AvahiError as error:

3633

2885

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

3634

2886

cleanup()

3635

2887

3636

3637

def should_only_run_tests():

3638

parser = argparse.ArgumentParser(add_help=False)

3639

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

3640

args, unknown_args = parser.parse_known_args()

3641

run_tests = args.check

3642

if run_tests:

3643

# Remove --check argument from sys.argv

3644

sys.argv[1:] = unknown_args

3645

return run_tests

3646

3647

# Add all tests from doctest strings

3648

def load_tests(loader, tests, none):

3649

import doctest

3650

tests.addTests(doctest.DocTestSuite())

3651

return tests

3652

3653

2888

if __name__ == '__main__':

3654

try:

3655

if should_only_run_tests():

3656

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

3657

unittest.main()

3658

else:

3659

main()

3660

finally:

3661

logging.shutdown()

2889

main()