/mandos/trunk : revision 1124

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

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 program is free software: you can redistribute it and/or modify

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

90

114

91

115

if sys.version_info.major == 2:

92

116

str = unicode

93

117

94

version = "1.6.9"

118

version = "1.8.4"

95

119

stored_state_file = "clients.pickle"

96

120

97

121

logger = logging.getLogger()

98

122

syslogger = None

99

123

100

124

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

104

127

except (OSError, AttributeError):

128

105

129

def if_nametoindex(interface):

106

130

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

107

131

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

112

136

return interface_index

113

137

114

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

115

155

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

116

156

"""init logger and add loglevel"""

117

157

118

158

global syslogger

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

123

162

syslogger.setFormatter(logging.Formatter

124

163

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

125

164

' %(message)s'))

126

165

logger.addHandler(syslogger)

127

166

128

167

if debug:

129

168

console = logging.StreamHandler()

130

169

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

142

181

143

182

class PGPEngine(object):

144

183

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

184

145

185

def __init__(self):

146

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

147

198

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

199

'--homedir', self.tempdir,

149

200

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

201

'--quiet']

202

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

203

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

204

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

205

153

206

def __enter__(self):

154

207

return self

155

208

156

209

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

157

210

self._cleanup()

158

211

return False

159

212

160

213

def __del__(self):

161

214

self._cleanup()

162

215

163

216

def _cleanup(self):

164

217

if self.tempdir is not None:

165

218

# Delete contents of tempdir

166

219

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

167

topdown = False):

220

topdown=False):

168

221

for filename in files:

169

222

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

170

223

for dirname in dirs:

172

225

# Remove tempdir

173

226

os.rmdir(self.tempdir)

174

227

self.tempdir = None

175

228

176

229

def password_encode(self, password):

177

230

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

178

231

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

183

236

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

184

237

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

185

238

return encoded

186

239

187

240

def encrypt(self, data, password):

188

241

passphrase = self.password_encode(password)

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

191

244

passfile.write(passphrase)

192

245

passfile.flush()

193

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

246

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

194

247

'--passphrase-file',

195

248

passfile.name]

196

249

+ self.gnupgargs,

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

201

254

if proc.returncode != 0:

202

255

raise PGPError(err)

203

256

return ciphertext

204

257

205

258

def decrypt(self, data, password):

206

259

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

209

262

passfile.write(passphrase)

210

263

passfile.flush()

211

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

264

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

212

265

'--passphrase-file',

213

266

passfile.name]

214

267

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

220

272

if proc.returncode != 0:

221

273

raise PGPError(err)

222

274

return decrypted_plaintext

223

275

224

276

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

225

303

class AvahiError(Exception):

226

304

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

227

305

self.value = value

228

306

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

229

307

**kwargs)

230

308

309

231

310

class AvahiServiceError(AvahiError):

232

311

pass

233

312

313

234

314

class AvahiGroupError(AvahiError):

235

315

pass

236

316

237

317

238

318

class AvahiService(object):

239

319

"""An Avahi (Zeroconf) service.

240

320

241

321

Attributes:

242

322

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

243

323

Used to optionally bind to the specified interface.

255

335

server: D-Bus Server

256

336

bus: dbus.SystemBus()

257

337

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

263

350

self.interface = interface

264

351

self.name = name

265

352

self.type = servicetype

274

361

self.server = None

275

362

self.bus = bus

276

363

self.entry_group_state_changed_match = None

277

364

278

365

def rename(self, remove=True):

279

366

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

280

367

if self.rename_count >= self.max_renames:

282

369

" after %i retries, exiting.",

283

370

self.rename_count)

284

371

raise AvahiServiceError("Too many renames")

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

287

374

self.rename_count += 1

288

375

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

289

376

self.name)

300

387

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

301

388

self.cleanup()

302

389

os._exit(1)

303

390

304

391

def remove(self):

305

392

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

306

393

if self.entry_group_state_changed_match is not None:

308

395

self.entry_group_state_changed_match = None

309

396

if self.group is not None:

310

397

self.group.Reset()

311

398

312

399

def add(self):

313

400

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

314

401

self.remove()

331

418

dbus.UInt16(self.port),

332

419

avahi.string_array_to_txt_array(self.TXT))

333

420

self.group.Commit()

334

421

335

422

def entry_group_state_changed(self, state, error):

336

423

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

337

424

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

338

425

339

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

340

427

logger.debug("Zeroconf service established.")

341

428

elif state == avahi.ENTRY_GROUP_COLLISION:

344

431

elif state == avahi.ENTRY_GROUP_FAILURE:

345

432

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

346

433

str(error))

347

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

348

.format(error))

349

434

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

435

350

436

def cleanup(self):

351

437

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

352

438

if self.group is not None:

357

443

pass

358

444

self.group = None

359

445

self.remove()

360

446

361

447

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

362

448

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

363

449

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

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

371

456

if state in bad_states:

372

457

if bad_states[state] is not None:

373

458

if error is None:

376

461

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

377

462

self.cleanup()

378

463

elif state == avahi.SERVER_RUNNING:

379

self.add()

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

380

476

else:

381

477

if error is None:

382

478

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

383

479

else:

384

480

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

385

481

386

482

def activate(self):

387

483

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

388

484

if self.server is None:

392

488

follow_name_owner_changes=True),

393

489

avahi.DBUS_INTERFACE_SERVER)

394

490

self.server.connect_to_signal("StateChanged",

395

self.server_state_changed)

491

self.server_state_changed)

396

492

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

397

493

398

494

399

495

class AvahiServiceToSyslog(AvahiService):

400

496

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

401

497

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

402

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

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

407

502

return ret

408

503

409

504

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

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

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

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

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

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

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

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

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version("3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

815

816

410

817

class Client(object):

411

818

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

412

819

413

820

Attributes:

414

821

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

415

822

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

417

824

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

418

825

to see if the client lives.

419

826

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

421

828

checker_command: string; External command which is run to check

422

829

if client lives. %() expansions are done at

423

830

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

424

831

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

425

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

426

833

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

427

834

client_structure: Object describing what attributes a client has

428

835

and is used for storing the client at exit

429

836

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

431

838

enabled: bool()

432

839

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

433

uniquely identify the client

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

434

843

host: string; available for use by the checker command

435

844

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

436

845

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

438

847

last_checker_status: integer between 0 and 255 reflecting exit

439

848

status of last checker. -1 reflects crashed

440

849

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

441

852

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

442

853

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

443

854

D-Bus identifiers

450

861

disabled, or None

451

862

server_settings: The server_settings dict from main()

452

863

"""

453

864

454

865

runtime_expansions = ("approval_delay", "approval_duration",

455

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

866

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

456

867

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

457

868

"last_approval_request", "last_checked_ok",

458

869

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

470

882

@staticmethod

471

883

def config_parser(config):

472

884

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

479

891

for client_name in config.sections():

480

892

section = dict(config.items(client_name))

481

893

client = settings[client_name] = {}

482

894

483

895

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

484

896

# Reformat values from string types to Python types

485

897

client["approved_by_default"] = config.getboolean(

486

898

client_name, "approved_by_default")

487

899

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

488

900

"enabled")

489

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

490

907

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

491

908

.replace(" ", ""))

492

909

if "secret" in section:

493

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

910

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

911

.encode("utf-8"),

912

"base64")

494

913

elif "secfile" in section:

495

914

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

496

915

(section["secfile"])),

511

930

client["last_approval_request"] = None

512

931

client["last_checked_ok"] = None

513

932

client["last_checker_status"] = -2

514

933

515

934

return settings

516

517

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

935

936

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

518

937

self.name = name

519

938

if server_settings is None:

520

939

server_settings = {}

522

941

# adding all client settings

523

942

for setting, value in settings.items():

524

943

setattr(self, setting, value)

525

944

526

945

if self.enabled:

527

946

if not hasattr(self, "last_enabled"):

528

947

self.last_enabled = datetime.datetime.utcnow()

532

951

else:

533

952

self.last_enabled = None

534

953

self.expires = None

535

954

536

955

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

537

# Uppercase and remove spaces from fingerprint for later

538

# comparison purposes with return value from the fingerprint()

539

# function

956

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

540

957

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

541

958

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

542

959

datetime.datetime.utcnow())

543

960

544

961

# attributes specific for this server instance

545

962

self.checker = None

546

963

self.checker_initiator_tag = None

549

966

self.current_checker_command = None

550

967

self.approved = None

551

968

self.approvals_pending = 0

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

557

973

if not attr.startswith("_")]

558

974

self.client_structure.append("client_structure")

559

560

for name, t in inspect.getmembers(type(self),

561

lambda obj:

562

isinstance(obj,

563

property)):

975

976

