/mandos/release : revision 237.7.303

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

39

try:

44

40

import SocketServer as socketserver

48

44

import argparse

49

45

import datetime

50

46

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

51

53

try:

52

54

import ConfigParser as configparser

53

55

except ImportError:

80

82

81

83

import dbus

82

84

import dbus.service

83

import gi

84

from gi.repository import GLib

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

89

import avahi

85

90

from dbus.mainloop.glib import DBusGMainLoop

86

91

import ctypes

87

92

import ctypes.util

88

93

import xml.dom.minidom

89

94

import inspect

90

95

91

if sys.version_info.major == 2:

92

__metaclass__ = type

93

94

# Try to find the value of SO_BINDTODEVICE:

95

96

try:

96

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

97

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

98

97

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

99

98

except AttributeError:

100

99

try:

101

# This is where SO_BINDTODEVICE was up to and including Python

102

# 2.6, and also 3.2:

103

100

from IN import SO_BINDTODEVICE

104

101

except ImportError:

105

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

106

# Try running the C preprocessor:

107

try:

108

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

109

"/dev/stdin"],

110

stdin=subprocess.PIPE,

111

stdout=subprocess.PIPE)

112

stdout = cc.communicate(

113

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

114

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

115

except (OSError, ValueError, IndexError):

116

# No value found

117

SO_BINDTODEVICE = None

102

SO_BINDTODEVICE = None

118

103

119

104

if sys.version_info.major == 2:

120

105

str = unicode

121

106

122

if sys.version_info < (3, 2):

123

configparser.Configparser = configparser.SafeConfigParser

124

125

version = "1.8.7"

107

version = "1.6.9"

126

108

stored_state_file = "clients.pickle"

127

109

128

110

logger = logging.getLogger()

132

114

if_nametoindex = ctypes.cdll.LoadLibrary(

133

115

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

134

116

except (OSError, AttributeError):

135

117

136

118

def if_nametoindex(interface):

137

119

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

138

120

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

143

125

return interface_index

144

126

145

127

146

def copy_function(func):

147

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

148

if sys.version_info.major == 2:

149

return types.FunctionType(func.func_code,

150

func.func_globals,

151

func.func_name,

152

func.func_defaults,

153

func.func_closure)

154

else:

155

return types.FunctionType(func.__code__,

156

func.__globals__,

157

func.__name__,

158

func.__defaults__,

159

func.__closure__)

160

161

162

128

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

163

129

"""init logger and add loglevel"""

164

130

165

131

global syslogger

166

132

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

169

135

syslogger.setFormatter(logging.Formatter

170

136

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

171

137

' %(message)s'))

172

138

logger.addHandler(syslogger)

173

139

174

140

if debug:

175

141

console = logging.StreamHandler()

176

142

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

186

152

pass

187

153

188

154

189

class PGPEngine:

155

class PGPEngine(object):

190

156

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

191

157

192

158

def __init__(self):

193

159

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

194

self.gpg = "gpg"

195

try:

196

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

197

for line in output.splitlines():

198

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

199

if name == "gpg":

200

self.gpg = path

201

break

202

except OSError as e:

203

if e.errno != errno.ENOENT:

204

raise

205

160

self.gnupgargs = ['--batch',

206

'--homedir', self.tempdir,

161

'--home', self.tempdir,

207

162

'--force-mdc',

208

'--quiet']

209

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

210

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

211

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

212

163

'--quiet',

164

'--no-use-agent']

165

213

166

def __enter__(self):

214

167

return self

215

168

216

169

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

217

170

self._cleanup()

218

171

return False

219

172

220

173

def __del__(self):

221

174

self._cleanup()

222

175

223

176

def _cleanup(self):

224

177

if self.tempdir is not None:

225

178

# Delete contents of tempdir

226

179

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

227

topdown=False):

180

topdown = False):

228

181

for filename in files:

229

182

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

230

183

for dirname in dirs:

232

185

# Remove tempdir

233

186

os.rmdir(self.tempdir)

234

187

self.tempdir = None

235

188

236

189

def password_encode(self, password):

237

190

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

238

191

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

243

196

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

244

197

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

245

198

return encoded

246

199

247

200

def encrypt(self, data, password):

248

201

passphrase = self.password_encode(password)

249

202

with tempfile.NamedTemporaryFile(

250

203

dir=self.tempdir) as passfile:

251

204

passfile.write(passphrase)

252

205

passfile.flush()

253

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

206

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

254

207

'--passphrase-file',

255

208

passfile.name]

256

209

+ self.gnupgargs,

257

stdin=subprocess.PIPE,

258

stdout=subprocess.PIPE,

259

stderr=subprocess.PIPE)

260

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

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

261

214

if proc.returncode != 0:

262

215

raise PGPError(err)

263

216

return ciphertext

264

217

265

218

def decrypt(self, data, password):

266

219

passphrase = self.password_encode(password)

267

220

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

221

dir = self.tempdir) as passfile:

269

222

passfile.write(passphrase)

270

223

passfile.flush()

271

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

224

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

272

225

'--passphrase-file',

273

226

passfile.name]

274

227

+ self.gnupgargs,

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

279

232

if proc.returncode != 0:

280

233

raise PGPError(err)

281

234

return decrypted_plaintext

282

235

283

236

284

# Pretend that we have an Avahi module

285

class avahi:

286

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

287

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

288

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

289

PROTO_INET = 0 # avahi-common/address.h

290

PROTO_INET6 = 1 # avahi-common/address.h

291

DBUS_NAME = "org.freedesktop.Avahi"

292

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

293

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

294

DBUS_PATH_SERVER = "/"

295

296

@staticmethod

297

def string_array_to_txt_array(t):

298

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

299

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

300

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

301

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

302

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

303

SERVER_INVALID = 0 # avahi-common/defs.h

304

SERVER_REGISTERING = 1 # avahi-common/defs.h

305

SERVER_RUNNING = 2 # avahi-common/defs.h

306

SERVER_COLLISION = 3 # avahi-common/defs.h

307

SERVER_FAILURE = 4 # avahi-common/defs.h

308

309

310

237

class AvahiError(Exception):

311

238

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

312

239

self.value = value

322

249

pass

323

250

324

251

325

class AvahiService:

252

class AvahiService(object):

326

253

"""An Avahi (Zeroconf) service.

327

254

328

255

Attributes:

329

256

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

330

257

Used to optionally bind to the specified interface.

342

269

server: D-Bus Server

343

270

bus: dbus.SystemBus()

344

271

"""

345

272

346

273

def __init__(self,

347

interface=avahi.IF_UNSPEC,

348

name=None,

349

servicetype=None,

350

port=None,

351

TXT=None,

352

domain="",

353

host="",

354

max_renames=32768,

355

protocol=avahi.PROTO_UNSPEC,

356

bus=None):

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

357

284

self.interface = interface

358

285

self.name = name

359

286

self.type = servicetype

368

295

self.server = None

369

296

self.bus = bus

370

297

self.entry_group_state_changed_match = None

371

298

372

299

def rename(self, remove=True):

373

300

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

374

301

if self.rename_count >= self.max_renames:

394

321

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

395

322

self.cleanup()

396

323

os._exit(1)

397

324

398

325

def remove(self):

399

326

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

400

327

if self.entry_group_state_changed_match is not None:

402

329

self.entry_group_state_changed_match = None

403

330

if self.group is not None:

404

331

self.group.Reset()

405

332

406

333

def add(self):

407

334

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

408

335

self.remove()

425

352

dbus.UInt16(self.port),

426

353

avahi.string_array_to_txt_array(self.TXT))

427

354

self.group.Commit()

428

355

429

356

def entry_group_state_changed(self, state, error):

430

357

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

431

358

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

432

359

433

360

if state == avahi.ENTRY_GROUP_ESTABLISHED:

434

361

logger.debug("Zeroconf service established.")

435

362

elif state == avahi.ENTRY_GROUP_COLLISION:

439

366

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

440

367

str(error))

441

368

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

442

369

443

370

def cleanup(self):

444

371

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

445

372

if self.group is not None:

450

377

pass

451

378

self.group = None

452

379

self.remove()

453

380

454

381

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

455

382

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

456

383

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

468

395

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

469

396

self.cleanup()

470

397

elif state == avahi.SERVER_RUNNING:

471

try:

472

self.add()

473

except dbus.exceptions.DBusException as error:

474

if (error.get_dbus_name()

475

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

476

logger.info("Local Zeroconf service name"

477

" collision.")

478

return self.rename(remove=False)

479

else:

480

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

481

self.cleanup()

482

os._exit(1)

398

self.add()

483

399

else:

484

400

if error is None:

485

401

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

486

402

else:

487

403

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

488

404

489

405

def activate(self):

490

406

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

491

407

if self.server is None:

502

418

class AvahiServiceToSyslog(AvahiService):

503

419

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

504

420

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

505

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

421

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

506

422

syslogger.setFormatter(logging.Formatter(

507

423

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

508

424

.format(self.name)))

509

425

return ret

510

426

511

427

512

# Pretend that we have a GnuTLS module

513

class gnutls:

514

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

515

516

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

517

if library is None:

518

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

519

_library = ctypes.cdll.LoadLibrary(library)

520

del library

521

522

# Unless otherwise indicated, the constants and types below are

523

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

524

525

# Constants

526

E_SUCCESS = 0

527

E_INTERRUPTED = -52

528

E_AGAIN = -28

529

CRT_OPENPGP = 2

530

CRT_RAWPK = 3

531

CLIENT = 2

532

SHUT_RDWR = 0

533

CRD_CERTIFICATE = 1

534

E_NO_CERTIFICATE_FOUND = -49

535

X509_FMT_DER = 0

536

NO_TICKETS = 1<<10

537

ENABLE_RAWPK = 1<<18

538

CTYPE_PEERS = 3

539

KEYID_USE_SHA256 = 1 # gnutls/x509.h

540

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

541

542

# Types

543

class session_int(ctypes.Structure):

544

_fields_ = []

545

session_t = ctypes.POINTER(session_int)

546

547

class certificate_credentials_st(ctypes.Structure):

548

_fields_ = []

549

certificate_credentials_t = ctypes.POINTER(

550

certificate_credentials_st)

551

certificate_type_t = ctypes.c_int

552

553

class datum_t(ctypes.Structure):

554

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

555

('size', ctypes.c_uint)]

556

557

class openpgp_crt_int(ctypes.Structure):

558

_fields_ = []

559

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

560

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

561

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

562

credentials_type_t = ctypes.c_int

563

transport_ptr_t = ctypes.c_void_p

564

close_request_t = ctypes.c_int

565

566

# Exceptions

567

class Error(Exception):

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = gnutls.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials:

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession:

593

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

594

self._c_object = gnutls.session_t()

595

gnutls_flags = gnutls.CLIENT

596

if gnutls.check_version(b"3.5.6"):

597

gnutls_flags |= gnutls.NO_TICKETS

598

if gnutls.has_rawpk:

599

gnutls_flags |= gnutls.ENABLE_RAWPK

600

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

601

del gnutls_flags

602

gnutls.set_default_priority(self._c_object)

603

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

604

gnutls.handshake_set_private_extensions(self._c_object,

605

True)

606

self.socket = socket

607

if credentials is None:

608

credentials = gnutls.Credentials()

609

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

610

ctypes.cast(credentials._c_object,

611

ctypes.c_void_p))

612

self.credentials = credentials

613

614

def __del__(self):

615

gnutls.deinit(self._c_object)

616

617

def handshake(self):

618

return gnutls.handshake(self._c_object)

619

620

def send(self, data):

621

data = bytes(data)

622

data_len = len(data)

623

while data_len > 0:

624

data_len -= gnutls.record_send(self._c_object,

625

data[-data_len:],

626

data_len)

627

628

def bye(self):

629

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

630

631

# Error handling functions

632

def _error_code(result):

633

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

634

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

635

if result >= 0:

636

return result

637

if result == gnutls.E_NO_CERTIFICATE_FOUND:

638

raise gnutls.CertificateSecurityError(code=result)

639

raise gnutls.Error(code=result)

640

641

