/mandos/release : revision 237.7.295

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

import random

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

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

98

try:

99

collections.abc.Callable

100

except AttributeError:

101

class abc:

102

Callable = collections.Callable

103

collections.abc = abc

104

del abc

105

106

# Show warnings by default

107

if not sys.warnoptions:

108

import warnings

109

warnings.simplefilter("default")

110

111

# Try to find the value of SO_BINDTODEVICE:

112

try:

113

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

114

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

83

try:

115

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

116

85

except AttributeError:

117

86

try:

118

# This is where SO_BINDTODEVICE was up to and including Python

119

# 2.6, and also 3.2:

120

87

from IN import SO_BINDTODEVICE

121

88

except ImportError:

122

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

123

# Try running the C preprocessor:

124

try:

125

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

126

"/dev/stdin"],

127

stdin=subprocess.PIPE,

128

stdout=subprocess.PIPE)

129

stdout = cc.communicate(

130

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

131

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

132

except (OSError, ValueError, IndexError):

133

# No value found

134

SO_BINDTODEVICE = None

135

136

if sys.version_info < (3, 2):

137

configparser.Configparser = configparser.SafeConfigParser

138

139

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

140

95

stored_state_file = "clients.pickle"

141

96

142

97

logger = logging.getLogger()

143

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

144

98

syslogger = None

145

99

146

100

try:

147

101

if_nametoindex = ctypes.cdll.LoadLibrary(

148

102

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

149

103

except (OSError, AttributeError):

150

104

151

105

def if_nametoindex(interface):

152

106

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

153

107

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

158

112

return interface_index

159

113

160

114

161

def copy_function(func):

162

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

163

if sys.version_info.major == 2:

164

return types.FunctionType(func.func_code,

165

func.func_globals,

166

func.func_name,

167

func.func_defaults,

168

func.func_closure)

169

else:

170

return types.FunctionType(func.__code__,

171

func.__globals__,

172

func.__name__,

173

func.__defaults__,

174

func.__closure__)

175

176

177

115

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

178

116

"""init logger and add loglevel"""

179

117

180

118

global syslogger

181

119

syslogger = (logging.handlers.SysLogHandler(

182

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

183

address="/dev/log"))

120

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

121

address = "/dev/log"))

184

122

syslogger.setFormatter(logging.Formatter

185

123

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

186

124

' %(message)s'))

187

125

logger.addHandler(syslogger)

188

126

189

127

if debug:

190

128

console = logging.StreamHandler()

191

129

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

201

139

pass

202

140

203

141

204

class PGPEngine:

142

class PGPEngine(object):

205

143

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

206

144

207

145

def __init__(self):

208

146

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

209

self.gpg = "gpg"

210

try:

211

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

212

for line in output.splitlines():

213

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

214

if name == b"gpg":

215

self.gpg = path

216

break

217

except OSError as e:

218

if e.errno != errno.ENOENT:

219

raise

220

147

self.gnupgargs = ['--batch',

221

'--homedir', self.tempdir,

148

'--home', self.tempdir,

222

149

'--force-mdc',

223

'--quiet']

224

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

225

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

226

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

227

150

'--quiet',

151

'--no-use-agent']

152

228

153

def __enter__(self):

229

154

return self

230

155

231

156

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

232

157

self._cleanup()

233

158

return False

234

159

235

160

def __del__(self):

236

161

self._cleanup()

237

162

238

163

def _cleanup(self):

239

164

if self.tempdir is not None:

240

165

# Delete contents of tempdir

241

166

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

242

topdown=False):

167

topdown = False):

243

168

for filename in files:

244

169

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

245

170

for dirname in dirs:

247

172

# Remove tempdir

248

173

os.rmdir(self.tempdir)

249

174

self.tempdir = None

250

175

251

176

def password_encode(self, password):

252

177

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

253

178

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

258

183

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

259

184

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

260

185

return encoded

261

186

262

187

def encrypt(self, data, password):

263

188

passphrase = self.password_encode(password)

264

189

with tempfile.NamedTemporaryFile(

265

190

dir=self.tempdir) as passfile:

266

191

passfile.write(passphrase)

267

192

passfile.flush()

268

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

193

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

269

194

'--passphrase-file',

270

195

passfile.name]

271

196

+ self.gnupgargs,

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

276

201

if proc.returncode != 0:

277

202

raise PGPError(err)

278

203

return ciphertext

279

204

280

205

def decrypt(self, data, password):

281

206

passphrase = self.password_encode(password)

282

207

with tempfile.NamedTemporaryFile(

283

dir=self.tempdir) as passfile:

208

dir = self.tempdir) as passfile:

284

209

passfile.write(passphrase)

285

210

passfile.flush()

286

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

211

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

287

212

'--passphrase-file',

288

213

passfile.name]

289

214

+ self.gnupgargs,

290

stdin=subprocess.PIPE,

291

stdout=subprocess.PIPE,

292

stderr=subprocess.PIPE)

293

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

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

294

219

if proc.returncode != 0:

295

220

raise PGPError(err)

296

221

return decrypted_plaintext

297

222

298

223

299

# Pretend that we have an Avahi module

300

class avahi:

301

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

302

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

303

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

304

PROTO_INET = 0 # avahi-common/address.h

305

PROTO_INET6 = 1 # avahi-common/address.h

306

DBUS_NAME = "org.freedesktop.Avahi"

307

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

308

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

309

DBUS_PATH_SERVER = "/"

310

311

@staticmethod

312

def string_array_to_txt_array(t):

313

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

314

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

315

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

316

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

317

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

318

SERVER_INVALID = 0 # avahi-common/defs.h

319

SERVER_REGISTERING = 1 # avahi-common/defs.h

320

SERVER_RUNNING = 2 # avahi-common/defs.h

321

SERVER_COLLISION = 3 # avahi-common/defs.h

322

SERVER_FAILURE = 4 # avahi-common/defs.h

323

324

325

224

class AvahiError(Exception):

326

225

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

327

226

self.value = value

337

236

pass

338

237

339

238

340

class AvahiService:

239

class AvahiService(object):

341

240

"""An Avahi (Zeroconf) service.

342

241

343

242

Attributes:

344

243

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

345

244

Used to optionally bind to the specified interface.

357

256

server: D-Bus Server

358

257

bus: dbus.SystemBus()

359

258

"""

360

259

361

260

def __init__(self,

362

interface=avahi.IF_UNSPEC,

363

name=None,

364

servicetype=None,

365

port=None,

366

TXT=None,

367

domain="",

368

host="",

369

max_renames=32768,

370

protocol=avahi.PROTO_UNSPEC,

371

bus=None):

261

interface = avahi.IF_UNSPEC,

262

name = None,

263

servicetype = None,

264

port = None,

265

TXT = None,

266

domain = "",

267

host = "",

268

max_renames = 32768,

269

protocol = avahi.PROTO_UNSPEC,

270

bus = None):

372

271

self.interface = interface

373

272

self.name = name

374

273

self.type = servicetype

383

282

self.server = None

384

283

self.bus = bus

385

284

self.entry_group_state_changed_match = None

386

285

387

286

def rename(self, remove=True):

388

287

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

389

288

if self.rename_count >= self.max_renames:

409

308

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

410

309

self.cleanup()

411

310

os._exit(1)

412

311

413

312

def remove(self):

414

313

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

415

314

if self.entry_group_state_changed_match is not None:

417

316

self.entry_group_state_changed_match = None

418

317

if self.group is not None:

419

318

self.group.Reset()

420

319

421

320

def add(self):

422

321

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

423

322

self.remove()

440

339

dbus.UInt16(self.port),

441

340

avahi.string_array_to_txt_array(self.TXT))

442

341

self.group.Commit()

443

342

444

343

def entry_group_state_changed(self, state, error):

445

344

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

446

345

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

447

346

448

347

if state == avahi.ENTRY_GROUP_ESTABLISHED:

449

348

logger.debug("Zeroconf service established.")

450

349

elif state == avahi.ENTRY_GROUP_COLLISION:

454

353

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

455

354

str(error))

456

355

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

457

356

458

357

def cleanup(self):

459

358

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

460

359

if self.group is not None:

465

364

pass

466

365

self.group = None

467

366

self.remove()

468

367

469

368

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

470

369

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

471

370

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

483

382

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

484

383

self.cleanup()

485

384

elif state == avahi.SERVER_RUNNING:

486

try:

487

self.add()

488

except dbus.exceptions.DBusException as error:

489

if (error.get_dbus_name()

490

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

491

logger.info("Local Zeroconf service name"

492

" collision.")

493

return self.rename(remove=False)

494

else:

495

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

496

self.cleanup()

497

os._exit(1)

385

self.add()

498

386

else:

499

387

if error is None:

500

388

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

501

389

else:

502

390

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

503

391

504

392

def activate(self):

505

393

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

506

394

if self.server is None:

517

405

class AvahiServiceToSyslog(AvahiService):

518

406

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

519

407

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

520

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

408

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

521

409

syslogger.setFormatter(logging.Formatter(

522

410

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

523

411

.format(self.name)))

524

412

return ret

525

413

526

414

527

# Pretend that we have a GnuTLS module

528

class gnutls:

529

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

530

531

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

532

if library is None:

533

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

534

_library = ctypes.cdll.LoadLibrary(library)

535

del library

536

537

# Unless otherwise indicated, the constants and types below are

538

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

539

540

# Constants

541

E_SUCCESS = 0

542

E_INTERRUPTED = -52

543

E_AGAIN = -28

544

CRT_OPENPGP = 2

545

CRT_RAWPK = 3

546

CLIENT = 2

547

SHUT_RDWR = 0

548

CRD_CERTIFICATE = 1

549

E_NO_CERTIFICATE_FOUND = -49

550

X509_FMT_DER = 0

551

NO_TICKETS = 1<<10

552

ENABLE_RAWPK = 1<<18

553

CTYPE_PEERS = 3

554

KEYID_USE_SHA256 = 1 # gnutls/x509.h

555

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

556

557

# Types

558

class session_int(ctypes.Structure):

559

_fields_ = []

560

session_t = ctypes.POINTER(session_int)

561

562

class certificate_credentials_st(ctypes.Structure):

563

_fields_ = []

564

certificate_credentials_t = ctypes.POINTER(

565

certificate_credentials_st)

566

certificate_type_t = ctypes.c_int

567

568

class datum_t(ctypes.Structure):

569

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

570

('size', ctypes.c_uint)]

571

572

class openpgp_crt_int(ctypes.Structure):

573

_fields_ = []

574

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

575

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

576

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

577

credentials_type_t = ctypes.c_int

578

transport_ptr_t = ctypes.c_void_p

579

close_request_t = ctypes.c_int

580

581

# Exceptions

582

class Error(Exception):

583

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

584

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

585

# code is passed, convert it to a string with

586

# gnutls.strerror()

587

self.code = code

588

if message is None and code is not None:

589

message = gnutls.strerror(code)

590

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

591

message, *args)

592

593

class CertificateSecurityError(Error):

594

pass

595

596

# Classes

597

class Credentials:

598

def __init__(self):

599

self._c_object = gnutls.certificate_credentials_t()

600

gnutls.certificate_allocate_credentials(

601

ctypes.byref(self._c_object))

602

self.type = gnutls.CRD_CERTIFICATE

603

604

def __del__(self):

605

gnutls.certificate_free_credentials(self._c_object)

606

607

class ClientSession:

608

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

609

self._c_object = gnutls.session_t()

610

gnutls_flags = gnutls.CLIENT

611

if gnutls.check_version(b"3.5.6"):

612

gnutls_flags |= gnutls.NO_TICKETS

613

if gnutls.has_rawpk:

614

gnutls_flags |= gnutls.ENABLE_RAWPK

615

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

616

del gnutls_flags

617

gnutls.set_default_priority(self._c_object)

618

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

619

gnutls.handshake_set_private_extensions(self._c_object,

620

True)

621

self.socket = socket

622

if credentials is None:

623

credentials = gnutls.Credentials()

624

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

625

ctypes.cast(credentials._c_object,

626

ctypes.c_void_p))

627

self.credentials = credentials

628

629

def __del__(self):

630

gnutls.deinit(self._c_object)

631

632

def handshake(self):

633

return gnutls.handshake(self._c_object)

634

635

def send(self, data):

636

data = bytes(data)

637

data_len = len(data)

638

while data_len > 0:

639

data_len -= gnutls.record_send(self._c_object,

640

data[-data_len:],

641

data_len)

642

643

def bye(self):

644

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

645

646

# Error handling functions

647

def _error_code(result):

648

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

649

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

650

if result >= 0:

651

return result

652

if result == gnutls.E_NO_CERTIFICATE_FOUND:

653

raise gnutls.CertificateSecurityError(code=result)

654

raise gnutls.Error(code=result)

655

656

def _retry_on_error(result, func, arguments):

657

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

658

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

659

while result < 0:

660

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

661

return _error_code(result)

662

result = func(*arguments)

663

return result

664

665

# Unless otherwise indicated, the function declarations below are

