/mandos/trunk : revision 1202

1

#!/usr/bin/python2.7

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

43

try:

40

44

import SocketServer as socketserver

44

48

import argparse

45

49

import datetime

46

50

import errno

47

import gnutls.crypto

48

import gnutls.connection

49

import gnutls.errors

50

import gnutls.library.functions

51

import gnutls.library.constants

52

import gnutls.library.types

53

51

try:

54

52

import ConfigParser as configparser

55

53

except ImportError:

79

77

import itertools

80

78

import collections

81

79

import codecs

80

import unittest

81

import random

82

83

import dbus

84

import dbus.service

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

89

import avahi

85

import gi

86

from gi.repository import GLib

90

87

from dbus.mainloop.glib import DBusGMainLoop

91

88

import ctypes

92

89

import ctypes.util

93

90

import xml.dom.minidom

94

91

import inspect

95

92

96

try:

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:

97

115

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

98

116

except AttributeError:

99

117

try:

118

# This is where SO_BINDTODEVICE was up to and including Python

119

# 2.6, and also 3.2:

100

120

from IN import SO_BINDTODEVICE

101

121

except ImportError:

102

SO_BINDTODEVICE = None

103

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

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"

108

140

stored_state_file = "clients.pickle"

109

141

110

142

logger = logging.getLogger()

143

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

111

144

syslogger = None

112

145

113

146

try:

114

147

if_nametoindex = ctypes.cdll.LoadLibrary(

115

148

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

116

149

except (OSError, AttributeError):

117

150

118

151

def if_nametoindex(interface):

119

152

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

120

153

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

125

158

return interface_index

126

159

127

160

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

128

177

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

129

178

"""init logger and add loglevel"""

130

179

131

180

global syslogger

132

181

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

182

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

183

address="/dev/log"))

135

184

syslogger.setFormatter(logging.Formatter

136

185

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

137

186

' %(message)s'))

138

187

logger.addHandler(syslogger)

139

188

140

189

if debug:

141

190

console = logging.StreamHandler()

142

191

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

152

201

pass

153

202

154

203

155

class PGPEngine(object):

204

class PGPEngine:

156

205

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

157

206

158

207

def __init__(self):

159

208

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

160

220

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

221

'--homedir', self.tempdir,

162

222

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

165

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

166

228

def __enter__(self):

167

229

return self

168

230

169

231

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

170

232

self._cleanup()

171

233

return False

172

234

173

235

def __del__(self):

174

236

self._cleanup()

175

237

176

238

def _cleanup(self):

177

239

if self.tempdir is not None:

178

240

# Delete contents of tempdir

179

241

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

180

topdown = False):

242

topdown=False):

181

243

for filename in files:

182

244

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

183

245

for dirname in dirs:

185

247

# Remove tempdir

186

248

os.rmdir(self.tempdir)

187

249

self.tempdir = None

188

250

189

251

def password_encode(self, password):

190

252

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

191

253

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

196

258

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

197

259

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

198

260

return encoded

199

261

200

262

def encrypt(self, data, password):

201

263

passphrase = self.password_encode(password)

202

264

with tempfile.NamedTemporaryFile(

203

265

dir=self.tempdir) as passfile:

204

266

passfile.write(passphrase)

205

267

passfile.flush()

206

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

268

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

207

269

'--passphrase-file',

208

270

passfile.name]

209

271

+ self.gnupgargs,

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

214

276

if proc.returncode != 0:

215

277

raise PGPError(err)

216

278

return ciphertext

217

279

218

280

def decrypt(self, data, password):

219

281

passphrase = self.password_encode(password)

220

282

with tempfile.NamedTemporaryFile(

221

dir = self.tempdir) as passfile:

283

dir=self.tempdir) as passfile:

222

284

passfile.write(passphrase)

223

285

passfile.flush()

224

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

286

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

225

287

'--passphrase-file',

226

288

passfile.name]

227

289

+ self.gnupgargs,

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

290

stdin=subprocess.PIPE,

291

stdout=subprocess.PIPE,

292

stderr=subprocess.PIPE)

293

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

232

294

if proc.returncode != 0:

233

295

raise PGPError(err)

234

296

return decrypted_plaintext

235

297

236

298

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

237

325

class AvahiError(Exception):

238

326

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

239

327

self.value = value

249

337

pass

250

338

251

339

252

class AvahiService(object):

340

class AvahiService:

253

341

"""An Avahi (Zeroconf) service.

254

342

255

343

Attributes:

256

344

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

257

345

Used to optionally bind to the specified interface.

269

357

server: D-Bus Server

270

358

bus: dbus.SystemBus()

271

359

"""

272

360

273

361

def __init__(self,

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

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

284

372

self.interface = interface

285

373

self.name = name

286

374

self.type = servicetype

295

383

self.server = None

296

384

self.bus = bus

297

385

self.entry_group_state_changed_match = None

298

386

299

387

def rename(self, remove=True):

300

388

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

301

389

if self.rename_count >= self.max_renames:

321

409

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

322

410

self.cleanup()

323

411

os._exit(1)

324

412

325

413

def remove(self):

326

414

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

327

415

if self.entry_group_state_changed_match is not None:

329

417

self.entry_group_state_changed_match = None

330

418

if self.group is not None:

331

419

self.group.Reset()

332

420

333

421

def add(self):

334

422

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

335

423

self.remove()

352

440

dbus.UInt16(self.port),

353

441

avahi.string_array_to_txt_array(self.TXT))

354

442

self.group.Commit()

355

443

356

444

def entry_group_state_changed(self, state, error):

357

445

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

358

446

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

359

447

360

448

if state == avahi.ENTRY_GROUP_ESTABLISHED:

361

449

logger.debug("Zeroconf service established.")

362

450

elif state == avahi.ENTRY_GROUP_COLLISION:

366

454

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

367

455

str(error))

368

456

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

369

457

370

458

def cleanup(self):

371

459

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

372

460

if self.group is not None:

377

465

pass

378

466

self.group = None

379

467

self.remove()

380

468

381

469

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

382

470

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

383

471

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

412

500

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

413

501

else:

414

502

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

415

503

416

504

def activate(self):

417

505

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

418

506

if self.server is None:

429

517

class AvahiServiceToSyslog(AvahiService):

430

518

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

431

519

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

432

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

520

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

433

521

syslogger.setFormatter(logging.Formatter(

434

522

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

435

523

.format(self.name)))

436

524

return ret

437

525

526

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

438

828

def call_pipe(connection, # : multiprocessing.Connection

439

829

func, *args, **kwargs):

440

830

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

441

831

442

832

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

443

833

return value on the provided multiprocessing.Connection.

444

834

"""

445

835

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

446

836

connection.close()

447

837

448

class Client(object):

838

839

class Client:

449

840

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

450

841

451

842

Attributes:

452

843

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

453

844

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

454

845

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

455

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

456

to see if the client lives.

457

'None' if no process is running.

458

checker_callback_tag: a gobject event source tag, or None

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

459

850

checker_command: string; External command which is run to check

460

851

if client lives. %() expansions are done at

461

852

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

462

853

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

463

checker_initiator_tag: a gobject event source tag, or None

854

checker_initiator_tag: a GLib event source tag, or None

464

855

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

465

856

client_structure: Object describing what attributes a client has

466

857

and is used for storing the client at exit

467

858

current_checker_command: string; current running checker_command

468

disable_initiator_tag: a gobject event source tag, or None

859

disable_initiator_tag: a GLib event source tag, or None

469

860

enabled: bool()

470

861

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

471

uniquely identify the client

862

uniquely identify an OpenPGP client

863

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

864

a client using raw public keys

472

865

host: string; available for use by the checker command

473

866

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

474

867

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

490

883

disabled, or None

491

884

server_settings: The server_settings dict from main()

492

885

"""

493

886

494

887

runtime_expansions = ("approval_delay", "approval_duration",

495

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

888

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

496

889

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

497

890

"last_approval_request", "last_checked_ok",

498

891

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

507

900

"approved_by_default": "True",

508

901

"enabled": "True",

509

902

}

510

903

511

904

@staticmethod

512

905

def config_parser(config):

513

906

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

520

913

for client_name in config.sections():

521

914

section = dict(config.items(client_name))

522

915

client = settings[client_name] = {}

523

916

524

917

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

525

918

# Reformat values from string types to Python types

526

919

client["approved_by_default"] = config.getboolean(

527

920

client_name, "approved_by_default")

528

921

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

529

922

"enabled")

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

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

534

929

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

535

930

.replace(" ", ""))

536

931

if "secret" in section:

537

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

932

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

933

.encode("utf-8"),

934

"base64")

538

935

elif "secfile" in section:

539

936

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

540

937

(section["secfile"])),

555

952

client["last_approval_request"] = None

556

953

client["last_checked_ok"] = None

557

954

client["last_checker_status"] = -2

558

955

559

956

return settings

560

561

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

957

958

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

562

959

self.name = name

563

960

if server_settings is None:

564

961

server_settings = {}

566

963

# adding all client settings

567

964

for setting, value in settings.items():

568

965

setattr(self, setting, value)

569

966

570

967

if self.enabled:

571

968

if not hasattr(self, "last_enabled"):

572

969

self.last_enabled = datetime.datetime.utcnow()

576

973

else:

577

974

self.last_enabled = None

578

975

self.expires = None

579

976

580

977

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

978

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

581

979

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

582

980

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

583

981