def _retry_on_error(result, func, arguments):

642

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

643

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

644

while result < 0:

645

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

646

return _error_code(result)

647

result = func(*arguments)

648

return result

649

650

# Unless otherwise indicated, the function declarations below are

651

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

652

653

# Functions

654

priority_set_direct = _library.gnutls_priority_set_direct

655

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

656

ctypes.POINTER(ctypes.c_char_p)]

657

priority_set_direct.restype = _error_code

658

659

init = _library.gnutls_init

660

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

661

init.restype = _error_code

662

663

set_default_priority = _library.gnutls_set_default_priority

664

set_default_priority.argtypes = [session_t]

665

set_default_priority.restype = _error_code

666

667

record_send = _library.gnutls_record_send

668

record_send.argtypes = [session_t, ctypes.c_void_p,

669

ctypes.c_size_t]

670

record_send.restype = ctypes.c_ssize_t

671

record_send.errcheck = _retry_on_error

672

673

certificate_allocate_credentials = (

674

_library.gnutls_certificate_allocate_credentials)

675

certificate_allocate_credentials.argtypes = [

676

ctypes.POINTER(certificate_credentials_t)]

677

certificate_allocate_credentials.restype = _error_code

678

679

certificate_free_credentials = (

680

_library.gnutls_certificate_free_credentials)

681

certificate_free_credentials.argtypes = [

682

certificate_credentials_t]

683

certificate_free_credentials.restype = None

684

685

handshake_set_private_extensions = (

686

_library.gnutls_handshake_set_private_extensions)

687

handshake_set_private_extensions.argtypes = [session_t,

688

ctypes.c_int]

689

handshake_set_private_extensions.restype = None

690

691

credentials_set = _library.gnutls_credentials_set

692

credentials_set.argtypes = [session_t, credentials_type_t,

693

ctypes.c_void_p]

694

credentials_set.restype = _error_code

695

696

strerror = _library.gnutls_strerror

697

strerror.argtypes = [ctypes.c_int]

698

strerror.restype = ctypes.c_char_p

699

700

certificate_type_get = _library.gnutls_certificate_type_get

701

certificate_type_get.argtypes = [session_t]

702

certificate_type_get.restype = _error_code

703

704

certificate_get_peers = _library.gnutls_certificate_get_peers

705

certificate_get_peers.argtypes = [session_t,

706

ctypes.POINTER(ctypes.c_uint)]

707

certificate_get_peers.restype = ctypes.POINTER(datum_t)

708

709

global_set_log_level = _library.gnutls_global_set_log_level

710

global_set_log_level.argtypes = [ctypes.c_int]

711

global_set_log_level.restype = None

712

713

global_set_log_function = _library.gnutls_global_set_log_function

714

global_set_log_function.argtypes = [log_func]

715

global_set_log_function.restype = None

716

717

deinit = _library.gnutls_deinit

718

deinit.argtypes = [session_t]

719

deinit.restype = None

720

721

handshake = _library.gnutls_handshake

722

handshake.argtypes = [session_t]

723

handshake.restype = _error_code

724

handshake.errcheck = _retry_on_error

725

726

transport_set_ptr = _library.gnutls_transport_set_ptr

727

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

728

transport_set_ptr.restype = None

729

730

bye = _library.gnutls_bye

731

bye.argtypes = [session_t, close_request_t]

732

bye.restype = _error_code

733

bye.errcheck = _retry_on_error

734

735

check_version = _library.gnutls_check_version

736

check_version.argtypes = [ctypes.c_char_p]

737

check_version.restype = ctypes.c_char_p

738

739

_need_version = b"3.3.0"

740

if check_version(_need_version) is None:

741

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

742

.format(_need_version))

743

744

_tls_rawpk_version = b"3.6.6"

745

has_rawpk = bool(check_version(_tls_rawpk_version))

746

747

if has_rawpk:

748

# Types

749

class pubkey_st(ctypes.Structure):

750

_fields = []

751

pubkey_t = ctypes.POINTER(pubkey_st)

752

753

x509_crt_fmt_t = ctypes.c_int

754

755

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

756

pubkey_init = _library.gnutls_pubkey_init

757

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

758

pubkey_init.restype = _error_code

759

760

pubkey_import = _library.gnutls_pubkey_import

761

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

762

x509_crt_fmt_t]

763

pubkey_import.restype = _error_code

764

765

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

766

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

767

ctypes.POINTER(ctypes.c_ubyte),

768

ctypes.POINTER(ctypes.c_size_t)]

769

pubkey_get_key_id.restype = _error_code

770

771

pubkey_deinit = _library.gnutls_pubkey_deinit

772

pubkey_deinit.argtypes = [pubkey_t]

773

pubkey_deinit.restype = None

774

else:

775

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

776

777

openpgp_crt_init = _library.gnutls_openpgp_crt_init

778

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

779

openpgp_crt_init.restype = _error_code

780

781

openpgp_crt_import = _library.gnutls_openpgp_crt_import

782

openpgp_crt_import.argtypes = [openpgp_crt_t,

783

ctypes.POINTER(datum_t),

784

openpgp_crt_fmt_t]

785

openpgp_crt_import.restype = _error_code

786

787

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

788

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

789

ctypes.POINTER(ctypes.c_uint)]

790

openpgp_crt_verify_self.restype = _error_code

791

792

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

793

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

794

openpgp_crt_deinit.restype = None

795

796

openpgp_crt_get_fingerprint = (

797

_library.gnutls_openpgp_crt_get_fingerprint)

798

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

799

ctypes.c_void_p,

800

ctypes.POINTER(

801

ctypes.c_size_t)]

802

openpgp_crt_get_fingerprint.restype = _error_code

803

804

if check_version(b"3.6.4"):

805

certificate_type_get2 = _library.gnutls_certificate_type_get2

806

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

807

certificate_type_get2.restype = _error_code

808

809

# Remove non-public functions

810

del _error_code, _retry_on_error

811

812

813

def call_pipe(connection, # : multiprocessing.Connection

814

func, *args, **kwargs):

815

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

816

817

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

818

return value on the provided multiprocessing.Connection.

819

"""

820

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

821

connection.close()

822

823

824

class Client:

428

class Client(object):

825

429

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

826

430

827

431

Attributes:

828

432

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

829

433

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

830

434

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

831

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

832

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

833

running.

834

checker_callback_tag: a GLib event source tag, or None

435

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

436

to see if the client lives.

437

'None' if no process is running.

438

checker_callback_tag: a gobject event source tag, or None

835

439

checker_command: string; External command which is run to check

836

440

if client lives. %() expansions are done at

837

441

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

838

442

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

839

checker_initiator_tag: a GLib event source tag, or None

443

checker_initiator_tag: a gobject event source tag, or None

840

444

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

841

445

client_structure: Object describing what attributes a client has

842

446

and is used for storing the client at exit

843

447

current_checker_command: string; current running checker_command

844

disable_initiator_tag: a GLib event source tag, or None

448

disable_initiator_tag: a gobject event source tag, or None

845

449

enabled: bool()

846

450

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

847

uniquely identify an OpenPGP client

848

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

849

a client using raw public keys

451

uniquely identify the client

850

452

host: string; available for use by the checker command

851

453

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

852

454

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

854

456

last_checker_status: integer between 0 and 255 reflecting exit

855

457

status of last checker. -1 reflects crashed

856

458

checker, -2 means no checker completed yet.

857

last_checker_signal: The signal which killed the last checker, if

858

last_checker_status is -1

859

459

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

860

460

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

861

461

D-Bus identifiers

868

468

disabled, or None

869

469

server_settings: The server_settings dict from main()

870

470

"""

871

471

872

472

runtime_expansions = ("approval_delay", "approval_duration",

873

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

473

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

874

474

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

875

475

"last_approval_request", "last_checked_ok",

876

476

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

885

485

"approved_by_default": "True",

886

486

"enabled": "True",

887

487

}

888

488

889

489

@staticmethod

890

490

def config_parser(config):

891

491

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

898

498

for client_name in config.sections():

899

499

section = dict(config.items(client_name))

900

500

client = settings[client_name] = {}

901

501

902

502

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

903

503

# Reformat values from string types to Python types

904

504

client["approved_by_default"] = config.getboolean(

905

505

client_name, "approved_by_default")

906

506

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

907

507

"enabled")

908

909

# Uppercase and remove spaces from key_id and fingerprint

910

# for later comparison purposes with return value from the

911

# key_id() and fingerprint() functions

912

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

913

.replace(" ", ""))

508

509

# Uppercase and remove spaces from fingerprint for later

510

# comparison purposes with return value from the

511

# fingerprint() function

914

512

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

915

513

.replace(" ", ""))

916

514

if "secret" in section:

917

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

918

.encode("utf-8"),

919

"base64")

515

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

920

516

elif "secfile" in section:

921

517

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

922

518

(section["secfile"])),

937

533

client["last_approval_request"] = None

938

534

client["last_checked_ok"] = None

939

535

client["last_checker_status"] = -2

940

536

941

537

return settings

942

943

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

538

539

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

944

540

self.name = name

945

541

if server_settings is None:

946

542

server_settings = {}

948

544

# adding all client settings

949

545

for setting, value in settings.items():

950

546

setattr(self, setting, value)

951

547

952

548

if self.enabled:

953

549

if not hasattr(self, "last_enabled"):

954

550

self.last_enabled = datetime.datetime.utcnow()

958

554

else:

959

555

self.last_enabled = None

960

556

self.expires = None

961

557

962

558

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

963

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

964

559

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

965

560

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

966

561

datetime.datetime.utcnow())

967

562

968

563

# attributes specific for this server instance

969

564

self.checker = None

970

565

self.checker_initiator_tag = None

976

571

self.changedstate = multiprocessing_manager.Condition(

977

572

multiprocessing_manager.Lock())

978

573

self.client_structure = [attr

979

for attr in self.__dict__.keys()

574

for attr in self.__dict__.iterkeys()

980

575

if not attr.startswith("_")]

981

576

self.client_structure.append("client_structure")

982

577

983

578