666

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

667

668

# Functions

669

priority_set_direct = _library.gnutls_priority_set_direct

670

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

671

ctypes.POINTER(ctypes.c_char_p)]

672

priority_set_direct.restype = _error_code

673

674

init = _library.gnutls_init

675

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

676

init.restype = _error_code

677

678

set_default_priority = _library.gnutls_set_default_priority

679

set_default_priority.argtypes = [session_t]

680

set_default_priority.restype = _error_code

681

682

record_send = _library.gnutls_record_send

683

record_send.argtypes = [session_t, ctypes.c_void_p,

684

ctypes.c_size_t]

685

record_send.restype = ctypes.c_ssize_t

686

record_send.errcheck = _retry_on_error

687

688

certificate_allocate_credentials = (

689

_library.gnutls_certificate_allocate_credentials)

690

certificate_allocate_credentials.argtypes = [

691

ctypes.POINTER(certificate_credentials_t)]

692

certificate_allocate_credentials.restype = _error_code

693

694

certificate_free_credentials = (

695

_library.gnutls_certificate_free_credentials)

696

certificate_free_credentials.argtypes = [

697

certificate_credentials_t]

698

certificate_free_credentials.restype = None

699

700

handshake_set_private_extensions = (

701

_library.gnutls_handshake_set_private_extensions)

702

handshake_set_private_extensions.argtypes = [session_t,

703

ctypes.c_int]

704

handshake_set_private_extensions.restype = None

705

706

credentials_set = _library.gnutls_credentials_set

707

credentials_set.argtypes = [session_t, credentials_type_t,

708

ctypes.c_void_p]

709

credentials_set.restype = _error_code

710

711

strerror = _library.gnutls_strerror

712

strerror.argtypes = [ctypes.c_int]

713

strerror.restype = ctypes.c_char_p

714

715

certificate_type_get = _library.gnutls_certificate_type_get

716

certificate_type_get.argtypes = [session_t]

717

certificate_type_get.restype = _error_code

718

719

certificate_get_peers = _library.gnutls_certificate_get_peers

720

certificate_get_peers.argtypes = [session_t,

721

ctypes.POINTER(ctypes.c_uint)]

722

certificate_get_peers.restype = ctypes.POINTER(datum_t)

723

724

global_set_log_level = _library.gnutls_global_set_log_level

725

global_set_log_level.argtypes = [ctypes.c_int]

726

global_set_log_level.restype = None

727

728

global_set_log_function = _library.gnutls_global_set_log_function

729

global_set_log_function.argtypes = [log_func]

730

global_set_log_function.restype = None

731

732

deinit = _library.gnutls_deinit

733

deinit.argtypes = [session_t]

734

deinit.restype = None

735

736

handshake = _library.gnutls_handshake

737

handshake.argtypes = [session_t]

738

handshake.restype = _error_code

739

handshake.errcheck = _retry_on_error

740

741

transport_set_ptr = _library.gnutls_transport_set_ptr

742

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

743

transport_set_ptr.restype = None

744

745

bye = _library.gnutls_bye

746

bye.argtypes = [session_t, close_request_t]

747

bye.restype = _error_code

748

bye.errcheck = _retry_on_error

749

750

check_version = _library.gnutls_check_version

751

check_version.argtypes = [ctypes.c_char_p]

752

check_version.restype = ctypes.c_char_p

753

754

_need_version = b"3.3.0"

755

if check_version(_need_version) is None:

756

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

757

.format(_need_version))

758

759

_tls_rawpk_version = b"3.6.6"

760

has_rawpk = bool(check_version(_tls_rawpk_version))

761

762

if has_rawpk:

763

# Types

764

class pubkey_st(ctypes.Structure):

765

_fields = []

766

pubkey_t = ctypes.POINTER(pubkey_st)

767

768

x509_crt_fmt_t = ctypes.c_int

769

770

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

771

pubkey_init = _library.gnutls_pubkey_init

772

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

773

pubkey_init.restype = _error_code

774

775

pubkey_import = _library.gnutls_pubkey_import

776

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

777

x509_crt_fmt_t]

778

pubkey_import.restype = _error_code

779

780

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

781

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

782

ctypes.POINTER(ctypes.c_ubyte),

783

ctypes.POINTER(ctypes.c_size_t)]

784

pubkey_get_key_id.restype = _error_code

785

786

pubkey_deinit = _library.gnutls_pubkey_deinit

787

pubkey_deinit.argtypes = [pubkey_t]

788

pubkey_deinit.restype = None

789

else:

790

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

791

792

openpgp_crt_init = _library.gnutls_openpgp_crt_init

793

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

794

openpgp_crt_init.restype = _error_code

795

796

openpgp_crt_import = _library.gnutls_openpgp_crt_import

797

openpgp_crt_import.argtypes = [openpgp_crt_t,

798

ctypes.POINTER(datum_t),

799

openpgp_crt_fmt_t]

800

openpgp_crt_import.restype = _error_code

801

802

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

803

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

804

ctypes.POINTER(ctypes.c_uint)]

805

openpgp_crt_verify_self.restype = _error_code

806

807

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

808

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

809

openpgp_crt_deinit.restype = None

810

811

openpgp_crt_get_fingerprint = (

812

_library.gnutls_openpgp_crt_get_fingerprint)

813

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

814

ctypes.c_void_p,

815

ctypes.POINTER(

816

ctypes.c_size_t)]

817

openpgp_crt_get_fingerprint.restype = _error_code

818

819

if check_version(b"3.6.4"):

820

certificate_type_get2 = _library.gnutls_certificate_type_get2

821

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

822

certificate_type_get2.restype = _error_code

823

824

# Remove non-public functions

825

del _error_code, _retry_on_error

826

827

828

def call_pipe(connection, # : multiprocessing.Connection

829

func, *args, **kwargs):

830

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

831

832

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

833

return value on the provided multiprocessing.Connection.

834

"""

835

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

836

connection.close()

837

838

839

class Client:

415

class Client(object):

840

416

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

841

417

842

418

Attributes:

843

419

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

844

420

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

845

421

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

846

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

847

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

848

running.

849

checker_callback_tag: a GLib event source tag, or None

422

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

423

to see if the client lives.

424

'None' if no process is running.

425

checker_callback_tag: a gobject event source tag, or None

850

426

checker_command: string; External command which is run to check

851

427

if client lives. %() expansions are done at

852

428

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

853

429

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

854

checker_initiator_tag: a GLib event source tag, or None

430

checker_initiator_tag: a gobject event source tag, or None

855

431

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

856

432

client_structure: Object describing what attributes a client has

857

433

and is used for storing the client at exit

858

434

current_checker_command: string; current running checker_command

859

disable_initiator_tag: a GLib event source tag, or None

435

disable_initiator_tag: a gobject event source tag, or None

860

436

enabled: bool()

861

437

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

862

uniquely identify an OpenPGP client

863

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

864

a client using raw public keys

438

uniquely identify the client

865

439

host: string; available for use by the checker command

866

440

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

867

441

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

869

443

last_checker_status: integer between 0 and 255 reflecting exit

870

444

status of last checker. -1 reflects crashed

871

445

checker, -2 means no checker completed yet.

872

last_checker_signal: The signal which killed the last checker, if

873

last_checker_status is -1

874

446

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

875

447

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

876

448

D-Bus identifiers

883

455

disabled, or None

884

456

server_settings: The server_settings dict from main()

885

457

"""

886

458

887

459

runtime_expansions = ("approval_delay", "approval_duration",

888

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

460

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

889

461

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

890

462

"last_approval_request", "last_checked_ok",

891

463

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

900

472

"approved_by_default": "True",

901

473

"enabled": "True",

902

474

}

903

475

904

476

@staticmethod

905

477

def config_parser(config):

906

478

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

913

485

for client_name in config.sections():

914

486

section = dict(config.items(client_name))

915

487

client = settings[client_name] = {}

916

488

917

489

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

918

490

# Reformat values from string types to Python types

919

491

client["approved_by_default"] = config.getboolean(

920

492

client_name, "approved_by_default")

921

493

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

922

494

"enabled")

923

924

# Uppercase and remove spaces from key_id and fingerprint

925

# for later comparison purposes with return value from the

926

# key_id() and fingerprint() functions

927

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

928

.replace(" ", ""))

495

496

# Uppercase and remove spaces from fingerprint for later

497

# comparison purposes with return value from the

498

# fingerprint() function

929

499

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

930

500

.replace(" ", ""))

931

501

if "secret" in section:

932

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

933

.encode("utf-8"),

934

"base64")

502

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

935

503

elif "secfile" in section:

936

504

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

937

505

(section["secfile"])),

952

520

client["last_approval_request"] = None

953

521

client["last_checked_ok"] = None

954

522

client["last_checker_status"] = -2

955

523

956

524

return settings

957

958

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

525

526

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

959

527

self.name = name

960

528

if server_settings is None:

961

529

server_settings = {}

963

531

# adding all client settings

964

532

for setting, value in settings.items():

965

533

setattr(self, setting, value)

966

534

967

535

if self.enabled:

968

536

if not hasattr(self, "last_enabled"):

969

537

self.last_enabled = datetime.datetime.utcnow()

973

541

else:

974

542

self.last_enabled = None

975

543

self.expires = None

976

544

977

545

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

978

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

979

546

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

980

547

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

981

548

datetime.datetime.utcnow())

982

549

983

550

# attributes specific for this server instance

984

551

self.checker = None

985

552

self.checker_initiator_tag = None

991

558

self.changedstate = multiprocessing_manager.Condition(

992

559

multiprocessing_manager.Lock())

993

560

self.client_structure = [attr

994

for attr in self.__dict__.keys()

561

for attr in self.__dict__.iterkeys()

995

562

if not attr.startswith("_")]

996

563

self.client_structure.append("client_structure")

997

564

998

565

for name, t in inspect.getmembers(

999

566

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

1000

567

if not name.startswith("_"):

1001

568

self.client_structure.append(name)

1002

569

1003

570

# Send notice to process children that client state has changed

1004

571

def send_changedstate(self):

1005

572

with self.changedstate:

1006

573

self.changedstate.notify_all()

1007

574

1008

575

def enable(self):

1009

576

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

1010

577

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

1015

582

self.last_enabled = datetime.datetime.utcnow()

1016

583

self.init_checker()

1017

584

self.send_changedstate()

1018

585

1019

586

def disable(self, quiet=True):

1020

587

"""Disable this client."""

1021

588

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

1023

590

if not quiet:

1024

591

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

1025

592

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

1026

GLib.source_remove(self.disable_initiator_tag)

593

gobject.source_remove(self.disable_initiator_tag)

1027

594

self.disable_initiator_tag = None

1028

595

self.expires = None

1029

596

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

1030

GLib.source_remove(self.checker_initiator_tag)

597

gobject.source_remove(self.checker_initiator_tag)

1031

598

self.checker_initiator_tag = None

1032

599

self.stop_checker()

1033

600

self.enabled = False

1034

601

if not quiet:

1035

602

self.send_changedstate()

1036

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

603

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

1037

604

return False

1038

605

1039

606

def __del__(self):

1040

607

self.disable()

1041

608

1042

609

def init_checker(self):

1043

610

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

1044

611

# and every interval from then on.

1045

612

if self.checker_initiator_tag is not None:

1046

GLib.source_remove(self.checker_initiator_tag)

1047

self.checker_initiator_tag = GLib.timeout_add(

1048

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

1049

+ 1)),

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = gobject.timeout_add(

615

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

1050

616

self.start_checker)

1051

617

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

1052

618

if self.disable_initiator_tag is not None:

1053

GLib.source_remove(self.disable_initiator_tag)

1054

self.disable_initiator_tag = GLib.timeout_add(

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = gobject.timeout_add(

1055

621

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

1056

622

# Also start a new checker *right now*.

1057

623

self.start_checker()

1058

1059

def checker_callback(self, source, condition, connection,

1060

command):

624

625

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

1061

626

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

1062

# Read return code from connection (see call_pipe)

1063

returncode = connection.recv()

1064

connection.close()

1065

if self.checker is not None:

1066

self.checker.join()

1067

627

self.checker_callback_tag = None

1068

628

self.checker = None

1069

1070

if returncode >= 0:

1071

self.last_checker_status = returncode

1072

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1073

631

if self.last_checker_status == 0:

1074

632

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

1075

633

vars(self))

1078

636

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

1079

637

else:

1080

638

self.last_checker_status = -1

1081

self.last_checker_signal = -returncode

1082

639

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

1083

640

vars(self))

1084

return False

1085

641

1086

642

def checked_ok(self):

1087

643

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

1088

644

self.last_checked_ok = datetime.datetime.utcnow()

1089

645

self.last_checker_status = 0

1090

self.last_checker_signal = None

1091

646

self.bump_timeout()

1092

647

1093

648

def bump_timeout(self, timeout=None):

1094

649

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

1095

650

if timeout is None:

1096

651

timeout = self.timeout

1097

652

if self.disable_initiator_tag is not None:

1098

GLib.source_remove(self.disable_initiator_tag)

653

gobject.source_remove(self.disable_initiator_tag)

1099

654

self.disable_initiator_tag = None

1100

655

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

1101

self.disable_initiator_tag = GLib.timeout_add(

656

self.disable_initiator_tag = gobject.timeout_add(

1102

657

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

1103

658

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

1104

659

1105

660

def need_approval(self):

1106

661

self.last_approval_request = datetime.datetime.utcnow()

1107

662

1108

663

def start_checker(self):

1109

664

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

1110

665

1111

666

If a checker already exists, leave it running and do

1112

667

nothing."""

1113

668

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

1118

673

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

1119

674

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

1120

675

# should be.

1121

1122

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

1123

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

1124

self.checker.join()

1125

self.checker = None

676

677

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

678

try:

679

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

680

except AttributeError:

681

pass

682

except OSError as error:

683

if error.errno != errno.ECHILD:

684

raise

685

else:

686

if pid:

687

logger.warning("Checker was a zombie")

688

gobject.source_remove(self.checker_callback_tag)

689

self.checker_callback(pid, status,

690

self.current_checker_command)

1126

691

# Start a new checker if needed

1127

692

if self.checker is None:

1128

693

# Escape attributes for the shell

1129

694

escaped_attrs = {

1130

695

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

1131

for attr in self.runtime_expansions}

696

for attr in self.runtime_expansions }

1132

697

try:

1133

698

command = self.checker_command % escaped_attrs

1134

699

except TypeError as error:

1137

702

exc_info=error)

1138

703

return True # Try again later

1139

704

self.current_checker_command = command

1140

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

1141

self.name)

1142

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

1143

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

1144

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

1145

# always replaced by /dev/null.)

1146

# The exception is when not debugging but nevertheless

1147

# running in the foreground; use the previously

1148

# created wnull.

1149

popen_args = {"close_fds": True,

1150

"shell": True,

1151

"cwd": "/"}

1152

if (not self.server_settings["debug"]

1153

and self.server_settings["foreground"]):

1154

popen_args.update({"stdout": wnull,

1155

"stderr": wnull})

1156

pipe = multiprocessing.Pipe(duplex=False)

1157

self.checker = multiprocessing.Process(

1158

target=call_pipe,

1159

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

1160

kwargs=popen_args)

1161

self.checker.start()

1162

self.checker_callback_tag = GLib.io_add_watch(

1163

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

1164

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1165

self.checker_callback, pipe[0], command)

1166

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

705

try:

706

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

707

self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

# The exception is when not debugging but nevertheless

713

# running in the foreground; use the previously

714

# created wnull.

715

popen_args = {}

716

if (not self.server_settings["debug"]

717

and self.server_settings["foreground"]):

718

popen_args.update({"stdout": wnull,

719

"stderr": wnull })

720

self.checker = subprocess.Popen(command,

721

close_fds=True,

722

shell=True,

723

cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

return True

729

self.checker_callback_tag = gobject.child_watch_add(

730

self.checker.pid, self.checker_callback, data=command)

731

# The checker may have completed before the gobject

732

# watch was added. Check for this.

733

try:

734

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

735

except OSError as error:

736

if error.errno == errno.ECHILD:

737

# This should never happen

738

logger.error("Child process vanished",

739

exc_info=error)

740

return True

741

raise

742

if pid:

743

gobject.source_remove(self.checker_callback_tag)

744

self.checker_callback(pid, status, command)

745

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

1167

746

return True

1168

747

1169

748

def stop_checker(self):

1170

749

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

1171

750

if self.checker_callback_tag:

1172

GLib.source_remove(self.checker_callback_tag)

751

gobject.source_remove(self.checker_callback_tag)

1173

752

self.checker_callback_tag = None

1174

753

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

1175

754

return

1176

755

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

1177

self.checker.terminate()

756

try:

757

self.checker.terminate()

758

#time.sleep(0.5)

759

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

760

# self.checker.kill()

761

except OSError as error:

762

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

763

raise

1178

764

self.checker = None

1179

765

1180

766

1184

770

byte_arrays=False):

1185

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1186

772

become properties on the D-Bus.

1187

773

1188

774

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

1189

775

and with one argument by "Set".

1190

776

1191

777

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

1192

778

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

1193

779

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

1197

783

if byte_arrays and signature != "ay":

1198

784

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

1199

785

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

1200

786

1201

787

def decorator(func):

1202

788

func._dbus_is_property = True

1203

789

func._dbus_interface = dbus_interface

1206

792

func._dbus_name = func.__name__

1207

793

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

1208

794

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

1209

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

795

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1210

796

return func

1211

797

1212

798

return decorator

1213

799

1214

800

1215

801

def dbus_interface_annotations(dbus_interface):

1216

802

"""Decorator for marking functions returning interface annotations

1217

803

1218

804

Usage:

1219

805

1220

806

@dbus_interface_annotations("org.example.Interface")

1221

807

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

1222

808

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

1223

809

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

1224

810

"false"}

1225

811

"""

1226

812

1227

813

def decorator(func):

1228

814

func._dbus_is_interface = True

1229

815

func._dbus_interface = dbus_interface

1230

816

func._dbus_name = dbus_interface

1231

817

return func

1232

818

1233

819

return decorator

1234

820

1235

821

1236

822

def dbus_annotations(annotations):

1237

823

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

1238

824

Usage:

1239

825

1240

826

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

1241

827

"org.freedesktop.DBus.Property."

1242

828

"EmitsChangedSignal": "false"})

1244

830

access="r")

1245

831

def Property_dbus_property(self):

1246

832

return dbus.Boolean(False)

1247

1248

See also the DBusObjectWithAnnotations class.

1249

833

"""

1250

834

1251

835

def decorator(func):

1252

836

func._dbus_annotations = annotations

1253

837

return func

1254

838

1255

839

return decorator

1256

840

1257

841

1273

857

pass

1274

858

1275

859

1276

class DBusObjectWithAnnotations(dbus.service.Object):

1277

"""A D-Bus object with annotations.

1278

1279

Classes inheriting from this can use the dbus_annotations

1280

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1281

866

"""

1282

867

1283

868

@staticmethod

1284

869

def _is_dbus_thing(thing):

1285

870

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

1286

871

1287

872

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

1288

873

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

1289

874

"""

1290

875

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

1291

876

False)

1292

877

1293

878

def _get_all_dbus_things(self, thing):

1294

879

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

1295

880

"""

1298

883

for cls in self.__class__.__mro__

1299

884

for name, athing in

1300

885

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

1301

1302

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1303

out_signature="s",

1304

path_keyword='object_path',

1305

connection_keyword='connection')

1306

def Introspect(self, object_path, connection):

1307

"""Overloading of standard D-Bus method.

1308

1309

Inserts annotation tags on methods and signals.

1310

"""

1311

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

1312

connection)

1313

try:

1314

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

1315

1316

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

1317

# Add annotation tags

1318

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

1319

for tag in if_tag.getElementsByTagName(typ):

1320

annots = dict()

1321

for name, prop in (self.

1322

_get_all_dbus_things(typ)):

1323

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

1324

and prop._dbus_interface

1325

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

1326

annots.update(getattr(

1327

prop, "_dbus_annotations", {}))

1328

for name, value in annots.items():

1329

ann_tag = document.createElement(

1330

"annotation")

1331

ann_tag.setAttribute("name", name)

1332

ann_tag.setAttribute("value", value)

1333

tag.appendChild(ann_tag)

1334

# Add interface annotation tags

1335

for annotation, value in dict(

1336

itertools.chain.from_iterable(

1337

annotations().items()

1338

for name, annotations

1339

in self._get_all_dbus_things("interface")

1340

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

1341

)).items():

1342

ann_tag = document.createElement("annotation")

1343

ann_tag.setAttribute("name", annotation)

1344

ann_tag.setAttribute("value", value)

1345

if_tag.appendChild(ann_tag)

1346

# Fix argument name for the Introspect method itself

1347

if (if_tag.getAttribute("name")

1348

== dbus.INTROSPECTABLE_IFACE):

1349

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

1350

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

1351

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

1352

if (arg.getAttribute("direction")

1353

== "out"):

1354

arg.setAttribute("name",

1355

"xml_data")

1356

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

1357

document.unlink()

1358

except (AttributeError, xml.dom.DOMException,

1359

xml.parsers.expat.ExpatError) as error:

1360

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

1361

exc_info=error)

1362

return xmlstring

1363

1364

1365

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1366

"""A D-Bus object with properties.

1367

1368

Classes inheriting from this can use the dbus_service_property

1369

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

1370

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

1371

"""

1372

886

1373

887

def _get_dbus_property(self, interface_name, property_name):

1374

888

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

1375

889

property with the specified name and interface.

1380

894

if (value._dbus_name == property_name

1381

895

and value._dbus_interface == interface_name):

1382

896

return value.__get__(self)

1383

897

1384

898

# No such property

1385

899

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

1386

900

self.dbus_object_path, interface_name, property_name))

1387

1388

@classmethod

1389

def _get_all_interface_names(cls):

1390

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

1391

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

1392

"_dbus_interface", None)

1393

for x in (inspect.getmro(cls))

1394

for attr in dir(x))

1395

if name is not None)

1396

901

1397

902

@dbus.service.method(dbus.PROPERTIES_IFACE,

1398

903

in_signature="ss",

1399

904

out_signature="v")

1407

912

if not hasattr(value, "variant_level"):

1408

913

return value

1409

914

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

1410

915

1411

916

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

1412

917

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

1413

918

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

1422

927

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

1423

928

"'ay' signature {!r}"

1424

929

.format(prop._dbus_signature))

1425

value = dbus.ByteArray(bytes(value))

930

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

931

for byte in value))

1426

932

prop(value)

1427

933

1428

934

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

935

in_signature="s",

1430

936

out_signature="a{sv}")

1431

937

def GetAll(self, interface_name):

1432

938

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

1433

939

standard.

1434

940

1435

941

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

1436

942

"""

1437

943

properties = {}

1448

954

properties[name] = value

1449

955

continue

1450

956

properties[name] = type(value)(

1451

value, variant_level=value.variant_level + 1)

957

value, variant_level = value.variant_level + 1)

1452

958

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

1453

959

1454

960

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

1455

961

def PropertiesChanged(self, interface_name, changed_properties,

1456

962

invalidated_properties):

1458

964

standard.

1459

965

"""

1460

966

pass

1461

967

1462

968

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1463

969

out_signature="s",

1464

970

path_keyword='object_path',

1465

971

connection_keyword='connection')

1466

972

def Introspect(self, object_path, connection):

1467

973

"""Overloading of standard D-Bus method.

1468

974

1469

975

Inserts property tags and interface annotation tags.

1470

976

"""

1471

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1472

object_path,

1473

connection)

977

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

978

connection)

1474

979

try:

1475

980

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

1476

981

1477

982

def make_tag(document, name, prop):

1478

983

e = document.createElement("property")

1479

984

e.setAttribute("name", name)

1480

985

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

1481

986

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

1482

987

return e

1483

988

1484

989

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

1485

990

# Add property tags

1486

991

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

1489

994

if prop._dbus_interface

1490

995

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

1491

996

if_tag.appendChild(tag)

1492

# Add annotation tags for properties

1493

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

1494

annots = dict()

1495

for name, prop in self._get_all_dbus_things(

1496

"property"):

1497

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

1498

and prop._dbus_interface

1499

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

1500

annots.update(getattr(

1501

prop, "_dbus_annotations", {}))

1502

for name, value in annots.items():

1503

ann_tag = document.createElement(

1504

"annotation")

1505

ann_tag.setAttribute("name", name)

1506

ann_tag.setAttribute("value", value)

1507

tag.appendChild(ann_tag)

997

# Add annotation tags

998

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

999

for tag in if_tag.getElementsByTagName(typ):

1000

annots = dict()

1001

for name, prop in (self.

1002

_get_all_dbus_things(typ)):

1003

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

1004

and prop._dbus_interface

1005

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

1006

annots.update(getattr(

1007

prop, "_dbus_annotations", {}))

1008

for name, value in annots.items():

1009

ann_tag = document.createElement(

1010

"annotation")

1011

ann_tag.setAttribute("name", name)

1012

ann_tag.setAttribute("value", value)

1013

tag.appendChild(ann_tag)

1014

# Add interface annotation tags

1015

for annotation, value in dict(

1016

itertools.chain.from_iterable(

1017

annotations().items()

1018

for name, annotations

1019

in self._get_all_dbus_things("interface")

1020

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

1021

)).items():

1022

ann_tag = document.createElement("annotation")

1023

ann_tag.setAttribute("name", annotation)

1024

ann_tag.setAttribute("value", value)

1025

if_tag.appendChild(ann_tag)

1508

1026

# Add the names to the return values for the

1509

1027

# "org.freedesktop.DBus.Properties" methods

1510

1028

