/mandos/trunk : revision 738.1.1

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

72

84

73

import dbus

85

74

import dbus.service

86

import gi

87

from gi.repository import GLib

75

import gobject

76

import avahi

88

77

from dbus.mainloop.glib import DBusGMainLoop

89

78

import ctypes

90

79

import ctypes.util

91

80

import xml.dom.minidom

92

81

import inspect

93

82

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.14"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

147

95

stored_state_file = "clients.pickle"

148

96

149

97

logger = logging.getLogger()

150

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

151

98

syslogger = None

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

165

112

return interface_index

166

113

167

114

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

115

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

185

116

"""init logger and add loglevel"""

186

117

187

118

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

191

123

syslogger.setFormatter(logging.Formatter

192

124

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

193

125

' %(message)s'))

194

126

logger.addHandler(syslogger)

195

127

196

128

if debug:

197

129

console = logging.StreamHandler()

198

130

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

208

140

pass

209

141

210

142

211

class PGPEngine:

143

class PGPEngine(object):

212

144

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

213

214

145

def __init__(self):

215

146

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

147

self.gnupgargs = ['--batch',

228

'--homedir', self.tempdir,

148

'--home', self.tempdir,

229

149

'--force-mdc',

230

'--quiet']

231

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

232

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

233

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

234

150

'--quiet',

151

'--no-use-agent']

152

235

153

def __enter__(self):

236

154

return self

237

155

238

156

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

239

157

self._cleanup()

240

158

return False

241

159

242

160

def __del__(self):

243

161

self._cleanup()

244

162

245

163

def _cleanup(self):

246

164

if self.tempdir is not None:

247

165

# Delete contents of tempdir

248

166

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

249

topdown=False):

167

topdown = False):

250

168

for filename in files:

251

169

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

252

170

for dirname in dirs:

254

172

# Remove tempdir

255

173

os.rmdir(self.tempdir)

256

174

self.tempdir = None

257

175

258

176

def password_encode(self, password):

259

177

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

260

178

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

265

183

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

266

184

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

267

185

return encoded

268

186

269

187

def encrypt(self, data, password):

270

188

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

273

191

passfile.write(passphrase)

274

192

passfile.flush()

275

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

193

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

276

194

'--passphrase-file',

277

195

passfile.name]

278

196

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

283

201

if proc.returncode != 0:

284

202

raise PGPError(err)

285

203

return ciphertext

286

204

287

205

def decrypt(self, data, password):

288

206

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

291

209

passfile.write(passphrase)

292

210

passfile.flush()

293

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

211

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

294

212

'--passphrase-file',

295

213

passfile.name]

296

214

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

301

220

if proc.returncode != 0:

302

221

raise PGPError(err)

303

222

return decrypted_plaintext

304

223

305

224

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

225

class AvahiError(Exception):

333

226

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

334

227

self.value = value

335

228

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

336

229

**kwargs)

337

230

338

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

277

394

278

def rename(self, remove=True):

395

279

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

396

280

if self.rename_count >= self.max_renames:

398

282

" after %i retries, exiting.",

399

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

403

287

self.rename_count += 1

404

288

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

405

289

self.name)

416

300

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

417

301

self.cleanup()

418

302

os._exit(1)

419

303

420

304

def remove(self):

421

305

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

422

306

if self.entry_group_state_changed_match is not None:

424

308

self.entry_group_state_changed_match = None

425

309

if self.group is not None:

426

310

self.group.Reset()

427

311

428

312

def add(self):

429

313

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

430

314

self.remove()

447

331

dbus.UInt16(self.port),

448

332

avahi.string_array_to_txt_array(self.TXT))

449

333

self.group.Commit()

450

334

451

335

def entry_group_state_changed(self, state, error):

452

336

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

453

337

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

454

338

455

339

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

340

logger.debug("Zeroconf service established.")

457

341

elif state == avahi.ENTRY_GROUP_COLLISION:

460

344

elif state == avahi.ENTRY_GROUP_FAILURE:

461

345

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

462

346

str(error))

463

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

464

347

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

348

.format(error))

349

465

350

def cleanup(self):

466

351

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

467

352

if self.group is not None:

472

357

pass

473

358

self.group = None

474

359

self.remove()

475

360

476

361

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

477

362

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

478

363

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

485

371

if state in bad_states:

486

372

if bad_states[state] is not None:

487

373

if error is None:

490

376

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

491

377

self.cleanup()

492

378

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

379

self.add()

505

380

else:

506

381

if error is None:

507

382

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

508

383

else:

509

384

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

510

385

511

386

def activate(self):

512

387

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

513

388

if self.server is None:

517

392

follow_name_owner_changes=True),

518

393

avahi.DBUS_INTERFACE_SERVER)

519

394

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

395

self.server_state_changed)

521

396

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

522

397

523

398

524

399

class AvahiServiceToSyslog(AvahiService):

525

400

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

526

401

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

402

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

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

532

407

return ret

533

408

534

409

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

('size', ctypes.c_uint)]

579

580

class openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code)

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

# Classes

605

class Credentials:

606

def __init__(self):

607

self._c_object = gnutls.certificate_credentials_t()

608

gnutls.certificate_allocate_credentials(

609

ctypes.byref(self._c_object))

610

self.type = gnutls.CRD_CERTIFICATE

611

612

def __del__(self):

613

gnutls.certificate_free_credentials(self._c_object)

614

615

class ClientSession:

616

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

617

self._c_object = gnutls.session_t()

618

gnutls_flags = gnutls.CLIENT

619

if gnutls.check_version(b"3.5.6"):

620

gnutls_flags |= gnutls.NO_TICKETS

621

if gnutls.has_rawpk:

622

gnutls_flags |= gnutls.ENABLE_RAWPK

623

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

624

del gnutls_flags

625

gnutls.set_default_priority(self._c_object)

626

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

627

gnutls.handshake_set_private_extensions(self._c_object,

628

True)

629

self.socket = socket

630

if credentials is None:

631

credentials = gnutls.Credentials()

632

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

633

ctypes.cast(credentials._c_object,

634

ctypes.c_void_p))

635

self.credentials = credentials

636

637

def __del__(self):

638

gnutls.deinit(self._c_object)

639

640

def handshake(self):

641

return gnutls.handshake(self._c_object)

642

643

def send(self, data):

644

data = bytes(data)

645

data_len = len(data)

646

while data_len > 0:

647

data_len -= gnutls.record_send(self._c_object,

648

data[-data_len:],

649

data_len)

650

651

def bye(self):

652

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

653

654

# Error handling functions

655

def _error_code(result):

656

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

657

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

658

if result >= 0:

659

return result

660

if result == gnutls.E_NO_CERTIFICATE_FOUND:

661

raise gnutls.CertificateSecurityError(code=result)

662

raise gnutls.Error(code=result)

663

664

def _retry_on_error(result, func, arguments,

665

_error_code=_error_code):

666

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

667

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

668

while result < 0:

669

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

670

return _error_code(result)

671

result = func(*arguments)

672

return result

673

674

# Unless otherwise indicated, the function declarations below are

675

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

676

677

# Functions

678

priority_set_direct = _library.gnutls_priority_set_direct

679

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

680

ctypes.POINTER(ctypes.c_char_p)]

681

priority_set_direct.restype = _error_code

682

683

init = _library.gnutls_init

684

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

685

init.restype = _error_code

686

687

set_default_priority = _library.gnutls_set_default_priority

688

set_default_priority.argtypes = [session_t]

689

set_default_priority.restype = _error_code

690

691

record_send = _library.gnutls_record_send

692

record_send.argtypes = [session_t, ctypes.c_void_p,

693

ctypes.c_size_t]

694

record_send.restype = ctypes.c_ssize_t

695

record_send.errcheck = _retry_on_error

696

697

certificate_allocate_credentials = (

698

_library.gnutls_certificate_allocate_credentials)

699

certificate_allocate_credentials.argtypes = [

700

ctypes.POINTER(certificate_credentials_t)]

701

certificate_allocate_credentials.restype = _error_code

702

703

certificate_free_credentials = (

704

_library.gnutls_certificate_free_credentials)

705

certificate_free_credentials.argtypes = [

706

certificate_credentials_t]

707

certificate_free_credentials.restype = None

708

709

handshake_set_private_extensions = (

710

_library.gnutls_handshake_set_private_extensions)

711

handshake_set_private_extensions.argtypes = [session_t,

712

ctypes.c_int]

713

handshake_set_private_extensions.restype = None

714

715

credentials_set = _library.gnutls_credentials_set

716

credentials_set.argtypes = [session_t, credentials_type_t,

717

ctypes.c_void_p]

718

credentials_set.restype = _error_code

719

720

strerror = _library.gnutls_strerror

721

strerror.argtypes = [ctypes.c_int]

722

strerror.restype = ctypes.c_char_p

723

724

certificate_type_get = _library.gnutls_certificate_type_get

725

certificate_type_get.argtypes = [session_t]

726

certificate_type_get.restype = _error_code

727

728

certificate_get_peers = _library.gnutls_certificate_get_peers

729

certificate_get_peers.argtypes = [session_t,

730

ctypes.POINTER(ctypes.c_uint)]

731

certificate_get_peers.restype = ctypes.POINTER(datum_t)

732

733

global_set_log_level = _library.gnutls_global_set_log_level

734

global_set_log_level.argtypes = [ctypes.c_int]

735

global_set_log_level.restype = None

736

737

global_set_log_function = _library.gnutls_global_set_log_function

738

global_set_log_function.argtypes = [log_func]

739

global_set_log_function.restype = None

740

741

deinit = _library.gnutls_deinit

742

deinit.argtypes = [session_t]

743

deinit.restype = None

744

745

handshake = _library.gnutls_handshake

746

handshake.argtypes = [session_t]

747

handshake.restype = _error_code

748

handshake.errcheck = _retry_on_error

749

750

transport_set_ptr = _library.gnutls_transport_set_ptr

751

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

752

transport_set_ptr.restype = None

753

754

bye = _library.gnutls_bye

755

bye.argtypes = [session_t, close_request_t]

756

bye.restype = _error_code

757

bye.errcheck = _retry_on_error

758

759

check_version = _library.gnutls_check_version

760

check_version.argtypes = [ctypes.c_char_p]

761

check_version.restype = ctypes.c_char_p

762

763

_need_version = b"3.3.0"

764

if check_version(_need_version) is None:

765

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

766

.format(_need_version))

767

768

_tls_rawpk_version = b"3.6.6"

769

has_rawpk = bool(check_version(_tls_rawpk_version))

770

771

if has_rawpk:

772

# Types

773

class pubkey_st(ctypes.Structure):

774

_fields = []

775

pubkey_t = ctypes.POINTER(pubkey_st)

776

777

x509_crt_fmt_t = ctypes.c_int

778

779

# All the function declarations below are from

780

# gnutls/abstract.h

781

pubkey_init = _library.gnutls_pubkey_init

782

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

783

pubkey_init.restype = _error_code

784

785

pubkey_import = _library.gnutls_pubkey_import

786

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

787

x509_crt_fmt_t]

788

pubkey_import.restype = _error_code

789

790

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

791

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

792

ctypes.POINTER(ctypes.c_ubyte),

793

ctypes.POINTER(ctypes.c_size_t)]

794

pubkey_get_key_id.restype = _error_code

795

796