datetime.datetime.utcnow())

584

982

585

983

# attributes specific for this server instance

586

984

self.checker = None

587

985

self.checker_initiator_tag = None

593

991

self.changedstate = multiprocessing_manager.Condition(

594

992

multiprocessing_manager.Lock())

595

993

self.client_structure = [attr

596

for attr in self.__dict__.iterkeys()

994

for attr in self.__dict__.keys()

597

995

if not attr.startswith("_")]

598

996

self.client_structure.append("client_structure")

599

997

600

998

for name, t in inspect.getmembers(

601

999

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

602

1000

if not name.startswith("_"):

603

1001

self.client_structure.append(name)

604

1002

605

1003

# Send notice to process children that client state has changed

606

1004

def send_changedstate(self):

607

1005

with self.changedstate:

608

1006

self.changedstate.notify_all()

609

1007

610

1008

def enable(self):

611

1009

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

612

1010

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

617

1015

self.last_enabled = datetime.datetime.utcnow()

618

1016

self.init_checker()

619

1017

self.send_changedstate()

620

1018

621

1019

def disable(self, quiet=True):

622

1020

"""Disable this client."""

623

1021

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

625

1023

if not quiet:

626

1024

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

627

1025

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

628

gobject.source_remove(self.disable_initiator_tag)

1026

GLib.source_remove(self.disable_initiator_tag)

629

1027

self.disable_initiator_tag = None

630

1028

self.expires = None

631

1029

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

632

gobject.source_remove(self.checker_initiator_tag)

1030

GLib.source_remove(self.checker_initiator_tag)

633

1031

self.checker_initiator_tag = None

634

1032

self.stop_checker()

635

1033

self.enabled = False

636

1034

if not quiet:

637

1035

self.send_changedstate()

638

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

1036

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

639

1037

return False

640

1038

641

1039

def __del__(self):

642

1040

self.disable()

643

1041

644

1042

def init_checker(self):

645

1043

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

646

1044

# and every interval from then on.

647

1045

if self.checker_initiator_tag is not None:

648

gobject.source_remove(self.checker_initiator_tag)

649

self.checker_initiator_tag = gobject.timeout_add(

650

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

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

651

1050

self.start_checker)

652

1051

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

653

1052

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = gobject.timeout_add(

1053

GLib.source_remove(self.disable_initiator_tag)

1054

self.disable_initiator_tag = GLib.timeout_add(

656

1055

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

657

1056

# Also start a new checker *right now*.

658

1057

self.start_checker()

659

1058

660

1059

def checker_callback(self, source, condition, connection,

661

1060

command):

662

1061

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

663

self.checker_callback_tag = None

664

self.checker = None

665

1062

# Read return code from connection (see call_pipe)

666

1063

returncode = connection.recv()

667

1064

connection.close()

668

1065

if self.checker is not None:

1066

self.checker.join()

1067

self.checker_callback_tag = None

1068

self.checker = None

1069

669

1070

if returncode >= 0:

670

1071

self.last_checker_status = returncode

671

1072

self.last_checker_signal = None

681

1082

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

682

1083

vars(self))

683

1084

return False

684

1085

685

1086

def checked_ok(self):

686

1087

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

687

1088

self.last_checked_ok = datetime.datetime.utcnow()

688

1089

self.last_checker_status = 0

689

1090

self.last_checker_signal = None

690

1091

self.bump_timeout()

691

1092

692

1093

def bump_timeout(self, timeout=None):

693

1094

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

694

1095

if timeout is None:

695

1096

timeout = self.timeout

696

1097

if self.disable_initiator_tag is not None:

697

gobject.source_remove(self.disable_initiator_tag)

1098

GLib.source_remove(self.disable_initiator_tag)

698

1099

self.disable_initiator_tag = None

699

1100

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

700

self.disable_initiator_tag = gobject.timeout_add(

1101

self.disable_initiator_tag = GLib.timeout_add(

701

1102

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

702

1103

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

703

1104

704

1105

def need_approval(self):

705

1106

self.last_approval_request = datetime.datetime.utcnow()

706

1107

707

1108

def start_checker(self):

708

1109

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

709

1110

710

1111

If a checker already exists, leave it running and do

711

1112

nothing."""

712

1113

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

717

1118

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

718

1119

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

719

1120

# should be.

720

1121

721

1122

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

722

1123

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

723

1124

self.checker.join()

727

1128

# Escape attributes for the shell

728

1129

escaped_attrs = {

729

1130

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

730

for attr in self.runtime_expansions }

1131

for attr in self.runtime_expansions}

731

1132

try:

732

1133

command = self.checker_command % escaped_attrs

733

1134

except TypeError as error:

745

1146

# The exception is when not debugging but nevertheless

746

1147

# running in the foreground; use the previously

747

1148

# created wnull.

748

popen_args = { "close_fds": True,

749

"shell": True,

750

"cwd": "/" }

1149

popen_args = {"close_fds": True,

1150

"shell": True,

1151

"cwd": "/"}

751

1152

if (not self.server_settings["debug"]

752

1153

and self.server_settings["foreground"]):

753

1154

popen_args.update({"stdout": wnull,

754

"stderr": wnull })

755

pipe = multiprocessing.Pipe(duplex = False)

1155

"stderr": wnull})

1156

pipe = multiprocessing.Pipe(duplex=False)

756

1157

self.checker = multiprocessing.Process(

757

target = call_pipe,

758

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

759

kwargs = popen_args)

1158

target=call_pipe,

1159

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

1160

kwargs=popen_args)

760

1161

self.checker.start()

761

self.checker_callback_tag = gobject.io_add_watch(

762

pipe[0].fileno(), gobject.IO_IN,

1162

self.checker_callback_tag = GLib.io_add_watch(

1163

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

1164

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

763

1165

self.checker_callback, pipe[0], command)

764

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

1166

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

765

1167

return True

766

1168

767

1169

def stop_checker(self):

768

1170

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

769

1171

if self.checker_callback_tag:

770

gobject.source_remove(self.checker_callback_tag)

1172

GLib.source_remove(self.checker_callback_tag)

771

1173

self.checker_callback_tag = None

772

1174

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

773

1175

return

782

1184

byte_arrays=False):

783

1185

"""Decorators for marking methods of a DBusObjectWithProperties to

784

1186

become properties on the D-Bus.

785

1187

786

1188

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

787

1189

and with one argument by "Set".

788

1190

789

1191

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

790

1192

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

791

1193

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

795

1197

if byte_arrays and signature != "ay":

796

1198

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

797

1199

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

798

1200

799

1201

def decorator(func):

800

1202

func._dbus_is_property = True

801

1203

func._dbus_interface = dbus_interface

804

1206

func._dbus_name = func.__name__

805

1207

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

806

1208

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

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1209

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

808

1210

return func

809

1211

810

1212

return decorator

811

1213

812

1214

813

1215

def dbus_interface_annotations(dbus_interface):

814

1216

"""Decorator for marking functions returning interface annotations

815

1217

816

1218

Usage:

817

1219

818

1220

@dbus_interface_annotations("org.example.Interface")

819

1221

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

820

1222

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

821

1223

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

822

1224

"false"}

823

1225

"""

824

1226

825

1227

def decorator(func):

826

1228

func._dbus_is_interface = True

827

1229

func._dbus_interface = dbus_interface

828

1230

func._dbus_name = dbus_interface

829

1231

return func

830

1232

831

1233

return decorator

832

1234

833

1235

834

1236

def dbus_annotations(annotations):

835

1237

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

836

1238

Usage:

837

1239

838

1240

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

839

1241

"org.freedesktop.DBus.Property."

840

1242

"EmitsChangedSignal": "false"})

842

1244

access="r")

843

1245

def Property_dbus_property(self):

844

1246

return dbus.Boolean(False)

1247

1248

See also the DBusObjectWithAnnotations class.

845

1249

"""

846

1250

847

1251

def decorator(func):

848

1252

func._dbus_annotations = annotations

849

1253

return func

850

1254

851

1255

return decorator

852

1256

853

1257

869

1273

pass

870

1274

871

1275

872

class DBusObjectWithProperties(dbus.service.Object):

873

"""A D-Bus object with properties.

874

875

Classes inheriting from this can use the dbus_service_property

876

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

877

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

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.

878

1281

"""

879

1282

880

1283

@staticmethod

881

1284

def _is_dbus_thing(thing):

882

1285

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

883

1286

884

1287

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

885

1288

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

886

1289

"""

887

1290

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

888

1291

False)

889

1292

890

1293

def _get_all_dbus_things(self, thing):

891

1294

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

892

1295

"""

895

1298

for cls in self.__class__.__mro__

896

1299

for name, athing in

897

1300

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

898

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

899

1373

def _get_dbus_property(self, interface_name, property_name):

900

1374

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

901

1375

property with the specified name and interface.

906

1380

if (value._dbus_name == property_name

907

1381

and value._dbus_interface == interface_name):

908

1382

return value.__get__(self)

909

1383

910

1384

# No such property

911

1385

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

912

1386

self.dbus_object_path, interface_name, property_name))

913

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

914

1397

@dbus.service.method(dbus.PROPERTIES_IFACE,

915

1398

in_signature="ss",

916

1399

out_signature="v")

924

1407

if not hasattr(value, "variant_level"):

925

1408

return value

926

1409

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

927

1410

928

1411

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

929

1412

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

930

1413

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

939

1422

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

940

1423

"'ay' signature {!r}"

941

1424

.format(prop._dbus_signature))

942

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

943

for byte in value))

1425

value = dbus.ByteArray(bytes(value))

944

1426

prop(value)

945

1427

946

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

947

1429

in_signature="s",

948

1430

out_signature="a{sv}")

949

1431

def GetAll(self, interface_name):

950

1432

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

951

1433

standard.

952

1434

953

1435

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

954

1436

"""