if (if_tag.getAttribute("name")

1529

1047

return xmlstring

1530

1048

1531

1049

1532

try:

1533

dbus.OBJECT_MANAGER_IFACE

1534

except AttributeError:

1535

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

1536

1537

1538

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1539

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

1540

1541

Classes inheriting from this exposes the standard

1542

GetManagedObjects call and the InterfacesAdded and

1543

InterfacesRemoved signals on the standard

1544

"org.freedesktop.DBus.ObjectManager" interface.

1545

1546

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

1547

manually.

1548

"""

1549

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1550

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

1551

def GetManagedObjects(self):

1552

"""This function must be overridden"""

1553

raise NotImplementedError()

1554

1555

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1556

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

1557

def InterfacesAdded(self, object_path, interfaces_and_properties):

1558

pass

1559

1560

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

1561

def InterfacesRemoved(self, object_path, interfaces):

1562

pass

1563

1564

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1565

out_signature="s",

1566

path_keyword='object_path',

1567

connection_keyword='connection')

1568

def Introspect(self, object_path, connection):

1569

"""Overloading of standard D-Bus method.

1570

1571

Override return argument name of GetManagedObjects to be

1572

"objpath_interfaces_and_properties"

1573

"""

1574

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1575

object_path,

1576

connection)

1577

try:

1578

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

1579

1580

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

1581

# Fix argument name for the GetManagedObjects method

1582

if (if_tag.getAttribute("name")

1583

== dbus.OBJECT_MANAGER_IFACE):

1584

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

1585

if (cn.getAttribute("name")

1586

== "GetManagedObjects"):

1587

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

1588

if (arg.getAttribute("direction")

1589

== "out"):

1590

arg.setAttribute(

1591

"name",

1592

"objpath_interfaces"

1593

"_and_properties")

1594

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

1595

document.unlink()

1596

except (AttributeError, xml.dom.DOMException,

1597

xml.parsers.expat.ExpatError) as error:

1598

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

1599

exc_info=error)

1600

return xmlstring

1601

1602

1603

1050

def datetime_to_dbus(dt, variant_level=0):

1604

1051

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

1605

1052

if dt is None:

1606

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

1053

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

1607

1054

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

1608

1055

1609

1056

1612

1059

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

1613

1060

interface names according to the "alt_interface_names" mapping.

1614

1061

Usage:

1615

1062

1616

1063

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

1617

1064

"net.example.AlternateInterface"})

1618

1065

class SampleDBusObject(dbus.service.Object):

1619

1066

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

1620

1067

def SampleDBusMethod():

1621

1068

pass

1622

1069

1623

1070

The above "SampleDBusMethod" on "SampleDBusObject" will be

1624

1071

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

1625

1072

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

1626

1073

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

1627

1074

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

1628

1075

1629

1076

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

1630

1077

(from DBusObjectWithProperties) and interfaces (from the

1631

1078

dbus_interface_annotations decorator).

1632

1079

"""

1633

1080

1634

1081

def wrapper(cls):

1635

1082

for orig_interface_name, alt_interface_name in (

1636

1083

alt_interface_names.items()):

1653

1100

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

1654

1101

# Extract the original non-method undecorated

1655

1102

# function by black magic

1656

if sys.version_info.major == 2:

1657

nonmethod_func = (dict(

1658

zip(attribute.func_code.co_freevars,

1659

attribute.__closure__))

1660

["func"].cell_contents)

1661

else:

1662

nonmethod_func = (dict(

1663

zip(attribute.__code__.co_freevars,

1664

attribute.__closure__))

1665

["func"].cell_contents)

1103

nonmethod_func = (dict(

1104

zip(attribute.func_code.co_freevars,

1105

attribute.__closure__))

1106

["func"].cell_contents)

1666

1107

# Create a new, but exactly alike, function

1667

1108

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

1668

1109

# with the alternate D-Bus interface name

1669

new_function = copy_function(nonmethod_func)

1670

1110

new_function = (dbus.service.signal(

1671

alt_interface,

1672

attribute._dbus_signature)(new_function))

1111

alt_interface, attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1673

1118

# Copy annotations, if any

1674

1119

try:

1675

1120

new_function._dbus_annotations = dict(

1676

1121

attribute._dbus_annotations)

1677

1122

except AttributeError:

1678

1123

pass

1679

1680

1124

# Define a creator of a function to call both the

1681

1125

# original and alternate functions, so both the

1682

1126

# original and alternate signals gets sent when

1685

1129

"""This function is a scope container to pass

1686

1130

func1 and func2 to the "call_both" function

1687

1131

outside of its arguments"""

1688

1689

@functools.wraps(func2)

1132

1690

1133

def call_both(*args, **kwargs):

1691

1134

"""This function will emit two D-Bus

1692

1135

signals by calling func1 and func2"""

1693

1136

func1(*args, **kwargs)

1694

1137

func2(*args, **kwargs)

1695

# Make wrapper function look like a D-Bus

1696

# signal

1697

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

1698

if name.startswith("_dbus_"):

1699

setattr(call_both, name, attr)

1700

1138

1701

1139

return call_both

1702

1140

# Create the "call_both" function and add it to

1703

1141

# the class

1713

1151

alt_interface,

1714

1152

attribute._dbus_in_signature,

1715

1153

attribute._dbus_out_signature)

1716

(copy_function(attribute)))

1154

(types.FunctionType(attribute.func_code,

1155

attribute.func_globals,

1156

attribute.func_name,

1157

attribute.func_defaults,

1158

attribute.func_closure)))

1717

1159

# Copy annotations, if any

1718

1160

try:

1719

1161

attr[attrname]._dbus_annotations = dict(

1731

1173

attribute._dbus_access,

1732

1174

attribute._dbus_get_args_options

1733

1175

["byte_arrays"])

1734

(copy_function(attribute)))

1176

(types.FunctionType(

1177

attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

1735

1182

# Copy annotations, if any

1736

1183

try:

1737

1184

attr[attrname]._dbus_annotations = dict(

1746

1193

# to the class.

1747

1194

attr[attrname] = (

1748

1195

dbus_interface_annotations(alt_interface)

1749

(copy_function(attribute)))

1196

(types.FunctionType(attribute.func_code,

1197

attribute.func_globals,

1198

attribute.func_name,

1199

attribute.func_defaults,

1200

attribute.func_closure)))

1750

1201

if deprecate:

1751

1202

# Deprecate all alternate interfaces

1752

iname = "_AlternateDBusNames_interface_annotation{}"

1203

iname="_AlternateDBusNames_interface_annotation{}"

1753

1204

for interface_name in interface_names:

1754

1205

1755

1206

@dbus_interface_annotations(interface_name)

1756

1207

def func(self):

1757

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

1758

"true"}

1208

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

1209

"true" }

1759

1210

# Find an unused name

1760

1211

for aname in (iname.format(i)

1761

1212

for i in itertools.count()):

1765

1216

if interface_names:

1766

1217

# Replace the class with a new subclass of it with

1767

1218

# methods, signals, etc. as created above.

1768

if sys.version_info.major == 2:

1769

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

1770

(cls, ), attr)

1771

else:

1772

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

1773

(cls, ), attr)

1219

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

1220

(cls, ), attr)

1774

1221

return cls

1775

1222

1776

1223

return wrapper

1777

1224

1778

1225

1780

1227

"se.bsnet.fukt.Mandos"})

1781

1228

class ClientDBus(Client, DBusObjectWithProperties):

1782

1229

"""A Client class using D-Bus

1783

1230

1784

1231

Attributes:

1785

1232

dbus_object_path: dbus.ObjectPath

1786

1233

bus: dbus.SystemBus()

1787

1234

"""

1788

1235

1789

1236

runtime_expansions = (Client.runtime_expansions

1790

1237

+ ("dbus_object_path", ))

1791

1238

1792

1239

_interface = "se.recompile.Mandos.Client"

1793

1240

1794

1241

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

1795

1796

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

1242

1243

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

1797

1244

self.bus = bus

1798

1245

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

1799

1246

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

1805

1252

"/clients/" + client_object_name)

1806

1253

DBusObjectWithProperties.__init__(self, self.bus,

1807

1254

self.dbus_object_path)

1808

1255

1809

1256

def notifychangeproperty(transform_func, dbus_name,

1810

1257

type_func=lambda x: x,

1811

1258

variant_level=1,

1813

1260

_interface=_interface):

1814

1261

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

1815

1262

its changes to DBus.

1816

1263

1817

1264

transform_fun: Function that takes a value and a variant_level

1818

1265

and transforms it to a D-Bus type.

1819

1266

dbus_name: D-Bus name of the variable

1822

1269

variant_level: D-Bus variant level. Default: 1

1823

1270

"""

1824

1271

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

1825

1272

1826

1273

def setter(self, value):

1827

1274

if hasattr(self, "dbus_object_path"):

1828

1275

if (not hasattr(self, attrname) or

1835

1282

else:

1836

1283

dbus_value = transform_func(

1837

1284

type_func(value),

1838

variant_level=variant_level)

1285

variant_level = variant_level)

1839

1286

self.PropertyChanged(dbus.String(dbus_name),

1840

1287

dbus_value)

1841

1288

self.PropertiesChanged(

1842

1289

_interface,

1843

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

1844

dbus_value}),

1290

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

1291

dbus_value }),

1845

1292

dbus.Array())

1846

1293

setattr(self, attrname, value)

1847

1294

1848

1295

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

1849

1296

1850

1297

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1851

1298

approvals_pending = notifychangeproperty(dbus.Boolean,

1852

1299

"ApprovalPending",

1853

type_func=bool)

1300

type_func = bool)

1854

1301

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

1855

1302

last_enabled = notifychangeproperty(datetime_to_dbus,

1856

1303

"LastEnabled")

1857

1304

checker = notifychangeproperty(

1858

1305

dbus.Boolean, "CheckerRunning",

1859

type_func=lambda checker: checker is not None)

1306

type_func = lambda checker: checker is not None)

1860

1307

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1861

1308

"LastCheckedOK")

1862

1309

last_checker_status = notifychangeproperty(dbus.Int16,

1867

1314

"ApprovedByDefault")

1868

1315

approval_delay = notifychangeproperty(

1869

1316

dbus.UInt64, "ApprovalDelay",

1870

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

1317

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

1871

1318

approval_duration = notifychangeproperty(

1872

1319

dbus.UInt64, "ApprovalDuration",

1873

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

1320

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

1874

1321

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

1875

1322

timeout = notifychangeproperty(

1876

1323

dbus.UInt64, "Timeout",

1877

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

1324

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

1878

1325

extended_timeout = notifychangeproperty(

1879

1326

dbus.UInt64, "ExtendedTimeout",

1880

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

1327

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

1881

1328

interval = notifychangeproperty(

1882

1329

dbus.UInt64, "Interval",

1883

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

1330

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

1884

1331

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

1885

1332

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

1886

1333

invalidate_only=True)

1887

1334

1888

1335

del notifychangeproperty

1889

1336

1890

1337

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

1891

1338

try:

1892

1339

self.remove_from_connection()

1895

1342

if hasattr(DBusObjectWithProperties, "__del__"):

1896

1343

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

1897

1344

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

1898

1899

def checker_callback(self, source, condition,

1900

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

1901

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

1902

connection, command, *args,

1903

**kwargs)

1904

exitstatus = self.last_checker_status

1905

if exitstatus >= 0:

1345

1346

def checker_callback(self, pid, condition, command,

1347

*args, **kwargs):

1348

self.checker_callback_tag = None

1349

self.checker = None

1350

if os.WIFEXITED(condition):

1351

exitstatus = os.WEXITSTATUS(condition)

1906

1352

# Emit D-Bus signal

1907

1353

self.CheckerCompleted(dbus.Int16(exitstatus),

1908

# This is specific to GNU libC

1909

dbus.Int64(exitstatus << 8),

1354

dbus.Int64(condition),

1910

1355

dbus.String(command))

1911

1356

else:

1912

1357

# Emit D-Bus signal

1913

1358

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

1914

dbus.Int64(

1915

# This is specific to GNU libC

1916

(exitstatus << 8)

1917

| self.last_checker_signal),

1359

dbus.Int64(condition),

1918

1360

dbus.String(command))

1919

return ret

1920

1361

1362

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

1363

*args, **kwargs)

1364

1921

1365

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

1922

1366

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

1923

1367

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

1927

1371

# Emit D-Bus signal

1928

1372

self.CheckerStarted(self.current_checker_command)

1929

1373

return r

1930

1374

1931

1375

def _reset_approved(self):

1932

1376

self.approved = None

1933

1377

return False

1934

1378

1935

1379

def approve(self, value=True):

1936

1380

self.approved = value

1937

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

1938

* 1000), self._reset_approved)

1381

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

1382

* 1000), self._reset_approved)

1939

1383

self.send_changedstate()

1940

1941

# D-Bus methods, signals & properties

1942

1943

# Interfaces

1944

1945

# Signals

1946

1384

1385

## D-Bus methods, signals & properties

1386

1387

## Interfaces

1388

1389

## Signals

1390

1947

1391

# CheckerCompleted - signal

1948

1392

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

1949

1393

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

1950

1394

"D-Bus signal"

1951

1395

pass

1952

1396

1953

1397

# CheckerStarted - signal

1954

1398

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

1955

1399

def CheckerStarted(self, command):

1956

1400

"D-Bus signal"

1957

1401

pass

1958

1402

1959

1403

# PropertyChanged - signal

1960

1404

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

1961

1405

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

1962

1406

def PropertyChanged(self, property, value):

1963

1407

"D-Bus signal"

1964

1408

pass

1965

1409

1966

1410

# GotSecret - signal

1967

1411

@dbus.service.signal(_interface)

1968

1412

def GotSecret(self):

1971

1415

server to mandos-client

1972

1416

"""