for name, t in inspect.getmembers(

984

579

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

985

580

if not name.startswith("_"):

986

581

self.client_structure.append(name)

987

582

988

583

# Send notice to process children that client state has changed

989

584

def send_changedstate(self):

990

585

with self.changedstate:

991

586

self.changedstate.notify_all()

992

587

993

588

def enable(self):

994

589

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

995

590

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

1000

595

self.last_enabled = datetime.datetime.utcnow()

1001

596

self.init_checker()

1002

597

self.send_changedstate()

1003

598

1004

599

def disable(self, quiet=True):

1005

600

"""Disable this client."""

1006

601

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

1008

603

if not quiet:

1009

604

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

1010

605

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

1011

GLib.source_remove(self.disable_initiator_tag)

606

gobject.source_remove(self.disable_initiator_tag)

1012

607

self.disable_initiator_tag = None

1013

608

self.expires = None

1014

609

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

1015

GLib.source_remove(self.checker_initiator_tag)

610

gobject.source_remove(self.checker_initiator_tag)

1016

611

self.checker_initiator_tag = None

1017

612

self.stop_checker()

1018

613

self.enabled = False

1019

614

if not quiet:

1020

615

self.send_changedstate()

1021

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

616

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

1022

617

return False

1023

618

1024

619

def __del__(self):

1025

620

self.disable()

1026

621

1027

622

def init_checker(self):

1028

623

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

1029

624

# and every interval from then on.

1030

625

if self.checker_initiator_tag is not None:

1031

GLib.source_remove(self.checker_initiator_tag)

1032

self.checker_initiator_tag = GLib.timeout_add(

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = gobject.timeout_add(

1033

628

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

1034

629

self.start_checker)

1035

630

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

1036

631

if self.disable_initiator_tag is not None:

1037

GLib.source_remove(self.disable_initiator_tag)

1038

self.disable_initiator_tag = GLib.timeout_add(

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = gobject.timeout_add(

1039

634

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

1040

635

# Also start a new checker *right now*.

1041

636

self.start_checker()

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

637

638

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

1045

639

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

1046

# Read return code from connection (see call_pipe)

1047

returncode = connection.recv()

1048

connection.close()

1049

self.checker.join()

1050

640

self.checker_callback_tag = None

1051

641

self.checker = None

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1056

644

if self.last_checker_status == 0:

1057

645

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

1058

646

vars(self))

1061

649

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

1062

650

else:

1063

651

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

1065

652

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

1066

653

vars(self))

1067

return False

1068

654

1069

655

def checked_ok(self):

1070

656

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

1071

657

self.last_checked_ok = datetime.datetime.utcnow()

1072

658

self.last_checker_status = 0

1073

self.last_checker_signal = None

1074

659

self.bump_timeout()

1075

660

1076

661

def bump_timeout(self, timeout=None):

1077

662

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

1078

663

if timeout is None:

1079

664

timeout = self.timeout

1080

665

if self.disable_initiator_tag is not None:

1081

GLib.source_remove(self.disable_initiator_tag)

666

gobject.source_remove(self.disable_initiator_tag)

1082

667

self.disable_initiator_tag = None

1083

668

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

1084

self.disable_initiator_tag = GLib.timeout_add(

669

self.disable_initiator_tag = gobject.timeout_add(

1085

670

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

1086

671

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

1087

672

1088

673

def need_approval(self):

1089

674

self.last_approval_request = datetime.datetime.utcnow()

1090

675

1091

676

def start_checker(self):

1092

677

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

1093

678

1094

679

If a checker already exists, leave it running and do

1095

680

nothing."""

1096

681

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

1101

686

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

1102

687

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

1103

688

# should be.

1104

1105

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

1106

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

1107

self.checker.join()

1108

self.checker = None

689

690

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

691

try:

692

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

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

self.current_checker_command)

1109

704

# Start a new checker if needed

1110

705

if self.checker is None:

1111

706

# Escape attributes for the shell

1112

707

escaped_attrs = {

1113

708

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

1114

for attr in self.runtime_expansions}

709

for attr in self.runtime_expansions }

1115

710

try:

1116

711

command = self.checker_command % escaped_attrs

1117

712

except TypeError as error:

1120

715

exc_info=error)

1121

716

return True # Try again later

1122

717

self.current_checker_command = command

1123

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

1124

self.name)

1125

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

1126

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

1127

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

1128

# always replaced by /dev/null.)

1129

# The exception is when not debugging but nevertheless

1130

# running in the foreground; use the previously

1131

# created wnull.

1132

popen_args = {"close_fds": True,

1133

"shell": True,

1134

"cwd": "/"}

1135

if (not self.server_settings["debug"]

1136

and self.server_settings["foreground"]):

1137

popen_args.update({"stdout": wnull,

1138

"stderr": wnull})

1139

pipe = multiprocessing.Pipe(duplex=False)

1140

self.checker = multiprocessing.Process(

1141

target=call_pipe,

1142

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

1143

kwargs=popen_args)

1144

self.checker.start()

1145

self.checker_callback_tag = GLib.io_add_watch(

1146

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

1147

self.checker_callback, pipe[0], command)

1148

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

718

try:

719

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

720

self.name)

721

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

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True,

736

cwd="/",

737

**popen_args)

738

except OSError as error:

739

logger.error("Failed to start subprocess",

740

exc_info=error)

741

return True

742

self.checker_callback_tag = gobject.child_watch_add(

743

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

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

747

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

748

except OSError as error:

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

758

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

1149

759

return True

1150

760

1151

761

def stop_checker(self):

1152

762

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

1153

763

if self.checker_callback_tag:

1154

GLib.source_remove(self.checker_callback_tag)

764

gobject.source_remove(self.checker_callback_tag)

1155

765

self.checker_callback_tag = None

1156

766

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

1157

767

return

1158

768

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

1159

self.checker.terminate()

769

try:

770

self.checker.terminate()

771

#time.sleep(0.5)

772

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

773

# self.checker.kill()

774

except OSError as error:

775

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

776

raise

1160

777

self.checker = None

1161

778

1162

779

1166

783

byte_arrays=False):

1167

784

"""Decorators for marking methods of a DBusObjectWithProperties to

1168

785

become properties on the D-Bus.

1169

786

1170

787

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

1171

788

and with one argument by "Set".

1172

789

1173

790

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

1174

791

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

1175

792

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

1179

796

if byte_arrays and signature != "ay":

1180

797

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

1181

798

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

1182

799

1183

800

def decorator(func):

1184

801

func._dbus_is_property = True

1185

802

func._dbus_interface = dbus_interface

1188

805

func._dbus_name = func.__name__

1189

806

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

1190

807

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

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1192

809

return func

1193

810

1194

811

return decorator

1195

812

1196

813

1197

814

def dbus_interface_annotations(dbus_interface):

1198

815

"""Decorator for marking functions returning interface annotations

1199

816

1200

817

Usage:

1201

818

1202

819

@dbus_interface_annotations("org.example.Interface")

1203

820

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

1204

821

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

1205

822

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

1206

823

"false"}

1207

824

"""

1208

825

1209

826

def decorator(func):

1210

827

func._dbus_is_interface = True

1211

828

func._dbus_interface = dbus_interface

1212

829

func._dbus_name = dbus_interface

1213

830

return func

1214

831

1215

832

return decorator

1216

833

1217

834

1218

835

def dbus_annotations(annotations):

1219

836

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

1220

837

Usage:

1221

838

1222

839

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

1223

840

"org.freedesktop.DBus.Property."

1224

841

"EmitsChangedSignal": "false"})

1226

843

access="r")

1227

844

def Property_dbus_property(self):

1228

845

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

1231

846

"""

1232

847

1233

848

def decorator(func):

1234

849

func._dbus_annotations = annotations

1235

850

return func

1236

851

1237

852

return decorator

1238

853

1239

854

1255

870

pass

1256

871

1257

872

1258

class DBusObjectWithAnnotations(dbus.service.Object):

1259

"""A D-Bus object with annotations.

1260

1261

Classes inheriting from this can use the dbus_annotations

1262

decorator to add annotations to methods or signals.

873

class DBusObjectWithProperties(dbus.service.Object):

874

"""A D-Bus object with properties.

875

876

Classes inheriting from this can use the dbus_service_property

877

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

878

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

1263

879

"""

1264

880

1265

881

@staticmethod

1266

882

def _is_dbus_thing(thing):

1267

883

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

1268

884

1269

885

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

1270

886

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

1271

887

"""

1272

888

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

1273

889

False)

1274

890

1275

891

def _get_all_dbus_things(self, thing):

1276

892

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

1277

893

"""

1280

896

for cls in self.__class__.__mro__

1281

897

for name, athing in

1282

898

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

1283

1284

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1285

out_signature="s",

1286

path_keyword='object_path',

1287

connection_keyword='connection')

1288

def Introspect(self, object_path, connection):

1289

"""Overloading of standard D-Bus method.

1290

1291

Inserts annotation tags on methods and signals.

1292

"""

1293

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

1294

connection)

1295

try:

1296

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

1297

1298

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

1299

# Add annotation tags

1300

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

1301

for tag in if_tag.getElementsByTagName(typ):

1302

annots = dict()

1303

for name, prop in (self.

1304

_get_all_dbus_things(typ)):

1305

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

1306

and prop._dbus_interface

1307

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

1308

annots.update(getattr(

1309

prop, "_dbus_annotations", {}))

1310

for name, value in annots.items():

1311

ann_tag = document.createElement(

1312

"annotation")

1313

ann_tag.setAttribute("name", name)

1314

ann_tag.setAttribute("value", value)

1315

tag.appendChild(ann_tag)

1316

# Add interface annotation tags

1317

for annotation, value in dict(

1318

itertools.chain.from_iterable(

1319

annotations().items()

1320

for name, annotations

1321

in self._get_all_dbus_things("interface")

1322

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

1323

)).items():

1324

ann_tag = document.createElement("annotation")

1325

ann_tag.setAttribute("name", annotation)

1326

ann_tag.setAttribute("value", value)

1327

if_tag.appendChild(ann_tag)

1328

# Fix argument name for the Introspect method itself

1329

if (if_tag.getAttribute("name")

1330

== dbus.INTROSPECTABLE_IFACE):

1331

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

1332

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

1333

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

1334

if (arg.getAttribute("direction")

1335

== "out"):

1336

arg.setAttribute("name",

1337

"xml_data")

1338

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

1339

document.unlink()

1340

except (AttributeError, xml.dom.DOMException,

1341

xml.parsers.expat.ExpatError) as error:

1342

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

1343

exc_info=error)

1344

return xmlstring

1345

1346

1347

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1348

"""A D-Bus object with properties.

1349

1350

Classes inheriting from this can use the dbus_service_property

1351

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

1352

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

1353

"""

1354

899

1355

900

def _get_dbus_property(self, interface_name, property_name):

1356

901

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

1357

902

property with the specified name and interface.

1362

907

if (value._dbus_name == property_name

1363

908

and value._dbus_interface == interface_name):

1364

909

return value.__get__(self)

1365

910

1366

911

# No such property

1367

912

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

1368

913

self.dbus_object_path, interface_name, property_name))

1369

1370

@classmethod

1371

def _get_all_interface_names(cls):

1372

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

1373

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

1374

"_dbus_interface", None)

1375

for x in (inspect.getmro(cls))

1376

for attr in dir(x))

1377

if name is not None)

1378

914

1379

915

@dbus.service.method(dbus.PROPERTIES_IFACE,

1380

916

in_signature="ss",

1381

917

out_signature="v")

1389

925

if not hasattr(value, "variant_level"):

1390

926

return value

1391

927

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

1392

928

1393

929

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

1394

930

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

1395

931

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

1407

943

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

1408

944

for byte in value))

1409

945

prop(value)

1410

946

1411

947

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

948

in_signature="s",

1413

949

out_signature="a{sv}")

1414

950

def GetAll(self, interface_name):

1415

951

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

1416

952

standard.

1417

953

1418

954

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

1419

955

"""

1420

956

properties = {}

1431

967

properties[name] = value

1432

968

continue

1433

969

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

970

value, variant_level = value.variant_level + 1)

1435

971

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

1436

972

1437

973

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

1438

974

def PropertiesChanged(self, interface_name, changed_properties,

1439

975

invalidated_properties):

1441

977

standard.

1442

978

"""

1443

979

pass

1444

980

1445

981

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1446

982

out_signature="s",

1447

983

path_keyword='object_path',

1448

984

connection_keyword='connection')

1449

985

def Introspect(self, object_path, connection):

1450

986

"""Overloading of standard D-Bus method.

1451

987

1452

988

Inserts property tags and interface annotation tags.

1453

989

"""

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

990

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

991

connection)

1457

992

try:

1458

993

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

1459

994

1460

995

def make_tag(document, name, prop):

1461

996

e = document.createElement("property")

1462

997

e.setAttribute("name", name)

1463

998

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

1464

999

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

1465

1000

return e

1466

1001

1467

1002

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

1468

1003

# Add property tags

1469

1004

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

1472

1007

if prop._dbus_interface

1473

1008

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

1474

1009

if_tag.appendChild(tag)

1475

# Add annotation tags for properties

1476

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

1477

annots = dict()

1478

for name, prop in self._get_all_dbus_things(

1479

"property"):

1480

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

1481

and prop._dbus_interface

1482

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

1483

annots.update(getattr(

1484

prop, "_dbus_annotations", {}))

1485

for name, value in annots.items():

1486

ann_tag = document.createElement(

1487

"annotation")

1488

ann_tag.setAttribute("name", name)

1489

ann_tag.setAttribute("value", value)

1490

tag.appendChild(ann_tag)

1010

# Add annotation tags

1011

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

1012

for tag in if_tag.getElementsByTagName(typ):

1013

annots = dict()

1014

for name, prop in (self.

1015

_get_all_dbus_things(typ)):

1016

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

1017

and prop._dbus_interface

1018

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

1019

annots.update(getattr(

1020

prop, "_dbus_annotations", {}))

1021

for name, value in annots.items():

1022

ann_tag = document.createElement(

1023

"annotation")

1024

ann_tag.setAttribute("name", name)

1025

ann_tag.setAttribute("value", value)

