/mandos/trunk : revision 738.1.1

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

72

84

73

import dbus

85

74

import dbus.service

86

import gi

87

from gi.repository import GLib

75

import gobject

76

import avahi

88

77

from dbus.mainloop.glib import DBusGMainLoop

89

78

import ctypes

90

79

import ctypes.util

91

80

import xml.dom.minidom

92

81

import inspect

93

82

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

147

95

stored_state_file = "clients.pickle"

148

96

149

97

logger = logging.getLogger()

150

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

151

98

syslogger = None

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

165

112

return interface_index

166

113

167

114

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

115

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

185

116

"""init logger and add loglevel"""

186

117

187

118

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

191

123

syslogger.setFormatter(logging.Formatter

192

124

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

193

125

' %(message)s'))

194

126

logger.addHandler(syslogger)

195

127

196

128

if debug:

197

129

console = logging.StreamHandler()

198

130

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

208

140

pass

209

141

210

142

211

class PGPEngine:

143

class PGPEngine(object):

212

144

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

213

214

145

def __init__(self):

215

146

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

147

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

148

'--home', self.tempdir,

229

149

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

150

'--quiet',

151

'--no-use-agent']

152

235

153

def __enter__(self):

236

154

return self

237

155

238

156

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

239

157

self._cleanup()

240

158

return False

241

159

242

160

def __del__(self):

243

161

self._cleanup()

244

162

245

163

def _cleanup(self):

246

164

if self.tempdir is not None:

247

165

# Delete contents of tempdir

248

166

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

249

topdown=False):

167

topdown = False):

250

168

for filename in files:

251

169

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

252

170

for dirname in dirs:

254

172

# Remove tempdir

255

173

os.rmdir(self.tempdir)

256

174

self.tempdir = None

257

175

258

176

def password_encode(self, password):

259

177

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

260

178

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

265

183

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

266

184

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

267

185

return encoded

268

186

269

187

def encrypt(self, data, password):

270

188

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

273

191

passfile.write(passphrase)

274

192

passfile.flush()

275

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

193

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

276

194

'--passphrase-file',

277

195

passfile.name]

278

196

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

283

201

if proc.returncode != 0:

284

202

raise PGPError(err)

285

203

return ciphertext

286

204

287

205

def decrypt(self, data, password):

288

206

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

291

209

passfile.write(passphrase)

292

210

passfile.flush()

293

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

211

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

294

212

'--passphrase-file',

295

213

passfile.name]

296

214

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

301

220

if proc.returncode != 0:

302

221

raise PGPError(err)

303

222

return decrypted_plaintext

304

223

305

224

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

225

class AvahiError(Exception):

333

226

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

334

227

self.value = value

335

228

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

336

229

**kwargs)

337

230

338

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

277

394

278

def rename(self, remove=True):

395

279

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

396

280

if self.rename_count >= self.max_renames:

398

282

" after %i retries, exiting.",

399

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

403

287

self.rename_count += 1

404

288

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

405

289

self.name)

416

300

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

417

301

self.cleanup()

418

302

os._exit(1)

419

303

420

304

def remove(self):

421

305

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

422

306

if self.entry_group_state_changed_match is not None:

424

308

self.entry_group_state_changed_match = None

425

309

if self.group is not None:

426

310

self.group.Reset()

427

311

428

312

def add(self):

429

313

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

430

314

self.remove()

447

331

dbus.UInt16(self.port),

448

332

avahi.string_array_to_txt_array(self.TXT))

449

333

self.group.Commit()

450

334

451

335

def entry_group_state_changed(self, state, error):

452

336

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

453

337

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

454

338

455

339

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

340

logger.debug("Zeroconf service established.")

457

341

elif state == avahi.ENTRY_GROUP_COLLISION:

460

344

elif state == avahi.ENTRY_GROUP_FAILURE:

461

345

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

462

346

str(error))

463

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

464

347

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

348

.format(error))

349

465

350

def cleanup(self):

466

351

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

467

352

if self.group is not None:

472

357

pass

473

358

self.group = None

474

359

self.remove()

475

360

476

361

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

477

362

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

478

363

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

485

371

if state in bad_states:

486

372

if bad_states[state] is not None:

487

373

if error is None:

490

376

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

491

377

self.cleanup()

492

378

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

379

self.add()

505

380

else:

506

381

if error is None:

507

382

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

508

383

else:

509

384

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

510

385

511

386

def activate(self):

512

387

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

513

388

if self.server is None:

517

392

follow_name_owner_changes=True),

518

393

avahi.DBUS_INTERFACE_SERVER)

519

394

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

395

self.server_state_changed)

521

396

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

522

397

523

398

524

399

class AvahiServiceToSyslog(AvahiService):

525

400

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

526

401

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

527

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

528

syslogger.setFormatter(logging.Formatter(

529

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

530

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

531

407

return ret

532

408

533

409

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

('size', ctypes.c_uint)]

578

579

class openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code)

597

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

598

message, *args)

599

600

class CertificateSecurityError(Error):

601

pass

602

603

# Classes

604

class Credentials:

605

def __init__(self):

606

self._c_object = gnutls.certificate_credentials_t()

607

gnutls.certificate_allocate_credentials(

608

ctypes.byref(self._c_object))

609

self.type = gnutls.CRD_CERTIFICATE

610

611

def __del__(self):

612

gnutls.certificate_free_credentials(self._c_object)

613

614

class ClientSession:

615

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

616

self._c_object = gnutls.session_t()

617

gnutls_flags = gnutls.CLIENT

618

if gnutls.check_version(b"3.5.6"):

619

gnutls_flags |= gnutls.NO_TICKETS

620

if gnutls.has_rawpk:

621

gnutls_flags |= gnutls.ENABLE_RAWPK

622

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

623

del gnutls_flags

624

gnutls.set_default_priority(self._c_object)

625

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

626

gnutls.handshake_set_private_extensions(self._c_object,

627

True)

628

self.socket = socket

629

if credentials is None:

630

credentials = gnutls.Credentials()

631

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

632

ctypes.cast(credentials._c_object,

633

ctypes.c_void_p))

634

self.credentials = credentials

635

636

def __del__(self):

637

gnutls.deinit(self._c_object)

638

639

def handshake(self):

640

return gnutls.handshake(self._c_object)

641

642

def send(self, data):

643

data = bytes(data)

644

data_len = len(data)

645

while data_len > 0:

646

data_len -= gnutls.record_send(self._c_object,

647

data[-data_len:],

648

data_len)

649

650

def bye(self):

651

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

652

653

# Error handling functions

654

def _error_code(result):

655

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

656

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

657

if result >= 0:

658

return result

659

if result == gnutls.E_NO_CERTIFICATE_FOUND:

660

raise gnutls.CertificateSecurityError(code=result)

661

raise gnutls.Error(code=result)

662

663

def _retry_on_error(result, func, arguments):

664

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

665

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

666

while result < 0:

667

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

668

return _error_code(result)

669

result = func(*arguments)

670

return result

671

672

# Unless otherwise indicated, the function declarations below are

673

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

674

675

# Functions

676

priority_set_direct = _library.gnutls_priority_set_direct

677

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

678

ctypes.POINTER(ctypes.c_char_p)]

679

priority_set_direct.restype = _error_code

680

681

init = _library.gnutls_init

682

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

683

init.restype = _error_code

684

685

set_default_priority = _library.gnutls_set_default_priority

686

set_default_priority.argtypes = [session_t]

687

set_default_priority.restype = _error_code

688

689

record_send = _library.gnutls_record_send

690

record_send.argtypes = [session_t, ctypes.c_void_p,

691

ctypes.c_size_t]

692

record_send.restype = ctypes.c_ssize_t

693

record_send.errcheck = _retry_on_error

694

695

certificate_allocate_credentials = (

696

_library.gnutls_certificate_allocate_credentials)

697

certificate_allocate_credentials.argtypes = [

698

ctypes.POINTER(certificate_credentials_t)]

699

certificate_allocate_credentials.restype = _error_code

700

701

certificate_free_credentials = (

702

_library.gnutls_certificate_free_credentials)

703

certificate_free_credentials.argtypes = [

704

certificate_credentials_t]

705

certificate_free_credentials.restype = None

706

707

handshake_set_private_extensions = (

708

_library.gnutls_handshake_set_private_extensions)

709

handshake_set_private_extensions.argtypes = [session_t,

710

ctypes.c_int]

711

handshake_set_private_extensions.restype = None

712

713

credentials_set = _library.gnutls_credentials_set

714

credentials_set.argtypes = [session_t, credentials_type_t,

715

ctypes.c_void_p]

716

credentials_set.restype = _error_code

717

718

strerror = _library.gnutls_strerror

719

strerror.argtypes = [ctypes.c_int]

720

strerror.restype = ctypes.c_char_p

721

722

certificate_type_get = _library.gnutls_certificate_type_get

723

certificate_type_get.argtypes = [session_t]

724

certificate_type_get.restype = _error_code

725

726

certificate_get_peers = _library.gnutls_certificate_get_peers

727

certificate_get_peers.argtypes = [session_t,

728

ctypes.POINTER(ctypes.c_uint)]

729

certificate_get_peers.restype = ctypes.POINTER(datum_t)

730

731

global_set_log_level = _library.gnutls_global_set_log_level

732

global_set_log_level.argtypes = [ctypes.c_int]

733

global_set_log_level.restype = None

734

735

global_set_log_function = _library.gnutls_global_set_log_function

736

global_set_log_function.argtypes = [log_func]

737

global_set_log_function.restype = None

738

739

deinit = _library.gnutls_deinit

740

deinit.argtypes = [session_t]

741

deinit.restype = None

742

743

handshake = _library.gnutls_handshake

744

handshake.argtypes = [session_t]

745

handshake.restype = _error_code

746

handshake.errcheck = _retry_on_error

747

748

transport_set_ptr = _library.gnutls_transport_set_ptr

749

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

750

transport_set_ptr.restype = None

751

752

bye = _library.gnutls_bye

753

bye.argtypes = [session_t, close_request_t]

754

bye.restype = _error_code

755

bye.errcheck = _retry_on_error

756

757

check_version = _library.gnutls_check_version

758

check_version.argtypes = [ctypes.c_char_p]

759

check_version.restype = ctypes.c_char_p

760

761

_need_version = b"3.3.0"

762

if check_version(_need_version) is None:

763

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

764

.format(_need_version))

765

766

_tls_rawpk_version = b"3.6.6"

767

has_rawpk = bool(check_version(_tls_rawpk_version))

768

769

if has_rawpk:

770

# Types

771

class pubkey_st(ctypes.Structure):

772

_fields = []

773

pubkey_t = ctypes.POINTER(pubkey_st)

774

775

x509_crt_fmt_t = ctypes.c_int

776

777

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

778

pubkey_init = _library.gnutls_pubkey_init

779

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

780

pubkey_init.restype = _error_code

781

782

pubkey_import = _library.gnutls_pubkey_import

783

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

784

x509_crt_fmt_t]

785

pubkey_import.restype = _error_code

786

787

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

788

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

789

ctypes.POINTER(ctypes.c_ubyte),

790

ctypes.POINTER(ctypes.c_size_t)]