1973

1417

pass

1974

1418

1975

1419

# Rejected - signal

1976

1420

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

1977

1421

def Rejected(self, reason):

1978

1422

"D-Bus signal"

1979

1423

pass

1980

1424

1981

1425

# NeedApproval - signal

1982

1426

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

1983

1427

def NeedApproval(self, timeout, default):

1984

1428

"D-Bus signal"

1985

1429

return self.need_approval()

1986

1987

# Methods

1988

1430

1431

## Methods

1432

1989

1433

# Approve - method

1990

1434

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

1991

1435

def Approve(self, value):

1992

1436

self.approve(value)

1993

1437

1994

1438

# CheckedOK - method

1995

1439

@dbus.service.method(_interface)

1996

1440

def CheckedOK(self):

1997

1441

self.checked_ok()

1998

1442

1999

1443

# Enable - method

2000

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

2001

1444

@dbus.service.method(_interface)

2002

1445

def Enable(self):

2003

1446

"D-Bus method"

2004

1447

self.enable()

2005

1448

2006

1449

# StartChecker - method

2007

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

2008

1450

@dbus.service.method(_interface)

2009

1451

def StartChecker(self):

2010

1452

"D-Bus method"

2011

1453

self.start_checker()

2012

1454

2013

1455

# Disable - method

2014

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

2015

1456

@dbus.service.method(_interface)

2016

1457

def Disable(self):

2017

1458

"D-Bus method"

2018

1459

self.disable()

2019

1460

2020

1461

# StopChecker - method

2021

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

2022

1462

@dbus.service.method(_interface)

2023

1463

def StopChecker(self):

2024

1464

self.stop_checker()

2025

2026

# Properties

2027

1465

1466

## Properties

1467

2028

1468

# ApprovalPending - property

2029

1469

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

2030

1470

def ApprovalPending_dbus_property(self):

2031

1471

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

2032

1472

2033

1473

# ApprovedByDefault - property

2034

1474