955

1437

properties = {}

966

1448

properties[name] = value

967

1449

continue

968

1450

properties[name] = type(value)(

969

value, variant_level = value.variant_level + 1)

1451

value, variant_level=value.variant_level + 1)

970

1452

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

971

1453

972

1454

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

973

1455

def PropertiesChanged(self, interface_name, changed_properties,

974

1456

invalidated_properties):

976

1458

standard.

977

1459

"""

978

1460

pass

979

1461

980

1462

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

981

1463

out_signature="s",

982

1464

path_keyword='object_path',

983

1465

connection_keyword='connection')

984

1466

def Introspect(self, object_path, connection):

985

1467

"""Overloading of standard D-Bus method.

986

1468

987

1469

Inserts property tags and interface annotation tags.

988

1470

"""

989

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

990

connection)

1471

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1472

object_path,

1473

connection)

991

1474

try:

992

1475

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

993

1476

994

1477

def make_tag(document, name, prop):

995

1478

e = document.createElement("property")

996

1479

e.setAttribute("name", name)

997

1480

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

998

1481

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

999

1482

return e

1000

1483

1001

1484

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

1002

1485

# Add property tags

1003

1486

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

1006

1489

if prop._dbus_interface

1007

1490

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

1008

1491

if_tag.appendChild(tag)

1009

# Add annotation tags

1010

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

1011

for tag in if_tag.getElementsByTagName(typ):

1012

annots = dict()

1013

for name, prop in (self.

1014

_get_all_dbus_things(typ)):

1015

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

1016

and prop._dbus_interface

1017

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

1018

annots.update(getattr(

1019

prop, "_dbus_annotations", {}))

1020

for name, value in annots.items():

1021

ann_tag = document.createElement(

1022

"annotation")

1023

ann_tag.setAttribute("name", name)

1024

ann_tag.setAttribute("value", value)

1025

tag.appendChild(ann_tag)

1026

# Add interface annotation tags

1027

for annotation, value in dict(

1028

itertools.chain.from_iterable(

1029

annotations().items()

1030

for name, annotations

1031

in self._get_all_dbus_things("interface")

1032

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

1033

)).items():

1034

ann_tag = document.createElement("annotation")

1035

ann_tag.setAttribute("name", annotation)

1036

ann_tag.setAttribute("value", value)

1037

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

1038

1508

# Add the names to the return values for the

1039

1509

# "org.freedesktop.DBus.Properties" methods

1040

1510

if (if_tag.getAttribute("name")

1059

1529

return xmlstring

1060

1530

1061

1531

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

1062

1603

def datetime_to_dbus(dt, variant_level=0):

1063

1604

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

1064

1605

if dt is None:

1065

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

1606

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

1066

1607

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

1067

1608

1068

1609

1071

1612

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

1072

1613

interface names according to the "alt_interface_names" mapping.

1073

1614

Usage:

1074

1615

1075

1616

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

1076

1617

"net.example.AlternateInterface"})

1077

1618

class SampleDBusObject(dbus.service.Object):

1078

1619

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

1079

1620

def SampleDBusMethod():

1080

1621

pass

1081

1622

1082

1623

The above "SampleDBusMethod" on "SampleDBusObject" will be

1083

1624

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

1084

1625

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

1085

1626

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

1086

1627

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

1087

1628

1088

1629

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

1089

1630

(from DBusObjectWithProperties) and interfaces (from the

1090

1631

dbus_interface_annotations decorator).

1091

1632

"""

1092

1633

1093

1634

def wrapper(cls):

1094

1635

for orig_interface_name, alt_interface_name in (

1095

1636

alt_interface_names.items()):

1110

1651

interface_names.add(alt_interface)

1111

1652

# Is this a D-Bus signal?

1112

1653

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

1654

# Extract the original non-method undecorated

1655

# function by black magic

1113

1656

if sys.version_info.major == 2:

1114

# Extract the original non-method undecorated

1115

# function by black magic

1116

1657

nonmethod_func = (dict(

1117

1658

zip(attribute.func_code.co_freevars,

1118

1659

attribute.__closure__))

1119

1660

["func"].cell_contents)

1120

1661

else:

1121

nonmethod_func = attribute

1662

nonmethod_func = (dict(

1663

zip(attribute.__code__.co_freevars,

1664

attribute.__closure__))

1665

["func"].cell_contents)

1122

1666

# Create a new, but exactly alike, function

1123

1667

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

1124

1668

# with the alternate D-Bus interface name

1125

if sys.version_info.major == 2:

1126

new_function = types.FunctionType(

1127

nonmethod_func.func_code,

1128

nonmethod_func.func_globals,

1129

nonmethod_func.func_name,

1130

nonmethod_func.func_defaults,

1131

nonmethod_func.func_closure)

1132

else:

1133

new_function = types.FunctionType(

1134

nonmethod_func.__code__,

1135

nonmethod_func.__globals__,

1136

nonmethod_func.__name__,

1137

nonmethod_func.__defaults__,

1138

nonmethod_func.__closure__)

1669

new_function = copy_function(nonmethod_func)

1139

1670

new_function = (dbus.service.signal(

1140

1671

alt_interface,

1141

1672

attribute._dbus_signature)(new_function))

1145

1676

attribute._dbus_annotations)

1146

1677

except AttributeError:

1147

1678

pass

1679

1148

1680

# Define a creator of a function to call both the

1149

1681

# original and alternate functions, so both the

1150

1682

# original and alternate signals gets sent when

1153

1685

"""This function is a scope container to pass

1154

1686

func1 and func2 to the "call_both" function

1155

1687

outside of its arguments"""

1156

1688

1689

@functools.wraps(func2)

1157

1690

def call_both(*args, **kwargs):

1158

1691

"""This function will emit two D-Bus

1159

1692

signals by calling func1 and func2"""

1160

1693

func1(*args, **kwargs)

1161

1694

func2(*args, **kwargs)

1162

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

1163

1701

return call_both

1164

1702

# Create the "call_both" function and add it to

1165

1703

# the class

1175

1713

alt_interface,

1176

1714

attribute._dbus_in_signature,

1177

1715

attribute._dbus_out_signature)

1178

(types.FunctionType(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1716

(copy_function(attribute)))

1183

1717

# Copy annotations, if any

1184

1718

try:

1185

1719

attr[attrname]._dbus_annotations = dict(

1197

1731

attribute._dbus_access,

1198

1732

attribute._dbus_get_args_options

1199

1733

["byte_arrays"])

1200

(types.FunctionType(

1201

attribute.func_code,

1202

attribute.func_globals,

1203

attribute.func_name,

1204

attribute.func_defaults,

1205

attribute.func_closure)))

1734

(copy_function(attribute)))

1206

1735

# Copy annotations, if any

1207

1736

try:

1208

1737

attr[attrname]._dbus_annotations = dict(

1217

1746

# to the class.

1218

1747

attr[attrname] = (

1219

1748

dbus_interface_annotations(alt_interface)

1220

(types.FunctionType(attribute.func_code,

1221

attribute.func_globals,

1222

attribute.func_name,

1223

attribute.func_defaults,

1224

attribute.func_closure)))

1749

(copy_function(attribute)))

1225

1750

if deprecate:

1226

1751

# Deprecate all alternate interfaces

1227

iname="_AlternateDBusNames_interface_annotation{}"

1752

iname = "_AlternateDBusNames_interface_annotation{}"

1228

1753

for interface_name in interface_names:

1229

1754

1230

1755

@dbus_interface_annotations(interface_name)

1231

1756

def func(self):

1232

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

1233

"true" }

1757

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

1758

"true"}

1234

1759

# Find an unused name

1235

1760

for aname in (iname.format(i)

1236

1761

for i in itertools.count()):

1240

1765

if interface_names:

1241

1766

# Replace the class with a new subclass of it with

1242

1767

# methods, signals, etc. as created above.

1243

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

1244

(cls, ), attr)

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)

1245

1774

return cls

1246

1775

1247

1776

return wrapper

1248

1777

1249

1778

1251

1780

"se.bsnet.fukt.Mandos"})

1252

1781

class ClientDBus(Client, DBusObjectWithProperties):

1253

1782

"""A Client class using D-Bus

1254

1783

1255

1784

Attributes:

1256

1785

dbus_object_path: dbus.ObjectPath

1257

1786

bus: dbus.SystemBus()

1258

1787

"""

1259

1788

1260

1789

runtime_expansions = (Client.runtime_expansions

1261

1790

+ ("dbus_object_path", ))

1262

1791

1263

1792

_interface = "se.recompile.Mandos.Client"

1264

1793

1265

1794

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

1266

1267

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

1795

1796

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

1268

1797

self.bus = bus

1269

1798

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

1270

1799

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

1276

1805

"/clients/" + client_object_name)

1277

1806

DBusObjectWithProperties.__init__(self, self.bus,

1278

1807

self.dbus_object_path)

1279

1808

1280

1809

def notifychangeproperty(transform_func, dbus_name,

1281

1810

type_func=lambda x: x,

1282

1811

variant_level=1,

1284

1813

_interface=_interface):