1026

tag.appendChild(ann_tag)

1027

# Add interface annotation tags

1028

for annotation, value in dict(

1029

itertools.chain.from_iterable(

1030

annotations().items()

1031

for name, annotations

1032

in self._get_all_dbus_things("interface")

1033

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

1034

)).items():

1035

ann_tag = document.createElement("annotation")

1036

ann_tag.setAttribute("name", annotation)

1037

ann_tag.setAttribute("value", value)

1038

if_tag.appendChild(ann_tag)

1491

1039

# Add the names to the return values for the

1492

1040

# "org.freedesktop.DBus.Properties" methods

1493

1041

if (if_tag.getAttribute("name")

1512

1060

return xmlstring

1513

1061

1514

1062

1515

try:

1516

dbus.OBJECT_MANAGER_IFACE

1517

except AttributeError:

1518

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

1519

1520

1521

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1522

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

1523

1524

Classes inheriting from this exposes the standard

1525

GetManagedObjects call and the InterfacesAdded and

1526

InterfacesRemoved signals on the standard

1527

"org.freedesktop.DBus.ObjectManager" interface.

1528

1529

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

1530

manually.

1531

"""

1532

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1533

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

1534

def GetManagedObjects(self):

1535

"""This function must be overridden"""

1536

raise NotImplementedError()

1537

1538

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def InterfacesAdded(self, object_path, interfaces_and_properties):

1541

pass

1542

1543

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

1544

def InterfacesRemoved(self, object_path, interfaces):

1545

pass

1546

1547

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1548

out_signature="s",

1549

path_keyword='object_path',

1550

connection_keyword='connection')

1551

def Introspect(self, object_path, connection):

1552

"""Overloading of standard D-Bus method.

1553

1554

Override return argument name of GetManagedObjects to be

1555

"objpath_interfaces_and_properties"

1556

"""

1557

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1558

object_path,

1559

connection)

1560

try:

1561

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

1562

1563

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

1564

# Fix argument name for the GetManagedObjects method

1565

if (if_tag.getAttribute("name")

1566

== dbus.OBJECT_MANAGER_IFACE):

1567

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

1568

if (cn.getAttribute("name")

1569

== "GetManagedObjects"):

1570

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

1571

if (arg.getAttribute("direction")

1572

== "out"):

1573

arg.setAttribute(

1574

"name",

1575

"objpath_interfaces"

1576

"_and_properties")

1577

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

1578

document.unlink()

1579

except (AttributeError, xml.dom.DOMException,

1580

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

1063

def datetime_to_dbus(dt, variant_level=0):

1587

1064

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

1588

1065

if dt is None:

1589

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

1066

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

1590

1067

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

1591

1068

1592

1069

1595

1072

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

1596

1073

interface names according to the "alt_interface_names" mapping.

1597

1074

Usage:

1598

1075

1599

1076

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

1600

1077

"net.example.AlternateInterface"})

1601

1078

class SampleDBusObject(dbus.service.Object):

1602

1079

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

1603

1080

def SampleDBusMethod():

1604

1081

pass

1605

1082

1606

1083

The above "SampleDBusMethod" on "SampleDBusObject" will be

1607

1084

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

1608

1085

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

1609

1086

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

1610

1087

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

1611

1088

1612

1089

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

1613

1090

(from DBusObjectWithProperties) and interfaces (from the

1614

1091

dbus_interface_annotations decorator).

1615

1092

"""

1616

1093

1617

1094

def wrapper(cls):

1618

1095

for orig_interface_name, alt_interface_name in (

1619

1096

alt_interface_names.items()):

1634

1111

interface_names.add(alt_interface)

1635

1112

# Is this a D-Bus signal?

1636

1113

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

1637

# Extract the original non-method undecorated

1638

# function by black magic

1639

if sys.version_info.major == 2:

1114

if sys.version == 2:

1115

# Extract the original non-method undecorated

1116

# function by black magic

1640

1117

nonmethod_func = (dict(

1641

1118

zip(attribute.func_code.co_freevars,

1642

1119

attribute.__closure__))

1643

1120

["func"].cell_contents)

1644

1121

else:

1645

nonmethod_func = (dict(

1646

zip(attribute.__code__.co_freevars,

1647

attribute.__closure__))

1648

["func"].cell_contents)

1122

nonmethod_func = attribute

1649

1123

# Create a new, but exactly alike, function

1650

1124

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

1651

1125

# with the alternate D-Bus interface name

1652

new_function = copy_function(nonmethod_func)

1126

if sys.version == 2:

1127

new_function = types.FunctionType(

1128

nonmethod_func.func_code,

1129

nonmethod_func.func_globals,

1130

nonmethod_func.func_name,

1131

nonmethod_func.func_defaults,

1132

nonmethod_func.func_closure)

1133

else:

1134

new_function = types.FunctionType(

1135

nonmethod_func.__code__,

1136

nonmethod_func.__globals__,

1137

nonmethod_func.__name__,

1138

nonmethod_func.__defaults__,

1139

nonmethod_func.__closure__)

1653

1140

new_function = (dbus.service.signal(

1654

1141

alt_interface,

1655

1142

attribute._dbus_signature)(new_function))

1659

1146

attribute._dbus_annotations)

1660

1147

except AttributeError:

1661

1148

pass

1662

1663

1149

# Define a creator of a function to call both the

1664

1150

# original and alternate functions, so both the

1665

1151

# original and alternate signals gets sent when

1668

1154

"""This function is a scope container to pass

1669

1155

func1 and func2 to the "call_both" function

1670

1156

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1157

1673

1158

def call_both(*args, **kwargs):

1674

1159

"""This function will emit two D-Bus

1675

1160

signals by calling func1 and func2"""

1676

1161

func1(*args, **kwargs)

1677

1162

func2(*args, **kwargs)

1678

# Make wrapper function look like a D-Bus

1679

# signal

1680

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

1681

if name.startswith("_dbus_"):

1682

setattr(call_both, name, attr)

1683

1163

1684

1164

return call_both

1685

1165

# Create the "call_both" function and add it to

1686

1166

# the class

1696

1176

alt_interface,

1697

1177

attribute._dbus_in_signature,

1698

1178

attribute._dbus_out_signature)

1699

(copy_function(attribute)))

1179

(types.FunctionType(attribute.func_code,

1180

attribute.func_globals,

1181

attribute.func_name,

1182

attribute.func_defaults,

1183

attribute.func_closure)))

1700

1184

# Copy annotations, if any

1701

1185

try:

1702

1186

attr[attrname]._dbus_annotations = dict(

1714

1198

attribute._dbus_access,

1715

1199

attribute._dbus_get_args_options

1716

1200

["byte_arrays"])

1717

(copy_function(attribute)))

1201

(types.FunctionType(

1202

attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1718

1207

# Copy annotations, if any

1719

1208

try:

1720

1209

attr[attrname]._dbus_annotations = dict(

1729

1218

# to the class.

1730

1219

attr[attrname] = (

1731

1220

dbus_interface_annotations(alt_interface)

1732

(copy_function(attribute)))

1221

(types.FunctionType(attribute.func_code,

1222

attribute.func_globals,

1223

attribute.func_name,

1224

attribute.func_defaults,

1225

attribute.func_closure)))

1733

1226

if deprecate:

1734

1227

# Deprecate all alternate interfaces

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1228

iname="_AlternateDBusNames_interface_annotation{}"

1736

1229

for interface_name in interface_names:

1737

1230

1738

1231

@dbus_interface_annotations(interface_name)

1739

1232

def func(self):

1740

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

1741

"true"}

1233

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

1234

"true" }

1742

1235

# Find an unused name

1743

1236

for aname in (iname.format(i)

1744

1237

for i in itertools.count()):

1748

1241

if interface_names:

1749

1242

# Replace the class with a new subclass of it with

1750

1243

# methods, signals, etc. as created above.

1751

if sys.version_info.major == 2:

1752

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

1753

(cls, ), attr)

1754

else:

1755

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

1756

(cls, ), attr)

1244

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

1245

(cls, ), attr)

1757

1246

return cls

1758

1247

1759

1248

return wrapper

1760

1249

1761

1250

1763

1252

"se.bsnet.fukt.Mandos"})

1764

1253

class ClientDBus(Client, DBusObjectWithProperties):

1765

1254

"""A Client class using D-Bus

1766

1255

1767

1256

Attributes:

1768

1257

dbus_object_path: dbus.ObjectPath

1769

1258

bus: dbus.SystemBus()

1770

1259

"""

1771

1260

1772

1261

runtime_expansions = (Client.runtime_expansions

1773

1262

+ ("dbus_object_path", ))

1774

1263

1775

1264

_interface = "se.recompile.Mandos.Client"

1776

1265

1777

1266

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

1778

1779

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

1267

1268

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

1780

1269

self.bus = bus

1781

1270

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

1782

1271

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

1788

1277

"/clients/" + client_object_name)

1789

1278

DBusObjectWithProperties.__init__(self, self.bus,

1790

1279

self.dbus_object_path)

1791

1280

1792

1281

def notifychangeproperty(transform_func, dbus_name,

1793

1282

type_func=lambda x: x,

1794

1283

variant_level=1,

1796

1285

_interface=_interface):

1797

1286

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

1798

1287

its changes to DBus.

1799

1288

1800

1289

transform_fun: Function that takes a value and a variant_level

1801

1290

and transforms it to a D-Bus type.

1802

1291

dbus_name: D-Bus name of the variable

1805

1294

variant_level: D-Bus variant level. Default: 1

1806

1295

"""

1807

1296

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

1808

1297

1809

1298

def setter(self, value):

1810

1299

if hasattr(self, "dbus_object_path"):

1811

1300

if (not hasattr(self, attrname) or

1818

1307

else:

1819

1308

dbus_value = transform_func(

1820

1309

type_func(value),

1821

variant_level=variant_level)

1310

variant_level = variant_level)

1822

1311

self.PropertyChanged(dbus.String(dbus_name),

1823

1312

dbus_value)

1824

1313

self.PropertiesChanged(

1825

1314

_interface,

1826

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

1827

dbus_value}),

1315

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

1316

dbus_value }),

1828

1317

dbus.Array())

1829

1318

setattr(self, attrname, value)

1830

1319

1831

1320

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

1832

1321

1833

1322

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1834

1323

approvals_pending = notifychangeproperty(dbus.Boolean,

1835

1324

"ApprovalPending",

1836

type_func=bool)

1325

type_func = bool)

1837

1326

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

1838

1327

last_enabled = notifychangeproperty(datetime_to_dbus,

1839

1328

"LastEnabled")

1840

1329

checker = notifychangeproperty(

1841

1330

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1331

type_func = lambda checker: checker is not None)

1843

1332

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1844

1333

"LastCheckedOK")

1845

1334

last_checker_status = notifychangeproperty(dbus.Int16,

1850

1339

"ApprovedByDefault")

1851

1340

approval_delay = notifychangeproperty(

1852

1341

dbus.UInt64, "ApprovalDelay",

1853

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

1342

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

1854

1343

approval_duration = notifychangeproperty(

1855

1344

dbus.UInt64, "ApprovalDuration",

1856

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

1345

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

1857

1346

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

1858

1347

timeout = notifychangeproperty(

1859

1348

dbus.UInt64, "Timeout",

1860

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

1349

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

1861

1350

extended_timeout = notifychangeproperty(

1862

1351

dbus.UInt64, "ExtendedTimeout",

1863

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

1352

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

1864

1353

interval = notifychangeproperty(

1865

1354

dbus.UInt64, "Interval",

1866

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

1355

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

1867

1356

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

1868

1357

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

1869

1358

invalidate_only=True)

1870

1359

1871

1360

del notifychangeproperty

1872

1361

1873

1362

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

1874

1363

try:

1875

1364

self.remove_from_connection()

1878

1367

if hasattr(DBusObjectWithProperties, "__del__"):

1879

1368

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

1880

1369

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

1881

1882

def checker_callback(self, source, condition,

1883

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

1884

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

1885

connection, command, *args,

1886

**kwargs)

1887

exitstatus = self.last_checker_status

1888

if exitstatus >= 0:

1370

1371

def checker_callback(self, pid, condition, command,

1372

*args, **kwargs):

1373

self.checker_callback_tag = None

1374

self.checker = None

1375

if os.WIFEXITED(condition):

1376

exitstatus = os.WEXITSTATUS(condition)

1889

1377

# Emit D-Bus signal

1890

1378

self.CheckerCompleted(dbus.Int16(exitstatus),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1379

dbus.Int64(condition),

1893

1380

dbus.String(command))

1894

1381

else:

1895

1382

# Emit D-Bus signal

1896

1383

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

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1384

dbus.Int64(condition),

1901

1385

dbus.String(command))

1902

return ret

1903

1386

1387

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

1388

*args, **kwargs)

1389

1904

1390

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

1905

1391

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

1906

1392

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

1910

1396

# Emit D-Bus signal

1911

1397

self.CheckerStarted(self.current_checker_command)

1912

1398

return r

1913

1399

1914

1400

def _reset_approved(self):

1915

1401

self.approved = None

1916

1402

return False

1917

1403

1918

1404

def approve(self, value=True):

1919

1405

self.approved = value

1920

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

1921

* 1000), self._reset_approved)