@dbus_service_property(_interface,

2035

1475

signature="b",

2038

1478

if value is None: # get

2039

1479

return dbus.Boolean(self.approved_by_default)

2040

1480

self.approved_by_default = bool(value)

2041

1481

2042

1482

# ApprovalDelay - property

2043

1483

@dbus_service_property(_interface,

2044

1484

signature="t",

2048

1488

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

2049

1489

* 1000)

2050

1490

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

2051

1491

2052

1492

# ApprovalDuration - property

2053

1493

@dbus_service_property(_interface,

2054

1494

signature="t",

2058

1498

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

2059

1499

* 1000)

2060

1500

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

2061

1501

2062

1502

# Name - property

2063

@dbus_annotations(

2064

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

2065

1503

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

2066

1504

def Name_dbus_property(self):

2067

1505

return dbus.String(self.name)

2068

2069

# KeyID - property

2070

@dbus_annotations(

2071

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

2072

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

2073

def KeyID_dbus_property(self):

2074

return dbus.String(self.key_id)

2075

1506

2076

1507

# Fingerprint - property

2077

@dbus_annotations(

2078

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

2079

1508

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

2080

1509

def Fingerprint_dbus_property(self):

2081

1510

return dbus.String(self.fingerprint)

2082

1511

2083

1512

# Host - property

2084

1513

@dbus_service_property(_interface,

2085

1514

signature="s",

2088

1517

if value is None: # get

2089

1518

return dbus.String(self.host)

2090

1519

self.host = str(value)

2091

1520

2092

1521

# Created - property

2093

@dbus_annotations(

2094

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

2095

1522

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

2096

1523

def Created_dbus_property(self):

2097

1524

return datetime_to_dbus(self.created)

2098

1525

2099

1526

# LastEnabled - property

2100

1527

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

2101

1528

def LastEnabled_dbus_property(self):

2102

1529

return datetime_to_dbus(self.last_enabled)

2103

1530

2104

1531

# Enabled - property

2105

1532

@dbus_service_property(_interface,

2106

1533

signature="b",

2112

1539

self.enable()

2113

1540

else:

2114

1541

self.disable()

2115

1542

2116

1543

# LastCheckedOK - property

2117

1544

@dbus_service_property(_interface,

2118

1545

signature="s",

2122

1549

self.checked_ok()

2123

1550

return

2124

1551

return datetime_to_dbus(self.last_checked_ok)

2125

1552

2126

1553

# LastCheckerStatus - property

2127

1554

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

2128

1555

def LastCheckerStatus_dbus_property(self):

2129

1556

return dbus.Int16(self.last_checker_status)

2130

1557

2131

1558

# Expires - property

2132

1559

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

2133

1560

def Expires_dbus_property(self):

2134

1561

return datetime_to_dbus(self.expires)

2135

1562

2136

1563

# LastApprovalRequest - property

2137

1564

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

2138

1565

def LastApprovalRequest_dbus_property(self):

2139

1566

return datetime_to_dbus(self.last_approval_request)

2140

1567

2141

1568

# Timeout - property

2142

1569

@dbus_service_property(_interface,

2143

1570

signature="t",

2158

1585

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

2159

1586

is None):

2160

1587

return

2161

GLib.source_remove(self.disable_initiator_tag)

2162

self.disable_initiator_tag = GLib.timeout_add(

1588

gobject.source_remove(self.disable_initiator_tag)

1589

self.disable_initiator_tag = gobject.timeout_add(

2163

1590

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

2164

1591

self.disable)

2165

1592

2166

1593

# ExtendedTimeout - property

2167

1594

@dbus_service_property(_interface,

2168

1595

signature="t",

2172

1599

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

2173

1600

* 1000)

2174

1601

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

2175

1602

2176

1603

# Interval - property

2177

1604

@dbus_service_property(_interface,

2178

1605

signature="t",

2185

1612

return

2186

1613

if self.enabled:

2187

1614

# Reschedule checker run

2188

GLib.source_remove(self.checker_initiator_tag)

2189

self.checker_initiator_tag = GLib.timeout_add(

1615

gobject.source_remove(self.checker_initiator_tag)

1616

self.checker_initiator_tag = gobject.timeout_add(

2190

1617

value, self.start_checker)

2191

self.start_checker() # Start one now, too

2192

1618

self.start_checker() # Start one now, too

1619

2193

1620

# Checker - property

2194

1621

@dbus_service_property(_interface,

2195

1622

signature="s",

2198

1625

if value is None: # get

2199

1626

return dbus.String(self.checker_command)

2200

1627

self.checker_command = str(value)

2201

1628

2202

1629

# CheckerRunning - property

2203

1630

@dbus_service_property(_interface,

2204

1631

signature="b",

2210

1637

self.start_checker()

2211

1638

else:

2212

1639

self.stop_checker()

2213

1640

2214

1641

# ObjectPath - property

2215

@dbus_annotations(

2216

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

2217

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

2218

1642

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

2219

1643

def ObjectPath_dbus_property(self):

2220

return self.dbus_object_path # is already a dbus.ObjectPath

2221

1644

return self.dbus_object_path # is already a dbus.ObjectPath

1645

2222

1646

# Secret = property

2223

@dbus_annotations(

2224

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

2225

"invalidates"})

2226

1647

@dbus_service_property(_interface,

2227

1648

signature="ay",

2228

1649

access="write",

2229

1650

byte_arrays=True)

2230

1651

def Secret_dbus_property(self, value):

2231

1652

self.secret = bytes(value)

2232

1653

2233

1654

del _interface

2234

1655

2235

1656

2236

class ProxyClient:

2237

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

1657

class ProxyClient(object):

1658

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

2238

1659

self._pipe = child_pipe

2239

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

1660

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

2240

1661

if not self._pipe.recv():

2241

raise KeyError(key_id or fpr)

2242

1662

raise KeyError()

1663

2243

1664

def __getattribute__(self, name):

2244

1665

if name == '_pipe':

2245

1666

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

2248

1669

if data[0] == 'data':

2249

1670

return data[1]

2250

1671

if data[0] == 'function':

2251

1672

2252

1673

def func(*args, **kwargs):

2253

1674

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

2254

1675

return self._pipe.recv()[1]

2255

1676

2256

1677

return func

2257

1678

2258

1679

def __setattr__(self, name, value):

2259

1680

if name == '_pipe':

2260

1681

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

2263

1684

2264

1685

class ClientHandler(socketserver.BaseRequestHandler, object):

2265

1686

"""A class to handle client connections.

2266

1687

2267

1688

Instantiated once for each connection to handle it.

2268

1689

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

2269

1690

2270

1691

def handle(self):

2271

1692

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

2272

1693

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

2273

1694

str(self.client_address))

2274

1695

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

2275

1696

self.server.child_pipe.fileno())

2276

2277

session = gnutls.ClientSession(self.request)

2278

2279

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

2280

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

2281

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

2282

# "+DHE-DSS"))

1697

1698

session = gnutls.connection.ClientSession(

1699

self.request, gnutls.connection .X509Credentials())

1700

1701

# Note: gnutls.connection.X509Credentials is really a

1702

# generic GnuTLS certificate credentials object so long as

1703

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

1704

# here despite using OpenPGP certificates.

1705

1706

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

1707

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

1708

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

1709

# "+DHE-DSS"))

2283

1710

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

2284

1711

priority = self.server.gnutls_priority

2285

1712

if priority is None:

2286

1713

priority = "NORMAL"

2287

gnutls.priority_set_direct(session._c_object,

2288

priority.encode("utf-8"),

2289

None)

2290

1714

gnutls.library.functions.gnutls_priority_set_direct(

1715

session._c_object, priority, None)

1716

2291

1717

# Start communication using the Mandos protocol

2292

1718

# Get protocol number

2293

1719

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

2298

1724

except (ValueError, IndexError, RuntimeError) as error:

2299

1725

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

2300

1726

return

2301

1727

2302

1728

# Start GnuTLS connection

2303

1729

try:

2304

1730

session.handshake()

2305

except gnutls.Error as error:

1731

except gnutls.errors.GNUTLSError as error:

2306

1732

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

2307

1733

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

2308

1734

# established. Just abandon the request.

2309

1735

return

2310

1736

logger.debug("Handshake succeeded")

2311

1737

2312

1738

approval_required = False

2313

1739

try:

2314

if gnutls.has_rawpk:

2315

fpr = b""

2316

try:

2317

key_id = self.key_id(

2318

self.peer_certificate(session))

2319

except (TypeError, gnutls.Error) as error:

2320

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

2321

return

2322

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

2323

2324

else:

2325

key_id = b""

2326

try:

2327

fpr = self.fingerprint(

2328

self.peer_certificate(session))

2329

except (TypeError, gnutls.Error) as error:

2330

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

2331

return

2332

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

2333

2334

try:

2335

client = ProxyClient(child_pipe, key_id, fpr,

1740

try:

1741

fpr = self.fingerprint(

1742

self.peer_certificate(session))

1743

except (TypeError,

1744

gnutls.errors.GNUTLSError) as error:

1745

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

1746

return

1747

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

1748

1749

try:

1750

client = ProxyClient(child_pipe, fpr,

2336

1751

self.client_address)

2337

1752

except KeyError:

2338

1753

return

2339

1754

2340

1755

if client.approval_delay:

2341

1756

delay = client.approval_delay

2342

1757

client.approvals_pending += 1

2343

1758

approval_required = True

2344

1759

2345

1760

while True:

2346

1761

if not client.enabled:

2347

1762

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

2350

1765

# Emit D-Bus signal

2351

1766

client.Rejected("Disabled")

2352

1767

return

2353

1768

2354

1769

if client.approved or not client.approval_delay:

2355

# We are approved or approval is disabled

1770

#We are approved or approval is disabled

2356

1771

break

2357

1772

elif client.approved is None:

2358

1773

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

2369

1784

# Emit D-Bus signal

2370

1785

client.Rejected("Denied")

2371

1786

return

2372

2373

# wait until timeout or approved

1787

1788

#wait until timeout or approved

2374

1789

time = datetime.datetime.now()

2375

1790

client.changedstate.acquire()

2376

1791

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

2389

1804

break

2390

1805

else:

2391

1806

delay -= time2 - time

2392

2393

try:

2394

session.send(client.secret)

2395

except gnutls.Error as error:

2396

logger.warning("gnutls send failed",

2397

exc_info=error)

2398

return

2399

1807

1808

sent_size = 0

1809

while sent_size < len(client.secret):

1810

try:

1811

sent = session.send(client.secret[sent_size:])

1812

except gnutls.errors.GNUTLSError as error:

1813

logger.warning("gnutls send failed",

1814

exc_info=error)

1815

return

1816

logger.debug("Sent: %d, remaining: %d", sent,

1817

len(client.secret) - (sent_size

1818

+ sent))

1819

sent_size += sent

1820

2400

1821

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

2401

1822

# bump the timeout using extended_timeout

2402

1823

client.bump_timeout(client.extended_timeout)

2403

1824

if self.server.use_dbus:

2404

1825

# Emit D-Bus signal

2405

1826

client.GotSecret()

2406

1827

2407

1828

finally:

2408

1829

if approval_required:

2409

1830

client.approvals_pending -= 1

2410

1831

try:

2411

1832

session.bye()

2412

except gnutls.Error as error:

1833

except gnutls.errors.GNUTLSError as error:

2413

1834

logger.warning("GnuTLS bye failed",

2414

1835

exc_info=error)

2415

1836

2416

1837

@staticmethod

2417

1838

def peer_certificate(session):

2418

"Return the peer's certificate as a bytestring"

2419

try:

2420

cert_type = gnutls.certificate_type_get2(session._c_object,

2421

gnutls.CTYPE_PEERS)

2422

except AttributeError:

2423

cert_type = gnutls.certificate_type_get(session._c_object)

2424

if gnutls.has_rawpk:

2425

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2426

else:

2427

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2428

# If not a valid certificate type...

2429

if cert_type not in valid_cert_types:

2430

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

2431

valid_cert_types)

2432

# ...return invalid data

2433

return b""

1839

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

1840

# If not an OpenPGP certificate...

1841

if (gnutls.library.functions.gnutls_certificate_type_get(

1842

session._c_object)

1843

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1844

# ...do the normal thing

1845

return session.peer_certificate

2434

1846

list_size = ctypes.c_uint(1)

2435

cert_list = (gnutls.certificate_get_peers

1847

cert_list = (gnutls.library.functions

1848

.gnutls_certificate_get_peers

2436

1849

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

2437

1850

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

2438

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

1851

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

1852

" certificate")

2439

1853

if list_size.value == 0:

2440

1854

return None

2441

1855

cert = cert_list[0]

2442

1856

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

2443

2444

@staticmethod

2445

def key_id(certificate):

2446

"Convert a certificate bytestring to a hexdigit key ID"

2447

# New GnuTLS "datum" with the public key

2448

datum = gnutls.datum_t(

2449

ctypes.cast(ctypes.c_char_p(certificate),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.c_uint(len(certificate)))

2452

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

2453

# New empty GnuTLS certificate

2454

pubkey = gnutls.pubkey_t()

2455

gnutls.pubkey_init(ctypes.byref(pubkey))

2456

# Import the raw public key into the certificate

2457

gnutls.pubkey_import(pubkey,

2458

ctypes.byref(datum),

2459

gnutls.X509_FMT_DER)

2460

# New buffer for the key ID

2461

buf = ctypes.create_string_buffer(32)

2462

buf_len = ctypes.c_size_t(len(buf))

2463

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

2464

gnutls.pubkey_get_key_id(pubkey,

2465

gnutls.KEYID_USE_SHA256,

2466

ctypes.cast(ctypes.byref(buf),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.byref(buf_len))

2469

# Deinit the certificate

2470

gnutls.pubkey_deinit(pubkey)

2471

2472

# Convert the buffer to a Python bytestring

2473

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

2474

# Convert the bytestring to hexadecimal notation

2475

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

2476

return hex_key_id

2477

1857

2478

1858

@staticmethod

2479

1859

def fingerprint(openpgp):

2480

1860

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2481

1861

# New GnuTLS "datum" with the OpenPGP public key

2482

datum = gnutls.datum_t(

1862

datum = gnutls.library.types.gnutls_datum_t(

2483

1863

ctypes.cast(ctypes.c_char_p(openpgp),

2484

1864

ctypes.POINTER(ctypes.c_ubyte)),

2485

1865

ctypes.c_uint(len(openpgp)))

2486

1866

# New empty GnuTLS certificate

2487

crt = gnutls.openpgp_crt_t()

2488

gnutls.openpgp_crt_init(ctypes.byref(crt))

1867

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1868

gnutls.library.functions.gnutls_openpgp_crt_init(

1869

ctypes.byref(crt))

2489

1870

# Import the OpenPGP public key into the certificate

2490

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

2491

gnutls.OPENPGP_FMT_RAW)

1871

gnutls.library.functions.gnutls_openpgp_crt_import(

1872

crt, ctypes.byref(datum),

1873

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2492

1874

# Verify the self signature in the key

2493

1875

crtverify = ctypes.c_uint()

2494

gnutls.openpgp_crt_verify_self(crt, 0,

2495

ctypes.byref(crtverify))

1876

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1877

crt, 0, ctypes.byref(crtverify))

2496

1878

if crtverify.value != 0:

2497

gnutls.openpgp_crt_deinit(crt)

2498

raise gnutls.CertificateSecurityError(code

2499

=crtverify.value)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1880

raise gnutls.errors.CertificateSecurityError(

1881

"Verify failed")

2500

1882

# New buffer for the fingerprint

2501

1883

buf = ctypes.create_string_buffer(20)

2502

1884

buf_len = ctypes.c_size_t()

2503

1885

# Get the fingerprint from the certificate into the buffer

2504

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

2505

ctypes.byref(buf_len))

1886

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1887

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

2506

1888

# Deinit the certificate

2507

gnutls.openpgp_crt_deinit(crt)

1889

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2508

1890

# Convert the buffer to a Python bytestring

2509

1891

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

2510

1892

# Convert the bytestring to hexadecimal notation

2512

1894

return hex_fpr

2513

1895

2514

1896

2515

class MultiprocessingMixIn:

1897

class MultiprocessingMixIn(object):

2516

1898

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

2517

1899

2518

1900

def sub_process_main(self, request, address):

2519

1901

try:

2520

1902

self.finish_request(request, address)

2521

1903

except Exception:

2522

1904

self.handle_error(request, address)

2523

1905

self.close_request(request)

2524

1906

2525

1907

def process_request(self, request, address):

2526

1908

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

2527

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

2528

args=(request, address))

1909

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

1910

args = (request, address))

2529

1911

proc.start()

2530

1912

return proc

2531

1913

2532

1914

2533

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1915

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2534

1916

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

2535

1917

2536

1918

def process_request(self, request, client_address):

2537

1919

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

2538

1920

2539

1921

This function creates a new pipe in self.pipe

2540

1922

"""

2541

1923

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2542

1924

2543

1925

proc = MultiprocessingMixIn.process_request(self, request,

2544

1926

client_address)

2545

1927

self.child_pipe.close()

2546

1928

self.add_pipe(parent_pipe, proc)

2547

1929

2548

1930

def add_pipe(self, parent_pipe, proc):

2549

1931

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

2550

1932

raise NotImplementedError()

2551

1933

2552

1934

2553

1935

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2554

socketserver.TCPServer):

1936

socketserver.TCPServer, object):

2555

1937

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

2556

1938

2557

1939

Attributes:

2558

1940

enabled: Boolean; whether this server is activated yet

2559

1941

interface: None or a network interface name (string)

2560

1942

use_ipv6: Boolean; to use IPv6 or not

2561

1943

"""

2562

1944

2563

1945

def __init__(self, server_address, RequestHandlerClass,

2564

1946

interface=None,

2565

1947

use_ipv6=True,

2575

1957

self.socketfd = socketfd

2576

1958

# Save the original socket.socket() function

2577

1959

self.socket_socket = socket.socket

2578

2579

1960

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

2580

#

1961

#

2581

1962

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

2582

1963

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

2583

1964

# patching socket.socket.)

2584

#

1965

#

2585

1966

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

2586

1967

@functools.wraps(socket.socket)

2587

1968

def socket_wrapper(*args, **kwargs):

2599

1980

# socket_wrapper(), if socketfd was set.

2600

1981

socketserver.TCPServer.__init__(self, server_address,

2601

1982

RequestHandlerClass)

2602

1983

2603

1984

def server_bind(self):

2604

1985

"""This overrides the normal server_bind() function

2605

1986

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

2606

1987

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

2607

global SO_BINDTODEVICE

2608

1988

if self.interface is not None:

2609

1989

if SO_BINDTODEVICE is None:

2610

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

2611

# common enough.

2612

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

2613

SO_BINDTODEVICE = 25

2614

try:

2615

self.socket.setsockopt(

2616

socket.SOL_SOCKET, SO_BINDTODEVICE,

2617

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

2618

except socket.error as error:

2619

if error.errno == errno.EPERM:

2620

logger.error("No permission to bind to"

2621

" interface %s", self.interface)

2622

elif error.errno == errno.ENOPROTOOPT:

2623

logger.error("SO_BINDTODEVICE not available;"

2624

" cannot bind to interface %s",

2625

self.interface)

2626

elif error.errno == errno.ENODEV:

2627

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

2628

" cannot bind", self.interface)

2629

else:

2630

raise

1990

logger.error("SO_BINDTODEVICE does not exist;"

1991

" cannot bind to interface %s",

1992

self.interface)

1993

else:

1994

try:

1995

self.socket.setsockopt(

1996

socket.SOL_SOCKET, SO_BINDTODEVICE,

1997

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

1998

except socket.error as error:

1999

if error.errno == errno.EPERM:

2000

logger.error("No permission to bind to"

2001

" interface %s", self.interface)

2002

elif error.errno == errno.ENOPROTOOPT:

2003

logger.error("SO_BINDTODEVICE not available;"

2004

" cannot bind to interface %s",

2005

self.interface)

2006

elif error.errno == errno.ENODEV:

2007

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

2008

" cannot bind", self.interface)

2009

else:

2010

raise

2631

2011

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

2632

2012

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

2633

if self.server_address[1]:

2634

self.allow_reuse_address = True

2635

2013

if not self.server_address[0]:

2636

2014

if self.address_family == socket.AF_INET6:

2637

any_address = "::" # in6addr_any

2015

any_address = "::" # in6addr_any

2638

2016

else:

2639

any_address = "0.0.0.0" # INADDR_ANY

2017

any_address = "0.0.0.0" # INADDR_ANY

2640

2018

self.server_address = (any_address,

2641

2019

self.server_address[1])

2642

2020

elif not self.server_address[1]:

2652

2030

2653

2031

class MandosServer(IPv6_TCPServer):

2654

2032

"""Mandos server.

2655

2033

2656

2034

Attributes:

2657

2035

clients: set of Client objects

2658

2036

gnutls_priority GnuTLS priority string

2659

2037

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

2660

2661

Assumes a GLib.MainLoop event loop.

2038

2039

Assumes a gobject.MainLoop event loop.

2662

2040

"""

2663

2041

2664

2042

def __init__(self, server_address, RequestHandlerClass,

2665

2043

interface=None,

2666

2044

use_ipv6=True,

2676

2054

self.gnutls_priority = gnutls_priority

2677

2055

IPv6_TCPServer.__init__(self, server_address,

2678

2056

RequestHandlerClass,

2679

interface=interface,

2680

use_ipv6=use_ipv6,

2681

socketfd=socketfd)

2682

2057

interface = interface,

2058

use_ipv6 = use_ipv6,

2059

socketfd = socketfd)

2060

2683

2061

def server_activate(self):

2684

2062

if self.enabled:

2685

2063

return socketserver.TCPServer.server_activate(self)

2686

2064

2687

2065

def enable(self):

2688

2066

self.enabled = True

2689

2067

2690

2068

def add_pipe(self, parent_pipe, proc):

2691

2069

# Call "handle_ipc" for both data and EOF events

2692

GLib.io_add_watch(

2693

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

2694

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

2070

gobject.io_add_watch(

2071

parent_pipe.fileno(),

2072

gobject.IO_IN | gobject.IO_HUP,

2695

2073

functools.partial(self.handle_ipc,

2696

parent_pipe=parent_pipe,

2697

proc=proc))

2698

2074

parent_pipe = parent_pipe,

2075

proc = proc))

2076

2699

2077

def handle_ipc(self, source, condition,

2700

2078

parent_pipe=None,

2701

proc=None,

2079

proc = None,

2702

2080

client_object=None):

2703

2081

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

2704

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

2082

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

2705

2083

# Wait for other process to exit

2706

2084

proc.join()

2707

2085

return False

2708

2086

2709

2087

# Read a request from the child

2710

2088

request = parent_pipe.recv()

2711

2089

command = request[0]

2712

2090

2713

2091

if command == 'init':

2714

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

2715

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

2716

address = request[3]

2717

2718

for c in self.clients.values():

2719

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2720

continue

2721

if key_id and c.key_id == key_id:

2722

client = c

2723

break

2724

if fpr and c.fingerprint == fpr:

2092

fpr = request[1]

2093

address = request[2]

2094

2095

for c in self.clients.itervalues():

2096

if c.fingerprint == fpr:

2725

2097

client = c

2726

2098

break

2727

2099

else:

2728

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

2729

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

2100

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

2101

"dress: %s", fpr, address)

2730

2102

if self.use_dbus:

2731

2103

# Emit D-Bus signal

2732

mandos_dbus_service.ClientNotFound(key_id or fpr,

2104

mandos_dbus_service.ClientNotFound(fpr,

2733

2105

address[0])

2734

2106

parent_pipe.send(False)

2735

2107

return False

2736

2737

GLib.io_add_watch(

2738

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

2739

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

2108

2109

gobject.io_add_watch(

2110

parent_pipe.fileno(),

2111

gobject.IO_IN | gobject.IO_HUP,

2740

2112

functools.partial(self.handle_ipc,

2741

parent_pipe=parent_pipe,

2742

proc=proc,

2743

client_object=client))

2113

parent_pipe = parent_pipe,

2114

proc = proc,

2115

client_object = client))

2744

2116

parent_pipe.send(True)

2745

2117

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

2746

2118

# same fileno

2749

2121

funcname = request[1]

2750

2122

args = request[2]

2751

2123

kwargs = request[3]

2752

2124

2753

2125

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

2754

2126

funcname)(*args,

2755

2127

**kwargs)))

2756

2128

2757

2129

if command == 'getattr':

2758

2130

attrname = request[1]

2759

if isinstance(client_object.__getattribute__(attrname),

2760

collections.abc.Callable):

2131

if callable(client_object.__getattribute__(attrname)):

2761

2132

parent_pipe.send(('function', ))

2762

2133

else:

2763

2134

parent_pipe.send((

2764

2135

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

2765

2136

2766

2137

if command == 'setattr':

2767

2138

attrname = request[1]

2768

2139

value = request[2]

2769

2140

setattr(client_object, attrname, value)

2770

2141

2771

2142

return True

2772

2143

2773

2144

2774

2145

def rfc3339_duration_to_delta(duration):

2775

2146

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

2776

2777

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

2778

True

2779

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

2780

True

2781

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

2782

True

2783

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

2784

True

2785

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

2786

True

2787

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

2788

True

2789

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

2790

True

2147

2148

>>> rfc3339_duration_to_delta("P7D")

2149

datetime.timedelta(7)

2150

>>> rfc3339_duration_to_delta("PT60S")

2151

datetime.timedelta(0, 60)

2152

>>> rfc3339_duration_to_delta("PT60M")

2153

datetime.timedelta(0, 3600)

2154

>>> rfc3339_duration_to_delta("PT24H")

2155

datetime.timedelta(1)

2156

>>> rfc3339_duration_to_delta("P1W")

2157

datetime.timedelta(7)

2158

>>> rfc3339_duration_to_delta("PT5M30S")

2159

datetime.timedelta(0, 330)

2160

>>> rfc3339_duration_to_delta("P1DT3M20S")

2161

datetime.timedelta(1, 200)

2791

2162

"""

2792

2163

2793

2164

# Parsing an RFC 3339 duration with regular expressions is not

2794

2165

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

2795

2166

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

2796

2167

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

2797

2168

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

2798

2169

# avoid excessive use of external libraries.

2799

2170

2800

2171

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

2172

Token = collections.namedtuple("Token",

2173

("regexp", # To match token; if

2174

# "value" is not None,

2175

# must have a "group"

2176

# containing digits

2177

"value", # datetime.timedelta or

2178

# None

2179

"followers")) # Tokens valid after

2180

# this token

2801

2181

Token = collections.namedtuple("Token", (

2802

2182

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

2803

2183

# a "group" containing digits

2835

2215

frozenset((token_year, token_month,

2836

2216

token_day, token_time,

2837

2217

token_week)))

2838

# Define starting values:

2839

# Value so far

2840

value = datetime.timedelta()

2218

# Define starting values

2219

value = datetime.timedelta() # Value so far

2841

2220

found_token = None

2842

# Following valid tokens

2843

followers = frozenset((token_duration, ))

2844

# String left to parse

2845

s = duration

2221

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

2222

s = duration # String left to parse

2846

2223

# Loop until end token is found

2847

2224

while found_token is not token_end:

2848

2225

# Search for any currently valid tokens

2864

2241

break

2865

2242

else:

2866

2243

# No currently valid tokens were found

2867

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

2868

.format(duration))

2244

raise ValueError("Invalid RFC 3339 duration")

2869

2245

# End token found

2870

2246

return value

2871

2247

2872

2248

2873

2249

def string_to_delta(interval):

2874

2250

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

2875

2876

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

2877

True

2878

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

2879

True

2880

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

2881

True

2882

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

2883

True

2884

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

2885

True

2886

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

2887

True

2251

2252

>>> string_to_delta('7d')

2253

datetime.timedelta(7)

2254

>>> string_to_delta('60s')

2255

datetime.timedelta(0, 60)

2256

>>> string_to_delta('60m')

2257

datetime.timedelta(0, 3600)

2258

>>> string_to_delta('24h')

2259

datetime.timedelta(1)

2260

>>> string_to_delta('1w')

2261

datetime.timedelta(7)

2262

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

2263

datetime.timedelta(0, 330)

2888

2264

"""

2889

2265

2890

2266

try:

2891

2267

return rfc3339_duration_to_delta(interval)

2892

2268

except ValueError:

2893

2269

pass

2894

2270

2895

2271

timevalue = datetime.timedelta(0)

2896

2272

for s in interval.split():

2897

2273

try:

2915

2291

return timevalue

2916

2292

2917

2293

2918

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

2294

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

2919

2295

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

2920

2296

2921

2297

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

2922

2298

if os.fork():

2923

2299

sys.exit()

2941

2317

2942

2318

2943

2319

def main():

2944

2320

2945

2321

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

2946

2322

# Parsing of options, both command line and config file

2947

2323

2948

2324

parser = argparse.ArgumentParser()

2949

2325

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

2950

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

2326

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

2951

2327

help="show version number and exit")

2952

2328

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

2953

2329

help="Bind to interface IF")

2989

2365

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

2990

2366

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

2991

2367

default=None)

2992

2368

2993

2369

options = parser.parse_args()

2994

2370

2371

if options.check:

2372

import doctest

2373

fail_count, test_count = doctest.testmod()

2374

sys.exit(os.EX_OK if fail_count == 0 else 1)

2375

2995

2376

# Default values for config file for server-global settings

2996

if gnutls.has_rawpk:

2997

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

2998

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

2999

else:

3000

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

3001

":+SIGN-DSA-SHA256")

3002

server_defaults = {"interface": "",

3003

"address": "",

3004

"port": "",

3005

"debug": "False",

3006

"priority": priority,

3007

"servicename": "Mandos",

3008

"use_dbus": "True",

3009

"use_ipv6": "True",

3010

"debuglevel": "",

3011

"restore": "True",

3012

"socket": "",

3013

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

3014

"foreground": "False",

3015

"zeroconf": "True",

3016

}

3017

del priority

3018

2377

server_defaults = { "interface": "",

2378

"address": "",

2379

"port": "",

2380

"debug": "False",

2381

"priority":

2382

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

2383

":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2384

"servicename": "Mandos",

2385

"use_dbus": "True",

2386

"use_ipv6": "True",

2387

"debuglevel": "",

2388

"restore": "True",

2389

"socket": "",

2390

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

2391

"foreground": "False",

2392

"zeroconf": "True",

2393

}

2394

3019

2395

# Parse config file for server-global settings

3020

server_config = configparser.ConfigParser(server_defaults)

2396

server_config = configparser.SafeConfigParser(server_defaults)

3021

2397

del server_defaults

3022

2398

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

3023

# Convert the ConfigParser object to a dict

2399

# Convert the SafeConfigParser object to a dict

3024

2400

server_settings = server_config.defaults()

3025

2401

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

3026

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

3027

"foreground", "zeroconf"):

2402

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

3028

2403

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

3029

2404

option)

3030

2405

if server_settings["port"]:

3040

2415

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

3041

2416

["socket"])

3042

2417

del server_config

3043

2418

3044

2419

# Override the settings from the config file with command line

3045

2420

# options, if set.

3046

2421

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

3064

2439

if server_settings["debug"]:

3065

2440

server_settings["foreground"] = True

3066

2441

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

3067

2442

3068

2443

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

3069

2444

3070

2445

if (not server_settings["zeroconf"]

3071

2446

and not (server_settings["port"]

3072

2447

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

3073

2448

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

3074

2449

3075

2450

# For convenience

3076

2451

debug = server_settings["debug"]

3077

2452

debuglevel = server_settings["debuglevel"]

3081

2456

stored_state_file)

3082

2457

foreground = server_settings["foreground"]

3083

2458

zeroconf = server_settings["zeroconf"]

3084

2459

3085

2460

if debug:

3086

2461

initlogger(debug, logging.DEBUG)

3087

2462

else:

3090

2465

else:

3091

2466

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

3092

2467

initlogger(debug, level)

3093

2468

3094

2469

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

3095

2470

syslogger.setFormatter(

3096

2471

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

3097

2472

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

3098

2473

server_settings["servicename"])))

