/mandos/release : revision 237.7.392

11

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

12

#

13

# Everything else is

14

15

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

28

# along with this program. If not, see

29

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

30

#

31

# Contact the authors at <mandos@fukt.bsnet.se>.

31

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

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

38

46

import socket

39

47

import argparse

40

48

import datetime

41

49

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

49

54

import sys

50

55

import re

51

56

import os

60

65

import struct

61

66

import fcntl

62

67

import functools

63

import cPickle as pickle

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

64

72

import multiprocessing

73

import types

74

import binascii

75

import tempfile

76

import itertools

77

import collections

78

import codecs

65

79

66

80

import dbus

67

81

import dbus.service

68

import gobject

69

import avahi

82

from gi.repository import GLib

70

83

from dbus.mainloop.glib import DBusGMainLoop

71

84

import ctypes

72

85

import ctypes.util

81

94

except ImportError:

82

95

SO_BINDTODEVICE = None

83

96

84

85

version = "1.3.0"

86

87

#logger = logging.getLogger('mandos')

88

logger = logging.Logger('mandos')

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

address = str("/dev/log")))

92

syslogger.setFormatter(logging.Formatter

93

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

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'

99

' %(levelname)s:'

100

' %(message)s'))

101

logger.addHandler(console)

97

if sys.version_info.major == 2:

98

str = unicode

99

100

version = "1.7.7"

101

stored_state_file = "clients.pickle"

102

103

logger = logging.getLogger()

104

syslogger = None

105

106

try:

107

if_nametoindex = ctypes.cdll.LoadLibrary(

108

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

109

except (OSError, AttributeError):

110

111

def if_nametoindex(interface):

112

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

113

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

114

with contextlib.closing(socket.socket()) as s:

115

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

116

struct.pack(b"16s16x", interface))

117

interface_index = struct.unpack("I", ifreq[16:20])[0]

118

return interface_index

119

120

121

def copy_function(func):

122

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

123

if sys.version_info.major == 2:

124

return types.FunctionType(func.func_code,

125

func.func_globals,

126

func.func_name,

127

func.func_defaults,

128

func.func_closure)

129

else:

130

return types.FunctionType(func.__code__,

131

func.__globals__,

132

func.__name__,

133

func.__defaults__,

134

func.__closure__)

135

136

137

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

138

"""init logger and add loglevel"""

139

140

global syslogger

141

syslogger = (logging.handlers.SysLogHandler(

142

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

143

address = "/dev/log"))

144

syslogger.setFormatter(logging.Formatter

145

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

146

' %(message)s'))

147

logger.addHandler(syslogger)

148

149

if debug:

150

console = logging.StreamHandler()

151

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

152

' [%(process)d]:'

153

' %(levelname)s:'

154

' %(message)s'))

155

logger.addHandler(console)

156

logger.setLevel(level)

157

158

159

class PGPError(Exception):

160

"""Exception if encryption/decryption fails"""

161

pass

162

163

164

class PGPEngine(object):

165

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

166

167

def __init__(self):

168

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

169

self.gpg = "gpg"

170

try:

171

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

172

for line in output.splitlines():

173

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

174

if name == "gpg":

175

self.gpg = path

176

break

177

except OSError as e:

178

if e.errno != errno.ENOENT:

179

raise

180

self.gnupgargs = ['--batch',

181

'--homedir', self.tempdir,

182

'--force-mdc',

183

'--quiet',

184

'--no-use-agent']

185

186

def __enter__(self):

187

return self

188

189

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

190

self._cleanup()

191

return False

192

193

def __del__(self):

194

self._cleanup()

195

196

def _cleanup(self):

197

if self.tempdir is not None:

198

# Delete contents of tempdir

199

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

200

topdown = False):

201

for filename in files:

202

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

203

for dirname in dirs:

204

os.rmdir(os.path.join(root, dirname))

205

# Remove tempdir

206

os.rmdir(self.tempdir)

207

self.tempdir = None

208

209

def password_encode(self, password):

210

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

211

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

212

encoded = b"mandos" + binascii.hexlify(password)

213

if len(encoded) > 2048:

214

# GnuPG can't handle long passwords, so encode differently

215

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

216

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

217

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

218

return encoded

219

220

def encrypt(self, data, password):

221

passphrase = self.password_encode(password)

222

with tempfile.NamedTemporaryFile(

223

dir=self.tempdir) as passfile:

224

passfile.write(passphrase)

225

passfile.flush()

226

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

227

'--passphrase-file',

228

passfile.name]

229

+ self.gnupgargs,

230

stdin = subprocess.PIPE,

231

stdout = subprocess.PIPE,

232

stderr = subprocess.PIPE)

233

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

234

if proc.returncode != 0:

235

raise PGPError(err)

236

return ciphertext

237

238

def decrypt(self, data, password):

239

passphrase = self.password_encode(password)

240

with tempfile.NamedTemporaryFile(

241

dir = self.tempdir) as passfile:

242

passfile.write(passphrase)

243

passfile.flush()

244

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

245

'--passphrase-file',

246

passfile.name]

247

+ self.gnupgargs,

248

stdin = subprocess.PIPE,

249

stdout = subprocess.PIPE,

250

stderr = subprocess.PIPE)

251

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

252

if proc.returncode != 0:

253

raise PGPError(err)

254

return decrypted_plaintext

255

256

# Pretend that we have an Avahi module

257

class Avahi(object):

258

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

259

It is instantiated once, and simulates having an Avahi module."""

260

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

261

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

262

PROTO_INET = 0 # avahi-common/address.h

263

PROTO_INET6 = 1 # avahi-common/address.h

264

DBUS_NAME = "org.freedesktop.Avahi"

265

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

266

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

267

DBUS_PATH_SERVER = "/"

268

def string_array_to_txt_array(self, t):

269

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

270

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

271

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

272

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

273

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

274

SERVER_INVALID = 0 # avahi-common/defs.h

275

SERVER_REGISTERING = 1 # avahi-common/defs.h

276

SERVER_RUNNING = 2 # avahi-common/defs.h

277

SERVER_COLLISION = 3 # avahi-common/defs.h

278

SERVER_FAILURE = 4 # avahi-common/defs.h

279

avahi = Avahi()

102

280

103

281

class AvahiError(Exception):

104

282

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

105

283

self.value = value

106

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

107

def __unicode__(self):

108

return unicode(repr(self.value))

284

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

285

**kwargs)

286

109

287

110

288

class AvahiServiceError(AvahiError):

111

289

pass

112

290

291

113

292

class AvahiGroupError(AvahiError):

114

293

pass

115

294

122

301

Used to optionally bind to the specified interface.

123

302

name: string; Example: 'Mandos'

124

303

type: string; Example: '_mandos._tcp'.

125

See <http://www.dns-sd.org/ServiceTypes.html>

304

See <https://www.iana.org/assignments/service-names-port-numbers>

126

305

port: integer; what port to announce

127

306

TXT: list of strings; TXT record for the service

128

307

domain: string; Domain to publish on, default to .local if empty.

134

313

server: D-Bus Server

135

314

bus: dbus.SystemBus()

136

315

"""

137

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

138

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

139

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

140

protocol = avahi.PROTO_UNSPEC, bus = None):

316

317

def __init__(self,

318

interface = avahi.IF_UNSPEC,

319

name = None,

320

servicetype = None,

321

port = None,

322

TXT = None,

323

domain = "",

324

host = "",

325

max_renames = 32768,

326

protocol = avahi.PROTO_UNSPEC,

327

bus = None):

141

328

self.interface = interface

142

329

self.name = name

143

330

self.type = servicetype

152

339

self.server = None

153

340

self.bus = bus

154

341

self.entry_group_state_changed_match = None

155

def rename(self):

342

343

def rename(self, remove=True):

156

344

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

157

345

if self.rename_count >= self.max_renames:

158

346

logger.critical("No suitable Zeroconf service name found"

159

347

" after %i retries, exiting.",

160

348

self.rename_count)

161

349

raise AvahiServiceError("Too many renames")

162

self.name = unicode(self.server.GetAlternativeServiceName(self.name))

350

self.name = str(

351

self.server.GetAlternativeServiceName(self.name))

352

self.rename_count += 1

163

353

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

164

354

self.name)

165

syslogger.setFormatter(logging.Formatter

166

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

167

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

168

% self.name))

169

self.remove()

355

if remove:

356

self.remove()

170

357

try:

171

358

self.add()

172

359

except dbus.exceptions.DBusException as error:

173

logger.critical("DBusException: %s", error)

174

self.cleanup()

175

os._exit(1)

176

self.rename_count += 1

360

if (error.get_dbus_name()

361

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

362

logger.info("Local Zeroconf service name collision.")

363

return self.rename(remove=False)

364

else:

365

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

366

self.cleanup()

367

os._exit(1)

368

177

369

def remove(self):

178

370

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

179

if self.group is not None:

180

try:

181

self.group.Free()

182

except (dbus.exceptions.UnknownMethodException,

183

dbus.exceptions.DBusException) as e:

184

pass

185

self.group = None

186

371

if self.entry_group_state_changed_match is not None:

187

372

self.entry_group_state_changed_match.remove()

188

373

self.entry_group_state_changed_match = None

374

if self.group is not None:

375

self.group.Reset()

376

189

377

def add(self):

190

378

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

191

379

self.remove()

192

self.group = dbus.Interface(

193

self.bus.get_object(avahi.DBUS_NAME,

194

self.server.EntryGroupNew(),

195

follow_name_owner_changes=True),

196

avahi.DBUS_INTERFACE_ENTRY_GROUP)

380

if self.group is None:

381

self.group = dbus.Interface(

382

self.bus.get_object(avahi.DBUS_NAME,

383

self.server.EntryGroupNew()),

384

avahi.DBUS_INTERFACE_ENTRY_GROUP)

197

385

self.entry_group_state_changed_match = (

198

386

self.group.connect_to_signal(

199

'StateChanged', self .entry_group_state_changed))

387

'StateChanged', self.entry_group_state_changed))

200

388

logger.debug("Adding Zeroconf service '%s' of type '%s' ...",

201

389

self.name, self.type)

202

390

self.group.AddService(

208

396

dbus.UInt16(self.port),

209

397

avahi.string_array_to_txt_array(self.TXT))

210

398

self.group.Commit()

399

211

400

def entry_group_state_changed(self, state, error):

212

401

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

213

402

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

219

408

self.rename()

220

409

elif state == avahi.ENTRY_GROUP_FAILURE:

221

410

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

222

unicode(error))

223

raise AvahiGroupError("State changed: %s"

224

% unicode(error))

411

str(error))

412

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

413

225

414

def cleanup(self):

226

415

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

416

if self.group is not None:

417

try:

418

self.group.Free()

419

except (dbus.exceptions.UnknownMethodException,

420

dbus.exceptions.DBusException):

421

pass

422

self.group = None

227

423

self.remove()

424

228

425

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

229

426

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

230

427

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

231

bad_states = { avahi.SERVER_INVALID:

232

"Zeroconf server invalid",

233

avahi.SERVER_REGISTERING: None,

234

avahi.SERVER_COLLISION:

235

"Zeroconf server name collision",

236

avahi.SERVER_FAILURE:

237

"Zeroconf server failure" }

428

bad_states = {

429

avahi.SERVER_INVALID: "Zeroconf server invalid",

430

avahi.SERVER_REGISTERING: None,

431

avahi.SERVER_COLLISION: "Zeroconf server name collision",

432

avahi.SERVER_FAILURE: "Zeroconf server failure",

433

}

238

434

if state in bad_states:

239

if bad_states[state]:

240

logger.error(bad_states[state])

241

self.remove()

435

if bad_states[state] is not None:

436

if error is None:

437

logger.error(bad_states[state])

438

else:

439

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

440

self.cleanup()

242

441

elif state == avahi.SERVER_RUNNING:

243

self.add()

442

try:

443

self.add()

444

except dbus.exceptions.DBusException as error:

445

if (error.get_dbus_name()

446

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

447

logger.info("Local Zeroconf service name"

448

" collision.")

449

return self.rename(remove=False)

450

else:

451

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

452

self.cleanup()

453

os._exit(1)

244

454

else:

245

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

455

if error is None:

456

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

457

else:

458

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

459

246

460

def activate(self):

247

461

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

248

462

if self.server is None:

252

466

follow_name_owner_changes=True),

253

467

avahi.DBUS_INTERFACE_SERVER)

254

468

self.server.connect_to_signal("StateChanged",

255

self.server_state_changed)

469

self.server_state_changed)

256

470

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

257

471

258

472

473

class AvahiServiceToSyslog(AvahiService):

474

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

475

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

476

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

477

syslogger.setFormatter(logging.Formatter(

478

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

479

.format(self.name)))

480

return ret

481

482

# Pretend that we have a GnuTLS module

483

class GnuTLS(object):

484

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

485

It is instantiated once, and simulates having a GnuTLS module."""

486

487

_library = ctypes.cdll.LoadLibrary(

488

ctypes.util.find_library("gnutls"))

489

_need_version = b"3.3.0"

490

def __init__(self):

491

# Need to use class name "GnuTLS" here, since this method is

492

# called before the assignment to the "gnutls" global variable

493

# happens.

494

if GnuTLS.check_version(self._need_version) is None:

495

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

496

.format(self._need_version))

497

498

# Unless otherwise indicated, the constants and types below are

499

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

500

501

# Constants

502

E_SUCCESS = 0

503

E_INTERRUPTED = -52

504

E_AGAIN = -28

505

CRT_OPENPGP = 2

506

CLIENT = 2

507

SHUT_RDWR = 0

508

CRD_CERTIFICATE = 1

509

E_NO_CERTIFICATE_FOUND = -49

510

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

511

512

# Types

513

class session_int(ctypes.Structure):

514

_fields_ = []

515

session_t = ctypes.POINTER(session_int)

516

class certificate_credentials_st(ctypes.Structure):

517

_fields_ = []

518

certificate_credentials_t = ctypes.POINTER(

519

certificate_credentials_st)

520

certificate_type_t = ctypes.c_int

521

class datum_t(ctypes.Structure):

522

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

523

('size', ctypes.c_uint)]

524

class openpgp_crt_int(ctypes.Structure):

525

_fields_ = []

526

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

527

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

528

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

529

credentials_type_t = ctypes.c_int

530

transport_ptr_t = ctypes.c_void_p

531

close_request_t = ctypes.c_int

532

533

# Exceptions

534

class Error(Exception):

535

# We need to use the class name "GnuTLS" here, since this

536

# exception might be raised from within GnuTLS.__init__,

537

# which is called before the assignment to the "gnutls"

538

# global variable has happened.

539

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

540

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

541

# code is passed, convert it to a string with

542

# gnutls.strerror()

543

self.code = code

544

if message is None and code is not None:

545

message = GnuTLS.strerror(code)

546

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

547

message, *args)

548

549

class CertificateSecurityError(Error):

550

pass

551

552

# Classes

553

class Credentials(object):

554

def __init__(self):

555

self._c_object = gnutls.certificate_credentials_t()

556

gnutls.certificate_allocate_credentials(

557

ctypes.byref(self._c_object))

558

self.type = gnutls.CRD_CERTIFICATE

559

560

def __del__(self):

561

gnutls.certificate_free_credentials(self._c_object)

562

563

class ClientSession(object):

564

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

565

self._c_object = gnutls.session_t()

566

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

567

gnutls.set_default_priority(self._c_object)

568

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

569

gnutls.handshake_set_private_extensions(self._c_object,

570

True)

571

self.socket = socket

572

if credentials is None:

573

credentials = gnutls.Credentials()

574

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

575

ctypes.cast(credentials._c_object,

576

ctypes.c_void_p))

577

self.credentials = credentials

578

579

def __del__(self):

580

gnutls.deinit(self._c_object)

581

582

def handshake(self):

583

return gnutls.handshake(self._c_object)

584

585

def send(self, data):

586

data = bytes(data)

587

data_len = len(data)

588

while data_len > 0:

589

data_len -= gnutls.record_send(self._c_object,

590

data[-data_len:],

591

data_len)

592

593

def bye(self):

594

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

595

596

# Error handling functions

597

def _error_code(result):

598

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

599

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

600

if result >= 0:

601

return result

602

if result == gnutls.E_NO_CERTIFICATE_FOUND:

603

raise gnutls.CertificateSecurityError(code = result)

604

raise gnutls.Error(code = result)

605

606

def _retry_on_error(result, func, arguments):

607

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

608

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

609

while result < 0:

610

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

611

return _error_code(result)

612

result = func(*arguments)

613

return result

614

615

# Unless otherwise indicated, the function declarations below are

616

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

617

618

# Functions

619

priority_set_direct = _library.gnutls_priority_set_direct

620

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

621

ctypes.POINTER(ctypes.c_char_p)]

622

priority_set_direct.restype = _error_code

623

624

init = _library.gnutls_init

625

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

626

init.restype = _error_code

627

628

set_default_priority = _library.gnutls_set_default_priority

629

set_default_priority.argtypes = [session_t]

630

set_default_priority.restype = _error_code

631

632

record_send = _library.gnutls_record_send

633

record_send.argtypes = [session_t, ctypes.c_void_p,

634

ctypes.c_size_t]

635

record_send.restype = ctypes.c_ssize_t

636

record_send.errcheck = _retry_on_error

637

638

certificate_allocate_credentials = (

639

_library.gnutls_certificate_allocate_credentials)

640

certificate_allocate_credentials.argtypes = [

641

ctypes.POINTER(certificate_credentials_t)]

642

certificate_allocate_credentials.restype = _error_code

643

644

certificate_free_credentials = (

645

_library.gnutls_certificate_free_credentials)

646

certificate_free_credentials.argtypes = [certificate_credentials_t]

647

certificate_free_credentials.restype = None

648

649

handshake_set_private_extensions = (

650

_library.gnutls_handshake_set_private_extensions)

651

handshake_set_private_extensions.argtypes = [session_t,

652

ctypes.c_int]

653

handshake_set_private_extensions.restype = None

654

655

credentials_set = _library.gnutls_credentials_set

656

credentials_set.argtypes = [session_t, credentials_type_t,

657

ctypes.c_void_p]

658

credentials_set.restype = _error_code

659

660

strerror = _library.gnutls_strerror

661

strerror.argtypes = [ctypes.c_int]

662

strerror.restype = ctypes.c_char_p

663

664

certificate_type_get = _library.gnutls_certificate_type_get

665

certificate_type_get.argtypes = [session_t]

666

certificate_type_get.restype = _error_code

667

668

certificate_get_peers = _library.gnutls_certificate_get_peers

669

certificate_get_peers.argtypes = [session_t,

670

ctypes.POINTER(ctypes.c_uint)]

671

certificate_get_peers.restype = ctypes.POINTER(datum_t)

672

673

global_set_log_level = _library.gnutls_global_set_log_level

674

global_set_log_level.argtypes = [ctypes.c_int]

675

global_set_log_level.restype = None

676

677

global_set_log_function = _library.gnutls_global_set_log_function

678

global_set_log_function.argtypes = [log_func]

679

global_set_log_function.restype = None

680

681

deinit = _library.gnutls_deinit

682

deinit.argtypes = [session_t]

683

deinit.restype = None

684

685

handshake = _library.gnutls_handshake

686

handshake.argtypes = [session_t]

687

handshake.restype = _error_code

688

handshake.errcheck = _retry_on_error

689

690

transport_set_ptr = _library.gnutls_transport_set_ptr

691

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

692

transport_set_ptr.restype = None

693

694

bye = _library.gnutls_bye

695

bye.argtypes = [session_t, close_request_t]

696

bye.restype = _error_code

697

bye.errcheck = _retry_on_error

698

699

check_version = _library.gnutls_check_version

700

check_version.argtypes = [ctypes.c_char_p]

701

check_version.restype = ctypes.c_char_p

702

703

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

704

705

openpgp_crt_init = _library.gnutls_openpgp_crt_init

706

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

707

openpgp_crt_init.restype = _error_code

708

709

openpgp_crt_import = _library.gnutls_openpgp_crt_import

710

openpgp_crt_import.argtypes = [openpgp_crt_t,

711

ctypes.POINTER(datum_t),

712

openpgp_crt_fmt_t]

713

openpgp_crt_import.restype = _error_code

714

715

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

716

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

717

ctypes.POINTER(ctypes.c_uint)]

718

openpgp_crt_verify_self.restype = _error_code

719

720

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

721

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

722

openpgp_crt_deinit.restype = None

723

724

openpgp_crt_get_fingerprint = (

725

_library.gnutls_openpgp_crt_get_fingerprint)

726

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

727

ctypes.c_void_p,

728

ctypes.POINTER(

729

ctypes.c_size_t)]

730

openpgp_crt_get_fingerprint.restype = _error_code

731

732

# Remove non-public functions

733

del _error_code, _retry_on_error

734

# Create the global "gnutls" object, simulating a module

735

gnutls = GnuTLS()

736

737

def call_pipe(connection, # : multiprocessing.Connection

738

func, *args, **kwargs):

739

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

740

741

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

742

return value on the provided multiprocessing.Connection.

743

"""

744

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

745

connection.close()

746

259

747

class Client(object):

260

748

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

261

749

262

750

Attributes:

263

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

751

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

264

752

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

265

753

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

266

754

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

267

755

to see if the client lives.

268

756

'None' if no process is running.

269

checker_callback_tag: a gobject event source tag, or None

757

checker_callback_tag: a GLib event source tag, or None

270

758

checker_command: string; External command which is run to check

271

759

if client lives. %() expansions are done at

272

760

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

273

761

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

274

checker_initiator_tag: a gobject event source tag, or None

762

checker_initiator_tag: a GLib event source tag, or None

275

763

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

764

client_structure: Object describing what attributes a client has

765

and is used for storing the client at exit

276

766

current_checker_command: string; current running checker_command

277

disable_hook: If set, called by disable() as disable_hook(self)

278

disable_initiator_tag: a gobject event source tag, or None

767

disable_initiator_tag: a GLib event source tag, or None

279

768

enabled: bool()

280

769

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

281

770

uniquely identify the client

283

772

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

284

773

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

285

774

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

286

last_enabled: datetime.datetime(); (UTC)

775

last_checker_status: integer between 0 and 255 reflecting exit

776

status of last checker. -1 reflects crashed

777

checker, -2 means no checker completed yet.

778

last_checker_signal: The signal which killed the last checker, if

779

last_checker_status is -1

780

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

287

781

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

288

782

D-Bus identifiers

289

783

secret: bytestring; sent verbatim (over TLS) to client

290

784

timeout: datetime.timedelta(); How long from last_checked_ok

291

785

until this client is disabled

786

extended_timeout: extra long timeout when secret has been sent

292

787

runtime_expansions: Allowed attributes for runtime expansion.

788

expires: datetime.datetime(); time (UTC) when a client will be

789

disabled, or None

790

server_settings: The server_settings dict from main()

293

791

"""

294

792

295

793

runtime_expansions = ("approval_delay", "approval_duration",

296

"created", "enabled", "fingerprint",

297

"host", "interval", "last_checked_ok",

794

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

795

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

796

"last_approval_request", "last_checked_ok",

298

797

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

798

client_defaults = {

799

"timeout": "PT5M",

800

"extended_timeout": "PT15M",

801

"interval": "PT2M",

802

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

803

"host": "",

804

"approval_delay": "PT0S",

805

"approval_duration": "PT1S",

806

"approved_by_default": "True",

807

"enabled": "True",

808

}

299

809

300

810

@staticmethod

301

def _timedelta_to_milliseconds(td):

302

"Convert a datetime.timedelta() to milliseconds"

303

return ((td.days * 24 * 60 * 60 * 1000)

304

+ (td.seconds * 1000)

305

+ (td.microseconds // 1000))

306

307

def timeout_milliseconds(self):

308

"Return the 'timeout' attribute in milliseconds"

309

return self._timedelta_to_milliseconds(self.timeout)

310

311

def interval_milliseconds(self):

312

"Return the 'interval' attribute in milliseconds"

313

return self._timedelta_to_milliseconds(self.interval)

314

315

def approval_delay_milliseconds(self):

316

return self._timedelta_to_milliseconds(self.approval_delay)

317

318

def __init__(self, name = None, disable_hook=None, config=None):

319

"""Note: the 'checker' key in 'config' sets the

320

'checker_command' attribute and *not* the 'checker'

321

attribute."""

811

def config_parser(config):

812

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

813

{ client_name: {setting_name: value, ...}, ...}

814

with exceptions for any special settings as defined above.

815

NOTE: Must be a pure function. Must return the same result

816

value given the same arguments.

817

"""

818

settings = {}

819

for client_name in config.sections():

820

section = dict(config.items(client_name))

821

client = settings[client_name] = {}

822

823

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

824

# Reformat values from string types to Python types

825

client["approved_by_default"] = config.getboolean(

826

client_name, "approved_by_default")

827

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

828

"enabled")

829

830

# Uppercase and remove spaces from fingerprint for later

831

# comparison purposes with return value from the

832

# fingerprint() function

833

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

834

.replace(" ", ""))

835

if "secret" in section:

836

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

837

.encode("utf-8"),

838

"base64")

839

elif "secfile" in section:

840

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

841

(section["secfile"])),

842

"rb") as secfile:

843

client["secret"] = secfile.read()

844

else:

845

raise TypeError("No secret or secfile for section {}"

846

.format(section))

847

client["timeout"] = string_to_delta(section["timeout"])

848

client["extended_timeout"] = string_to_delta(

849

section["extended_timeout"])

850

client["interval"] = string_to_delta(section["interval"])

851

client["approval_delay"] = string_to_delta(

852

section["approval_delay"])

853

client["approval_duration"] = string_to_delta(

854

section["approval_duration"])

855

client["checker_command"] = section["checker"]

856

client["last_approval_request"] = None

857

client["last_checked_ok"] = None

858

client["last_checker_status"] = -2

859

860

return settings

861

862

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

322

863

self.name = name

323

if config is None:

324

config = {}

864

if server_settings is None:

865

server_settings = {}

866

self.server_settings = server_settings

867

# adding all client settings

868

for setting, value in settings.items():

869

setattr(self, setting, value)

870

871

if self.enabled:

872

if not hasattr(self, "last_enabled"):

873

self.last_enabled = datetime.datetime.utcnow()

874

if not hasattr(self, "expires"):

875

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

876

+ self.timeout)

877

else:

878

self.last_enabled = None

879

self.expires = None

880

325

881

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

326

# Uppercase and remove spaces from fingerprint for later

327

# comparison purposes with return value from the fingerprint()

328

# function

329

self.fingerprint = (config["fingerprint"].upper()

330

.replace(" ", ""))

331

882

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

332

if "secret" in config:

333

self.secret = config["secret"].decode("base64")

334

elif "secfile" in config:

335

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

336

(config["secfile"])),

337

"rb") as secfile:

338

self.secret = secfile.read()

339

else:

340

raise TypeError("No secret or secfile for client %s"

341

% self.name)

342

self.host = config.get("host", "")

343

self.created = datetime.datetime.utcnow()

344

self.enabled = False

345

self.last_approval_request = None

346

self.last_enabled = None

347

self.last_checked_ok = None

348

self.timeout = string_to_delta(config["timeout"])

349

self.interval = string_to_delta(config["interval"])

350

self.disable_hook = disable_hook

883

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

884

datetime.datetime.utcnow())

885

886

# attributes specific for this server instance

351

887

self.checker = None

352

888

self.checker_initiator_tag = None

353

889

self.disable_initiator_tag = None

354

890

self.checker_callback_tag = None

355

self.checker_command = config["checker"]

356

891

self.current_checker_command = None

357

self.last_connect = None

358

self._approved = None

359

self.approved_by_default = config.get("approved_by_default",

360

True)

892

self.approved = None

361

893

self.approvals_pending = 0

362

self.approval_delay = string_to_delta(

363

config["approval_delay"])

364

self.approval_duration = string_to_delta(

365

config["approval_duration"])

366

self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())

894

self.changedstate = multiprocessing_manager.Condition(

895

multiprocessing_manager.Lock())

896

self.client_structure = [attr

897

for attr in self.__dict__.keys()

898

if not attr.startswith("_")]

899

self.client_structure.append("client_structure")

900

901

for name, t in inspect.getmembers(

902

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

903

if not name.startswith("_"):

904

self.client_structure.append(name)

367

905

906

# Send notice to process children that client state has changed

368

907

def send_changedstate(self):

369

self.changedstate.acquire()

370

self.changedstate.notify_all()

371

self.changedstate.release()

372

908

with self.changedstate:

909

self.changedstate.notify_all()

910

373

911

def enable(self):

374

912

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

375

913

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

376

914

# Already enabled

377

915

return

378

self.send_changedstate()

916

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

917

self.enabled = True

379

918

self.last_enabled = datetime.datetime.utcnow()

380

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

381

# and every interval from then on.

382

self.checker_initiator_tag = (gobject.timeout_add

383

(self.interval_milliseconds(),

384

self.start_checker))

385

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

386

self.disable_initiator_tag = (gobject.timeout_add

387

(self.timeout_milliseconds(),

388

self.disable))

389

self.enabled = True

390

# Also start a new checker *right now*.

391

self.start_checker()

919

self.init_checker()

920

self.send_changedstate()

392

921

393

922

def disable(self, quiet=True):

394

923

"""Disable this client."""

395

924

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

396

925

return False

397

926

if not quiet:

398

self.send_changedstate()

399

if not quiet:

400

927

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

401

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

402

gobject.source_remove(self.disable_initiator_tag)

928

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

929

GLib.source_remove(self.disable_initiator_tag)

403

930

self.disable_initiator_tag = None

404

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

405

gobject.source_remove(self.checker_initiator_tag)

931

self.expires = None

932

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

933

GLib.source_remove(self.checker_initiator_tag)

406

934

self.checker_initiator_tag = None

407

935

self.stop_checker()

408

if self.disable_hook:

409

self.disable_hook(self)

410

936

self.enabled = False

411

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

937

if not quiet:

938

self.send_changedstate()

939

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

412

940

return False

413

941

414

942

def __del__(self):

415

self.disable_hook = None

416

943

self.disable()

417

944

418

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

945

def init_checker(self):

946

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

947

# and every interval from then on.

948

if self.checker_initiator_tag is not None:

949

GLib.source_remove(self.checker_initiator_tag)

950

self.checker_initiator_tag = GLib.timeout_add(

951

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

952

self.start_checker)

953

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

954

if self.disable_initiator_tag is not None:

955

GLib.source_remove(self.disable_initiator_tag)

956

self.disable_initiator_tag = GLib.timeout_add(

957

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

958

# Also start a new checker *right now*.

959

self.start_checker()

960

961

def checker_callback(self, source, condition, connection,

962

command):

419

963

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

420

964

self.checker_callback_tag = None

421

965

self.checker = None

422

if os.WIFEXITED(condition):

423

exitstatus = os.WEXITSTATUS(condition)

424

if exitstatus == 0:

966

# Read return code from connection (see call_pipe)

967

returncode = connection.recv()

968

connection.close()

969

970

if returncode >= 0:

971

self.last_checker_status = returncode

972

self.last_checker_signal = None

973

if self.last_checker_status == 0:

425

974

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

426

975

vars(self))

427

976

self.checked_ok()

428

977

else:

429

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

430

vars(self))

978

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

431

979

else:

980

self.last_checker_status = -1

981

self.last_checker_signal = -returncode

432

982

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

433

983

vars(self))

984

return False

434

985

435

986

def checked_ok(self):

436

"""Bump up the timeout for this client.

437

438

This should only be called when the client has been seen,

439

alive and well.

440

"""

987

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

441

988

self.last_checked_ok = datetime.datetime.utcnow()

442

gobject.source_remove(self.disable_initiator_tag)

443

self.disable_initiator_tag = (gobject.timeout_add

444

(self.timeout_milliseconds(),

445

self.disable))

989

self.last_checker_status = 0

990

self.last_checker_signal = None

991

self.bump_timeout()

992

993

def bump_timeout(self, timeout=None):

994

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

995

if timeout is None:

996

timeout = self.timeout

997

if self.disable_initiator_tag is not None:

998

GLib.source_remove(self.disable_initiator_tag)

999

self.disable_initiator_tag = None

1000

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

1001

self.disable_initiator_tag = GLib.timeout_add(

1002

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

1003

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

446

1004

447

1005

def need_approval(self):

448

1006

self.last_approval_request = datetime.datetime.utcnow()

453

1011

If a checker already exists, leave it running and do

454

1012

nothing."""

455

1013

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

456

# did that, then if a checker (for some reason) started

457

# running slowly and taking more than 'interval' time, the

458

# client would inevitably timeout, since no checker would get

459

# a chance to run to completion. If we instead leave running

1014

# did that, and if a checker (for some reason) started running

1015

# slowly and taking more than 'interval' time, then the client

1016

# would inevitably timeout, since no checker would get a

1017

# chance to run to completion. If we instead leave running

460

1018

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

461

1019

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

462

1020

# should be.

463

1021

464

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

465

try:

466

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

467

except (AttributeError, OSError) as error:

468

if (isinstance(error, OSError)

469

and error.errno != errno.ECHILD):

470

raise error

471

else:

472

if pid:

473

logger.warning("Checker was a zombie")

474

gobject.source_remove(self.checker_callback_tag)

475

self.checker_callback(pid, status,

476

self.current_checker_command)

1022

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

1023

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

1024

self.checker.join()

1025

self.checker = None

477

1026

# Start a new checker if needed

478

1027

if self.checker is None:

1028

# Escape attributes for the shell

1029

escaped_attrs = {

1030

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

1031

for attr in self.runtime_expansions }

479

1032

try:

480

# In case checker_command has exactly one % operator

481

command = self.checker_command % self.host

482

except TypeError:

483

# Escape attributes for the shell

484

escaped_attrs = dict(

485

(attr,

486

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

487

errors=

488

'replace')))

489

for attr in

490

self.runtime_expansions)

491

492

try:

493

command = self.checker_command % escaped_attrs

494

except TypeError as error:

495

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

496

' %s', self.checker_command, error)

497

return True # Try again later

1033

command = self.checker_command % escaped_attrs

1034

except TypeError as error:

1035

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

1036

self.checker_command,

1037

exc_info=error)

1038

return True # Try again later

498

1039

self.current_checker_command = command

499

try:

500

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

501

command, self.name)

502

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

503

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

504

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

505

# always replaced by /dev/null.)

506

self.checker = subprocess.Popen(command,

507

close_fds=True,

508

shell=True, cwd="/")

509

self.checker_callback_tag = (gobject.child_watch_add

510

(self.checker.pid,

511

self.checker_callback,

512

data=command))

513

# The checker may have completed before the gobject

514

# watch was added. Check for this.

515

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

516

if pid:

517

gobject.source_remove(self.checker_callback_tag)

518

self.checker_callback(pid, status, command)

519

except OSError as error:

520

logger.error("Failed to start subprocess: %s",

521

error)

522

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

1040

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

1041

self.name)

1042

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

1043

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

1044

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

1045

# always replaced by /dev/null.)

1046

# The exception is when not debugging but nevertheless

1047

# running in the foreground; use the previously

1048

# created wnull.

1049

popen_args = { "close_fds": True,

1050

"shell": True,

1051

"cwd": "/" }

1052

if (not self.server_settings["debug"]

1053

and self.server_settings["foreground"]):

1054

popen_args.update({"stdout": wnull,

1055

"stderr": wnull })

1056

pipe = multiprocessing.Pipe(duplex = False)

1057

self.checker = multiprocessing.Process(

1058

target = call_pipe,

1059

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

1060

kwargs = popen_args)

1061

self.checker.start()

1062

self.checker_callback_tag = GLib.io_add_watch(

1063

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

1064

self.checker_callback, pipe[0], command)

1065

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

523

1066

return True

524

1067

525

1068

def stop_checker(self):

526

1069

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

527

1070

if self.checker_callback_tag:

528

gobject.source_remove(self.checker_callback_tag)

1071

GLib.source_remove(self.checker_callback_tag)

529

1072

self.checker_callback_tag = None

530

1073

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

531

1074

return

532

1075

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

533

try:

534

os.kill(self.checker.pid, signal.SIGTERM)

535

#time.sleep(0.5)

536

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

537

# os.kill(self.checker.pid, signal.SIGKILL)

538

except OSError as error:

539

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

540

raise

1076

self.checker.terminate()

541

1077

self.checker = None

542

1078

543

def dbus_service_property(dbus_interface, signature="v",

544

access="readwrite", byte_arrays=False):

1079

1080

def dbus_service_property(dbus_interface,

1081

signature="v",

1082

access="readwrite",

1083

byte_arrays=False):

545

1084

"""Decorators for marking methods of a DBusObjectWithProperties to

546

1085

become properties on the D-Bus.

547

1086

556

1095

# "Set" method, so we fail early here:

557

1096

if byte_arrays and signature != "ay":

558

1097

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

559

" signature %r" % signature)

1098

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

1099

560

1100

def decorator(func):

561

1101

func._dbus_is_property = True

562

1102

func._dbus_interface = dbus_interface

567

1107

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

568

1108

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

569

1109

return func

1110

1111

return decorator

1112

1113

1114

def dbus_interface_annotations(dbus_interface):

1115

"""Decorator for marking functions returning interface annotations

1116

1117

Usage:

1118

1119

@dbus_interface_annotations("org.example.Interface")

1120

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

1121

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

1122

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

1123

"false"}

1124

"""

1125

1126

def decorator(func):

1127

func._dbus_is_interface = True

1128

func._dbus_interface = dbus_interface

1129

func._dbus_name = dbus_interface

1130

return func

1131

1132

return decorator

1133

1134

1135

def dbus_annotations(annotations):

1136

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

1137

Usage:

1138

1139

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

1140

"org.freedesktop.DBus.Property."

1141

"EmitsChangedSignal": "false"})

1142

@dbus_service_property("org.example.Interface", signature="b",

1143

access="r")

1144

def Property_dbus_property(self):

1145

return dbus.Boolean(False)

1146

1147

See also the DBusObjectWithAnnotations class.

1148

"""

1149

1150

def decorator(func):

1151

func._dbus_annotations = annotations

1152

return func

1153

570

1154

return decorator

571

1155

572

1156

573

1157

class DBusPropertyException(dbus.exceptions.DBusException):

574

1158

"""A base class for D-Bus property-related exceptions

575

1159

"""

576

def __unicode__(self):

577

return unicode(str(self))

1160

pass

578

1161

579

1162

580

1163

class DBusPropertyAccessException(DBusPropertyException):

589

1172

pass

590

1173

591

1174

592

class DBusObjectWithProperties(dbus.service.Object):

1175

class DBusObjectWithAnnotations(dbus.service.Object):

1176

"""A D-Bus object with annotations.

1177

1178

Classes inheriting from this can use the dbus_annotations

1179

decorator to add annotations to methods or signals.

1180

"""

1181

1182

@staticmethod

1183

def _is_dbus_thing(thing):

1184

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

1185

1186

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

1187

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

1188

"""

1189

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

1190

False)

1191

1192

def _get_all_dbus_things(self, thing):

1193

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

1194

"""

1195

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

1196

athing.__get__(self))

1197

for cls in self.__class__.__mro__

1198

for name, athing in

1199

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

1200

1201

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1202

out_signature = "s",

1203

path_keyword = 'object_path',

1204

connection_keyword = 'connection')

1205

def Introspect(self, object_path, connection):

1206

"""Overloading of standard D-Bus method.

1207

1208

Inserts annotation tags on methods and signals.

1209

"""

1210

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

1211

connection)

1212

try:

1213

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

1214

1215

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

1216

# Add annotation tags

1217

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

1218

for tag in if_tag.getElementsByTagName(typ):

1219

annots = dict()

1220

for name, prop in (self.

1221

_get_all_dbus_things(typ)):

1222

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

1223

and prop._dbus_interface

1224

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

1225

annots.update(getattr(

1226

prop, "_dbus_annotations", {}))

1227

for name, value in annots.items():

1228

ann_tag = document.createElement(

1229

"annotation")

1230

ann_tag.setAttribute("name", name)

1231

ann_tag.setAttribute("value", value)

1232

tag.appendChild(ann_tag)

1233

# Add interface annotation tags

1234

for annotation, value in dict(

1235

itertools.chain.from_iterable(

1236

annotations().items()

1237

for name, annotations

1238

in self._get_all_dbus_things("interface")

1239

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

1240

)).items():

1241

ann_tag = document.createElement("annotation")

1242

ann_tag.setAttribute("name", annotation)

1243

ann_tag.setAttribute("value", value)

1244

if_tag.appendChild(ann_tag)

1245

# Fix argument name for the Introspect method itself

1246

if (if_tag.getAttribute("name")

1247

== dbus.INTROSPECTABLE_IFACE):

1248

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

1249

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

1250

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

1251

if (arg.getAttribute("direction")

1252

== "out"):

1253

arg.setAttribute("name",

1254

"xml_data")

1255

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

1256

document.unlink()

1257

except (AttributeError, xml.dom.DOMException,

1258

xml.parsers.expat.ExpatError) as error:

1259

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

1260

exc_info=error)

1261

return xmlstring

1262

1263

1264

class DBusObjectWithProperties(DBusObjectWithAnnotations):

593

1265

"""A D-Bus object with properties.

594

1266

595

1267

Classes inheriting from this can use the dbus_service_property

596

1268

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

597

1269

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

598

1270

"""

599

1271

600

@staticmethod

601

def _is_dbus_property(obj):

602

return getattr(obj, "_dbus_is_property", False)

603

604

def _get_all_dbus_properties(self):

605

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

606

"""

607

return ((prop._dbus_name, prop)

608

for name, prop in

609

inspect.getmembers(self, self._is_dbus_property))

610

611

1272

def _get_dbus_property(self, interface_name, property_name):

612

1273

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

613

1274

property with the specified name and interface.

614

1275

"""

615

for name in (property_name,

616

property_name + "_dbus_property"):

617

prop = getattr(self, name, None)

618

if (prop is None

619

or not self._is_dbus_property(prop)

620

or prop._dbus_name != property_name

621

or (interface_name and prop._dbus_interface

622

and interface_name != prop._dbus_interface)):

623

continue

624

return prop

1276

for cls in self.__class__.__mro__:

1277

for name, value in inspect.getmembers(

1278

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

1279

if (value._dbus_name == property_name

1280

and value._dbus_interface == interface_name):

1281

return value.__get__(self)

1282

625

1283

# No such property

626

raise DBusPropertyNotFound(self.dbus_object_path + ":"

627

+ interface_name + "."

628

+ property_name)

629

630

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

1284

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

1285

self.dbus_object_path, interface_name, property_name))

1286

1287

@classmethod

1288

def _get_all_interface_names(cls):

1289

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

1290

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

1291

"_dbus_interface", None)

1292

for x in (inspect.getmro(cls))

1293

for attr in dir(x))

1294

if name is not None)

1295

1296

@dbus.service.method(dbus.PROPERTIES_IFACE,

1297

in_signature="ss",

631

1298

out_signature="v")

632

1299

def Get(self, interface_name, property_name):

633

1300

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

651

1318

# The byte_arrays option is not supported yet on

652

1319

# signatures other than "ay".

653

1320

if prop._dbus_signature != "ay":

654

raise ValueError

655

value = dbus.ByteArray(''.join(unichr(byte)

656

for byte in value))

1321

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

1322

"'ay' signature {!r}"

1323

.format(prop._dbus_signature))

1324

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

1325

for byte in value))

657

1326

prop(value)

658

1327

659

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

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

in_signature="s",

660

1330

out_signature="a{sv}")

661

1331

def GetAll(self, interface_name):

662

1332

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

663

1333

standard.

664

1334

665

1335

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

666

1336

"""

667

all = {}

668

for name, prop in self._get_all_dbus_properties():

1337

properties = {}

1338

for name, prop in self._get_all_dbus_things("property"):

669

1339

if (interface_name

670

1340

and interface_name != prop._dbus_interface):

671

1341

# Interface non-empty but did not match

675

1345

continue

676

1346

value = prop()

677

1347

if not hasattr(value, "variant_level"):

678

all[name] = value

1348

properties[name] = value

679

1349

continue

680

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

681

value.variant_level+1)

682

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

1350

properties[name] = type(value)(

1351

value, variant_level = value.variant_level + 1)

1352

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

1353

1354

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

1355

def PropertiesChanged(self, interface_name, changed_properties,

1356

invalidated_properties):

1357

"""Standard D-Bus PropertiesChanged() signal, see D-Bus

1358

standard.

1359

"""

1360

pass

683

1361

684

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

685

1363

out_signature="s",

686

1364

path_keyword='object_path',

687

1365

connection_keyword='connection')

688

1366

def Introspect(self, object_path, connection):

689

"""Standard D-Bus method, overloaded to insert property tags.

1367

"""Overloading of standard D-Bus method.

1368

1369

Inserts property tags and interface annotation tags.

690

1370

"""

691

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

692

connection)

1371

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1372

object_path,

1373

connection)

693

1374

try:

694

1375

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

1376

695

1377

def make_tag(document, name, prop):

696

1378

e = document.createElement("property")

697

1379

e.setAttribute("name", name)

698

1380

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

699

1381

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

700

1382

return e

1383

701

1384

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

1385

# Add property tags

702

1386

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

703

1387

for name, prop

704

in self._get_all_dbus_properties()

1388

in self._get_all_dbus_things("property")

705

1389

if prop._dbus_interface

706

1390

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

707

1391

if_tag.appendChild(tag)

1392

# Add annotation tags for properties

1393

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

1394

annots = dict()

1395

for name, prop in self._get_all_dbus_things(

1396

"property"):

1397

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

1398

and prop._dbus_interface

1399

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

1400

annots.update(getattr(

1401

prop, "_dbus_annotations", {}))

1402

for name, value in annots.items():

1403

ann_tag = document.createElement(

1404

"annotation")

1405

ann_tag.setAttribute("name", name)

1406

ann_tag.setAttribute("value", value)

1407

tag.appendChild(ann_tag)

708

1408

# Add the names to the return values for the

709

1409

# "org.freedesktop.DBus.Properties" methods

710

1410

if (if_tag.getAttribute("name")

725

1425

except (AttributeError, xml.dom.DOMException,

726

1426

xml.parsers.expat.ExpatError) as error:

727

1427

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

728

error)

729

return xmlstring

730

731

1428

exc_info=error)

1429

return xmlstring

1430

1431

try:

1432

dbus.OBJECT_MANAGER_IFACE

1433

except AttributeError:

1434

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

1435

1436

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1437

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

1438

1439

Classes inheriting from this exposes the standard

1440

GetManagedObjects call and the InterfacesAdded and

1441

InterfacesRemoved signals on the standard

1442

"org.freedesktop.DBus.ObjectManager" interface.

1443

1444

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

1445

manually.

1446

"""

1447

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1448

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

1449

def GetManagedObjects(self):

1450

"""This function must be overridden"""

1451

raise NotImplementedError()

1452

1453

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1454

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

1455

def InterfacesAdded(self, object_path, interfaces_and_properties):

1456

pass

1457

1458

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

1459

def InterfacesRemoved(self, object_path, interfaces):

1460

pass

1461

1462

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1463

out_signature = "s",

1464

path_keyword = 'object_path',

1465

connection_keyword = 'connection')

1466

def Introspect(self, object_path, connection):

1467

"""Overloading of standard D-Bus method.

1468

1469

Override return argument name of GetManagedObjects to be

1470

"objpath_interfaces_and_properties"

1471

"""

1472

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1473

object_path,

1474

connection)

1475

try:

1476

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

1477

1478

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

1479

# Fix argument name for the GetManagedObjects method

1480

if (if_tag.getAttribute("name")

1481

== dbus.OBJECT_MANAGER_IFACE):

1482

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

1483

if (cn.getAttribute("name")

1484

== "GetManagedObjects"):

1485

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

1486

if (arg.getAttribute("direction")

1487

== "out"):

1488

arg.setAttribute(

1489

"name",

1490

"objpath_interfaces"

1491

"_and_properties")

1492

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

1493

document.unlink()

1494

except (AttributeError, xml.dom.DOMException,

1495

xml.parsers.expat.ExpatError) as error:

1496

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

1497

exc_info = error)

1498

return xmlstring

1499

1500

def datetime_to_dbus(dt, variant_level=0):

1501

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

1502

if dt is None:

1503

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

1504

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

1505

1506

1507

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1508

"""A class decorator; applied to a subclass of

1509

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

1510

interface names according to the "alt_interface_names" mapping.

1511

Usage:

1512

1513

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

1514

"net.example.AlternateInterface"})

1515

class SampleDBusObject(dbus.service.Object):

1516

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

1517

def SampleDBusMethod():

1518

pass

1519

1520

The above "SampleDBusMethod" on "SampleDBusObject" will be

1521

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

1522

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

1523

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

1524

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

1525

1526

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

1527

(from DBusObjectWithProperties) and interfaces (from the

1528

dbus_interface_annotations decorator).

1529

"""

1530

1531

def wrapper(cls):

1532

for orig_interface_name, alt_interface_name in (

1533

alt_interface_names.items()):

1534

attr = {}

1535

interface_names = set()

1536

# Go though all attributes of the class

1537

for attrname, attribute in inspect.getmembers(cls):

1538

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

1539

# with the wrong interface name

1540

if (not hasattr(attribute, "_dbus_interface")

1541

or not attribute._dbus_interface.startswith(

1542

orig_interface_name)):

1543

continue

1544

# Create an alternate D-Bus interface name based on

1545

# the current name

1546

alt_interface = attribute._dbus_interface.replace(

1547

orig_interface_name, alt_interface_name)

1548

interface_names.add(alt_interface)

1549

# Is this a D-Bus signal?

1550

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

1551

# Extract the original non-method undecorated

1552

# function by black magic

1553

if sys.version_info.major == 2:

1554

nonmethod_func = (dict(

1555

zip(attribute.func_code.co_freevars,

1556

attribute.__closure__))

1557

["func"].cell_contents)

1558

else:

1559

nonmethod_func = (dict(

1560

zip(attribute.__code__.co_freevars,

1561

attribute.__closure__))

1562

["func"].cell_contents)

1563

# Create a new, but exactly alike, function

1564

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

1565

# with the alternate D-Bus interface name

1566

new_function = copy_function(nonmethod_func)

1567

new_function = (dbus.service.signal(

1568

alt_interface,

1569

attribute._dbus_signature)(new_function))

1570

# Copy annotations, if any

1571

try:

1572

new_function._dbus_annotations = dict(

1573

attribute._dbus_annotations)

1574

except AttributeError:

1575

pass

1576

# Define a creator of a function to call both the

1577

# original and alternate functions, so both the

1578

# original and alternate signals gets sent when

1579

# the function is called

1580

def fixscope(func1, func2):

1581

"""This function is a scope container to pass

1582

func1 and func2 to the "call_both" function

1583

outside of its arguments"""

1584

1585

@functools.wraps(func2)

1586

def call_both(*args, **kwargs):

1587

"""This function will emit two D-Bus

1588

signals by calling func1 and func2"""

1589

func1(*args, **kwargs)

1590

func2(*args, **kwargs)

1591

# Make wrapper function look like a D-Bus signal

1592

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

1593

if name.startswith("_dbus_"):

1594

setattr(call_both, name, attr)

1595

1596

return call_both

1597

# Create the "call_both" function and add it to

1598

# the class

1599

attr[attrname] = fixscope(attribute, new_function)

1600

# Is this a D-Bus method?

1601

elif getattr(attribute, "_dbus_is_method", False):

1602

# Create a new, but exactly alike, function

1603

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

1604

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

1605

# to the class.

1606

attr[attrname] = (

1607

dbus.service.method(

1608

alt_interface,

1609

attribute._dbus_in_signature,

1610

attribute._dbus_out_signature)

1611

(copy_function(attribute)))

1612

# Copy annotations, if any

1613

try:

1614

attr[attrname]._dbus_annotations = dict(

1615

attribute._dbus_annotations)

1616

except AttributeError:

1617

pass

1618

# Is this a D-Bus property?

1619

elif getattr(attribute, "_dbus_is_property", False):

1620

# Create a new, but exactly alike, function

1621

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

1622

# property with the alternate D-Bus interface

1623

# name. Add it to the class.

1624

attr[attrname] = (dbus_service_property(

1625

alt_interface, attribute._dbus_signature,

1626

attribute._dbus_access,

1627

attribute._dbus_get_args_options

1628

["byte_arrays"])

1629

(copy_function(attribute)))

1630

# Copy annotations, if any

1631

try:

1632

attr[attrname]._dbus_annotations = dict(

1633

attribute._dbus_annotations)

1634

except AttributeError:

1635

pass

1636

# Is this a D-Bus interface?

1637

elif getattr(attribute, "_dbus_is_interface", False):

1638

# Create a new, but exactly alike, function

1639

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

1640

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

1641

# to the class.

1642

attr[attrname] = (

1643

dbus_interface_annotations(alt_interface)

1644

(copy_function(attribute)))

1645

if deprecate:

1646

# Deprecate all alternate interfaces

1647

iname="_AlternateDBusNames_interface_annotation{}"

1648

for interface_name in interface_names:

1649

1650

@dbus_interface_annotations(interface_name)

1651

def func(self):

1652

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

1653

"true" }

1654

# Find an unused name

1655

for aname in (iname.format(i)

1656

for i in itertools.count()):

1657

if aname not in attr:

1658

attr[aname] = func

1659

break

1660

if interface_names:

1661

# Replace the class with a new subclass of it with

1662

# methods, signals, etc. as created above.

1663

if sys.version_info.major == 2:

1664

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

1665

(cls, ), attr)

1666

else:

1667

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

1668

(cls, ), attr)

1669

return cls

1670

1671

return wrapper

1672

1673

1674

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

1675

"se.bsnet.fukt.Mandos"})

732

1676

class ClientDBus(Client, DBusObjectWithProperties):

733

1677

"""A Client class using D-Bus

734

1678

738

1682

"""

739

1683

740

1684

runtime_expansions = (Client.runtime_expansions

741

+ ("dbus_object_path",))

1685

+ ("dbus_object_path", ))

1686

1687

_interface = "se.recompile.Mandos.Client"

742

1688

743

1689

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

744

1690

745

1691

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

746

self._approvals_pending = 0

747

1692

self.bus = bus

748

1693

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

749

1694

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

750

1695

# the D-Bus

751

client_object_name = unicode(self.name).translate(

1696

client_object_name = str(self.name).translate(

752

1697

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

753

1698

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

754

self.dbus_object_path = (dbus.ObjectPath

755

("/clients/" + client_object_name))

1699

self.dbus_object_path = dbus.ObjectPath(

1700

"/clients/" + client_object_name)

756

1701

DBusObjectWithProperties.__init__(self, self.bus,

757

1702

self.dbus_object_path)

758

759

def _get_approvals_pending(self):

760

return self._approvals_pending

761

def _set_approvals_pending(self, value):

762

old_value = self._approvals_pending

763

self._approvals_pending = value

764

bval = bool(value)

765

if (hasattr(self, "dbus_object_path")

766

and bval is not bool(old_value)):

767

dbus_bool = dbus.Boolean(bval, variant_level=1)

768

self.PropertyChanged(dbus.String("ApprovalPending"),

769

dbus_bool)

770

771

approvals_pending = property(_get_approvals_pending,

772

_set_approvals_pending)

773

del _get_approvals_pending, _set_approvals_pending

774

775

@staticmethod

776

def _datetime_to_dbus(dt, variant_level=0):

777

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

778

return dbus.String(dt.isoformat(),

779

variant_level=variant_level)

780

781

def enable(self):

782

oldstate = getattr(self, "enabled", False)

783

r = Client.enable(self)

784

if oldstate != self.enabled:

785

# Emit D-Bus signals

786

self.PropertyChanged(dbus.String("Enabled"),

787

dbus.Boolean(True, variant_level=1))

788

self.PropertyChanged(

789

dbus.String("LastEnabled"),

790

self._datetime_to_dbus(self.last_enabled,

791

variant_level=1))

792

return r

793

794

def disable(self, quiet = False):

795

oldstate = getattr(self, "enabled", False)

796

r = Client.disable(self, quiet=quiet)

797

if not quiet and oldstate != self.enabled:

798

# Emit D-Bus signal

799

self.PropertyChanged(dbus.String("Enabled"),

800

dbus.Boolean(False, variant_level=1))

801

return r

1703

1704

def notifychangeproperty(transform_func, dbus_name,

1705

type_func=lambda x: x,

1706

variant_level=1,

1707

invalidate_only=False,

1708

_interface=_interface):

1709

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

1710

its changes to DBus.

1711

1712

transform_fun: Function that takes a value and a variant_level

1713

and transforms it to a D-Bus type.

1714

dbus_name: D-Bus name of the variable

1715

type_func: Function that transform the value before sending it

1716

to the D-Bus. Default: no transform

1717

variant_level: D-Bus variant level. Default: 1

1718

"""

1719

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

1720

1721

def setter(self, value):

1722

if hasattr(self, "dbus_object_path"):

1723

if (not hasattr(self, attrname) or

1724

type_func(getattr(self, attrname, None))

1725

!= type_func(value)):

1726

if invalidate_only:

1727

self.PropertiesChanged(

1728

_interface, dbus.Dictionary(),

1729

dbus.Array((dbus_name, )))

1730

else:

1731

dbus_value = transform_func(

1732

type_func(value),

1733

variant_level = variant_level)

1734

self.PropertyChanged(dbus.String(dbus_name),

1735

dbus_value)

1736

self.PropertiesChanged(

1737

_interface,

1738

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

1739

dbus_value }),

1740

dbus.Array())

1741

setattr(self, attrname, value)

1742

1743

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

1744

1745

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1746

approvals_pending = notifychangeproperty(dbus.Boolean,

1747

"ApprovalPending",

1748

type_func = bool)

1749

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

1750

last_enabled = notifychangeproperty(datetime_to_dbus,

1751

"LastEnabled")

1752

checker = notifychangeproperty(

1753

dbus.Boolean, "CheckerRunning",

1754

type_func = lambda checker: checker is not None)

1755

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1756

"LastCheckedOK")

1757

last_checker_status = notifychangeproperty(dbus.Int16,

1758

"LastCheckerStatus")

1759

last_approval_request = notifychangeproperty(

1760

datetime_to_dbus, "LastApprovalRequest")

1761

approved_by_default = notifychangeproperty(dbus.Boolean,

1762

"ApprovedByDefault")

1763

approval_delay = notifychangeproperty(

1764

dbus.UInt64, "ApprovalDelay",

1765

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

1766

approval_duration = notifychangeproperty(

1767

dbus.UInt64, "ApprovalDuration",

1768

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

1769

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

1770

timeout = notifychangeproperty(

1771

dbus.UInt64, "Timeout",

1772

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

1773

extended_timeout = notifychangeproperty(

1774

dbus.UInt64, "ExtendedTimeout",

1775

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

1776

interval = notifychangeproperty(

1777

dbus.UInt64, "Interval",

1778

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

1779

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

1780

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

1781

invalidate_only=True)

1782

1783

del notifychangeproperty

802

1784

803

1785

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

804

1786

try:

809

1791

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

810

1792

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

811

1793

812

def checker_callback(self, pid, condition, command,

813

*args, **kwargs):

814

self.checker_callback_tag = None

815

self.checker = None

816

# Emit D-Bus signal

817

self.PropertyChanged(dbus.String("CheckerRunning"),

818

dbus.Boolean(False, variant_level=1))

819

if os.WIFEXITED(condition):

820

exitstatus = os.WEXITSTATUS(condition)

1794

def checker_callback(self, source, condition,

1795

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

1796

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

1797

connection, command, *args,

1798

**kwargs)

1799

exitstatus = self.last_checker_status

1800

if exitstatus >= 0:

821

1801

# Emit D-Bus signal

822

1802

self.CheckerCompleted(dbus.Int16(exitstatus),

823

dbus.Int64(condition),

1803

# This is specific to GNU libC

1804

dbus.Int64(exitstatus << 8),

824

1805

dbus.String(command))

825

1806

else:

826

1807

# Emit D-Bus signal

827

1808

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

828

dbus.Int64(condition),

1809

dbus.Int64(

1810

# This is specific to GNU libC

1811

(exitstatus << 8)

1812

| self.last_checker_signal),

829

1813

dbus.String(command))

830

831

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

832

*args, **kwargs)

833

834

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

835

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

836

# Emit D-Bus signal

837

self.PropertyChanged(

838

dbus.String("LastCheckedOK"),

839

(self._datetime_to_dbus(self.last_checked_ok,

840

variant_level=1)))

841

842

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

843

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

844

# Emit D-Bus signal

845

self.PropertyChanged(

846

dbus.String("LastApprovalRequest"),

847

(self._datetime_to_dbus(self.last_approval_request,

848

variant_level=1)))

849

return r

1814

return ret

850

1815

851

1816

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

852

old_checker = self.checker

853

if self.checker is not None:

854

old_checker_pid = self.checker.pid

855

else:

856

old_checker_pid = None

1817

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

857

1818

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

858

1819

# Only if new checker process was started

859

1820

if (self.checker is not None

860

1821

and old_checker_pid != self.checker.pid):

861

1822

# Emit D-Bus signal

862

1823

self.CheckerStarted(self.current_checker_command)

863

self.PropertyChanged(

864

dbus.String("CheckerRunning"),

865

dbus.Boolean(True, variant_level=1))

866

1824

return r

867

1825

868

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

869

old_checker = getattr(self, "checker", None)

870

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

871

if (old_checker is not None

872

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

873

self.PropertyChanged(dbus.String("CheckerRunning"),

874

dbus.Boolean(False, variant_level=1))

875

return r

876

877

1826

def _reset_approved(self):

878

self._approved = None

1827

self.approved = None

879

1828

return False

880

1829

881

1830

def approve(self, value=True):

1831

self.approved = value

1832

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

1833

* 1000), self._reset_approved)

882

1834

self.send_changedstate()

883

self._approved = value

884

gobject.timeout_add(self._timedelta_to_milliseconds

885

(self.approval_duration),

886

self._reset_approved)

887

888

1835

889

1836

## D-Bus methods, signals & properties

890

_interface = "se.bsnet.fukt.Mandos.Client"

1837

1838

## Interfaces

891

1839

892

1840

## Signals

893

1841

904

1852

pass

905

1853

906

1854

# PropertyChanged - signal

1855

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

907

1856

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

908

1857

def PropertyChanged(self, property, value):

909

1858

"D-Bus signal"

943

1892

self.checked_ok()

944

1893

945

1894

# Enable - method

1895

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

946

1896

@dbus.service.method(_interface)

947

1897

def Enable(self):

948

1898

"D-Bus method"

949

1899

self.enable()

950

1900

951

1901

# StartChecker - method

1902

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

952

1903

@dbus.service.method(_interface)

953

1904

def StartChecker(self):

954

1905

"D-Bus method"

955

1906

self.start_checker()

956

1907

957

1908

# Disable - method

1909

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

958

1910

@dbus.service.method(_interface)

959

1911

def Disable(self):

960

1912

"D-Bus method"

961

1913

self.disable()

962

1914

963

1915

# StopChecker - method

1916

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

964

1917

@dbus.service.method(_interface)

965

1918

def StopChecker(self):

966

1919

self.stop_checker()

973

1926

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

974

1927

975

1928

# ApprovedByDefault - property

976

@dbus_service_property(_interface, signature="b",

1929

@dbus_service_property(_interface,

1930

signature="b",

977

1931

access="readwrite")

978

1932

def ApprovedByDefault_dbus_property(self, value=None):

979

1933

if value is None: # get

980

1934

return dbus.Boolean(self.approved_by_default)

981

1935

self.approved_by_default = bool(value)

982

# Emit D-Bus signal

983

self.PropertyChanged(dbus.String("ApprovedByDefault"),

984

dbus.Boolean(value, variant_level=1))

985

1936

986

1937

# ApprovalDelay - property

987

@dbus_service_property(_interface, signature="t",

1938

@dbus_service_property(_interface,

1939

signature="t",

988

1940

access="readwrite")

989

1941

def ApprovalDelay_dbus_property(self, value=None):

990

1942

if value is None: # get

991

return dbus.UInt64(self.approval_delay_milliseconds())

1943

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

1944

* 1000)

992

1945

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

993

# Emit D-Bus signal

994

self.PropertyChanged(dbus.String("ApprovalDelay"),

995

dbus.UInt64(value, variant_level=1))

996

1946

997

1947

# ApprovalDuration - property

998

@dbus_service_property(_interface, signature="t",

1948

@dbus_service_property(_interface,

1949

signature="t",

999

1950

access="readwrite")

1000

1951

def ApprovalDuration_dbus_property(self, value=None):

1001

1952

if value is None: # get

1002

return dbus.UInt64(self._timedelta_to_milliseconds(

1003

self.approval_duration))

1953

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

1954

* 1000)

1004

1955

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

1005

# Emit D-Bus signal

1006

self.PropertyChanged(dbus.String("ApprovalDuration"),

1007

dbus.UInt64(value, variant_level=1))

1008

1956

1009

1957

# Name - property

1958

@dbus_annotations(

1959

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

1010

1960

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

1011

1961

def Name_dbus_property(self):

1012

1962

return dbus.String(self.name)

1013

1963

1014

1964

# Fingerprint - property

1965

@dbus_annotations(

1966

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

1015

1967

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

1016

1968

def Fingerprint_dbus_property(self):

1017

1969

return dbus.String(self.fingerprint)

1018

1970

1019

1971

# Host - property

1020

@dbus_service_property(_interface, signature="s",

1972

@dbus_service_property(_interface,

1973

signature="s",

1021

1974

access="readwrite")

1022

1975

def Host_dbus_property(self, value=None):

1023

1976

if value is None: # get

1024

1977

return dbus.String(self.host)

1025

self.host = value

1026

# Emit D-Bus signal

1027

self.PropertyChanged(dbus.String("Host"),

1028

dbus.String(value, variant_level=1))

1978

self.host = str(value)

1029

1979

1030

1980

# Created - property

1981

@dbus_annotations(

1982

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

1031

1983

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

1032

1984

def Created_dbus_property(self):

1033

return dbus.String(self._datetime_to_dbus(self.created))

1985

return datetime_to_dbus(self.created)

1034

1986

1035

1987

# LastEnabled - property

1036

1988

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

1037

1989

def LastEnabled_dbus_property(self):

1038

if self.last_enabled is None:

1039

return dbus.String("")

1040

return dbus.String(self._datetime_to_dbus(self.last_enabled))

1990

return datetime_to_dbus(self.last_enabled)

1041

1991

1042

1992

# Enabled - property

1043

@dbus_service_property(_interface, signature="b",

1993

@dbus_service_property(_interface,

1994

signature="b",

1044

1995

access="readwrite")

1045

1996

def Enabled_dbus_property(self, value=None):

1046

1997

if value is None: # get

1051

2002

self.disable()

1052

2003

1053

2004

# LastCheckedOK - property

1054

@dbus_service_property(_interface, signature="s",

2005

@dbus_service_property(_interface,

2006

signature="s",

1055

2007

access="readwrite")

1056

2008

def LastCheckedOK_dbus_property(self, value=None):

1057

2009

if value is not None:

1058

2010

self.checked_ok()

1059

2011

return

1060

if self.last_checked_ok is None:

1061

return dbus.String("")

1062

return dbus.String(self._datetime_to_dbus(self

1063

.last_checked_ok))

2012

return datetime_to_dbus(self.last_checked_ok)

2013

2014

# LastCheckerStatus - property

2015

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

2016

def LastCheckerStatus_dbus_property(self):

2017

return dbus.Int16(self.last_checker_status)

2018

2019

# Expires - property

2020

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

2021

def Expires_dbus_property(self):

2022

return datetime_to_dbus(self.expires)

1064

2023

1065

2024

# LastApprovalRequest - property

1066

2025

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

1067

2026

def LastApprovalRequest_dbus_property(self):

1068

if self.last_approval_request is None:

1069

return dbus.String("")

1070

return dbus.String(self.

1071

_datetime_to_dbus(self

1072

.last_approval_request))

2027

return datetime_to_dbus(self.last_approval_request)

1073

2028

1074

2029

# Timeout - property

1075

@dbus_service_property(_interface, signature="t",

2030

@dbus_service_property(_interface,

2031

signature="t",

1076

2032

access="readwrite")

1077

2033

def Timeout_dbus_property(self, value=None):

1078

2034

if value is None: # get

1079

return dbus.UInt64(self.timeout_milliseconds())

2035

return dbus.UInt64(self.timeout.total_seconds() * 1000)

2036

old_timeout = self.timeout

1080

2037

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

1081

# Emit D-Bus signal

1082

self.PropertyChanged(dbus.String("Timeout"),

1083

dbus.UInt64(value, variant_level=1))

1084

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

1085

return

1086

# Reschedule timeout

1087

gobject.source_remove(self.disable_initiator_tag)

1088

self.disable_initiator_tag = None

1089

time_to_die = (self.

1090

_timedelta_to_milliseconds((self

1091

.last_checked_ok

1092

+ self.timeout)

1093

- datetime.datetime

1094

.utcnow()))

1095

if time_to_die <= 0:

1096

# The timeout has passed

1097

self.disable()

1098

else:

1099

self.disable_initiator_tag = (gobject.timeout_add

1100

(time_to_die, self.disable))

2038

# Reschedule disabling

2039

if self.enabled:

2040

now = datetime.datetime.utcnow()

2041

self.expires += self.timeout - old_timeout

2042

if self.expires <= now:

2043

# The timeout has passed

2044

self.disable()

2045

else:

2046

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

2047

is None):

2048

return

2049

GLib.source_remove(self.disable_initiator_tag)

2050

self.disable_initiator_tag = GLib.timeout_add(

2051

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

2052

self.disable)

2053

2054

# ExtendedTimeout - property

2055

@dbus_service_property(_interface,

2056

signature="t",

2057

access="readwrite")

2058

def ExtendedTimeout_dbus_property(self, value=None):

2059

if value is None: # get

2060

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

2061

* 1000)

2062

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

1101

2063

1102

2064

# Interval - property

1103

@dbus_service_property(_interface, signature="t",

2065

@dbus_service_property(_interface,

2066

signature="t",

1104

2067

access="readwrite")

1105

2068

def Interval_dbus_property(self, value=None):

1106

2069

if value is None: # get

1107

return dbus.UInt64(self.interval_milliseconds())

2070

return dbus.UInt64(self.interval.total_seconds() * 1000)

1108

2071

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

1109

# Emit D-Bus signal

1110

self.PropertyChanged(dbus.String("Interval"),

1111

dbus.UInt64(value, variant_level=1))

1112

2072

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

1113

2073

return

1114

# Reschedule checker run

1115

gobject.source_remove(self.checker_initiator_tag)

1116

self.checker_initiator_tag = (gobject.timeout_add

1117

(value, self.start_checker))

1118

self.start_checker() # Start one now, too

1119

2074

if self.enabled:

2075

# Reschedule checker run

2076

GLib.source_remove(self.checker_initiator_tag)

2077

self.checker_initiator_tag = GLib.timeout_add(

2078

value, self.start_checker)

2079

self.start_checker() # Start one now, too

2080

1120

2081

# Checker - property

1121

@dbus_service_property(_interface, signature="s",

2082

@dbus_service_property(_interface,

2083

signature="s",

1122

2084

access="readwrite")

1123

2085

def Checker_dbus_property(self, value=None):

1124

2086

if value is None: # get

1125

2087

return dbus.String(self.checker_command)

1126

self.checker_command = value

1127

# Emit D-Bus signal

1128

self.PropertyChanged(dbus.String("Checker"),

1129

dbus.String(self.checker_command,

1130

variant_level=1))

2088

self.checker_command = str(value)

1131

2089

1132

2090

# CheckerRunning - property

1133

@dbus_service_property(_interface, signature="b",

2091

@dbus_service_property(_interface,

2092

signature="b",

1134

2093

access="readwrite")

1135

2094

def CheckerRunning_dbus_property(self, value=None):

1136

2095

if value is None: # get

1141

2100

self.stop_checker()

1142

2101

1143

2102

# ObjectPath - property

2103

@dbus_annotations(

2104

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

2105

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

1144

2106

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

1145

2107

def ObjectPath_dbus_property(self):

1146

2108

return self.dbus_object_path # is already a dbus.ObjectPath

1147

2109

1148

2110

# Secret = property

1149

@dbus_service_property(_interface, signature="ay",

1150

access="write", byte_arrays=True)

2111

@dbus_annotations(

2112

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

2113

"invalidates"})

2114

@dbus_service_property(_interface,

2115

signature="ay",

2116

access="write",

2117

byte_arrays=True)

1151

2118

def Secret_dbus_property(self, value):

1152

self.secret = str(value)

2119

self.secret = bytes(value)

1153

2120

1154

2121

del _interface

1155

2122

1159

2126

self._pipe = child_pipe

1160

2127

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

1161

2128

if not self._pipe.recv():

1162

raise KeyError()

1163

2129

raise KeyError(fpr)

2130

1164

2131

def __getattribute__(self, name):

1165

if(name == '_pipe'):

2132

if name == '_pipe':

1166

2133

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

1167

2134

self._pipe.send(('getattr', name))

1168

2135

data = self._pipe.recv()

1169

2136

if data[0] == 'data':

1170

2137

return data[1]

1171

2138

if data[0] == 'function':

2139

1172

2140

def func(*args, **kwargs):

1173

2141

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

1174

2142

return self._pipe.recv()[1]

2143

1175

2144

return func

1176

2145

1177

2146

def __setattr__(self, name, value):

1178

if(name == '_pipe'):

2147

if name == '_pipe':

1179

2148

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

1180

2149

self._pipe.send(('setattr', name, value))

1181

2150

1189

2158

def handle(self):

1190

2159

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

1191

2160

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

1192

unicode(self.client_address))

2161

str(self.client_address))

1193

2162

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

1194

2163

self.server.child_pipe.fileno())

1195

1196

session = (gnutls.connection

1197

.ClientSession(self.request,

1198

gnutls.connection

1199

.X509Credentials()))

1200

1201

# Note: gnutls.connection.X509Credentials is really a

1202

# generic GnuTLS certificate credentials object so long as

1203

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

1204

# here despite using OpenPGP certificates.

1205

2164

2165

session = gnutls.ClientSession(self.request)

2166

1206

2167

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

1207

2168

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

1208

2169

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

1211

2172

priority = self.server.gnutls_priority

1212

2173

if priority is None:

1213

2174

priority = "NORMAL"

1214

(gnutls.library.functions

1215

.gnutls_priority_set_direct(session._c_object,

1216

priority, None))

1217

2175

gnutls.priority_set_direct(session._c_object, priority,

2176

None)

2177

1218

2178

# Start communication using the Mandos protocol

1219

2179

# Get protocol number

1220

2180

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

1221

2181

logger.debug("Protocol version: %r", line)

1222

2182

try:

1223

2183

if int(line.strip().split()[0]) > 1:

1224

raise RuntimeError

2184

raise RuntimeError(line)

1225

2185

except (ValueError, IndexError, RuntimeError) as error:

1226

2186

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

1227

2187

return

1228

2188

1229

2189

# Start GnuTLS connection

1230

2190

try:

1231

2191

session.handshake()

1232

except gnutls.errors.GNUTLSError as error:

2192

except gnutls.Error as error:

1233

2193

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

1234

2194

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

1235

2195

# established. Just abandon the request.

1236

2196

return

1237

2197

logger.debug("Handshake succeeded")

1238

2198

1239

2199

approval_required = False

1240

2200

try:

1241

2201

try:

1242

fpr = self.fingerprint(self.peer_certificate

1243

(session))

1244

except (TypeError,

1245

gnutls.errors.GNUTLSError) as error:

2202

fpr = self.fingerprint(

2203

self.peer_certificate(session))

2204

except (TypeError, gnutls.Error) as error:

1246

2205

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

1247

2206

return

1248

2207

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

1249

2208

1250

2209

try:

1251

2210

client = ProxyClient(child_pipe, fpr,

1252

2211

self.client_address)

1260

2219

1261

2220

while True:

1262

2221

if not client.enabled:

1263

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

1264

client.name)

2222

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

2223

client.name)

1265

2224

if self.server.use_dbus:

1266

2225

# Emit D-Bus signal

1267

client.Rejected("Disabled")

2226

client.Rejected("Disabled")

1268

2227

return

1269

2228

1270

if client._approved or not client.approval_delay:

2229

if client.approved or not client.approval_delay:

1271

2230

#We are approved or approval is disabled

1272

2231

break

1273

elif client._approved is None:

2232

elif client.approved is None:

1274

2233

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

1275

2234

client.name)

1276

2235

if self.server.use_dbus:

1277

2236

# Emit D-Bus signal

1278

2237

client.NeedApproval(

1279

client.approval_delay_milliseconds(),

1280

client.approved_by_default)

2238

client.approval_delay.total_seconds()

2239

* 1000, client.approved_by_default)

1281

2240

else:

1282

2241

logger.warning("Client %s was not approved",

1283

2242

client.name)

1287

2246

return

1288

2247

1289

2248

#wait until timeout or approved

1290

#x = float(client._timedelta_to_milliseconds(delay))

1291

2249

time = datetime.datetime.now()

1292

2250

client.changedstate.acquire()

1293

client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))

2251

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

1294

2252

client.changedstate.release()

1295

2253

time2 = datetime.datetime.now()

1296

2254

if (time2 - time) >= delay:

1307

2265

else:

1308

2266

delay -= time2 - time

1309

2267

1310

sent_size = 0

1311

while sent_size < len(client.secret):

1312

try:

1313

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

1314

except gnutls.errors.GNUTLSError as error:

1315

logger.warning("gnutls send failed")

1316

return

1317

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

1318

sent, len(client.secret)

1319

- (sent_size + sent))

1320

sent_size += sent

1321

2268

try:

2269

session.send(client.secret)

2270

except gnutls.Error as error:

2271

logger.warning("gnutls send failed",

2272

exc_info = error)

2273

return

2274

1322

2275

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

1323

# bump the timeout as if seen

1324

client.checked_ok()

2276

# bump the timeout using extended_timeout

2277

client.bump_timeout(client.extended_timeout)

1325

2278

if self.server.use_dbus:

1326

2279

# Emit D-Bus signal

1327

2280

client.GotSecret()

1331

2284

client.approvals_pending -= 1

1332

2285

try:

1333

2286

session.bye()

1334

except gnutls.errors.GNUTLSError as error:

1335

logger.warning("GnuTLS bye failed")

2287

except gnutls.Error as error:

2288

logger.warning("GnuTLS bye failed",

2289

exc_info=error)

1336

2290

1337

2291

@staticmethod

1338

2292

def peer_certificate(session):

1339

2293

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

1340

2294

# If not an OpenPGP certificate...

1341

if (gnutls.library.functions

1342

.gnutls_certificate_type_get(session._c_object)

1343

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1344

# ...do the normal thing

1345

return session.peer_certificate

2295

if (gnutls.certificate_type_get(session._c_object)

2296

!= gnutls.CRT_OPENPGP):

2297

# ...return invalid data

2298

return b""

1346

2299

list_size = ctypes.c_uint(1)

1347

cert_list = (gnutls.library.functions

1348

.gnutls_certificate_get_peers

2300

cert_list = (gnutls.certificate_get_peers

1349

2301

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

1350

2302

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

1351

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

1352

" certificate")

2303

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

1353

2304

if list_size.value == 0:

1354

2305

return None

1355

2306

cert = cert_list[0]

1359

2310

def fingerprint(openpgp):

1360

2311

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1361

2312

# New GnuTLS "datum" with the OpenPGP public key

1362

datum = (gnutls.library.types

1363

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

1364

ctypes.POINTER

1365

(ctypes.c_ubyte)),

1366

ctypes.c_uint(len(openpgp))))

2313

datum = gnutls.datum_t(

2314

ctypes.cast(ctypes.c_char_p(openpgp),

2315

ctypes.POINTER(ctypes.c_ubyte)),

2316

ctypes.c_uint(len(openpgp)))

1367

2317

# New empty GnuTLS certificate

1368

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1369

(gnutls.library.functions

1370

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2318

crt = gnutls.openpgp_crt_t()

2319

gnutls.openpgp_crt_init(ctypes.byref(crt))

1371

2320

# Import the OpenPGP public key into the certificate

1372

(gnutls.library.functions

1373

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

1374

gnutls.library.constants

1375

.GNUTLS_OPENPGP_FMT_RAW))

2321

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

2322

gnutls.OPENPGP_FMT_RAW)

1376

2323

# Verify the self signature in the key

1377

2324

crtverify = ctypes.c_uint()

1378

(gnutls.library.functions

1379

.gnutls_openpgp_crt_verify_self(crt, 0,

1380

ctypes.byref(crtverify)))

2325

gnutls.openpgp_crt_verify_self(crt, 0,

2326

ctypes.byref(crtverify))

1381

2327

if crtverify.value != 0:

1382

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1383

raise (gnutls.errors.CertificateSecurityError

1384

("Verify failed"))

2328

gnutls.openpgp_crt_deinit(crt)

2329

raise gnutls.CertificateSecurityError("Verify failed")

1385

2330

# New buffer for the fingerprint

1386

2331

buf = ctypes.create_string_buffer(20)

1387

2332

buf_len = ctypes.c_size_t()

1388

2333

# Get the fingerprint from the certificate into the buffer

1389

(gnutls.library.functions

1390

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

1391

ctypes.byref(buf_len)))

2334

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

2335

ctypes.byref(buf_len))

1392

2336

# Deinit the certificate

1393

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2337

gnutls.openpgp_crt_deinit(crt)

1394

2338

# Convert the buffer to a Python bytestring

1395

2339

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

1396

2340

# Convert the bytestring to hexadecimal notation

1397

hex_fpr = ''.join("%02X" % ord(char) for char in fpr)

2341

hex_fpr = binascii.hexlify(fpr).upper()

1398

2342

return hex_fpr

1399

2343

1400

2344

1401

2345

class MultiprocessingMixIn(object):

1402

2346

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

2347

1403

2348

def sub_process_main(self, request, address):

1404

2349

try:

1405

2350

self.finish_request(request, address)

1406

except:

2351

except Exception:

1407

2352

self.handle_error(request, address)

1408

2353

self.close_request(request)

1409

2354

1410

2355

def process_request(self, request, address):

1411

2356

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

1412

multiprocessing.Process(target = self.sub_process_main,

1413

args = (request, address)).start()

2357

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

2358

args = (request, address))

2359

proc.start()

2360

return proc

2361

1414

2362

1415

2363

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1416

2364

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

2365

1417

2366

def process_request(self, request, client_address):

1418

2367

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

1419

2368

1420

2369

This function creates a new pipe in self.pipe

1421

2370

"""

1422

2371

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1423

1424

super(MultiprocessingMixInWithPipe,

1425

self).process_request(request, client_address)

2372

2373

proc = MultiprocessingMixIn.process_request(self, request,

2374

client_address)

1426

2375

self.child_pipe.close()

1427

self.add_pipe(parent_pipe)

1428

1429

def add_pipe(self, parent_pipe):

2376

self.add_pipe(parent_pipe, proc)

2377

2378

def add_pipe(self, parent_pipe, proc):

1430

2379

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

1431

raise NotImplementedError

2380

raise NotImplementedError()

2381

1432

2382

1433

2383

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1434

2384

socketserver.TCPServer, object):

1439

2389

interface: None or a network interface name (string)

1440

2390

use_ipv6: Boolean; to use IPv6 or not

1441

2391

"""

2392

1442

2393

def __init__(self, server_address, RequestHandlerClass,

1443

interface=None, use_ipv6=True):

2394

interface=None,

2395

use_ipv6=True,

2396

socketfd=None):

2397

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

2398

creating a new one with socket.socket().

2399

"""

1444

2400

self.interface = interface

1445

2401

if use_ipv6:

1446

2402

self.address_family = socket.AF_INET6

2403

if socketfd is not None:

2404

# Save the file descriptor

2405

self.socketfd = socketfd

2406

# Save the original socket.socket() function

2407

self.socket_socket = socket.socket

2408

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

2409

#

2410

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

2411

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

2412

# patching socket.socket.)

2413

#

2414

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

2415

@functools.wraps(socket.socket)

2416

def socket_wrapper(*args, **kwargs):

2417

# Restore original function so subsequent calls are

2418

# not affected.

2419

socket.socket = self.socket_socket

2420

del self.socket_socket

2421

# This time only, return a new socket object from the

2422

# saved file descriptor.

2423

return socket.fromfd(self.socketfd, *args, **kwargs)

2424

# Replace socket.socket() function with wrapper

2425

socket.socket = socket_wrapper

2426

# The socketserver.TCPServer.__init__ will call

2427

# socket.socket(), which might be our replacement,

2428

# socket_wrapper(), if socketfd was set.

1447

2429

socketserver.TCPServer.__init__(self, server_address,

1448

2430

RequestHandlerClass)

2431

1449

2432

def server_bind(self):

1450

2433

"""This overrides the normal server_bind() function

1451

2434

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

1457

2440

self.interface)

1458

2441

else:

1459

2442

try:

1460

self.socket.setsockopt(socket.SOL_SOCKET,

1461

SO_BINDTODEVICE,

1462

str(self.interface

1463

+ '\0'))

2443

self.socket.setsockopt(

2444

socket.SOL_SOCKET, SO_BINDTODEVICE,

2445

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

1464

2446

except socket.error as error:

1465

if error[0] == errno.EPERM:

1466

logger.error("No permission to"

1467

" bind to interface %s",

1468

self.interface)

1469

elif error[0] == errno.ENOPROTOOPT:

2447

if error.errno == errno.EPERM:

2448

logger.error("No permission to bind to"

2449

" interface %s", self.interface)

2450

elif error.errno == errno.ENOPROTOOPT:

1470

2451

logger.error("SO_BINDTODEVICE not available;"

1471

2452

" cannot bind to interface %s",

1472

2453

self.interface)

2454

elif error.errno == errno.ENODEV:

2455

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

2456

" cannot bind", self.interface)

1473

2457

else:

1474

2458

raise

1475

2459

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

1478

2462

if self.address_family == socket.AF_INET6:

1479

2463

any_address = "::" # in6addr_any

1480

2464

else:

1481

any_address = socket.INADDR_ANY

2465

any_address = "0.0.0.0" # INADDR_ANY

1482

2466

self.server_address = (any_address,

1483

2467

self.server_address[1])

1484

2468

elif not self.server_address[1]:

1485

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

1486

0)

2469

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

1487

2470

# if self.interface:

1488

2471

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

1489

2472

# 0, # port

1501

2484

gnutls_priority GnuTLS priority string

1502

2485

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

1503

2486

1504

Assumes a gobject.MainLoop event loop.

2487

Assumes a GLib.MainLoop event loop.

1505

2488

"""

2489

1506

2490

def __init__(self, server_address, RequestHandlerClass,

1507

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

1508

gnutls_priority=None, use_dbus=True):

2491

interface=None,

2492

use_ipv6=True,

2493

clients=None,

2494

gnutls_priority=None,

2495

use_dbus=True,

2496

socketfd=None):

1509

2497

self.enabled = False

1510

2498

self.clients = clients

1511

2499

if self.clients is None:

1512

self.clients = set()

2500

self.clients = {}

1513

2501

self.use_dbus = use_dbus

1514

2502

self.gnutls_priority = gnutls_priority

1515

2503

IPv6_TCPServer.__init__(self, server_address,

1516

2504

RequestHandlerClass,

1517

2505

interface = interface,

1518

use_ipv6 = use_ipv6)

2506

use_ipv6 = use_ipv6,

2507

socketfd = socketfd)

2508

1519

2509

def server_activate(self):

1520

2510

if self.enabled:

1521

2511

return socketserver.TCPServer.server_activate(self)

2512

1522

2513

def enable(self):

1523

2514

self.enabled = True

1524

def add_pipe(self, parent_pipe):

2515

2516

def add_pipe(self, parent_pipe, proc):

1525

2517

# Call "handle_ipc" for both data and EOF events

1526

gobject.io_add_watch(parent_pipe.fileno(),

1527

gobject.IO_IN | gobject.IO_HUP,

1528

functools.partial(self.handle_ipc,

1529

parent_pipe = parent_pipe))

1530

1531

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

2518

GLib.io_add_watch(

2519

parent_pipe.fileno(),

2520

GLib.IO_IN | GLib.IO_HUP,

2521

functools.partial(self.handle_ipc,

2522

parent_pipe = parent_pipe,

2523

proc = proc))

2524

2525

def handle_ipc(self, source, condition,

2526

parent_pipe=None,

2527

proc = None,

1532

2528

client_object=None):

1533

condition_names = {

1534

gobject.IO_IN: "IN", # There is data to read.

1535

gobject.IO_OUT: "OUT", # Data can be written (without

1536

# blocking).

1537

gobject.IO_PRI: "PRI", # There is urgent data to read.

1538

gobject.IO_ERR: "ERR", # Error condition.

1539

gobject.IO_HUP: "HUP" # Hung up (the connection has been

1540

# broken, usually for pipes and

1541

# sockets).

1542

}

1543

conditions_string = ' | '.join(name

1544

for cond, name in

1545

condition_names.iteritems()

1546

if cond & condition)

1547

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

1548

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

2529

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

2530

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

2531

# Wait for other process to exit

2532

proc.join()

1549

2533

return False

1550

2534

1551

2535

# Read a request from the child

1556

2540

fpr = request[1]

1557

2541

address = request[2]

1558

2542

1559

for c in self.clients:

2543

for c in self.clients.values():

1560

2544

if c.fingerprint == fpr:

1561

2545

client = c

1562

2546

break

1563

2547

else:

1564

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

1565

"dress: %s", fpr, address)

2548

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

2549

"dress: %s", fpr, address)

1566

2550

if self.use_dbus:

1567

2551

# Emit D-Bus signal

1568

mandos_dbus_service.ClientNotFound(fpr, address[0])

2552

mandos_dbus_service.ClientNotFound(fpr,

2553

address[0])

1569

2554

parent_pipe.send(False)

1570

2555

return False

1571

2556

1572

gobject.io_add_watch(parent_pipe.fileno(),

1573

gobject.IO_IN | gobject.IO_HUP,

1574

functools.partial(self.handle_ipc,

1575

parent_pipe = parent_pipe,

1576

client_object = client))

2557

GLib.io_add_watch(

2558

parent_pipe.fileno(),

2559

GLib.IO_IN | GLib.IO_HUP,

2560

functools.partial(self.handle_ipc,

2561

parent_pipe = parent_pipe,

2562

proc = proc,

2563

client_object = client))

1577

2564

parent_pipe.send(True)

1578

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

2565

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

2566

# same fileno

1579

2567

return False

1580

2568

if command == 'funcall':

1581

2569

funcname = request[1]

1582

2570

args = request[2]

1583

2571

kwargs = request[3]

1584

2572

1585

parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))

1586

2573

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

2574

funcname)(*args,

2575

**kwargs)))

2576

1587

2577

if command == 'getattr':

1588

2578

attrname = request[1]

1589

if callable(client_object.__getattribute__(attrname)):

1590

parent_pipe.send(('function',))

2579

if isinstance(client_object.__getattribute__(attrname),

2580

collections.Callable):

2581

parent_pipe.send(('function', ))

1591

2582

else:

1592

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

2583

parent_pipe.send((

2584

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

1593

2585

1594

2586

if command == 'setattr':

1595

2587

attrname = request[1]

1596

2588

value = request[2]

1597

2589

setattr(client_object, attrname, value)

1598

2590

1599

2591

return True

1600

2592

1601

2593

2594

def rfc3339_duration_to_delta(duration):

2595

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

2596

2597

>>> rfc3339_duration_to_delta("P7D")

2598

datetime.timedelta(7)

2599

>>> rfc3339_duration_to_delta("PT60S")

2600

datetime.timedelta(0, 60)

2601

>>> rfc3339_duration_to_delta("PT60M")

2602

datetime.timedelta(0, 3600)

2603

>>> rfc3339_duration_to_delta("PT24H")

2604

datetime.timedelta(1)

2605

>>> rfc3339_duration_to_delta("P1W")

2606

datetime.timedelta(7)

2607

>>> rfc3339_duration_to_delta("PT5M30S")

2608

datetime.timedelta(0, 330)

2609

>>> rfc3339_duration_to_delta("P1DT3M20S")

2610

datetime.timedelta(1, 200)

2611

"""

2612

2613

# Parsing an RFC 3339 duration with regular expressions is not

2614

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

2615

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

2616

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

2617

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

2618

# avoid excessive use of external libraries.

2619

2620

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

2621

Token = collections.namedtuple("Token", (

2622

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

2623

# a "group" containing digits

2624

"value", # datetime.timedelta or None

2625

"followers")) # Tokens valid after this token

2626

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

2627

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

2628

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

2629

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

2630

datetime.timedelta(seconds=1),

2631

frozenset((token_end, )))

2632

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

2633

datetime.timedelta(minutes=1),

2634

frozenset((token_second, token_end)))

2635

token_hour = Token(re.compile(r"(\d+)H"),

2636

datetime.timedelta(hours=1),

2637

frozenset((token_minute, token_end)))

2638

token_time = Token(re.compile(r"T"),

2639

None,

2640

frozenset((token_hour, token_minute,

2641

token_second)))

2642

token_day = Token(re.compile(r"(\d+)D"),

2643

datetime.timedelta(days=1),

2644

frozenset((token_time, token_end)))

2645

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

2646

datetime.timedelta(weeks=4),

2647

frozenset((token_day, token_end)))

2648

token_year = Token(re.compile(r"(\d+)Y"),

2649

datetime.timedelta(weeks=52),

2650

frozenset((token_month, token_end)))

2651

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

2652

datetime.timedelta(weeks=1),

2653

frozenset((token_end, )))

2654

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

2655

frozenset((token_year, token_month,

2656

token_day, token_time,

2657

token_week)))

2658

# Define starting values

2659

value = datetime.timedelta() # Value so far

2660

found_token = None

2661

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

2662

s = duration # String left to parse

2663

# Loop until end token is found

2664

while found_token is not token_end:

2665

# Search for any currently valid tokens

2666

for token in followers:

2667

match = token.regexp.match(s)

2668

if match is not None:

2669

# Token found

2670

if token.value is not None:

2671

# Value found, parse digits

2672

factor = int(match.group(1), 10)

2673

# Add to value so far

2674

value += factor * token.value

2675

# Strip token from string

2676

s = token.regexp.sub("", s, 1)

2677

# Go to found token

2678

found_token = token

2679

# Set valid next tokens

2680

followers = found_token.followers

2681

break

2682

else:

2683

# No currently valid tokens were found

2684

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

2685

.format(duration))

2686

# End token found

2687

return value

2688

2689

1602

2690

def string_to_delta(interval):

1603

2691

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

1604

2692

1615

2703

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

1616

2704

datetime.timedelta(0, 330)

1617

2705

"""

2706

2707

try:

2708

return rfc3339_duration_to_delta(interval)

2709

except ValueError:

2710

pass

2711

1618

2712

timevalue = datetime.timedelta(0)

1619

2713

for s in interval.split():

1620

2714

try:

1621

suffix = unicode(s[-1])

2715

suffix = s[-1]

1622

2716

value = int(s[:-1])

1623

2717

if suffix == "d":

1624

2718

delta = datetime.timedelta(value)

1631

2725

elif suffix == "w":

1632

2726

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

1633

2727

else:

1634

raise ValueError("Unknown suffix %r" % suffix)

1635

except (ValueError, IndexError) as e:

2728

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

2729

except IndexError as e:

1636

2730

raise ValueError(*(e.args))

1637

2731

timevalue += delta

1638

2732

return timevalue

1639

2733

1640

2734

1641

def if_nametoindex(interface):

1642

"""Call the C function if_nametoindex(), or equivalent

1643

1644

Note: This function cannot accept a unicode string."""

1645

global if_nametoindex

1646

try:

1647

if_nametoindex = (ctypes.cdll.LoadLibrary

1648

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

1649

.if_nametoindex)

1650

except (OSError, AttributeError):

1651

logger.warning("Doing if_nametoindex the hard way")

1652

def if_nametoindex(interface):

1653

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

1654

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

1655

with contextlib.closing(socket.socket()) as s:

1656

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1657

struct.pack(str("16s16x"),

1658

interface))

1659

interface_index = struct.unpack(str("I"),

1660

ifreq[16:20])[0]

1661

return interface_index

1662

return if_nametoindex(interface)

1663

1664

1665

2735

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

1666

2736

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

1667

2737

1675

2745

sys.exit()

1676

2746

if not noclose:

1677

2747

# Close all standard open file descriptors

1678

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

2748

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

1679

2749

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

1680

2750

raise OSError(errno.ENODEV,

1681

"%s not a character device"

1682

% os.path.devnull)

2751

"{} not a character device"

2752

.format(os.devnull))

1683

2753

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

1684

2754

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

1685

2755

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

1694

2764

1695

2765

parser = argparse.ArgumentParser()

1696

2766

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

1697

version = "%%(prog)s %s" % version,

2767

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

1698

2768

help="show version number and exit")

1699

2769

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

1700

2770

help="Bind to interface IF")

1706

2776

help="Run self-test")

1707

2777

parser.add_argument("--debug", action="store_true",

1708

2778

help="Debug mode; run in foreground and log"

1709

" to terminal")

2779

" to terminal", default=None)

1710

2780

parser.add_argument("--debuglevel", metavar="LEVEL",

1711

2781

help="Debug level for stdout output")

1712

2782

parser.add_argument("--priority", help="GnuTLS"

1719

2789

" files")

1720

2790

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

1721

2791

dest="use_dbus", help="Do not provide D-Bus"

1722

" system bus interface")

2792

" system bus interface", default=None)

1723

2793

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

1724

dest="use_ipv6", help="Do not use IPv6")

2794

dest="use_ipv6", help="Do not use IPv6",

2795

default=None)

2796

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

2797

dest="restore", help="Do not restore stored"

2798

" state", default=None)

2799

parser.add_argument("--socket", type=int,

2800

help="Specify a file descriptor to a network"

2801

" socket to use instead of creating one")

2802

parser.add_argument("--statedir", metavar="DIR",

2803

help="Directory to save/restore state in")

2804

parser.add_argument("--foreground", action="store_true",

2805

help="Run in foreground", default=None)

2806

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

2807

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

2808

default=None)

2809

1725

2810

options = parser.parse_args()

1726

2811

1727

2812

if options.check:

1728

2813

import doctest

1729

doctest.testmod()

1730

sys.exit()

2814

fail_count, test_count = doctest.testmod()

2815

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

1731

2816

1732

2817

# Default values for config file for server-global settings

1733

2818

server_defaults = { "interface": "",

1735

2820

"port": "",

1736

2821

"debug": "False",

1737

2822

"priority":

1738

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

2823

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

2824

":+SIGN-DSA-SHA256",

1739

2825

"servicename": "Mandos",

1740

2826

"use_dbus": "True",

1741

2827

"use_ipv6": "True",

1742

2828

"debuglevel": "",

1743

}

2829

"restore": "True",

2830

"socket": "",

2831

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

2832

"foreground": "False",

2833

"zeroconf": "True",

2834

}

1744

2835

1745

2836

# Parse config file for server-global settings

1746

2837

server_config = configparser.SafeConfigParser(server_defaults)

1747

2838

del server_defaults

1748

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

1749

"mandos.conf"))

2839

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

1750

2840

# Convert the SafeConfigParser object to a dict

1751

2841

server_settings = server_config.defaults()

1752

2842

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

1753

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

2843

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

1754

2844

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

1755

2845

option)

1756

2846

if server_settings["port"]:

1757

2847

server_settings["port"] = server_config.getint("DEFAULT",

1758

2848

"port")

2849

if server_settings["socket"]:

2850

server_settings["socket"] = server_config.getint("DEFAULT",

2851

"socket")

2852

# Later, stdin will, and stdout and stderr might, be dup'ed

2853

# over with an opened os.devnull. But we don't want this to

2854

# happen with a supplied network socket.

2855

if 0 <= server_settings["socket"] <= 2:

2856

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

2857

["socket"])

1759

2858

del server_config

1760

2859

1761

2860

# Override the settings from the config file with command line

1762

2861

# options, if set.

1763

2862

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

1764

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

1765

"use_dbus", "use_ipv6", "debuglevel"):

2863

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

2864

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

2865

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

1766

2866

value = getattr(options, option)

1767

2867

if value is not None:

1768

2868

server_settings[option] = value

1769

2869

del options

1770

2870

# Force all strings to be unicode

1771

2871

for option in server_settings.keys():

1772

if type(server_settings[option]) is str:

1773

server_settings[option] = unicode(server_settings[option])

2872

if isinstance(server_settings[option], bytes):

2873

server_settings[option] = (server_settings[option]

2874

.decode("utf-8"))

2875

# Force all boolean options to be boolean

2876

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

2877

"foreground", "zeroconf"):

2878

server_settings[option] = bool(server_settings[option])

2879

# Debug implies foreground

2880

if server_settings["debug"]:

2881

server_settings["foreground"] = True

1774

2882

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

1775

2883

1776

2884

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

1777

2885

2886

if (not server_settings["zeroconf"]

2887

and not (server_settings["port"]

2888

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

2889

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

2890

1778

2891

# For convenience

1779

2892

debug = server_settings["debug"]

1780

2893

debuglevel = server_settings["debuglevel"]

1781

2894

use_dbus = server_settings["use_dbus"]

1782

2895

use_ipv6 = server_settings["use_ipv6"]

1783

2896

stored_state_path = os.path.join(server_settings["statedir"],

2897

stored_state_file)

2898

foreground = server_settings["foreground"]

2899

zeroconf = server_settings["zeroconf"]

2900

2901

if debug:

2902

initlogger(debug, logging.DEBUG)

2903

else:

2904

if not debuglevel:

2905

initlogger(debug)

2906

else:

2907

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

2908

initlogger(debug, level)

2909

1784

2910

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

1785

syslogger.setFormatter(logging.Formatter

1786

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

1787

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

1788

% server_settings["servicename"]))

2911

syslogger.setFormatter(

2912

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

2913

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

2914

server_settings["servicename"])))

1789

2915

1790

2916

# Parse config file with clients

1791

client_defaults = { "timeout": "1h",

1792

"interval": "5m",

1793

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

1794

"host": "",

1795

"approval_delay": "0s",

1796

"approval_duration": "1s",

1797

}

1798

client_config = configparser.SafeConfigParser(client_defaults)

2917

client_config = configparser.SafeConfigParser(Client

2918

.client_defaults)

1799

2919

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

1800

2920

"clients.conf"))

1801

2921

1802

2922

global mandos_dbus_service

1803

2923

mandos_dbus_service = None

1804

2924

1805

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

1806

server_settings["port"]),

1807

ClientHandler,

1808

interface=(server_settings["interface"]

1809

or None),

1810

use_ipv6=use_ipv6,

1811

gnutls_priority=

1812

server_settings["priority"],

1813

use_dbus=use_dbus)

1814

if not debug:

1815

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

2925

socketfd = None

2926

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

2927

socketfd = server_settings["socket"]

2928

tcp_server = MandosServer(

2929

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

2930

ClientHandler,

2931

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

2932

use_ipv6=use_ipv6,

2933

gnutls_priority=server_settings["priority"],

2934

use_dbus=use_dbus,

2935

socketfd=socketfd)

2936

if not foreground:

2937

pidfilename = "/run/mandos.pid"

2938

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

2939

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

2940

pidfile = None

1816

2941

try:

1817

pidfile = open(pidfilename, "w")

1818

except IOError:

1819

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

2942

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

2943

except IOError as e:

2944

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

2945

exc_info=e)

1820

2946

1821

try:

1822

uid = pwd.getpwnam("_mandos").pw_uid

1823

gid = pwd.getpwnam("_mandos").pw_gid

1824

except KeyError:

2947

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

2948

("mandos", "mandos"),

2949

("nobody", "nogroup")):

1825

2950

try:

1826

uid = pwd.getpwnam("mandos").pw_uid

1827

gid = pwd.getpwnam("mandos").pw_gid

2951

uid = pwd.getpwnam(name).pw_uid

2952

gid = pwd.getpwnam(group).pw_gid

2953

break

1828

2954

except KeyError:

1829

try:

1830

uid = pwd.getpwnam("nobody").pw_uid

1831

gid = pwd.getpwnam("nobody").pw_gid

1832

except KeyError:

1833

uid = 65534

1834

gid = 65534

2955

continue

2956

else:

2957

uid = 65534

2958

gid = 65534

1835

2959

try:

1836

2960

os.setgid(gid)

1837

2961

os.setuid(uid)

2962

if debug:

2963

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

2964

gid))

1838

2965

except OSError as error:

1839

if error[0] != errno.EPERM:

1840

raise error

2966

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

2967

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

2968

if error.errno != errno.EPERM:

2969

raise

1841

2970

1842

if not debug and not debuglevel:

1843

syslogger.setLevel(logging.WARNING)

1844

console.setLevel(logging.WARNING)

1845

if debuglevel:

1846

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

1847

syslogger.setLevel(level)

1848

console.setLevel(level)

1849

1850

2971

if debug:

1851

2972

# Enable all possible GnuTLS debugging

1852

2973

1853

2974

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

1854

2975

# - GnuTLS manual

1855

gnutls.library.functions.gnutls_global_set_log_level(11)

2976

gnutls.global_set_log_level(11)

1856

2977

1857

@gnutls.library.types.gnutls_log_func

2978

@gnutls.log_func

1858

2979

def debug_gnutls(level, string):

1859

2980

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

1860

2981

1861

(gnutls.library.functions

1862

.gnutls_global_set_log_function(debug_gnutls))

2982

gnutls.global_set_log_function(debug_gnutls)

1863

2983

1864

2984

# Redirect stdin so all checkers get /dev/null

1865

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

2985

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

1866

2986

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

1867

2987

if null > 2:

1868

2988

os.close(null)

1869

else:

1870

# No console logging

1871

logger.removeHandler(console)

1872

2989

1873

2990

# Need to fork before connecting to D-Bus

1874

if not debug:

2991

if not foreground:

1875

2992

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

1876

2993

daemon()

1877

2994

2995

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

2996

# to inform GLib that threads will be used.

2997

GLib.threads_init()

2998

1878

2999

global main_loop

1879

3000

# From the Avahi example code

1880

DBusGMainLoop(set_as_default=True )

1881

main_loop = gobject.MainLoop()

3001

DBusGMainLoop(set_as_default=True)

3002

main_loop = GLib.MainLoop()

1882

3003

bus = dbus.SystemBus()

1883

3004

# End of Avahi example code

1884

3005

if use_dbus:

1885

3006

try:

1886

bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",

1887

bus, do_not_queue=True)

1888

except dbus.exceptions.NameExistsException as e:

1889

logger.error(unicode(e) + ", disabling D-Bus")

3007

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

3008

bus,

3009

do_not_queue=True)

3010

old_bus_name = dbus.service.BusName(

3011

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

3012

do_not_queue=True)

3013

except dbus.exceptions.DBusException as e:

3014

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

1890

3015

use_dbus = False

1891

3016

server_settings["use_dbus"] = False

1892

3017

tcp_server.use_dbus = False

1893

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1894

service = AvahiService(name = server_settings["servicename"],

1895

servicetype = "_mandos._tcp",

1896

protocol = protocol, bus = bus)

1897

if server_settings["interface"]:

1898

service.interface = (if_nametoindex

1899

(str(server_settings["interface"])))

3018

if zeroconf:

3019

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3020

service = AvahiServiceToSyslog(

3021

name = server_settings["servicename"],

3022

servicetype = "_mandos._tcp",

3023

protocol = protocol,

3024

bus = bus)

3025

if server_settings["interface"]:

3026

service.interface = if_nametoindex(

3027

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

1900

3028

1901

3029

global multiprocessing_manager

1902

3030

multiprocessing_manager = multiprocessing.Manager()

1904

3032

client_class = Client

1905

3033

if use_dbus:

1906

3034

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

1907

def client_config_items(config, section):

1908

special_settings = {

1909

"approved_by_default":

1910

lambda: config.getboolean(section,

1911

"approved_by_default"),

1912

}

1913

for name, value in config.items(section):

3035

3036

client_settings = Client.config_parser(client_config)

3037

old_client_settings = {}

3038

clients_data = {}

3039

3040

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

3041

global wnull

3042

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

3043

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

3044

# mode

3045

if debug or not foreground:

3046

wnull.close()

3047

3048

# Get client data and settings from last running state.

3049

if server_settings["restore"]:

3050

try:

3051

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

3052

if sys.version_info.major == 2:

3053

clients_data, old_client_settings = pickle.load(

3054

stored_state)

3055

else:

3056

bytes_clients_data, bytes_old_client_settings = (

3057

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

3058

### Fix bytes to strings

3059

## clients_data

3060

# .keys()

3061

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

3062

if isinstance(key, bytes)

3063

else key): value

3064

for key, value in

3065

bytes_clients_data.items() }

3066

del bytes_clients_data

3067

for key in clients_data:

3068

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

3069

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

3070

for k, v in

3071

clients_data[key].items() }

3072

clients_data[key] = value

3073

# .client_structure

3074

value["client_structure"] = [

3075

(s.decode("utf-8")

3076

if isinstance(s, bytes)

3077

else s) for s in

3078

value["client_structure"] ]

3079

# .name & .host

3080

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

3081

if isinstance(value[k], bytes):

3082

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

3083

## old_client_settings

3084

# .keys()

3085

old_client_settings = {

3086

(key.decode("utf-8")

3087

if isinstance(key, bytes)

3088

else key): value

3089

for key, value in

3090

bytes_old_client_settings.items() }

3091

del bytes_old_client_settings

3092

# .host

3093

for value in old_client_settings.values():

3094

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

3095

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

3096

.decode("utf-8"))

3097

os.remove(stored_state_path)

3098

except IOError as e:

3099

if e.errno == errno.ENOENT:

3100

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

3101

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

3102

else:

3103

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

3104

exc_info=e)

3105

raise

3106

except EOFError as e:

3107

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

3108

"EOFError:",

3109

exc_info=e)

3110

3111

with PGPEngine() as pgp:

3112

for client_name, client in clients_data.items():

3113

# Skip removed clients

3114

if client_name not in client_settings:

3115

continue

3116

3117

# Decide which value to use after restoring saved state.

3118

# We have three different values: Old config file,

3119

# new config file, and saved state.

3120

# New config value takes precedence if it differs from old

3121

# config value, otherwise use saved state.

3122

for name, value in client_settings[client_name].items():

3123

try:

3124

# For each value in new config, check if it

3125

# differs from the old config value (Except for

3126

# the "secret" attribute)

3127

if (name != "secret"

3128

and (value !=

3129

old_client_settings[client_name][name])):

3130

client[name] = value

3131

except KeyError:

3132

pass

3133

3134

# Clients who has passed its expire date can still be

3135

# enabled if its last checker was successful. A Client

3136

# whose checker succeeded before we stored its state is

3137

# assumed to have successfully run all checkers during

3138

# downtime.

3139

if client["enabled"]:

3140

if datetime.datetime.utcnow() >= client["expires"]:

3141

if not client["last_checked_ok"]:

3142

logger.warning(

3143

"disabling client {} - Client never "

3144

"performed a successful checker".format(

3145

client_name))

3146

client["enabled"] = False

3147

elif client["last_checker_status"] != 0:

3148

logger.warning(

3149

"disabling client {} - Client last"

3150

" checker failed with error code"

3151

" {}".format(

3152

client_name,

3153

client["last_checker_status"]))

3154

client["enabled"] = False

3155

else:

3156

client["expires"] = (

3157

datetime.datetime.utcnow()

3158

+ client["timeout"])

3159

logger.debug("Last checker succeeded,"

3160

" keeping {} enabled".format(

3161

client_name))

1914

3162

try:

1915

yield (name, special_settings[name]())

1916

except KeyError:

1917

yield (name, value)

1918

1919

tcp_server.clients.update(set(

1920

client_class(name = section,

1921

config= dict(client_config_items(

1922

client_config, section)))

1923

for section in client_config.sections()))

3163

client["secret"] = pgp.decrypt(

3164

client["encrypted_secret"],

3165

client_settings[client_name]["secret"])

3166

except PGPError:

3167

# If decryption fails, we use secret from new settings

3168

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

3169

client_name))

3170

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

3171

["secret"])

3172

3173

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

3174

for client_name in (set(old_client_settings)

3175

- set(client_settings)):

3176

del clients_data[client_name]

3177

for client_name in (set(client_settings)

3178

- set(old_client_settings)):

3179

clients_data[client_name] = client_settings[client_name]

3180

3181

# Create all client objects

3182

for client_name, client in clients_data.items():

3183

tcp_server.clients[client_name] = client_class(

3184

name = client_name,

3185

settings = client,

3186

server_settings = server_settings)

3187

1924

3188

if not tcp_server.clients:

1925

3189

logger.warning("No clients defined")

1926

1927

if not debug:

1928

try:

1929

with pidfile:

1930

pid = os.getpid()

1931

pidfile.write(str(pid) + "\n".encode("utf-8"))

1932

del pidfile

1933

except IOError:

1934

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

1935

pidfilename, pid)

1936

except NameError:

1937

# "pidfile" was never created

1938

pass

3190

3191

if not foreground:

3192

if pidfile is not None:

3193

pid = os.getpid()

3194

try:

3195

with pidfile:

3196

print(pid, file=pidfile)

3197

except IOError:

3198

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

3199

pidfilename, pid)

3200

del pidfile

1939

3201

del pidfilename

3202

3203

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

3204

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3205

lambda: main_loop.quit() and False)

3206

3207

if use_dbus:

1940

3208

1941

signal.signal(signal.SIGINT, signal.SIG_IGN)

1942

1943

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

1944

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

1945

1946

if use_dbus:

1947

class MandosDBusService(dbus.service.Object):

3209

@alternate_dbus_interfaces(

3210

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

3211

class MandosDBusService(DBusObjectWithObjectManager):

1948

3212

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

3213

1949

3214

def __init__(self):

1950

3215

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

1951

_interface = "se.bsnet.fukt.Mandos"

3216

3217

_interface = "se.recompile.Mandos"

1952

3218

1953

3219

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

1954

3220

def ClientAdded(self, objpath):

1960

3226

"D-Bus signal"

1961

3227

pass

1962

3228

3229

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

3230

"true"})

1963

3231

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

1964

3232

def ClientRemoved(self, objpath, name):

1965

3233

"D-Bus signal"

1966

3234

pass

1967

3235

3236

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

3237

"true"})

1968

3238

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

1969

3239

def GetAllClients(self):

1970

3240

"D-Bus method"

1971

return dbus.Array(c.dbus_object_path

1972

for c in tcp_server.clients)

3241

return dbus.Array(c.dbus_object_path for c in

3242

tcp_server.clients.values())

1973

3243

3244

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

3245

"true"})

1974

3246

@dbus.service.method(_interface,

1975

3247

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

1976

3248

def GetAllClientsWithProperties(self):

1977

3249

"D-Bus method"

1978

3250

return dbus.Dictionary(

1979

((c.dbus_object_path, c.GetAll(""))

1980

for c in tcp_server.clients),

3251

{ c.dbus_object_path: c.GetAll(

3252

"se.recompile.Mandos.Client")

3253

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

1981

3254

signature="oa{sv}")

1982

3255

1983

3256

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

1984

3257

def RemoveClient(self, object_path):

1985

3258

"D-Bus method"

1986

for c in tcp_server.clients:

3259

for c in tcp_server.clients.values():

1987

3260

if c.dbus_object_path == object_path:

1988

tcp_server.clients.remove(c)

3261

del tcp_server.clients[c.name]

1989

3262

c.remove_from_connection()

1990

# Don't signal anything except ClientRemoved

3263

# Don't signal the disabling

1991

3264

c.disable(quiet=True)

1992

# Emit D-Bus signal

1993

self.ClientRemoved(object_path, c.name)

3265

# Emit D-Bus signal for removal

3266

self.client_removed_signal(c)

1994

3267

return

1995

3268

raise KeyError(object_path)

1996

3269

1997

3270

del _interface

3271

3272

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3273

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

3274

def GetManagedObjects(self):

3275

"""D-Bus method"""

3276

return dbus.Dictionary(

3277

{ client.dbus_object_path:

3278

dbus.Dictionary(

3279

{ interface: client.GetAll(interface)

3280

for interface in

3281

client._get_all_interface_names()})

3282

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

3283

3284

def client_added_signal(self, client):

3285

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

3286

if use_dbus:

3287

# New standard signal

3288

self.InterfacesAdded(

3289

client.dbus_object_path,

3290

dbus.Dictionary(

3291

{ interface: client.GetAll(interface)

3292

for interface in

3293

client._get_all_interface_names()}))

3294

# Old signal

3295

self.ClientAdded(client.dbus_object_path)

3296

3297

def client_removed_signal(self, client):

3298

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

3299

if use_dbus:

3300

# New standard signal

3301

self.InterfacesRemoved(

3302

client.dbus_object_path,

3303

client._get_all_interface_names())

3304

# Old signal

3305

self.ClientRemoved(client.dbus_object_path,

3306

client.name)

1998

3307

1999

3308

mandos_dbus_service = MandosDBusService()

2000

3309

2001

3310

def cleanup():

2002

3311

"Cleanup function; run on exit"

2003

service.cleanup()

2004

3312

if zeroconf:

3313

service.cleanup()

3314

3315

multiprocessing.active_children()

3316

wnull.close()

3317

if not (tcp_server.clients or client_settings):

3318

return

3319

3320

# Store client before exiting. Secrets are encrypted with key

3321

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

3322

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

3323

clients = {}

3324

with PGPEngine() as pgp:

3325

for client in tcp_server.clients.values():

3326

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

3327

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

3328

key)

3329

client_dict = {}

3330

3331

# A list of attributes that can not be pickled

3332

# + secret.

3333

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

3334

"checker", "server_settings" }

3335

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

3336

.Object):

3337

exclude.add(name)

3338

3339

client_dict["encrypted_secret"] = (client

3340

.encrypted_secret)

3341

for attr in client.client_structure:

3342

if attr not in exclude:

3343

client_dict[attr] = getattr(client, attr)

3344

3345

clients[client.name] = client_dict

3346

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

3347

3348

try:

3349

with tempfile.NamedTemporaryFile(

3350

mode='wb',

3351

suffix=".pickle",

3352

prefix='clients-',

3353

dir=os.path.dirname(stored_state_path),

3354

delete=False) as stored_state:

3355

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

3356

protocol = 2)

3357

tempname = stored_state.name

3358

os.rename(tempname, stored_state_path)

3359

except (IOError, OSError) as e:

3360

if not debug:

3361

try:

3362

os.remove(tempname)

3363

except NameError:

3364

pass

3365

if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):

3366

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

3367

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

3368

else:

3369

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

3370

exc_info=e)

3371

raise

3372

3373

# Delete all clients, and settings from config

2005

3374

while tcp_server.clients:

2006

client = tcp_server.clients.pop()

3375

name, client = tcp_server.clients.popitem()

2007

3376

if use_dbus:

2008

3377

client.remove_from_connection()

2009

client.disable_hook = None

2010

# Don't signal anything except ClientRemoved

3378

# Don't signal the disabling

2011

3379

client.disable(quiet=True)

3380

# Emit D-Bus signal for removal

2012

3381

if use_dbus:

2013

# Emit D-Bus signal

2014

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2015

client.name)

3382

mandos_dbus_service.client_removed_signal(client)

3383

client_settings.clear()

2016

3384

2017

3385

atexit.register(cleanup)

2018

3386

2019

for client in tcp_server.clients:

3387

for client in tcp_server.clients.values():

2020

3388

if use_dbus:

2021

# Emit D-Bus signal

2022

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2023

client.enable()

3389

# Emit D-Bus signal for adding

3390

mandos_dbus_service.client_added_signal(client)

3391

# Need to initiate checking of clients

3392

if client.enabled:

3393

client.init_checker()

2024

3394

2025

3395

tcp_server.enable()

2026

3396

tcp_server.server_activate()

2027

3397

2028

3398

# Find out what port we got

2029

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

3399

if zeroconf:

3400

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

2030

3401

if use_ipv6:

2031

3402

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

2032

" flowinfo %d, scope_id %d"

2033

% tcp_server.socket.getsockname())

3403

" flowinfo %d, scope_id %d",

3404

*tcp_server.socket.getsockname())

2034

3405

else: # IPv4

2035

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

2036

% tcp_server.socket.getsockname())

3406

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

3407

*tcp_server.socket.getsockname())

2037

3408

2038

3409

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

2039

3410

2040

3411

try:

2041

# From the Avahi example code

2042

try:

2043

service.activate()

2044

except dbus.exceptions.DBusException as error:

2045

logger.critical("DBusException: %s", error)

2046

cleanup()

2047

sys.exit(1)

2048

# End of Avahi example code

3412

if zeroconf:

3413

# From the Avahi example code

3414

try:

3415

service.activate()

3416

except dbus.exceptions.DBusException as error:

3417

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

3418

cleanup()

3419

sys.exit(1)

3420

# End of Avahi example code

2049

3421

2050

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

2051

lambda *args, **kwargs:

2052

(tcp_server.handle_request

2053

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

3422

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

3423

lambda *args, **kwargs:

3424

(tcp_server.handle_request

3425

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

2054

3426

2055

3427

logger.debug("Starting main loop")

2056

3428

main_loop.run()

2057

3429

except AvahiError as error:

2058

logger.critical("AvahiError: %s", error)

3430

logger.critical("Avahi Error", exc_info=error)

2059

3431

cleanup()

2060

3432

sys.exit(1)

2061

3433

except KeyboardInterrupt:

2066

3438

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

2067

3439

cleanup()

2068

3440

3441

2069

3442

if __name__ == '__main__':

2070

3443

main()