791

pubkey_get_key_id.restype = _error_code

792

793

pubkey_deinit = _library.gnutls_pubkey_deinit

794

pubkey_deinit.argtypes = [pubkey_t]

795

pubkey_deinit.restype = None

796

else:

797

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

798

799

openpgp_crt_init = _library.gnutls_openpgp_crt_init

800

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

801

openpgp_crt_init.restype = _error_code

802

803

openpgp_crt_import = _library.gnutls_openpgp_crt_import

804

openpgp_crt_import.argtypes = [openpgp_crt_t,

805

ctypes.POINTER(datum_t),

806

openpgp_crt_fmt_t]

807

openpgp_crt_import.restype = _error_code

808

809

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

810

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

811

ctypes.POINTER(ctypes.c_uint)]

812

openpgp_crt_verify_self.restype = _error_code

813

814

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

815

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

816

openpgp_crt_deinit.restype = None

817

818

openpgp_crt_get_fingerprint = (

819

_library.gnutls_openpgp_crt_get_fingerprint)

820

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

821

ctypes.c_void_p,

822

ctypes.POINTER(

823

ctypes.c_size_t)]

824

openpgp_crt_get_fingerprint.restype = _error_code

825

826

if check_version(b"3.6.4"):

827

certificate_type_get2 = _library.gnutls_certificate_type_get2

828

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

829

certificate_type_get2.restype = _error_code

830

831

# Remove non-public functions

832

del _error_code, _retry_on_error

833

834

835

def call_pipe(connection, # : multiprocessing.Connection

836

func, *args, **kwargs):

837

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

838

839

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

840

return value on the provided multiprocessing.Connection.

841

"""

842

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

843

connection.close()

844

845

846

class Client:

410

class Client(object):

847

411

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

848

412

849

413

Attributes:

850

414

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

851

415

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

852

416

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

853

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

854

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

855

running.

856

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

857

421

checker_command: string; External command which is run to check

858

422

if client lives. %() expansions are done at

859

423

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

860

424

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

861

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

862

426

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

863

427

client_structure: Object describing what attributes a client has

864

428

and is used for storing the client at exit

865

429

current_checker_command: string; current running checker_command

866

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

867

431

enabled: bool()

868

432

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

869

uniquely identify an OpenPGP client

870

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

871

a client using raw public keys

433

uniquely identify the client

872

434

host: string; available for use by the checker command

873

435

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

874

436

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

876

438

last_checker_status: integer between 0 and 255 reflecting exit

877

439

status of last checker. -1 reflects crashed

878

440

checker, -2 means no checker completed yet.

879

last_checker_signal: The signal which killed the last checker, if

880

last_checker_status is -1

881

441

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

882

442

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

883

443

D-Bus identifiers

890

450

disabled, or None

891

451

server_settings: The server_settings dict from main()

892

452

"""

893

453

894

454

runtime_expansions = ("approval_delay", "approval_duration",

895

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

455

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

896

456

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

897

457

"last_approval_request", "last_checked_ok",

898

458

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

899

client_defaults = {

900

"timeout": "PT5M",

901

"extended_timeout": "PT15M",

902

"interval": "PT2M",

903

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

904

"host": "",

905

"approval_delay": "PT0S",

906

"approval_duration": "PT1S",

907

"approved_by_default": "True",

908

"enabled": "True",

909

}

910

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

911

470

@staticmethod

912

471

def config_parser(config):

913

472

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

920

479

for client_name in config.sections():

921

480

section = dict(config.items(client_name))

922

481

client = settings[client_name] = {}

923

482

924

483

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

925

484

# Reformat values from string types to Python types

926

485

client["approved_by_default"] = config.getboolean(

927

486

client_name, "approved_by_default")

928

487

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

929

488

"enabled")

930

931

# Uppercase and remove spaces from key_id and fingerprint

932

# for later comparison purposes with return value from the

933

# key_id() and fingerprint() functions

934

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

935

.replace(" ", ""))

489

936

490

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

937

491

.replace(" ", ""))

938

492

if "secret" in section:

939

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

940

.encode("utf-8"),

941

"base64")

493

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

942

494

elif "secfile" in section:

943

495

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

944

496

(section["secfile"])),

959

511

client["last_approval_request"] = None

960

512

client["last_checked_ok"] = None

961

513

client["last_checker_status"] = -2

962

514

963

515

return settings

964

965

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

516

517

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

966

518

self.name = name

967

519

if server_settings is None:

968

520

server_settings = {}

970

522

# adding all client settings

971

523

for setting, value in settings.items():

972

524

setattr(self, setting, value)

973

525

974

526

if self.enabled:

975

527

if not hasattr(self, "last_enabled"):

976

528

self.last_enabled = datetime.datetime.utcnow()

980

532

else:

981

533

self.last_enabled = None

982

534

self.expires = None

983

535

984

536

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

985

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

986

540

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

987

541

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

988

542

datetime.datetime.utcnow())

989

543

990

544

# attributes specific for this server instance

991

545

self.checker = None

992

546

self.checker_initiator_tag = None

995

549

self.current_checker_command = None

996

550

self.approved = None

997

551

self.approvals_pending = 0

998

self.changedstate = multiprocessing_manager.Condition(

999

multiprocessing_manager.Lock())

1000

self.client_structure = [attr

1001

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

1002

557

if not attr.startswith("_")]

1003

558

self.client_structure.append("client_structure")

1004

1005

for name, t in inspect.getmembers(

1006

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

1007

564

if not name.startswith("_"):

1008

565

self.client_structure.append(name)

1009

566

1010

567

# Send notice to process children that client state has changed

1011

568

def send_changedstate(self):

1012

569

with self.changedstate:

1013

570

self.changedstate.notify_all()

1014

571

1015

572

def enable(self):

1016

573

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

1017

574

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

1022

579

self.last_enabled = datetime.datetime.utcnow()

1023

580

self.init_checker()

1024

581

self.send_changedstate()

1025

582

1026

583

def disable(self, quiet=True):

1027

584

"""Disable this client."""

1028

585

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

1030

587

if not quiet:

1031

588

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

1032

589

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

1033

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

1034

591

self.disable_initiator_tag = None

1035

592

self.expires = None

1036

593

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

1037

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

1038

595

self.checker_initiator_tag = None

1039

596

self.stop_checker()

1040

597

self.enabled = False

1041

598

if not quiet:

1042

599

self.send_changedstate()

1043

# 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

1044

601

return False

1045

602

1046

603

def __del__(self):

1047

604

self.disable()

1048

605

1049

606

def init_checker(self):

1050

607

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

1051

608

# and every interval from then on.

1052

609

if self.checker_initiator_tag is not None:

1053

GLib.source_remove(self.checker_initiator_tag)

1054

self.checker_initiator_tag = GLib.timeout_add(

1055

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

1056

+ 1)),

1057

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

1058

615

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

1059

616

if self.disable_initiator_tag is not None:

1060

GLib.source_remove(self.disable_initiator_tag)

1061

self.disable_initiator_tag = GLib.timeout_add(

1062

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

1063

622

# Also start a new checker *right now*.

1064

623

self.start_checker()

1065

1066

def checker_callback(self, source, condition, connection,

1067

command):

624

625

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

1068

626

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

1069

# Read return code from connection (see call_pipe)

1070

returncode = connection.recv()

1071

connection.close()

1072

if self.checker is not None:

1073

self.checker.join()

1074

627

self.checker_callback_tag = None

1075

628

self.checker = None

1076

1077

if returncode >= 0:

1078

self.last_checker_status = returncode

1079

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1080

631

if self.last_checker_status == 0:

1081

632

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

1082

633

vars(self))

1083

634

self.checked_ok()

1084

635

else:

1085

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

636

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

637

vars(self))

1086

638

else:

1087

639

self.last_checker_status = -1

1088

self.last_checker_signal = -returncode

1089

640

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

1090

641

vars(self))

1091

return False

1092

642

1093

643

def checked_ok(self):

1094

644

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

1095

645

self.last_checked_ok = datetime.datetime.utcnow()

1096

646

self.last_checker_status = 0

1097

self.last_checker_signal = None

1098

647

self.bump_timeout()

1099

648

1100

649

def bump_timeout(self, timeout=None):

1101

650

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

1102

651

if timeout is None:

1103

652

timeout = self.timeout

1104

653

if self.disable_initiator_tag is not None:

1105

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1106

655

self.disable_initiator_tag = None

1107

656

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

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1110

660

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

1111

661

1112

662

def need_approval(self):

1113

663

self.last_approval_request = datetime.datetime.utcnow()

1114

664

1115

665

def start_checker(self):

1116

666

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

1117

667

1118

668

If a checker already exists, leave it running and do

1119

669

nothing."""

1120

670

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

1125

675

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

1126

676

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

1127

677

# should be.

1128

1129

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

1130

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

1131

self.checker.join()

1132

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)

1133

693

# Start a new checker if needed

1134

694

if self.checker is None:

1135

695

# Escape attributes for the shell

1136

escaped_attrs = {

1137

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

1138

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1139

699

try:

1140

700

command = self.checker_command % escaped_attrs

1141

701

except TypeError as error:

1142

702

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

1143

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

1144

727

exc_info=error)

1145

return True # Try again later

1146

self.current_checker_command = command

1147

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

1148

self.name)

1149

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

1150

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

1151

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

1152

# always replaced by /dev/null.)

1153

# The exception is when not debugging but nevertheless

1154

# running in the foreground; use the previously

1155

# created wnull.

1156

popen_args = {"close_fds": True,

1157

"shell": True,

1158

"cwd": "/"}

1159

if (not self.server_settings["debug"]

1160

and self.server_settings["foreground"]):

1161

popen_args.update({"stdout": wnull,

1162

"stderr": wnull})

1163

pipe = multiprocessing.Pipe(duplex=False)

1164

self.checker = multiprocessing.Process(

1165

target=call_pipe,

1166

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

1167

kwargs=popen_args)

1168

self.checker.start()

1169

self.checker_callback_tag = GLib.io_add_watch(

1170

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

1171

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1172

self.checker_callback, pipe[0], command)

1173

# 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

1174

748

return True

1175

749

1176

750

def stop_checker(self):

1177

751

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

1178

752

if self.checker_callback_tag:

1179

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1180

754

self.checker_callback_tag = None

1181

755

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

1182

756

return

1183

757

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

1184

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

1185

766

self.checker = None

1186

767

1187

768

1188

def dbus_service_property(dbus_interface,

1189

signature="v",

1190

access="readwrite",

1191

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1192

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1193

772

become properties on the D-Bus.

1194

773

1195

774

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

1196

775

and with one argument by "Set".

1197

776

1198

777

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

1199

778

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

1200

779

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

1204

783

if byte_arrays and signature != "ay":

1205

784

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

1206

785

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

1207

1208

786

def decorator(func):

1209

787

func._dbus_is_property = True

1210

788

func._dbus_interface = dbus_interface

1213

791

func._dbus_name = func.__name__

1214

792

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

1215

793

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

1216

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1217

795

return func

1218

1219

796

return decorator

1220

797

1221

798

1222

799

def dbus_interface_annotations(dbus_interface):

1223

800

"""Decorator for marking functions returning interface annotations

1224

801

1225

802

Usage:

1226

803

1227

804

@dbus_interface_annotations("org.example.Interface")

1228

805

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

1229

806

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

1230

807

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

1231

808

"false"}

1232

809

"""

1233

1234

810

def decorator(func):

1235

811

func._dbus_is_interface = True

1236

812

func._dbus_interface = dbus_interface

1237

813

func._dbus_name = dbus_interface

1238

814

return func

1239

1240

815

return decorator

1241

816

1242

817

1243

818

def dbus_annotations(annotations):

1244

819

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

1245

820

Usage:

1246

821

1247

822

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

1248

823

"org.freedesktop.DBus.Property."

1249

824

"EmitsChangedSignal": "false"})

1251

826

access="r")

1252

827

def Property_dbus_property(self):

1253

828

return dbus.Boolean(False)

1254

1255

See also the DBusObjectWithAnnotations class.

1256

829

"""

1257

1258

830

def decorator(func):

1259

831

func._dbus_annotations = annotations

1260

832

return func

1261

1262

833

return decorator

1263

834

1264

835

1267

838

"""

1268

839

pass

1269

840

1270

1271

841

class DBusPropertyAccessException(DBusPropertyException):

1272

842

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

1273

843

"""

1280

850

pass

1281

851

1282

852

1283

class DBusObjectWithAnnotations(dbus.service.Object):

1284

"""A D-Bus object with annotations.

1285

1286

Classes inheriting from this can use the dbus_annotations

1287

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.

1288

859

"""

1289

860

1290

861

@staticmethod

1291

862

def _is_dbus_thing(thing):

1292

863

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

1293

864

1294

865

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

1295

866

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

1296

867

"""

1297

868

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

1298

869

False)

1299

870

1300

871

def _get_all_dbus_things(self, thing):

1301

872

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

1302

873

"""

1303

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

874

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

875

name),

1304

876

athing.__get__(self))

1305

877

for cls in self.__class__.__mro__

1306

878

for name, athing in

1307

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

1308

1309

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1310

out_signature="s",

1311

path_keyword='object_path',

1312

connection_keyword='connection')

1313

def Introspect(self, object_path, connection):

1314

"""Overloading of standard D-Bus method.

1315

1316

Inserts annotation tags on methods and signals.

1317

"""

1318

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

1319

connection)

1320

try:

1321

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

1322

1323

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

1324

# Add annotation tags

1325

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

1326

for tag in if_tag.getElementsByTagName(typ):

1327

annots = dict()

1328

for name, prop in (self.

1329

_get_all_dbus_things(typ)):

1330

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

1331

and prop._dbus_interface

1332

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

1333

annots.update(getattr(

1334

prop, "_dbus_annotations", {}))

1335

for name, value in annots.items():

1336

ann_tag = document.createElement(

1337

"annotation")

1338

ann_tag.setAttribute("name", name)

1339

ann_tag.setAttribute("value", value)

1340

tag.appendChild(ann_tag)

1341

# Add interface annotation tags

1342

for annotation, value in dict(

1343

itertools.chain.from_iterable(

1344

annotations().items()

1345

for name, annotations

1346

in self._get_all_dbus_things("interface")

1347

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

1348

)).items():

1349

ann_tag = document.createElement("annotation")

1350

ann_tag.setAttribute("name", annotation)

1351

ann_tag.setAttribute("value", value)

1352

if_tag.appendChild(ann_tag)

1353

# Fix argument name for the Introspect method itself

1354

if (if_tag.getAttribute("name")

1355

== dbus.INTROSPECTABLE_IFACE):

1356

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

1357

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

1358

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

1359

if (arg.getAttribute("direction")

1360

== "out"):

1361

arg.setAttribute("name",

1362

"xml_data")

1363

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

1364

document.unlink()

1365

except (AttributeError, xml.dom.DOMException,

1366

xml.parsers.expat.ExpatError) as error:

1367

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

1368

exc_info=error)

1369

return xmlstring

1370

1371

1372

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1373

"""A D-Bus object with properties.

1374

1375

Classes inheriting from this can use the dbus_service_property

1376

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

1377

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

1378

"""

1379

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1380

882

def _get_dbus_property(self, interface_name, property_name):

1381

883

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

1382

884

property with the specified name and interface.

1383

885

"""

1384

for cls in self.__class__.__mro__:

1385

for name, value in inspect.getmembers(

1386

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

1387

890

if (value._dbus_name == property_name

1388

891

and value._dbus_interface == interface_name):

1389

892

return value.__get__(self)

1390

893

1391

894

# No such property

1392

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

1393

self.dbus_object_path, interface_name, property_name))

1394

1395

@classmethod

1396

def _get_all_interface_names(cls):

1397

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

1398

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

1399

"_dbus_interface", None)

1400

for x in (inspect.getmro(cls))

1401

for attr in dir(x))

1402

if name is not None)

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

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

1406

900

out_signature="v")

1407

901

def Get(self, interface_name, property_name):

1408

902

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

1414

908

if not hasattr(value, "variant_level"):

1415

909

return value

1416

910

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

1417

911

1418

912

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

1419

913

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

1420

914

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

1429

923

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

1430

924

"'ay' signature {!r}"

1431

925

.format(prop._dbus_signature))

1432

value = dbus.ByteArray(bytes(value))

926

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

927

for byte in value))

1433

928

prop(value)

1434

1435

@dbus.service.method(dbus.PROPERTIES_IFACE,

1436

in_signature="s",

929

930

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

1437

931

out_signature="a{sv}")

1438

932

def GetAll(self, interface_name):

1439

933

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

1440

934

standard.

1441

935

1442

936

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

1443

937

"""

1444

938

properties = {}

1454

948

if not hasattr(value, "variant_level"):

1455

949

properties[name] = value

1456

950

continue

1457

properties[name] = type(value)(

1458

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1459

953

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

1460

954

1461

955

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

1462

956

def PropertiesChanged(self, interface_name, changed_properties,

1463

957

invalidated_properties):

1465

959

standard.

1466

960

"""

1467

961

pass

1468

962

1469

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1470

964

out_signature="s",

1471

965

path_keyword='object_path',

1472

966

connection_keyword='connection')

1473

967

def Introspect(self, object_path, connection):

1474

968

"""Overloading of standard D-Bus method.

1475

969

1476

970

Inserts property tags and interface annotation tags.

1477

971

"""

1478

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1479

object_path,

1480

connection)

972

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

973

connection)

1481

974

try:

1482

975

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

1483

1484

976

def make_tag(document, name, prop):

1485

977

e = document.createElement("property")

1486

978

e.setAttribute("name", name)

1487

979

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

1488

980

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

1489

981

return e

1490

1491

982

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

1492

983

# Add property tags

1493

984

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

1496

987

if prop._dbus_interface

1497

988

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

1498

989

if_tag.appendChild(tag)

1499

# Add annotation tags for properties

1500

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

1501

annots = dict()

1502

for name, prop in self._get_all_dbus_things(

1503

"property"):

1504

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

1505

and prop._dbus_interface

1506

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

1507

annots.update(getattr(

1508

prop, "_dbus_annotations", {}))

1509

for name, value in annots.items():

1510

ann_tag = document.createElement(

1511

"annotation")

1512

ann_tag.setAttribute("name", name)

1513

ann_tag.setAttribute("value", value)

1514

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)

1515

1021

# Add the names to the return values for the

1516

1022

# "org.freedesktop.DBus.Properties" methods

1517

1023

if (if_tag.getAttribute("name")

1536

1042

return xmlstring

1537

1043

1538

1044

1539

try:

1540

dbus.OBJECT_MANAGER_IFACE

1541

except AttributeError:

1542

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

1543

1544

1545

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1546

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

1547

1548

Classes inheriting from this exposes the standard

1549

GetManagedObjects call and the InterfacesAdded and

1550

InterfacesRemoved signals on the standard

1551

"org.freedesktop.DBus.ObjectManager" interface.

1552

1553

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

1554

manually.

1555

"""

1556

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1557

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

1558

def GetManagedObjects(self):

1559

"""This function must be overridden"""

1560

raise NotImplementedError()

1561

1562

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1563

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

1564

def InterfacesAdded(self, object_path, interfaces_and_properties):

1565

pass

1566

1567

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

1568

def InterfacesRemoved(self, object_path, interfaces):

1569

pass

1570

1571

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1572

out_signature="s",

1573

path_keyword='object_path',

1574

connection_keyword='connection')

1575

def Introspect(self, object_path, connection):

1576

"""Overloading of standard D-Bus method.

1577

1578

Override return argument name of GetManagedObjects to be

1579

"objpath_interfaces_and_properties"

1580

"""

1581

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1582

object_path,

1583

connection)

1584

try:

1585

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

1586

1587

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

1588

# Fix argument name for the GetManagedObjects method

1589

if (if_tag.getAttribute("name")

1590

== dbus.OBJECT_MANAGER_IFACE):

1591

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

1592

if (cn.getAttribute("name")

1593

== "GetManagedObjects"):

1594

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

1595

if (arg.getAttribute("direction")

1596

== "out"):

1597

arg.setAttribute(

1598

"name",

1599

"objpath_interfaces"

1600

"_and_properties")

1601

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

1602

document.unlink()

1603

except (AttributeError, xml.dom.DOMException,

1604

xml.parsers.expat.ExpatError) as error:

1605

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

1606

exc_info=error)

1607

return xmlstring

1608

1609

1610

1045

def datetime_to_dbus(dt, variant_level=0):

1611

1046

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

1612

1047

if dt is None:

1613

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

1614

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)

1615

1051

1616

1052

1617

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1619

1055

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

1620

1056

interface names according to the "alt_interface_names" mapping.

1621

1057

Usage:

1622

1058

1623

1059

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

1624

1060

"net.example.AlternateInterface"})

1625

1061

class SampleDBusObject(dbus.service.Object):

1626

1062

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

1627

1063

def SampleDBusMethod():

1628

1064

pass

1629

1065

1630

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1631

1067

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

1632

1068

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

1633

1069

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

1634

1070

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

1635

1071

1636

1072

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

1637

1073

(from DBusObjectWithProperties) and interfaces (from the

1638

1074

dbus_interface_annotations decorator).

1639

1075