1285

1814

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

1286

1815

its changes to DBus.

1287

1816

1288

1817

transform_fun: Function that takes a value and a variant_level

1289

1818

and transforms it to a D-Bus type.

1290

1819

dbus_name: D-Bus name of the variable

1293

1822

variant_level: D-Bus variant level. Default: 1

1294

1823

"""

1295

1824

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

1296

1825

1297

1826

def setter(self, value):

1298

1827

if hasattr(self, "dbus_object_path"):

1299

1828

if (not hasattr(self, attrname) or

1306

1835

else:

1307

1836

dbus_value = transform_func(

1308

1837

type_func(value),

1309

variant_level = variant_level)

1838

variant_level=variant_level)

1310

1839

self.PropertyChanged(dbus.String(dbus_name),

1311

1840

dbus_value)

1312

1841

self.PropertiesChanged(

1313

1842

_interface,

1314

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

1315

dbus_value }),

1843

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

1844

dbus_value}),

1316

1845

dbus.Array())

1317

1846

setattr(self, attrname, value)

1318

1847

1319

1848

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

1320

1849

1321

1850

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1322

1851

approvals_pending = notifychangeproperty(dbus.Boolean,

1323

1852

"ApprovalPending",

1324

type_func = bool)

1853

type_func=bool)

1325

1854

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

1326

1855

last_enabled = notifychangeproperty(datetime_to_dbus,

1327

1856

"LastEnabled")

1328

1857

checker = notifychangeproperty(

1329

1858

dbus.Boolean, "CheckerRunning",

1330

type_func = lambda checker: checker is not None)

1859

type_func=lambda checker: checker is not None)

1331

1860

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1332

1861

"LastCheckedOK")

1333

1862

last_checker_status = notifychangeproperty(dbus.Int16,

1338

1867

"ApprovedByDefault")

1339

1868

approval_delay = notifychangeproperty(

1340

1869

dbus.UInt64, "ApprovalDelay",

1341

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

1870

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

1342

1871

approval_duration = notifychangeproperty(

1343

1872

dbus.UInt64, "ApprovalDuration",

1344

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

1873

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

1345

1874

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

1346

1875

timeout = notifychangeproperty(

1347

1876

dbus.UInt64, "Timeout",

1348

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

1877

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

1349

1878

extended_timeout = notifychangeproperty(

1350

1879

dbus.UInt64, "ExtendedTimeout",

1351

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

1880

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

1352

1881

interval = notifychangeproperty(

1353

1882

dbus.UInt64, "Interval",

1354

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

1883

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

1355

1884

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

1356

1885

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

1357

1886

invalidate_only=True)

1358

1887

1359

1888

del notifychangeproperty

1360

1889

1361

1890

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

1362

1891

try:

1363

1892

self.remove_from_connection()

1366

1895

if hasattr(DBusObjectWithProperties, "__del__"):

1367

1896

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

1368

1897

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

1369

1898

1370

1899

def checker_callback(self, source, condition,

1371

1900

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

1372

1901

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

1376

1905

if exitstatus >= 0:

1377

1906

# Emit D-Bus signal

1378

1907

self.CheckerCompleted(dbus.Int16(exitstatus),

1379

dbus.Int64(0),

1908

# This is specific to GNU libC

1909

dbus.Int64(exitstatus << 8),

1380

1910

dbus.String(command))

1381

1911

else:

1382

1912

# Emit D-Bus signal

1383

1913

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

1384

1914

dbus.Int64(

1385

self.last_checker_signal),

1915

# This is specific to GNU libC

1916

(exitstatus << 8)

1917

| self.last_checker_signal),

1386

1918

dbus.String(command))

1387

1919

return ret

1388

1920

1389

1921

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

1390

1922

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

1391

1923

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

1395

1927

# Emit D-Bus signal

1396

1928

self.CheckerStarted(self.current_checker_command)

1397

1929

return r

1398

1930

1399

1931

def _reset_approved(self):

1400

1932

self.approved = None

1401

1933

return False

1402

1934

1403

1935

def approve(self, value=True):

1404

1936

self.approved = value

1405

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

1406

* 1000), self._reset_approved)

1937

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

1938

* 1000), self._reset_approved)

1407

1939

self.send_changedstate()

1408

1409

## D-Bus methods, signals & properties

1410

1411

## Interfaces

1412

1413

## Signals

1414

1940

1941

# D-Bus methods, signals & properties

1942

1943

# Interfaces

1944

1945

# Signals

1946

1415

1947

# CheckerCompleted - signal

1416

1948

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

1417

1949

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

1418

1950

"D-Bus signal"

1419

1951

pass

1420

1952

1421

1953

# CheckerStarted - signal

1422

1954

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

1423

1955

def CheckerStarted(self, command):

1424

1956

"D-Bus signal"

1425

1957

pass

1426

1958

1427

1959

# PropertyChanged - signal

1428

1960

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

1429

1961

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

1430

1962

def PropertyChanged(self, property, value):

1431

1963

"D-Bus signal"

1432

1964

pass

1433

1965

1434

1966

# GotSecret - signal

1435

1967

@dbus.service.signal(_interface)

1436

1968

def GotSecret(self):

1439

1971

server to mandos-client

1440

1972

"""

1441

1973

pass

1442

1974

1443

1975

# Rejected - signal

1444

1976

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

1445

1977

def Rejected(self, reason):

1446

1978

"D-Bus signal"

1447

1979

pass

1448

1980

1449

1981

# NeedApproval - signal

1450

1982

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

1451

1983

def NeedApproval(self, timeout, default):

1452

1984

"D-Bus signal"

1453

1985

return self.need_approval()

1454

1455

## Methods

1456

1986

1987

# Methods

1988

1457

1989

# Approve - method

1458

1990

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

1459

1991

def Approve(self, value):

1460

1992

self.approve(value)

1461

1993

1462

1994

# CheckedOK - method

1463

1995

@dbus.service.method(_interface)

1464

1996

def CheckedOK(self):

1465

1997

self.checked_ok()

1466

1998

1467

1999

# Enable - method

2000

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

1468

2001

@dbus.service.method(_interface)

1469

2002

def Enable(self):

1470

2003

"D-Bus method"

1471

2004

self.enable()

1472

2005

1473

2006

# StartChecker - method

2007

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

1474

2008

@dbus.service.method(_interface)

1475

2009

def StartChecker(self):

1476

2010

"D-Bus method"

1477

2011

self.start_checker()

1478

2012

1479

2013

# Disable - method

2014

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

1480

2015

@dbus.service.method(_interface)

1481

2016

def Disable(self):

1482

2017

"D-Bus method"

1483

2018

self.disable()

1484

2019

1485

2020

# StopChecker - method

2021

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

1486

2022

@dbus.service.method(_interface)

1487

2023

def StopChecker(self):

1488

2024

self.stop_checker()

1489

1490

## Properties

1491

2025

2026

# Properties

2027

1492

2028

# ApprovalPending - property

1493

2029

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

1494

2030

def ApprovalPending_dbus_property(self):

1495

2031

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

1496

2032

1497

2033

# ApprovedByDefault - property

1498

2034