3099

2474

3100

2475

# Parse config file with clients

3101

client_config = configparser.ConfigParser(Client.client_defaults)

2476

client_config = configparser.SafeConfigParser(Client

2477

.client_defaults)

3102

2478

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

3103

2479

"clients.conf"))

3104

2480

3105

2481

global mandos_dbus_service

3106

2482

mandos_dbus_service = None

3107

2483

3108

2484

socketfd = None

3109

2485

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

3110

2486

socketfd = server_settings["socket"]

3122

2498

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

3123

2499

pidfile = None

3124

2500

try:

3125

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

2501

pidfile = open(pidfilename, "w")

3126

2502

except IOError as e:

3127

2503

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

3128

2504

exc_info=e)

3129

3130

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

3131

("mandos", "mandos"),

3132

("nobody", "nogroup")):

2505

2506

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

3133

2507

try:

3134

2508

uid = pwd.getpwnam(name).pw_uid

3135

gid = pwd.getpwnam(group).pw_gid

2509

gid = pwd.getpwnam(name).pw_gid

3136

2510

break

3137

2511

except KeyError:

3138

2512

continue

3142

2516

try:

3143

2517

os.setgid(gid)

3144

2518

os.setuid(uid)

3145

if debug:

3146

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

3147

gid))

3148

2519

except OSError as error:

3149

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

3150

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

3151

2520

if error.errno != errno.EPERM:

3152

2521

raise

3153

2522

3154

2523

if debug:

3155

2524

# Enable all possible GnuTLS debugging

3156

2525

3157

2526

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

3158

2527

# - GnuTLS manual

3159

gnutls.global_set_log_level(11)

3160

3161

@gnutls.log_func

2528

gnutls.library.functions.gnutls_global_set_log_level(11)

2529

2530

@gnutls.library.types.gnutls_log_func

3162

2531

def debug_gnutls(level, string):

3163

2532

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

3164

3165

gnutls.global_set_log_function(debug_gnutls)

3166

2533

2534

gnutls.library.functions.gnutls_global_set_log_function(

2535

debug_gnutls)

2536

3167

2537

# Redirect stdin so all checkers get /dev/null

3168

2538

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

3169

2539

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

3170

2540

if null > 2:

3171

2541

os.close(null)

3172

2542

3173

2543

# Need to fork before connecting to D-Bus

3174

2544

if not foreground:

3175

2545

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

3176

2546

daemon()

3177

3178

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

3179

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

3180

# need to inform GLib that threads will be used.

3181

GLib.threads_init()

3182

2547

2548

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

2549

# need to inform gobject that threads will be used.

2550

gobject.threads_init()

2551

3183

2552

global main_loop

3184

2553

# From the Avahi example code

3185

2554

DBusGMainLoop(set_as_default=True)

3186

main_loop = GLib.MainLoop()

2555

main_loop = gobject.MainLoop()

3187

2556

bus = dbus.SystemBus()

3188

2557

# End of Avahi example code

3189

2558

if use_dbus:

3194

2563

old_bus_name = dbus.service.BusName(

3195

2564

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

3196

2565

do_not_queue=True)

3197

except dbus.exceptions.DBusException as e:

2566

except dbus.exceptions.NameExistsException as e:

3198

2567

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

3199

2568

use_dbus = False

3200

2569

server_settings["use_dbus"] = False

3202

2571

if zeroconf:

3203

2572

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3204

2573

service = AvahiServiceToSyslog(

3205

name=server_settings["servicename"],

3206

servicetype="_mandos._tcp",

3207

protocol=protocol,

3208

bus=bus)

2574

name = server_settings["servicename"],

2575

servicetype = "_mandos._tcp",

2576

protocol = protocol,

2577

bus = bus)

3209

2578

if server_settings["interface"]:

3210

2579