for name, t in inspect.getmembers(

977

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

564

978

if not name.startswith("_"):

565

979

self.client_structure.append(name)

566

980

567

981

# Send notice to process children that client state has changed

568

982

def send_changedstate(self):

569

983

with self.changedstate:

570

984

self.changedstate.notify_all()

571

985

572

986

def enable(self):

573

987

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

574

988

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

579

993

self.last_enabled = datetime.datetime.utcnow()

580

994

self.init_checker()

581

995

self.send_changedstate()

582

996

583

997

def disable(self, quiet=True):

584

998

"""Disable this client."""

585

999

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

587

1001

if not quiet:

588

1002

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

589

1003

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

590

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

591

1005

self.disable_initiator_tag = None

592

1006

self.expires = None

593

1007

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

594

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

595

1009

self.checker_initiator_tag = None

596

1010

self.stop_checker()

597

1011

self.enabled = False

598

1012

if not quiet:

599

1013

self.send_changedstate()

600

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

1014

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

601

1015

return False

602

1016

603

1017

def __del__(self):

604

1018

self.disable()

605

1019

606

1020

def init_checker(self):

607

1021

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

608

1022

# and every interval from then on.

609

1023

if self.checker_initiator_tag is not None:

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

615

1028

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

616

1029

if self.disable_initiator_tag is not None:

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

622

1033

# Also start a new checker *right now*.

623

1034

self.start_checker()

624

625

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

626

1038

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

627

1039

self.checker_callback_tag = None

628

1040

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

631

1048

if self.last_checker_status == 0:

632

1049

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

633

1050

vars(self))

634

1051

self.checked_ok()

635

1052

else:

636

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

637

vars(self))

1053

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

638

1054

else:

639

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

640

1057

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

641

1058

vars(self))

642

1059

return False

1060

643

1061

def checked_ok(self):

644

1062

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

645

1063

self.last_checked_ok = datetime.datetime.utcnow()

646

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

647

1066

self.bump_timeout()

648

1067

649

1068

def bump_timeout(self, timeout=None):

650

1069

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

651

1070

if timeout is None:

652

1071

timeout = self.timeout

653

1072

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

655

1074

self.disable_initiator_tag = None

656

1075

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

660

1078

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

661

1079

662

1080

def need_approval(self):

663

1081

self.last_approval_request = datetime.datetime.utcnow()

664

1082

665

1083

def start_checker(self):

666

1084

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

667

1085

668

1086

If a checker already exists, leave it running and do

669

1087

nothing."""

670

1088

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

675

1093

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

676

1094

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

677

1095

# should be.

678

679

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

680

try:

681

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

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

693

1101

# Start a new checker if needed

694

1102

if self.checker is None:

695

1103

# Escape attributes for the shell

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

699

1107

try:

700

1108

command = self.checker_command % escaped_attrs

701

1109

except TypeError as error:

702

1110

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

705

1114

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

721

self.checker = subprocess.Popen(command,

722

close_fds=True,

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

747

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

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

748

1141

return True

749

1142

750

1143

def stop_checker(self):

751

1144

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

752

1145

if self.checker_callback_tag:

753

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

754

1147

self.checker_callback_tag = None

755

1148

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

756

1149

return

757

1150

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

758

try:

759

self.checker.terminate()

760

#time.sleep(0.5)

761

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

762

# self.checker.kill()

763

except OSError as error:

764

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

765

raise

1151

self.checker.terminate()

766

1152

self.checker = None

767

1153

768

1154

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

771

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

772

1160

become properties on the D-Bus.

773

1161

774

1162

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

775

1163

and with one argument by "Set".

776

1164

777

1165

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

778

1166

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

779

1167

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

783

1171

if byte_arrays and signature != "ay":

784

1172

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

785

1173

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

1174

786

1175

def decorator(func):

787

1176

func._dbus_is_property = True

788

1177

func._dbus_interface = dbus_interface

791

1180

func._dbus_name = func.__name__

792

1181

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

793

1182

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

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

795

1184

return func

1185

796

1186

return decorator

797

1187

798

1188

799

1189

def dbus_interface_annotations(dbus_interface):

800

1190

"""Decorator for marking functions returning interface annotations

801

1191

802

1192

Usage:

803

1193

804

1194

@dbus_interface_annotations("org.example.Interface")

805

1195

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

806

1196

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

807

1197

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

808

1198

"false"}

809

1199

"""

1200

810

1201

def decorator(func):

811

1202

func._dbus_is_interface = True

812

1203

func._dbus_interface = dbus_interface

813

1204

func._dbus_name = dbus_interface

814

1205

return func

1206

815

1207

return decorator

816

1208

817

1209

818

1210

def dbus_annotations(annotations):

819

1211

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

820

1212

Usage:

821

1213

822

1214

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

823

1215

"org.freedesktop.DBus.Property."

824

1216

"EmitsChangedSignal": "false"})

826

1218

access="r")

827

1219

def Property_dbus_property(self):

828

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

829

1223

"""

1224

830

1225

def decorator(func):

831

1226

func._dbus_annotations = annotations

832

1227

return func

1228

833

1229

return decorator

834

1230

835

1231

838

1234

"""

839

1235

pass

840

1236

1237

841

1238

class DBusPropertyAccessException(DBusPropertyException):

842

1239

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

843

1240

"""

850

1247

pass

851

1248

852

1249

853

class DBusObjectWithProperties(dbus.service.Object):

854

"""A D-Bus object with properties.

855

856

Classes inheriting from this can use the dbus_service_property

857

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

858

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

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

859

1255

"""

860

1256

861

1257

@staticmethod

862

1258

def _is_dbus_thing(thing):

863

1259

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

864

1260

865

1261

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

866

1262

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

867

1263

"""

868

1264

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

869

1265

False)

870

1266

871

1267

def _get_all_dbus_things(self, thing):

872

1268

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

873

1269

"""

874

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

875

name),

1270

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

876

1271

athing.__get__(self))

877

1272

for cls in self.__class__.__mro__

878

1273

for name, athing in

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

882

1347

def _get_dbus_property(self, interface_name, property_name):

883

1348

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

884

1349

property with the specified name and interface.

885

1350

"""

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

cls, self._is_dbus_thing("property")):

890

1354

if (value._dbus_name == property_name

891

1355

and value._dbus_interface == interface_name):

892

1356

return value.__get__(self)

893

1357

894

1358

# No such property

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

900

1373

out_signature="v")

901

1374

def Get(self, interface_name, property_name):

902

1375

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

908

1381

if not hasattr(value, "variant_level"):

909

1382

return value

910

1383

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

911

1384

912

1385

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

913

1386

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

914

1387

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

926

1399

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

927

1400

for byte in value))

928

1401

prop(value)

929

930

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

931

1405

out_signature="a{sv}")

932

1406

def GetAll(self, interface_name):

933

1407

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

934

1408

standard.

935

1409

936

1410

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

937

1411

"""

938

1412

properties = {}

948

1422

if not hasattr(value, "variant_level"):

949

1423

properties[name] = value

950

1424

continue

951

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

952

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

953

1427

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

954

1428

955

1429

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

956

1430

def PropertiesChanged(self, interface_name, changed_properties,

957

1431

invalidated_properties):

959

1433

standard.

960

1434

"""

961

1435

pass

962

1436

963

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

964

1438

out_signature="s",

965

1439

path_keyword='object_path',

966

1440

connection_keyword='connection')

967

1441

def Introspect(self, object_path, connection):

968

1442

"""Overloading of standard D-Bus method.

969

1443

970

1444

Inserts property tags and interface annotation tags.

971

1445

"""

972

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

973

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

974

1449

try:

975

1450

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

1451

976

1452

def make_tag(document, name, prop):

977

1453

e = document.createElement("property")

978

1454

e.setAttribute("name", name)

979

1455

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

980

1456

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

981

1457

return e

1458

982

1459

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

983

1460

# Add property tags

984

1461

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

987

1464

if prop._dbus_interface

988

1465

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

989

1466

if_tag.appendChild(tag)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

1021

1483

# Add the names to the return values for the

1022

1484

# "org.freedesktop.DBus.Properties" methods

1023

1485

if (if_tag.getAttribute("name")

1042

1504

return xmlstring

1043

1505

1044

1506

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1045

1578

def datetime_to_dbus(dt, variant_level=0):

1046

1579

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

1047

1580

if dt is None:

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1581

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

1582

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

1051

1583

1052

1584

1053

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1055

1587

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

1056

1588

interface names according to the "alt_interface_names" mapping.

1057

1589

Usage:

1058

1590

1059

1591

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

1060

1592

"net.example.AlternateInterface"})

1061

1593

class SampleDBusObject(dbus.service.Object):

1062

1594

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

1063

1595

def SampleDBusMethod():

1064

1596

pass

1065

1597

1066

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1067

1599

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

1068

1600

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

1069

1601

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

1070

1602

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

1071

1603

1072

1604

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

1073

1605

(from DBusObjectWithProperties) and interfaces (from the

1074

1606

dbus_interface_annotations decorator).

1075

1607

"""

1608

1076

1609

def wrapper(cls):

1077

1610

for orig_interface_name, alt_interface_name in (

1078

alt_interface_names.items()):

1611