@dbus_service_property(_interface,

1499

2035

signature="b",

1502

2038

if value is None: # get

1503

2039

return dbus.Boolean(self.approved_by_default)

1504

2040

self.approved_by_default = bool(value)

1505

2041

1506

2042

# ApprovalDelay - property

1507

2043

@dbus_service_property(_interface,

1508

2044

signature="t",

1512

2048

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

1513

2049

* 1000)

1514

2050

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

1515

2051

1516

2052

# ApprovalDuration - property

1517

2053

@dbus_service_property(_interface,

1518

2054

signature="t",

1522

2058

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

1523

2059

* 1000)

1524

2060

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

1525

2061

1526

2062

# Name - property

2063

@dbus_annotations(

2064

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

1527

2065

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

1528

2066

def Name_dbus_property(self):

1529

2067

return dbus.String(self.name)

1530

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

1531

2076

# Fingerprint - property

2077

@dbus_annotations(

2078

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

1532

2079

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

1533

2080

def Fingerprint_dbus_property(self):

1534

2081

return dbus.String(self.fingerprint)

1535

2082

1536

2083

# Host - property

1537

2084

@dbus_service_property(_interface,

1538

2085

signature="s",

1541

2088

if value is None: # get

1542

2089

return dbus.String(self.host)

1543

2090

self.host = str(value)

1544

2091

1545

2092

# Created - property

2093

@dbus_annotations(

2094

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

1546

2095

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

1547

2096

def Created_dbus_property(self):

1548

2097

return datetime_to_dbus(self.created)

1549

2098

1550

2099

# LastEnabled - property

1551

2100

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

1552

2101

def LastEnabled_dbus_property(self):

1553

2102

return datetime_to_dbus(self.last_enabled)

1554

2103

1555

2104

# Enabled - property

1556

2105

@dbus_service_property(_interface,

1557

2106

signature="b",

1563

2112

self.enable()

1564

2113

else:

1565

2114

self.disable()

1566

2115

1567

2116

# LastCheckedOK - property

1568

2117

@dbus_service_property(_interface,

1569

2118

signature="s",

1573

2122

self.checked_ok()

1574

2123

return

1575

2124

return datetime_to_dbus(self.last_checked_ok)

1576

2125

1577

2126

# LastCheckerStatus - property

1578

2127

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

1579

2128

def LastCheckerStatus_dbus_property(self):

1580

2129

return dbus.Int16(self.last_checker_status)

1581

2130

1582

2131

# Expires - property

1583

2132

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

1584

2133

def Expires_dbus_property(self):

1585

2134

return datetime_to_dbus(self.expires)

1586

2135

1587

2136

# LastApprovalRequest - property

1588

2137

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

1589

2138

def LastApprovalRequest_dbus_property(self):

1590

2139

return datetime_to_dbus(self.last_approval_request)

1591

2140

1592

2141

# Timeout - property

1593

2142

@dbus_service_property(_interface,

1594

2143

signature="t",

1609

2158

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

1610

2159

is None):

1611

2160

return

1612

gobject.source_remove(self.disable_initiator_tag)

1613

self.disable_initiator_tag = gobject.timeout_add(

2161

GLib.source_remove(self.disable_initiator_tag)

2162

self.disable_initiator_tag = GLib.timeout_add(

1614

2163

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

1615

2164

self.disable)

1616

2165

1617

2166

# ExtendedTimeout - property

1618

2167

@dbus_service_property(_interface,

1619

2168

signature="t",

1623

2172

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

1624

2173

* 1000)

1625

2174

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

1626

2175

1627

2176

# Interval - property

1628

2177

@dbus_service_property(_interface,

1629

2178

signature="t",

1636

2185

return

1637

2186

if self.enabled:

1638

2187

# Reschedule checker run

1639

gobject.source_remove(self.checker_initiator_tag)

1640

self.checker_initiator_tag = gobject.timeout_add(

2188

GLib.source_remove(self.checker_initiator_tag)

2189

self.checker_initiator_tag = GLib.timeout_add(

1641

2190

value, self.start_checker)

1642

self.start_checker() # Start one now, too

1643

2191

self.start_checker() # Start one now, too

2192

1644

2193

# Checker - property

1645

2194

@dbus_service_property(_interface,

1646

2195

signature="s",

1649

2198

if value is None: # get

1650

2199

return dbus.String(self.checker_command)

1651

2200

self.checker_command = str(value)

1652

2201

1653

2202

# CheckerRunning - property

1654

2203

@dbus_service_property(_interface,

1655

2204

signature="b",

1661

2210

self.start_checker()

1662

2211

else:

1663

2212

self.stop_checker()

1664

2213

1665

2214

# ObjectPath - property

2215

@dbus_annotations(

2216

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

2217

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

1666

2218

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

1667

2219

def ObjectPath_dbus_property(self):

1668

return self.dbus_object_path # is already a dbus.ObjectPath

1669

2220

return self.dbus_object_path # is already a dbus.ObjectPath

2221

1670

2222

# Secret = property

2223

@dbus_annotations(

2224

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

2225

"invalidates"})

1671

2226

@dbus_service_property(_interface,

1672

2227

signature="ay",

1673

2228

access="write",

1674

2229

byte_arrays=True)

1675

2230

def Secret_dbus_property(self, value):

1676

2231

self.secret = bytes(value)

1677

2232

1678

2233

del _interface

1679

2234

1680

2235

1681

class ProxyClient(object):

1682

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

2236

class ProxyClient:

2237

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

1683

2238

self._pipe = child_pipe

1684

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

2239

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

1685

2240

if not self._pipe.recv():

1686

raise KeyError(fpr)

1687

2241

raise KeyError(key_id or fpr)

2242

1688

2243

def __getattribute__(self, name):

1689

2244

if name == '_pipe':

1690

2245

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

1693

2248

if data[0] == 'data':

1694

2249

return data[1]

1695

2250

if data[0] == 'function':

1696

2251

1697

2252

def func(*args, **kwargs):

1698

2253

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

1699

2254

return self._pipe.recv()[1]

1700

2255

1701

2256

return func

1702

2257

1703

2258

def __setattr__(self, name, value):

1704

2259

if name == '_pipe':

1705

2260

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

1708

2263

1709

2264

class ClientHandler(socketserver.BaseRequestHandler, object):

1710

2265

"""A class to handle client connections.

1711

2266

1712

2267

Instantiated once for each connection to handle it.

1713

2268

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

1714

2269

1715

2270

def handle(self):

1716

2271

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

1717

2272

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

1718

2273

str(self.client_address))

1719

2274

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

1720

2275

self.server.child_pipe.fileno())

1721

1722

session = gnutls.connection.ClientSession(

1723

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

1724

1725

# Note: gnutls.connection.X509Credentials is really a

1726

# generic GnuTLS certificate credentials object so long as

1727

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

1728

# here despite using OpenPGP certificates.

1729

1730

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

1731

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

1732

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

1733

# "+DHE-DSS"))

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

1734

2283

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

1735

2284

priority = self.server.gnutls_priority

1736

2285

if priority is None:

1737

2286

priority = "NORMAL"

1738

gnutls.library.functions.gnutls_priority_set_direct(

1739

session._c_object, priority, None)

1740

2287

gnutls.priority_set_direct(session._c_object,

2288

priority.encode("utf-8"),

2289

None)

2290

1741

2291

# Start communication using the Mandos protocol

1742

2292

# Get protocol number

1743

2293

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

1748

2298

except (ValueError, IndexError, RuntimeError) as error:

1749

2299

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

1750

2300

return

1751

2301

1752

2302

# Start GnuTLS connection

1753

2303

try:

1754

2304

session.handshake()

1755

except gnutls.errors.GNUTLSError as error:

2305

except gnutls.Error as error:

1756

2306

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

1757

2307

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

1758

2308

# established. Just abandon the request.

1759

2309

return

1760

2310

logger.debug("Handshake succeeded")

1761

2311

1762

2312

approval_required = False

1763

2313

try:

1764

try:

1765

fpr = self.fingerprint(

1766

self.peer_certificate(session))

1767

except (TypeError,

1768

gnutls.errors.GNUTLSError) as error:

1769

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

1770

return

1771

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

1772

1773

try:

1774

client = ProxyClient(child_pipe, fpr,

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,

1775

2336

self.client_address)

1776

2337

except KeyError:

1777

2338

return

1778

2339

1779

2340

if client.approval_delay:

1780

2341

delay = client.approval_delay

1781

2342

client.approvals_pending += 1

1782

2343

approval_required = True

1783

2344

1784

2345

while True:

1785

2346

if not client.enabled:

1786

2347

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

1789

2350

# Emit D-Bus signal

1790

2351

client.Rejected("Disabled")

1791

2352

return

1792

2353

1793

2354

if client.approved or not client.approval_delay:

1794

#We are approved or approval is disabled

2355

# We are approved or approval is disabled

1795

2356

break

1796

2357

elif client.approved is None:

1797

2358

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

1808

2369

# Emit D-Bus signal

1809

2370

client.Rejected("Denied")

1810

2371

return

1811

1812

#wait until timeout or approved

2372

2373

# wait until timeout or approved

1813

2374

time = datetime.datetime.now()

1814

2375

client.changedstate.acquire()

1815

2376

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

1828

2389

break

1829

2390

else:

1830

2391

delay -= time2 - time

1831

1832

sent_size = 0

1833

while sent_size < len(client.secret):

1834

try:

1835

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

1836

except gnutls.errors.GNUTLSError as error:

1837

logger.warning("gnutls send failed",

1838

exc_info=error)

1839

return

1840

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

1841

len(client.secret) - (sent_size

1842

+ sent))

1843

sent_size += sent

1844

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

1845

2400

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

1846

2401

# bump the timeout using extended_timeout

1847

2402

client.bump_timeout(client.extended_timeout)

1848

2403

if self.server.use_dbus:

1849

2404

# Emit D-Bus signal

1850

2405

client.GotSecret()

1851

2406

1852

2407

finally:

1853

2408

if approval_required:

1854

2409

client.approvals_pending -= 1

1855

2410

try:

1856

2411

session.bye()

1857

except gnutls.errors.GNUTLSError as error:

2412

except gnutls.Error as error:

1858

2413

logger.warning("GnuTLS bye failed",

1859

2414

exc_info=error)

1860

2415

1861

2416

@staticmethod

1862

2417

def peer_certificate(session):

1863

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

1864

# If not an OpenPGP certificate...

1865

if (gnutls.library.functions.gnutls_certificate_type_get(

1866

session._c_object)

1867

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1868

# ...do the normal thing

1869

return session.peer_certificate

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

1870

2434

list_size = ctypes.c_uint(1)

1871

cert_list = (gnutls.library.functions

1872

.gnutls_certificate_get_peers

2435

cert_list = (gnutls.certificate_get_peers

1873

2436

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

1874

2437

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

1875

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

1876

" certificate")

2438

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

1877

2439

if list_size.value == 0:

1878

2440

return None

1879

2441

cert = cert_list[0]

1880

2442

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

1881

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

1882

2478

@staticmethod

1883

2479

def fingerprint(openpgp):

1884

2480

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1885

2481

# New GnuTLS "datum" with the OpenPGP public key

1886

datum = gnutls.library.types.gnutls_datum_t(

2482

datum = gnutls.datum_t(

1887

2483

ctypes.cast(ctypes.c_char_p(openpgp),

1888

2484

ctypes.POINTER(ctypes.c_ubyte)),

1889

2485

ctypes.c_uint(len(openpgp)))

1890

2486

# New empty GnuTLS certificate

1891

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1892

gnutls.library.functions.gnutls_openpgp_crt_init(

1893

ctypes.byref(crt))

2487

crt = gnutls.openpgp_crt_t()

2488

gnutls.openpgp_crt_init(ctypes.byref(crt))

1894

2489

# Import the OpenPGP public key into the certificate

1895

gnutls.library.functions.gnutls_openpgp_crt_import(

1896

crt, ctypes.byref(datum),

1897

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2490

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

2491

gnutls.OPENPGP_FMT_RAW)

1898

2492

# Verify the self signature in the key

1899

2493

crtverify = ctypes.c_uint()

1900

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1901

crt, 0, ctypes.byref(crtverify))

2494

gnutls.openpgp_crt_verify_self(crt, 0,

2495

ctypes.byref(crtverify))

1902

2496

if crtverify.value != 0:

1903

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1904

raise gnutls.errors.CertificateSecurityError(

1905

"Verify failed")

2497

gnutls.openpgp_crt_deinit(crt)

2498

raise gnutls.CertificateSecurityError(code

2499

=crtverify.value)

1906

2500

# New buffer for the fingerprint

1907

2501

buf = ctypes.create_string_buffer(20)

1908

2502

buf_len = ctypes.c_size_t()

1909

2503

# Get the fingerprint from the certificate into the buffer

1910

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1911

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

2504

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

2505

ctypes.byref(buf_len))

1912

2506

# Deinit the certificate

1913

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2507

gnutls.openpgp_crt_deinit(crt)

1914

2508

# Convert the buffer to a Python bytestring

1915

2509

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

1916

2510

# Convert the bytestring to hexadecimal notation

1918

2512

return hex_fpr

1919

2513

1920

2514

1921

class MultiprocessingMixIn(object):

2515

class MultiprocessingMixIn:

1922

2516

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

1923

2517

1924

2518

def sub_process_main(self, request, address):

1925

2519

try:

1926

2520

self.finish_request(request, address)

1927

2521

except Exception:

1928

2522

self.handle_error(request, address)

1929

2523

self.close_request(request)

1930

2524

1931

2525

def process_request(self, request, address):

1932

2526

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

1933

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

1934

args = (request, address))

2527

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

2528

args=(request, address))

1935

2529

proc.start()

1936

2530

return proc

1937

2531

1938

2532

1939

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2533

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1940

2534

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

1941

2535

1942

2536

def process_request(self, request, client_address):

1943

2537

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

1944

2538

1945

2539

This function creates a new pipe in self.pipe

1946

2540

"""

1947

2541

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1948

2542

1949

2543

proc = MultiprocessingMixIn.process_request(self, request,

1950

2544

client_address)

1951

2545

self.child_pipe.close()

1952

2546

self.add_pipe(parent_pipe, proc)

1953

2547

1954

2548

def add_pipe(self, parent_pipe, proc):

1955

2549

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

1956

2550

raise NotImplementedError()

1957

2551

1958

2552

1959

2553

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1960

socketserver.TCPServer, object):

2554

socketserver.TCPServer):

1961

2555

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

1962

2556

1963

2557

Attributes:

1964

2558

enabled: Boolean; whether this server is activated yet

1965

2559

interface: None or a network interface name (string)

1966

2560

use_ipv6: Boolean; to use IPv6 or not

1967

2561

"""

1968

2562

1969

2563

def __init__(self, server_address, RequestHandlerClass,

1970

2564

interface=None,

1971

2565

use_ipv6=True,

1981

2575

self.socketfd = socketfd

1982

2576

# Save the original socket.socket() function

1983

2577

self.socket_socket = socket.socket

2578

1984

2579

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

1985

#

2580

#

1986

2581

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

1987

2582

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

1988

2583

# patching socket.socket.)

1989

#

2584

#

1990

2585

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

1991

2586

@functools.wraps(socket.socket)

1992

2587

def socket_wrapper(*args, **kwargs):

2004

2599

# socket_wrapper(), if socketfd was set.

2005

2600

socketserver.TCPServer.__init__(self, server_address,

2006

2601

RequestHandlerClass)

2007

2602

2008

2603

def server_bind(self):

2009

2604

"""This overrides the normal server_bind() function

2010

2605

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

2011

2606

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

2607

global SO_BINDTODEVICE

2012

2608

if self.interface is not None:

2013

2609

if SO_BINDTODEVICE is None:

2014

logger.error("SO_BINDTODEVICE does not exist;"

2015

" cannot bind to interface %s",

2016

self.interface)

2017

else:

2018

try:

2019

self.socket.setsockopt(

2020

socket.SOL_SOCKET, SO_BINDTODEVICE,

2021

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

2022

except socket.error as error:

2023

if error.errno == errno.EPERM:

2024

logger.error("No permission to bind to"

2025

" interface %s", self.interface)

2026

elif error.errno == errno.ENOPROTOOPT:

2027

logger.error("SO_BINDTODEVICE not available;"

2028

" cannot bind to interface %s",

2029

self.interface)

2030

elif error.errno == errno.ENODEV:

2031

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

2032

" cannot bind", self.interface)

2033

else:

2034

raise

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

2035

2631

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

2036

2632

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

2633

if self.server_address[1]:

2634

self.allow_reuse_address = True

2037

2635

if not self.server_address[0]:

2038

2636

if self.address_family == socket.AF_INET6:

2039

any_address = "::" # in6addr_any

2637

any_address = "::" # in6addr_any

2040

2638

else:

2041

any_address = "0.0.0.0" # INADDR_ANY

2639

any_address = "0.0.0.0" # INADDR_ANY

2042

2640

self.server_address = (any_address,

2043

2641

self.server_address[1])

2044

2642

elif not self.server_address[1]:

2054

2652

2055

2653

class MandosServer(IPv6_TCPServer):

2056

2654

"""Mandos server.

2057

2655

2058

2656

Attributes:

2059

2657

clients: set of Client objects

2060

2658

gnutls_priority GnuTLS priority string

2061

2659

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

2062

2063

Assumes a gobject.MainLoop event loop.

2660

2661

Assumes a GLib.MainLoop event loop.

2064

2662

"""

2065

2663

2066

2664

def __init__(self, server_address, RequestHandlerClass,

2067

2665

interface=None,

2068

2666

use_ipv6=True,

2078

2676

self.gnutls_priority = gnutls_priority

2079

2677

IPv6_TCPServer.__init__(self, server_address,

2080

2678

RequestHandlerClass,

2081

interface = interface,

2082

use_ipv6 = use_ipv6,

2083

socketfd = socketfd)

2084

2679

interface=interface,

2680

use_ipv6=use_ipv6,

2681

socketfd=socketfd)

2682

2085

2683

def server_activate(self):

2086

2684

if self.enabled:

2087

2685

return socketserver.TCPServer.server_activate(self)

2088

2686

2089

2687

def enable(self):

2090

2688

self.enabled = True

2091

2689

2092

2690

def add_pipe(self, parent_pipe, proc):

2093

2691

# Call "handle_ipc" for both data and EOF events

2094

gobject.io_add_watch(

2095

parent_pipe.fileno(),

2096

gobject.IO_IN | gobject.IO_HUP,

2692

GLib.io_add_watch(

2693

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

2694

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

2097

2695

functools.partial(self.handle_ipc,

2098

parent_pipe = parent_pipe,

2099

proc = proc))

2100

2696

parent_pipe=parent_pipe,

2697

proc=proc))

2698

2101

2699

def handle_ipc(self, source, condition,

2102

2700

parent_pipe=None,

2103

proc = None,

2701

proc=None,

2104

2702

client_object=None):

2105

2703

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

2106

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

2704

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

2107

2705

# Wait for other process to exit

2108

2706

proc.join()

2109

2707

return False

2110

2708

2111

2709

# Read a request from the child

2112

2710

request = parent_pipe.recv()

2113

2711

command = request[0]

2114

2712

2115

2713

if command == 'init':

2116

fpr = request[1]

2117

address = request[2]

2118

2119

for c in self.clients.itervalues():

2120

if c.fingerprint == fpr:

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:

2121

2725

client = c

2122

2726

break

2123

2727

else:

2124

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

2125

"dress: %s", fpr, address)

2728

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

2729

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

2126

2730

if self.use_dbus:

2127

2731

# Emit D-Bus signal

2128

mandos_dbus_service.ClientNotFound(fpr,

2732

mandos_dbus_service.ClientNotFound(key_id or fpr,

2129

2733

address[0])

2130

2734

parent_pipe.send(False)

2131

2735

return False

2132

2133

gobject.io_add_watch(

2134

parent_pipe.fileno(),

2135

gobject.IO_IN | gobject.IO_HUP,

2736

2737

GLib.io_add_watch(

2738

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

2739

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

2136

2740

functools.partial(self.handle_ipc,

2137

parent_pipe = parent_pipe,

2138

proc = proc,

2139

client_object = client))

2741

parent_pipe=parent_pipe,

2742

proc=proc,

2743

client_object=client))

2140

2744

parent_pipe.send(True)

2141

2745

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

2142

2746

# same fileno

2145

2749

funcname = request[1]

2146

2750

args = request[2]

2147

2751

kwargs = request[3]

2148

2752

2149

2753

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

2150

2754

funcname)(*args,

2151

2755

**kwargs)))

2152

2756

2153

2757

if command == 'getattr':

2154

2758

attrname = request[1]

2155

2759

if isinstance(client_object.__getattribute__(attrname),

2156

collections.Callable):

2760

collections.abc.Callable):

2157

2761

parent_pipe.send(('function', ))

2158

2762

else:

2159

2763

parent_pipe.send((

2160

2764

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

2161

2765

2162

2766

if command == 'setattr':

2163

2767

attrname = request[1]

2164

2768

value = request[2]

2165

2769

setattr(client_object, attrname, value)

2166

2770

2167

2771

return True

2168

2772

2169

2773

2170

2774

def rfc3339_duration_to_delta(duration):

2171

2775

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

2172

2173

>>> rfc3339_duration_to_delta("P7D")

2174

datetime.timedelta(7)

2175

>>> rfc3339_duration_to_delta("PT60S")

2176

datetime.timedelta(0, 60)

2177

>>> rfc3339_duration_to_delta("PT60M")

2178

datetime.timedelta(0, 3600)

2179

>>> rfc3339_duration_to_delta("PT24H")

2180

datetime.timedelta(1)

2181

>>> rfc3339_duration_to_delta("P1W")

2182

datetime.timedelta(7)

2183

>>> rfc3339_duration_to_delta("PT5M30S")

2184

datetime.timedelta(0, 330)

2185

>>> rfc3339_duration_to_delta("P1DT3M20S")

2186

datetime.timedelta(1, 200)

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

2187

2791

"""

2188

2792

2189

2793

# Parsing an RFC 3339 duration with regular expressions is not

2190

2794

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

2191

2795

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

2192

2796

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

2193

2797

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

2194

2798

# avoid excessive use of external libraries.

2195

2799

2196

2800

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

2197

2801

Token = collections.namedtuple("Token", (

2198

2802

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

2231

2835

frozenset((token_year, token_month,

2232

2836

token_day, token_time,

2233

2837

token_week)))

2234

# Define starting values

2235

value = datetime.timedelta() # Value so far

2838

# Define starting values:

2839

# Value so far

2840

value = datetime.timedelta()

2236

2841

found_token = None

2237

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

2238

s = duration # String left to parse

2842

# Following valid tokens

2843

followers = frozenset((token_duration, ))

2844

# String left to parse

2845

s = duration

2239

2846

# Loop until end token is found

2240

2847

while found_token is not token_end:

2241

2848

# Search for any currently valid tokens

2265

2872

2266

2873

def string_to_delta(interval):

2267

2874

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

2268

2269

>>> string_to_delta('7d')

2270

datetime.timedelta(7)

2271

>>> string_to_delta('60s')

2272

datetime.timedelta(0, 60)

2273

>>> string_to_delta('60m')

2274

datetime.timedelta(0, 3600)

2275

>>> string_to_delta('24h')

2276

datetime.timedelta(1)

2277

>>> string_to_delta('1w')

2278

datetime.timedelta(7)

2279

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

2280

datetime.timedelta(0, 330)

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

2281

2888

"""

2282

2889

2283

2890

try:

2284

2891

return rfc3339_duration_to_delta(interval)

2285

2892

except ValueError:

2286

2893

pass

2287

2894

2288

2895

timevalue = datetime.timedelta(0)

2289

2896

for s in interval.split():

2290

2897

try:

2308

2915

return timevalue

2309

2916

2310

2917

2311

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

2918

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

2312

2919

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

2313

2920

2314

2921

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

2315

2922

if os.fork():

2316

2923

sys.exit()

2334

2941

2335

2942

2336

2943

def main():

2337

2944

2338

2945

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

2339

2946

# Parsing of options, both command line and config file

2340

2947

2341

2948

parser = argparse.ArgumentParser()

2342

2949

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

2343

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

2950

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

2344

2951

help="show version number and exit")

2345

2952

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

2346

2953

help="Bind to interface IF")

2382

2989

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

2383

2990

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

2384

2991

default=None)

2385

2992

2386

2993

options = parser.parse_args()

2387

2388

if options.check:

2389

import doctest

2390

fail_count, test_count = doctest.testmod()

2391

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

2392

2994

2393

2995

# Default values for config file for server-global settings

2394

server_defaults = { "interface": "",

2395

"address": "",

2396

"port": "",

2397

"debug": "False",

2398

"priority":

2399

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

2400

":+SIGN-DSA-SHA256",

2401

"servicename": "Mandos",

2402

"use_dbus": "True",

2403

"use_ipv6": "True",

2404

"debuglevel": "",

2405

"restore": "True",

2406

"socket": "",

2407

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

2408

"foreground": "False",

2409

"zeroconf": "True",

2410

}

2411

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

2412

3019

# Parse config file for server-global settings

2413

server_config = configparser.SafeConfigParser(server_defaults)

3020

server_config = configparser.ConfigParser(server_defaults)

2414

3021

del server_defaults

2415

3022

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

2416

# Convert the SafeConfigParser object to a dict

3023

# Convert the ConfigParser object to a dict

2417

3024

server_settings = server_config.defaults()

2418

3025

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

2419

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

3026

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

3027

"foreground", "zeroconf"):

2420

3028

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

2421

3029

option)

2422

3030

if server_settings["port"]:

2432

3040

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

2433

3041

["socket"])