pubkey_deinit = _library.gnutls_pubkey_deinit

797

pubkey_deinit.argtypes = [pubkey_t]

798

pubkey_deinit.restype = None

799

else:

800

# All the function declarations below are from

801

# gnutls/openpgp.h

802

803

openpgp_crt_init = _library.gnutls_openpgp_crt_init

804

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

805

openpgp_crt_init.restype = _error_code

806

807

openpgp_crt_import = _library.gnutls_openpgp_crt_import

808

openpgp_crt_import.argtypes = [openpgp_crt_t,

809

ctypes.POINTER(datum_t),

810

openpgp_crt_fmt_t]

811

openpgp_crt_import.restype = _error_code

812

813

openpgp_crt_verify_self = \

814

_library.gnutls_openpgp_crt_verify_self

815

openpgp_crt_verify_self.argtypes = [

816

openpgp_crt_t,

817

ctypes.c_uint,

818

ctypes.POINTER(ctypes.c_uint),

819

]

820

openpgp_crt_verify_self.restype = _error_code

821

822

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

823

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

824

openpgp_crt_deinit.restype = None

825

826

openpgp_crt_get_fingerprint = (

827

_library.gnutls_openpgp_crt_get_fingerprint)

828

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

829

ctypes.c_void_p,

830

ctypes.POINTER(

831

ctypes.c_size_t)]

832

openpgp_crt_get_fingerprint.restype = _error_code

833

834

if check_version(b"3.6.4"):

835

certificate_type_get2 = _library.gnutls_certificate_type_get2

836

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

837

certificate_type_get2.restype = _error_code

838

839

# Remove non-public functions

840

del _error_code, _retry_on_error

841

842

843

def call_pipe(connection, # : multiprocessing.Connection

844

func, *args, **kwargs):

845

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

846

847

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

848

return value on the provided multiprocessing.Connection.

849

"""

850

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

851

connection.close()

852

853

854

class Client:

410

class Client(object):

855

411

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

856

412

857

413

Attributes:

858

414

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

859

415

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

860

416

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

861

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

862

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

863

running.

864

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

865

421

checker_command: string; External command which is run to check

866

422

if client lives. %() expansions are done at

867

423

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

868

424

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

869

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

870

426

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

871

427

client_structure: Object describing what attributes a client has

872

428

and is used for storing the client at exit

873

429

current_checker_command: string; current running checker_command

874

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

875

431

enabled: bool()

876

432

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

877

uniquely identify an OpenPGP client

878

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

879

a client using raw public keys

433

uniquely identify the client

880

434

host: string; available for use by the checker command

881

435

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

882

436

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

884

438

last_checker_status: integer between 0 and 255 reflecting exit

885

439

status of last checker. -1 reflects crashed

886

440

checker, -2 means no checker completed yet.

887

last_checker_signal: The signal which killed the last checker, if

888

last_checker_status is -1

889

441

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

890

442

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

891

443

D-Bus identifiers

898

450

disabled, or None

899

451

server_settings: The server_settings dict from main()

900

452

"""

901

453

902

454

runtime_expansions = ("approval_delay", "approval_duration",

903

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

455

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

904

456

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

905

457

"last_approval_request", "last_checked_ok",

906

458

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

907

client_defaults = {

908

"timeout": "PT5M",

909

"extended_timeout": "PT15M",

910

"interval": "PT2M",

911

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

912

"host": "",

913

"approval_delay": "PT0S",

914

"approval_duration": "PT1S",

915

"approved_by_default": "True",

916

"enabled": "True",

917

}

918

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

919

470

@staticmethod

920

471

def config_parser(config):

921

472

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

928

479

for client_name in config.sections():

929

480

section = dict(config.items(client_name))

930

481

client = settings[client_name] = {}

931

482

932

483

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

933

484

# Reformat values from string types to Python types

934

485

client["approved_by_default"] = config.getboolean(

935

486

client_name, "approved_by_default")

936

487

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

937

488

"enabled")

938

939

# Uppercase and remove spaces from key_id and fingerprint

940

# for later comparison purposes with return value from the

941

# key_id() and fingerprint() functions

942

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

943

.replace(" ", ""))

489

944

490

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

945

491

.replace(" ", ""))

946

492

if "secret" in section:

947

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

948

.encode("utf-8"),

949

"base64")

493

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

950

494

elif "secfile" in section:

951

495

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

952

496

(section["secfile"])),

967

511

client["last_approval_request"] = None

968

512

client["last_checked_ok"] = None

969

513

client["last_checker_status"] = -2

970

514

971

515

return settings

972

973

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

516

517

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

974

518

self.name = name

975

519

if server_settings is None:

976

520

server_settings = {}

978

522

# adding all client settings

979

523

for setting, value in settings.items():

980

524

setattr(self, setting, value)

981

525

982

526

if self.enabled:

983

527

if not hasattr(self, "last_enabled"):

984

528

self.last_enabled = datetime.datetime.utcnow()

988

532

else:

989

533

self.last_enabled = None

990

534

self.expires = None

991

535

992

536

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

993

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

994

540

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

995

541

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

996

542

datetime.datetime.utcnow())

997

543

998

544

# attributes specific for this server instance

999

545

self.checker = None

1000

546

self.checker_initiator_tag = None

1003

549

self.current_checker_command = None

1004

550

self.approved = None

1005

551

self.approvals_pending = 0

1006

self.changedstate = multiprocessing_manager.Condition(

1007

multiprocessing_manager.Lock())

1008

self.client_structure = [attr

1009

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

1010

557

if not attr.startswith("_")]

1011

558

self.client_structure.append("client_structure")

1012

1013

for name, t in inspect.getmembers(

1014

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

1015

564

if not name.startswith("_"):

1016

565

self.client_structure.append(name)

1017

566

1018

567

# Send notice to process children that client state has changed

1019

568

def send_changedstate(self):

1020

569

with self.changedstate:

1021

570

self.changedstate.notify_all()

1022

571

1023

572

def enable(self):

1024

573

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

1025

574

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

1030

579

self.last_enabled = datetime.datetime.utcnow()

1031

580

self.init_checker()

1032

581

self.send_changedstate()

1033

582

1034

583

def disable(self, quiet=True):

1035

584

"""Disable this client."""

1036

585

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

1038

587

if not quiet:

1039

588

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

1040

589

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

1041

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

1042

591

self.disable_initiator_tag = None

1043

592

self.expires = None

1044

593

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

1045

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

1046

595

self.checker_initiator_tag = None

1047

596

self.stop_checker()

1048

597

self.enabled = False

1049

598

if not quiet:

1050

599

self.send_changedstate()

1051

# 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

1052

601

return False

1053

602

1054

603

def __del__(self):

1055

604

self.disable()

1056

605

1057

606

def init_checker(self):

1058

607

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

1059

608

# and every interval from then on.

1060

609

if self.checker_initiator_tag is not None:

1061

GLib.source_remove(self.checker_initiator_tag)

1062

self.checker_initiator_tag = GLib.timeout_add(

1063

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

1064

+ 1)),

1065

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

1066

615

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

1067

616

if self.disable_initiator_tag is not None:

1068

GLib.source_remove(self.disable_initiator_tag)

1069

self.disable_initiator_tag = GLib.timeout_add(

1070

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

1071

622

# Also start a new checker *right now*.

1072

623

self.start_checker()

1073

1074

def checker_callback(self, source, condition, connection,

1075

command):

624

625

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

1076

626

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

1077

# Read return code from connection (see call_pipe)

1078

returncode = connection.recv()

1079

connection.close()

1080

if self.checker is not None:

1081

self.checker.join()

1082

627

self.checker_callback_tag = None

1083

628

self.checker = None

1084

1085

if returncode >= 0:

1086

self.last_checker_status = returncode

1087

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1088

631

if self.last_checker_status == 0:

1089

632

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

1090

633

vars(self))

1091

634

self.checked_ok()

1092

635

else:

1093

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

636

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

637

vars(self))

1094

638

else:

1095

639

self.last_checker_status = -1

1096

self.last_checker_signal = -returncode

1097

640

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

1098

641

vars(self))

1099

return False

1100

642

1101

643

def checked_ok(self):

1102

644

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

1103

645

self.last_checked_ok = datetime.datetime.utcnow()

1104

646

self.last_checker_status = 0

1105

self.last_checker_signal = None

1106

647

self.bump_timeout()

1107

648

1108

649

def bump_timeout(self, timeout=None):

1109

650

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

1110

651

if timeout is None:

1111

652

timeout = self.timeout

1112

653

if self.disable_initiator_tag is not None:

1113

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1114

655

self.disable_initiator_tag = None

1115

656

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

1116

self.disable_initiator_tag = GLib.timeout_add(

1117

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1118

660

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

1119

661

1120

662

def need_approval(self):

1121

663

self.last_approval_request = datetime.datetime.utcnow()

1122

664

1123

665

def start_checker(self):

1124

666

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

1125

667

1126

668

If a checker already exists, leave it running and do

1127

669

nothing."""

1128

670

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

1133

675

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

1134

676

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

1135

677

# should be.

1136

1137

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

1138

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

1139

self.checker.join()

1140

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)

1141

693

# Start a new checker if needed

1142

694

if self.checker is None:

1143

695

# Escape attributes for the shell

1144

escaped_attrs = {

1145

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

1146

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1147

699

try:

1148

700

command = self.checker_command % escaped_attrs

1149

701

except TypeError as error:

1150

702

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

1151

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

1152

727

exc_info=error)

1153

return True # Try again later

1154

self.current_checker_command = command

1155

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

1156

self.name)

1157

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

1158

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

1159

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

1160

# always replaced by /dev/null.)

1161

# The exception is when not debugging but nevertheless

1162

# running in the foreground; use the previously

1163

# created wnull.

1164

popen_args = {"close_fds": True,

1165

"shell": True,

1166

"cwd": "/"}

1167

if (not self.server_settings["debug"]

1168

and self.server_settings["foreground"]):

1169

popen_args.update({"stdout": wnull,

1170

"stderr": wnull})

1171

pipe = multiprocessing.Pipe(duplex=False)

1172

self.checker = multiprocessing.Process(

1173

target=call_pipe,

1174

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

1175

kwargs=popen_args)

1176

self.checker.start()

1177

self.checker_callback_tag = GLib.io_add_watch(

1178

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

1179

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1180

self.checker_callback, pipe[0], command)

1181

# 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

1182

748

return True

1183

749

1184

750

def stop_checker(self):

1185

751

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

1186

752

if self.checker_callback_tag:

1187

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1188

754

self.checker_callback_tag = None

1189

755

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

1190

756

return

1191

757

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

1192

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

1193

766

self.checker = None

1194

767

1195

768

1196

def dbus_service_property(dbus_interface,

1197

signature="v",

1198

access="readwrite",

1199

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1200

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1201

772

become properties on the D-Bus.

1202

773

1203

774

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

1204

775

and with one argument by "Set".

1205

776

1206

777

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

1207

778

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

1208

779

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

1212

783

if byte_arrays and signature != "ay":

1213

784

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

1214

785

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

1215

1216

786

def decorator(func):

1217

787

func._dbus_is_property = True

1218

788

func._dbus_interface = dbus_interface

1221

791

func._dbus_name = func.__name__

1222

792

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

1223

793

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

1224

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1225

795

return func

1226

1227

796

return decorator

1228

797

1229

798

1230

799

def dbus_interface_annotations(dbus_interface):

1231

800

"""Decorator for marking functions returning interface annotations

1232

801

1233

802

Usage:

1234

803

1235

804

@dbus_interface_annotations("org.example.Interface")

1236

805

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

1237

806

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

1238

807

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

1239

808

"false"}