alt_interface_names.items()):

1079

1612

attr = {}

1080

1613

interface_names = set()

1081

1614

# Go though all attributes of the class

1083

1616

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

1084

1617

# with the wrong interface name

1085

1618

if (not hasattr(attribute, "_dbus_interface")

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1088

1621

continue

1089

1622

# Create an alternate D-Bus interface name based on

1090

1623

# the current name

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1094

1626

interface_names.add(alt_interface)

1095

1627

# Is this a D-Bus signal?

1096

1628

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

1097

1629

# Extract the original non-method undecorated

1098

1630

# function by black magic

1099

nonmethod_func = (dict(

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1100

1633

zip(attribute.func_code.co_freevars,

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1103

1641

# Create a new, but exactly alike, function

1104

1642

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

1105

1643

# with the alternate D-Bus interface name

1106

new_function = (dbus.service.signal

1107

(alt_interface,

1108

attribute._dbus_signature)

1109

(types.FunctionType(

1110

nonmethod_func.func_code,

1111

nonmethod_func.func_globals,

1112

nonmethod_func.func_name,

1113

nonmethod_func.func_defaults,

1114

nonmethod_func.func_closure)))

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1115

1648

# Copy annotations, if any

1116

1649

try:

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1119

1652

except AttributeError:

1120

1653

pass

1654

1121

1655

# Define a creator of a function to call both the

1122

1656

# original and alternate functions, so both the

1123

1657

# original and alternate signals gets sent when

1126

1660

"""This function is a scope container to pass

1127

1661

func1 and func2 to the "call_both" function

1128

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1129

1665

def call_both(*args, **kwargs):

1130

1666

"""This function will emit two D-Bus

1131

1667

signals by calling func1 and func2"""

1132

1668

func1(*args, **kwargs)

1133

1669

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1134

1676

return call_both

1135

1677

# Create the "call_both" function and add it to

1136

1678

# the class

1141

1683

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

1142

1684

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

1143

1685

# to the class.

1144

attr[attrname] = (dbus.service.method

1145

(alt_interface,

1146

attribute._dbus_in_signature,

1147

attribute._dbus_out_signature)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1154

1692

# Copy annotations, if any

1155

1693

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1158

1696

except AttributeError:

1159

1697

pass

1160

1698

# Is this a D-Bus property?

1163

1701

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

1164

1702

# property with the alternate D-Bus interface

1165

1703

# name. Add it to the class.

1166

attr[attrname] = (dbus_service_property

1167

(alt_interface,

1168

attribute._dbus_signature,

1169

attribute._dbus_access,

1170

attribute

1171

._dbus_get_args_options

1172

["byte_arrays"])

1173

(types.FunctionType

1174

(attribute.func_code,

1175

attribute.func_globals,

1176

attribute.func_name,

1177

attribute.func_defaults,

1178

attribute.func_closure)))

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1179

1710

# Copy annotations, if any

1180

1711

try:

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1183

1714

except AttributeError:

1184

1715

pass

1185

1716

# Is this a D-Bus interface?

1188

1719

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

1189

1720

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

1190

1721

# to the class.

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1199

1725

if deprecate:

1200

1726

# Deprecate all alternate interfaces

1201

iname="_AlternateDBusNames_interface_annotation{}"

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1202

1728

for interface_name in interface_names:

1729

1203

1730

@dbus_interface_annotations(interface_name)

1204

1731

def func(self):

1205

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

1206

"true" }

1732

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

1733

"true"}

1207

1734

# Find an unused name

1208

1735

for aname in (iname.format(i)

1209

1736

for i in itertools.count()):

1213

1740

if interface_names:

1214

1741

# Replace the class with a new subclass of it with

1215

1742

# methods, signals, etc. as created above.

1216

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

1217

(cls,), attr)

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1218

1749

return cls

1750

1219

1751

return wrapper

1220

1752

1221

1753

1222

1754

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

1223

"se.bsnet.fukt.Mandos"})

1755

"se.bsnet.fukt.Mandos"})

1224

1756

class ClientDBus(Client, DBusObjectWithProperties):

1225

1757

"""A Client class using D-Bus

1226

1758

1227

1759

Attributes:

1228

1760

dbus_object_path: dbus.ObjectPath

1229

1761

bus: dbus.SystemBus()

1230

1762

"""

1231

1763

1232

1764

runtime_expansions = (Client.runtime_expansions

1233

+ ("dbus_object_path",))

1234

1765

+ ("dbus_object_path", ))

1766

1235

1767

_interface = "se.recompile.Mandos.Client"

1236

1768

1237

1769

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

1238

1239

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

1770

1771

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

1240

1772

self.bus = bus

1241

1773

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

1242

1774

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

1244

1776

client_object_name = str(self.name).translate(

1245

1777

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

1246

1778

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

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1249

1781

DBusObjectWithProperties.__init__(self, self.bus,

1250

1782

self.dbus_object_path)

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1255

1788

_interface=_interface):

1256

1789

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

1257

1790

its changes to DBus.

1258

1791

1259

1792

transform_fun: Function that takes a value and a variant_level

1260

1793

and transforms it to a D-Bus type.

1261

1794

dbus_name: D-Bus name of the variable

1264

1797

variant_level: D-Bus variant level. Default: 1

1265

1798

"""

1266

1799

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

1800

1267

1801

def setter(self, value):

1268

1802

if hasattr(self, "dbus_object_path"):

1269

1803

if (not hasattr(self, attrname) or

1270

1804

type_func(getattr(self, attrname, None))

1271

1805

!= type_func(value)):

1272

1806

if invalidate_only:

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1277

1810

else:

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1281

1814

self.PropertyChanged(dbus.String(dbus_name),

1282

1815

dbus_value)

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1287

1821

setattr(self, attrname, value)

1288

1822

1289

1823

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

1290

1824

1291

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1292

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1293

1827

"ApprovalPending",

1294

type_func = bool)

1828

type_func=bool)

1295

1829

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

1296

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1297

1831

"LastEnabled")

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1301

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1302

1836

"LastCheckedOK")

1303

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1306

1840

datetime_to_dbus, "LastApprovalRequest")

1307

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1308

1842

"ApprovedByDefault")

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1314

1846

approval_duration = notifychangeproperty(

1315

1847

dbus.UInt64, "ApprovalDuration",

1316

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

1848

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

1317

1849

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1321

1853

extended_timeout = notifychangeproperty(

1322

1854

dbus.UInt64, "ExtendedTimeout",

1323

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

1324

interval = notifychangeproperty(dbus.UInt64,

1325

"Interval",

1326

type_func =

1327

lambda td: td.total_seconds()

1328

* 1000)

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1329

1859

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

1330

1860

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

1331

1861

invalidate_only=True)

1332

1862

1333

1863

del notifychangeproperty

1334

1864

1335

1865

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

1336

1866

try:

1337

1867

self.remove_from_connection()

1340

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1341

1871

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

1342

1872

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

1343

1344

def checker_callback(self, pid, condition, command,

1345

*args, **kwargs):

1346

self.checker_callback_tag = None

1347

self.checker = None

1348

if os.WIFEXITED(condition):

1349

exitstatus = os.WEXITSTATUS(condition)

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1350

1881

# Emit D-Bus signal

1351

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1352

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1353

1885

dbus.String(command))

1354

1886

else:

1355

1887

# Emit D-Bus signal

1356

1888

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

1357

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1358

1893

dbus.String(command))

1359

1360

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

1361

*args, **kwargs)

1362

1894

return ret

1895

1363

1896

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

1364

1897

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

1365

1898

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

1369

1902

# Emit D-Bus signal

1370

1903

self.CheckerStarted(self.current_checker_command)

1371

1904

return r

1372

1905

1373

1906

def _reset_approved(self):

1374

1907

self.approved = None

1375

1908

return False

1376

1909

1377

1910

def approve(self, value=True):

1378

1911

self.approved = value

1379

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

1380

* 1000), self._reset_approved)

1912

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

1913

* 1000), self._reset_approved)

1381

1914

self.send_changedstate()

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1389

1922

# CheckerCompleted - signal

1390

1923

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

1391

1924

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

1392

1925

"D-Bus signal"

1393

1926

pass

1394

1927

1395

1928

# CheckerStarted - signal

1396

1929

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

1397

1930

def CheckerStarted(self, command):

1398

1931

"D-Bus signal"

1399

1932

pass

1400

1933

1401

1934

# PropertyChanged - signal

1402

1935

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

1403

1936

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

1404

1937

def PropertyChanged(self, property, value):

1405

1938

"D-Bus signal"

1406

1939

pass

1407

1940

1408

1941

# GotSecret - signal

1409

1942

@dbus.service.signal(_interface)

1410

1943

def GotSecret(self):

1413

1946

server to mandos-client

1414

1947

"""

1415

1948

pass

1416

1949

1417

1950

# Rejected - signal

1418

1951

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

1419

1952

def Rejected(self, reason):

1420

1953

"D-Bus signal"

1421

1954

pass

1422

1955

1423

1956

# NeedApproval - signal

1424

1957

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

1425

1958

def NeedApproval(self, timeout, default):

1426

1959

"D-Bus signal"

1427

1960

return self.need_approval()

1428

1429

## Methods

1430

1961

1962

# Methods

1963

1431

1964

# Approve - method

1432

1965

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

1433

1966

def Approve(self, value):

1434

1967

self.approve(value)

1435

1968

1436

1969

# CheckedOK - method

1437

1970

@dbus.service.method(_interface)

1438

1971

def CheckedOK(self):

1439

1972

self.checked_ok()

1440

1973

1441

1974

# Enable - method

1975

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

1442

1976

@dbus.service.method(_interface)

1443

1977

def Enable(self):

1444

1978

"D-Bus method"

1445

1979

self.enable()

1446

1980

1447

1981

# StartChecker - method

1982

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

1448

1983

@dbus.service.method(_interface)

1449

1984

def StartChecker(self):

1450

1985

"D-Bus method"

1451

1986

self.start_checker()

1452

1987

1453

1988

# Disable - method

1989

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

1454

1990

@dbus.service.method(_interface)

1455

1991

def Disable(self):

1456

1992

"D-Bus method"

1457

1993

self.disable()

1458

1994

1459

1995

# StopChecker - method

1996

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

1460

1997

@dbus.service.method(_interface)

1461

1998

def StopChecker(self):

1462

1999

self.stop_checker()

1463

1464

## Properties

1465

2000

2001

# Properties

2002

1466

2003

# ApprovalPending - property

1467

2004

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

1468

2005

def ApprovalPending_dbus_property(self):

1469

2006

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

1470

2007

1471

2008

# ApprovedByDefault - property

1472

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1473

2011

access="readwrite")

1474

2012

def ApprovedByDefault_dbus_property(self, value=None):

1475

2013

if value is None: # get

1476

2014

return dbus.Boolean(self.approved_by_default)

1477

2015

self.approved_by_default = bool(value)

1478

2016

1479

2017

# ApprovalDelay - property

1480

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1481

2020

access="readwrite")

1482

2021

def ApprovalDelay_dbus_property(self, value=None):

1483

2022

if value is None: # get

1484

2023

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

1485

2024

* 1000)

1486

2025

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

1487

2026

1488

2027

# ApprovalDuration - property

1489

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1490

2030

access="readwrite")

1491

2031

def ApprovalDuration_dbus_property(self, value=None):

1492

2032

if value is None: # get

1493

2033

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

1494

2034

* 1000)

1495

2035

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

1496

2036

1497

2037

# Name - property

2038

@dbus_annotations(

2039

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

1498

2040

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

1499

2041

def Name_dbus_property(self):

1500

2042

return dbus.String(self.name)

1501

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1502

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1503

2054

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

1504

2055

def Fingerprint_dbus_property(self):

1505

2056

return dbus.String(self.fingerprint)

1506

2057

1507

2058

# Host - property

1508

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1509

2061

access="readwrite")

1510

2062

def Host_dbus_property(self, value=None):

1511

2063

if value is None: # get

1512

2064

return dbus.String(self.host)

1513

2065

self.host = str(value)

1514

2066

1515

2067

# Created - property

2068

@dbus_annotations(

2069

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

1516

2070

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

1517

2071

def Created_dbus_property(self):

1518

2072

return datetime_to_dbus(self.created)

1519

2073

1520

2074

# LastEnabled - property

1521

2075

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

1522

2076

def LastEnabled_dbus_property(self):

1523

2077

return datetime_to_dbus(self.last_enabled)

1524

2078

1525

2079

# Enabled - property

1526

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1527

2082

access="readwrite")

1528

2083

def Enabled_dbus_property(self, value=None):

1529

2084

if value is None: # get

1532

2087

self.enable()

1533

2088

else:

1534

2089

self.disable()

1535

2090

1536

2091

# LastCheckedOK - property

1537

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1538

2094

access="readwrite")

1539

2095

def LastCheckedOK_dbus_property(self, value=None):

1540

2096

if value is not None:

1541

2097

self.checked_ok()

1542

2098

return

1543

2099

return datetime_to_dbus(self.last_checked_ok)

1544

2100

1545

2101

# LastCheckerStatus - property

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2102

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

1548

2103

def LastCheckerStatus_dbus_property(self):

1549

2104

return dbus.Int16(self.last_checker_status)

1550

2105

1551

2106

# Expires - property

1552

2107

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

1553

2108

def Expires_dbus_property(self):

1554

2109

return datetime_to_dbus(self.expires)

1555

2110

1556

2111

# LastApprovalRequest - property

1557

2112

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

1558

2113

def LastApprovalRequest_dbus_property(self):

1559

2114

return datetime_to_dbus(self.last_approval_request)

1560

2115

1561

2116

# Timeout - property

1562

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1563

2119

access="readwrite")

1564

2120

def Timeout_dbus_property(self, value=None):

1565

2121

if value is None: # get

1577

2133

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

1578

2134

is None):

1579

2135

return

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

int((self.expires - now).total_seconds()

1584

* 1000), self.disable))

1585

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1586

2141

# ExtendedTimeout - property

1587

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1588

2144

access="readwrite")

1589

2145

def ExtendedTimeout_dbus_property(self, value=None):

1590

2146

if value is None: # get

1591

2147

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

1592

2148

* 1000)

1593

2149

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

1594

2150

1595

2151

# Interval - property

1596

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1597

2154

access="readwrite")

1598

2155

def Interval_dbus_property(self, value=None):

1599

2156

if value is None: # get

1603

2160

return

1604

2161

if self.enabled:

1605

2162

# Reschedule checker run

1606

gobject.source_remove(self.checker_initiator_tag)

1607

self.checker_initiator_tag = (gobject.timeout_add

1608

(value, self.start_checker))

1609

self.start_checker() # Start one now, too

1610

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1611

2168

# Checker - property

1612

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1613

2171

access="readwrite")

1614

2172

def Checker_dbus_property(self, value=None):

1615

2173

if value is None: # get

1616

2174

return dbus.String(self.checker_command)

1617

2175

self.checker_command = str(value)

1618

2176

1619

2177

# CheckerRunning - property

1620

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1621

2180

access="readwrite")

1622

2181

def CheckerRunning_dbus_property(self, value=None):

1623

2182

if value is None: # get

1626

2185

self.start_checker()

1627

2186

else:

1628

2187

self.stop_checker()

1629

2188

1630

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1631

2193

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

1632

2194

def ObjectPath_dbus_property(self):

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1635

2197

# Secret = property

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1638

2205

def Secret_dbus_property(self, value):

1639

2206

self.secret = bytes(value)

1640

2207

1641

2208

del _interface

1642

2209

1643

2210

1644

2211

class ProxyClient(object):

1645

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

2212

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

1646

2213

self._pipe = child_pipe

1647

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

2214

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

1648

2215

if not self._pipe.recv():

1649

raise KeyError()

1650

2216

raise KeyError(key_id or fpr)

2217

1651

2218

def __getattribute__(self, name):

1652

2219

if name == '_pipe':

1653

2220

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

1656

2223

if data[0] == 'data':

1657

2224

return data[1]

1658

2225

if data[0] == 'function':

2226

1659

2227

def func(*args, **kwargs):

1660

2228

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

1661

2229

return self._pipe.recv()[1]

2230

1662

2231

return func

1663

2232

1664

2233

def __setattr__(self, name, value):

1665

2234

if name == '_pipe':

1666

2235

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

1669

2238

1670

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1671

2240

"""A class to handle client connections.

1672

2241

1673

2242

Instantiated once for each connection to handle it.

1674

2243

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

1675

2244

1676

2245

def handle(self):

1677

2246

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

1678

2247

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

1679

2248

str(self.client_address))

1680

2249

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

1681

2250

self.server.child_pipe.fileno())

1682

1683

session = (gnutls.connection

1684

.ClientSession(self.request,

1685

gnutls.connection

1686

.X509Credentials()))

1687

1688

# Note: gnutls.connection.X509Credentials is really a

1689

# generic GnuTLS certificate credentials object so long as

1690

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

1691

# here despite using OpenPGP certificates.

1692

1693

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

1694

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

1695

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

1696

# "+DHE-DSS"))

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1697

2258

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

1698

2259

priority = self.server.gnutls_priority

1699

2260

if priority is None:

1700

2261

priority = "NORMAL"

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1705

2266

# Start communication using the Mandos protocol

1706

2267

# Get protocol number

1707

2268

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

1712

2273

except (ValueError, IndexError, RuntimeError) as error:

1713

2274

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

1714

2275

return

1715

2276

1716

2277

# Start GnuTLS connection

1717

2278

try:

1718

2279

session.handshake()

1719

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1720

2281

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

1721

2282

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

1722

2283

# established. Just abandon the request.

1723

2284

return

1724

2285

logger.debug("Handshake succeeded")

1725

2286