1406

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

1407

* 1000), self._reset_approved)

1922

1408

self.send_changedstate()

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

1409

1410

## D-Bus methods, signals & properties

1411

1412

## Interfaces

1413

1414

## Signals

1415

1930

1416

# CheckerCompleted - signal

1931

1417

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

1932

1418

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

1933

1419

"D-Bus signal"

1934

1420

pass

1935

1421

1936

1422

# CheckerStarted - signal

1937

1423

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

1938

1424

def CheckerStarted(self, command):

1939

1425

"D-Bus signal"

1940

1426

pass

1941

1427

1942

1428

# PropertyChanged - signal

1943

1429

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

1944

1430

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

1945

1431

def PropertyChanged(self, property, value):

1946

1432

"D-Bus signal"

1947

1433

pass

1948

1434

1949

1435

# GotSecret - signal

1950

1436

@dbus.service.signal(_interface)

1951

1437

def GotSecret(self):

1954

1440

server to mandos-client

1955

1441

"""

1956

1442

pass

1957

1443

1958

1444

# Rejected - signal

1959

1445

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

1960

1446

def Rejected(self, reason):

1961

1447

"D-Bus signal"

1962

1448

pass

1963

1449

1964

1450

# NeedApproval - signal

1965

1451

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

1966

1452

def NeedApproval(self, timeout, default):

1967

1453

"D-Bus signal"

1968

1454

return self.need_approval()

1969

1970

# Methods

1971

1455

1456

## Methods

1457

1972

1458

# Approve - method

1973

1459

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

1974

1460

def Approve(self, value):

1975

1461

self.approve(value)

1976

1462

1977

1463

# CheckedOK - method

1978

1464

@dbus.service.method(_interface)

1979

1465

def CheckedOK(self):

1980

1466

self.checked_ok()

1981

1467

1982

1468

# Enable - method

1983

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

1984

1469

@dbus.service.method(_interface)

1985

1470

def Enable(self):

1986

1471

"D-Bus method"

1987

1472

self.enable()

1988

1473

1989

1474

# StartChecker - method

1990

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

1991

1475

@dbus.service.method(_interface)

1992

1476

def StartChecker(self):

1993

1477

"D-Bus method"

1994

1478

self.start_checker()

1995

1479

1996

1480

# Disable - method

1997

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

1998

1481

@dbus.service.method(_interface)

1999

1482

def Disable(self):

2000

1483

"D-Bus method"

2001

1484

self.disable()

2002

1485

2003

1486

# StopChecker - method

2004

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

2005

1487

@dbus.service.method(_interface)

2006

1488

def StopChecker(self):

2007

1489

self.stop_checker()

2008

2009

# Properties

2010

1490

1491

## Properties

1492

2011

1493

# ApprovalPending - property

2012

1494

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

2013

1495

def ApprovalPending_dbus_property(self):

2014

1496

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

2015

1497

2016

1498

# ApprovedByDefault - property

2017

1499

@dbus_service_property(_interface,

2018

1500

signature="b",

2021

1503

if value is None: # get

2022

1504

return dbus.Boolean(self.approved_by_default)

2023

1505

self.approved_by_default = bool(value)

2024

1506

2025

1507

# ApprovalDelay - property

2026

1508

@dbus_service_property(_interface,

2027

1509

signature="t",

2031

1513

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

2032

1514

* 1000)

2033

1515

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

2034

1516

2035

1517

# ApprovalDuration - property

2036

1518

@dbus_service_property(_interface,

2037

1519

signature="t",

2041

1523

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

2042

1524

* 1000)

2043

1525

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

2044

1526

2045

1527

# Name - property

2046

@dbus_annotations(

2047

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

2048

1528

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

2049

1529

def Name_dbus_property(self):

2050

1530

return dbus.String(self.name)

2051

2052

# KeyID - property

2053

@dbus_annotations(

2054

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

2055

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

2056

def KeyID_dbus_property(self):

2057

return dbus.String(self.key_id)

2058

1531

2059

1532

# Fingerprint - property

2060

@dbus_annotations(

2061

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

2062

1533

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

2063

1534

def Fingerprint_dbus_property(self):

2064

1535

return dbus.String(self.fingerprint)

2065

1536

2066

1537

# Host - property

2067

1538

@dbus_service_property(_interface,

2068

1539

signature="s",

2071

1542

if value is None: # get

2072

1543

return dbus.String(self.host)

2073

1544

self.host = str(value)

2074

1545

2075

1546

# Created - property

2076

@dbus_annotations(

2077

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

2078

1547

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

2079

1548

def Created_dbus_property(self):

2080

1549

return datetime_to_dbus(self.created)

2081

1550

2082

1551

# LastEnabled - property

2083

1552

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

2084

1553

def LastEnabled_dbus_property(self):

2085

1554

return datetime_to_dbus(self.last_enabled)

2086

1555

2087

1556

# Enabled - property

2088

1557

@dbus_service_property(_interface,

2089

1558

signature="b",

2095

1564

self.enable()

2096

1565

else:

2097

1566

self.disable()

2098

1567

2099

1568

# LastCheckedOK - property

2100

1569

@dbus_service_property(_interface,

2101

1570

signature="s",

2105

1574

self.checked_ok()

2106

1575

return

2107

1576

return datetime_to_dbus(self.last_checked_ok)

2108

1577

2109

1578

# LastCheckerStatus - property

2110

1579

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

2111

1580

def LastCheckerStatus_dbus_property(self):

2112

1581

return dbus.Int16(self.last_checker_status)

2113

1582

2114

1583

# Expires - property

2115

1584

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

2116

1585

def Expires_dbus_property(self):

2117

1586

return datetime_to_dbus(self.expires)

2118

1587

2119

1588

# LastApprovalRequest - property

2120

1589

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

2121

1590

def LastApprovalRequest_dbus_property(self):

2122

1591

return datetime_to_dbus(self.last_approval_request)

2123

1592

2124

1593

# Timeout - property

2125

1594

@dbus_service_property(_interface,

2126

1595

signature="t",

2141

1610

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

2142

1611

is None):

2143

1612

return

2144

GLib.source_remove(self.disable_initiator_tag)

2145

self.disable_initiator_tag = GLib.timeout_add(

1613

gobject.source_remove(self.disable_initiator_tag)

1614

self.disable_initiator_tag = gobject.timeout_add(

2146

1615

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

2147

1616

self.disable)

2148

1617

2149

1618

# ExtendedTimeout - property

2150

1619

@dbus_service_property(_interface,

2151

1620

signature="t",

2155

1624

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

2156

1625

* 1000)

2157

1626

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

2158

1627

2159

1628

# Interval - property

2160

1629

@dbus_service_property(_interface,

2161

1630

signature="t",

2168

1637

return

2169

1638

if self.enabled:

2170

1639

# Reschedule checker run

2171

GLib.source_remove(self.checker_initiator_tag)

2172

self.checker_initiator_tag = GLib.timeout_add(

1640

gobject.source_remove(self.checker_initiator_tag)

1641

self.checker_initiator_tag = gobject.timeout_add(

2173

1642

value, self.start_checker)

2174

self.start_checker() # Start one now, too

2175

1643

self.start_checker() # Start one now, too

1644

2176

1645

# Checker - property

2177

1646

@dbus_service_property(_interface,

2178

1647

signature="s",

2181

1650

if value is None: # get

2182

1651

return dbus.String(self.checker_command)

2183

1652

self.checker_command = str(value)

2184

1653

2185

1654

# CheckerRunning - property

2186

1655

@dbus_service_property(_interface,

2187

1656

signature="b",

2193

1662

self.start_checker()

2194

1663

else:

2195

1664

self.stop_checker()

2196

1665

2197

1666

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

2201

1667

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

2202

1668

def ObjectPath_dbus_property(self):

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1669

return self.dbus_object_path # is already a dbus.ObjectPath

1670

2205

1671

# Secret = property

2206

@dbus_annotations(

2207

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

2208

"invalidates"})

2209

1672

@dbus_service_property(_interface,

2210

1673

signature="ay",

2211

1674

access="write",

2212

1675

byte_arrays=True)

2213

1676

def Secret_dbus_property(self, value):

2214

1677

self.secret = bytes(value)

2215

1678

2216

1679

del _interface

2217

1680

2218

1681

2219

class ProxyClient:

2220

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

1682

class ProxyClient(object):

1683

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

2221

1684

self._pipe = child_pipe

2222

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

1685

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

2223

1686

if not self._pipe.recv():

2224

raise KeyError(key_id or fpr)

2225

1687

raise KeyError(fpr)

1688

2226

1689

def __getattribute__(self, name):

2227

1690

if name == '_pipe':

2228

1691

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

2231

1694

if data[0] == 'data':

2232

1695

return data[1]

2233

1696

if data[0] == 'function':

2234

1697

2235

1698

def func(*args, **kwargs):

2236

1699

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

2237

1700

return self._pipe.recv()[1]

2238

1701

2239

1702

return func

2240

1703

2241

1704

def __setattr__(self, name, value):

2242

1705

if name == '_pipe':

2243

1706

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

2246

1709

2247

1710

class ClientHandler(socketserver.BaseRequestHandler, object):

2248

1711

"""A class to handle client connections.

2249

1712

2250

1713

Instantiated once for each connection to handle it.

2251

1714

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

2252

1715

2253

1716

def handle(self):

2254

1717

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

2255

1718

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

2256

1719

str(self.client_address))

2257

1720

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

2258

1721

self.server.child_pipe.fileno())

2259

2260

session = gnutls.ClientSession(self.request)

2261

2262

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

2263

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

2264

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

2265

# "+DHE-DSS"))

1722

1723