service.interface = if_nametoindex(

3211

2580

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

3212

2581

3213

2582

global multiprocessing_manager

3214

2583

multiprocessing_manager = multiprocessing.Manager()

3215

2584

3216

2585

client_class = Client

3217

2586

if use_dbus:

3218

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

3219

2587

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

2588

3220

2589

client_settings = Client.config_parser(client_config)

3221

2590

old_client_settings = {}

3222

2591

clients_data = {}

3223

2592

3224

2593

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

3225

2594

global wnull

3226

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

2595

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

3227

2596

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

3228

2597

# mode

3229

2598

if debug or not foreground:

3230

2599

wnull.close()

3231

2600

3232

2601

# Get client data and settings from last running state.

3233

2602

if server_settings["restore"]:

3234

2603

try:

3235

2604

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

3236

if sys.version_info.major == 2:

3237

clients_data, old_client_settings = pickle.load(

3238

stored_state)

3239

else:

3240

bytes_clients_data, bytes_old_client_settings = (

3241

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

3242

# Fix bytes to strings

3243

# clients_data

3244

# .keys()

3245

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

3246

if isinstance(key, bytes)

3247

else key): value

3248

for key, value in

3249

bytes_clients_data.items()}

3250

del bytes_clients_data

3251

for key in clients_data:

3252

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

3253

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

3254

for k, v in

3255

clients_data[key].items()}

3256

clients_data[key] = value

3257

# .client_structure

3258

value["client_structure"] = [

3259

(s.decode("utf-8")

3260

if isinstance(s, bytes)

3261

else s) for s in

3262

value["client_structure"]]

3263

# .name, .host, and .checker_command

3264

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

3265

if isinstance(value[k], bytes):

3266

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

3267

if "key_id" not in value:

3268

value["key_id"] = ""

3269

elif "fingerprint" not in value:

3270

value["fingerprint"] = ""

3271

# old_client_settings

3272

# .keys()

3273

old_client_settings = {

3274

(key.decode("utf-8")

3275

if isinstance(key, bytes)

3276

else key): value

3277

for key, value in

3278

bytes_old_client_settings.items()}

3279

del bytes_old_client_settings

3280

# .host and .checker_command

3281

for value in old_client_settings.values():

3282

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

3283

if isinstance(value[attribute], bytes):

3284

value[attribute] = (value[attribute]

3285

.decode("utf-8"))

2605

clients_data, old_client_settings = pickle.load(

2606

stored_state)

3286

2607

os.remove(stored_state_path)

3287

2608

except IOError as e:

3288

2609

if e.errno == errno.ENOENT:

3296

2617

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

3297

2618

"EOFError:",

3298

2619

exc_info=e)

3299

2620

3300

2621

with PGPEngine() as pgp:

3301

2622

for client_name, client in clients_data.items():

3302

2623

# Skip removed clients

3303

2624

if client_name not in client_settings:

3304

2625

continue

3305

2626

3306

2627

# Decide which value to use after restoring saved state.

3307

2628

# We have three different values: Old config file,

3308

2629

# new config file, and saved state.

3319

2640

client[name] = value

3320

2641

except KeyError:

3321

2642

pass

3322

2643

3323

2644

# Clients who has passed its expire date can still be

3324

# enabled if its last checker was successful. A Client

2645

# enabled if its last checker was successful. Clients

3325

2646

# whose checker succeeded before we stored its state is

3326

2647

# assumed to have successfully run all checkers during

3327

2648

# downtime.

3358

2679

client_name))

3359

2680

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

3360

2681

["secret"])

3361

2682

3362

2683

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

3363

2684

for client_name in (set(old_client_settings)

3364

2685

- set(client_settings)):

3366

2687

for client_name in (set(client_settings)

3367

2688

- set(old_client_settings)):

3368

2689

clients_data[client_name] = client_settings[client_name]

3369

2690

3370

2691

# Create all client objects

3371

2692

for client_name, client in clients_data.items():

3372

2693

tcp_server.clients[client_name] = client_class(

3373

name=client_name,

3374

settings=client,

3375

server_settings=server_settings)

3376

2694

name = client_name,

2695

settings = client,

2696

server_settings = server_settings)

2697

3377

2698

if not tcp_server.clients:

3378

2699

logger.warning("No clients defined")

3379

2700

3380

2701

if not foreground:

3381

2702

if pidfile is not None:

3382

pid = os.getpid()

3383

2703

try:

3384

2704

with pidfile:

3385

print(pid, file=pidfile)

2705

pid = os.getpid()

2706

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

3386

2707

except IOError:

3387

2708

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

3388

2709

pidfilename, pid)

3389

2710

del pidfile

3390

2711

del pidfilename

3391

3392

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

3393

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3394

lambda: main_loop.quit() and False)

3395

2712

2713

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

2714

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

2715

3396

2716

if use_dbus:

3397

2717

3398

2718

@alternate_dbus_interfaces(

3399

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

3400

class MandosDBusService(DBusObjectWithObjectManager):

2719

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

2720

class MandosDBusService(DBusObjectWithProperties):

3401

2721

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

3402

2722

3403

2723

def __init__(self):

3404

2724

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

3405

2725

3406

2726

_interface = "se.recompile.Mandos"

3407

2727

2728

@dbus_interface_annotations(_interface)

2729

def _foo(self):

2730

return {

2731

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

2732

"false" }

2733

3408

2734

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

3409

2735

def ClientAdded(self, objpath):

3410

2736

"D-Bus signal"

3411

2737

pass

3412

2738

3413

2739

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

3414

def ClientNotFound(self, key_id, address):

2740

def ClientNotFound(self, fingerprint, address):

3415

2741

"D-Bus signal"

3416

2742

pass

3417

3418

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

3419

"true"})

2743

3420

2744

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

3421

2745

def ClientRemoved(self, objpath, name):

3422

2746

"D-Bus signal"

3423

2747

pass

3424

3425

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

3426

"true"})

2748

3427

2749

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

3428

2750

def GetAllClients(self):

3429

2751

"D-Bus method"

3430

2752

return dbus.Array(c.dbus_object_path for c in

3431

tcp_server.clients.values())

3432

3433

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

3434

"true"})

2753

tcp_server.clients.itervalues())

2754

3435

2755

@dbus.service.method(_interface,

3436

2756

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

3437

2757

def GetAllClientsWithProperties(self):

3438

2758

"D-Bus method"

3439

2759

return dbus.Dictionary(

3440

{c.dbus_object_path: c.GetAll(

3441

"se.recompile.Mandos.Client")

3442

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

2760

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

2761

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

3443

2762

signature="oa{sv}")

3444

2763

3445

2764

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

3446

2765

def RemoveClient(self, object_path):

3447

2766

"D-Bus method"

3448

for c in tcp_server.clients.values():

2767

for c in tcp_server.clients.itervalues():

3449

2768

if c.dbus_object_path == object_path:

3450

2769

del tcp_server.clients[c.name]

3451

2770

c.remove_from_connection()

3452

# Don't signal the disabling

2771

# Don't signal anything except ClientRemoved

3453

2772

c.disable(quiet=True)

3454

# Emit D-Bus signal for removal

3455

self.client_removed_signal(c)

2773

# Emit D-Bus signal

2774

self.ClientRemoved(object_path, c.name)

3456

2775

return

3457

2776

raise KeyError(object_path)

3458

2777

3459

2778

del _interface

3460

3461

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3462

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

3463

def GetManagedObjects(self):

3464

"""D-Bus method"""

3465

return dbus.Dictionary(

3466

{client.dbus_object_path:

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()})

3471

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

3472

3473

def client_added_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesAdded(

3478

client.dbus_object_path,

3479

dbus.Dictionary(

3480

{interface: client.GetAll(interface)

3481

for interface in

3482

client._get_all_interface_names()}))

3483

# Old signal

3484

self.ClientAdded(client.dbus_object_path)

3485

3486

def client_removed_signal(self, client):

3487

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

3488

if use_dbus:

3489

# New standard signal

3490

self.InterfacesRemoved(

3491

client.dbus_object_path,

3492

client._get_all_interface_names())

3493

# Old signal

3494

self.ClientRemoved(client.dbus_object_path,

3495

client.name)

3496

2779

3497

2780

mandos_dbus_service = MandosDBusService()

3498

3499

# Save modules to variables to exempt the modules from being

3500

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

3501

mp = multiprocessing

3502

wn = wnull

3503

2781

3504

2782

def cleanup():

3505

2783

"Cleanup function; run on exit"

3506

2784

if zeroconf:

3507

2785

service.cleanup()

3508

3509

mp.active_children()

3510

wn.close()

2786

2787

multiprocessing.active_children()

2788

wnull.close()

3511

2789

if not (tcp_server.clients or client_settings):

3512

2790

return

3513

2791

3514

2792

# Store client before exiting. Secrets are encrypted with key

3515

2793

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

3516

2794

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

3517

2795

clients = {}

3518

2796

with PGPEngine() as pgp:

3519

for client in tcp_server.clients.values():

2797

for client in tcp_server.clients.itervalues():

3520

2798

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

3521

2799

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

3522

2800

key)

3523

2801

client_dict = {}

3524

2802

3525

2803

# A list of attributes that can not be pickled

3526

2804

# + secret.

3527

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

3528

"checker", "server_settings"}

2805

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

2806

"checker", "server_settings" }

3529

2807

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

3530

2808

.Object):

3531

2809

exclude.add(name)

3532

2810

3533

2811

client_dict["encrypted_secret"] = (client

3534

2812

.encrypted_secret)

3535

2813

for attr in client.client_structure:

3536

2814

if attr not in exclude:

3537

2815

client_dict[attr] = getattr(client, attr)

3538

2816

3539

2817

clients[client.name] = client_dict

3540

2818

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

3541

2819

3542

2820

try:

3543

2821

with tempfile.NamedTemporaryFile(

3544

2822

mode='wb',

3546

2824

prefix='clients-',

3547

2825

dir=os.path.dirname(stored_state_path),

3548

2826

delete=False) as stored_state:

3549

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

3550

protocol=2)

2827

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

3551

2828

tempname = stored_state.name

3552

2829

os.rename(tempname, stored_state_path)

3553

2830

except (IOError, OSError) as e:

3563

2840

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

3564

2841

exc_info=e)

3565

2842

raise

3566

2843

3567

2844

# Delete all clients, and settings from config

3568

2845

while tcp_server.clients:

3569

2846

name, client = tcp_server.clients.popitem()

3570

2847

if use_dbus:

3571

2848

client.remove_from_connection()

3572

# Don't signal the disabling

2849

# Don't signal anything except ClientRemoved

3573

2850

client.disable(quiet=True)

3574

# Emit D-Bus signal for removal

3575

2851

if use_dbus:

3576

mandos_dbus_service.client_removed_signal(client)

2852

# Emit D-Bus signal

2853

mandos_dbus_service.ClientRemoved(

2854

client.dbus_object_path, client.name)

3577

2855

client_settings.clear()

3578

2856

3579

2857

atexit.register(cleanup)

3580

3581

for client in tcp_server.clients.values():

2858

2859

for client in tcp_server.clients.itervalues():

3582

2860

if use_dbus:

3583

# Emit D-Bus signal for adding

3584

mandos_dbus_service.client_added_signal(client)

2861

# Emit D-Bus signal

2862

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3585

2863

# Need to initiate checking of clients

3586

2864

if client.enabled:

3587

2865

client.init_checker()

3588

2866

3589

2867

tcp_server.enable()

3590

2868

tcp_server.server_activate()

3591

2869

3592

2870

# Find out what port we got

3593

2871

if zeroconf:

3594

2872

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

3599

2877

else: # IPv4

3600

2878

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

3601

2879

*tcp_server.socket.getsockname())

3602

3603

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

3604

2880

2881

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

2882

3605

2883

try:

3606

2884

if zeroconf:

3607

2885

# From the Avahi example code

3612

2890

cleanup()

3613

2891

sys.exit(1)

3614

2892

# End of Avahi example code

3615

3616

GLib.io_add_watch(

3617

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

3618

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3619

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

3620

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

3621

2893

2894

gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,

2895

lambda *args, **kwargs:

2896

(tcp_server.handle_request

2897

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

2898

3622

2899

logger.debug("Starting main loop")

3623

2900

main_loop.run()

3624

2901

except AvahiError as error:

3633

2910

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

3634

2911

cleanup()

3635

2912

3636

3637

def should_only_run_tests():

3638

parser = argparse.ArgumentParser(add_help=False)

3639

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

3640

args, unknown_args = parser.parse_known_args()

3641

run_tests = args.check

3642

if run_tests:

3643

# Remove --check argument from sys.argv

3644

sys.argv[1:] = unknown_args

3645

return run_tests

3646

3647

# Add all tests from doctest strings

3648

def load_tests(loader, tests, none):

3649

import doctest

3650

tests.addTests(doctest.DocTestSuite())

3651

return tests

3652

2913

3653

2914

if __name__ == '__main__':

3654

try:

3655

if should_only_run_tests():

3656

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

3657

unittest.main()

3658

else:

3659

main()

3660

finally:

3661

logging.shutdown()

2915

main()