1240

809

"""

1241

1242

810

def decorator(func):

1243

811

func._dbus_is_interface = True

1244

812

func._dbus_interface = dbus_interface

1245

813

func._dbus_name = dbus_interface

1246

814

return func

1247

1248

815

return decorator

1249

816

1250

817

1251

818

def dbus_annotations(annotations):

1252

819

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

1253

820

Usage:

1254

821

1255

822

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

1256

823

"org.freedesktop.DBus.Property."

1257

824

"EmitsChangedSignal": "false"})

1259

826

access="r")

1260

827

def Property_dbus_property(self):

1261

828

return dbus.Boolean(False)

1262

1263

See also the DBusObjectWithAnnotations class.

1264

829

"""

1265

1266

830

def decorator(func):

1267

831

func._dbus_annotations = annotations

1268

832

return func

1269

1270

833

return decorator

1271

834

1272

835

1275

838

"""

1276

839

pass

1277

840

1278

1279

841

class DBusPropertyAccessException(DBusPropertyException):

1280

842

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

1281

843

"""

1288

850

pass

1289

851

1290

852

1291

class DBusObjectWithAnnotations(dbus.service.Object):

1292

"""A D-Bus object with annotations.

1293

1294

Classes inheriting from this can use the dbus_annotations

1295

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.

1296

859

"""

1297

860

1298

861

@staticmethod

1299

862

def _is_dbus_thing(thing):

1300

863

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

1301

864

1302

865

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

1303

866

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

1304

867

"""

1305

868

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

1306

869

False)

1307

870

1308

871

def _get_all_dbus_things(self, thing):

1309

872

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

1310

873

"""

1311

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

874

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

875

name),

1312

876

athing.__get__(self))

1313

877

for cls in self.__class__.__mro__

1314

878

for name, athing in

1315

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

1316

1317

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1318

out_signature="s",

1319

path_keyword='object_path',

1320

connection_keyword='connection')

1321

def Introspect(self, object_path, connection):

1322

"""Overloading of standard D-Bus method.

1323

1324

Inserts annotation tags on methods and signals.

1325

"""

1326

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

1327

connection)

1328

try:

1329

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

1330

1331

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

1332

# Add annotation tags

1333

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

1334

for tag in if_tag.getElementsByTagName(typ):

1335

annots = dict()

1336

for name, prop in (self.

1337

_get_all_dbus_things(typ)):

1338

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

1339

and prop._dbus_interface

1340

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

1341

annots.update(getattr(

1342

prop, "_dbus_annotations", {}))

1343

for name, value in annots.items():

1344

ann_tag = document.createElement(

1345

"annotation")

1346

ann_tag.setAttribute("name", name)

1347

ann_tag.setAttribute("value", value)

1348

tag.appendChild(ann_tag)

1349

# Add interface annotation tags

1350

for annotation, value in dict(

1351

itertools.chain.from_iterable(

1352

annotations().items()

1353

for name, annotations

1354

in self._get_all_dbus_things("interface")

1355

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

1356

)).items():

1357

ann_tag = document.createElement("annotation")

1358

ann_tag.setAttribute("name", annotation)

1359

ann_tag.setAttribute("value", value)

1360

if_tag.appendChild(ann_tag)

1361

# Fix argument name for the Introspect method itself

1362

if (if_tag.getAttribute("name")

1363

== dbus.INTROSPECTABLE_IFACE):

1364

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

1365

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

1366

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

1367

if (arg.getAttribute("direction")

1368

== "out"):

1369

arg.setAttribute("name",

1370

"xml_data")

1371

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

1372

document.unlink()

1373

except (AttributeError, xml.dom.DOMException,

1374

xml.parsers.expat.ExpatError) as error:

1375

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

1376

exc_info=error)

1377

return xmlstring

1378

1379

1380

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1381

"""A D-Bus object with properties.

1382

1383

Classes inheriting from this can use the dbus_service_property

1384

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

1385

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

1386

"""

1387

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1388

882

def _get_dbus_property(self, interface_name, property_name):

1389

883

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

1390

884

property with the specified name and interface.

1391

885

"""

1392

for cls in self.__class__.__mro__:

1393

for name, value in inspect.getmembers(

1394

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

1395

890

if (value._dbus_name == property_name

1396

891

and value._dbus_interface == interface_name):

1397

892

return value.__get__(self)

1398

893

1399

894

# No such property

1400

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

1401

self.dbus_object_path, interface_name, property_name))

1402

1403

@classmethod

1404

def _get_all_interface_names(cls):

1405

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

1406

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

1407

"_dbus_interface", None)

1408

for x in (inspect.getmro(cls))

1409

for attr in dir(x))

1410

if name is not None)

1411

1412

@dbus.service.method(dbus.PROPERTIES_IFACE,

1413

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

1414

900

out_signature="v")

1415

901

def Get(self, interface_name, property_name):

1416

902

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

1422

908

if not hasattr(value, "variant_level"):

1423

909

return value

1424

910

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

1425

911

1426

912

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

1427

913

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

1428

914

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

1437

923

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

1438

924

"'ay' signature {!r}"

1439

925

.format(prop._dbus_signature))

1440

value = dbus.ByteArray(bytes(value))

926

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

927

for byte in value))

1441

928

prop(value)

1442

1443

@dbus.service.method(dbus.PROPERTIES_IFACE,

1444

in_signature="s",

929

930

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

1445

931

out_signature="a{sv}")

1446

932

def GetAll(self, interface_name):

1447

933

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

1448

934

standard.

1449

935

1450

936

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

1451

937

"""

1452

938

properties = {}

1462

948

if not hasattr(value, "variant_level"):

1463

949

properties[name] = value

1464

950

continue

1465

properties[name] = type(value)(

1466

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1467

953

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

1468

954

1469

955

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

1470

956

def PropertiesChanged(self, interface_name, changed_properties,

1471

957

invalidated_properties):

1473

959

standard.

1474

960

"""

1475

961

pass

1476

962

1477

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1478

964

out_signature="s",

1479

965

path_keyword='object_path',

1480

966

connection_keyword='connection')

1481

967

def Introspect(self, object_path, connection):

1482

968

"""Overloading of standard D-Bus method.

1483

969

1484

970

Inserts property tags and interface annotation tags.

1485

971

"""

1486

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1487

object_path,

1488

connection)

972

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

973

connection)

1489

974

try:

1490

975

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

1491

1492

976

def make_tag(document, name, prop):

1493

977

e = document.createElement("property")

1494

978

e.setAttribute("name", name)

1495

979

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

1496

980

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

1497

981

return e

1498

1499

982

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

1500

983

# Add property tags

1501

984

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

1504

987

if prop._dbus_interface

1505

988

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

1506

989

if_tag.appendChild(tag)

1507

# Add annotation tags for properties

1508

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

1509

annots = dict()

1510

for name, prop in self._get_all_dbus_things(

1511

"property"):

1512

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

1513

and prop._dbus_interface

1514

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

1515

annots.update(getattr(

1516

prop, "_dbus_annotations", {}))

1517

for name, value in annots.items():

1518

ann_tag = document.createElement(

1519

"annotation")

1520

ann_tag.setAttribute("name", name)

1521

ann_tag.setAttribute("value", value)

1522

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)

1523

1021

# Add the names to the return values for the

1524

1022

# "org.freedesktop.DBus.Properties" methods

1525

1023

if (if_tag.getAttribute("name")

1544

1042

return xmlstring

1545

1043

1546

1044

1547

try:

1548

dbus.OBJECT_MANAGER_IFACE

1549

except AttributeError:

1550

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

1551

1552

1553

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1554

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

1555

1556

Classes inheriting from this exposes the standard

1557

GetManagedObjects call and the InterfacesAdded and

1558

InterfacesRemoved signals on the standard

1559

"org.freedesktop.DBus.ObjectManager" interface.

1560

1561

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

1562

manually.

1563

"""

1564

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1565

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

1566

def GetManagedObjects(self):

1567

"""This function must be overridden"""

1568

raise NotImplementedError()

1569

1570

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1571

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

1572

def InterfacesAdded(self, object_path, interfaces_and_properties):

1573

pass

1574

1575

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

1576

def InterfacesRemoved(self, object_path, interfaces):

1577

pass

1578

1579

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1580

out_signature="s",

1581

path_keyword='object_path',

1582

connection_keyword='connection')

1583

def Introspect(self, object_path, connection):

1584

"""Overloading of standard D-Bus method.

1585

1586

Override return argument name of GetManagedObjects to be

1587

"objpath_interfaces_and_properties"

1588

"""

1589

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1590

object_path,

1591

connection)

1592

try:

1593

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

1594

1595

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

1596

# Fix argument name for the GetManagedObjects method

1597

if (if_tag.getAttribute("name")

1598

== dbus.OBJECT_MANAGER_IFACE):

1599

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

1600

if (cn.getAttribute("name")

1601

== "GetManagedObjects"):

1602

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

1603

if (arg.getAttribute("direction")

1604

== "out"):

1605

arg.setAttribute(

1606

"name",

1607

"objpath_interfaces"

1608

"_and_properties")

1609

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

1610

document.unlink()

1611

except (AttributeError, xml.dom.DOMException,

1612

xml.parsers.expat.ExpatError) as error:

1613

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

1614

exc_info=error)

1615

return xmlstring

1616

1617

1618

1045

def datetime_to_dbus(dt, variant_level=0):

1619

1046

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

1620

1047

if dt is None:

1621

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

1622

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)

1623

1051

1624

1052

1625

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1627

1055

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

1628

1056

interface names according to the "alt_interface_names" mapping.

1629

1057

Usage:

1630

1058

1631

1059

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

1632

1060

"net.example.AlternateInterface"})

1633

1061

class SampleDBusObject(dbus.service.Object):

1634

1062

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

1635

1063

def SampleDBusMethod():

1636

1064

pass

1637

1065

1638

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1639

1067

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

1640

1068

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

1641

1069

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

1642

1070

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

1643

1071

1644

1072

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

1645

1073

(from DBusObjectWithProperties) and interfaces (from the

1646

1074

dbus_interface_annotations decorator).

1647

1075

"""

1648

1649

1076

def wrapper(cls):

1650

1077

for orig_interface_name, alt_interface_name in (

1651

alt_interface_names.items()):

1078

alt_interface_names.items()):

1652

1079

attr = {}

1653

1080

interface_names = set()

1654

1081

# Go though all attributes of the class

1656

1083

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

1657

1084

# with the wrong interface name

1658

1085

if (not hasattr(attribute, "_dbus_interface")

1659

or not attribute._dbus_interface.startswith(

1660

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1661

1088

continue

1662

1089

# Create an alternate D-Bus interface name based on

1663

1090

# the current name

1664

alt_interface = attribute._dbus_interface.replace(

1665

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1666

1094

interface_names.add(alt_interface)

1667

1095

# Is this a D-Bus signal?

1668

1096

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

1669

1097

# Extract the original non-method undecorated

1670

1098

# function by black magic

1671

if sys.version_info.major == 2:

1672

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1673

1100

zip(attribute.func_code.co_freevars,

1674

attribute.__closure__))

1675

["func"].cell_contents)

1676

else:

1677

nonmethod_func = (dict(

1678

zip(attribute.__code__.co_freevars,

1679

attribute.__closure__))

1680

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1681

1103

# Create a new, but exactly alike, function

1682

1104

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

1683

1105

# with the alternate D-Bus interface name

1684

new_function = copy_function(nonmethod_func)

1685

new_function = (dbus.service.signal(

1686

alt_interface,

1687

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

1688

1115

# Copy annotations, if any

1689

1116

try:

1690

new_function._dbus_annotations = dict(

1691

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1692

1119

except AttributeError:

1693

1120

pass

1694

1695

1121

# Define a creator of a function to call both the

1696

1122

# original and alternate functions, so both the

1697

1123

# original and alternate signals gets sent when

1700

1126

"""This function is a scope container to pass

1701

1127

func1 and func2 to the "call_both" function

1702

1128

outside of its arguments"""

1703

1704

@functools.wraps(func2)

1705

1129

def call_both(*args, **kwargs):

1706

1130

"""This function will emit two D-Bus

1707

1131

signals by calling func1 and func2"""

1708

1132

func1(*args, **kwargs)

1709

1133

func2(*args, **kwargs)

1710

# Make wrapper function look like a D-Bus

1711

# signal

1712

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

1713

if name.startswith("_dbus_"):

1714

setattr(call_both, name, attr)

1715

1716

1134

return call_both

1717

1135

# Create the "call_both" function and add it to

1718

1136

# the class

1723

1141

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

1724

1142

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

1725

1143

# to the class.

1726

attr[attrname] = (

1727

dbus.service.method(

1728

alt_interface,

1729

attribute._dbus_in_signature,

1730

attribute._dbus_out_signature)

1731

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

1732

1154

# Copy annotations, if any

1733

1155

try:

1734

attr[attrname]._dbus_annotations = dict(

1735

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1736

1158

except AttributeError:

1737

1159

pass

1738

1160

# Is this a D-Bus property?

1741

1163

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

1742

1164

# property with the alternate D-Bus interface

1743

1165

# name. Add it to the class.

1744

attr[attrname] = (dbus_service_property(

1745

alt_interface, attribute._dbus_signature,

1746

attribute._dbus_access,

1747

attribute._dbus_get_args_options

1748

["byte_arrays"])

1749

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

1750

1179

# Copy annotations, if any

1751

1180

try:

1752

attr[attrname]._dbus_annotations = dict(

1753

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1754

1183

except AttributeError:

1755

1184

pass

1756

1185

# Is this a D-Bus interface?

1759

1188

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

1760

1189

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

1761

1190

# to the class.

1762

attr[attrname] = (

1763

dbus_interface_annotations(alt_interface)

1764

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

1765

1199

if deprecate:

1766

1200

# Deprecate all alternate interfaces

1767

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1768

1202

for interface_name in interface_names:

1769

1770

1203

@dbus_interface_annotations(interface_name)

1771

1204

def func(self):

1772

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

1773

"true"}

1205

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

1206

"true" }

1774

1207

# Find an unused name

1775

1208

for aname in (iname.format(i)

1776

1209

for i in itertools.count()):

1780

1213

if interface_names:

1781

1214

# Replace the class with a new subclass of it with

1782

1215

# methods, signals, etc. as created above.

1783

if sys.version_info.major == 2:

1784

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

1785

(cls, ), attr)

1786

else:

1787

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

1788

(cls, ), attr)

1216

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

1217

(cls,), attr)

1789

1218

return cls

1790

1791

1219

return wrapper

1792

1220

1793

1221

1794

1222

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

1795

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1796

1224

class ClientDBus(Client, DBusObjectWithProperties):

1797

1225

"""A Client class using D-Bus

1798

1226

1799

1227

Attributes:

1800

1228

dbus_object_path: dbus.ObjectPath

1801

1229

bus: dbus.SystemBus()

1802

1230

"""

1803

1231

1804

1232

runtime_expansions = (Client.runtime_expansions

1805

+ ("dbus_object_path", ))

1806

1233

+ ("dbus_object_path",))

1234

1807

1235

_interface = "se.recompile.Mandos.Client"

1808

1236

1809

1237

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

1810

1811

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

1238

1239

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

1812

1240

self.bus = bus

1813

1241

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

1814

1242

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

1816

1244

client_object_name = str(self.name).translate(

1817

1245

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

1818

1246

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

1819

self.dbus_object_path = dbus.ObjectPath(

1820

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1821

1249

DBusObjectWithProperties.__init__(self, self.bus,

1822

1250

self.dbus_object_path)

1823

1824

def notifychangeproperty(transform_func, dbus_name,

1825

type_func=lambda x: x,

1826

variant_level=1,

1827

invalidate_only=False,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1828

1255

_interface=_interface):

1829

1256

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

1830

1257

its changes to DBus.

1831

1258

1832

1259

transform_fun: Function that takes a value and a variant_level

1833

1260

and transforms it to a D-Bus type.

1834

1261

dbus_name: D-Bus name of the variable

1837

1264

variant_level: D-Bus variant level. Default: 1

1838

1265

"""

1839

1266

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

1840

1841

1267

def setter(self, value):

1842

1268

if hasattr(self, "dbus_object_path"):

1843

1269

if (not hasattr(self, attrname) or

1844

1270

type_func(getattr(self, attrname, None))

1845

1271

!= type_func(value)):

1846

1272

if invalidate_only:

1847

self.PropertiesChanged(

1848

_interface, dbus.Dictionary(),

1849

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1850

1277

else:

1851

dbus_value = transform_func(

1852

type_func(value),

1853

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1854

1281

self.PropertyChanged(dbus.String(dbus_name),

1855

1282

dbus_value)

1856

self.PropertiesChanged(

1857

_interface,

1858

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

1859

dbus_value}),

1860

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1861

1287

setattr(self, attrname, value)

1862

1288

1863

1289

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

1864

1290

1865

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1866

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1867

1293

"ApprovalPending",

1868

type_func=bool)

1294

type_func = bool)

1869

1295

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

1870

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1871

1297

"LastEnabled")

1872

checker = notifychangeproperty(

1873

dbus.Boolean, "CheckerRunning",

1874

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1875

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1876

1302

"LastCheckedOK")

1877

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1880

1306

datetime_to_dbus, "LastApprovalRequest")

1881

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1882

1308

"ApprovedByDefault")

1883

approval_delay = notifychangeproperty(

1884

dbus.UInt64, "ApprovalDelay",

1885

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)

1886

1314

approval_duration = notifychangeproperty(

1887

1315

dbus.UInt64, "ApprovalDuration",

1888

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

1316

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

1889

1317

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

1890

timeout = notifychangeproperty(

1891

dbus.UInt64, "Timeout",

1892

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1893

1321

extended_timeout = notifychangeproperty(

1894

1322

dbus.UInt64, "ExtendedTimeout",

1895

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

1896

interval = notifychangeproperty(

1897

dbus.UInt64, "Interval",

1898

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)

1899

1329

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

1900

1330

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

1901

1331

invalidate_only=True)

1902

1332

1903

1333

del notifychangeproperty

1904

1334

1905

1335

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

1906

1336

try:

1907

1337

self.remove_from_connection()

1910

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1911

1341

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

1912

1342

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

1913

1914

def checker_callback(self, source, condition,

1915

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

1916

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

1917

connection, command, *args,

1918

**kwargs)

1919

exitstatus = self.last_checker_status

1920

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)

1921

1350

# Emit D-Bus signal

1922

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1923

# This is specific to GNU libC

1924

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1925

1353

dbus.String(command))

1926

1354

else:

1927

1355

# Emit D-Bus signal

1928

1356

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

1929

dbus.Int64(

1930

# This is specific to GNU libC

1931

(exitstatus << 8)

1932

| self.last_checker_signal),

1357

dbus.Int64(condition),

1933

1358

dbus.String(command))

1934

return ret

1935

1359

1360

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

1361

*args, **kwargs)

1362

1936

1363

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

1937

1364

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

1938

1365

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

1942

1369

# Emit D-Bus signal

1943

1370

self.CheckerStarted(self.current_checker_command)

1944

1371

return r

1945

1372

1946

1373

def _reset_approved(self):

1947

1374

self.approved = None

1948

1375

return False

1949

1376

1950

1377

def approve(self, value=True):

1951

1378

self.approved = value

1952

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

1953

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1954

1381

self.send_changedstate()

1955

1956

# D-Bus methods, signals & properties

1957

1958

# Interfaces

1959

1960

# Signals

1961

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1962

1389

# CheckerCompleted - signal

1963

1390

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

1964

1391

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

1965

1392

"D-Bus signal"

1966

1393

pass

1967

1394

1968

1395

# CheckerStarted - signal

1969

1396

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

1970

1397

def CheckerStarted(self, command):

1971

1398

"D-Bus signal"

1972

1399

pass

1973

1400

1974

1401

# PropertyChanged - signal

1975

1402

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

1976

1403

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

1977

1404

def PropertyChanged(self, property, value):

1978

1405

"D-Bus signal"

1979

1406

pass

1980

1407

1981

1408

# GotSecret - signal

1982

1409

@dbus.service.signal(_interface)

1983

1410

def GotSecret(self):

1986

1413

server to mandos-client

1987

1414

"""

1988

1415

pass

1989

1416

1990

1417

# Rejected - signal

1991

1418

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

1992

1419

def Rejected(self, reason):

1993

1420

"D-Bus signal"

1994

1421

pass

1995

1422

1996

1423

# NeedApproval - signal

1997

1424

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

1998

1425

def NeedApproval(self, timeout, default):

1999

1426

"D-Bus signal"

2000

1427

return self.need_approval()

2001

2002

# Methods

2003

1428

1429

## Methods

1430

2004

1431

# Approve - method

2005

1432

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

2006

1433

def Approve(self, value):

2007

1434

self.approve(value)

2008

1435

2009

1436

# CheckedOK - method

2010

1437

@dbus.service.method(_interface)

2011

1438

def CheckedOK(self):

2012

1439

self.checked_ok()

2013

1440

2014

1441

# Enable - method

2015

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

2016

1442

@dbus.service.method(_interface)

2017

1443

def Enable(self):

2018

1444

"D-Bus method"

2019

1445

self.enable()

2020

1446

2021

1447

# StartChecker - method

2022

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

2023

1448

@dbus.service.method(_interface)

2024

1449

def StartChecker(self):

2025

1450

"D-Bus method"

2026

1451

self.start_checker()

2027

1452

2028

1453

# Disable - method

2029

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

2030

1454

@dbus.service.method(_interface)

2031

1455

def Disable(self):

2032

1456

"D-Bus method"

2033

1457

self.disable()

2034

1458

2035

1459

# StopChecker - method

2036

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

2037

1460

@dbus.service.method(_interface)

2038

1461

def StopChecker(self):

2039

1462

self.stop_checker()

2040

2041

# Properties

2042

1463

1464

## Properties

1465

2043

1466

# ApprovalPending - property

2044

1467

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

2045

1468

def ApprovalPending_dbus_property(self):

2046

1469

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

2047

1470

2048

1471

# ApprovedByDefault - property

2049

@dbus_service_property(_interface,

2050

signature="b",

1472

@dbus_service_property(_interface, signature="b",

2051

1473

access="readwrite")

2052

1474

def ApprovedByDefault_dbus_property(self, value=None):

2053

1475

if value is None: # get

2054

1476

return dbus.Boolean(self.approved_by_default)

2055

1477

self.approved_by_default = bool(value)

2056

1478

2057

1479

# ApprovalDelay - property

2058

@dbus_service_property(_interface,

2059

signature="t",

1480

@dbus_service_property(_interface, signature="t",

2060

1481

access="readwrite")

2061

1482

def ApprovalDelay_dbus_property(self, value=None):

2062

1483

if value is None: # get

2063

1484

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

2064

1485

* 1000)

2065

1486

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

2066

1487

2067

1488

# ApprovalDuration - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1489

@dbus_service_property(_interface, signature="t",

2070

1490

access="readwrite")

2071

1491

def ApprovalDuration_dbus_property(self, value=None):

2072

1492

if value is None: # get

2073

1493

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

2074

1494

* 1000)

2075

1495

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

2076

1496

2077

1497

# Name - property

2078

@dbus_annotations(

2079

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

2080

1498

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

2081

1499

def Name_dbus_property(self):

2082

1500

return dbus.String(self.name)

2083

2084

# KeyID - property

2085

@dbus_annotations(

2086

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

2087

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

2088

def KeyID_dbus_property(self):

2089

return dbus.String(self.key_id)

2090

1501

2091

1502

# Fingerprint - property

2092

@dbus_annotations(

2093

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

2094

1503

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

2095

1504

def Fingerprint_dbus_property(self):

2096

1505

return dbus.String(self.fingerprint)

2097

1506

2098

1507

# Host - property

2099

@dbus_service_property(_interface,

2100

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2101

1509

access="readwrite")

2102

1510

def Host_dbus_property(self, value=None):

2103

1511

if value is None: # get

2104

1512

return dbus.String(self.host)

2105

1513

self.host = str(value)

2106

1514

2107

1515

# Created - property

2108

@dbus_annotations(

2109

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

2110

1516

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

2111

1517

def Created_dbus_property(self):

2112

1518

return datetime_to_dbus(self.created)

2113

1519

2114

1520

# LastEnabled - property

2115

1521

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

2116

1522

def LastEnabled_dbus_property(self):

2117

1523

return datetime_to_dbus(self.last_enabled)

2118

1524

2119

1525

# Enabled - property

2120

@dbus_service_property(_interface,

2121

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2122

1527

access="readwrite")

2123

1528

def Enabled_dbus_property(self, value=None):

2124

1529

if value is None: # get

2127

1532

self.enable()

2128

1533

else:

2129

1534

self.disable()

2130

1535

2131

1536

# LastCheckedOK - property

2132

@dbus_service_property(_interface,

2133

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2134

1538

access="readwrite")

2135

1539

def LastCheckedOK_dbus_property(self, value=None):

2136

1540

if value is not None:

2137

1541

self.checked_ok()

2138

1542

return

2139

1543

return datetime_to_dbus(self.last_checked_ok)

2140

1544

2141

1545

# LastCheckerStatus - property

2142

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2143

1548

def LastCheckerStatus_dbus_property(self):

2144

1549

return dbus.Int16(self.last_checker_status)

2145

1550

2146

1551

# Expires - property

2147

1552

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

2148

1553

def Expires_dbus_property(self):

2149

1554

return datetime_to_dbus(self.expires)

2150

1555

2151

1556

# LastApprovalRequest - property

2152

1557

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

2153

1558

def LastApprovalRequest_dbus_property(self):

2154

1559

return datetime_to_dbus(self.last_approval_request)

2155

1560

2156

1561

# Timeout - property

2157

@dbus_service_property(_interface,

2158

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2159

1563

access="readwrite")

2160

1564

def Timeout_dbus_property(self, value=None):

2161

1565

if value is None: # get

2173

1577

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

2174

1578

is None):

2175

1579

return

2176

GLib.source_remove(self.disable_initiator_tag)

2177

self.disable_initiator_tag = GLib.timeout_add(

2178

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

2179

self.disable)

2180

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

2181

1586

# ExtendedTimeout - property

2182

@dbus_service_property(_interface,

2183

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2184

1588

access="readwrite")

2185

1589

def ExtendedTimeout_dbus_property(self, value=None):

2186

1590

if value is None: # get

2187

1591

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

2188

1592

* 1000)

2189

1593

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

2190

1594

2191

1595

# Interval - property

2192

@dbus_service_property(_interface,

2193

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2194

1597

access="readwrite")

2195

1598

def Interval_dbus_property(self, value=None):

2196

1599

if value is None: # get

2200

1603

return

2201

1604

if self.enabled:

2202

1605

# Reschedule checker run

2203

GLib.source_remove(self.checker_initiator_tag)

2204

self.checker_initiator_tag = GLib.timeout_add(

2205

value, self.start_checker)

2206

self.start_checker() # Start one now, too

2207

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

2208

1611

# Checker - property

2209

@dbus_service_property(_interface,

2210

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2211

1613

access="readwrite")

2212

1614

def Checker_dbus_property(self, value=None):

2213

1615

if value is None: # get

2214

1616

return dbus.String(self.checker_command)

2215

1617

self.checker_command = str(value)

2216

1618

2217

1619

# CheckerRunning - property

2218

@dbus_service_property(_interface,

2219

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2220

1621

access="readwrite")

2221

1622

def CheckerRunning_dbus_property(self, value=None):

2222

1623

if value is None: # get

2225

1626

self.start_checker()

2226

1627

else:

2227

1628

self.stop_checker()

2228

1629

2229

1630

# ObjectPath - property

2230

@dbus_annotations(

2231

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

2232

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

2233

1631

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

2234

1632

def ObjectPath_dbus_property(self):

2235

return self.dbus_object_path # is already a dbus.ObjectPath

2236

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2237

1635

# Secret = property

2238

@dbus_annotations(

2239

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

2240

"invalidates"})

2241

@dbus_service_property(_interface,

2242

signature="ay",

2243

access="write",

2244

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2245

1638

def Secret_dbus_property(self, value):

2246

1639

self.secret = bytes(value)

2247

1640

2248

1641

del _interface

2249

1642

2250

1643

2251

class ProxyClient:

2252

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

1644

class ProxyClient(object):

1645

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

2253

1646

self._pipe = child_pipe

2254

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

1647

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

2255

1648

if not self._pipe.recv():

2256

raise KeyError(key_id or fpr)

2257

1649

raise KeyError()

1650

2258

1651

def __getattribute__(self, name):

2259

1652

if name == '_pipe':

2260

1653

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

2263

1656

if data[0] == 'data':

2264

1657

return data[1]

2265

1658

if data[0] == 'function':

2266

2267

1659

def func(*args, **kwargs):

2268

1660

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

2269

1661

return self._pipe.recv()[1]

2270

2271

1662

return func

2272

1663

2273

1664

def __setattr__(self, name, value):

2274

1665

if name == '_pipe':

2275

1666

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

2278

1669

2279

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2280

1671

"""A class to handle client connections.

2281

1672

2282

1673

Instantiated once for each connection to handle it.

2283

1674

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

2284

1675

2285

1676

def handle(self):

2286

1677

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

2287

1678

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

2288

1679

str(self.client_address))

2289

1680

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

2290

1681

self.server.child_pipe.fileno())

2291

2292

session = gnutls.ClientSession(self.request)

2293

2294

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

2295

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

2296

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

2297

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

2298

1697

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

2299

1698

priority = self.server.gnutls_priority

2300

1699

if priority is None:

2301

1700

priority = "NORMAL"

2302

gnutls.priority_set_direct(session._c_object,

2303

priority.encode("utf-8"),

2304

None)

2305

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2306

1705

# Start communication using the Mandos protocol

2307

1706

# Get protocol number

2308

1707

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

2313

1712

except (ValueError, IndexError, RuntimeError) as error:

2314

1713

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

2315

1714

return

2316

1715

2317

1716

# Start GnuTLS connection

2318

1717

try:

2319

1718

session.handshake()

2320

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2321

1720

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

2322

1721

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

2323

1722

# established. Just abandon the request.

2324

1723

return

2325

1724

logger.debug("Handshake succeeded")

2326

1725

2327

1726

approval_required = False

2328

1727

try:

2329

if gnutls.has_rawpk:

2330

fpr = b""

2331

try:

2332

key_id = self.key_id(

2333

self.peer_certificate(session))

2334

except (TypeError, gnutls.Error) as error:

2335

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

2336

return

2337

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

2338

2339

else:

2340

key_id = b""

2341

try:

2342

fpr = self.fingerprint(

2343

self.peer_certificate(session))

2344

except (TypeError, gnutls.Error) as error:

2345

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

2346

return

2347

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

2348

2349

try:

2350

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,

2351

1739

self.client_address)

2352

1740

except KeyError:

2353

1741

return

2354

1742

2355

1743

if client.approval_delay:

2356

1744

delay = client.approval_delay

2357

1745

client.approvals_pending += 1

2358

1746

approval_required = True

2359

1747

2360

1748

while True:

2361

1749

if not client.enabled:

2362

1750

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

2363

client.name)

1751

client.name)

2364

1752

if self.server.use_dbus:

2365

1753

# Emit D-Bus signal

2366

1754

client.Rejected("Disabled")

2367

1755

return

2368

1756

2369

1757

if client.approved or not client.approval_delay:

2370

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2371

1759

break

2372

1760

elif client.approved is None:

2373

1761

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

2384

1772

# Emit D-Bus signal

2385

1773

client.Rejected("Denied")

2386

1774

return

2387

2388

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2389

1777

time = datetime.datetime.now()

2390

1778

client.changedstate.acquire()

2391

1779

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

2404

1792

break

2405

1793

else:

2406

1794

delay -= time2 - time

2407

2408

try:

2409

session.send(client.secret)

2410

except gnutls.Error as error:

2411

logger.warning("gnutls send failed",

2412

exc_info=error)

2413

return

2414

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

2415

1809

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

2416

1810

# bump the timeout using extended_timeout

2417

1811

client.bump_timeout(client.extended_timeout)

2418

1812

if self.server.use_dbus:

2419

1813

# Emit D-Bus signal

2420

1814

client.GotSecret()

2421

1815

2422

1816

finally:

2423

1817

if approval_required:

2424

1818

client.approvals_pending -= 1

2425

1819

try:

2426

1820

session.bye()

2427

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2428

1822

logger.warning("GnuTLS bye failed",

2429

1823

exc_info=error)

2430

1824

2431

1825

@staticmethod

2432

1826

def peer_certificate(session):

2433

"Return the peer's certificate as a bytestring"

2434

try:

2435

cert_type = gnutls.certificate_type_get2(session._c_object,

2436

gnutls.CTYPE_PEERS)

2437

except AttributeError:

2438

cert_type = gnutls.certificate_type_get(session._c_object)

2439

if gnutls.has_rawpk:

2440

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2441

else:

2442

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2443

# If not a valid certificate type...

2444

if cert_type not in valid_cert_types:

2445

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

2446

valid_cert_types)

2447

# ...return invalid data

2448

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

2449

1834

list_size = ctypes.c_uint(1)

2450

cert_list = (gnutls.certificate_get_peers

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2451

1837

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

2452

1838

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

2453

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

1839

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

1840

" certificate")

2454

1841

if list_size.value == 0:

2455

1842

return None

2456

1843

cert = cert_list[0]

2457

1844

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

2458

2459

@staticmethod

2460

def key_id(certificate):

2461

"Convert a certificate bytestring to a hexdigit key ID"

2462

# New GnuTLS "datum" with the public key

2463

datum = gnutls.datum_t(

2464

ctypes.cast(ctypes.c_char_p(certificate),

2465

ctypes.POINTER(ctypes.c_ubyte)),

2466

ctypes.c_uint(len(certificate)))

2467

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

2468

# New empty GnuTLS certificate

2469

pubkey = gnutls.pubkey_t()

2470

gnutls.pubkey_init(ctypes.byref(pubkey))

2471

# Import the raw public key into the certificate

2472

gnutls.pubkey_import(pubkey,

2473

ctypes.byref(datum),

2474

gnutls.X509_FMT_DER)

2475

# New buffer for the key ID

2476

buf = ctypes.create_string_buffer(32)

2477

buf_len = ctypes.c_size_t(len(buf))

2478

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

2479

gnutls.pubkey_get_key_id(

2480

pubkey,

2481

gnutls.KEYID_USE_SHA256,

2482

ctypes.cast(ctypes.byref(buf),

2483

ctypes.POINTER(ctypes.c_ubyte)),

2484

ctypes.byref(buf_len))

2485

# Deinit the certificate

2486

gnutls.pubkey_deinit(pubkey)

2487

2488

# Convert the buffer to a Python bytestring

2489

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

2490

# Convert the bytestring to hexadecimal notation

2491

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

2492

return hex_key_id

2493

1845

2494

1846

@staticmethod

2495

1847

def fingerprint(openpgp):

2496

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2497

1849

# New GnuTLS "datum" with the OpenPGP public key

2498

datum = gnutls.datum_t(

2499

ctypes.cast(ctypes.c_char_p(openpgp),

2500

ctypes.POINTER(ctypes.c_ubyte)),

2501

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

2502

1855

# New empty GnuTLS certificate

2503

crt = gnutls.openpgp_crt_t()

2504

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

2505

1859

# Import the OpenPGP public key into the certificate

2506

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

2507

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

2508

1864

# Verify the self signature in the key

2509

1865

crtverify = ctypes.c_uint()

2510

gnutls.openpgp_crt_verify_self(crt, 0,

2511

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2512

1869

if crtverify.value != 0:

2513

gnutls.openpgp_crt_deinit(crt)

2514

raise gnutls.CertificateSecurityError(code

2515

=crtverify.value)

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2516

1873

# New buffer for the fingerprint

2517

1874

buf = ctypes.create_string_buffer(20)

2518

1875

buf_len = ctypes.c_size_t()

2519

1876

# Get the fingerprint from the certificate into the buffer

2520

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

2521

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2522

1880

# Deinit the certificate

2523

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2524

1882

# Convert the buffer to a Python bytestring

2525

1883

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

2526

1884

# Convert the bytestring to hexadecimal notation

2528

1886

return hex_fpr

2529

1887

2530

1888

2531

class MultiprocessingMixIn:

1889

class MultiprocessingMixIn(object):

2532

1890

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

2533

2534

1891

def sub_process_main(self, request, address):

2535

1892

try:

2536

1893

self.finish_request(request, address)

2537

1894

except Exception:

2538

1895

self.handle_error(request, address)

2539

1896

self.close_request(request)

2540

1897

2541

1898

def process_request(self, request, address):

2542

1899

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

2543

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

2544

args=(request, address))

1900

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

1901

args = (request, address))

2545

1902

proc.start()

2546

1903

return proc

2547

1904

2548

1905

2549

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2550

1907

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

2551

2552

1908

def process_request(self, request, client_address):

2553

1909

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

2554

1910

2555

1911

This function creates a new pipe in self.pipe

2556

1912

"""

2557

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2558

1914

2559

1915

proc = MultiprocessingMixIn.process_request(self, request,

2560

1916

client_address)

2561

1917

self.child_pipe.close()

2562

1918

self.add_pipe(parent_pipe, proc)

2563

1919

2564

1920

def add_pipe(self, parent_pipe, proc):

2565

1921

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

2566

1922

raise NotImplementedError()

2567

1923

2568

1924

2569

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2570

socketserver.TCPServer):

1926

socketserver.TCPServer, object):

2571

1927

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

2572

1928

2573

1929

Attributes:

2574

1930

enabled: Boolean; whether this server is activated yet

2575

1931

interface: None or a network interface name (string)

2576

1932

use_ipv6: Boolean; to use IPv6 or not

2577

1933

"""

2578

2579

1934

def __init__(self, server_address, RequestHandlerClass,

2580

interface=None,

2581

use_ipv6=True,

2582

socketfd=None):

1935

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

2583

1936

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

2584

1937

creating a new one with socket.socket().

2585

1938

"""

2591

1944

self.socketfd = socketfd

2592

1945

# Save the original socket.socket() function

2593

1946

self.socket_socket = socket.socket

2594

2595

1947

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

2596

#

1948

#

2597

1949

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

2598

1950

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

2599

1951

# patching socket.socket.)

2600

#

1952

#

2601

1953

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

2602

1954

@functools.wraps(socket.socket)

2603

1955

def socket_wrapper(*args, **kwargs):

2615

1967

# socket_wrapper(), if socketfd was set.

2616

1968

socketserver.TCPServer.__init__(self, server_address,

2617

1969

RequestHandlerClass)

2618

1970

2619

1971

def server_bind(self):

2620

1972

"""This overrides the normal server_bind() function

2621

1973

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

2622

1974

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

2623

global SO_BINDTODEVICE

2624

1975

if self.interface is not None:

2625

1976

if SO_BINDTODEVICE is None:

2626

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

2627

# common enough.

2628

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

2629

SO_BINDTODEVICE = 25

2630

try:

2631

self.socket.setsockopt(

2632

socket.SOL_SOCKET, SO_BINDTODEVICE,

2633

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

2634

except socket.error as error:

2635

if error.errno == errno.EPERM:

2636

logger.error("No permission to bind to"

2637

" interface %s", self.interface)

2638

elif error.errno == errno.ENOPROTOOPT:

2639

logger.error("SO_BINDTODEVICE not available;"

2640

" cannot bind to interface %s",

2641

self.interface)

2642

elif error.errno == errno.ENODEV:

2643

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

2644

" cannot bind", self.interface)

2645

else:

2646

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

2647

1999

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

2648

2000

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

2649

if self.server_address[1]:

2650

self.allow_reuse_address = True

2651

2001

if not self.server_address[0]:

2652

2002

if self.address_family == socket.AF_INET6:

2653

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2654

2004

else:

2655

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2656

2006

self.server_address = (any_address,

2657

2007

self.server_address[1])

2658

2008

elif not self.server_address[1]:

2659

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

2009

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

2010

0)

2660

2011

# if self.interface:

2661

2012

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

2662

2013

# 0, # port

2668

2019

2669

2020

class MandosServer(IPv6_TCPServer):

2670

2021

"""Mandos server.

2671

2022

2672

2023

Attributes:

2673

2024

clients: set of Client objects

2674

2025

gnutls_priority GnuTLS priority string

2675

2026

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

2676

2677

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2678

2029

"""

2679

2680

2030

def __init__(self, server_address, RequestHandlerClass,

2681

interface=None,

2682

use_ipv6=True,

2683

clients=None,

2684

gnutls_priority=None,

2685

use_dbus=True,

2686

socketfd=None):

2031

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

2032

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

2687

2033

self.enabled = False

2688

2034

self.clients = clients

2689

2035

if self.clients is None:

2692

2038

self.gnutls_priority = gnutls_priority

2693

2039

IPv6_TCPServer.__init__(self, server_address,

2694

2040

RequestHandlerClass,

2695

interface=interface,

2696

use_ipv6=use_ipv6,

2697

socketfd=socketfd)

2698

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2699

2044

def server_activate(self):

2700

2045

if self.enabled:

2701

2046

return socketserver.TCPServer.server_activate(self)

2702

2047

2703

2048

def enable(self):

2704

2049

self.enabled = True

2705

2050

2706

2051

def add_pipe(self, parent_pipe, proc):

2707

2052

# Call "handle_ipc" for both data and EOF events

2708

GLib.io_add_watch(

2709

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

2710

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

2711

functools.partial(self.handle_ipc,

2712

parent_pipe=parent_pipe,

2713

proc=proc))

2714

2715

def handle_ipc(self, source, condition,

2716

parent_pipe=None,

2717

proc=None,

2718

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

2719

2062

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

2720

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

2063

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

2721

2064

# Wait for other process to exit

2722

2065

proc.join()

2723

2066

return False

2724

2067

2725

2068

# Read a request from the child

2726

2069

request = parent_pipe.recv()

2727

2070

command = request[0]

2728

2071

2729

2072

if command == 'init':

2730

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

2731

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

2732

address = request[3]

2733

2734

for c in self.clients.values():

2735

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2736

"27AE41E4649B934CA495991B7852B855"):

2737

continue

2738

if key_id and c.key_id == key_id:

2739

client = c

2740

break

2741

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:

2742

2078

client = c

2743

2079

break

2744

2080

else:

2745

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

2746

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

2081

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

2082

"dress: %s", fpr, address)

2747

2083

if self.use_dbus:

2748

2084

# Emit D-Bus signal

2749

mandos_dbus_service.ClientNotFound(key_id or fpr,

2085

mandos_dbus_service.ClientNotFound(fpr,

2750

2086

address[0])

2751

2087

parent_pipe.send(False)

2752

2088

return False

2753

2754

GLib.io_add_watch(

2755

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

2756

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

2757

functools.partial(self.handle_ipc,

2758

parent_pipe=parent_pipe,

2759

proc=proc,

2760

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

2761

2098

parent_pipe.send(True)

2762

2099

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

2763

2100

# same fileno

2766

2103

funcname = request[1]

2767

2104

args = request[2]

2768

2105

kwargs = request[3]

2769

2106

2770

2107

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

2771

2108

funcname)(*args,

2772

**kwargs)))

2773

2109

**kwargs)))

2110

2774

2111

if command == 'getattr':

2775

2112

attrname = request[1]

2776

if isinstance(client_object.__getattribute__(attrname),

2777

collections.abc.Callable):

2778

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2779

2115

else:

2780

parent_pipe.send((

2781

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

2782

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2783

2119

if command == 'setattr':

2784

2120

attrname = request[1]

2785

2121

value = request[2]

2786

2122

setattr(client_object, attrname, value)

2787

2123

2788

2124

return True

2789

2125

2790

2126

2791

2127

def rfc3339_duration_to_delta(duration):

2792

2128

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

2793

2794

>>> timedelta = datetime.timedelta

2795

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

2796

True

2797

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

2798

True

2799

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

2800

True

2801

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

2802

True

2803

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

2804

True

2805

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

2806

True

2807

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

2808

True

2809

>>> del timedelta

2129

2130

>>> rfc3339_duration_to_delta("P7D")

2131

datetime.timedelta(7)

2132

>>> rfc3339_duration_to_delta("PT60S")

2133

datetime.timedelta(0, 60)

2134

>>> rfc3339_duration_to_delta("PT60M")

2135

datetime.timedelta(0, 3600)

2136

>>> rfc3339_duration_to_delta("PT24H")

2137

datetime.timedelta(1)

2138

>>> rfc3339_duration_to_delta("P1W")

2139

datetime.timedelta(7)

2140

>>> rfc3339_duration_to_delta("PT5M30S")

2141

datetime.timedelta(0, 330)

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

datetime.timedelta(1, 200)

2810

2144

"""

2811

2145

2812

2146

# Parsing an RFC 3339 duration with regular expressions is not

2813

2147

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

2814

2148

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

2815

2149

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

2816

2150

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

2817

2151

# avoid excessive use of external libraries.

2818

2152

2819

2153

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

2820

Token = collections.namedtuple("Token", (

2821

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

2822

# a "group" containing digits

2823

"value", # datetime.timedelta or None

2824

"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

2825

2163

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

2826

2164

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

2827

2165

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

2828

2166

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

2829

2167

datetime.timedelta(seconds=1),

2830

frozenset((token_end, )))

2168

frozenset((token_end,)))

2831

2169

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

2832

2170

datetime.timedelta(minutes=1),

2833

2171

frozenset((token_second, token_end)))

2849

2187

frozenset((token_month, token_end)))

2850

2188

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

2851

2189

datetime.timedelta(weeks=1),

2852

frozenset((token_end, )))

2190

frozenset((token_end,)))

2853

2191

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

2854

2192

frozenset((token_year, token_month,

2855

2193

token_day, token_time,

2856

2194

token_week)))

2857

# Define starting values:

2858

# Value so far

2859

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2860

2197

found_token = None

2861

# Following valid tokens

2862

followers = frozenset((token_duration, ))

2863

# String left to parse

2864

s = duration

2198

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

2199

s = duration # String left to parse

2865

2200

# Loop until end token is found

2866

2201

while found_token is not token_end:

2867

2202

# Search for any currently valid tokens

2883

2218

break

2884

2219

else:

2885

2220

# No currently valid tokens were found

2886

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

2887

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2888

2222

# End token found

2889

2223

return value

2890

2224

2891

2225

2892

2226

def string_to_delta(interval):

2893

2227

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

2894

2895

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

2896

True

2897

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

2898

True

2899

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

2900

True

2901

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

2902

True

2903

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

2904

True

2905

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

2906

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)

2907

2241

"""

2908

2242

2909

2243

try:

2910

2244

return rfc3339_duration_to_delta(interval)

2911

2245

except ValueError:

2912

2246

pass

2913

2247

2914

2248

timevalue = datetime.timedelta(0)

2915

2249

for s in interval.split():

2916

2250

try:

2927

2261

elif suffix == "w":

2928

2262

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

2929

2263

else:

2930

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2931

2266

except IndexError as e:

2932

2267

raise ValueError(*(e.args))

2933

2268

timevalue += delta

2934

2269

return timevalue

2935

2270

2936

2271

2937

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

2272

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

2938

2273

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

2939

2274

2940

2275

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

2941

2276

if os.fork():

2942

2277

sys.exit()

2949

2284

# Close all standard open file descriptors

2950

2285

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

2951

2286

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

2952

raise OSError(errno.ENODEV,

2953

"{} not a character device"

2287

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

2954

2288

.format(os.devnull))

2955

2289

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

2956

2290

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

2960

2294

2961

2295

2962

2296

def main():

2963

2297

2964

2298

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

2965

2299

# Parsing of options, both command line and config file

2966

2300

2967

2301

parser = argparse.ArgumentParser()

2968

2302

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

2969

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

2303

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

2970

2304

help="show version number and exit")

2971

2305

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

2972

2306

help="Bind to interface IF")

3008

2342

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

3009

2343

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

3010

2344

default=None)

3011

2345

3012

2346

options = parser.parse_args()

3013

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

3014

2353

# Default values for config file for server-global settings

3015

if gnutls.has_rawpk:

3016

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

3017

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

3018

else:

3019

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

3020

":+SIGN-DSA-SHA256")

3021

server_defaults = {"interface": "",

3022

"address": "",

3023

"port": "",

3024

"debug": "False",

3025

"priority": priority,

3026

"servicename": "Mandos",

3027

"use_dbus": "True",

3028

"use_ipv6": "True",

3029

"debuglevel": "",

3030

"restore": "True",

3031

"socket": "",

3032

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

3033

"foreground": "False",

3034

"zeroconf": "True",

3035

}

3036

del priority

3037

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

3038

2371

# Parse config file for server-global settings

3039

server_config = configparser.ConfigParser(server_defaults)

2372

server_config = configparser.SafeConfigParser(server_defaults)

3040

2373

del server_defaults

3041

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

3042

# 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

3043

2377

server_settings = server_config.defaults()

3044

2378

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

3045

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

3046

"foreground", "zeroconf"):

2379

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

3047

2380

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

3048

2381

option)

3049

2382

if server_settings["port"]:

3059

2392

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

3060

2393

["socket"])

3061

2394

del server_config

3062

2395

3063

2396

# Override the settings from the config file with command line

3064

2397

# options, if set.

3065

2398

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

3066

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

3067

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

3068

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

2399

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

2400

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

2401

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

3069

2402

value = getattr(options, option)

3070

2403

if value is not None:

3071

2404

server_settings[option] = value

3083

2416

if server_settings["debug"]:

3084

2417

server_settings["foreground"] = True

3085

2418

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

3086

2419

3087

2420

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

3088

3089

if (not server_settings["zeroconf"]

3090

and not (server_settings["port"]

3091

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

3092

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

3093

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

3094

2428

# For convenience

3095

2429

debug = server_settings["debug"]

3096

2430

debuglevel = server_settings["debuglevel"]

3100

2434

stored_state_file)

3101

2435

foreground = server_settings["foreground"]

3102

2436

zeroconf = server_settings["zeroconf"]

3103

2437

3104

2438

if debug:

3105

2439

initlogger(debug, logging.DEBUG)

3106

2440

else:

3109

2443

else:

3110

2444

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

3111

2445

initlogger(debug, level)

3112

2446

3113

2447

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

3114

syslogger.setFormatter(

3115

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

3116

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

3117

server_settings["servicename"])))

3118

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3119

2454

# Parse config file with clients

3120

client_config = configparser.ConfigParser(Client.client_defaults)

2455

client_config = configparser.SafeConfigParser(Client

2456

.client_defaults)

3121

2457

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

3122

2458

"clients.conf"))

3123

2459

3124

2460

global mandos_dbus_service

3125

2461

mandos_dbus_service = None

3126

2462

3127

2463

socketfd = None

3128

2464

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

3129

2465

socketfd = server_settings["socket"]

3130

tcp_server = MandosServer(

3131

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

3132

ClientHandler,

3133

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

3134

use_ipv6=use_ipv6,

3135

gnutls_priority=server_settings["priority"],

3136

use_dbus=use_dbus,

3137

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)

3138

2476

if not foreground:

3139

2477

pidfilename = "/run/mandos.pid"

3140

2478

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

3141

2479

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

3142

2480

pidfile = None

3143

2481

try:

3144

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

2482

pidfile = open(pidfilename, "w")

3145

2483

except IOError as e:

3146

2484

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

3147

2485

exc_info=e)

3148

3149

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

3150

("mandos", "mandos"),

3151

("nobody", "nogroup")):

2486

2487

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

3152

2488

try:

3153

2489

uid = pwd.getpwnam(name).pw_uid

3154

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

3155

2491

break

3156

2492

except KeyError:

3157

2493

continue

3161

2497

try:

3162

2498

os.setgid(gid)

3163

2499

os.setuid(uid)

3164

if debug:

3165

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

3166

gid))

3167

2500

except OSError as error:

3168

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

3169

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

3170

2501

if error.errno != errno.EPERM:

3171

2502

raise

3172

2503

3173

2504

if debug:

3174

2505

# Enable all possible GnuTLS debugging

3175

2506

3176

2507

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

3177

2508

# - GnuTLS manual

3178

gnutls.global_set_log_level(11)

3179

3180

@gnutls.log_func

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3181

2512

def debug_gnutls(level, string):

3182

2513

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

3183

3184

gnutls.global_set_log_function(debug_gnutls)

3185

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3186

2518

# Redirect stdin so all checkers get /dev/null

3187

2519

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

3188

2520

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

3189

2521

if null > 2:

3190

2522

os.close(null)

3191

2523

3192

2524

# Need to fork before connecting to D-Bus

3193

2525

if not foreground:

3194

2526

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

3195

2527

daemon()

3196

3197

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

3198

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

3199

# need to inform GLib that threads will be used.

3200

GLib.threads_init()

3201

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

3202

2533

global main_loop

3203

2534

# From the Avahi example code

3204

2535

DBusGMainLoop(set_as_default=True)

3205

main_loop = GLib.MainLoop()

2536

main_loop = gobject.MainLoop()

3206

2537

bus = dbus.SystemBus()

3207

2538

# End of Avahi example code

3208

2539

if use_dbus:

3209

2540

try:

3210

2541

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

3211

bus,

3212

do_not_queue=True)

3213

old_bus_name = dbus.service.BusName(

3214

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

3215

do_not_queue=True)

3216

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:

3217

2547

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

3218

2548

use_dbus = False

3219

2549

server_settings["use_dbus"] = False

3220

2550

tcp_server.use_dbus = False

3221

2551

if zeroconf:

3222

2552

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3223

service = AvahiServiceToSyslog(

3224

name=server_settings["servicename"],

3225

servicetype="_mandos._tcp",

3226

protocol=protocol,

3227

bus=bus)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3228

2557

if server_settings["interface"]:

3229

service.interface = if_nametoindex(

3230

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

3231

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3232

2562

global multiprocessing_manager

3233

2563

multiprocessing_manager = multiprocessing.Manager()

3234

2564

3235

2565

client_class = Client

3236

2566

if use_dbus:

3237

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

3238

2567

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

2568

3239

2569

client_settings = Client.config_parser(client_config)

3240

2570

old_client_settings = {}

3241

2571

clients_data = {}

3242

2572

3243

2573

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

3244

2574

global wnull

3245

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

2575

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

3246

2576

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

3247

2577

# mode

3248

2578

if debug or not foreground:

3249

2579

wnull.close()

3250

2580

3251

2581

# Get client data and settings from last running state.

3252

2582

if server_settings["restore"]:

3253

2583

try:

3254

2584

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

3255

if sys.version_info.major == 2:

3256

clients_data, old_client_settings = pickle.load(

3257

stored_state)

3258

else:

3259

bytes_clients_data, bytes_old_client_settings = (

3260

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

3261

# Fix bytes to strings

3262

# clients_data

3263

# .keys()

3264

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

3265

if isinstance(key, bytes)

3266

else key): value

3267

for key, value in

3268

bytes_clients_data.items()}

3269

del bytes_clients_data

3270

for key in clients_data:

3271

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

3272

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

3273

for k, v in

3274

clients_data[key].items()}

3275

clients_data[key] = value

3276

# .client_structure

3277

value["client_structure"] = [

3278

(s.decode("utf-8")

3279

if isinstance(s, bytes)

3280

else s) for s in

3281

value["client_structure"]]

3282

# .name, .host, and .checker_command

3283

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

3284

if isinstance(value[k], bytes):

3285

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

3286

if "key_id" not in value:

3287

value["key_id"] = ""

3288

elif "fingerprint" not in value:

3289

value["fingerprint"] = ""

3290

# old_client_settings

3291

# .keys()

3292

old_client_settings = {

3293

(key.decode("utf-8")

3294

if isinstance(key, bytes)

3295

else key): value

3296

for key, value in

3297

bytes_old_client_settings.items()}

3298

del bytes_old_client_settings

3299

# .host and .checker_command

3300

for value in old_client_settings.values():

3301

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

3302

if isinstance(value[attribute], bytes):

3303

value[attribute] = (value[attribute]

3304

.decode("utf-8"))

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3305

2587

os.remove(stored_state_path)

3306

2588

except IOError as e:

3307

2589

if e.errno == errno.ENOENT:

3308

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

3309

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

2590

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

2591

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

3310

2592

else:

3311

2593

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

3312

2594

exc_info=e)

3313

2595

raise

3314

2596

except EOFError as e:

3315

2597

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

3316

"EOFError:",

3317

exc_info=e)

3318

2598

"EOFError:", exc_info=e)

2599

3319

2600

with PGPEngine() as pgp:

3320

2601

for client_name, client in clients_data.items():

3321

2602

# Skip removed clients

3322

2603

if client_name not in client_settings:

3323

2604

continue

3324

2605

3325

2606

# Decide which value to use after restoring saved state.

3326

2607

# We have three different values: Old config file,

3327

2608

# new config file, and saved state.

3332

2613

# For each value in new config, check if it

3333

2614

# differs from the old config value (Except for

3334

2615

# the "secret" attribute)

3335

if (name != "secret"

3336

and (value !=

3337

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3338

2619

client[name] = value

3339

2620

except KeyError:

3340

2621

pass

3341

2622

3342

2623

# Clients who has passed its expire date can still be

3343

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3344

2625

# whose checker succeeded before we stored its state is

3345

2626

# assumed to have successfully run all checkers during

3346

2627

# downtime.

3349

2630

if not client["last_checked_ok"]:

3350

2631

logger.warning(

3351

2632

"disabling client {} - Client never "

3352

"performed a successful checker".format(

3353

client_name))

2633

"performed a successful checker"

2634

.format(client_name))

3354

2635

client["enabled"] = False

3355

2636

elif client["last_checker_status"] != 0:

3356

2637

logger.warning(

3357

2638

"disabling client {} - Client last"

3358

" checker failed with error code"

3359

" {}".format(

3360

client_name,

3361

client["last_checker_status"]))

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3362

2642

client["enabled"] = False

3363

2643

else:

3364

client["expires"] = (

3365

datetime.datetime.utcnow()

3366

+ client["timeout"])

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3367

2647

logger.debug("Last checker succeeded,"

3368

" keeping {} enabled".format(

3369

client_name))

2648

" keeping {} enabled"

2649

.format(client_name))

3370

2650

try:

3371

client["secret"] = pgp.decrypt(

3372

client["encrypted_secret"],

3373

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3374

2655

except PGPError:

3375

2656

# If decryption fails, we use secret from new settings

3376

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

3377

client_name))

3378

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

3379

["secret"])

3380

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3381

2662

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

3382

2663

for client_name in (set(old_client_settings)

3383

2664

- set(client_settings)):

3385

2666

for client_name in (set(client_settings)

3386

2667

- set(old_client_settings)):

3387

2668

clients_data[client_name] = client_settings[client_name]

3388

2669

3389

2670

# Create all client objects

3390

2671

for client_name, client in clients_data.items():

3391

2672

tcp_server.clients[client_name] = client_class(

3392

name=client_name,

3393

settings=client,

3394

server_settings=server_settings)

3395

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3396

2676

if not tcp_server.clients:

3397

2677

logger.warning("No clients defined")

3398

2678

3399

2679

if not foreground:

3400

2680

if pidfile is not None:

3401

pid = os.getpid()

3402

2681

try:

3403

2682

with pidfile:

3404

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3405

2685

except IOError:

3406

2686

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

3407

2687

pidfilename, pid)

3408

2688

del pidfile

3409

2689

del pidfilename

3410

3411

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

3412

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3413

lambda: main_loop.quit() and False)

3414

2690

2691

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

2692

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

2693

3415

2694

if use_dbus:

3416

3417

@alternate_dbus_interfaces(

3418

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

3419

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3420

2698

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

3421

3422

2699

def __init__(self):

3423

2700

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

3424

3425

2701

_interface = "se.recompile.Mandos"

3426

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3427

2709

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

3428

2710

def ClientAdded(self, objpath):

3429

2711

"D-Bus signal"

3430

2712

pass

3431

2713

3432

2714

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

3433

def ClientNotFound(self, key_id, address):

2715

def ClientNotFound(self, fingerprint, address):

3434

2716

"D-Bus signal"

3435

2717

pass

3436

3437

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

3438

"true"})

2718

3439

2719

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

3440

2720

def ClientRemoved(self, objpath, name):

3441

2721

"D-Bus signal"

3442

2722

pass

3443

3444

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

3445

"true"})

2723

3446

2724

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

3447

2725

def GetAllClients(self):

3448

2726

"D-Bus method"

3449

return dbus.Array(c.dbus_object_path for c in

3450

tcp_server.clients.values())

3451

3452

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

3453

"true"})

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3454

2731

@dbus.service.method(_interface,

3455

2732

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

3456

2733

def GetAllClientsWithProperties(self):

3457

2734

"D-Bus method"

3458

2735

return dbus.Dictionary(

3459

{c.dbus_object_path: c.GetAll(

3460

"se.recompile.Mandos.Client")

3461

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

2736

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

2737

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

3462

2738

signature="oa{sv}")

3463

2739

3464

2740

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

3465

2741

def RemoveClient(self, object_path):

3466

2742

"D-Bus method"

3467

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3468

2744

if c.dbus_object_path == object_path:

3469

2745

del tcp_server.clients[c.name]

3470

2746

c.remove_from_connection()

3471

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3472

2748

c.disable(quiet=True)

3473

# Emit D-Bus signal for removal

3474

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3475

2751

return

3476

2752

raise KeyError(object_path)

3477

2753

3478

2754

del _interface

3479

3480

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3481

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

3482

def GetManagedObjects(self):

3483

"""D-Bus method"""

3484

return dbus.Dictionary(

3485

{client.dbus_object_path:

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()})

3490

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

3491

3492

def client_added_signal(self, client):

3493

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

3494

if use_dbus:

3495

# New standard signal

3496

self.InterfacesAdded(

3497

client.dbus_object_path,

3498

dbus.Dictionary(

3499

{interface: client.GetAll(interface)

3500

for interface in

3501

client._get_all_interface_names()}))

3502

# Old signal

3503

self.ClientAdded(client.dbus_object_path)

3504

3505

def client_removed_signal(self, client):

3506

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

3507

if use_dbus:

3508

# New standard signal

3509

self.InterfacesRemoved(

3510

client.dbus_object_path,

3511

client._get_all_interface_names())

3512

# Old signal

3513

self.ClientRemoved(client.dbus_object_path,

3514

client.name)

3515

2755

3516

2756

mandos_dbus_service = MandosDBusService()

3517

3518

# Save modules to variables to exempt the modules from being

3519

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

3520

mp = multiprocessing

3521

wn = wnull

3522

2757

3523

2758

def cleanup():

3524

2759

"Cleanup function; run on exit"

3525

2760

if zeroconf:

3526

2761

service.cleanup()

3527

3528

mp.active_children()

3529

wn.close()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3530

2765

if not (tcp_server.clients or client_settings):

3531

2766

return

3532

2767

3533

2768

# Store client before exiting. Secrets are encrypted with key

3534

2769

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

3535

2770

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

3536

2771

clients = {}

3537

2772

with PGPEngine() as pgp:

3538

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3539

2774

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

3540

2775

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

3541

2776

key)

3542

2777

client_dict = {}

3543

2778

3544

2779

# A list of attributes that can not be pickled

3545

2780

# + secret.

3546

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

3547

"checker", "server_settings"}

3548

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

3549

.Object):

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3550

2785

exclude.add(name)

3551

2786

3552

2787

client_dict["encrypted_secret"] = (client

3553

2788

.encrypted_secret)

3554

2789

for attr in client.client_structure:

3555

2790

if attr not in exclude:

3556

2791

client_dict[attr] = getattr(client, attr)

3557

2792

3558

2793

clients[client.name] = client_dict

3559

2794

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

3560

2795

3561

2796

try:

3562

with tempfile.NamedTemporaryFile(

3563

mode='wb',

3564

suffix=".pickle",

3565

prefix='clients-',

3566

dir=os.path.dirname(stored_state_path),

3567

delete=False) as stored_state:

3568

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

3569

protocol=2)

3570

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

3571

2803

os.rename(tempname, stored_state_path)

3572

2804

except (IOError, OSError) as e:

3573

2805

if not debug:

3582

2814

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

3583

2815

exc_info=e)

3584

2816

raise

3585

2817

3586

2818

# Delete all clients, and settings from config

3587

2819

while tcp_server.clients:

3588

2820

name, client = tcp_server.clients.popitem()

3589

2821

if use_dbus:

3590

2822

client.remove_from_connection()

3591

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3592

2824

client.disable(quiet=True)

3593

# Emit D-Bus signal for removal

3594

2825

if use_dbus:

3595

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)

3596

2830

client_settings.clear()

3597

2831

3598

2832

atexit.register(cleanup)

3599

3600

for client in tcp_server.clients.values():

2833

2834

for client in tcp_server.clients.itervalues():

3601

2835

if use_dbus:

3602

# Emit D-Bus signal for adding

3603

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3604

2838

# Need to initiate checking of clients

3605

2839

if client.enabled:

3606

2840

client.init_checker()

3607

2841

3608

2842

tcp_server.enable()

3609

2843

tcp_server.server_activate()

3610

2844

3611

2845

# Find out what port we got

3612

2846

if zeroconf:

3613

2847

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

3618

2852

else: # IPv4

3619

2853

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

3620

2854

*tcp_server.socket.getsockname())

3621

3622

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

3623

2855

2856

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

2857

3624

2858

try:

3625

2859

if zeroconf:

3626

2860

# From the Avahi example code

3631

2865

cleanup()

3632

2866

sys.exit(1)

3633

2867

# End of Avahi example code

3634

3635

GLib.io_add_watch(

3636

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

3637

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3638

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

3639

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

3640

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

3641

2874

logger.debug("Starting main loop")

3642

2875

main_loop.run()

3643

2876

except AvahiError as error:

3652

2885

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

3653

2886

cleanup()

3654

2887

3655

3656

def should_only_run_tests():

3657

parser = argparse.ArgumentParser(add_help=False)

3658

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

3659

args, unknown_args = parser.parse_known_args()

3660

run_tests = args.check

3661

if run_tests:

3662

# Remove --check argument from sys.argv

3663

sys.argv[1:] = unknown_args

3664

return run_tests

3665

3666

# Add all tests from doctest strings

3667

def load_tests(loader, tests, none):

3668

import doctest

3669

tests.addTests(doctest.DocTestSuite())

3670

return tests

3671

3672

2888

if __name__ == '__main__':

3673

try:

3674

if should_only_run_tests():

3675

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

3676

unittest.main()

3677

else:

3678

main()

3679

finally:

3680

logging.shutdown()

2889

main()