session = gnutls.connection.ClientSession(

1724

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

1725

1726

# Note: gnutls.connection.X509Credentials is really a

1727

# generic GnuTLS certificate credentials object so long as

1728

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

1729

# here despite using OpenPGP certificates.

1730

1731

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

1732

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

1733

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

1734

# "+DHE-DSS"))

2266

1735

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

2267

1736

priority = self.server.gnutls_priority

2268

1737

if priority is None:

2269

1738

priority = "NORMAL"

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1739

gnutls.library.functions.gnutls_priority_set_direct(

1740

session._c_object, priority, None)

1741

2274

1742

# Start communication using the Mandos protocol

2275

1743

# Get protocol number

2276

1744

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

2281

1749

except (ValueError, IndexError, RuntimeError) as error:

2282

1750

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

2283

1751

return

2284

1752

2285

1753

# Start GnuTLS connection

2286

1754

try:

2287

1755

session.handshake()

2288

except gnutls.Error as error:

1756

except gnutls.errors.GNUTLSError as error:

2289

1757

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

2290

1758

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

2291

1759

# established. Just abandon the request.

2292

1760

return

2293

1761

logger.debug("Handshake succeeded")

2294

1762

2295

1763

approval_required = False

2296

1764

try:

2297

if gnutls.has_rawpk:

2298

fpr = b""

2299

try:

2300

key_id = self.key_id(

2301

self.peer_certificate(session))

2302

except (TypeError, gnutls.Error) as error:

2303

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

2304

return

2305

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

2306

2307

else:

2308

key_id = b""

2309

try:

2310

fpr = self.fingerprint(

2311

self.peer_certificate(session))

2312

except (TypeError, gnutls.Error) as error:

2313

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

2314

return

2315

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

2316

2317

try:

2318

client = ProxyClient(child_pipe, key_id, fpr,

1765

try:

1766

fpr = self.fingerprint(

1767

self.peer_certificate(session))

1768

except (TypeError,

1769

gnutls.errors.GNUTLSError) as error:

1770

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

1771

return

1772

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

1773

1774

try:

1775

client = ProxyClient(child_pipe, fpr,

2319

1776

self.client_address)

2320

1777

except KeyError:

2321

1778

return

2322

1779

2323

1780

if client.approval_delay:

2324

1781

delay = client.approval_delay

2325

1782

client.approvals_pending += 1

2326

1783

approval_required = True

2327

1784

2328

1785

while True:

2329

1786

if not client.enabled:

2330

1787

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

2333

1790

# Emit D-Bus signal

2334

1791

client.Rejected("Disabled")

2335

1792

return

2336

1793

2337

1794

if client.approved or not client.approval_delay:

2338

# We are approved or approval is disabled

1795

#We are approved or approval is disabled

2339

1796

break

2340

1797

elif client.approved is None:

2341

1798

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

2352

1809

# Emit D-Bus signal

2353

1810

client.Rejected("Denied")

2354

1811

return

2355

2356

# wait until timeout or approved

1812

1813

#wait until timeout or approved

2357

1814

time = datetime.datetime.now()

2358

1815

client.changedstate.acquire()

2359

1816

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

2372

1829

break

2373

1830

else:

2374

1831

delay -= time2 - time

2375

2376

try:

2377

session.send(client.secret)

2378

except gnutls.Error as error:

2379

logger.warning("gnutls send failed",

2380

exc_info=error)

2381

return

2382

1832

1833

sent_size = 0

1834

while sent_size < len(client.secret):

1835

try:

1836

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

1837

except gnutls.errors.GNUTLSError as error:

1838

logger.warning("gnutls send failed",

1839

exc_info=error)

1840

return

1841

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

1842

len(client.secret) - (sent_size

1843

+ sent))

1844

sent_size += sent

1845

2383

1846

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

2384

1847

# bump the timeout using extended_timeout

2385

1848

client.bump_timeout(client.extended_timeout)

2386

1849

if self.server.use_dbus:

2387

1850

# Emit D-Bus signal

2388

1851

client.GotSecret()

2389

1852

2390

1853

finally:

2391

1854

if approval_required:

2392

1855

client.approvals_pending -= 1

2393

1856

try:

2394

1857

session.bye()

2395

except gnutls.Error as error:

1858

except gnutls.errors.GNUTLSError as error:

2396

1859

logger.warning("GnuTLS bye failed",

2397

1860

exc_info=error)

2398

1861

2399

1862

@staticmethod

2400

1863

def peer_certificate(session):

2401

"Return the peer's certificate as a bytestring"

2402

try:

2403

cert_type = gnutls.certificate_type_get2(session._c_object,

2404

gnutls.CTYPE_PEERS)

2405

except AttributeError:

2406

cert_type = gnutls.certificate_type_get(session._c_object)

2407

if gnutls.has_rawpk:

2408

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2409

else:

2410

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2411

# If not a valid certificate type...

2412

if cert_type not in valid_cert_types:

2413

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

2414

valid_cert_types)

2415

# ...return invalid data

2416

return b""

1864

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

1865

# If not an OpenPGP certificate...

1866

if (gnutls.library.functions.gnutls_certificate_type_get(

1867

session._c_object)

1868

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1869

# ...do the normal thing

1870

return session.peer_certificate

2417

1871

list_size = ctypes.c_uint(1)

2418

cert_list = (gnutls.certificate_get_peers

1872

cert_list = (gnutls.library.functions

1873

.gnutls_certificate_get_peers

2419

1874

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

2420

1875

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

2421

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

1876

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

1877

" certificate")

2422

1878

if list_size.value == 0:

2423

1879

return None

2424

1880

cert = cert_list[0]

2425

1881

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

2426

2427

@staticmethod

2428

def key_id(certificate):

2429

"Convert a certificate bytestring to a hexdigit key ID"

2430

# New GnuTLS "datum" with the public key

2431

datum = gnutls.datum_t(

2432

ctypes.cast(ctypes.c_char_p(certificate),

2433

ctypes.POINTER(ctypes.c_ubyte)),

2434

ctypes.c_uint(len(certificate)))

2435

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

2436

# New empty GnuTLS certificate

2437

pubkey = gnutls.pubkey_t()

2438

gnutls.pubkey_init(ctypes.byref(pubkey))

2439

# Import the raw public key into the certificate

2440

gnutls.pubkey_import(pubkey,

2441

ctypes.byref(datum),

2442

gnutls.X509_FMT_DER)

2443

# New buffer for the key ID

2444

buf = ctypes.create_string_buffer(32)

2445

buf_len = ctypes.c_size_t(len(buf))

2446

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

2447

gnutls.pubkey_get_key_id(pubkey,

2448

gnutls.KEYID_USE_SHA256,

2449

ctypes.cast(ctypes.byref(buf),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.byref(buf_len))

2452

# Deinit the certificate

2453

gnutls.pubkey_deinit(pubkey)

2454

2455

# Convert the buffer to a Python bytestring

2456

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

2457

# Convert the bytestring to hexadecimal notation

2458

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

2459

return hex_key_id

2460

1882

2461

1883

@staticmethod

2462

1884

def fingerprint(openpgp):

2463

1885

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2464

1886

# New GnuTLS "datum" with the OpenPGP public key

2465

datum = gnutls.datum_t(

1887

datum = gnutls.library.types.gnutls_datum_t(

2466

1888

ctypes.cast(ctypes.c_char_p(openpgp),

2467

1889

ctypes.POINTER(ctypes.c_ubyte)),

2468

1890

ctypes.c_uint(len(openpgp)))

2469

1891

# New empty GnuTLS certificate

2470

crt = gnutls.openpgp_crt_t()

2471

gnutls.openpgp_crt_init(ctypes.byref(crt))

1892

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1893

gnutls.library.functions.gnutls_openpgp_crt_init(

1894

ctypes.byref(crt))

2472

1895

# Import the OpenPGP public key into the certificate

2473

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

2474

gnutls.OPENPGP_FMT_RAW)

1896

gnutls.library.functions.gnutls_openpgp_crt_import(

1897

crt, ctypes.byref(datum),

1898

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2475

1899

# Verify the self signature in the key

2476

1900

crtverify = ctypes.c_uint()

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1901

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1902

crt, 0, ctypes.byref(crtverify))

2479

1903

if crtverify.value != 0:

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1904

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1905

raise gnutls.errors.CertificateSecurityError(

1906

"Verify failed")

2483

1907

# New buffer for the fingerprint

2484

1908

buf = ctypes.create_string_buffer(20)

2485

1909

buf_len = ctypes.c_size_t()

2486

1910

# Get the fingerprint from the certificate into the buffer

2487

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

2488

ctypes.byref(buf_len))

1911

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1912

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

2489

1913

# Deinit the certificate

2490

gnutls.openpgp_crt_deinit(crt)

1914

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2491

1915

# Convert the buffer to a Python bytestring

2492

1916

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

2493

1917

# Convert the bytestring to hexadecimal notation

2495

1919

return hex_fpr

2496

1920

2497

1921

2498

class MultiprocessingMixIn:

1922

class MultiprocessingMixIn(object):

2499

1923

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

2500

1924

2501

1925

def sub_process_main(self, request, address):

2502

1926

try:

2503

1927

self.finish_request(request, address)

2504

1928

except Exception:

2505

1929

self.handle_error(request, address)

2506

1930

self.close_request(request)

2507

1931

2508

1932

def process_request(self, request, address):

2509

1933

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

2510

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

2511

args=(request, address))

1934

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

1935

args = (request, address))

2512

1936

proc.start()

2513

1937

return proc

2514

1938

2515

1939

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1940

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2517

1941

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

2518

1942

2519

1943

def process_request(self, request, client_address):

2520

1944

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

2521

1945

2522

1946

This function creates a new pipe in self.pipe

2523

1947

"""

2524

1948

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2525

1949

2526

1950

proc = MultiprocessingMixIn.process_request(self, request,

2527

1951

client_address)

2528

1952

self.child_pipe.close()

2529

1953

self.add_pipe(parent_pipe, proc)

2530

1954

2531

1955

def add_pipe(self, parent_pipe, proc):

2532

1956

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

2533

1957

raise NotImplementedError()

2534

1958

2535

1959

2536

1960

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2537

socketserver.TCPServer):

1961

socketserver.TCPServer, object):

2538

1962

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

2539

1963

2540

1964

Attributes:

2541

1965

enabled: Boolean; whether this server is activated yet

2542

1966

interface: None or a network interface name (string)

2543

1967

use_ipv6: Boolean; to use IPv6 or not

2544

1968

"""

2545

1969

2546

1970