"""

1640

1641

1076

def wrapper(cls):

1642

1077

for orig_interface_name, alt_interface_name in (

1643

alt_interface_names.items()):

1078

alt_interface_names.items()):

1644

1079

attr = {}

1645

1080

interface_names = set()

1646

1081

# Go though all attributes of the class

1648

1083

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

1649

1084

# with the wrong interface name

1650

1085

if (not hasattr(attribute, "_dbus_interface")

1651

or not attribute._dbus_interface.startswith(

1652

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1653

1088

continue

1654

1089

# Create an alternate D-Bus interface name based on

1655

1090

# the current name

1656

alt_interface = attribute._dbus_interface.replace(

1657

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1658

1094

interface_names.add(alt_interface)

1659

1095

# Is this a D-Bus signal?

1660

1096

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

1661

1097

# Extract the original non-method undecorated

1662

1098

# function by black magic

1663

if sys.version_info.major == 2:

1664

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1665

1100

zip(attribute.func_code.co_freevars,

1666

attribute.__closure__))

1667

["func"].cell_contents)

1668

else:

1669

nonmethod_func = (dict(

1670

zip(attribute.__code__.co_freevars,

1671

attribute.__closure__))

1672

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1673

1103

# Create a new, but exactly alike, function

1674

1104

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

1675

1105

# with the alternate D-Bus interface name

1676

new_function = copy_function(nonmethod_func)

1677

new_function = (dbus.service.signal(

1678

alt_interface,

1679

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

1680

1115

# Copy annotations, if any

1681

1116

try:

1682

new_function._dbus_annotations = dict(

1683

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1684

1119

except AttributeError:

1685

1120

pass

1686

1687

1121

# Define a creator of a function to call both the

1688

1122

# original and alternate functions, so both the

1689

1123

# original and alternate signals gets sent when

1692

1126

"""This function is a scope container to pass

1693

1127

func1 and func2 to the "call_both" function

1694

1128

outside of its arguments"""

1695

1696

@functools.wraps(func2)

1697

1129

def call_both(*args, **kwargs):

1698

1130

"""This function will emit two D-Bus

1699

1131

signals by calling func1 and func2"""

1700

1132

func1(*args, **kwargs)

1701

1133

func2(*args, **kwargs)

1702

# Make wrapper function look like a D-Bus

1703

# signal

1704

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

1705

if name.startswith("_dbus_"):

1706

setattr(call_both, name, attr)

1707

1708

1134

return call_both

1709

1135

# Create the "call_both" function and add it to

1710

1136

# the class

1715

1141

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

1716

1142

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

1717

1143

# to the class.

1718

attr[attrname] = (

1719

dbus.service.method(

1720

alt_interface,

1721

attribute._dbus_in_signature,

1722

attribute._dbus_out_signature)

1723

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

1724

1154

# Copy annotations, if any

1725

1155

try:

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1728

1158

except AttributeError:

1729

1159

pass

1730

1160

# Is this a D-Bus property?

1733

1163

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

1734

1164

# property with the alternate D-Bus interface

1735

1165

# name. Add it to the class.

1736

attr[attrname] = (dbus_service_property(

1737

alt_interface, attribute._dbus_signature,

1738

attribute._dbus_access,

1739

attribute._dbus_get_args_options

1740

["byte_arrays"])

1741

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

1742

1179

# Copy annotations, if any

1743

1180

try:

1744

attr[attrname]._dbus_annotations = dict(

1745

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1746

1183

except AttributeError:

1747

1184

pass

1748

1185

# Is this a D-Bus interface?

1751

1188

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

1752

1189

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

1753

1190

# to the class.

1754

attr[attrname] = (

1755

dbus_interface_annotations(alt_interface)

1756

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

1757

1199

if deprecate:

1758

1200

# Deprecate all alternate interfaces

1759

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1760

1202

for interface_name in interface_names:

1761

1762

1203

@dbus_interface_annotations(interface_name)

1763

1204

def func(self):

1764

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

1765

"true"}

1205

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

1206

"true" }

1766

1207

# Find an unused name

1767

1208

for aname in (iname.format(i)

1768

1209

for i in itertools.count()):

1772

1213

if interface_names:

1773

1214

# Replace the class with a new subclass of it with

1774

1215

# methods, signals, etc. as created above.

1775

if sys.version_info.major == 2:

1776

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

1777

(cls, ), attr)

1778

else:

1779

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

1780

(cls, ), attr)

1216

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

1217

(cls,), attr)

1781

1218

return cls

1782

1783

1219

return wrapper

1784

1220

1785

1221

1786

1222

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

1787

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1788

1224

class ClientDBus(Client, DBusObjectWithProperties):

1789

1225

"""A Client class using D-Bus

1790

1226

1791

1227

Attributes:

1792

1228

dbus_object_path: dbus.ObjectPath

1793

1229

bus: dbus.SystemBus()

1794

1230

"""

1795

1231

1796

1232

runtime_expansions = (Client.runtime_expansions

1797

+ ("dbus_object_path", ))

1798

1233

+ ("dbus_object_path",))

1234

1799

1235

_interface = "se.recompile.Mandos.Client"

1800

1236

1801

1237

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

1802

1803

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

1238

1239

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

1804

1240

self.bus = bus

1805

1241

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

1806

1242

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

1808

1244

client_object_name = str(self.name).translate(

1809

1245

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

1810

1246

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

1811

self.dbus_object_path = dbus.ObjectPath(

1812

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1813

1249

DBusObjectWithProperties.__init__(self, self.bus,

1814

1250

self.dbus_object_path)

1815

1816

def notifychangeproperty(transform_func, dbus_name,

1817

type_func=lambda x: x,

1818

variant_level=1,

1819

invalidate_only=False,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1820

1255

_interface=_interface):

1821

1256

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

1822

1257

its changes to DBus.

1823

1258

1824

1259

transform_fun: Function that takes a value and a variant_level

1825

1260

and transforms it to a D-Bus type.

1826

1261

dbus_name: D-Bus name of the variable

1829

1264

variant_level: D-Bus variant level. Default: 1

1830

1265

"""

1831

1266

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

1832

1833

1267

def setter(self, value):

1834

1268

if hasattr(self, "dbus_object_path"):

1835

1269

if (not hasattr(self, attrname) or

1836

1270

type_func(getattr(self, attrname, None))

1837

1271

!= type_func(value)):

1838

1272

if invalidate_only:

1839

self.PropertiesChanged(

1840

_interface, dbus.Dictionary(),

1841

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1842

1277

else:

1843

dbus_value = transform_func(

1844

type_func(value),

1845

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1846

1281

self.PropertyChanged(dbus.String(dbus_name),

1847

1282

dbus_value)

1848

self.PropertiesChanged(

1849

_interface,

1850

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

1851

dbus_value}),

1852

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1853

1287

setattr(self, attrname, value)

1854

1288

1855

1289

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

1856

1290

1857

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1858

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1859

1293

"ApprovalPending",

1860

type_func=bool)

1294

type_func = bool)

1861

1295

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

1862

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1863

1297

"LastEnabled")

1864

checker = notifychangeproperty(

1865

dbus.Boolean, "CheckerRunning",

1866

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1867

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1868

1302

"LastCheckedOK")

1869

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1872

1306

datetime_to_dbus, "LastApprovalRequest")

1873

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1874

1308

"ApprovedByDefault")

1875

approval_delay = notifychangeproperty(

1876

dbus.UInt64, "ApprovalDelay",

1877

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)

1878

1314

approval_duration = notifychangeproperty(

1879

1315

dbus.UInt64, "ApprovalDuration",

1880

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

1316

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

1881

1317

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

1882

timeout = notifychangeproperty(

1883

dbus.UInt64, "Timeout",

1884

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1885

1321

extended_timeout = notifychangeproperty(

1886

1322

dbus.UInt64, "ExtendedTimeout",

1887

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

1888

interval = notifychangeproperty(

1889

dbus.UInt64, "Interval",

1890

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)

1891

1329

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

1892

1330

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

1893

1331

invalidate_only=True)

1894

1332

1895

1333

del notifychangeproperty

1896

1334

1897

1335

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

1898

1336

try:

1899

1337

self.remove_from_connection()

1902

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1903

1341

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

1904

1342

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

1905

1906

def checker_callback(self, source, condition,

1907

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

1908

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

1909

connection, command, *args,

1910

**kwargs)

1911

exitstatus = self.last_checker_status

1912

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)

1913

1350

# Emit D-Bus signal

1914

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1915

# This is specific to GNU libC

1916

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1917

1353

dbus.String(command))

1918

1354

else:

1919

1355

# Emit D-Bus signal

1920

1356

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

1921

dbus.Int64(

1922

# This is specific to GNU libC

1923

(exitstatus << 8)

1924

| self.last_checker_signal),

1357

dbus.Int64(condition),

1925

1358

dbus.String(command))

1926

return ret

1927

1359

1360

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

1361

*args, **kwargs)

1362

1928

1363

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

1929

1364

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

1930

1365

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

1934

1369

# Emit D-Bus signal

1935

1370

self.CheckerStarted(self.current_checker_command)

1936

1371

return r

1937

1372

1938

1373

def _reset_approved(self):

1939

1374

self.approved = None

1940

1375

return False

1941

1376

1942

1377

def approve(self, value=True):

1943

1378

self.approved = value

1944

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

1945

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1946

1381

self.send_changedstate()

1947

1948

# D-Bus methods, signals & properties

1949

1950

# Interfaces

1951

1952

# Signals

1953

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1954

1389

# CheckerCompleted - signal

1955

1390

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

1956

1391

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

1957

1392

"D-Bus signal"

1958

1393

pass

1959

1394

1960

1395

# CheckerStarted - signal

1961

1396

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

1962

1397

def CheckerStarted(self, command):

1963

1398

"D-Bus signal"

1964

1399

pass

1965

1400

1966

1401

# PropertyChanged - signal

1967

1402

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

1968

1403

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

1969

1404

def PropertyChanged(self, property, value):

1970

1405

"D-Bus signal"

1971

1406

pass

1972

1407

1973

1408

# GotSecret - signal

1974

1409

@dbus.service.signal(_interface)

1975

1410

def GotSecret(self):

1978

1413

server to mandos-client

1979

1414

"""

1980

1415

pass

1981

1416

1982

1417

# Rejected - signal

1983

1418

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

1984

1419

def Rejected(self, reason):

1985

1420

"D-Bus signal"

1986

1421

pass

1987

1422

1988

1423

# NeedApproval - signal

1989

1424

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

1990

1425

def NeedApproval(self, timeout, default):

1991

1426

"D-Bus signal"

1992

1427

return self.need_approval()

1993

1994

# Methods

1995

1428

1429

## Methods

1430

1996

1431

# Approve - method

1997

1432

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

1998

1433

def Approve(self, value):

1999

1434

self.approve(value)

2000

1435

2001

1436

# CheckedOK - method

2002

1437

@dbus.service.method(_interface)

2003

1438

def CheckedOK(self):

2004

1439

self.checked_ok()

2005

1440

2006

1441

# Enable - method

2007

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

2008

1442

@dbus.service.method(_interface)

2009

1443

def Enable(self):

2010

1444

"D-Bus method"

2011

1445

self.enable()

2012

1446

2013

1447

# StartChecker - method

2014

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

2015

1448

@dbus.service.method(_interface)

2016

1449

def StartChecker(self):

2017

1450

"D-Bus method"

2018

1451

self.start_checker()

2019

1452

2020

1453

# Disable - method

2021

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

2022

1454

@dbus.service.method(_interface)

2023

1455

def Disable(self):

2024

1456

"D-Bus method"

2025

1457

self.disable()

2026

1458

2027

1459

# StopChecker - method

2028

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

2029

1460

@dbus.service.method(_interface)

2030

1461

def StopChecker(self):

2031

1462

self.stop_checker()

2032

2033

# Properties

2034

1463

1464

## Properties

1465

2035

1466

# ApprovalPending - property

2036

1467

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

2037

1468

def ApprovalPending_dbus_property(self):

2038

1469

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

2039

1470

2040

1471

# ApprovedByDefault - property

2041

@dbus_service_property(_interface,

2042

signature="b",

1472

@dbus_service_property(_interface, signature="b",

2043

1473

access="readwrite")

2044

1474

def ApprovedByDefault_dbus_property(self, value=None):

2045

1475

if value is None: # get

2046

1476

return dbus.Boolean(self.approved_by_default)

2047

1477

self.approved_by_default = bool(value)

2048

1478

2049

1479

# ApprovalDelay - property

2050

@dbus_service_property(_interface,

2051

signature="t",

1480

@dbus_service_property(_interface, signature="t",

2052

1481

access="readwrite")

2053

1482

def ApprovalDelay_dbus_property(self, value=None):

2054

1483

if value is None: # get

2055

1484

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

2056

1485

* 1000)

2057

1486

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

2058

1487

2059

1488

# ApprovalDuration - property

2060

@dbus_service_property(_interface,

2061

signature="t",

1489

@dbus_service_property(_interface, signature="t",

2062

1490

access="readwrite")

2063

1491

def ApprovalDuration_dbus_property(self, value=None):

2064

1492

if value is None: # get

2065

1493

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

2066

1494

* 1000)

2067

1495

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

2068

1496

2069

1497

# Name - property

2070

@dbus_annotations(

2071

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

2072

1498

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

2073

1499

def Name_dbus_property(self):

2074

1500

return dbus.String(self.name)

2075

2076

# KeyID - property

2077

@dbus_annotations(

2078

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

2079

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

2080

def KeyID_dbus_property(self):

2081

return dbus.String(self.key_id)

2082

1501

2083

1502

# Fingerprint - property

2084

@dbus_annotations(

2085

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

2086

1503

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

2087

1504

def Fingerprint_dbus_property(self):

2088

1505

return dbus.String(self.fingerprint)

2089

1506

2090

1507

# Host - property

2091

@dbus_service_property(_interface,

2092

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2093

1509

access="readwrite")

2094

1510

def Host_dbus_property(self, value=None):

2095

1511

if value is None: # get

2096

1512

return dbus.String(self.host)

2097

1513

self.host = str(value)

2098

1514

2099

1515

# Created - property

2100

@dbus_annotations(

2101

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

2102

1516

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

2103

1517

def Created_dbus_property(self):

2104

1518

return datetime_to_dbus(self.created)

2105

1519

2106

1520

# LastEnabled - property

2107

1521

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

2108

1522

def LastEnabled_dbus_property(self):

2109

1523

return datetime_to_dbus(self.last_enabled)

2110

1524

2111

1525

# Enabled - property

2112

@dbus_service_property(_interface,

2113

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2114

1527

access="readwrite")

2115

1528

def Enabled_dbus_property(self, value=None):

2116

1529

if value is None: # get

2119

1532

self.enable()

2120

1533

else:

2121

1534

self.disable()

2122

1535

2123

1536

# LastCheckedOK - property

2124

@dbus_service_property(_interface,

2125

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2126

1538

access="readwrite")

2127

1539

def LastCheckedOK_dbus_property(self, value=None):

2128

1540

if value is not None:

2129

1541

self.checked_ok()

2130

1542

return

2131

1543

return datetime_to_dbus(self.last_checked_ok)

2132

1544

2133

1545

# LastCheckerStatus - property

2134

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2135

1548

def LastCheckerStatus_dbus_property(self):

2136

1549

return dbus.Int16(self.last_checker_status)

2137

1550

2138

1551

# Expires - property

2139

1552

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

2140

1553

def Expires_dbus_property(self):

2141

1554

return datetime_to_dbus(self.expires)

2142

1555

2143

1556

# LastApprovalRequest - property

2144

1557

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

2145

1558

def LastApprovalRequest_dbus_property(self):

2146

1559

return datetime_to_dbus(self.last_approval_request)

2147

1560

2148

1561

# Timeout - property

2149

@dbus_service_property(_interface,

2150

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2151

1563

access="readwrite")

2152

1564

def Timeout_dbus_property(self, value=None):

2153

1565

if value is None: # get

2165

1577

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

2166

1578

is None):

2167

1579

return

2168

GLib.source_remove(self.disable_initiator_tag)

2169

self.disable_initiator_tag = GLib.timeout_add(

2170

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

2171

self.disable)

2172

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

2173

1586

# ExtendedTimeout - property

2174

@dbus_service_property(_interface,

2175

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2176

1588

access="readwrite")

2177

1589

def ExtendedTimeout_dbus_property(self, value=None):

2178

1590

if value is None: # get

2179

1591

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

2180

1592

* 1000)

2181

1593

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

2182

1594

2183

1595

# Interval - property

2184

@dbus_service_property(_interface,

2185

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2186

1597

access="readwrite")

2187

1598

def Interval_dbus_property(self, value=None):

2188

1599

if value is None: # get

2192

1603

return

2193

1604

if self.enabled:

2194

1605

# Reschedule checker run

2195

GLib.source_remove(self.checker_initiator_tag)

2196

self.checker_initiator_tag = GLib.timeout_add(

2197

value, self.start_checker)

2198

self.start_checker() # Start one now, too

2199

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

2200

1611

# Checker - property

2201

@dbus_service_property(_interface,

2202

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2203

1613

access="readwrite")

2204

1614

def Checker_dbus_property(self, value=None):

2205

1615

if value is None: # get

2206

1616

return dbus.String(self.checker_command)

2207

1617

self.checker_command = str(value)

2208

1618

2209

1619

# CheckerRunning - property

2210

@dbus_service_property(_interface,

2211

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2212

1621

access="readwrite")

2213

1622

def CheckerRunning_dbus_property(self, value=None):

2214

1623

if value is None: # get

2217

1626

self.start_checker()

2218

1627

else:

2219

1628

self.stop_checker()

2220

1629

2221

1630

# ObjectPath - property

2222

@dbus_annotations(

2223

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

2224

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

2225

1631

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

2226

1632

def ObjectPath_dbus_property(self):

2227

return self.dbus_object_path # is already a dbus.ObjectPath

2228

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2229

1635

# Secret = property

2230

@dbus_annotations(

2231

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

2232

"invalidates"})

2233

@dbus_service_property(_interface,

2234

signature="ay",

2235

access="write",

2236

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2237

1638

def Secret_dbus_property(self, value):

2238

1639

self.secret = bytes(value)

2239

1640

2240

1641

del _interface

2241

1642

2242

1643

2243

class ProxyClient:

2244

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

1644

class ProxyClient(object):

1645

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

2245

1646

self._pipe = child_pipe

2246

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

1647

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

2247

1648

if not self._pipe.recv():

2248

raise KeyError(key_id or fpr)

2249

1649

raise KeyError()

1650

2250

1651

def __getattribute__(self, name):

2251

1652

if name == '_pipe':

2252

1653

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

2255

1656

if data[0] == 'data':

2256

1657

return data[1]

2257

1658

if data[0] == 'function':

2258

2259

1659

def func(*args, **kwargs):

2260

1660

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

2261

1661

return self._pipe.recv()[1]

2262

2263

1662

return func

2264

1663

2265

1664

def __setattr__(self, name, value):

2266

1665

if name == '_pipe':

2267

1666

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

2270

1669

2271

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2272

1671

"""A class to handle client connections.

2273

1672

2274

1673

Instantiated once for each connection to handle it.

2275

1674

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

2276

1675

2277

1676

def handle(self):

2278

1677

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

2279

1678

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

2280

1679

str(self.client_address))

2281

1680

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

2282

1681

self.server.child_pipe.fileno())

2283

2284

session = gnutls.ClientSession(self.request)

2285

2286

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

2287

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

2288

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

2289

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

2290

1697

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

2291

1698

priority = self.server.gnutls_priority

2292

1699

if priority is None:

2293

1700

priority = "NORMAL"

2294

gnutls.priority_set_direct(session._c_object,

2295

priority.encode("utf-8"),

2296

None)

2297

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2298

1705

# Start communication using the Mandos protocol

2299

1706

# Get protocol number

2300

1707

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

2305

1712

except (ValueError, IndexError, RuntimeError) as error:

2306

1713

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

2307

1714

return

2308

1715

2309

1716

# Start GnuTLS connection

2310

1717

try:

2311

1718

session.handshake()

2312

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2313

1720

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

2314

1721

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

2315

1722

# established. Just abandon the request.

2316

1723

return

2317

1724

logger.debug("Handshake succeeded")

2318

1725

2319

1726

approval_required = False

2320

1727

try:

2321

if gnutls.has_rawpk:

2322

fpr = b""

2323

try:

2324

key_id = self.key_id(

2325

self.peer_certificate(session))

2326

except (TypeError, gnutls.Error) as error:

2327

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

2328

return

2329

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

2330

2331

else:

2332

key_id = b""

2333

try:

2334

fpr = self.fingerprint(

2335

self.peer_certificate(session))

2336

except (TypeError, gnutls.Error) as error:

2337

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

2338

return

2339

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

2340

2341

try:

2342

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,

2343

1739

self.client_address)

2344

1740

except KeyError:

2345

1741

return

2346

1742

2347

1743

if client.approval_delay:

2348

1744

delay = client.approval_delay

2349

1745

client.approvals_pending += 1

2350

1746

approval_required = True

2351

1747

2352

1748

while True:

2353

1749

if not client.enabled:

2354

1750

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

2355

client.name)

1751

client.name)

2356

1752

if self.server.use_dbus:

2357

1753

# Emit D-Bus signal

2358

1754

client.Rejected("Disabled")

2359

1755

return

2360

1756

2361

1757

if client.approved or not client.approval_delay:

2362

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2363

1759

break

2364

1760

elif client.approved is None:

2365

1761

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

2376

1772

# Emit D-Bus signal

2377

1773

client.Rejected("Denied")

2378

1774

return

2379

2380

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2381

1777

time = datetime.datetime.now()

2382

1778

client.changedstate.acquire()

2383

1779

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

2396

1792

break

2397

1793

else:

2398

1794

delay -= time2 - time

2399

2400

try:

2401

session.send(client.secret)

2402

except gnutls.Error as error:

2403

logger.warning("gnutls send failed",

2404

exc_info=error)

2405

return

2406

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

2407

1809

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

2408

1810

# bump the timeout using extended_timeout

2409

1811

client.bump_timeout(client.extended_timeout)

2410

1812

if self.server.use_dbus:

2411

1813

# Emit D-Bus signal

2412

1814

client.GotSecret()

2413

1815

2414

1816

finally:

2415

1817

if approval_required:

2416

1818

client.approvals_pending -= 1

2417

1819

try:

2418

1820

session.bye()

2419

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2420

1822

logger.warning("GnuTLS bye failed",

2421

1823

exc_info=error)

2422

1824

2423

1825

@staticmethod

2424

1826

def peer_certificate(session):

2425

"Return the peer's certificate as a bytestring"

2426

try:

2427

cert_type = gnutls.certificate_type_get2(session._c_object,

2428

gnutls.CTYPE_PEERS)

2429

except AttributeError:

2430

cert_type = gnutls.certificate_type_get(session._c_object)

2431

if gnutls.has_rawpk:

2432

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2433

else:

2434

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2435

# If not a valid certificate type...

2436

if cert_type not in valid_cert_types:

2437

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

2438

valid_cert_types)

2439

# ...return invalid data

2440

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

2441

1834

list_size = ctypes.c_uint(1)

2442

cert_list = (gnutls.certificate_get_peers

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2443

1837

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

2444

1838

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

2445

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

1839

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

1840

" certificate")

2446

1841

if list_size.value == 0:

2447

1842

return None

2448

1843

cert = cert_list[0]

2449

1844

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

2450

2451

@staticmethod

2452

def key_id(certificate):

2453

"Convert a certificate bytestring to a hexdigit key ID"

2454

# New GnuTLS "datum" with the public key

2455

datum = gnutls.datum_t(

2456

ctypes.cast(ctypes.c_char_p(certificate),

2457

ctypes.POINTER(ctypes.c_ubyte)),

2458

ctypes.c_uint(len(certificate)))

2459

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

2460

# New empty GnuTLS certificate

2461

pubkey = gnutls.pubkey_t()

2462

gnutls.pubkey_init(ctypes.byref(pubkey))

2463

# Import the raw public key into the certificate

2464

gnutls.pubkey_import(pubkey,

2465

ctypes.byref(datum),

2466

gnutls.X509_FMT_DER)

2467

# New buffer for the key ID

2468

buf = ctypes.create_string_buffer(32)

2469

buf_len = ctypes.c_size_t(len(buf))

2470

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

2471

gnutls.pubkey_get_key_id(pubkey,

2472

gnutls.KEYID_USE_SHA256,

2473

ctypes.cast(ctypes.byref(buf),

2474

ctypes.POINTER(ctypes.c_ubyte)),

2475

ctypes.byref(buf_len))

2476

# Deinit the certificate

2477

gnutls.pubkey_deinit(pubkey)

2478

2479

# Convert the buffer to a Python bytestring

2480

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

2481

# Convert the bytestring to hexadecimal notation

2482

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

2483

return hex_key_id

2484

1845

2485

1846

@staticmethod

2486

1847

def fingerprint(openpgp):

2487

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2488

1849

# New GnuTLS "datum" with the OpenPGP public key

2489

datum = gnutls.datum_t(

2490

ctypes.cast(ctypes.c_char_p(openpgp),

2491

ctypes.POINTER(ctypes.c_ubyte)),

2492

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

2493

1855

# New empty GnuTLS certificate

2494

crt = gnutls.openpgp_crt_t()

2495

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

2496

1859

# Import the OpenPGP public key into the certificate

2497

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

2498

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

2499

1864

# Verify the self signature in the key

2500

1865

crtverify = ctypes.c_uint()

2501

gnutls.openpgp_crt_verify_self(crt, 0,

2502

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2503

1869

if crtverify.value != 0:

2504

gnutls.openpgp_crt_deinit(crt)

2505

raise gnutls.CertificateSecurityError(code

2506

=crtverify.value)

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2507

1873

# New buffer for the fingerprint

2508

1874

buf = ctypes.create_string_buffer(20)

2509

1875

buf_len = ctypes.c_size_t()

2510

1876

# Get the fingerprint from the certificate into the buffer

2511

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

2512

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2513

1880

# Deinit the certificate

2514

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2515

1882

# Convert the buffer to a Python bytestring

2516

1883

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

2517

1884

# Convert the bytestring to hexadecimal notation

2519

1886

return hex_fpr

2520

1887

2521

1888

2522

class MultiprocessingMixIn:

1889

class MultiprocessingMixIn(object):

2523

1890

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

2524

2525

1891

def sub_process_main(self, request, address):

2526

1892

try:

2527

1893

self.finish_request(request, address)

2528

1894

except Exception:

2529

1895

self.handle_error(request, address)

2530

1896

self.close_request(request)

2531

1897

2532

1898

def process_request(self, request, address):

2533

1899

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

2534

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

2535

args=(request, address))

1900

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

1901

args = (request, address))

2536

1902

proc.start()

2537

1903

return proc

2538

1904

2539

1905

2540

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2541

1907

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

2542

2543

1908

def process_request(self, request, client_address):

2544

1909

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

2545

1910

2546

1911

This function creates a new pipe in self.pipe

2547

1912

"""

2548

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2549

1914

2550

1915

proc = MultiprocessingMixIn.process_request(self, request,

2551

1916

client_address)

2552

1917

self.child_pipe.close()

2553

1918

self.add_pipe(parent_pipe, proc)

2554

1919

2555

1920

def add_pipe(self, parent_pipe, proc):

2556

1921

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

2557

1922

raise NotImplementedError()

2558

1923

2559

1924

2560

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2561

socketserver.TCPServer):

1926

socketserver.TCPServer, object):

2562

1927

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

2563

1928

2564

1929

Attributes:

2565

1930

enabled: Boolean; whether this server is activated yet

2566

1931

interface: None or a network interface name (string)

2567

1932

use_ipv6: Boolean; to use IPv6 or not

2568

1933

"""

2569

2570

1934

def __init__(self, server_address, RequestHandlerClass,

2571

interface=None,

2572

use_ipv6=True,

2573

socketfd=None):

1935

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

2574

1936

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

2575

1937

creating a new one with socket.socket().

2576

1938

"""

2582

1944

self.socketfd = socketfd

2583

1945

# Save the original socket.socket() function

2584

1946

self.socket_socket = socket.socket

2585

2586

1947

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

2587

#

1948

#

2588

1949

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

2589

1950

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

2590

1951

# patching socket.socket.)

2591

#

1952

#

2592

1953

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

2593

1954

@functools.wraps(socket.socket)

2594

1955

def socket_wrapper(*args, **kwargs):

2606

1967

# socket_wrapper(), if socketfd was set.

2607

1968

socketserver.TCPServer.__init__(self, server_address,

2608

1969

RequestHandlerClass)

2609

1970

2610

1971

def server_bind(self):

2611

1972

"""This overrides the normal server_bind() function

2612

1973

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

2613

1974

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

2614

global SO_BINDTODEVICE

2615

1975

if self.interface is not None:

2616

1976

if SO_BINDTODEVICE is None:

2617

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

2618

# common enough.

2619

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

2620

SO_BINDTODEVICE = 25

2621

try:

2622

self.socket.setsockopt(

2623

socket.SOL_SOCKET, SO_BINDTODEVICE,

2624

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

2625

except socket.error as error:

2626

if error.errno == errno.EPERM:

2627

logger.error("No permission to bind to"

2628

" interface %s", self.interface)

2629

elif error.errno == errno.ENOPROTOOPT:

2630

logger.error("SO_BINDTODEVICE not available;"

2631

" cannot bind to interface %s",

2632

self.interface)

2633

elif error.errno == errno.ENODEV:

2634

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

2635

" cannot bind", self.interface)

2636

else:

2637

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

2638

1999

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

2639

2000

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

2640

if self.server_address[1]:

2641

self.allow_reuse_address = True

2642

2001

if not self.server_address[0]:

2643

2002

if self.address_family == socket.AF_INET6:

2644

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2645

2004

else:

2646

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2647

2006

self.server_address = (any_address,

2648

2007

self.server_address[1])

2649

2008

elif not self.server_address[1]:

2650

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

2009

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

2010

0)

2651

2011

# if self.interface:

2652

2012

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

2653

2013

# 0, # port

2659

2019

2660

2020

class MandosServer(IPv6_TCPServer):

2661

2021

"""Mandos server.

2662

2022

2663

2023

Attributes:

2664

2024

clients: set of Client objects

2665

2025

gnutls_priority GnuTLS priority string

2666

2026

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

2667

2668

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2669

2029

"""

2670

2671

2030

def __init__(self, server_address, RequestHandlerClass,

2672

interface=None,

2673

use_ipv6=True,

2674

clients=None,

2675

gnutls_priority=None,

2676

use_dbus=True,

2677

socketfd=None):

2031

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

2032

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

2678

2033

self.enabled = False

2679

2034

self.clients = clients

2680

2035

if self.clients is None:

2683

2038

self.gnutls_priority = gnutls_priority

2684

2039

IPv6_TCPServer.__init__(self, server_address,

2685

2040

RequestHandlerClass,

2686

interface=interface,

2687

use_ipv6=use_ipv6,

2688

socketfd=socketfd)

2689

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2690

2044

def server_activate(self):

2691

2045

if self.enabled:

2692

2046

return socketserver.TCPServer.server_activate(self)

2693

2047

2694

2048

def enable(self):

2695

2049

self.enabled = True

2696

2050

2697

2051

def add_pipe(self, parent_pipe, proc):

2698

2052

# Call "handle_ipc" for both data and EOF events

2699

GLib.io_add_watch(

2700

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

2701

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

2702

functools.partial(self.handle_ipc,

2703

parent_pipe=parent_pipe,

2704

proc=proc))

2705

2706

def handle_ipc(self, source, condition,

2707

parent_pipe=None,

2708

proc=None,

2709

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

2710

2062

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

2711

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

2063

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

2712

2064

# Wait for other process to exit

2713

2065

proc.join()

2714

2066

return False

2715

2067

2716

2068

# Read a request from the child

2717

2069

request = parent_pipe.recv()

2718

2070

command = request[0]

2719

2071

2720

2072

if command == 'init':

2721

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

2722

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

2723

address = request[3]

2724

2725

for c in self.clients.values():

2726

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2727

continue

2728

if key_id and c.key_id == key_id:

2729

client = c

2730

break

2731

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:

2732

2078

client = c

2733

2079

break

2734

2080

else:

2735

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

2736

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

2081

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

2082

"dress: %s", fpr, address)

2737

2083

if self.use_dbus:

2738

2084

# Emit D-Bus signal

2739

mandos_dbus_service.ClientNotFound(key_id or fpr,

2085

mandos_dbus_service.ClientNotFound(fpr,

2740

2086

address[0])

2741

2087

parent_pipe.send(False)

2742

2088

return False

2743

2744

GLib.io_add_watch(

2745

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

2746

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

2747

functools.partial(self.handle_ipc,

2748

parent_pipe=parent_pipe,

2749

proc=proc,

2750

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

2751

2098

parent_pipe.send(True)

2752

2099

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

2753

2100

# same fileno

2756

2103

funcname = request[1]

2757

2104

args = request[2]

2758

2105

kwargs = request[3]

2759

2106

2760

2107

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

2761

2108

funcname)(*args,

2762

**kwargs)))

2763

2109

**kwargs)))

2110

2764

2111

if command == 'getattr':

2765

2112

attrname = request[1]

2766

if isinstance(client_object.__getattribute__(attrname),

2767

collections.abc.Callable):

2768

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2769

2115

else:

2770

parent_pipe.send((

2771

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

2772

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2773

2119

if command == 'setattr':

2774

2120

attrname = request[1]

2775

2121

value = request[2]

2776

2122

setattr(client_object, attrname, value)

2777

2123

2778

2124

return True

2779

2125

2780

2126

2781

2127

def rfc3339_duration_to_delta(duration):

2782

2128

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

2783

2784

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

2785

True

2786

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

2787

True

2788

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

2789

True

2790

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

2791

True

2792

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

2793

True

2794

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

2795

True

2796

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

2797

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)

2798

2144

"""

2799

2145

2800

2146

# Parsing an RFC 3339 duration with regular expressions is not

2801

2147

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

2802

2148

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

2803

2149

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

2804

2150

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

2805

2151

# avoid excessive use of external libraries.

2806

2152

2807

2153

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

2808

Token = collections.namedtuple("Token", (

2809

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

2810

# a "group" containing digits

2811

"value", # datetime.timedelta or None

2812

"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

2813

2163

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

2814

2164

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

2815

2165

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

2816

2166

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

2817

2167

datetime.timedelta(seconds=1),

2818

frozenset((token_end, )))

2168

frozenset((token_end,)))

2819

2169

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

2820

2170

datetime.timedelta(minutes=1),

2821

2171

frozenset((token_second, token_end)))

2837

2187

frozenset((token_month, token_end)))

2838

2188

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

2839

2189

datetime.timedelta(weeks=1),

2840

frozenset((token_end, )))

2190

frozenset((token_end,)))

2841

2191

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

2842

2192

frozenset((token_year, token_month,

2843

2193

token_day, token_time,

2844

2194

token_week)))

2845

# Define starting values:

2846

# Value so far

2847

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2848

2197

found_token = None

2849

# Following valid tokens

2850

followers = frozenset((token_duration, ))

2851

# String left to parse

2852

s = duration

2198

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

2199

s = duration # String left to parse

2853

2200

# Loop until end token is found

2854

2201

while found_token is not token_end:

2855

2202

# Search for any currently valid tokens

2871

2218

break

2872

2219

else:

2873

2220

# No currently valid tokens were found

2874

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

2875

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2876

2222

# End token found

2877

2223

return value

2878

2224

2879

2225

2880

2226

def string_to_delta(interval):

2881

2227

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

2882

2883

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

2884

True

2885

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

2886

True

2887

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

2888

True

2889

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

2890

True

2891

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

2892

True

2893

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

2894

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)

2895

2241

"""

2896

2242

2897

2243

try:

2898

2244

return rfc3339_duration_to_delta(interval)

2899

2245

except ValueError:

2900

2246

pass

2901

2247

2902

2248

timevalue = datetime.timedelta(0)

2903

2249

for s in interval.split():

2904

2250

try:

2915

2261

elif suffix == "w":

2916

2262

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

2917

2263

else:

2918

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2919

2266

except IndexError as e:

2920

2267

raise ValueError(*(e.args))

2921

2268

timevalue += delta

2922

2269

return timevalue

2923

2270

2924

2271

2925

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

2272

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

2926

2273

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

2927

2274

2928

2275

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

2929

2276

if os.fork():

2930

2277

sys.exit()

2937

2284

# Close all standard open file descriptors

2938

2285

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

2939

2286

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

2940

raise OSError(errno.ENODEV,

2941

"{} not a character device"

2287

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

2942

2288

.format(os.devnull))

2943

2289

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

2944

2290

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

2948

2294

2949

2295

2950

2296

def main():

2951

2297

2952

2298

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

2953

2299

# Parsing of options, both command line and config file

2954

2300

2955

2301

parser = argparse.ArgumentParser()

2956

2302

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

2957

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

2303

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

2958

2304

help="show version number and exit")

2959

2305

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

2960

2306

help="Bind to interface IF")

2996

2342

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

2997

2343

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

2998

2344

default=None)

2999

2345

3000

2346

options = parser.parse_args()

3001

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

3002

2353

# Default values for config file for server-global settings

3003

if gnutls.has_rawpk:

3004

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

3005

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

3006

else:

3007

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

3008

":+SIGN-DSA-SHA256")

3009

server_defaults = {"interface": "",

3010

"address": "",

3011

"port": "",

3012

"debug": "False",

3013

"priority": priority,

3014

"servicename": "Mandos",

3015

"use_dbus": "True",

3016

"use_ipv6": "True",

3017

"debuglevel": "",

3018

"restore": "True",

3019

"socket": "",

3020

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

3021

"foreground": "False",

3022

"zeroconf": "True",

3023

}

3024

del priority

3025

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

3026

2371

# Parse config file for server-global settings

3027

server_config = configparser.ConfigParser(server_defaults)

2372

server_config = configparser.SafeConfigParser(server_defaults)

3028

2373

del server_defaults

3029

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

3030

# 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

3031

2377

server_settings = server_config.defaults()

3032

2378

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

3033

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

3034

"foreground", "zeroconf"):

2379

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

3035

2380

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

3036

2381

option)

3037

2382

if server_settings["port"]:

3047

2392

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

3048

2393

["socket"])

3049

2394

del server_config

3050

2395

3051

2396

# Override the settings from the config file with command line

3052

2397

# options, if set.

3053

2398

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

3054

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

3055

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

3056

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

2399

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

2400

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

2401

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

3057

2402

value = getattr(options, option)

3058

2403

if value is not None:

3059

2404

server_settings[option] = value

3071

2416

if server_settings["debug"]:

3072

2417

server_settings["foreground"] = True

3073

2418

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

3074

2419

3075

2420

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

3076

3077

if (not server_settings["zeroconf"]

3078

and not (server_settings["port"]

3079

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

3080

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

3081

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

3082

2428

# For convenience

3083

2429

debug = server_settings["debug"]

3084

2430

debuglevel = server_settings["debuglevel"]

3088

2434

stored_state_file)

3089

2435

foreground = server_settings["foreground"]

3090

2436

zeroconf = server_settings["zeroconf"]

3091

2437

3092

2438

if debug:

3093

2439

initlogger(debug, logging.DEBUG)

3094

2440

else:

3097

2443

else:

3098

2444

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

3099

2445

initlogger(debug, level)

3100

2446

3101

2447

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

3102

syslogger.setFormatter(

3103

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

3104

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

3105

server_settings["servicename"])))

3106

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3107

2454

# Parse config file with clients

3108

client_config = configparser.ConfigParser(Client.client_defaults)

2455

client_config = configparser.SafeConfigParser(Client

2456

.client_defaults)

3109

2457

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

3110

2458

"clients.conf"))

3111

2459

3112

2460

global mandos_dbus_service

3113

2461

mandos_dbus_service = None

3114

2462

3115

2463

socketfd = None

3116

2464

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

3117

2465

socketfd = server_settings["socket"]

3118

tcp_server = MandosServer(

3119

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

3120

ClientHandler,

3121

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

3122

use_ipv6=use_ipv6,

3123

gnutls_priority=server_settings["priority"],

3124

use_dbus=use_dbus,

3125

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)

3126

2476

if not foreground:

3127

2477

pidfilename = "/run/mandos.pid"

3128

2478

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

3129

2479

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

3130

2480

pidfile = None

3131

2481

try:

3132

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

2482

pidfile = open(pidfilename, "w")

3133

2483

except IOError as e:

3134

2484

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

3135

2485

exc_info=e)

3136

3137

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

3138

("mandos", "mandos"),

3139

("nobody", "nogroup")):

2486

2487

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

3140

2488

try:

3141

2489

uid = pwd.getpwnam(name).pw_uid

3142

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

3143

2491

break

3144

2492

except KeyError:

3145

2493

continue

3149

2497

try:

3150

2498

os.setgid(gid)

3151

2499

os.setuid(uid)

3152

if debug:

3153

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

3154

gid))

3155

2500

except OSError as error:

3156

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

3157

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

3158

2501

if error.errno != errno.EPERM:

3159

2502

raise

3160

2503

3161

2504

if debug:

3162

2505

# Enable all possible GnuTLS debugging

3163

2506

3164

2507

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

3165

2508

# - GnuTLS manual

3166

gnutls.global_set_log_level(11)

3167

3168

@gnutls.log_func

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3169

2512

def debug_gnutls(level, string):

3170

2513

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

3171

3172

gnutls.global_set_log_function(debug_gnutls)

3173

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3174

2518

# Redirect stdin so all checkers get /dev/null

3175

2519

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

3176

2520

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

3177

2521

if null > 2:

3178

2522

os.close(null)

3179

2523

3180

2524

# Need to fork before connecting to D-Bus

3181

2525

if not foreground:

3182

2526

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

3183

2527

daemon()

3184

3185

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

3186

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

3187

# need to inform GLib that threads will be used.

3188

GLib.threads_init()

3189

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

3190

2533

global main_loop

3191

2534

# From the Avahi example code

3192

2535

DBusGMainLoop(set_as_default=True)

3193

main_loop = GLib.MainLoop()

2536

main_loop = gobject.MainLoop()

3194

2537

bus = dbus.SystemBus()

3195

2538

# End of Avahi example code

3196

2539

if use_dbus:

3197

2540

try:

3198

2541

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

3199

bus,

3200

do_not_queue=True)

3201

old_bus_name = dbus.service.BusName(

3202

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

3203

do_not_queue=True)

3204

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:

3205

2547

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

3206

2548

use_dbus = False

3207

2549

server_settings["use_dbus"] = False

3208

2550

tcp_server.use_dbus = False

3209

2551

if zeroconf:

3210

2552

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3211

service = AvahiServiceToSyslog(

3212

name=server_settings["servicename"],

3213

servicetype="_mandos._tcp",

3214

protocol=protocol,

3215

bus=bus)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3216

2557

if server_settings["interface"]:

3217

service.interface = if_nametoindex(

3218

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

3219

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3220

2562

global multiprocessing_manager

3221

2563

multiprocessing_manager = multiprocessing.Manager()

3222

2564

3223

2565

client_class = Client

3224

2566

if use_dbus:

3225

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

3226

2567

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

2568

3227

2569

client_settings = Client.config_parser(client_config)

3228

2570

old_client_settings = {}

3229

2571

clients_data = {}

3230

2572

3231

2573

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

3232

2574

global wnull

3233

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

2575

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

3234

2576

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

3235

2577

# mode

3236

2578

if debug or not foreground:

3237

2579

wnull.close()

3238

2580

3239

2581

# Get client data and settings from last running state.

3240

2582

if server_settings["restore"]:

3241

2583

try:

3242

2584

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

3243

if sys.version_info.major == 2:

3244

clients_data, old_client_settings = pickle.load(

3245

stored_state)

3246

else:

3247

bytes_clients_data, bytes_old_client_settings = (

3248

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

3249

# Fix bytes to strings

3250

# clients_data

3251

# .keys()

3252

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

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_clients_data.items()}

3257

del bytes_clients_data

3258

for key in clients_data:

3259

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

3260

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

3261

for k, v in

3262

clients_data[key].items()}

3263

clients_data[key] = value

3264

# .client_structure

3265

value["client_structure"] = [

3266

(s.decode("utf-8")

3267

if isinstance(s, bytes)

3268

else s) for s in

3269

value["client_structure"]]

3270

# .name, .host, and .checker_command

3271

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

3272

if isinstance(value[k], bytes):

3273

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

3274

if "key_id" not in value:

3275

value["key_id"] = ""

3276

elif "fingerprint" not in value:

3277

value["fingerprint"] = ""

3278

# old_client_settings

3279

# .keys()

3280

old_client_settings = {

3281

(key.decode("utf-8")

3282

if isinstance(key, bytes)

3283

else key): value

3284

for key, value in

3285

bytes_old_client_settings.items()}

3286

del bytes_old_client_settings

3287

# .host and .checker_command

3288

for value in old_client_settings.values():

3289

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

3290

if isinstance(value[attribute], bytes):

3291

value[attribute] = (value[attribute]

3292

.decode("utf-8"))

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3293

2587

os.remove(stored_state_path)

3294

2588

except IOError as e:

3295

2589

if e.errno == errno.ENOENT:

3296

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

3297

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

2590

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

2591

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

3298

2592

else:

3299

2593

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

3300

2594

exc_info=e)

3301

2595

raise

3302

2596

except EOFError as e:

3303

2597

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

3304

"EOFError:",

3305

exc_info=e)

3306

2598

"EOFError:", exc_info=e)

2599

3307

2600

with PGPEngine() as pgp:

3308

2601

for client_name, client in clients_data.items():

3309

2602

# Skip removed clients

3310

2603

if client_name not in client_settings:

3311

2604

continue

3312

2605

3313

2606

# Decide which value to use after restoring saved state.

3314

2607

# We have three different values: Old config file,

3315

2608

# new config file, and saved state.

3320

2613

# For each value in new config, check if it

3321

2614

# differs from the old config value (Except for

3322

2615

# the "secret" attribute)

3323

if (name != "secret"

3324

and (value !=

3325

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3326

2619

client[name] = value

3327

2620

except KeyError:

3328

2621

pass

3329

2622

3330

2623

# Clients who has passed its expire date can still be

3331

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3332

2625

# whose checker succeeded before we stored its state is

3333

2626

# assumed to have successfully run all checkers during

3334

2627

# downtime.

3337

2630

if not client["last_checked_ok"]:

3338

2631

logger.warning(

3339

2632

"disabling client {} - Client never "

3340

"performed a successful checker".format(

3341

client_name))

2633

"performed a successful checker"

2634

.format(client_name))

3342

2635

client["enabled"] = False

3343

2636

elif client["last_checker_status"] != 0:

3344

2637

logger.warning(

3345

2638

"disabling client {} - Client last"

3346

" checker failed with error code"

3347

" {}".format(

3348

client_name,

3349

client["last_checker_status"]))

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3350

2642

client["enabled"] = False

3351

2643

else:

3352

client["expires"] = (

3353

datetime.datetime.utcnow()

3354

+ client["timeout"])

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3355

2647

logger.debug("Last checker succeeded,"

3356

" keeping {} enabled".format(

3357

client_name))

2648

" keeping {} enabled"

2649

.format(client_name))

3358

2650

try:

3359

client["secret"] = pgp.decrypt(

3360

client["encrypted_secret"],

3361

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3362

2655

except PGPError:

3363

2656

# If decryption fails, we use secret from new settings

3364

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

3365

client_name))

3366

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

3367

["secret"])

3368

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3369

2662

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

3370

2663

for client_name in (set(old_client_settings)

3371

2664

- set(client_settings)):

3373

2666

for client_name in (set(client_settings)

3374

2667

- set(old_client_settings)):

3375

2668

clients_data[client_name] = client_settings[client_name]

3376

2669

3377

2670

# Create all client objects

3378

2671

for client_name, client in clients_data.items():

3379

2672

tcp_server.clients[client_name] = client_class(

3380

name=client_name,

3381

settings=client,

3382

server_settings=server_settings)

3383

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3384

2676

if not tcp_server.clients:

3385

2677

logger.warning("No clients defined")

3386

2678

3387

2679

if not foreground:

3388

2680

if pidfile is not None:

3389

pid = os.getpid()

3390

2681

try:

3391

2682

with pidfile:

3392

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3393

2685

except IOError:

3394

2686

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

3395

2687

pidfilename, pid)

3396

2688

del pidfile

3397

2689

del pidfilename

3398

3399

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

3400

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3401

lambda: main_loop.quit() and False)

3402

2690

2691

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

2692

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

2693

3403

2694

if use_dbus:

3404

3405

@alternate_dbus_interfaces(

3406

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

3407

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3408

2698

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

3409

3410

2699

def __init__(self):

3411

2700

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

3412

3413

2701

_interface = "se.recompile.Mandos"

3414

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3415

2709

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

3416

2710

def ClientAdded(self, objpath):

3417

2711

"D-Bus signal"

3418

2712

pass

3419

2713

3420

2714

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

3421

def ClientNotFound(self, key_id, address):

2715

def ClientNotFound(self, fingerprint, address):

3422

2716

"D-Bus signal"

3423

2717

pass

3424

3425

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

3426

"true"})

2718

3427

2719

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

3428

2720

def ClientRemoved(self, objpath, name):

3429

2721

"D-Bus signal"

3430

2722

pass

3431

3432

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

3433

"true"})

2723

3434

2724

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

3435

2725

def GetAllClients(self):

3436

2726

"D-Bus method"

3437

return dbus.Array(c.dbus_object_path for c in

3438

tcp_server.clients.values())

3439

3440

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

3441

"true"})

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3442

2731

@dbus.service.method(_interface,

3443

2732

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

3444

2733

def GetAllClientsWithProperties(self):

3445

2734

"D-Bus method"

3446

2735

return dbus.Dictionary(

3447

{c.dbus_object_path: c.GetAll(

3448

"se.recompile.Mandos.Client")

3449

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

2736

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

2737

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

3450

2738

signature="oa{sv}")

3451

2739

3452

2740

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

3453

2741

def RemoveClient(self, object_path):

3454

2742

"D-Bus method"

3455

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3456

2744

if c.dbus_object_path == object_path:

3457

2745

del tcp_server.clients[c.name]

3458

2746

c.remove_from_connection()

3459

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3460

2748

c.disable(quiet=True)

3461

# Emit D-Bus signal for removal

3462

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3463

2751

return

3464

2752

raise KeyError(object_path)

3465

2753

3466

2754

del _interface

3467

3468

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3469

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

3470

def GetManagedObjects(self):

3471

"""D-Bus method"""

3472

return dbus.Dictionary(

3473

{client.dbus_object_path:

3474

dbus.Dictionary(

3475

{interface: client.GetAll(interface)

3476

for interface in

3477

client._get_all_interface_names()})

3478

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

3479

3480

def client_added_signal(self, client):

3481

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

3482

if use_dbus:

3483

# New standard signal

3484

self.InterfacesAdded(

3485

client.dbus_object_path,

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()}))

3490

# Old signal

3491

self.ClientAdded(client.dbus_object_path)

3492

3493

def client_removed_signal(self, client):

3494

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

3495

if use_dbus:

3496

# New standard signal

3497

self.InterfacesRemoved(

3498

client.dbus_object_path,

3499

client._get_all_interface_names())

3500

# Old signal

3501

self.ClientRemoved(client.dbus_object_path,

3502

client.name)

3503

2755

3504

2756

mandos_dbus_service = MandosDBusService()

3505

3506

# Save modules to variables to exempt the modules from being

3507

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

3508

mp = multiprocessing

3509

wn = wnull

3510

2757

3511

2758

def cleanup():

3512

2759

"Cleanup function; run on exit"

3513

2760

if zeroconf:

3514

2761

service.cleanup()

3515

3516

mp.active_children()

3517

wn.close()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3518

2765

if not (tcp_server.clients or client_settings):

3519

2766

return

3520

2767

3521

2768

# Store client before exiting. Secrets are encrypted with key

3522

2769

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

3523

2770

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

3524

2771

clients = {}

3525

2772

with PGPEngine() as pgp:

3526

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3527

2774

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

3528

2775

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

3529

2776

key)

3530

2777

client_dict = {}

3531

2778

3532

2779

# A list of attributes that can not be pickled

3533

2780

# + secret.

3534

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

3535

"checker", "server_settings"}

3536

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

3537

.Object):

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3538

2785

exclude.add(name)

3539

2786

3540

2787

client_dict["encrypted_secret"] = (client

3541

2788

.encrypted_secret)

3542

2789

for attr in client.client_structure:

3543

2790

if attr not in exclude:

3544

2791

client_dict[attr] = getattr(client, attr)

3545

2792

3546

2793

clients[client.name] = client_dict

3547

2794

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

3548

2795

3549

2796

try:

3550

with tempfile.NamedTemporaryFile(

3551

mode='wb',

3552

suffix=".pickle",

3553

prefix='clients-',

3554

dir=os.path.dirname(stored_state_path),

3555

delete=False) as stored_state:

3556

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

3557

protocol=2)

3558

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

3559

2803

os.rename(tempname, stored_state_path)

3560

2804

except (IOError, OSError) as e:

3561

2805

if not debug:

3570

2814

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

3571

2815

exc_info=e)

3572

2816

raise

3573

2817

3574

2818

# Delete all clients, and settings from config

3575

2819

while tcp_server.clients:

3576

2820

name, client = tcp_server.clients.popitem()

3577

2821

if use_dbus:

3578

2822

client.remove_from_connection()

3579

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3580

2824

client.disable(quiet=True)

3581

# Emit D-Bus signal for removal

3582

2825

if use_dbus:

3583

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)

3584

2830

client_settings.clear()

3585

2831

3586

2832

atexit.register(cleanup)

3587

3588

for client in tcp_server.clients.values():

2833

2834

for client in tcp_server.clients.itervalues():

3589

2835

if use_dbus:

3590

# Emit D-Bus signal for adding

3591

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3592

2838

# Need to initiate checking of clients

3593

2839

if client.enabled:

3594

2840

client.init_checker()

3595

2841

3596

2842

tcp_server.enable()

3597

2843

tcp_server.server_activate()

3598

2844

3599

2845

# Find out what port we got

3600

2846

if zeroconf:

3601

2847

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

3606

2852

else: # IPv4

3607

2853

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

3608

2854

*tcp_server.socket.getsockname())

3609

3610

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

3611

2855

2856

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

2857

3612

2858

try:

3613

2859

if zeroconf:

3614

2860

# From the Avahi example code

3619

2865

cleanup()

3620

2866

sys.exit(1)

3621

2867

# End of Avahi example code

3622

3623

GLib.io_add_watch(

3624

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

3625

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3626

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

3627

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

3628

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

3629

2874

logger.debug("Starting main loop")

3630

2875

main_loop.run()

3631

2876

except AvahiError as error:

3640

2885

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

3641

2886

cleanup()

3642

2887

3643

3644

def should_only_run_tests():

3645

parser = argparse.ArgumentParser(add_help=False)

3646

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

3647

args, unknown_args = parser.parse_known_args()

3648

run_tests = args.check

3649

if run_tests:

3650

# Remove --check argument from sys.argv

3651

sys.argv[1:] = unknown_args

3652

return run_tests

3653

3654

# Add all tests from doctest strings

3655

def load_tests(loader, tests, none):

3656

import doctest

3657

tests.addTests(doctest.DocTestSuite())

3658

return tests

3659

3660

2888

if __name__ == '__main__':

3661

try:

3662

if should_only_run_tests():

3663

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

3664

unittest.main()

3665

else:

3666

main()

3667

finally:

3668

logging.shutdown()

2889

main()