2434

3042

del server_config

2435

3043

2436

3044

# Override the settings from the config file with command line

2437

3045

# options, if set.

2438

3046

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

2456

3064

if server_settings["debug"]:

2457

3065

server_settings["foreground"] = True

2458

3066

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

2459

3067

2460

3068

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

2461

3069

2462

3070

if (not server_settings["zeroconf"]

2463

3071

and not (server_settings["port"]

2464

3072

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

2465

3073

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

2466

3074

2467

3075

# For convenience

2468

3076

debug = server_settings["debug"]

2469

3077

debuglevel = server_settings["debuglevel"]

2473

3081

stored_state_file)

2474

3082

foreground = server_settings["foreground"]

2475

3083

zeroconf = server_settings["zeroconf"]

2476

3084

2477

3085

if debug:

2478

3086

initlogger(debug, logging.DEBUG)

2479

3087

else:

2482

3090

else:

2483

3091

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

2484

3092

initlogger(debug, level)

2485

3093

2486

3094

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

2487

3095

syslogger.setFormatter(

2488

3096

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

2489

3097

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

2490

3098

server_settings["servicename"])))

2491

3099

2492

3100

# Parse config file with clients

2493

client_config = configparser.SafeConfigParser(Client

2494

.client_defaults)

3101

client_config = configparser.ConfigParser(Client.client_defaults)

2495

3102

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

2496

3103

"clients.conf"))

2497

3104

2498

3105

global mandos_dbus_service

2499

3106

mandos_dbus_service = None

2500

3107

2501

3108

socketfd = None

2502

3109

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

2503

3110

socketfd = server_settings["socket"]

2519

3126

except IOError as e:

2520

3127

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

2521

3128

exc_info=e)

2522

2523

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

3129

3130

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

3131

("mandos", "mandos"),

3132

("nobody", "nogroup")):

2524

3133

try:

2525

3134

uid = pwd.getpwnam(name).pw_uid

2526

gid = pwd.getpwnam(name).pw_gid

3135

gid = pwd.getpwnam(group).pw_gid

2527

3136

break

2528

3137

except KeyError:

2529

3138

continue

2533

3142

try:

2534

3143

os.setgid(gid)

2535

3144

os.setuid(uid)

3145

if debug:

3146

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

3147

gid))

2536

3148

except OSError as error:

3149

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

3150

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

2537

3151

if error.errno != errno.EPERM:

2538

3152

raise

2539

3153

2540

3154

if debug:

2541

3155

# Enable all possible GnuTLS debugging

2542

3156

2543

3157

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

2544

3158

# - GnuTLS manual

2545

gnutls.library.functions.gnutls_global_set_log_level(11)

2546

2547

@gnutls.library.types.gnutls_log_func

3159

gnutls.global_set_log_level(11)

3160

3161

@gnutls.log_func

2548

3162

def debug_gnutls(level, string):

2549

3163

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

2550

2551

gnutls.library.functions.gnutls_global_set_log_function(

2552

debug_gnutls)

2553

3164

3165

gnutls.global_set_log_function(debug_gnutls)

3166

2554

3167

# Redirect stdin so all checkers get /dev/null

2555

3168

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

2556

3169

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

2557

3170

if null > 2:

2558

3171

os.close(null)

2559

3172

2560

3173

# Need to fork before connecting to D-Bus

2561

3174

if not foreground:

2562

3175

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

2563

3176

daemon()

2564

2565

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

2566

# need to inform gobject that threads will be used.

2567

gobject.threads_init()

2568

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

2569

3183

global main_loop

2570

3184

# From the Avahi example code

2571

3185

DBusGMainLoop(set_as_default=True)

2572

main_loop = gobject.MainLoop()

3186

main_loop = GLib.MainLoop()

2573

3187

bus = dbus.SystemBus()

2574

3188

# End of Avahi example code

2575

3189

if use_dbus:

2588

3202

if zeroconf:

2589

3203

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2590

3204

service = AvahiServiceToSyslog(

2591

name = server_settings["servicename"],

2592

servicetype = "_mandos._tcp",

2593

protocol = protocol,

2594

bus = bus)

3205

name=server_settings["servicename"],

3206

servicetype="_mandos._tcp",

3207

protocol=protocol,

3208

bus=bus)

2595

3209

if server_settings["interface"]:

2596

3210

service.interface = if_nametoindex(

2597

3211

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

2598

3212

2599

3213

global multiprocessing_manager

2600

3214

multiprocessing_manager = multiprocessing.Manager()

2601

3215

2602

3216

client_class = Client

2603

3217

if use_dbus:

2604

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

2605

3218

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

3219

2606

3220

client_settings = Client.config_parser(client_config)

2607

3221

old_client_settings = {}

2608

3222

clients_data = {}

2609

3223

2610

3224

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

2611

3225

global wnull

2612

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

3226

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

2613

3227

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

2614

3228

# mode

2615

3229

if debug or not foreground:

2616

3230

wnull.close()

2617

3231

2618

3232

# Get client data and settings from last running state.

2619

3233

if server_settings["restore"]:

2620

3234

try:

2621

3235

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

2622

clients_data, old_client_settings = pickle.load(

2623

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

2624

3286

os.remove(stored_state_path)

2625

3287

except IOError as e:

2626

3288

if e.errno == errno.ENOENT:

2634

3296

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

2635

3297

"EOFError:",

2636

3298

exc_info=e)

2637

3299

2638

3300

with PGPEngine() as pgp:

2639

3301

for client_name, client in clients_data.items():

2640

3302

# Skip removed clients

2641

3303

if client_name not in client_settings:

2642

3304

continue

2643

3305

2644

3306

# Decide which value to use after restoring saved state.

2645

3307

# We have three different values: Old config file,

2646

3308

# new config file, and saved state.

2657

3319

client[name] = value

2658

3320

except KeyError:

2659

3321

pass

2660

3322

2661

3323

# Clients who has passed its expire date can still be

2662

3324

# enabled if its last checker was successful. A Client

2663

3325

# whose checker succeeded before we stored its state is

2696

3358

client_name))

2697

3359

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

2698

3360

["secret"])

2699

3361

2700

3362

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

2701

3363

for client_name in (set(old_client_settings)

2702

3364

- set(client_settings)):

2704

3366

for client_name in (set(client_settings)

2705

3367

- set(old_client_settings)):

2706

3368

clients_data[client_name] = client_settings[client_name]

2707

3369

2708

3370

# Create all client objects

2709

3371

for client_name, client in clients_data.items():

2710

3372

tcp_server.clients[client_name] = client_class(

2711

name = client_name,

2712

settings = client,

2713

server_settings = server_settings)

2714

3373

name=client_name,

3374

settings=client,

3375

server_settings=server_settings)

3376

2715

3377

if not tcp_server.clients:

2716

3378

logger.warning("No clients defined")

2717

3379

2718

3380

if not foreground:

2719

3381

if pidfile is not None:

2720

3382

pid = os.getpid()

2726

3388

pidfilename, pid)

2727

3389

del pidfile

2728

3390

del pidfilename

2729

2730

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

2731

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

2732

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

2733

3396

if use_dbus:

2734

3397

2735

3398

@alternate_dbus_interfaces(

2736

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

2737

class MandosDBusService(DBusObjectWithProperties):

3399

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

3400

class MandosDBusService(DBusObjectWithObjectManager):

2738

3401

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

2739

3402

2740

3403

def __init__(self):

2741

3404

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

2742

3405

2743

3406

_interface = "se.recompile.Mandos"

2744

2745

@dbus_interface_annotations(_interface)

2746

def _foo(self):

2747

return {

2748

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

2749

"false" }

2750

3407

2751

3408

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

2752

3409

def ClientAdded(self, objpath):

2753

3410

"D-Bus signal"

2754

3411

pass

2755

3412

2756

3413

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

2757

def ClientNotFound(self, fingerprint, address):

3414

def ClientNotFound(self, key_id, address):

2758

3415

"D-Bus signal"

2759

3416

pass

2760

3417

3418

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

3419

"true"})

2761

3420

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

2762

3421

def ClientRemoved(self, objpath, name):

2763

3422

"D-Bus signal"

2764

3423

pass

2765

3424

3425

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

3426

"true"})

2766

3427

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

2767

3428

def GetAllClients(self):

2768

3429

"D-Bus method"

2769

3430

return dbus.Array(c.dbus_object_path for c in

2770

tcp_server.clients.itervalues())

2771

3431

tcp_server.clients.values())

3432

3433

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

3434

"true"})

2772

3435

@dbus.service.method(_interface,

2773

3436

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

2774

3437

def GetAllClientsWithProperties(self):

2775

3438

"D-Bus method"

2776

3439

return dbus.Dictionary(

2777

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

2778

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

3440

{c.dbus_object_path: c.GetAll(

3441

"se.recompile.Mandos.Client")

3442

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

2779

3443

signature="oa{sv}")

2780

3444

2781

3445

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

2782

3446

def RemoveClient(self, object_path):

2783

3447

"D-Bus method"

2784

for c in tcp_server.clients.itervalues():

3448

for c in tcp_server.clients.values():

2785

3449

if c.dbus_object_path == object_path:

2786

3450

del tcp_server.clients[c.name]

2787

3451

c.remove_from_connection()

2788

# Don't signal anything except ClientRemoved

3452

# Don't signal the disabling

2789

3453

c.disable(quiet=True)

2790

# Emit D-Bus signal

2791

self.ClientRemoved(object_path, c.name)

3454

# Emit D-Bus signal for removal

3455

self.client_removed_signal(c)

2792

3456

return

2793

3457

raise KeyError(object_path)

2794

3458

2795

3459

del _interface

2796

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

2797

3497

mandos_dbus_service = MandosDBusService()

2798

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

2799

3504

def cleanup():

2800

3505

"Cleanup function; run on exit"

2801

3506

if zeroconf:

2802

3507

service.cleanup()

2803

2804

multiprocessing.active_children()

2805

wnull.close()

3508

3509

mp.active_children()

3510

wn.close()

2806

3511

if not (tcp_server.clients or client_settings):

2807

3512

return

2808

3513

2809

3514

# Store client before exiting. Secrets are encrypted with key

2810

3515

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

2811

3516

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

2812

3517

clients = {}

2813

3518

with PGPEngine() as pgp:

2814

for client in tcp_server.clients.itervalues():

3519

for client in tcp_server.clients.values():

2815

3520

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

2816

3521

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

2817

3522

key)

2818

3523

client_dict = {}

2819

3524

2820

3525

# A list of attributes that can not be pickled

2821

3526

# + secret.

2822

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

2823

"checker", "server_settings" }

3527

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

3528

"checker", "server_settings"}

2824

3529

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

2825

3530

.Object):

2826

3531

exclude.add(name)

2827

3532

2828

3533

client_dict["encrypted_secret"] = (client

2829

3534

.encrypted_secret)

2830

3535

for attr in client.client_structure:

2831

3536

if attr not in exclude:

2832

3537

client_dict[attr] = getattr(client, attr)

2833

3538

2834

3539

clients[client.name] = client_dict

2835

3540

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

2836

3541

2837

3542

try:

2838

3543

with tempfile.NamedTemporaryFile(

2839

3544

mode='wb',

2841

3546

prefix='clients-',

2842

3547

dir=os.path.dirname(stored_state_path),

2843

3548

delete=False) as stored_state:

2844

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

3549

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

3550

protocol=2)

2845

3551

tempname = stored_state.name

2846

3552

os.rename(tempname, stored_state_path)

2847

3553

except (IOError, OSError) as e:

2857

3563

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

2858

3564

exc_info=e)

2859

3565

raise

2860

3566

2861

3567

# Delete all clients, and settings from config

2862

3568

while tcp_server.clients:

2863

3569

name, client = tcp_server.clients.popitem()

2864

3570

if use_dbus:

2865

3571

client.remove_from_connection()

2866

# Don't signal anything except ClientRemoved

3572

# Don't signal the disabling

2867

3573

client.disable(quiet=True)

3574

# Emit D-Bus signal for removal

2868

3575

if use_dbus:

2869

# Emit D-Bus signal

2870

mandos_dbus_service.ClientRemoved(

2871

client.dbus_object_path, client.name)

3576

mandos_dbus_service.client_removed_signal(client)

2872

3577

client_settings.clear()

2873

3578

2874

3579

atexit.register(cleanup)

2875

2876

for client in tcp_server.clients.itervalues():

3580

3581

for client in tcp_server.clients.values():

2877

3582

if use_dbus:

2878

# Emit D-Bus signal

2879

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3583

# Emit D-Bus signal for adding

3584

mandos_dbus_service.client_added_signal(client)

2880

3585

# Need to initiate checking of clients

2881

3586

if client.enabled:

2882

3587

client.init_checker()

2883

3588

2884

3589

tcp_server.enable()

2885

3590

tcp_server.server_activate()

2886

3591

2887

3592

# Find out what port we got

2888

3593

if zeroconf:

2889

3594

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

2894

3599

else: # IPv4

2895

3600

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

2896

3601

*tcp_server.socket.getsockname())

2897

2898

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

2899

3602

3603

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

3604

2900

3605

try:

2901

3606

if zeroconf:

2902

3607

# From the Avahi example code

2907

3612

cleanup()

2908

3613

sys.exit(1)

2909

3614

# End of Avahi example code

2910

2911

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

2912

lambda *args, **kwargs:

2913

(tcp_server.handle_request

2914

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

2915

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

2916

3622

logger.debug("Starting main loop")

2917

3623

main_loop.run()

2918

3624

except AvahiError as error:

2927

3633

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

2928

3634

cleanup()

2929

3635

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

2930

3652

2931

3653

if __name__ == '__main__':

2932

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