1726

2287

approval_required = False

1727

2288

try:

1728

try:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

1733

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

1734

return

1735

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

1736

1737

try:

1738

client = ProxyClient(child_pipe, fpr,

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1739

2311

self.client_address)

1740

2312

except KeyError:

1741

2313

return

1742

2314

1743

2315

if client.approval_delay:

1744

2316

delay = client.approval_delay

1745

2317

client.approvals_pending += 1

1746

2318

approval_required = True

1747

2319

1748

2320

while True:

1749

2321

if not client.enabled:

1750

2322

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

1751

client.name)

2323

client.name)

1752

2324

if self.server.use_dbus:

1753

2325

# Emit D-Bus signal

1754

2326

client.Rejected("Disabled")

1755

2327

return

1756

2328

1757

2329

if client.approved or not client.approval_delay:

1758

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1759

2331

break

1760

2332

elif client.approved is None:

1761

2333

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

1772

2344

# Emit D-Bus signal

1773

2345

client.Rejected("Denied")

1774

2346

return

1775

1776

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1777

2349

time = datetime.datetime.now()

1778

2350

client.changedstate.acquire()

1779

2351

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

1792

2364

break

1793

2365

else:

1794

2366

delay -= time2 - time

1795

1796

sent_size = 0

1797

while sent_size < len(client.secret):

1798

try:

1799

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

1800

except gnutls.errors.GNUTLSError as error:

1801

logger.warning("gnutls send failed",

1802

exc_info=error)

1803

return

1804

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

1805

sent, len(client.secret)

1806

- (sent_size + sent))

1807

sent_size += sent

1808

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1809

2375

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

1810

2376

# bump the timeout using extended_timeout

1811

2377

client.bump_timeout(client.extended_timeout)

1812

2378

if self.server.use_dbus:

1813

2379

# Emit D-Bus signal

1814

2380

client.GotSecret()

1815

2381

1816

2382

finally:

1817

2383

if approval_required:

1818

2384

client.approvals_pending -= 1

1819

2385

try:

1820

2386

session.bye()

1821

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1822

2388

logger.warning("GnuTLS bye failed",

1823

2389

exc_info=error)

1824

2390

1825

2391

@staticmethod

1826

2392

def peer_certificate(session):

1827

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

1828

# If not an OpenPGP certificate...

1829

if (gnutls.library.functions

1830

.gnutls_certificate_type_get(session._c_object)

1831

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1832

# ...do the normal thing

1833

return session.peer_certificate

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1834

2409

list_size = ctypes.c_uint(1)

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1837

2411

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

1838

2412

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

1839

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

1840

" certificate")

2413

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

1841

2414

if list_size.value == 0:

1842

2415

return None

1843

2416

cert = cert_list[0]

1844

2417

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

1845

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1846

2453

@staticmethod

1847

2454

def fingerprint(openpgp):

1848

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1849

2456

# New GnuTLS "datum" with the OpenPGP public key

1850

datum = (gnutls.library.types

1851

.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),

1852

ctypes.POINTER

1853

(ctypes.c_ubyte)),

1854

ctypes.c_uint(len(openpgp))))

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1855

2461

# New empty GnuTLS certificate

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1859

2464

# Import the OpenPGP public key into the certificate

1860

(gnutls.library.functions

1861

.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1864

2467

# Verify the self signature in the key

1865

2468

crtverify = ctypes.c_uint()

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1869

2471

if crtverify.value != 0:

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1873

2475

# New buffer for the fingerprint

1874

2476

buf = ctypes.create_string_buffer(20)

1875

2477

buf_len = ctypes.c_size_t()

1876

2478

# Get the fingerprint from the certificate into the buffer

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1880

2481

# Deinit the certificate

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1882

2483

# Convert the buffer to a Python bytestring

1883

2484

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

1884

2485

# Convert the bytestring to hexadecimal notation

1888

2489

1889

2490

class MultiprocessingMixIn(object):

1890

2491

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

2492

1891

2493

def sub_process_main(self, request, address):

1892

2494

try:

1893

2495

self.finish_request(request, address)

1894

2496

except Exception:

1895

2497

self.handle_error(request, address)

1896

2498

self.close_request(request)

1897

2499

1898

2500

def process_request(self, request, address):

1899

2501

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

1900

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

1901

args = (request, address))

2502

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

2503

args=(request, address))

1902

2504

proc.start()

1903

2505

return proc

1904

2506

1905

2507

1906

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1907

2509

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

2510

1908

2511

def process_request(self, request, client_address):

1909

2512

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

1910

2513

1911

2514

This function creates a new pipe in self.pipe

1912

2515

"""

1913

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1914

2517

1915

2518

proc = MultiprocessingMixIn.process_request(self, request,

1916

2519

client_address)

1917

2520

self.child_pipe.close()

1918

2521

self.add_pipe(parent_pipe, proc)

1919

2522

1920

2523

def add_pipe(self, parent_pipe, proc):

1921

2524

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

1922

2525

raise NotImplementedError()

1925

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1926

2529

socketserver.TCPServer, object):

1927

2530

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

1928

2531

1929

2532

Attributes:

1930

2533

enabled: Boolean; whether this server is activated yet

1931

2534

interface: None or a network interface name (string)

1932

2535

use_ipv6: Boolean; to use IPv6 or not

1933

2536

"""

2537

1934

2538

def __init__(self, server_address, RequestHandlerClass,

1935

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

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

1936

2542

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

1937

2543

creating a new one with socket.socket().

1938

2544

"""

1944

2550

self.socketfd = socketfd

1945

2551

# Save the original socket.socket() function

1946

2552

self.socket_socket = socket.socket

2553

1947

2554

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

1948

#

2555

#

1949

2556

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

1950

2557

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

1951

2558

# patching socket.socket.)

1952

#

2559

#

1953

2560

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

1954

2561

@functools.wraps(socket.socket)

1955

2562

def socket_wrapper(*args, **kwargs):

1967

2574

# socket_wrapper(), if socketfd was set.

1968

2575

socketserver.TCPServer.__init__(self, server_address,

1969

2576

RequestHandlerClass)

1970

2577

1971

2578

def server_bind(self):

1972

2579

"""This overrides the normal server_bind() function

1973

2580

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

1974

2581

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

2582

global SO_BINDTODEVICE

1975

2583

if self.interface is not None:

1976

2584

if SO_BINDTODEVICE is None:

1977

logger.error("SO_BINDTODEVICE does not exist;"

1978

" cannot bind to interface %s",

1979

self.interface)

1980

else:

1981

try:

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1983

SO_BINDTODEVICE,

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1999

2606

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

2000

2607

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

2608

if self.server_address[1]:

2609

self.allow_reuse_address = True

2001

2610

if not self.server_address[0]:

2002

2611

if self.address_family == socket.AF_INET6:

2003

any_address = "::" # in6addr_any

2612

any_address = "::" # in6addr_any

2004

2613

else:

2005

any_address = "0.0.0.0" # INADDR_ANY

2614

any_address = "0.0.0.0" # INADDR_ANY

2006

2615

self.server_address = (any_address,

2007

2616

self.server_address[1])

2008

2617

elif not self.server_address[1]:

2009

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

2010

0)

2618

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

2011

2619

# if self.interface:

2012

2620

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

2013

2621

# 0, # port

2019

2627

2020

2628

class MandosServer(IPv6_TCPServer):

2021

2629

"""Mandos server.

2022

2630

2023

2631

Attributes:

2024

2632

clients: set of Client objects

2025

2633

gnutls_priority GnuTLS priority string

2026

2634

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

2027

2028

Assumes a gobject.MainLoop event loop.

2635

2636

Assumes a GLib.MainLoop event loop.

2029

2637

"""

2638

2030

2639

def __init__(self, server_address, RequestHandlerClass,

2031

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

2032

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

2640

interface=None,

2641

use_ipv6=True,

2642

clients=None,

2643

gnutls_priority=None,

2644

use_dbus=True,

2645

socketfd=None):

2033

2646

self.enabled = False

2034

2647

self.clients = clients

2035

2648

if self.clients is None:

2038

2651

self.gnutls_priority = gnutls_priority

2039

2652

IPv6_TCPServer.__init__(self, server_address,

2040

2653

RequestHandlerClass,

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2654

interface=interface,

2655

use_ipv6=use_ipv6,

2656

socketfd=socketfd)

2657

2044

2658

def server_activate(self):

2045

2659

if self.enabled:

2046

2660

return socketserver.TCPServer.server_activate(self)

2047

2661

2048

2662

def enable(self):

2049

2663

self.enabled = True

2050

2664

2051

2665

def add_pipe(self, parent_pipe, proc):

2052

2666

# Call "handle_ipc" for both data and EOF events

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2059

2060

def handle_ipc(self, source, condition, parent_pipe=None,

2061

proc = None, client_object=None):

2667

GLib.io_add_watch(

2668

parent_pipe.fileno(),

2669

GLib.IO_IN | GLib.IO_HUP,

2670

functools.partial(self.handle_ipc,

2671

parent_pipe=parent_pipe,

2672

proc=proc))

2673

2674

def handle_ipc(self, source, condition,

2675

parent_pipe=None,

2676

proc=None,

2677

client_object=None):

2062

2678

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

2063

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

2679

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

2064

2680

# Wait for other process to exit

2065

2681

proc.join()

2066

2682

return False

2067

2683

2068

2684

# Read a request from the child

2069

2685

request = parent_pipe.recv()

2070

2686

command = request[0]

2071

2687

2072

2688

if command == 'init':

2073

fpr = request[1]

2074

address = request[2]

2075

2076

for c in self.clients.itervalues():

2077

if c.fingerprint == fpr:

2689

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

2690

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

2691

address = request[3]

2692

2693

for c in self.clients.values():

2694

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2695

continue

2696

if key_id and c.key_id == key_id:

2697

client = c

2698

break

2699

if fpr and c.fingerprint == fpr:

2078

2700

client = c

2079

2701

break

2080

2702

else:

2081

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

2082

"dress: %s", fpr, address)

2703

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

2704

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

2083

2705

if self.use_dbus:

2084

2706

# Emit D-Bus signal

2085

mandos_dbus_service.ClientNotFound(fpr,

2707

mandos_dbus_service.ClientNotFound(key_id or fpr,

2086

2708

address[0])

2087

2709

parent_pipe.send(False)

2088

2710

return False

2089

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2711

2712

GLib.io_add_watch(

2713

parent_pipe.fileno(),

2714

GLib.IO_IN | GLib.IO_HUP,

2715

functools.partial(self.handle_ipc,

2716

parent_pipe=parent_pipe,

2717

proc=proc,

2718

client_object=client))

2098

2719

parent_pipe.send(True)

2099

2720

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

2100

2721

# same fileno

2103

2724

funcname = request[1]

2104

2725

args = request[2]

2105

2726

kwargs = request[3]

2106

2727

2107

2728

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

2108

2729

funcname)(*args,

2109

**kwargs)))

2110

2730

**kwargs)))

2731

2111

2732

if command == 'getattr':

2112

2733

attrname = request[1]

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2734

if isinstance(client_object.__getattribute__(attrname),

2735

collections.Callable):

2736

parent_pipe.send(('function', ))

2115

2737

else:

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2738

parent_pipe.send((

2739

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

2740

2119

2741

if command == 'setattr':

2120

2742

attrname = request[1]

2121

2743

value = request[2]

2122

2744

setattr(client_object, attrname, value)

2123

2745

2124

2746

return True

2125

2747

2126

2748

2127

2749

def rfc3339_duration_to_delta(duration):

2128

2750

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

2129

2751

2130

2752

>>> rfc3339_duration_to_delta("P7D")

2131

2753

datetime.timedelta(7)

2132

2754

>>> rfc3339_duration_to_delta("PT60S")

2142

2764

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

2765

datetime.timedelta(1, 200)

2144

2766

"""

2145

2767

2146

2768

# Parsing an RFC 3339 duration with regular expressions is not

2147

2769

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

2148

2770

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

2149

2771

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

2150

2772

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

2151

2773

# avoid excessive use of external libraries.

2152

2774

2153

2775

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

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2776

Token = collections.namedtuple("Token", (

2777

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

2778

# a "group" containing digits

2779

"value", # datetime.timedelta or None

2780

"followers")) # Tokens valid after this token

2163

2781

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

2164

2782

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

2165

2783

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

2166

2784

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

2167

2785

datetime.timedelta(seconds=1),

2168

frozenset((token_end,)))

2786

frozenset((token_end, )))

2169

2787

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

2170

2788

datetime.timedelta(minutes=1),

2171

2789

frozenset((token_second, token_end)))

2187

2805

frozenset((token_month, token_end)))

2188

2806

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

2189

2807

datetime.timedelta(weeks=1),

2190

frozenset((token_end,)))

2808

frozenset((token_end, )))

2191

2809

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

2192

2810

frozenset((token_year, token_month,

2193

2811

token_day, token_time,

2194

2812

token_week)))

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2813

# Define starting values:

2814

# Value so far

2815

value = datetime.timedelta()

2197

2816

found_token = None

2198

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

2199

s = duration # String left to parse

2817

# Following valid tokens

2818

followers = frozenset((token_duration, ))

2819

# String left to parse

2820

s = duration

2200

2821

# Loop until end token is found

2201

2822

while found_token is not token_end:

2202

2823

# Search for any currently valid tokens

2218

2839

break

2219

2840

else:

2220

2841

# No currently valid tokens were found

2221

raise ValueError("Invalid RFC 3339 duration")

2842

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

2843

.format(duration))

2222

2844

# End token found

2223

2845

return value

2224

2846

2225

2847

2226

2848

def string_to_delta(interval):

2227

2849

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

2228

2850

2229

2851

>>> string_to_delta('7d')

2230

2852

datetime.timedelta(7)

2231

2853

>>> string_to_delta('60s')

2239

2861

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

2240

2862

datetime.timedelta(0, 330)

2241

2863

"""

2242

2864

2243

2865

try:

2244

2866

return rfc3339_duration_to_delta(interval)

2245

2867

except ValueError:

2246

2868

pass

2247

2869

2248

2870

timevalue = datetime.timedelta(0)

2249

2871

for s in interval.split():

2250

2872

try:

2261

2883

elif suffix == "w":

2262

2884

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

2263

2885

else:

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2886

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

2266

2887

except IndexError as e:

2267

2888

raise ValueError(*(e.args))

2268

2889

timevalue += delta

2269

2890

return timevalue

2270

2891

2271

2892

2272

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

2893

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

2273

2894

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

2274

2895

2275

2896

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

2276

2897

if os.fork():

2277

2898

sys.exit()

2284

2905

# Close all standard open file descriptors

2285

2906

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

2286

2907

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

2287

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

2908

raise OSError(errno.ENODEV,

2909

"{} not a character device"

2288

2910

.format(os.devnull))

2289

2911

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

2290

2912

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

2294

2916

2295

2917

2296

2918

def main():

2297

2919

2298

2920

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

2299

2921

# Parsing of options, both command line and config file

2300

2922

2301

2923

parser = argparse.ArgumentParser()

2302

2924

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

2303

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

2925

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

2304

2926

help="show version number and exit")

2305

2927

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

2306

2928

help="Bind to interface IF")

2342

2964

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

2343

2965

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

2344

2966

default=None)

2345

2967

2346

2968

options = parser.parse_args()

2347

2969

2348

2970

if options.check:

2349

2971

import doctest

2350

2972

fail_count, test_count = doctest.testmod()

2351

2973

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

2352

2974

2353

2975

# Default values for config file for server-global settings

2354

server_defaults = { "interface": "",

2355

"address": "",

2356

"port": "",

2357

"debug": "False",

2358

"priority":

2359

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2360

"servicename": "Mandos",

2361

"use_dbus": "True",

2362

"use_ipv6": "True",

2363

"debuglevel": "",

2364

"restore": "True",

2365

"socket": "",

2366

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

2367

"foreground": "False",

2368

"zeroconf": "True",

2369

}

2370

2976

if gnutls.has_rawpk:

2977

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

2978

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

2979

else:

2980

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

2981

":+SIGN-DSA-SHA256")

2982

server_defaults = {"interface": "",

2983

"address": "",

2984

"port": "",

2985

"debug": "False",

2986

"priority": priority,

2987

"servicename": "Mandos",

2988

"use_dbus": "True",

2989

"use_ipv6": "True",

2990

"debuglevel": "",

2991

"restore": "True",

2992

"socket": "",

2993

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

2994

"foreground": "False",

2995

"zeroconf": "True",

2996

}

2997

del priority

2998

2371

2999

# Parse config file for server-global settings

2372

3000

server_config = configparser.SafeConfigParser(server_defaults)

2373

3001

del server_defaults

2374

server_config.read(os.path.join(options.configdir,

2375

"mandos.conf"))

3002

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

2376

3003

# Convert the SafeConfigParser object to a dict

2377

3004

server_settings = server_config.defaults()

2378

3005

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

2379

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

3006

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

3007

"foreground", "zeroconf"):

2380

3008

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

2381

3009

option)

2382

3010

if server_settings["port"]:

2392

3020

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

2393

3021

["socket"])

2394

3022

del server_config

2395

3023

2396

3024

# Override the settings from the config file with command line

2397

3025

# options, if set.

2398

3026

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

2399

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

2400

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

2401

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

3027

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

3028

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

3029

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

2402

3030

value = getattr(options, option)

2403

3031

if value is not None:

2404

3032

server_settings[option] = value

2416

3044

if server_settings["debug"]:

2417

3045

server_settings["foreground"] = True

2418

3046

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

2419

3047

2420

3048

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

2421

2422

if (not server_settings["zeroconf"] and

2423

not (server_settings["port"]

2424

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

2425

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

2426

" Zeroconf")

2427

3049

3050

if (not server_settings["zeroconf"]

3051

and not (server_settings["port"]

3052

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

3053

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

3054

2428

3055

# For convenience

2429

3056

debug = server_settings["debug"]

2430

3057

debuglevel = server_settings["debuglevel"]

2434

3061

stored_state_file)

2435

3062

foreground = server_settings["foreground"]

2436

3063

zeroconf = server_settings["zeroconf"]

2437

3064

2438

3065

if debug:

2439

3066

initlogger(debug, logging.DEBUG)

2440

3067

else:

2443

3070

else:

2444

3071

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

2445

3072

initlogger(debug, level)

2446

3073

2447

3074

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

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3075

syslogger.setFormatter(

3076

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

3077

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

3078

server_settings["servicename"])))

3079

2454

3080

# Parse config file with clients

2455

3081

client_config = configparser.SafeConfigParser(Client

2456

3082

.client_defaults)

2457

3083

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

2458

3084

"clients.conf"))

2459

3085

2460

3086

global mandos_dbus_service

2461

3087

mandos_dbus_service = None

2462

3088

2463

3089

socketfd = None

2464

3090

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

2465

3091

socketfd = server_settings["socket"]

2466

tcp_server = MandosServer((server_settings["address"],

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

3092

tcp_server = MandosServer(

3093

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

3094

ClientHandler,

3095

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

3096

use_ipv6=use_ipv6,

3097

gnutls_priority=server_settings["priority"],

3098

use_dbus=use_dbus,

3099

socketfd=socketfd)

2476

3100

if not foreground:

2477

3101

pidfilename = "/run/mandos.pid"

2478

3102

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

2479

3103

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

2480

3104

pidfile = None

2481

3105

try:

2482

pidfile = open(pidfilename, "w")

3106

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

2483

3107

except IOError as e:

2484

3108

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

2485

3109

exc_info=e)

2486

2487

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

3110

3111

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

3112

("mandos", "mandos"),

3113

("nobody", "nogroup")):

2488

3114

try:

2489

3115

uid = pwd.getpwnam(name).pw_uid

2490

gid = pwd.getpwnam(name).pw_gid

3116

gid = pwd.getpwnam(group).pw_gid

2491

3117

break

2492

3118

except KeyError:

2493

3119

continue

2497

3123

try:

2498

3124

os.setgid(gid)

2499

3125

os.setuid(uid)

3126

if debug:

3127

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

3128

gid))

2500

3129

except OSError as error:

3130

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

3131

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

2501

3132

if error.errno != errno.EPERM:

2502

3133

raise

2503

3134

2504

3135

if debug:

2505

3136

# Enable all possible GnuTLS debugging

2506

3137

2507

3138

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

2508

3139

# - GnuTLS manual

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3140

gnutls.global_set_log_level(11)

3141

3142

@gnutls.log_func

2512

3143

def debug_gnutls(level, string):

2513

3144

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

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3145

3146

gnutls.global_set_log_function(debug_gnutls)

3147

2518

3148

# Redirect stdin so all checkers get /dev/null

2519

3149

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

2520

3150

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

2521

3151

if null > 2:

2522

3152

os.close(null)

2523

3153

2524

3154

# Need to fork before connecting to D-Bus

2525

3155

if not foreground:

2526

3156

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

2527

3157

daemon()

2528

2529

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

2530

# need to inform gobject that threads will be used.

2531

gobject.threads_init()

2532

3158

3159

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

3160

# to inform GLib that threads will be used.

3161

GLib.threads_init()

3162

2533

3163

global main_loop

2534

3164

# From the Avahi example code

2535

3165

DBusGMainLoop(set_as_default=True)

2536

main_loop = gobject.MainLoop()

3166

main_loop = GLib.MainLoop()

2537

3167

bus = dbus.SystemBus()

2538

3168

# End of Avahi example code

2539

3169

if use_dbus:

2540

3170

try:

2541

3171

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

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

3172

bus,

3173

do_not_queue=True)

3174

old_bus_name = dbus.service.BusName(

3175

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

3176

do_not_queue=True)

3177

except dbus.exceptions.DBusException as e:

2547

3178

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

2548

3179

use_dbus = False

2549

3180

server_settings["use_dbus"] = False

2550

3181

tcp_server.use_dbus = False

2551

3182

if zeroconf:

2552

3183

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3184

service = AvahiServiceToSyslog(

3185

name=server_settings["servicename"],

3186

servicetype="_mandos._tcp",

3187

protocol=protocol,

3188

bus=bus)

2557

3189

if server_settings["interface"]:

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3190

service.interface = if_nametoindex(

3191

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

3192

2562

3193

global multiprocessing_manager

2563

3194

multiprocessing_manager = multiprocessing.Manager()

2564

3195

2565

3196

client_class = Client

2566

3197

if use_dbus:

2567

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

2568

3198

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

3199

2569

3200

client_settings = Client.config_parser(client_config)

2570

3201

old_client_settings = {}

2571

3202

clients_data = {}

2572

3203

2573

3204

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

2574

3205

global wnull

2575

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

3206

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

2576

3207

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

2577

3208

# mode

2578

3209

if debug or not foreground:

2579

3210

wnull.close()

2580

3211

2581

3212

# Get client data and settings from last running state.

2582

3213

if server_settings["restore"]:

2583

3214

try:

2584

3215

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

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3216

if sys.version_info.major == 2:

3217

clients_data, old_client_settings = pickle.load(

3218

stored_state)

3219

else:

3220

bytes_clients_data, bytes_old_client_settings = (

3221

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

3222

# Fix bytes to strings

3223

# clients_data

3224

# .keys()

3225

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

3226

if isinstance(key, bytes)

3227

else key): value

3228

for key, value in

3229

bytes_clients_data.items()}

3230

del bytes_clients_data

3231

for key in clients_data:

3232

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

3233

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

3234

for k, v in

3235

clients_data[key].items()}

3236

clients_data[key] = value

3237

# .client_structure

3238

value["client_structure"] = [

3239

(s.decode("utf-8")

3240

if isinstance(s, bytes)

3241

else s) for s in

3242

value["client_structure"]]

3243

# .name & .host

3244

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

3245

if isinstance(value[k], bytes):

3246

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

3247

if not value.has_key("key_id"):

3248

value["key_id"] = ""

3249

elif not value.has_key("fingerprint"):

3250

value["fingerprint"] = ""

3251

# old_client_settings

3252

# .keys()

3253

old_client_settings = {

3254

(key.decode("utf-8")

3255

if isinstance(key, bytes)

3256

else key): value

3257

for key, value in

3258

bytes_old_client_settings.items()}

3259

del bytes_old_client_settings

3260

# .host

3261

for value in old_client_settings.values():

3262

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

3263

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

3264

.decode("utf-8"))

2587

3265

os.remove(stored_state_path)

2588

3266

except IOError as e:

2589

3267

if e.errno == errno.ENOENT:

2590

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

2591

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

3268

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

3269

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

2592

3270

else:

2593

3271

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

2594

3272

exc_info=e)

2595

3273

raise

2596

3274

except EOFError as e:

2597

3275

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

2598

"EOFError:", exc_info=e)

2599

3276

"EOFError:",

3277

exc_info=e)

3278

2600

3279

with PGPEngine() as pgp:

2601

3280

for client_name, client in clients_data.items():

2602

3281

# Skip removed clients

2603

3282

if client_name not in client_settings:

2604

3283

continue

2605

3284

2606

3285

# Decide which value to use after restoring saved state.

2607

3286

# We have three different values: Old config file,

2608

3287

# new config file, and saved state.

2613

3292

# For each value in new config, check if it

2614

3293

# differs from the old config value (Except for

2615

3294

# the "secret" attribute)

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3295

if (name != "secret"

3296

and (value !=

3297

old_client_settings[client_name][name])):

2619

3298

client[name] = value

2620

3299

except KeyError:

2621

3300

pass

2622

3301

2623

3302

# Clients who has passed its expire date can still be

2624

# enabled if its last checker was successful. Clients

3303

# enabled if its last checker was successful. A Client

2625

3304

# whose checker succeeded before we stored its state is

2626

3305

# assumed to have successfully run all checkers during

2627

3306

# downtime.

2630

3309

if not client["last_checked_ok"]:

2631

3310

logger.warning(

2632

3311

"disabling client {} - Client never "

2633

"performed a successful checker"

2634

.format(client_name))

3312

"performed a successful checker".format(

3313

client_name))

2635

3314

client["enabled"] = False

2636

3315

elif client["last_checker_status"] != 0:

2637

3316

logger.warning(

2638

3317

"disabling client {} - Client last"

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3318

" checker failed with error code"

3319

" {}".format(

3320

client_name,

3321

client["last_checker_status"]))

2642

3322

client["enabled"] = False

2643

3323

else:

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3324

client["expires"] = (

3325

datetime.datetime.utcnow()

3326

+ client["timeout"])

2647

3327

logger.debug("Last checker succeeded,"

2648

" keeping {} enabled"

2649

.format(client_name))

3328

" keeping {} enabled".format(

3329

client_name))

2650

3330

try:

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3331

client["secret"] = pgp.decrypt(

3332

client["encrypted_secret"],

3333

client_settings[client_name]["secret"])

2655

3334

except PGPError:

2656

3335

# If decryption fails, we use secret from new settings

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3336

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

3337

client_name))

3338

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

3339

["secret"])

3340

2662

3341

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

2663

3342

for client_name in (set(old_client_settings)

2664

3343

- set(client_settings)):

2666

3345

for client_name in (set(client_settings)

2667

3346

- set(old_client_settings)):

2668

3347

clients_data[client_name] = client_settings[client_name]

2669

3348

2670

3349

# Create all client objects

2671

3350

for client_name, client in clients_data.items():

2672

3351

tcp_server.clients[client_name] = client_class(

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3352

name=client_name,

3353

settings=client,

3354

server_settings=server_settings)

3355

2676

3356

if not tcp_server.clients:

2677

3357

logger.warning("No clients defined")

2678

3358

2679

3359

if not foreground:

2680

3360

if pidfile is not None:

3361

pid = os.getpid()

2681

3362

try:

2682

3363

with pidfile:

2683

pid = os.getpid()

2684

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

3364

print(pid, file=pidfile)

2685

3365

except IOError:

2686

3366

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

2687

3367

pidfilename, pid)

2688

3368

del pidfile

2689

3369

del pidfilename

2690

2691

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

2692

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

2693

3370

3371

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

3372

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3373

lambda: main_loop.quit() and False)

3374

2694

3375

if use_dbus:

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3376

3377

@alternate_dbus_interfaces(

3378

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

3379

class MandosDBusService(DBusObjectWithObjectManager):

2698

3380

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

3381

2699

3382

def __init__(self):

2700

3383

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

3384

2701

3385

_interface = "se.recompile.Mandos"

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3386

2709

3387

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

2710

3388

def ClientAdded(self, objpath):

2711

3389

"D-Bus signal"

2712

3390

pass

2713

3391

2714

3392

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

2715

def ClientNotFound(self, fingerprint, address):

3393

def ClientNotFound(self, key_id, address):

2716

3394

"D-Bus signal"

2717

3395

pass

2718

3396

3397

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

3398

"true"})

2719

3399

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

2720

3400

def ClientRemoved(self, objpath, name):

2721

3401

"D-Bus signal"

2722

3402

pass

2723

3403

3404

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

3405

"true"})

2724

3406

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

2725

3407

def GetAllClients(self):

2726

3408

"D-Bus method"

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3409

return dbus.Array(c.dbus_object_path for c in

3410

tcp_server.clients.values())

3411

3412

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

3413

"true"})

2731

3414

@dbus.service.method(_interface,

2732

3415

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

2733

3416

def GetAllClientsWithProperties(self):

2734

3417

"D-Bus method"

2735

3418

return dbus.Dictionary(

2736

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

2737

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

3419

{c.dbus_object_path: c.GetAll(

3420

"se.recompile.Mandos.Client")

3421

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

2738

3422

signature="oa{sv}")

2739

3423

2740

3424

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

2741

3425

def RemoveClient(self, object_path):

2742

3426

"D-Bus method"

2743

for c in tcp_server.clients.itervalues():

3427

for c in tcp_server.clients.values():

2744

3428

if c.dbus_object_path == object_path:

2745

3429

del tcp_server.clients[c.name]

2746

3430

c.remove_from_connection()

2747

# Don't signal anything except ClientRemoved

3431

# Don't signal the disabling

2748

3432

c.disable(quiet=True)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3433

# Emit D-Bus signal for removal

3434

self.client_removed_signal(c)

2751

3435

return

2752

3436

raise KeyError(object_path)

2753

3437

2754

3438

del _interface

2755

3439

3440

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3441

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

3442

def GetManagedObjects(self):

3443

"""D-Bus method"""

3444

return dbus.Dictionary(

3445

{client.dbus_object_path:

3446

dbus.Dictionary(

3447

{interface: client.GetAll(interface)

3448

for interface in

3449

client._get_all_interface_names()})

3450

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

3451

3452

def client_added_signal(self, client):

3453

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

3454

if use_dbus:

3455

# New standard signal

3456

self.InterfacesAdded(

3457

client.dbus_object_path,

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()}))

3462

# Old signal

3463

self.ClientAdded(client.dbus_object_path)

3464

3465

def client_removed_signal(self, client):

3466

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

3467

if use_dbus:

3468

# New standard signal

3469

self.InterfacesRemoved(

3470

client.dbus_object_path,

3471

client._get_all_interface_names())

3472

# Old signal

3473

self.ClientRemoved(client.dbus_object_path,

3474

client.name)

3475

2756

3476

mandos_dbus_service = MandosDBusService()

2757

3477

3478

# Save modules to variables to exempt the modules from being

3479

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

3480

mp = multiprocessing

3481

wn = wnull

3482

2758

3483

def cleanup():

2759

3484

"Cleanup function; run on exit"

2760

3485

if zeroconf:

2761

3486

service.cleanup()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3487

3488

mp.active_children()

3489

wn.close()

2765

3490

if not (tcp_server.clients or client_settings):

2766

3491

return

2767

3492

2768

3493

# Store client before exiting. Secrets are encrypted with key

2769

3494

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

2770

3495

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

2771

3496

clients = {}

2772

3497

with PGPEngine() as pgp:

2773

for client in tcp_server.clients.itervalues():

3498

for client in tcp_server.clients.values():

2774

3499

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

2775

3500

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

2776

3501

key)

2777

3502

client_dict = {}

2778

3503

2779

3504

# A list of attributes that can not be pickled

2780

3505

# + secret.

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3506

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

3507

"checker", "server_settings"}

3508

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

3509

.Object):

2785

3510

exclude.add(name)

2786

3511

2787

3512

client_dict["encrypted_secret"] = (client

2788

3513

.encrypted_secret)

2789

3514

for attr in client.client_structure:

2790

3515

if attr not in exclude:

2791

3516

client_dict[attr] = getattr(client, attr)

2792

3517

2793

3518

clients[client.name] = client_dict

2794

3519

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

2795

3520

2796

3521

try:

2797

with (tempfile.NamedTemporaryFile

2798

(mode='wb', suffix=".pickle", prefix='clients-',

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3522

with tempfile.NamedTemporaryFile(

3523

mode='wb',

3524

suffix=".pickle",

3525

prefix='clients-',

3526

dir=os.path.dirname(stored_state_path),

3527

delete=False) as stored_state:

3528

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

3529

protocol=2)

3530

tempname = stored_state.name

2803

3531

os.rename(tempname, stored_state_path)

2804

3532

except (IOError, OSError) as e:

2805

3533

if not debug:

2814

3542

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

2815

3543

exc_info=e)

2816

3544

raise

2817

3545

2818

3546

# Delete all clients, and settings from config

2819

3547

while tcp_server.clients:

2820

3548

name, client = tcp_server.clients.popitem()

2821

3549

if use_dbus:

2822

3550

client.remove_from_connection()

2823

# Don't signal anything except ClientRemoved

3551

# Don't signal the disabling

2824

3552

client.disable(quiet=True)

3553

# Emit D-Bus signal for removal

2825

3554

if use_dbus:

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3555

mandos_dbus_service.client_removed_signal(client)

2830

3556

client_settings.clear()

2831

3557

2832

3558

atexit.register(cleanup)

2833

2834

for client in tcp_server.clients.itervalues():

3559

3560

for client in tcp_server.clients.values():

2835

3561

if use_dbus:

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3562

# Emit D-Bus signal for adding

3563

mandos_dbus_service.client_added_signal(client)

2838

3564

# Need to initiate checking of clients

2839

3565

if client.enabled:

2840

3566

client.init_checker()

2841

3567

2842

3568

tcp_server.enable()

2843

3569

tcp_server.server_activate()

2844

3570

2845

3571

# Find out what port we got

2846

3572

if zeroconf:

2847

3573

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

2852

3578

else: # IPv4

2853

3579

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

2854

3580

*tcp_server.socket.getsockname())

2855

2856

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

2857

3581

3582

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

3583

2858

3584

try:

2859

3585

if zeroconf:

2860

3586

# From the Avahi example code

2865

3591

cleanup()

2866

3592

sys.exit(1)

2867

3593

# End of Avahi example code

2868

2869

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

2870

lambda *args, **kwargs:

2871

(tcp_server.handle_request

2872

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

2873

3594

3595

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

3596

lambda *args, **kwargs:

3597

(tcp_server.handle_request

3598

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

3599

2874

3600

logger.debug("Starting main loop")

2875

3601

main_loop.run()

2876

3602

except AvahiError as error:

2885

3611

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

2886

3612

cleanup()

2887

3613

3614

2888

3615

if __name__ == '__main__':

2889

3616

main()