def __init__(self, server_address, RequestHandlerClass,

2547

1971

interface=None,

2548

1972

use_ipv6=True,

2558

1982

self.socketfd = socketfd

2559

1983

# Save the original socket.socket() function

2560

1984

self.socket_socket = socket.socket

2561

2562

1985

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

2563

#

1986

#

2564

1987

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

2565

1988

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

2566

1989

# patching socket.socket.)

2567

#

1990

#

2568

1991

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

2569

1992

@functools.wraps(socket.socket)

2570

1993

def socket_wrapper(*args, **kwargs):

2582

2005

# socket_wrapper(), if socketfd was set.

2583

2006

socketserver.TCPServer.__init__(self, server_address,

2584

2007

RequestHandlerClass)

2585

2008

2586

2009

def server_bind(self):

2587

2010

"""This overrides the normal server_bind() function

2588

2011

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

2589

2012

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

2590

global SO_BINDTODEVICE

2591

2013

if self.interface is not None:

2592

2014

if SO_BINDTODEVICE is None:

2593

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

2594

# common enough.

2595

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

2596

SO_BINDTODEVICE = 25

2597

try:

2598

self.socket.setsockopt(

2599

socket.SOL_SOCKET, SO_BINDTODEVICE,

2600

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

2601

except socket.error as error:

2602

if error.errno == errno.EPERM:

2603

logger.error("No permission to bind to"

2604

" interface %s", self.interface)

2605

elif error.errno == errno.ENOPROTOOPT:

2606

logger.error("SO_BINDTODEVICE not available;"

2607

" cannot bind to interface %s",

2608

self.interface)

2609

elif error.errno == errno.ENODEV:

2610

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

2611

" cannot bind", self.interface)

2612

else:

2613

raise

2015

logger.error("SO_BINDTODEVICE does not exist;"

2016

" cannot bind to interface %s",

2017

self.interface)

2018

else:

2019

try:

2020

self.socket.setsockopt(

2021

socket.SOL_SOCKET, SO_BINDTODEVICE,

2022

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

2023

except socket.error as error:

2024

if error.errno == errno.EPERM:

2025

logger.error("No permission to bind to"

2026

" interface %s", self.interface)

2027

elif error.errno == errno.ENOPROTOOPT:

2028

logger.error("SO_BINDTODEVICE not available;"

2029

" cannot bind to interface %s",

2030

self.interface)

2031

elif error.errno == errno.ENODEV:

2032

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

2033

" cannot bind", self.interface)

2034

else:

2035

raise

2614

2036

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

2615

2037

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

2618

2038

if not self.server_address[0]:

2619

2039

if self.address_family == socket.AF_INET6:

2620

any_address = "::" # in6addr_any

2040

any_address = "::" # in6addr_any

2621

2041

else:

2622

any_address = "0.0.0.0" # INADDR_ANY

2042

any_address = "0.0.0.0" # INADDR_ANY

2623

2043

self.server_address = (any_address,

2624

2044

self.server_address[1])

2625

2045

elif not self.server_address[1]:

2635

2055

2636

2056

class MandosServer(IPv6_TCPServer):

2637

2057

"""Mandos server.

2638

2058

2639

2059

Attributes:

2640

2060

clients: set of Client objects

2641

2061

gnutls_priority GnuTLS priority string

2642

2062

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

2643

2644

Assumes a GLib.MainLoop event loop.

2063

2064

Assumes a gobject.MainLoop event loop.

2645

2065

"""

2646

2066

2647

2067

def __init__(self, server_address, RequestHandlerClass,

2648

2068

interface=None,

2649

2069

use_ipv6=True,

2659

2079

self.gnutls_priority = gnutls_priority

2660

2080

IPv6_TCPServer.__init__(self, server_address,

2661

2081

RequestHandlerClass,

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

2082

interface = interface,

2083

use_ipv6 = use_ipv6,

2084

socketfd = socketfd)

2085

2666

2086

def server_activate(self):

2667

2087

if self.enabled:

2668

2088

return socketserver.TCPServer.server_activate(self)

2669

2089

2670

2090

def enable(self):

2671

2091

self.enabled = True

2672

2092

2673

2093

def add_pipe(self, parent_pipe, proc):

2674

2094

# Call "handle_ipc" for both data and EOF events

2675

GLib.io_add_watch(

2095

gobject.io_add_watch(

2676

2096

parent_pipe.fileno(),

2677

GLib.IO_IN | GLib.IO_HUP,

2097

gobject.IO_IN | gobject.IO_HUP,

2678

2098

functools.partial(self.handle_ipc,

2679

parent_pipe=parent_pipe,

2680

proc=proc))

2681

2099

parent_pipe = parent_pipe,

2100

proc = proc))

2101

2682

2102

def handle_ipc(self, source, condition,

2683

2103

parent_pipe=None,

2684

proc=None,

2104

proc = None,

2685

2105

client_object=None):

2686

2106

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

2687

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

2107

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

2688

2108

# Wait for other process to exit

2689

2109

proc.join()

2690

2110

return False

2691

2111

2692

2112

# Read a request from the child

2693

2113

request = parent_pipe.recv()

2694

2114

command = request[0]

2695

2115

2696

2116

if command == 'init':

2697

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

2698

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

2699

address = request[3]

2700

2701

for c in self.clients.values():

2702

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2703

continue

2704

if key_id and c.key_id == key_id:

2705

client = c

2706

break

2707

if fpr and c.fingerprint == fpr:

2117

fpr = request[1]

2118

address = request[2]

2119

2120

for c in self.clients.itervalues():

2121

if c.fingerprint == fpr:

2708

2122

client = c

2709

2123

break

2710

2124

else:

2711

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

2712

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

2125

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

2126

"dress: %s", fpr, address)

2713

2127

if self.use_dbus:

2714

2128

# Emit D-Bus signal

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

2129

mandos_dbus_service.ClientNotFound(fpr,

2716

2130

address[0])

2717

2131

parent_pipe.send(False)

2718

2132

return False

2719

2720

GLib.io_add_watch(

2133

2134

gobject.io_add_watch(

2721

2135

parent_pipe.fileno(),

2722

GLib.IO_IN | GLib.IO_HUP,

2136

gobject.IO_IN | gobject.IO_HUP,

2723

2137

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc,

2726

client_object=client))

2138

parent_pipe = parent_pipe,

2139

proc = proc,

2140

client_object = client))

2727

2141

parent_pipe.send(True)

2728

2142

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

2729

2143

# same fileno

2732

2146

funcname = request[1]

2733

2147

args = request[2]

2734

2148

kwargs = request[3]

2735

2149

2736

2150

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

2737

2151

funcname)(*args,

2738

2152

**kwargs)))

2739

2153

2740

2154

if command == 'getattr':

2741

2155

attrname = request[1]

2742

2156

if isinstance(client_object.__getattribute__(attrname),

2745

2159

else:

2746

2160

parent_pipe.send((

2747

2161

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

2748

2162

2749

2163

if command == 'setattr':

2750

2164

attrname = request[1]

2751

2165

value = request[2]

2752

2166

setattr(client_object, attrname, value)

2753

2167

2754

2168

return True

2755

2169

2756

2170

2757

2171

def rfc3339_duration_to_delta(duration):

2758

2172

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

2759

2173

2760

2174

>>> rfc3339_duration_to_delta("P7D")

2761

2175

datetime.timedelta(7)

2762

2176

>>> rfc3339_duration_to_delta("PT60S")

2772

2186

>>> rfc3339_duration_to_delta("P1DT3M20S")

2773

2187

datetime.timedelta(1, 200)

2774

2188

"""

2775

2189

2776

2190

# Parsing an RFC 3339 duration with regular expressions is not

2777

2191

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

2778

2192

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

2779

2193

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

2780

2194

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

2781

2195

# avoid excessive use of external libraries.

2782

2196

2783

2197

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

2784

2198

Token = collections.namedtuple("Token", (

2785

2199

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

2818

2232

frozenset((token_year, token_month,

2819

2233

token_day, token_time,

2820

2234

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2235

# Define starting values

2236

value = datetime.timedelta() # Value so far

2824

2237

found_token = None

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2238

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

2239

s = duration # String left to parse

2829

2240

# Loop until end token is found

2830

2241

while found_token is not token_end:

2831

2242

# Search for any currently valid tokens

2855

2266

2856

2267

def string_to_delta(interval):

2857

2268

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

2858

2269

2859

2270

>>> string_to_delta('7d')

2860

2271

datetime.timedelta(7)

2861

2272

>>> string_to_delta('60s')

2869

2280

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

2870

2281

datetime.timedelta(0, 330)

2871

2282

"""

2872

2283

2873

2284

try:

2874

2285

return rfc3339_duration_to_delta(interval)

2875

2286

except ValueError:

2876

2287

pass

2877

2288

2878

2289

timevalue = datetime.timedelta(0)

2879

2290

for s in interval.split():

2880

2291

try:

2898

2309

return timevalue

2899

2310

2900

2311

2901

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

2312

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

2902

2313

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

2903

2314

2904

2315

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

2905

2316

if os.fork():

2906

2317

sys.exit()

2924

2335

2925

2336

2926

2337

def main():

2927

2338

2928

2339

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

2929

2340

# Parsing of options, both command line and config file

2930

2341

2931

2342

parser = argparse.ArgumentParser()

2932

2343

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

2933

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

2344

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

2934

2345

help="show version number and exit")

2935

2346

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

2936

2347

help="Bind to interface IF")

2972

2383

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

2973

2384

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

2974

2385

default=None)

2975

2386

2976

2387

options = parser.parse_args()

2977

2388

2978

2389

if options.check:

2979

2390

import doctest

2980

2391

fail_count, test_count = doctest.testmod()

2981

2392

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

2982

2393

2983

2394

# Default values for config file for server-global settings

2984

if gnutls.has_rawpk:

2985

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

2986

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

2987

else:

2988

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

2989

":+SIGN-DSA-SHA256")

2990

server_defaults = {"interface": "",

2991

"address": "",

2992

"port": "",

2993

"debug": "False",

2994

"priority": priority,

2995

"servicename": "Mandos",

2996

"use_dbus": "True",

2997

"use_ipv6": "True",

2998

"debuglevel": "",

2999

"restore": "True",

3000

"socket": "",

3001

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

3002

"foreground": "False",

3003

"zeroconf": "True",

3004

}

3005

del priority

3006

2395

server_defaults = { "interface": "",

2396

"address": "",

2397

"port": "",

2398

"debug": "False",

2399

"priority":

2400

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

2401

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

2402

"servicename": "Mandos",

2403

"use_dbus": "True",

2404

"use_ipv6": "True",

2405

"debuglevel": "",

2406

"restore": "True",

2407

"socket": "",

2408

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

2409

"foreground": "False",

2410

"zeroconf": "True",

2411

}

2412

3007

2413

# Parse config file for server-global settings

3008

server_config = configparser.ConfigParser(server_defaults)

2414

server_config = configparser.SafeConfigParser(server_defaults)

3009

2415

del server_defaults

3010

2416

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

3011

# Convert the ConfigParser object to a dict

2417

# Convert the SafeConfigParser object to a dict

3012

2418

server_settings = server_config.defaults()

3013

2419

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

3014

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

3015

"foreground", "zeroconf"):

2420

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

3016

2421

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

3017

2422

option)

3018

2423

if server_settings["port"]:

3028

2433

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

3029

2434

["socket"])

3030

2435

del server_config

3031

2436

3032

2437

# Override the settings from the config file with command line

3033

2438

# options, if set.

3034

2439

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

3052

2457

if server_settings["debug"]:

3053

2458

server_settings["foreground"] = True

3054

2459

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

3055

2460

3056

2461

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

3057

2462

3058

2463

if (not server_settings["zeroconf"]

3059

2464

and not (server_settings["port"]

3060

2465

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

3061

2466

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

3062

2467

3063

2468

# For convenience

3064

2469

debug = server_settings["debug"]

3065

2470

debuglevel = server_settings["debuglevel"]

3069

2474

stored_state_file)

3070

2475

foreground = server_settings["foreground"]

3071

2476

zeroconf = server_settings["zeroconf"]

3072

2477

3073

2478

if debug:

3074

2479

initlogger(debug, logging.DEBUG)

3075

2480

else:

3078

2483

else:

3079

2484

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

3080

2485

initlogger(debug, level)

3081

2486

3082

2487

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

3083

2488

syslogger.setFormatter(

3084

2489

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

3085

2490

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

3086

2491

server_settings["servicename"])))

3087

2492

3088

2493

# Parse config file with clients

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2494

client_config = configparser.SafeConfigParser(Client

2495

.client_defaults)

3090

2496

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

3091

2497

"clients.conf"))

3092

2498

3093

2499

global mandos_dbus_service

3094

2500

mandos_dbus_service = None

3095

2501

3096

2502

socketfd = None

3097

2503

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

3098

2504

socketfd = server_settings["socket"]

3114

2520

except IOError as e:

3115

2521

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

3116

2522

exc_info=e)

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

2523

2524

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

3121

2525

try:

3122

2526

uid = pwd.getpwnam(name).pw_uid

3123

gid = pwd.getpwnam(group).pw_gid

2527

gid = pwd.getpwnam(name).pw_gid

3124

2528

break

3125

2529

except KeyError:

3126

2530

continue

3130

2534

try:

3131

2535

os.setgid(gid)

3132

2536

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

3136

2537

except OSError as error:

3137

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

3138

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

3139

2538

if error.errno != errno.EPERM:

3140

2539

raise

3141

2540

3142

2541

if debug:

3143

2542

# Enable all possible GnuTLS debugging

3144

2543

3145

2544

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

3146

2545

# - GnuTLS manual

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2546

gnutls.library.functions.gnutls_global_set_log_level(11)

2547

2548

@gnutls.library.types.gnutls_log_func

3150

2549

def debug_gnutls(level, string):

3151

2550

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

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2551

2552

gnutls.library.functions.gnutls_global_set_log_function(

2553

debug_gnutls)

2554

3155

2555

# Redirect stdin so all checkers get /dev/null

3156

2556

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

3157

2557

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

3158

2558

if null > 2:

3159

2559

os.close(null)

3160

2560

3161

2561

# Need to fork before connecting to D-Bus

3162

2562

if not foreground:

3163

2563

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

3164

2564

daemon()

3165

3166

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

3167

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

3168

# need to inform GLib that threads will be used.

3169

GLib.threads_init()

3170

2565

2566

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

2567

# need to inform gobject that threads will be used.

2568

gobject.threads_init()

2569

3171

2570

global main_loop

3172

2571

# From the Avahi example code

3173

2572

DBusGMainLoop(set_as_default=True)

3174

main_loop = GLib.MainLoop()

2573

main_loop = gobject.MainLoop()

3175

2574

bus = dbus.SystemBus()

3176

2575

# End of Avahi example code

3177

2576

if use_dbus:

3190

2589

if zeroconf:

3191

2590

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3192

2591

service = AvahiServiceToSyslog(

3193

name=server_settings["servicename"],

3194

servicetype="_mandos._tcp",

3195

protocol=protocol,

3196

bus=bus)

2592

name = server_settings["servicename"],

2593

servicetype = "_mandos._tcp",

2594

protocol = protocol,

2595

bus = bus)

3197

2596

if server_settings["interface"]:

3198

2597

service.interface = if_nametoindex(

3199

2598

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

3200

2599

3201

2600

global multiprocessing_manager

3202

2601

multiprocessing_manager = multiprocessing.Manager()

3203

2602

3204

2603

client_class = Client

3205

2604

if use_dbus:

3206

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

3207

2605

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

2606

3208

2607

client_settings = Client.config_parser(client_config)

3209

2608

old_client_settings = {}

3210

2609

clients_data = {}

3211

2610

3212

2611

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

3213

2612

global wnull

3214

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

2613

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

3215

2614

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

3216

2615

# mode

3217

2616

if debug or not foreground:

3218

2617

wnull.close()

3219

2618

3220

2619

# Get client data and settings from last running state.

3221

2620

if server_settings["restore"]:

3222

2621

try:

3223

2622

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

3224

if sys.version_info.major == 2:

3225

clients_data, old_client_settings = pickle.load(

3226

stored_state)

3227

else:

3228

bytes_clients_data, bytes_old_client_settings = (

3229

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

3230

# Fix bytes to strings

3231

# clients_data

3232

# .keys()

3233

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

3234

if isinstance(key, bytes)

3235

else key): value

3236

for key, value in

3237

bytes_clients_data.items()}

3238

del bytes_clients_data

3239

for key in clients_data:

3240

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

3241

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

3242

for k, v in

3243

clients_data[key].items()}

3244

clients_data[key] = value

3245

# .client_structure

3246

value["client_structure"] = [

3247

(s.decode("utf-8")

3248

if isinstance(s, bytes)

3249

else s) for s in

3250

value["client_structure"]]

3251

# .name & .host

3252

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

3253

if isinstance(value[k], bytes):

3254

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

3255

if "key_id" not in value:

3256

value["key_id"] = ""

3257

elif "fingerprint" not in value:

3258

value["fingerprint"] = ""

3259

# old_client_settings

3260

# .keys()

3261

old_client_settings = {

3262

(key.decode("utf-8")

3263

if isinstance(key, bytes)

3264

else key): value

3265

for key, value in

3266

bytes_old_client_settings.items()}

3267

del bytes_old_client_settings

3268

# .host

3269

for value in old_client_settings.values():

3270

if isinstance(value["host"], bytes):

3271

value["host"] = (value["host"]

3272

.decode("utf-8"))

2623

clients_data, old_client_settings = pickle.load(

2624

stored_state)

3273

2625

os.remove(stored_state_path)

3274

2626

except IOError as e:

3275

2627

if e.errno == errno.ENOENT:

3283

2635

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

3284

2636

"EOFError:",

3285

2637

exc_info=e)

3286

2638

3287

2639

with PGPEngine() as pgp:

3288

2640

for client_name, client in clients_data.items():

3289

2641

# Skip removed clients

3290

2642

if client_name not in client_settings:

3291

2643

continue

3292

2644

3293

2645

# Decide which value to use after restoring saved state.

3294

2646

# We have three different values: Old config file,

3295

2647

# new config file, and saved state.

3306

2658

client[name] = value

3307

2659

except KeyError:

3308

2660

pass

3309

2661

3310

2662

# Clients who has passed its expire date can still be

3311

# enabled if its last checker was successful. A Client

2663

# enabled if its last checker was successful. Clients

3312

2664

# whose checker succeeded before we stored its state is

3313

2665

# assumed to have successfully run all checkers during

3314

2666

# downtime.

3345

2697

client_name))

3346

2698

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

3347

2699

["secret"])

3348

2700

3349

2701

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

3350

2702

for client_name in (set(old_client_settings)

3351

2703

- set(client_settings)):

3353

2705

for client_name in (set(client_settings)

3354

2706

- set(old_client_settings)):

3355

2707

clients_data[client_name] = client_settings[client_name]

3356

2708

3357

2709

# Create all client objects

3358

2710

for client_name, client in clients_data.items():

3359

2711

tcp_server.clients[client_name] = client_class(

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2712

name = client_name,

2713

settings = client,

2714

server_settings = server_settings)

2715

3364

2716

if not tcp_server.clients:

3365

2717

logger.warning("No clients defined")

3366

2718

3367

2719

if not foreground:

3368

2720

if pidfile is not None:

3369

2721

pid = os.getpid()

3375

2727

pidfilename, pid)

3376

2728

del pidfile

3377

2729

del pidfilename

3378

3379

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

3380

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3381

lambda: main_loop.quit() and False)

3382

2730

2731

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

2732

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

2733

3383

2734

if use_dbus:

3384

2735

3385

2736

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2737

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

2738

class MandosDBusService(DBusObjectWithProperties):

3388

2739

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

3389

2740

3390

2741

def __init__(self):

3391

2742

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

3392

2743

3393

2744

_interface = "se.recompile.Mandos"

3394

2745

2746

@dbus_interface_annotations(_interface)

2747

def _foo(self):

2748

return {

2749

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

2750

"false" }

2751

3395

2752

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

3396

2753

def ClientAdded(self, objpath):

3397

2754

"D-Bus signal"

3398

2755

pass

3399

2756

3400

2757

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

3401

def ClientNotFound(self, key_id, address):

2758

def ClientNotFound(self, fingerprint, address):

3402

2759

"D-Bus signal"

3403

2760

pass

3404

3405

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

3406

"true"})

2761

3407

2762

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

3408

2763

def ClientRemoved(self, objpath, name):

3409

2764

"D-Bus signal"

3410

2765

pass

3411

3412

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

3413

"true"})

2766

3414

2767

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

3415

2768

def GetAllClients(self):

3416

2769

"D-Bus method"

3417

2770

return dbus.Array(c.dbus_object_path for c in

3418

tcp_server.clients.values())

3419

3420

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

3421

"true"})

2771

tcp_server.clients.itervalues())

2772

3422

2773

@dbus.service.method(_interface,

3423

2774

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

3424

2775

def GetAllClientsWithProperties(self):

3425

2776

"D-Bus method"

3426

2777

return dbus.Dictionary(

3427

{c.dbus_object_path: c.GetAll(

3428

"se.recompile.Mandos.Client")

3429

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

2778

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

2779

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

3430

2780

signature="oa{sv}")

3431

2781

3432

2782

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

3433

2783

def RemoveClient(self, object_path):

3434

2784

"D-Bus method"

3435

for c in tcp_server.clients.values():

2785

for c in tcp_server.clients.itervalues():

3436

2786

if c.dbus_object_path == object_path:

3437

2787

del tcp_server.clients[c.name]

3438

2788

c.remove_from_connection()

3439

# Don't signal the disabling

2789

# Don't signal anything except ClientRemoved

3440

2790

c.disable(quiet=True)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2791

# Emit D-Bus signal

2792

self.ClientRemoved(object_path, c.name)

3443

2793

return

3444

2794

raise KeyError(object_path)

3445

2795

3446

2796

del _interface

3447

3448

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3449

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

3450

def GetManagedObjects(self):

3451

"""D-Bus method"""

3452

return dbus.Dictionary(

3453

{client.dbus_object_path:

3454

dbus.Dictionary(

3455

{interface: client.GetAll(interface)

3456

for interface in

3457

client._get_all_interface_names()})

3458

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

3459

3460

def client_added_signal(self, client):

3461

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

3462

if use_dbus:

3463

# New standard signal

3464

self.InterfacesAdded(

3465

client.dbus_object_path,

3466

dbus.Dictionary(

3467

{interface: client.GetAll(interface)

3468

for interface in

3469

client._get_all_interface_names()}))

3470

# Old signal

3471

self.ClientAdded(client.dbus_object_path)

3472

3473

def client_removed_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesRemoved(

3478

client.dbus_object_path,

3479

client._get_all_interface_names())

3480

# Old signal

3481

self.ClientRemoved(client.dbus_object_path,

3482

client.name)

3483

2797

3484

2798

mandos_dbus_service = MandosDBusService()

3485

3486

# Save modules to variables to exempt the modules from being

3487

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

3488

mp = multiprocessing

3489

wn = wnull

3490

2799

3491

2800

def cleanup():

3492

2801

"Cleanup function; run on exit"

3493

2802

if zeroconf:

3494

2803

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2804

2805

multiprocessing.active_children()

2806

wnull.close()

3498

2807

if not (tcp_server.clients or client_settings):

3499

2808

return

3500

2809

3501

2810

# Store client before exiting. Secrets are encrypted with key

3502

2811

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

3503

2812

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

3504

2813

clients = {}

3505

2814

with PGPEngine() as pgp:

3506

for client in tcp_server.clients.values():

2815

for client in tcp_server.clients.itervalues():

3507

2816

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

3508

2817

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

3509

2818

key)

3510

2819

client_dict = {}

3511

2820

3512

2821

# A list of attributes that can not be pickled

3513

2822

# + secret.

3514

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

3515

"checker", "server_settings"}

2823

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

2824

"checker", "server_settings" }

3516

2825

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

3517

2826

.Object):

3518

2827

exclude.add(name)

3519

2828

3520

2829

client_dict["encrypted_secret"] = (client

3521

2830

.encrypted_secret)

3522

2831

for attr in client.client_structure:

3523

2832

if attr not in exclude:

3524

2833

client_dict[attr] = getattr(client, attr)

3525

2834

3526

2835

clients[client.name] = client_dict

3527

2836

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

3528

2837

3529

2838

try:

3530

2839

with tempfile.NamedTemporaryFile(

3531

2840

mode='wb',

3533

2842

prefix='clients-',

3534

2843

dir=os.path.dirname(stored_state_path),

3535

2844

delete=False) as stored_state:

3536

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

3537

protocol=2)

2845

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

3538

2846

tempname = stored_state.name

3539

2847

os.rename(tempname, stored_state_path)

3540

2848

except (IOError, OSError) as e:

3550

2858

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

3551

2859

exc_info=e)

3552

2860

raise

3553

2861

3554

2862

# Delete all clients, and settings from config

3555

2863

while tcp_server.clients:

3556

2864

name, client = tcp_server.clients.popitem()

3557

2865

if use_dbus:

3558

2866

client.remove_from_connection()

3559

# Don't signal the disabling

2867

# Don't signal anything except ClientRemoved

3560

2868

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

3562

2869

if use_dbus:

3563

mandos_dbus_service.client_removed_signal(client)

2870

# Emit D-Bus signal

2871

mandos_dbus_service.ClientRemoved(

2872

client.dbus_object_path, client.name)

3564

2873

client_settings.clear()

3565

2874

3566

2875

atexit.register(cleanup)

3567

3568

for client in tcp_server.clients.values():

2876

2877

for client in tcp_server.clients.itervalues():

3569

2878

if use_dbus:

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2879

# Emit D-Bus signal

2880

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3572

2881

# Need to initiate checking of clients

3573

2882

if client.enabled:

3574

2883

client.init_checker()

3575

2884

3576

2885

tcp_server.enable()

3577

2886

tcp_server.server_activate()

3578

2887

3579

2888

# Find out what port we got

3580

2889

if zeroconf:

3581

2890

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

3586

2895

else: # IPv4

3587

2896

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

3588

2897

*tcp_server.socket.getsockname())

3589

3590

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

3591

2898

2899

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

2900

3592

2901

try:

3593

2902

if zeroconf:

3594

2903

# From the Avahi example code

3599

2908

cleanup()

3600

2909

sys.exit(1)

3601

2910

# End of Avahi example code

3602

3603

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

3604

lambda *args, **kwargs:

3605

(tcp_server.handle_request

3606

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

3607

2911

2912

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

2913

lambda *args, **kwargs:

2914

(tcp_server.handle_request

2915

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

2916

3608

2917

logger.debug("Starting main loop")

3609

2918

main_loop.run()

3610

2919

except AvahiError as error: