/mandos/trunk : revision 505.1.7

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

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

37

import SocketServer as socketserver

46

38

import socket

47

39

import argparse

48

40

import datetime

49

41

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

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

54

49

import sys

55

50

import re

56

51

import os

65

60

import struct

66

61

import fcntl

67

62

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

63

import cPickle as pickle

72

64

import multiprocessing

73

65

import types

74

import binascii

75

import tempfile

76

import itertools

77

import collections

78

import codecs

79

66

80

67

import dbus

81

68

import dbus.service

82

from gi.repository import GLib

69

import gobject

70

import avahi

83

71

from dbus.mainloop.glib import DBusGMainLoop

84

72

import ctypes

85

73

import ctypes.util

86

74

import xml.dom.minidom

87

75

import inspect

88

76

89

# Try to find the value of SO_BINDTODEVICE:

90

77

try:

91

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

92

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

93

78

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

79

except AttributeError:

95

80

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

81

from IN import SO_BINDTODEVICE

99

82

except ImportError:

100

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

101

# Try running the C preprocessor:

102

try:

103

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

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

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

109

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

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.7"

118

stored_state_file = "clients.pickle"

119

120

logger = logging.getLogger()

121

syslogger = None

122

123

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

126

except (OSError, AttributeError):

127

128

def if_nametoindex(interface):

129

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

130

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

131

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

132

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

133

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

134

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

135

return interface_index

136

137

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

154

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

155

"""init logger and add loglevel"""

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

160

address = "/dev/log"))

161

syslogger.setFormatter(logging.Formatter

162

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

163

' %(message)s'))

164

logger.addHandler(syslogger)

165

166

if debug:

167

console = logging.StreamHandler()

168

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

169

' [%(process)d]:'

170

' %(levelname)s:'

171

' %(message)s'))

172

logger.addHandler(console)

173

logger.setLevel(level)

174

175

176

class PGPError(Exception):

177

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

178

pass

179

180

181

class PGPEngine(object):

182

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

183

184

def __init__(self):

185

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

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

'--force-mdc',

200

'--quiet']

201

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

202

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

203

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

204

205

def __enter__(self):

206

return self

207

208

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

209

self._cleanup()

210

return False

211

212

def __del__(self):

213

self._cleanup()

214

215

def _cleanup(self):

216

if self.tempdir is not None:

217

# Delete contents of tempdir

218

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

219

topdown = False):

220

for filename in files:

221

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

222

for dirname in dirs:

223

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

224

# Remove tempdir

225

os.rmdir(self.tempdir)

226

self.tempdir = None

227

228

def password_encode(self, password):

229

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

230

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

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

238

239

def encrypt(self, data, password):

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin = subprocess.PIPE,

250

stdout = subprocess.PIPE,

251

stderr = subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

raise PGPError(err)

255

return ciphertext

256

257

def decrypt(self, data, password):

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir = self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin = subprocess.PIPE,

268

stdout = subprocess.PIPE,

269

stderr = subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

raise PGPError(err)

273

return decrypted_plaintext

274

275

# Pretend that we have an Avahi module

276

class Avahi(object):

277

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

278

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

279

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

280

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

281

PROTO_INET = 0 # avahi-common/address.h

282

PROTO_INET6 = 1 # avahi-common/address.h

283

DBUS_NAME = "org.freedesktop.Avahi"

284

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

285

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

286

DBUS_PATH_SERVER = "/"

287

def string_array_to_txt_array(self, t):

288

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

289

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

290

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

291

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

292

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

293

SERVER_INVALID = 0 # avahi-common/defs.h

294

SERVER_REGISTERING = 1 # avahi-common/defs.h

295

SERVER_RUNNING = 2 # avahi-common/defs.h

296

SERVER_COLLISION = 3 # avahi-common/defs.h

297

SERVER_FAILURE = 4 # avahi-common/defs.h

298

avahi = Avahi()

83

SO_BINDTODEVICE = None

84

85

86

version = "1.3.1"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

90

syslogger = (logging.handlers.SysLogHandler

91

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

299

103

300

104

class AvahiError(Exception):

301

105

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

302

106

self.value = value

303

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

304

**kwargs)

305

107

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

108

def __unicode__(self):

109

return unicode(repr(self.value))

306

110

307

111

class AvahiServiceError(AvahiError):

308

112

pass

309

113

310

311

114

class AvahiGroupError(AvahiError):

312

115

pass

313

116

320

123

Used to optionally bind to the specified interface.

321

124

name: string; Example: 'Mandos'

322

125

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

323

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

126

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

324

127

port: integer; what port to announce

325

128

TXT: list of strings; TXT record for the service

326

129

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

332

135

server: D-Bus Server

333

136

bus: dbus.SystemBus()

334

137

"""

335

336

def __init__(self,

337

interface = avahi.IF_UNSPEC,

338

name = None,

339

servicetype = None,

340

port = None,

341

TXT = None,

342

domain = "",

343

host = "",

344

max_renames = 32768,

345

protocol = avahi.PROTO_UNSPEC,

346

bus = None):

138

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

139

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

140

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

141

protocol = avahi.PROTO_UNSPEC, bus = None):

347

142

self.interface = interface

348

143

self.name = name

349

144

self.type = servicetype

358

153

self.server = None

359

154

self.bus = bus

360

155

self.entry_group_state_changed_match = None

361

362

def rename(self, remove=True):

156

def rename(self):

363

157

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

364

158

if self.rename_count >= self.max_renames:

365

159

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

366

160

" after %i retries, exiting.",

367

161

self.rename_count)

368

162

raise AvahiServiceError("Too many renames")

369

self.name = str(

370

self.server.GetAlternativeServiceName(self.name))

371

self.rename_count += 1

163

self.name = unicode(self.server

164

.GetAlternativeServiceName(self.name))

372

165

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

373

166

self.name)

374

if remove:

375

self.remove()

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

self.remove()

376

172

try:

377

173

self.add()

378

174

except dbus.exceptions.DBusException as error:

379

if (error.get_dbus_name()

380

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

381

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

382

return self.rename(remove=False)

383

else:

384

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

385

self.cleanup()

386

os._exit(1)

387

175

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

176

self.cleanup()

177

os._exit(1)

178

self.rename_count += 1

388

179

def remove(self):

389

180

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

390

181

if self.entry_group_state_changed_match is not None:

392

183

self.entry_group_state_changed_match = None

393

184

if self.group is not None:

394

185

self.group.Reset()

395

396

186

def add(self):

397

187

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

398

188

self.remove()

403

193

avahi.DBUS_INTERFACE_ENTRY_GROUP)

404

194

self.entry_group_state_changed_match = (

405

195

self.group.connect_to_signal(

406

'StateChanged', self.entry_group_state_changed))

196

'StateChanged', self .entry_group_state_changed))

407

197

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

408

198

self.name, self.type)

409

199

self.group.AddService(

415

205

dbus.UInt16(self.port),

416

206

avahi.string_array_to_txt_array(self.TXT))

417

207

self.group.Commit()

418

419

208

def entry_group_state_changed(self, state, error):

420

209

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

421

210

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

427

216

self.rename()

428

217

elif state == avahi.ENTRY_GROUP_FAILURE:

429

218

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

430

str(error))

431

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

432

219

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

433

222

def cleanup(self):

434

223

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

435

224

if self.group is not None:

436

225

try:

437

226

self.group.Free()

438

227

except (dbus.exceptions.UnknownMethodException,

439

dbus.exceptions.DBusException):

228

dbus.exceptions.DBusException) as e:

440

229

pass

441

230

self.group = None

442

231

self.remove()

443

444

232

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

445

233

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

446

234

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

447

bad_states = {

448

avahi.SERVER_INVALID: "Zeroconf server invalid",

449

avahi.SERVER_REGISTERING: None,

450

avahi.SERVER_COLLISION: "Zeroconf server name collision",

451

avahi.SERVER_FAILURE: "Zeroconf server failure",

452

}

235

bad_states = { avahi.SERVER_INVALID:

236

"Zeroconf server invalid",

237

avahi.SERVER_REGISTERING: None,

238

avahi.SERVER_COLLISION:

239

"Zeroconf server name collision",

240

avahi.SERVER_FAILURE:

241

"Zeroconf server failure" }

453

242

if state in bad_states:

454

243

if bad_states[state] is not None:

455

244

if error is None:

458

247

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

459

248

self.cleanup()

460

249

elif state == avahi.SERVER_RUNNING:

461

try:

462

self.add()

463

except dbus.exceptions.DBusException as error:

464

if (error.get_dbus_name()

465

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

466

logger.info("Local Zeroconf service name"

467

" collision.")

468

return self.rename(remove=False)

469

else:

470

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

471

self.cleanup()

472

os._exit(1)

250

self.add()

473

251

else:

474

252

if error is None:

475

253

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

476

254

else:

477

255

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

478

479

256

def activate(self):

480

257

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

481

258

if self.server is None:

485

262

follow_name_owner_changes=True),

486

263

avahi.DBUS_INTERFACE_SERVER)

487

264

self.server.connect_to_signal("StateChanged",

488

self.server_state_changed)

265

self.server_state_changed)

489

266

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

490

267

491

268

492

class AvahiServiceToSyslog(AvahiService):

493

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

494

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

495

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

496

syslogger.setFormatter(logging.Formatter(

497

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

498

.format(self.name)))

499

return ret

500

501

# Pretend that we have a GnuTLS module

502

class GnuTLS(object):

503

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

504

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

505

506

_library = ctypes.cdll.LoadLibrary(

507

ctypes.util.find_library("gnutls"))

508

_need_version = b"3.3.0"

509

def __init__(self):

510

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

511

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

512

# happens.

513

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

514

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

515

.format(self._need_version))

516

517

# Unless otherwise indicated, the constants and types below are

518

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

519

520

# Constants

521

E_SUCCESS = 0

522

E_INTERRUPTED = -52

523

E_AGAIN = -28

524

CRT_OPENPGP = 2

525

CLIENT = 2

526

SHUT_RDWR = 0

527

CRD_CERTIFICATE = 1

528

E_NO_CERTIFICATE_FOUND = -49

529

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

530

531

# Types

532

class session_int(ctypes.Structure):

533

_fields_ = []

534

session_t = ctypes.POINTER(session_int)

535

class certificate_credentials_st(ctypes.Structure):

536

_fields_ = []

537

certificate_credentials_t = ctypes.POINTER(

538

certificate_credentials_st)

539

certificate_type_t = ctypes.c_int

540

class datum_t(ctypes.Structure):

541

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

542

('size', ctypes.c_uint)]

543

class openpgp_crt_int(ctypes.Structure):

544

_fields_ = []

545

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

546

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

547

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

548

credentials_type_t = ctypes.c_int

549

transport_ptr_t = ctypes.c_void_p

550

close_request_t = ctypes.c_int

551

552

# Exceptions

553

class Error(Exception):

554

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

555

# exception might be raised from within GnuTLS.__init__,

556

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

557

# global variable has happened.

558

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

559

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

560

# code is passed, convert it to a string with

561

# gnutls.strerror()

562

self.code = code

563

if message is None and code is not None:

564

message = GnuTLS.strerror(code)

565

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

566

message, *args)

567

568

class CertificateSecurityError(Error):

569

pass

570

571

# Classes

572

class Credentials(object):

573

def __init__(self):

574

self._c_object = gnutls.certificate_credentials_t()

575

gnutls.certificate_allocate_credentials(

576

ctypes.byref(self._c_object))

577

self.type = gnutls.CRD_CERTIFICATE

578

579

def __del__(self):

580

gnutls.certificate_free_credentials(self._c_object)

581

582

class ClientSession(object):

583

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

584

self._c_object = gnutls.session_t()

585

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

586

gnutls.set_default_priority(self._c_object)

587

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

588

gnutls.handshake_set_private_extensions(self._c_object,

589

True)

590

self.socket = socket

591

if credentials is None:

592

credentials = gnutls.Credentials()

593

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

594

ctypes.cast(credentials._c_object,

595

ctypes.c_void_p))

596

self.credentials = credentials

597

598

def __del__(self):

599

gnutls.deinit(self._c_object)

600

601

def handshake(self):

602

return gnutls.handshake(self._c_object)

603

604

def send(self, data):

605

data = bytes(data)

606

data_len = len(data)

607

while data_len > 0:

608

data_len -= gnutls.record_send(self._c_object,

609

data[-data_len:],

610

data_len)

611

612

def bye(self):

613

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

614

615

# Error handling functions

616

def _error_code(result):

617

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

618

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

619

if result >= 0:

620

return result

621

if result == gnutls.E_NO_CERTIFICATE_FOUND:

622

raise gnutls.CertificateSecurityError(code = result)

623

raise gnutls.Error(code = result)

624

625

def _retry_on_error(result, func, arguments):

626

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

627

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

628

while result < 0:

629

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

630

return _error_code(result)

631

result = func(*arguments)

632

return result

633

634

# Unless otherwise indicated, the function declarations below are

635

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

636

637

# Functions

638

priority_set_direct = _library.gnutls_priority_set_direct

639

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

640

ctypes.POINTER(ctypes.c_char_p)]

641

priority_set_direct.restype = _error_code

642

643

init = _library.gnutls_init

644

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

645

init.restype = _error_code

646

647

set_default_priority = _library.gnutls_set_default_priority

648

set_default_priority.argtypes = [session_t]

649

set_default_priority.restype = _error_code

650

651

record_send = _library.gnutls_record_send

652

record_send.argtypes = [session_t, ctypes.c_void_p,

653

ctypes.c_size_t]

654

record_send.restype = ctypes.c_ssize_t

655

record_send.errcheck = _retry_on_error

656

657

certificate_allocate_credentials = (

658

_library.gnutls_certificate_allocate_credentials)

659

certificate_allocate_credentials.argtypes = [

660

ctypes.POINTER(certificate_credentials_t)]

661

certificate_allocate_credentials.restype = _error_code

662

663

certificate_free_credentials = (

664

_library.gnutls_certificate_free_credentials)

665

certificate_free_credentials.argtypes = [certificate_credentials_t]

666

certificate_free_credentials.restype = None

667

668

handshake_set_private_extensions = (

669

_library.gnutls_handshake_set_private_extensions)

670

handshake_set_private_extensions.argtypes = [session_t,

671

ctypes.c_int]

672

handshake_set_private_extensions.restype = None

673

674

credentials_set = _library.gnutls_credentials_set

675

credentials_set.argtypes = [session_t, credentials_type_t,

676

ctypes.c_void_p]

677

credentials_set.restype = _error_code

678

679

strerror = _library.gnutls_strerror

680

strerror.argtypes = [ctypes.c_int]

681

strerror.restype = ctypes.c_char_p

682

683

certificate_type_get = _library.gnutls_certificate_type_get

684

certificate_type_get.argtypes = [session_t]

685

certificate_type_get.restype = _error_code

686

687

certificate_get_peers = _library.gnutls_certificate_get_peers

688

certificate_get_peers.argtypes = [session_t,

689

ctypes.POINTER(ctypes.c_uint)]

690

certificate_get_peers.restype = ctypes.POINTER(datum_t)

691

692

global_set_log_level = _library.gnutls_global_set_log_level

693

global_set_log_level.argtypes = [ctypes.c_int]

694

global_set_log_level.restype = None

695

696

global_set_log_function = _library.gnutls_global_set_log_function

697

global_set_log_function.argtypes = [log_func]

698

global_set_log_function.restype = None

699

700

deinit = _library.gnutls_deinit

701

deinit.argtypes = [session_t]

702

deinit.restype = None

703

704

handshake = _library.gnutls_handshake

705

handshake.argtypes = [session_t]

706

handshake.restype = _error_code

707

handshake.errcheck = _retry_on_error

708

709

transport_set_ptr = _library.gnutls_transport_set_ptr

710

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

711

transport_set_ptr.restype = None

712

713

bye = _library.gnutls_bye

714

bye.argtypes = [session_t, close_request_t]

715

bye.restype = _error_code

716

bye.errcheck = _retry_on_error

717

718

check_version = _library.gnutls_check_version

719

check_version.argtypes = [ctypes.c_char_p]

720

check_version.restype = ctypes.c_char_p

721

722

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

723

724

openpgp_crt_init = _library.gnutls_openpgp_crt_init

725

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

726

openpgp_crt_init.restype = _error_code

727

728

openpgp_crt_import = _library.gnutls_openpgp_crt_import

729

openpgp_crt_import.argtypes = [openpgp_crt_t,

730

ctypes.POINTER(datum_t),

731

openpgp_crt_fmt_t]

732

openpgp_crt_import.restype = _error_code

733

734

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

735

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

736

ctypes.POINTER(ctypes.c_uint)]

737

openpgp_crt_verify_self.restype = _error_code

738

739

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

740

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

741

openpgp_crt_deinit.restype = None

742

743

openpgp_crt_get_fingerprint = (

744

_library.gnutls_openpgp_crt_get_fingerprint)

745

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

746

ctypes.c_void_p,

747

ctypes.POINTER(

748

ctypes.c_size_t)]

749

openpgp_crt_get_fingerprint.restype = _error_code

750

751

# Remove non-public functions

752

del _error_code, _retry_on_error

753

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

754

gnutls = GnuTLS()

755

756

def call_pipe(connection, # : multiprocessing.Connection

757

func, *args, **kwargs):

758

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

759

760

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

761

return value on the provided multiprocessing.Connection.

762

"""

763

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

764

connection.close()

765

269

def _timedelta_to_milliseconds(td):

270

"Convert a datetime.timedelta() to milliseconds"

271

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

272

+ (td.seconds * 1000)

273

+ (td.microseconds // 1000))

274

766

275

class Client(object):

767

276

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

768

277

769

278

Attributes:

770

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

279

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

771

280

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

772

281

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

773

282

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

774

283

to see if the client lives.

775

284

'None' if no process is running.

776

checker_callback_tag: a GLib event source tag, or None

285

checker_callback_tag: a gobject event source tag, or None

777

286

checker_command: string; External command which is run to check

778

287

if client lives. %() expansions are done at

779

288

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

780

289

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

781

checker_initiator_tag: a GLib event source tag, or None

290

checker_initiator_tag: a gobject event source tag, or None

782

291

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

783

client_structure: Object describing what attributes a client has

784

and is used for storing the client at exit

785

292

current_checker_command: string; current running checker_command

786

disable_initiator_tag: a GLib event source tag, or None

293

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

294

disable_initiator_tag: a gobject event source tag, or None

787

295

enabled: bool()

788

296

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

789

297

uniquely identify the client

791

299

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

792

300

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

793

301

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

794

last_checker_status: integer between 0 and 255 reflecting exit

795

status of last checker. -1 reflects crashed

796

checker, -2 means no checker completed yet.

797

last_checker_signal: The signal which killed the last checker, if

798

last_checker_status is -1

799

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

302

last_enabled: datetime.datetime(); (UTC)

800

303

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

801

304

D-Bus identifiers

802

305

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

803

306

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

804

307

until this client is disabled

805

extended_timeout: extra long timeout when secret has been sent

308

extended_timeout: extra long timeout when password has been sent

806

309

runtime_expansions: Allowed attributes for runtime expansion.

807

310

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

808

311

disabled, or None

809

server_settings: The server_settings dict from main()

810

312

"""

811

313

812

314

runtime_expansions = ("approval_delay", "approval_duration",

813

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

814

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

815

"last_approval_request", "last_checked_ok",

315

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

316

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

816

317

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

817

client_defaults = {

818

"timeout": "PT5M",

819

"extended_timeout": "PT15M",

820

"interval": "PT2M",

821

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

822

"host": "",

823

"approval_delay": "PT0S",

824

"approval_duration": "PT1S",

825

"approved_by_default": "True",

826

"enabled": "True",

827

}

828

829

@staticmethod

830

def config_parser(config):

831

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

832

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

833

with exceptions for any special settings as defined above.

834

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

835

value given the same arguments.

836

"""

837

settings = {}

838

for client_name in config.sections():

839

section = dict(config.items(client_name))

840

client = settings[client_name] = {}

841

842

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

843

# Reformat values from string types to Python types

844

client["approved_by_default"] = config.getboolean(

845

client_name, "approved_by_default")

846

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

847

"enabled")

848

849

# Uppercase and remove spaces from fingerprint for later

850

# comparison purposes with return value from the

851

# fingerprint() function

852

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

853

.replace(" ", ""))

854

if "secret" in section:

855

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

856

.encode("utf-8"),

857

"base64")

858

elif "secfile" in section:

859

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

860

(section["secfile"])),

861

"rb") as secfile:

862

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

863

else:

864

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

865

.format(section))

866

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

867

client["extended_timeout"] = string_to_delta(

868

section["extended_timeout"])

869

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

870

client["approval_delay"] = string_to_delta(

871

section["approval_delay"])

872

client["approval_duration"] = string_to_delta(

873

section["approval_duration"])

874

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

875

client["last_approval_request"] = None

876

client["last_checked_ok"] = None

877

client["last_checker_status"] = -2

878

879

return settings

880

881

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

318

319

def timeout_milliseconds(self):

320

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

322

323

def extended_timeout_milliseconds(self):

324

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

326

327

def interval_milliseconds(self):

328

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

330

331

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

882

338

self.name = name

883

if server_settings is None:

884

server_settings = {}

885

self.server_settings = server_settings

886

# adding all client settings

887

for setting, value in settings.items():

888

setattr(self, setting, value)

889

890

if self.enabled:

891

if not hasattr(self, "last_enabled"):

892

self.last_enabled = datetime.datetime.utcnow()

893

if not hasattr(self, "expires"):

894

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

895

+ self.timeout)

896

else:

897

self.last_enabled = None

898

self.expires = None

899

339

if config is None:

340

config = {}

900

341

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

342

# Uppercase and remove spaces from fingerprint for later

343

# comparison purposes with return value from the fingerprint()

344

# function

345

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

346

.replace(" ", ""))

901

347

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

902

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

903

datetime.datetime.utcnow())

904

905

# attributes specific for this server instance

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

906

369

self.checker = None

907

370

self.checker_initiator_tag = None

908

371

self.disable_initiator_tag = None

372

self.expires = None

909

373

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

910

375

self.current_checker_command = None

911

self.approved = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

912

380

self.approvals_pending = 0

913

self.changedstate = multiprocessing_manager.Condition(

914

multiprocessing_manager.Lock())

915

self.client_structure = [attr

916

for attr in self.__dict__.keys()

917

if not attr.startswith("_")]

918

self.client_structure.append("client_structure")

919

920

for name, t in inspect.getmembers(

921

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

922

if not name.startswith("_"):

923

self.client_structure.append(name)

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

self.changedstate = (multiprocessing_manager

386

.Condition(multiprocessing_manager

387

.Lock()))

924

388

925

# Send notice to process children that client state has changed

926

389

def send_changedstate(self):

927

with self.changedstate:

928

self.changedstate.notify_all()

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

929

393

930

394

def enable(self):

931

395

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

932

396

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

933

397

# Already enabled

934

398

return

399

self.send_changedstate()

400

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

401

# and every interval from then on.

402

self.checker_initiator_tag = (gobject.timeout_add

403

(self.interval_milliseconds(),

404

self.start_checker))

405

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

935

406

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

936

410

self.enabled = True

937

411

self.last_enabled = datetime.datetime.utcnow()

938

self.init_checker()

939

self.send_changedstate()

412

# Also start a new checker *right now*.

413

self.start_checker()

940

414

941

415

def disable(self, quiet=True):

942

416

"""Disable this client."""

943

417

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

944

418

return False

945

419

if not quiet:

420

self.send_changedstate()

421

if not quiet:

946

422

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

947

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

948

GLib.source_remove(self.disable_initiator_tag)

423

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

424

gobject.source_remove(self.disable_initiator_tag)

949

425

self.disable_initiator_tag = None

950

426

self.expires = None

951

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

952

GLib.source_remove(self.checker_initiator_tag)

427

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

428

gobject.source_remove(self.checker_initiator_tag)

953

429

self.checker_initiator_tag = None

954

430

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

955

433

self.enabled = False

956

if not quiet:

957

self.send_changedstate()

958

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

434

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

959

435

return False

960

436

961

437

def __del__(self):

438

self.disable_hook = None

962

439

self.disable()

963

440

964

def init_checker(self):

965

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

966

# and every interval from then on.

967

if self.checker_initiator_tag is not None:

968

GLib.source_remove(self.checker_initiator_tag)

969

self.checker_initiator_tag = GLib.timeout_add(

970

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

971

self.start_checker)

972

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

973

if self.disable_initiator_tag is not None:

974

GLib.source_remove(self.disable_initiator_tag)

975

self.disable_initiator_tag = GLib.timeout_add(

976

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

977

# Also start a new checker *right now*.

978

self.start_checker()

979

980

def checker_callback(self, source, condition, connection,

981

command):

441

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

982

442

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

983

443

self.checker_callback_tag = None

984

444

self.checker = None

985

# Read return code from connection (see call_pipe)

986

returncode = connection.recv()

987

connection.close()

988

989

if returncode >= 0:

990

self.last_checker_status = returncode

991

self.last_checker_signal = None

992

if self.last_checker_status == 0:

445

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

993

448

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

994

449

vars(self))

995

450

self.checked_ok()

996

451

else:

997

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

452

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

453

vars(self))

998

454

else:

999

self.last_checker_status = -1

1000

self.last_checker_signal = -returncode

1001

455

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

1002

456

vars(self))

1003

return False

1004

1005

def checked_ok(self):

1006

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

1007

self.last_checked_ok = datetime.datetime.utcnow()

1008

self.last_checker_status = 0

1009

self.last_checker_signal = None

1010

self.bump_timeout()

1011

1012

def bump_timeout(self, timeout=None):

1013

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

457

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

1014

464

if timeout is None:

1015

465

timeout = self.timeout

1016

if self.disable_initiator_tag is not None:

1017

GLib.source_remove(self.disable_initiator_tag)

1018

self.disable_initiator_tag = None

1019

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

1020

self.disable_initiator_tag = GLib.timeout_add(

1021

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

1022

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

466

self.last_checked_ok = datetime.datetime.utcnow()

467

gobject.source_remove(self.disable_initiator_tag)

468

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

469

self.disable_initiator_tag = (gobject.timeout_add

470

(_timedelta_to_milliseconds

471

(timeout), self.disable))

1023

472

1024

473

def need_approval(self):

1025

474

self.last_approval_request = datetime.datetime.utcnow()

1030

479

If a checker already exists, leave it running and do

1031

480

nothing."""

1032

481

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

1033

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

1034

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

1035

# would inevitably timeout, since no checker would get a

1036

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

482

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

483

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

484

# client would inevitably timeout, since no checker would get

485

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

1037

486

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

1038

487

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

1039

488

# should be.

1040

489

1041

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

1042

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

1043

self.checker.join()

1044

self.checker = None

490

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

491

try:

492

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

493

except (AttributeError, OSError) as error:

494

if (isinstance(error, OSError)

495

and error.errno != errno.ECHILD):

496

raise error

497

else:

498

if pid:

499

logger.warning("Checker was a zombie")

500

gobject.source_remove(self.checker_callback_tag)

501

self.checker_callback(pid, status,

502

self.current_checker_command)

1045

503

# Start a new checker if needed

1046

504

if self.checker is None:

1047

# Escape attributes for the shell

1048

escaped_attrs = {

1049

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

1050

for attr in self.runtime_expansions }

1051

505

try:

1052

command = self.checker_command % escaped_attrs

1053

except TypeError as error:

1054

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

1055

self.checker_command,

1056

exc_info=error)

1057

return True # Try again later

506

# In case checker_command has exactly one % operator

507

command = self.checker_command % self.host

508

except TypeError:

509

# Escape attributes for the shell

510

escaped_attrs = dict(

511

(attr,

512

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

513

errors=

514

'replace')))

515

for attr in

516

self.runtime_expansions)

517

518

try:

519

command = self.checker_command % escaped_attrs

520

except TypeError as error:

521

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

522

' %s', self.checker_command, error)

523

return True # Try again later

1058

524

self.current_checker_command = command

1059

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

1060

self.name)

1061

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

1062

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

1063

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

1064

# always replaced by /dev/null.)

1065

# The exception is when not debugging but nevertheless

1066

# running in the foreground; use the previously

1067

# created wnull.

1068

popen_args = { "close_fds": True,

1069

"shell": True,

1070

"cwd": "/" }

1071

if (not self.server_settings["debug"]

1072

and self.server_settings["foreground"]):

1073

popen_args.update({"stdout": wnull,

1074

"stderr": wnull })

1075

pipe = multiprocessing.Pipe(duplex = False)

1076

self.checker = multiprocessing.Process(

1077

target = call_pipe,

1078

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

1079

kwargs = popen_args)

1080

self.checker.start()

1081

self.checker_callback_tag = GLib.io_add_watch(

1082

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

1083

self.checker_callback, pipe[0], command)

1084

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

525

try:

526

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

527

command, self.name)

528

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

529

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

530

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

531

# always replaced by /dev/null.)

532

self.checker = subprocess.Popen(command,

533

close_fds=True,

534

shell=True, cwd="/")

535

self.checker_callback_tag = (gobject.child_watch_add

536

(self.checker.pid,

537

self.checker_callback,

538

data=command))

539

# The checker may have completed before the gobject

540

# watch was added. Check for this.

541

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

542

if pid:

543

gobject.source_remove(self.checker_callback_tag)

544

self.checker_callback(pid, status, command)

545

except OSError as error:

546

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

547

error)

548

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

1085

549

return True

1086

550

1087

551

def stop_checker(self):

1088

552

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

1089

553

if self.checker_callback_tag:

1090

GLib.source_remove(self.checker_callback_tag)

554

gobject.source_remove(self.checker_callback_tag)

1091

555

self.checker_callback_tag = None

1092

556

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

1093

557

return

1094

558

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

1095

self.checker.terminate()

559

try:

560

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

561

#time.sleep(0.5)

562

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

563

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

564

except OSError as error:

565

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

566

raise

1096

567

self.checker = None

1097

568

1098

569

1099

def dbus_service_property(dbus_interface,

1100

signature="v",

1101

access="readwrite",

1102

byte_arrays=False):

570

def dbus_service_property(dbus_interface, signature="v",

571

access="readwrite", byte_arrays=False):

1103

572

"""Decorators for marking methods of a DBusObjectWithProperties to

1104

573

become properties on the D-Bus.

1105

574

1114

583

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

1115

584

if byte_arrays and signature != "ay":

1116

585

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

1117

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

1118

586

" signature %r" % signature)

1119

587

def decorator(func):

1120

588

func._dbus_is_property = True

1121

589

func._dbus_interface = dbus_interface

1126

594

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

1127

595

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1128

596

return func

1129

1130

return decorator

1131

1132

1133

def dbus_interface_annotations(dbus_interface):

1134

"""Decorator for marking functions returning interface annotations

1135

1136

Usage:

1137

1138

@dbus_interface_annotations("org.example.Interface")

1139

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

1140

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

1141

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

1142

"false"}

1143

"""

1144

1145

def decorator(func):

1146

func._dbus_is_interface = True

1147

func._dbus_interface = dbus_interface

1148

func._dbus_name = dbus_interface

1149

return func

1150

1151

return decorator

1152

1153

1154

def dbus_annotations(annotations):

1155

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

1156

Usage:

1157

1158

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

1159

"org.freedesktop.DBus.Property."

1160

"EmitsChangedSignal": "false"})

1161

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

1162

access="r")

1163

def Property_dbus_property(self):

1164

return dbus.Boolean(False)

1165

1166

See also the DBusObjectWithAnnotations class.

1167

"""

1168

1169

def decorator(func):

1170

func._dbus_annotations = annotations

1171

return func

1172

1173

597

return decorator

1174

598

1175

599

1176

600

class DBusPropertyException(dbus.exceptions.DBusException):

1177

601

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

1178

602

"""

1179

pass

603

def __unicode__(self):

604

return unicode(str(self))

1180

605

1181

606

1182

607

class DBusPropertyAccessException(DBusPropertyException):

1191

616

pass

1192

617

1193

618

1194

class DBusObjectWithAnnotations(dbus.service.Object):

1195

"""A D-Bus object with annotations.

1196

1197

Classes inheriting from this can use the dbus_annotations

1198

decorator to add annotations to methods or signals.

1199

"""

1200

1201

@staticmethod

1202

def _is_dbus_thing(thing):

1203

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

1204

1205

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

1206

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

1207

"""

1208

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

1209

False)

1210

1211

def _get_all_dbus_things(self, thing):

1212

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

1213

"""

1214

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

1215

athing.__get__(self))

1216

for cls in self.__class__.__mro__

1217

for name, athing in

1218

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

1219

1220

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1221

out_signature = "s",

1222

path_keyword = 'object_path',

1223

connection_keyword = 'connection')

1224

def Introspect(self, object_path, connection):

1225

"""Overloading of standard D-Bus method.

1226

1227

Inserts annotation tags on methods and signals.

1228

"""

1229

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

1230

connection)

1231

try:

1232

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

1233

1234

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

1235

# Add annotation tags

1236

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

1237

for tag in if_tag.getElementsByTagName(typ):

1238

annots = dict()

1239

for name, prop in (self.

1240

_get_all_dbus_things(typ)):

1241

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

1242

and prop._dbus_interface

1243

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

1244

annots.update(getattr(

1245

prop, "_dbus_annotations", {}))

1246

for name, value in annots.items():

1247

ann_tag = document.createElement(

1248

"annotation")

1249

ann_tag.setAttribute("name", name)

1250

ann_tag.setAttribute("value", value)

1251

tag.appendChild(ann_tag)

1252

# Add interface annotation tags

1253

for annotation, value in dict(

1254

itertools.chain.from_iterable(

1255

annotations().items()

1256

for name, annotations

1257

in self._get_all_dbus_things("interface")

1258

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

1259

)).items():

1260

ann_tag = document.createElement("annotation")

1261

ann_tag.setAttribute("name", annotation)

1262

ann_tag.setAttribute("value", value)

1263

if_tag.appendChild(ann_tag)

1264

# Fix argument name for the Introspect method itself

1265

if (if_tag.getAttribute("name")

1266

== dbus.INTROSPECTABLE_IFACE):

1267

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

1268

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

1269

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

1270

if (arg.getAttribute("direction")

1271

== "out"):

1272

arg.setAttribute("name",

1273

"xml_data")

1274

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

1275

document.unlink()

1276

except (AttributeError, xml.dom.DOMException,

1277

xml.parsers.expat.ExpatError) as error:

1278

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

1279

exc_info=error)

1280

return xmlstring

1281

1282

1283

class DBusObjectWithProperties(DBusObjectWithAnnotations):

619

class DBusObjectWithProperties(dbus.service.Object):

1284

620

"""A D-Bus object with properties.

1285

621

1286

622

Classes inheriting from this can use the dbus_service_property

1288

624

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

1289

625

"""

1290

626

627

@staticmethod

628

def _is_dbus_property(obj):

629

return getattr(obj, "_dbus_is_property", False)

630

631

def _get_all_dbus_properties(self):

632

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

633

"""

634

return ((prop.__get__(self)._dbus_name, prop.__get__(self))

635

for cls in self.__class__.__mro__

636

for name, prop in

637

inspect.getmembers(cls, self._is_dbus_property))

638

1291

639

def _get_dbus_property(self, interface_name, property_name):

1292

640

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

1293

641

property with the specified name and interface.

1294

642

"""

1295

for cls in self.__class__.__mro__:

1296

for name, value in inspect.getmembers(

1297

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

643

for cls in self.__class__.__mro__:

644

for name, value in (inspect.getmembers

645

(cls, self._is_dbus_property)):

1298

646

if (value._dbus_name == property_name

1299

647

and value._dbus_interface == interface_name):

1300

648

return value.__get__(self)

1301

649

1302

650

# No such property

1303

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

1304

self.dbus_object_path, interface_name, property_name))

1305

1306

@classmethod

1307

def _get_all_interface_names(cls):

1308

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

1309

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

1310

"_dbus_interface", None)

1311

for x in (inspect.getmro(cls))

1312

for attr in dir(x))

1313

if name is not None)

1314

1315

@dbus.service.method(dbus.PROPERTIES_IFACE,

1316

in_signature="ss",

651

raise DBusPropertyNotFound(self.dbus_object_path + ":"

652

+ interface_name + "."

653

+ property_name)

654

655

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

1317

656

out_signature="v")

1318

657

def Get(self, interface_name, property_name):

1319

658

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

1337

676

# The byte_arrays option is not supported yet on

1338

677

# signatures other than "ay".

1339

678

if prop._dbus_signature != "ay":

1340

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

1341

"'ay' signature {!r}"

1342

.format(prop._dbus_signature))

1343

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

1344

for byte in value))

679

raise ValueError

680

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

681

for byte in value))

1345

682

prop(value)

1346

683

1347

@dbus.service.method(dbus.PROPERTIES_IFACE,

1348

in_signature="s",

684

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

1349

685

out_signature="a{sv}")

1350

686

def GetAll(self, interface_name):

1351

687

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

1353

689

1354

690

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

1355

691

"""

1356

properties = {}

1357

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

692

all = {}

693

for name, prop in self._get_all_dbus_properties():

1358

694

if (interface_name

1359

695

and interface_name != prop._dbus_interface):

1360

696

# Interface non-empty but did not match

1364

700

continue

1365

701

value = prop()

1366

702

if not hasattr(value, "variant_level"):

1367

properties[name] = value

703

all[name] = value

1368

704

continue

1369

properties[name] = type(value)(

1370

value, variant_level = value.variant_level + 1)

1371

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

1372

1373

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

1374

def PropertiesChanged(self, interface_name, changed_properties,

1375

invalidated_properties):

1376

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

1377

standard.

1378

"""

1379

pass

705

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

706

value.variant_level+1)

707

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

1380

708

1381

709

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1382

710

out_signature="s",

1383

711

path_keyword='object_path',

1384

712

connection_keyword='connection')

1385

713

def Introspect(self, object_path, connection):

1386

"""Overloading of standard D-Bus method.

1387

1388

Inserts property tags and interface annotation tags.

714

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

1389

715

"""

1390

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1391

object_path,

1392

connection)

716

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

717

connection)

1393

718

try:

1394

719

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

1395

1396

720

def make_tag(document, name, prop):

1397

721

e = document.createElement("property")

1398

722

e.setAttribute("name", name)

1399

723

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

1400

724

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

1401

725

return e

1402

1403

726

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

1404

# Add property tags

1405

727

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

1406

728

for name, prop

1407

in self._get_all_dbus_things("property")

729

in self._get_all_dbus_properties()

1408

730

if prop._dbus_interface

1409

731

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

1410

732

if_tag.appendChild(tag)

1411

# Add annotation tags for properties

1412

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

1413

annots = dict()

1414

for name, prop in self._get_all_dbus_things(

1415

"property"):

1416

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

1417

and prop._dbus_interface

1418

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

1419

annots.update(getattr(

1420

prop, "_dbus_annotations", {}))

1421

for name, value in annots.items():

1422

ann_tag = document.createElement(

1423

"annotation")

1424

ann_tag.setAttribute("name", name)

1425

ann_tag.setAttribute("value", value)

1426

tag.appendChild(ann_tag)

1427

733

# Add the names to the return values for the

1428

734

# "org.freedesktop.DBus.Properties" methods

1429

735

if (if_tag.getAttribute("name")

1444

750

except (AttributeError, xml.dom.DOMException,

1445

751

xml.parsers.expat.ExpatError) as error:

1446

752

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

1447

exc_info=error)

1448

return xmlstring

1449

1450

try:

1451

dbus.OBJECT_MANAGER_IFACE

1452

except AttributeError:

1453

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

1454

1455

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1456

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

1457

1458

Classes inheriting from this exposes the standard

1459

GetManagedObjects call and the InterfacesAdded and

1460

InterfacesRemoved signals on the standard

1461

"org.freedesktop.DBus.ObjectManager" interface.

1462

1463

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

1464

manually.

1465

"""

1466

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1467

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

1468

def GetManagedObjects(self):

1469

"""This function must be overridden"""

1470

raise NotImplementedError()

1471

1472

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1473

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

1474

def InterfacesAdded(self, object_path, interfaces_and_properties):

1475

pass

1476

1477

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

1478

def InterfacesRemoved(self, object_path, interfaces):

1479

pass

1480

1481

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1482

out_signature = "s",

1483

path_keyword = 'object_path',

1484

connection_keyword = 'connection')

1485

def Introspect(self, object_path, connection):

1486

"""Overloading of standard D-Bus method.

1487

1488

Override return argument name of GetManagedObjects to be

1489

"objpath_interfaces_and_properties"

1490

"""

1491

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1492

object_path,

1493

connection)

1494

try:

1495

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

1496

1497

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

1498

# Fix argument name for the GetManagedObjects method

1499

if (if_tag.getAttribute("name")

1500

== dbus.OBJECT_MANAGER_IFACE):

1501

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

1502

if (cn.getAttribute("name")

1503

== "GetManagedObjects"):

1504

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

1505

if (arg.getAttribute("direction")

1506

== "out"):

1507

arg.setAttribute(

1508

"name",

1509

"objpath_interfaces"

1510

"_and_properties")

1511

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

1512

document.unlink()

1513

except (AttributeError, xml.dom.DOMException,

1514

xml.parsers.expat.ExpatError) as error:

1515

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

1516

exc_info = error)

1517

return xmlstring

1518

1519

def datetime_to_dbus(dt, variant_level=0):

753

error)

754

return xmlstring

755

756

757

def datetime_to_dbus (dt, variant_level=0):

1520

758

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

1521

759

if dt is None:

1522

760

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

1523

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

1524

1525

1526

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1527

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

1528

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

1529

interface names according to the "alt_interface_names" mapping.

1530

Usage:

1531

1532

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

1533

"net.example.AlternateInterface"})

1534

class SampleDBusObject(dbus.service.Object):

1535

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

1536

def SampleDBusMethod():

1537

pass

1538

1539

The above "SampleDBusMethod" on "SampleDBusObject" will be

1540

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

1541

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

1542

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

1543

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

1544

1545

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

1546

(from DBusObjectWithProperties) and interfaces (from the

1547

dbus_interface_annotations decorator).

761

return dbus.String(dt.isoformat(),

762

variant_level=variant_level)

763

764

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

765

.__metaclass__):

766

"""Applied to an empty subclass of a D-Bus object, this metaclass

767

will add additional D-Bus attributes matching a certain pattern.

1548

768

"""

1549

1550

def wrapper(cls):

1551

for orig_interface_name, alt_interface_name in (

1552

alt_interface_names.items()):

1553

attr = {}

1554

interface_names = set()

1555

# Go though all attributes of the class

1556

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

769

def __new__(mcs, name, bases, attr):

770

# Go through all the base classes which could have D-Bus

771

# methods, signals, or properties in them

772

for base in (b for b in bases

773

if issubclass(b, dbus.service.Object)):

774

# Go though all attributes of the base class

775

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

1557

776

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

1558

777

# with the wrong interface name

1559

778

if (not hasattr(attribute, "_dbus_interface")

1560

or not attribute._dbus_interface.startswith(

1561

orig_interface_name)):

779

or not attribute._dbus_interface

780

.startswith("se.recompile.Mandos")):

1562

781

continue

1563

782

# Create an alternate D-Bus interface name based on

1564

783

# the current name

1565

alt_interface = attribute._dbus_interface.replace(

1566

orig_interface_name, alt_interface_name)

1567

interface_names.add(alt_interface)

784

alt_interface = (attribute._dbus_interface

785

.replace("se.recompile.Mandos",

786

"se.bsnet.fukt.Mandos"))

1568

787

# Is this a D-Bus signal?

1569

788

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

1570

# Extract the original non-method undecorated

1571

# function by black magic

1572

if sys.version_info.major == 2:

1573

nonmethod_func = (dict(

789

# Extract the original non-method function by

790

# black magic

791

nonmethod_func = (dict(

1574

792

zip(attribute.func_code.co_freevars,

1575

attribute.__closure__))

1576

["func"].cell_contents)

1577

else:

1578

nonmethod_func = (dict(

1579

zip(attribute.__code__.co_freevars,

1580

attribute.__closure__))

1581

["func"].cell_contents)

793

attribute.__closure__))["func"]

794

.cell_contents)

1582

795

# Create a new, but exactly alike, function

1583

796

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

1584

797

# with the alternate D-Bus interface name

1585

new_function = copy_function(nonmethod_func)

1586

new_function = (dbus.service.signal(

1587

alt_interface,

1588

attribute._dbus_signature)(new_function))

1589

# Copy annotations, if any

1590

try:

1591

new_function._dbus_annotations = dict(

1592

attribute._dbus_annotations)

1593

except AttributeError:

1594

pass

798

new_function = (dbus.service.signal

799

(alt_interface,

800

attribute._dbus_signature)

801

(types.FunctionType(

802

nonmethod_func.func_code,

803

nonmethod_func.func_globals,

804

nonmethod_func.func_name,

805

nonmethod_func.func_defaults,

806

nonmethod_func.func_closure)))

1595

807

# Define a creator of a function to call both the

1596

# original and alternate functions, so both the

1597

# original and alternate signals gets sent when

1598

# the function is called

808

# old and new functions, so both the old and new

809

# signals gets sent when the function is called

1599

810

def fixscope(func1, func2):

1600

811

"""This function is a scope container to pass

1601

812

func1 and func2 to the "call_both" function

1602

813

outside of its arguments"""

1603

1604

@functools.wraps(func2)

1605

814

def call_both(*args, **kwargs):

1606

815

"""This function will emit two D-Bus

1607

816

signals by calling func1 and func2"""

1608

817

func1(*args, **kwargs)

1609

818

func2(*args, **kwargs)

1610

# Make wrapper function look like a D-Bus signal

1611

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

1612

if name.startswith("_dbus_"):

1613

setattr(call_both, name, attr)

1614

1615

819

return call_both

1616

820

# Create the "call_both" function and add it to

1617

821

# the class

1618

attr[attrname] = fixscope(attribute, new_function)

822

attr[attrname] = fixscope(attribute,

823

new_function)

1619

824

# Is this a D-Bus method?

1620

825

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

1621

826

# Create a new, but exactly alike, function

1622

827

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

1623

828

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

1624

829

# to the class.

1625

attr[attrname] = (

1626

dbus.service.method(

1627

alt_interface,

1628

attribute._dbus_in_signature,

1629

attribute._dbus_out_signature)

1630

(copy_function(attribute)))

1631

# Copy annotations, if any

1632

try:

1633

attr[attrname]._dbus_annotations = dict(

1634

attribute._dbus_annotations)

1635

except AttributeError:

1636

pass

830

attr[attrname] = (dbus.service.method

831

(alt_interface,

832

attribute._dbus_in_signature,

833

attribute._dbus_out_signature)

834

(types.FunctionType

835

(attribute.func_code,

836

attribute.func_globals,

837

attribute.func_name,

838

attribute.func_defaults,

839

attribute.func_closure)))

1637

840

# Is this a D-Bus property?

1638

841

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

1639

842

# Create a new, but exactly alike, function

1640

843

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

1641

844

# property with the alternate D-Bus interface

1642

845

# name. Add it to the class.

1643

attr[attrname] = (dbus_service_property(

1644

alt_interface, attribute._dbus_signature,

1645

attribute._dbus_access,

1646

attribute._dbus_get_args_options

1647

["byte_arrays"])

1648

(copy_function(attribute)))

1649

# Copy annotations, if any

1650

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1653

except AttributeError:

1654

pass

1655

# Is this a D-Bus interface?

1656

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

1657

# Create a new, but exactly alike, function

1658

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

1659

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

1660

# to the class.

1661

attr[attrname] = (

1662

dbus_interface_annotations(alt_interface)

1663

(copy_function(attribute)))

1664

if deprecate:

1665

# Deprecate all alternate interfaces

1666

iname="_AlternateDBusNames_interface_annotation{}"

1667

for interface_name in interface_names:

1668

1669

@dbus_interface_annotations(interface_name)

1670

def func(self):

1671

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

1672

"true" }

1673

# Find an unused name

1674

for aname in (iname.format(i)

1675

for i in itertools.count()):

1676

if aname not in attr:

1677

attr[aname] = func

1678

break

1679

if interface_names:

1680

# Replace the class with a new subclass of it with

1681

# methods, signals, etc. as created above.

1682

if sys.version_info.major == 2:

1683

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

1684

(cls, ), attr)

1685

else:

1686

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

1687

(cls, ), attr)

1688

return cls

1689

1690

return wrapper

1691

1692

1693

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

1694

"se.bsnet.fukt.Mandos"})

846

attr[attrname] = (dbus_service_property

847

(alt_interface,

848

attribute._dbus_signature,

849

attribute._dbus_access,

850

attribute

851

._dbus_get_args_options

852

["byte_arrays"])

853

(types.FunctionType

854

(attribute.func_code,

855

attribute.func_globals,

856

attribute.func_name,

857

attribute.func_defaults,

858

attribute.func_closure)))

859

return type.__new__(mcs, name, bases, attr)

860

1695

861

class ClientDBus(Client, DBusObjectWithProperties):

1696

862

"""A Client class using D-Bus

1697

863

1701

867

"""

1702

868

1703

869

runtime_expansions = (Client.runtime_expansions

1704

+ ("dbus_object_path", ))

1705

1706

_interface = "se.recompile.Mandos.Client"

870

+ ("dbus_object_path",))

1707

871

1708

872

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

1709

873

1710

874

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

875

self._approvals_pending = 0

1711

876

self.bus = bus

1712

877

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

1713

878

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

1714

879

# the D-Bus

1715

client_object_name = str(self.name).translate(

880

client_object_name = unicode(self.name).translate(

1716

881

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

1717

882

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

1718

self.dbus_object_path = dbus.ObjectPath(

1719

"/clients/" + client_object_name)

883

self.dbus_object_path = (dbus.ObjectPath

884

("/clients/" + client_object_name))

1720

885

DBusObjectWithProperties.__init__(self, self.bus,

1721

886

self.dbus_object_path)

1722

1723

def notifychangeproperty(transform_func, dbus_name,

1724

type_func=lambda x: x,

1725

variant_level=1,

1726

invalidate_only=False,

1727

_interface=_interface):

887

888

def notifychangeproperty(transform_func,

889

dbus_name, type_func=lambda x: x,

890

variant_level=1):

1728

891

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

1729

892

its changes to DBus.

1730

1731

transform_fun: Function that takes a value and a variant_level

1732

and transforms it to a D-Bus type.

893

894

transform_fun: Function that takes a value and transforms it

895

to a D-Bus type.

1733

896

dbus_name: D-Bus name of the variable

1734

897

type_func: Function that transform the value before sending it

1735

898

to the D-Bus. Default: no transform

1736

899

variant_level: D-Bus variant level. Default: 1

1737

900

"""

1738

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

1739

901

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

1740

902

def setter(self, value):

1741

903

if hasattr(self, "dbus_object_path"):

1742

904

if (not hasattr(self, attrname) or

1743

905

type_func(getattr(self, attrname, None))

1744

906

!= type_func(value)):

1745

if invalidate_only:

1746

self.PropertiesChanged(

1747

_interface, dbus.Dictionary(),

1748

dbus.Array((dbus_name, )))

1749

else:

1750

dbus_value = transform_func(

1751

type_func(value),

1752

variant_level = variant_level)

1753

self.PropertyChanged(dbus.String(dbus_name),

1754

dbus_value)

1755

self.PropertiesChanged(

1756

_interface,

1757

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

1758

dbus_value }),

1759

dbus.Array())

907

dbus_value = transform_func(type_func(value),

908

variant_level)

909

self.PropertyChanged(dbus.String(dbus_name),

910

dbus_value)

1760

911

setattr(self, attrname, value)

1761

912

1762

913

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

1763

914

915

1764

916

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1765

917

approvals_pending = notifychangeproperty(dbus.Boolean,

1766

918

"ApprovalPending",

1768

920

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

1769

921

last_enabled = notifychangeproperty(datetime_to_dbus,

1770

922

"LastEnabled")

1771

checker = notifychangeproperty(

1772

dbus.Boolean, "CheckerRunning",

1773

type_func = lambda checker: checker is not None)

923

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

924

type_func = lambda checker:

925

checker is not None)

1774

926

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1775

927

"LastCheckedOK")

1776

last_checker_status = notifychangeproperty(dbus.Int16,

1777

"LastCheckerStatus")

1778

928

last_approval_request = notifychangeproperty(

1779

929

datetime_to_dbus, "LastApprovalRequest")

1780

930

approved_by_default = notifychangeproperty(dbus.Boolean,

1781

931

"ApprovedByDefault")

1782

approval_delay = notifychangeproperty(

1783

dbus.UInt64, "ApprovalDelay",

1784

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

932

approval_delay = notifychangeproperty(dbus.UInt16,

933

"ApprovalDelay",

934

type_func =

935

_timedelta_to_milliseconds)

1785

936

approval_duration = notifychangeproperty(

1786

dbus.UInt64, "ApprovalDuration",

1787

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

937

dbus.UInt16, "ApprovalDuration",

938

type_func = _timedelta_to_milliseconds)

1788

939

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

1789

timeout = notifychangeproperty(

1790

dbus.UInt64, "Timeout",

1791

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

940

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

941

type_func =

942

_timedelta_to_milliseconds)

1792

943

extended_timeout = notifychangeproperty(

1793

dbus.UInt64, "ExtendedTimeout",

1794

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

1795

interval = notifychangeproperty(

1796

dbus.UInt64, "Interval",

1797

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

944

dbus.UInt16, "ExtendedTimeout",

945

type_func = _timedelta_to_milliseconds)

946

interval = notifychangeproperty(dbus.UInt16,

947

"Interval",

948

type_func =

949

_timedelta_to_milliseconds)

1798

950

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

1799

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

1800

invalidate_only=True)

1801

951

1802

952

del notifychangeproperty

1803

953

1810

960

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

1811

961

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

1812

962

1813

def checker_callback(self, source, condition,

1814

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

1815

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

1816

connection, command, *args,

1817

**kwargs)

1818

exitstatus = self.last_checker_status

1819

if exitstatus >= 0:

963

def checker_callback(self, pid, condition, command,

964

*args, **kwargs):

965

self.checker_callback_tag = None

966

self.checker = None

967

if os.WIFEXITED(condition):

968

exitstatus = os.WEXITSTATUS(condition)

1820

969

# Emit D-Bus signal

1821

970

self.CheckerCompleted(dbus.Int16(exitstatus),

1822

# This is specific to GNU libC

1823

dbus.Int64(exitstatus << 8),

971

dbus.Int64(condition),

1824

972

dbus.String(command))

1825

973

else:

1826

974

# Emit D-Bus signal

1827

975

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

1828

dbus.Int64(

1829

# This is specific to GNU libC

1830

(exitstatus << 8)

1831

| self.last_checker_signal),

976

dbus.Int64(condition),

1832

977

dbus.String(command))

1833

return ret

978

979

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

980

*args, **kwargs)

1834

981

1835

982

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

1836

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

983

old_checker = self.checker

984

if self.checker is not None:

985

old_checker_pid = self.checker.pid

986

else:

987

old_checker_pid = None

1837

988

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

1838

989

# Only if new checker process was started

1839

990

if (self.checker is not None

1843

994

return r

1844

995

1845

996

def _reset_approved(self):

1846

self.approved = None

997

self._approved = None

1847

998

return False

1848

999

1849

1000

def approve(self, value=True):

1850

self.approved = value

1851

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

1852

* 1000), self._reset_approved)

1853

1001

self.send_changedstate()

1002

self._approved = value

1003

gobject.timeout_add(_timedelta_to_milliseconds

1004

(self.approval_duration),

1005

self._reset_approved)

1006

1854

1007

1855

1008

## D-Bus methods, signals & properties

1856

1857

## Interfaces

1009

_interface = "se.recompile.Mandos.Client"

1858

1010

1859

1011

## Signals

1860

1012

1871

1023

pass

1872

1024

1873

1025

# PropertyChanged - signal

1874

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

1875

1026

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

1876

1027

def PropertyChanged(self, property, value):

1877

1028

"D-Bus signal"

1911

1062

self.checked_ok()

1912

1063

1913

1064

# Enable - method

1914

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

1915

1065

@dbus.service.method(_interface)

1916

1066

def Enable(self):

1917

1067

"D-Bus method"

1918

1068

self.enable()

1919

1069

1920

1070

# StartChecker - method

1921

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

1922

1071

@dbus.service.method(_interface)

1923

1072

def StartChecker(self):

1924

1073

"D-Bus method"

1925

1074

self.start_checker()

1926

1075

1927

1076

# Disable - method

1928

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

1929

1077

@dbus.service.method(_interface)

1930

1078

def Disable(self):

1931

1079

"D-Bus method"

1932

1080

self.disable()

1933

1081

1934

1082

# StopChecker - method

1935

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

1936

1083

@dbus.service.method(_interface)

1937

1084

def StopChecker(self):

1938

1085

self.stop_checker()

1945

1092

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

1946

1093

1947

1094

# ApprovedByDefault - property

1948

@dbus_service_property(_interface,

1949

signature="b",

1095

@dbus_service_property(_interface, signature="b",

1950

1096

access="readwrite")

1951

1097

def ApprovedByDefault_dbus_property(self, value=None):

1952

1098

if value is None: # get

1954

1100

self.approved_by_default = bool(value)

1955

1101

1956

1102

# ApprovalDelay - property

1957

@dbus_service_property(_interface,

1958

signature="t",

1103

@dbus_service_property(_interface, signature="t",

1959

1104

access="readwrite")

1960

1105

def ApprovalDelay_dbus_property(self, value=None):

1961

1106

if value is None: # get

1962

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

1963

* 1000)

1107

return dbus.UInt64(self.approval_delay_milliseconds())

1964

1108

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

1965

1109

1966

1110

# ApprovalDuration - property

1967

@dbus_service_property(_interface,

1968

signature="t",

1111

@dbus_service_property(_interface, signature="t",

1969

1112

access="readwrite")

1970

1113

def ApprovalDuration_dbus_property(self, value=None):

1971

1114

if value is None: # get

1972

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

1973

* 1000)

1115

return dbus.UInt64(_timedelta_to_milliseconds(

1116

self.approval_duration))

1974

1117

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

1975

1118

1976

1119

# Name - property

1977

@dbus_annotations(

1978

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

1979

1120

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

1980

1121

def Name_dbus_property(self):

1981

1122

return dbus.String(self.name)

1982

1123

1983

1124

# Fingerprint - property

1984

@dbus_annotations(

1985

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

1986

1125

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

1987

1126

def Fingerprint_dbus_property(self):

1988

1127

return dbus.String(self.fingerprint)

1989

1128

1990

1129

# Host - property

1991

@dbus_service_property(_interface,

1992

signature="s",

1130

@dbus_service_property(_interface, signature="s",

1993

1131

access="readwrite")

1994

1132

def Host_dbus_property(self, value=None):

1995

1133

if value is None: # get

1996

1134

return dbus.String(self.host)

1997

self.host = str(value)

1135

self.host = value

1998

1136

1999

1137

# Created - property

2000

@dbus_annotations(

2001

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

2002

1138

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

2003

1139

def Created_dbus_property(self):

2004

return datetime_to_dbus(self.created)

1140

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

2005

1141

2006

1142

# LastEnabled - property

2007

1143

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

2009

1145

return datetime_to_dbus(self.last_enabled)

2010

1146

2011

1147

# Enabled - property

2012

@dbus_service_property(_interface,

2013

signature="b",

1148

@dbus_service_property(_interface, signature="b",

2014

1149

access="readwrite")

2015

1150

def Enabled_dbus_property(self, value=None):

2016

1151

if value is None: # get

2021

1156

self.disable()

2022

1157

2023

1158

# LastCheckedOK - property

2024

@dbus_service_property(_interface,

2025

signature="s",

1159

@dbus_service_property(_interface, signature="s",

2026

1160

access="readwrite")

2027

1161

def LastCheckedOK_dbus_property(self, value=None):

2028

1162

if value is not None:

2030

1164

return

2031

1165

return datetime_to_dbus(self.last_checked_ok)

2032

1166

2033

# LastCheckerStatus - property

2034

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

2035

def LastCheckerStatus_dbus_property(self):

2036

return dbus.Int16(self.last_checker_status)

2037

2038

1167

# Expires - property

2039

1168

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

2040

1169

def Expires_dbus_property(self):

2046

1175

return datetime_to_dbus(self.last_approval_request)

2047

1176

2048

1177

# Timeout - property

2049

@dbus_service_property(_interface,

2050

signature="t",

1178

@dbus_service_property(_interface, signature="t",

2051

1179

access="readwrite")

2052

1180

def Timeout_dbus_property(self, value=None):

2053

1181

if value is None: # get

2054

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

2055

old_timeout = self.timeout

1182

return dbus.UInt64(self.timeout_milliseconds())

2056

1183

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

2057

# Reschedule disabling

2058

if self.enabled:

2059

now = datetime.datetime.utcnow()

2060

self.expires += self.timeout - old_timeout

2061

if self.expires <= now:

2062

# The timeout has passed

2063

self.disable()

2064

else:

2065

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

2066

is None):

2067

return

2068

GLib.source_remove(self.disable_initiator_tag)

2069

self.disable_initiator_tag = GLib.timeout_add(

2070

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

2071

self.disable)

1184

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

1185

return

1186

# Reschedule timeout

1187

gobject.source_remove(self.disable_initiator_tag)

1188

self.disable_initiator_tag = None

1189

self.expires = None

1190

time_to_die = (self.

1191

_timedelta_to_milliseconds((self

1192

.last_checked_ok

1193

+ self.timeout)

1194

- datetime.datetime

1195

.utcnow()))

1196

if time_to_die <= 0:

1197

# The timeout has passed

1198

self.disable()

1199

else:

1200

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

1201

+ datetime.timedelta(milliseconds =

1202

time_to_die))

1203

self.disable_initiator_tag = (gobject.timeout_add

1204

(time_to_die, self.disable))

2072

1205

2073

1206

# ExtendedTimeout - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1207

@dbus_service_property(_interface, signature="t",

2076

1208

access="readwrite")

2077

1209

def ExtendedTimeout_dbus_property(self, value=None):

2078

1210

if value is None: # get

2079

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

2080

* 1000)

1211

return dbus.UInt64(self.extended_timeout_milliseconds())

2081

1212

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

2082

1213

2083

1214

# Interval - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1215

@dbus_service_property(_interface, signature="t",

2086

1216

access="readwrite")

2087

1217

def Interval_dbus_property(self, value=None):

2088

1218

if value is None: # get

2089

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

1219

return dbus.UInt64(self.interval_milliseconds())

2090

1220

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

2091

1221

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

2092

1222

return

2093

if self.enabled:

2094

# Reschedule checker run

2095

GLib.source_remove(self.checker_initiator_tag)

2096

self.checker_initiator_tag = GLib.timeout_add(

2097

value, self.start_checker)

2098

self.start_checker() # Start one now, too

1223

# Reschedule checker run

1224

gobject.source_remove(self.checker_initiator_tag)

1225

self.checker_initiator_tag = (gobject.timeout_add

1226

(value, self.start_checker))

1227

self.start_checker() # Start one now, too

2099

1228

2100

1229

# Checker - property

2101

@dbus_service_property(_interface,

2102

signature="s",

1230

@dbus_service_property(_interface, signature="s",

2103

1231

access="readwrite")

2104

1232

def Checker_dbus_property(self, value=None):

2105

1233

if value is None: # get

2106

1234

return dbus.String(self.checker_command)

2107

self.checker_command = str(value)

1235

self.checker_command = value

2108

1236

2109

1237

# CheckerRunning - property

2110

@dbus_service_property(_interface,

2111

signature="b",

1238

@dbus_service_property(_interface, signature="b",

2112

1239

access="readwrite")

2113

1240

def CheckerRunning_dbus_property(self, value=None):

2114

1241

if value is None: # get

2119

1246

self.stop_checker()

2120

1247

2121

1248

# ObjectPath - property

2122

@dbus_annotations(

2123

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

2124

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

2125

1249

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

2126

1250

def ObjectPath_dbus_property(self):

2127

1251

return self.dbus_object_path # is already a dbus.ObjectPath

2128

1252

2129

1253

# Secret = property

2130

@dbus_annotations(

2131

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

2132

"invalidates"})

2133

@dbus_service_property(_interface,

2134

signature="ay",

2135

access="write",

2136

byte_arrays=True)

1254

@dbus_service_property(_interface, signature="ay",

1255

access="write", byte_arrays=True)

2137

1256

def Secret_dbus_property(self, value):

2138

self.secret = bytes(value)

1257

self.secret = str(value)

2139

1258

2140

1259

del _interface

2141

1260

2145

1264

self._pipe = child_pipe

2146

1265

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

2147

1266

if not self._pipe.recv():

2148

raise KeyError(fpr)

1267

raise KeyError()

2149

1268

2150

1269

def __getattribute__(self, name):

2151

if name == '_pipe':

1270

if(name == '_pipe'):

2152

1271

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

2153

1272

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

2154

1273

data = self._pipe.recv()

2155

1274

if data[0] == 'data':

2156

1275

return data[1]

2157

1276

if data[0] == 'function':

2158

2159

1277

def func(*args, **kwargs):

2160

1278

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

2161

1279

return self._pipe.recv()[1]

2162

2163

1280

return func

2164

1281

2165

1282

def __setattr__(self, name, value):

2166

if name == '_pipe':

1283

if(name == '_pipe'):

2167

1284

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

2168

1285

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

2169

1286

1287

class ClientDBusTransitional(ClientDBus):

1288

__metaclass__ = AlternateDBusNamesMetaclass

2170

1289

2171

1290

class ClientHandler(socketserver.BaseRequestHandler, object):

2172

1291

"""A class to handle client connections.

2177

1296

def handle(self):

2178

1297

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

2179

1298

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

2180

str(self.client_address))

1299

unicode(self.client_address))

2181

1300

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

2182

1301

self.server.child_pipe.fileno())

2183

1302

2184

session = gnutls.ClientSession(self.request)

1303

session = (gnutls.connection

1304

.ClientSession(self.request,

1305

gnutls.connection

1306

.X509Credentials()))

1307

1308

# Note: gnutls.connection.X509Credentials is really a

1309

# generic GnuTLS certificate credentials object so long as

1310

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

1311

# here despite using OpenPGP certificates.

2185

1312

2186

1313

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

2187

1314

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

2191

1318

priority = self.server.gnutls_priority

2192

1319

if priority is None:

2193

1320

priority = "NORMAL"

2194

gnutls.priority_set_direct(session._c_object,

2195

priority.encode("utf-8"),

2196

None)

1321

(gnutls.library.functions

1322

.gnutls_priority_set_direct(session._c_object,

1323

priority, None))

2197

1324

2198

1325

# Start communication using the Mandos protocol

2199

1326

# Get protocol number

2201

1328

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

2202

1329

try:

2203

1330

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

2204

raise RuntimeError(line)

1331

raise RuntimeError

2205

1332

except (ValueError, IndexError, RuntimeError) as error:

2206

1333

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

2207

1334

return

2209

1336

# Start GnuTLS connection

2210

1337

try:

2211

1338

session.handshake()

2212

except gnutls.Error as error:

1339

except gnutls.errors.GNUTLSError as error:

2213

1340

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

2214

1341

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

2215

1342

# established. Just abandon the request.

2219

1346

approval_required = False

2220

1347

try:

2221

1348

try:

2222

fpr = self.fingerprint(

2223

self.peer_certificate(session))

2224

except (TypeError, gnutls.Error) as error:

1349

fpr = self.fingerprint(self.peer_certificate

1350

(session))

1351

except (TypeError,

1352

gnutls.errors.GNUTLSError) as error:

2225

1353

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

2226

1354

return

2227

1355

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

2240

1368

while True:

2241

1369

if not client.enabled:

2242

1370

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

2243

client.name)

1371

client.name)

2244

1372

if self.server.use_dbus:

2245

1373

# Emit D-Bus signal

2246

1374

client.Rejected("Disabled")

2247

1375

return

2248

1376

2249

if client.approved or not client.approval_delay:

1377

if client._approved or not client.approval_delay:

2250

1378

#We are approved or approval is disabled

2251

1379

break

2252

elif client.approved is None:

1380

elif client._approved is None:

2253

1381

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

2254

1382

client.name)

2255

1383

if self.server.use_dbus:

2256

1384

# Emit D-Bus signal

2257

1385

client.NeedApproval(

2258

client.approval_delay.total_seconds()

2259

* 1000, client.approved_by_default)

1386

client.approval_delay_milliseconds(),

1387

client.approved_by_default)

2260

1388

else:

2261

1389

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

2262

1390

client.name)

2266

1394

return

2267

1395

2268

1396

#wait until timeout or approved

1397

#x = float(client

1398

# ._timedelta_to_milliseconds(delay))

2269

1399

time = datetime.datetime.now()

2270

1400

client.changedstate.acquire()

2271

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

1401

(client.changedstate.wait

1402

(float(client._timedelta_to_milliseconds(delay)

1403

/ 1000)))

2272

1404

client.changedstate.release()

2273

1405

time2 = datetime.datetime.now()

2274

1406

if (time2 - time) >= delay:

2285

1417

else:

2286

1418

delay -= time2 - time

2287

1419

2288

try:

2289

session.send(client.secret)

2290

except gnutls.Error as error:

2291

logger.warning("gnutls send failed",

2292

exc_info = error)

2293

return

1420

sent_size = 0

1421

while sent_size < len(client.secret):

1422

try:

1423

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

1424

except gnutls.errors.GNUTLSError as error:

1425

logger.warning("gnutls send failed")

1426

return

1427

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

1428

sent, len(client.secret)

1429

- (sent_size + sent))

1430

sent_size += sent

2294

1431

2295

1432

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

2296

# bump the timeout using extended_timeout

2297

client.bump_timeout(client.extended_timeout)

1433

# bump the timeout as if seen

1434

client.checked_ok(client.extended_timeout)

2298

1435

if self.server.use_dbus:

2299

1436

# Emit D-Bus signal

2300

1437

client.GotSecret()

2304

1441

client.approvals_pending -= 1

2305

1442

try:

2306

1443

session.bye()

2307

except gnutls.Error as error:

2308

logger.warning("GnuTLS bye failed",

2309

exc_info=error)

1444

except gnutls.errors.GNUTLSError as error:

1445

logger.warning("GnuTLS bye failed")

2310

1446

2311

1447

@staticmethod

2312

1448

def peer_certificate(session):

2313

1449

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

2314

1450

# If not an OpenPGP certificate...

2315

if (gnutls.certificate_type_get(session._c_object)

2316

!= gnutls.CRT_OPENPGP):

2317

# ...return invalid data

2318

return b""

1451

if (gnutls.library.functions

1452

.gnutls_certificate_type_get(session._c_object)

1453

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1454

# ...do the normal thing

1455

return session.peer_certificate

2319

1456

list_size = ctypes.c_uint(1)

2320

cert_list = (gnutls.certificate_get_peers

1457

cert_list = (gnutls.library.functions

1458

.gnutls_certificate_get_peers

2321

1459

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

2322

1460

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

2323

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

1461

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

1462

" certificate")

2324

1463

if list_size.value == 0:

2325

1464

return None

2326

1465

cert = cert_list[0]

2330

1469

def fingerprint(openpgp):

2331

1470

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2332

1471

# New GnuTLS "datum" with the OpenPGP public key

2333

datum = gnutls.datum_t(

2334

ctypes.cast(ctypes.c_char_p(openpgp),

2335

ctypes.POINTER(ctypes.c_ubyte)),

2336

ctypes.c_uint(len(openpgp)))

1472

datum = (gnutls.library.types

1473

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

1474

ctypes.POINTER

1475

(ctypes.c_ubyte)),

1476

ctypes.c_uint(len(openpgp))))

2337

1477

# New empty GnuTLS certificate

2338

crt = gnutls.openpgp_crt_t()

2339

gnutls.openpgp_crt_init(ctypes.byref(crt))

1478

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1479

(gnutls.library.functions

1480

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2340

1481

# Import the OpenPGP public key into the certificate

2341

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

2342

gnutls.OPENPGP_FMT_RAW)

1482

(gnutls.library.functions

1483

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

1484

gnutls.library.constants

1485

.GNUTLS_OPENPGP_FMT_RAW))

2343

1486

# Verify the self signature in the key

2344

1487

crtverify = ctypes.c_uint()

2345

gnutls.openpgp_crt_verify_self(crt, 0,

2346

ctypes.byref(crtverify))

1488

(gnutls.library.functions

1489

.gnutls_openpgp_crt_verify_self(crt, 0,

1490

ctypes.byref(crtverify)))

2347

1491

if crtverify.value != 0:

2348

gnutls.openpgp_crt_deinit(crt)

2349

raise gnutls.CertificateSecurityError("Verify failed")

1492

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1493

raise (gnutls.errors.CertificateSecurityError

1494

("Verify failed"))

2350

1495

# New buffer for the fingerprint

2351

1496

buf = ctypes.create_string_buffer(20)

2352

1497

buf_len = ctypes.c_size_t()

2353

1498

# Get the fingerprint from the certificate into the buffer

2354

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

2355

ctypes.byref(buf_len))

1499

(gnutls.library.functions

1500

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

1501

ctypes.byref(buf_len)))

2356

1502

# Deinit the certificate

2357

gnutls.openpgp_crt_deinit(crt)

1503

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2358

1504

# Convert the buffer to a Python bytestring

2359

1505

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

2360

1506

# Convert the bytestring to hexadecimal notation

2361

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

1507

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

2362

1508

return hex_fpr

2363

1509

2364

1510

2365

1511

class MultiprocessingMixIn(object):

2366

1512

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

2367

2368

1513

def sub_process_main(self, request, address):

2369

1514

try:

2370

1515

self.finish_request(request, address)

2371

except Exception:

1516

except:

2372

1517

self.handle_error(request, address)

2373

1518

self.close_request(request)

2374

1519

2375

1520

def process_request(self, request, address):

2376

1521

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

2377

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

2378

args = (request, address))

2379

proc.start()

2380

return proc

1522

multiprocessing.Process(target = self.sub_process_main,

1523

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

2381

1524

2382

1525

2383

1526

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2384

1527

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

2385

2386

1528

def process_request(self, request, client_address):

2387

1529

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

2388

1530

2390

1532

"""

2391

1533

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2392

1534

2393

proc = MultiprocessingMixIn.process_request(self, request,

2394

client_address)

1535

super(MultiprocessingMixInWithPipe,

1536

self).process_request(request, client_address)

2395

1537

self.child_pipe.close()

2396

self.add_pipe(parent_pipe, proc)

1538

self.add_pipe(parent_pipe)

2397

1539

2398

def add_pipe(self, parent_pipe, proc):

1540

def add_pipe(self, parent_pipe):

2399

1541

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

2400

raise NotImplementedError()

1542

raise NotImplementedError

2401

1543

2402

1544

2403

1545

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2409

1551

interface: None or a network interface name (string)

2410

1552

use_ipv6: Boolean; to use IPv6 or not

2411

1553

"""

2412

2413

1554

def __init__(self, server_address, RequestHandlerClass,

2414

interface=None,

2415

use_ipv6=True,

2416

socketfd=None):

2417

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

2418

creating a new one with socket.socket().

2419

"""

1555

interface=None, use_ipv6=True):

2420

1556

self.interface = interface

2421

1557

if use_ipv6:

2422

1558

self.address_family = socket.AF_INET6

2423

if socketfd is not None:

2424

# Save the file descriptor

2425

self.socketfd = socketfd

2426

# Save the original socket.socket() function

2427

self.socket_socket = socket.socket

2428

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

2429

#

2430

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

2431

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

2432

# patching socket.socket.)

2433

#

2434

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

2435

@functools.wraps(socket.socket)

2436

def socket_wrapper(*args, **kwargs):

2437

# Restore original function so subsequent calls are

2438

# not affected.

2439

socket.socket = self.socket_socket

2440

del self.socket_socket

2441

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

2442

# saved file descriptor.

2443

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

2444

# Replace socket.socket() function with wrapper

2445

socket.socket = socket_wrapper

2446

# The socketserver.TCPServer.__init__ will call

2447

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

2448

# socket_wrapper(), if socketfd was set.

2449

1559

socketserver.TCPServer.__init__(self, server_address,

2450

1560

RequestHandlerClass)

2451

2452

1561

def server_bind(self):

2453

1562

"""This overrides the normal server_bind() function

2454

1563

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

2455

1564

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

2456

1565

if self.interface is not None:

2457

1566

if SO_BINDTODEVICE is None:

2458

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

2459

# common enough.

2460

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

2461

SO_BINDTODEVICE = 25

2462

try:

2463

self.socket.setsockopt(

2464

socket.SOL_SOCKET, SO_BINDTODEVICE,

2465

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

2466

except socket.error as error:

2467

if error.errno == errno.EPERM:

2468

logger.error("No permission to bind to"

2469

" interface %s", self.interface)

2470

elif error.errno == errno.ENOPROTOOPT:

2471

logger.error("SO_BINDTODEVICE not available;"

2472

" cannot bind to interface %s",

2473

self.interface)

2474

elif error.errno == errno.ENODEV:

2475

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

2476

" cannot bind", self.interface)

2477

else:

2478

raise

1567

logger.error("SO_BINDTODEVICE does not exist;"

1568

" cannot bind to interface %s",

1569

self.interface)

1570

else:

1571

try:

1572

self.socket.setsockopt(socket.SOL_SOCKET,

1573

SO_BINDTODEVICE,

1574

str(self.interface

1575

+ '\0'))

1576

except socket.error as error:

1577

if error[0] == errno.EPERM:

1578

logger.error("No permission to"

1579

" bind to interface %s",

1580

self.interface)

1581

elif error[0] == errno.ENOPROTOOPT:

1582

logger.error("SO_BINDTODEVICE not available;"

1583

" cannot bind to interface %s",

1584

self.interface)

1585

else:

1586

raise

2479

1587

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

2480

1588

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

2481

1589

if not self.server_address[0]:

2482

1590

if self.address_family == socket.AF_INET6:

2483

1591

any_address = "::" # in6addr_any

2484

1592

else:

2485

any_address = "0.0.0.0" # INADDR_ANY

1593

any_address = socket.INADDR_ANY

2486

1594

self.server_address = (any_address,

2487

1595

self.server_address[1])

2488

1596

elif not self.server_address[1]:

2489

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

1597

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

1598

0)

2490

1599

# if self.interface:

2491

1600

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

2492

1601

# 0, # port

2504

1613

gnutls_priority GnuTLS priority string

2505

1614

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

2506

1615

2507

Assumes a GLib.MainLoop event loop.

1616

Assumes a gobject.MainLoop event loop.

2508

1617

"""

2509

2510

1618

def __init__(self, server_address, RequestHandlerClass,

2511

interface=None,

2512

use_ipv6=True,

2513

clients=None,

2514

gnutls_priority=None,

2515

use_dbus=True,

2516

socketfd=None):

1619

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

1620

gnutls_priority=None, use_dbus=True):

2517

1621

self.enabled = False

2518

1622

self.clients = clients

2519

1623

if self.clients is None:

2520

self.clients = {}

1624

self.clients = set()

2521

1625

self.use_dbus = use_dbus

2522

1626

self.gnutls_priority = gnutls_priority

2523

1627

IPv6_TCPServer.__init__(self, server_address,

2524

1628

RequestHandlerClass,

2525

1629

interface = interface,

2526

use_ipv6 = use_ipv6,

2527

socketfd = socketfd)

2528

1630

use_ipv6 = use_ipv6)

2529

1631

def server_activate(self):

2530

1632

if self.enabled:

2531

1633

return socketserver.TCPServer.server_activate(self)

2532

2533

1634

def enable(self):

2534

1635

self.enabled = True

2535

2536

def add_pipe(self, parent_pipe, proc):

1636

def add_pipe(self, parent_pipe):

2537

1637

# Call "handle_ipc" for both data and EOF events

2538

GLib.io_add_watch(

2539

parent_pipe.fileno(),

2540

GLib.IO_IN | GLib.IO_HUP,

2541

functools.partial(self.handle_ipc,

2542

parent_pipe = parent_pipe,

2543

proc = proc))

2544

2545

def handle_ipc(self, source, condition,

2546

parent_pipe=None,

2547

proc = None,

1638

gobject.io_add_watch(parent_pipe.fileno(),

1639

gobject.IO_IN | gobject.IO_HUP,

1640

functools.partial(self.handle_ipc,

1641

parent_pipe =

1642

parent_pipe))

1643

1644

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

2548

1645

client_object=None):

2549

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

2550

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

2551

# Wait for other process to exit

2552

proc.join()

1646

condition_names = {

1647

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

1648

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

1649

# blocking).

1650

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

1651

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

1652

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

1653

# broken, usually for pipes and

1654

# sockets).

1655

}

1656

conditions_string = ' | '.join(name

1657

for cond, name in

1658

condition_names.iteritems()

1659

if cond & condition)

1660

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

1661

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

2553

1662

return False

2554

1663

2555

1664

# Read a request from the child

2560

1669

fpr = request[1]

2561

1670

address = request[2]

2562

1671

2563

for c in self.clients.values():

1672

for c in self.clients:

2564

1673

if c.fingerprint == fpr:

2565

1674

client = c

2566

1675

break

2574

1683

parent_pipe.send(False)

2575

1684

return False

2576

1685

2577

GLib.io_add_watch(

2578

parent_pipe.fileno(),

2579

GLib.IO_IN | GLib.IO_HUP,

2580

functools.partial(self.handle_ipc,

2581

parent_pipe = parent_pipe,

2582

proc = proc,

2583

client_object = client))

1686

gobject.io_add_watch(parent_pipe.fileno(),

1687

gobject.IO_IN | gobject.IO_HUP,

1688

functools.partial(self.handle_ipc,

1689

parent_pipe =

1690

parent_pipe,

1691

client_object =

1692

client))

2584

1693

parent_pipe.send(True)

2585

1694

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

2586

1695

# same fileno

2592

1701

2593

1702

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

2594

1703

funcname)(*args,

2595

**kwargs)))

1704

**kwargs)))

2596

1705

2597

1706

if command == 'getattr':

2598

1707

attrname = request[1]

2599

if isinstance(client_object.__getattribute__(attrname),

2600

collections.Callable):

2601

parent_pipe.send(('function', ))

1708

if callable(client_object.__getattribute__(attrname)):

1709

parent_pipe.send(('function',))

2602

1710

else:

2603

parent_pipe.send((

2604

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

1711

parent_pipe.send(('data', client_object

1712

.__getattribute__(attrname)))

2605

1713

2606

1714

if command == 'setattr':

2607

1715

attrname = request[1]

2611

1719

return True

2612

1720

2613

1721

2614

def rfc3339_duration_to_delta(duration):

2615

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

2616

2617

>>> rfc3339_duration_to_delta("P7D")

2618

datetime.timedelta(7)

2619

>>> rfc3339_duration_to_delta("PT60S")

2620

datetime.timedelta(0, 60)

2621

>>> rfc3339_duration_to_delta("PT60M")

2622

datetime.timedelta(0, 3600)

2623

>>> rfc3339_duration_to_delta("PT24H")

2624

datetime.timedelta(1)

2625

>>> rfc3339_duration_to_delta("P1W")

2626

datetime.timedelta(7)

2627

>>> rfc3339_duration_to_delta("PT5M30S")

2628

datetime.timedelta(0, 330)

2629

>>> rfc3339_duration_to_delta("P1DT3M20S")

2630

datetime.timedelta(1, 200)

2631

"""

2632

2633

# Parsing an RFC 3339 duration with regular expressions is not

2634

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

2635

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

2636

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

2637

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

2638

# avoid excessive use of external libraries.

2639

2640

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

2641

Token = collections.namedtuple("Token", (

2642

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

2643

# a "group" containing digits

2644

"value", # datetime.timedelta or None

2645

"followers")) # Tokens valid after this token

2646

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

2647

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

2648

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

2649

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

2650

datetime.timedelta(seconds=1),

2651

frozenset((token_end, )))

2652

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

2653

datetime.timedelta(minutes=1),

2654

frozenset((token_second, token_end)))

2655

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

2656

datetime.timedelta(hours=1),

2657

frozenset((token_minute, token_end)))

2658

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

2659

None,

2660

frozenset((token_hour, token_minute,

2661

token_second)))

2662

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

2663

datetime.timedelta(days=1),

2664

frozenset((token_time, token_end)))

2665

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

2666

datetime.timedelta(weeks=4),

2667

frozenset((token_day, token_end)))

2668

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

2669

datetime.timedelta(weeks=52),

2670

frozenset((token_month, token_end)))

2671

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

2672

datetime.timedelta(weeks=1),

2673

frozenset((token_end, )))

2674

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

2675

frozenset((token_year, token_month,

2676

token_day, token_time,

2677

token_week)))

2678

# Define starting values

2679

value = datetime.timedelta() # Value so far

2680

found_token = None

2681

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

2682

s = duration # String left to parse

2683

# Loop until end token is found

2684

while found_token is not token_end:

2685

# Search for any currently valid tokens

2686

for token in followers:

2687

match = token.regexp.match(s)

2688

if match is not None:

2689

# Token found

2690

if token.value is not None:

2691

# Value found, parse digits

2692

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

2693

# Add to value so far

2694

value += factor * token.value

2695

# Strip token from string

2696

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

2697

# Go to found token

2698

found_token = token

2699

# Set valid next tokens

2700

followers = found_token.followers

2701

break

2702

else:

2703

# No currently valid tokens were found

2704

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

2705

.format(duration))

2706

# End token found

2707

return value

2708

2709

2710

1722

def string_to_delta(interval):

2711

1723

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

2712

1724

2723

1735

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

2724

1736

datetime.timedelta(0, 330)

2725

1737

"""

2726

2727

try:

2728

return rfc3339_duration_to_delta(interval)

2729

except ValueError:

2730

pass

2731

2732

1738

timevalue = datetime.timedelta(0)

2733

1739

for s in interval.split():

2734

1740

try:

2735

suffix = s[-1]

1741

suffix = unicode(s[-1])

2736

1742

value = int(s[:-1])

2737

1743

if suffix == "d":

2738

1744

delta = datetime.timedelta(value)

2745

1751

elif suffix == "w":

2746

1752

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

2747

1753

else:

2748

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

2749

except IndexError as e:

1754

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

1755

except (ValueError, IndexError) as e:

2750

1756

raise ValueError(*(e.args))

2751

1757

timevalue += delta

2752

1758

return timevalue

2753

1759

2754

1760

1761

def if_nametoindex(interface):

1762

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

1763

1764

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

1765

global if_nametoindex

1766

try:

1767

if_nametoindex = (ctypes.cdll.LoadLibrary

1768

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

1769

.if_nametoindex)

1770

except (OSError, AttributeError):

1771

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

1772

def if_nametoindex(interface):

1773

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

1774

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

1775

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

1776

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1777

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

1778

interface))

1779

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

1780

ifreq[16:20])[0]

1781

return interface_index

1782

return if_nametoindex(interface)

1783

1784

2755

1785

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

2756

1786

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

2757

1787

2765

1795

sys.exit()

2766

1796

if not noclose:

2767

1797

# Close all standard open file descriptors

2768

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

1798

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

2769

1799

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

2770

1800

raise OSError(errno.ENODEV,

2771

"{} not a character device"

2772

.format(os.devnull))

1801

"%s not a character device"

1802

% os.path.devnull)

2773

1803

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

2774

1804

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

2775

1805

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

2784

1814

2785

1815

parser = argparse.ArgumentParser()

2786

1816

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

2787

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

1817

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

2788

1818

help="show version number and exit")

2789

1819

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

2790

1820

help="Bind to interface IF")

2796

1826

help="Run self-test")

2797

1827

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

2798

1828

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

2799

" to terminal", default=None)

1829

" to terminal")

2800

1830

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

2801

1831

help="Debug level for stdout output")

2802

1832

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

2809

1839

" files")

2810

1840

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

2811

1841

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

2812

" system bus interface", default=None)

1842

" system bus interface")

2813

1843

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

2814

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

2815

default=None)

2816

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

2817

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

2818

" state", default=None)

2819

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

2820

help="Specify a file descriptor to a network"

2821

" socket to use instead of creating one")

2822

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

2823

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

2824

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

2825

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

2826

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

2827

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

2828

default=None)

2829

1844

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

2830

1845

options = parser.parse_args()

2831

1846

2832

1847

if options.check:

2833

1848

import doctest

2834

fail_count, test_count = doctest.testmod()

2835

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

1849

doctest.testmod()

1850

sys.exit()

2836

1851

2837

1852

# Default values for config file for server-global settings

2838

1853

server_defaults = { "interface": "",

2840

1855

"port": "",

2841

1856

"debug": "False",

2842

1857

"priority":

2843

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

2844

":+SIGN-DSA-SHA256",

1858

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

2845

1859

"servicename": "Mandos",

2846

1860

"use_dbus": "True",

2847

1861

"use_ipv6": "True",

2848

1862

"debuglevel": "",

2849

"restore": "True",

2850

"socket": "",

2851

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

2852

"foreground": "False",

2853

"zeroconf": "True",

2854

}

1863

}

2855

1864

2856

1865

# Parse config file for server-global settings

2857

1866

server_config = configparser.SafeConfigParser(server_defaults)

2858

1867

del server_defaults

2859

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

1868

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

1869

"mandos.conf"))

2860

1870

# Convert the SafeConfigParser object to a dict

2861

1871

server_settings = server_config.defaults()

2862

1872

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

2863

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

1873

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

2864

1874

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

2865

1875

option)

2866

1876

if server_settings["port"]:

2867

1877

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

2868

1878

"port")

2869

if server_settings["socket"]:

2870

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

2871

"socket")

2872

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

2873

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

2874

# happen with a supplied network socket.

2875

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

2876

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

2877

["socket"])

2878

1879

del server_config

2879

1880

2880

1881

# Override the settings from the config file with command line

2881

1882

# options, if set.

2882

1883

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

2883

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

2884

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

2885

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

1884

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

1885

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

2886

1886

value = getattr(options, option)

2887

1887

if value is not None:

2888

1888

server_settings[option] = value

2889

1889

del options

2890

1890

# Force all strings to be unicode

2891

1891

for option in server_settings.keys():

2892

if isinstance(server_settings[option], bytes):

2893

server_settings[option] = (server_settings[option]

2894

.decode("utf-8"))

2895

# Force all boolean options to be boolean

2896

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

2897

"foreground", "zeroconf"):

2898

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

2899

# Debug implies foreground

2900

if server_settings["debug"]:

2901

server_settings["foreground"] = True

1892

if type(server_settings[option]) is str:

1893

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

2902

1894

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

2903

1895

2904

1896

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

2905

1897

2906

if (not server_settings["zeroconf"]

2907

and not (server_settings["port"]

2908

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

2909

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

2910

2911

1898

# For convenience

2912

1899

debug = server_settings["debug"]

2913

1900

debuglevel = server_settings["debuglevel"]

2914

1901

use_dbus = server_settings["use_dbus"]

2915

1902

use_ipv6 = server_settings["use_ipv6"]

2916

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

2917

stored_state_file)

2918

foreground = server_settings["foreground"]

2919

zeroconf = server_settings["zeroconf"]

2920

2921

if debug:

2922

initlogger(debug, logging.DEBUG)

2923

else:

2924

if not debuglevel:

2925

initlogger(debug)

2926

else:

2927

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

2928

initlogger(debug, level)

2929

1903

2930

1904

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

2931

syslogger.setFormatter(

2932

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

2933

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

2934

server_settings["servicename"])))

1905

syslogger.setFormatter(logging.Formatter

1906

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

1907

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

1908

% server_settings["servicename"]))

2935

1909

2936

1910

# Parse config file with clients

2937

client_config = configparser.SafeConfigParser(Client

2938

.client_defaults)

1911

client_defaults = { "timeout": "5m",

1912

"extended_timeout": "15m",

1913

"interval": "2m",

1914

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

1915

"host": "",

1916

"approval_delay": "0s",

1917

"approval_duration": "1s",

1918

}

1919

client_config = configparser.SafeConfigParser(client_defaults)

2939

1920

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

2940

1921

"clients.conf"))

2941

1922

2942

1923

global mandos_dbus_service

2943

1924

mandos_dbus_service = None

2944

1925

2945

socketfd = None

2946

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

2947

socketfd = server_settings["socket"]

2948

tcp_server = MandosServer(

2949

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

2950

ClientHandler,

2951

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

2952

use_ipv6=use_ipv6,

2953

gnutls_priority=server_settings["priority"],

2954

use_dbus=use_dbus,

2955

socketfd=socketfd)

2956

if not foreground:

2957

pidfilename = "/run/mandos.pid"

2958

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

2959

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

2960

pidfile = None

1926

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

1927

server_settings["port"]),

1928

ClientHandler,

1929

interface=(server_settings["interface"]

1930

or None),

1931

use_ipv6=use_ipv6,

1932

gnutls_priority=

1933

server_settings["priority"],

1934

use_dbus=use_dbus)

1935

if not debug:

1936

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

2961

1937

try:

2962

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

2963

except IOError as e:

2964

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

2965

exc_info=e)

1938

pidfile = open(pidfilename, "w")

1939

except IOError:

1940

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

2966

1941

2967

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

2968

("mandos", "mandos"),

2969

("nobody", "nogroup")):

1942

try:

1943

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

1944

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

1945

except KeyError:

2970

1946

try:

2971

uid = pwd.getpwnam(name).pw_uid

2972

gid = pwd.getpwnam(group).pw_gid

2973

break

1947

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

1948

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

2974

1949

except KeyError:

2975

continue

2976

else:

2977

uid = 65534

2978

gid = 65534

1950

try:

1951

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

1952

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

1953

except KeyError:

1954

uid = 65534

1955

gid = 65534

2979

1956

try:

2980

1957

os.setgid(gid)

2981

1958

os.setuid(uid)

2982

if debug:

2983

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

2984

gid))

2985

1959

except OSError as error:

2986

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

2987

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

2988

if error.errno != errno.EPERM:

2989

raise

1960

if error[0] != errno.EPERM:

1961

raise error

1962

1963

if not debug and not debuglevel:

1964

syslogger.setLevel(logging.WARNING)

1965

console.setLevel(logging.WARNING)

1966

if debuglevel:

1967

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

1968

syslogger.setLevel(level)

1969

console.setLevel(level)

2990

1970

2991

1971

if debug:

2992

1972

# Enable all possible GnuTLS debugging

2993

1973

2994

1974

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

2995

1975

# - GnuTLS manual

2996

gnutls.global_set_log_level(11)

1976

gnutls.library.functions.gnutls_global_set_log_level(11)

2997

1977

2998

@gnutls.log_func

1978

@gnutls.library.types.gnutls_log_func

2999

1979

def debug_gnutls(level, string):

3000

1980

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

3001

1981

3002

gnutls.global_set_log_function(debug_gnutls)

1982

(gnutls.library.functions

1983

.gnutls_global_set_log_function(debug_gnutls))

3003

1984

3004

1985

# Redirect stdin so all checkers get /dev/null

3005

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

1986

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

3006

1987

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

3007

1988

if null > 2:

3008

1989

os.close(null)

1990

else:

1991

# No console logging

1992

logger.removeHandler(console)

3009

1993

3010

1994

# Need to fork before connecting to D-Bus

3011

if not foreground:

1995

if not debug:

3012

1996

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

3013

1997

daemon()

3014

1998

3015

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

3016

# to inform GLib that threads will be used.

3017

GLib.threads_init()

3018

3019

1999

global main_loop

3020

2000

# From the Avahi example code

3021

DBusGMainLoop(set_as_default=True)

3022

main_loop = GLib.MainLoop()

2001

DBusGMainLoop(set_as_default=True )

2002

main_loop = gobject.MainLoop()

3023

2003

bus = dbus.SystemBus()

3024

2004

# End of Avahi example code

3025

2005

if use_dbus:

3026

2006

try:

3027

2007

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

3028

bus,

3029

do_not_queue=True)

3030

old_bus_name = dbus.service.BusName(

3031

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

3032

do_not_queue=True)

3033

except dbus.exceptions.DBusException as e:

3034

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

2008

bus, do_not_queue=True)

2009

old_bus_name = (dbus.service.BusName

2010

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

2011

do_not_queue=True))

2012

except dbus.exceptions.NameExistsException as e:

2013

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

3035

2014

use_dbus = False

3036

2015

server_settings["use_dbus"] = False

3037

2016

tcp_server.use_dbus = False

3038

if zeroconf:

3039

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3040

service = AvahiServiceToSyslog(

3041

name = server_settings["servicename"],

3042

servicetype = "_mandos._tcp",

3043

protocol = protocol,

3044

bus = bus)

3045

if server_settings["interface"]:

3046

service.interface = if_nametoindex(

3047

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

2017

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2018

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

2019

servicetype = "_mandos._tcp",

2020

protocol = protocol, bus = bus)

2021

if server_settings["interface"]:

2022

service.interface = (if_nametoindex

2023

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

3048

2024

3049

2025

global multiprocessing_manager

3050

2026

multiprocessing_manager = multiprocessing.Manager()

3051

2027

3052

2028

client_class = Client

3053

2029

if use_dbus:

3054

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

3055

3056

client_settings = Client.config_parser(client_config)

3057

old_client_settings = {}

3058

clients_data = {}

3059

3060

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

3061

global wnull

3062

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

3063

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

3064

# mode

3065

if debug or not foreground:

3066

wnull.close()

3067

3068

# Get client data and settings from last running state.

3069

if server_settings["restore"]:

3070

try:

3071

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

3072

if sys.version_info.major == 2:

3073

clients_data, old_client_settings = pickle.load(

3074

stored_state)

3075

else:

3076

bytes_clients_data, bytes_old_client_settings = (

3077

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

3078

### Fix bytes to strings

3079

## clients_data

3080

# .keys()

3081

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

3082

if isinstance(key, bytes)

3083

else key): value

3084

for key, value in

3085

bytes_clients_data.items() }

3086

del bytes_clients_data

3087

for key in clients_data:

3088

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

3089

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

3090

for k, v in

3091

clients_data[key].items() }

3092

clients_data[key] = value

3093

# .client_structure

3094

value["client_structure"] = [

3095

(s.decode("utf-8")

3096

if isinstance(s, bytes)

3097

else s) for s in

3098

value["client_structure"] ]

3099

# .name & .host

3100

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

3101

if isinstance(value[k], bytes):

3102

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

3103

## old_client_settings

3104

# .keys()

3105

old_client_settings = {

3106

(key.decode("utf-8")

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_old_client_settings.items() }

3111

del bytes_old_client_settings

3112

# .host

3113

for value in old_client_settings.values():

3114

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

3115

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

3116

.decode("utf-8"))

3117

os.remove(stored_state_path)

3118

except IOError as e:

3119

if e.errno == errno.ENOENT:

3120

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

3121

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

3122

else:

3123

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

3124

exc_info=e)

3125

raise

3126

except EOFError as e:

3127

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

3128

"EOFError:",

3129

exc_info=e)

3130

3131

with PGPEngine() as pgp:

3132

for client_name, client in clients_data.items():

3133

# Skip removed clients

3134

if client_name not in client_settings:

3135

continue

3136

3137

# Decide which value to use after restoring saved state.

3138

# We have three different values: Old config file,

3139

# new config file, and saved state.

3140

# New config value takes precedence if it differs from old

3141

# config value, otherwise use saved state.

3142

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

3143

try:

3144

# For each value in new config, check if it

3145

# differs from the old config value (Except for

3146

# the "secret" attribute)

3147

if (name != "secret"

3148

and (value !=

3149

old_client_settings[client_name][name])):

3150

client[name] = value

3151

except KeyError:

3152

pass

3153

3154

# Clients who has passed its expire date can still be

3155

# enabled if its last checker was successful. A Client

3156

# whose checker succeeded before we stored its state is

3157

# assumed to have successfully run all checkers during

3158

# downtime.

3159

if client["enabled"]:

3160

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

3161

if not client["last_checked_ok"]:

3162

logger.warning(

3163

"disabling client {} - Client never "

3164

"performed a successful checker".format(

3165

client_name))

3166

client["enabled"] = False

3167

elif client["last_checker_status"] != 0:

3168

logger.warning(

3169

"disabling client {} - Client last"

3170

" checker failed with error code"

3171

" {}".format(

3172

client_name,

3173

client["last_checker_status"]))

3174

client["enabled"] = False

3175

else:

3176

client["expires"] = (

3177

datetime.datetime.utcnow()

3178

+ client["timeout"])

3179

logger.debug("Last checker succeeded,"

3180

" keeping {} enabled".format(

3181

client_name))

2030

client_class = functools.partial(ClientDBusTransitional,

2031

bus = bus)

2032

def client_config_items(config, section):

2033

special_settings = {

2034

"approved_by_default":

2035

lambda: config.getboolean(section,

2036

"approved_by_default"),

2037

}

2038

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

3182

2039

try:

3183

client["secret"] = pgp.decrypt(

3184

client["encrypted_secret"],

3185

client_settings[client_name]["secret"])

3186

except PGPError:

3187

# If decryption fails, we use secret from new settings

3188

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

3189

client_name))

3190

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

3191

["secret"])

3192

3193

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

3194

for client_name in (set(old_client_settings)

3195

- set(client_settings)):

3196

del clients_data[client_name]

3197

for client_name in (set(client_settings)

3198

- set(old_client_settings)):

3199

clients_data[client_name] = client_settings[client_name]

3200

3201

# Create all client objects

3202

for client_name, client in clients_data.items():

3203

tcp_server.clients[client_name] = client_class(

3204

name = client_name,

3205

settings = client,

3206

server_settings = server_settings)

3207

2040

yield (name, special_settings[name]())

2041

except KeyError:

2042

yield (name, value)

2043

2044

tcp_server.clients.update(set(

2045

client_class(name = section,

2046

config= dict(client_config_items(

2047

client_config, section)))

2048

for section in client_config.sections()))

3208

2049

if not tcp_server.clients:

3209

2050

logger.warning("No clients defined")

3210

3211

if not foreground:

3212

if pidfile is not None:

3213

pid = os.getpid()

3214

try:

3215

with pidfile:

3216

print(pid, file=pidfile)

3217

except IOError:

3218

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

3219

pidfilename, pid)

3220

del pidfile

2051

2052

if not debug:

2053

try:

2054

with pidfile:

2055

pid = os.getpid()

2056

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

2057

del pidfile

2058

except IOError:

2059

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

2060

pidfilename, pid)

2061

except NameError:

2062

# "pidfile" was never created

2063

pass

3221

2064

del pidfilename

2065

2066

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

3222

2067

3223

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

3224

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3225

lambda: main_loop.quit() and False)

2068

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

2069

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

3226

2070

3227

2071

if use_dbus:

3228

3229

@alternate_dbus_interfaces(

3230

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

3231

class MandosDBusService(DBusObjectWithObjectManager):

2072

class MandosDBusService(dbus.service.Object):

3232

2073

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

3233

3234

2074

def __init__(self):

3235

2075

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

3236

3237

2076

_interface = "se.recompile.Mandos"

3238

2077

3239

2078

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

3246

2085

"D-Bus signal"

3247

2086

pass

3248

2087

3249

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

3250

"true"})

3251

2088

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

3252

2089

def ClientRemoved(self, objpath, name):

3253

2090

"D-Bus signal"

3254

2091

pass

3255

2092

3256

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

3257

"true"})

3258

2093

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

3259

2094

def GetAllClients(self):

3260

2095

"D-Bus method"

3261

return dbus.Array(c.dbus_object_path for c in

3262

tcp_server.clients.values())

2096

return dbus.Array(c.dbus_object_path

2097

for c in tcp_server.clients)

3263

2098

3264

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

3265

"true"})

3266

2099

@dbus.service.method(_interface,

3267

2100

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

3268

2101

def GetAllClientsWithProperties(self):

3269

2102

"D-Bus method"

3270

2103

return dbus.Dictionary(

3271

{ c.dbus_object_path: c.GetAll(

3272

"se.recompile.Mandos.Client")

3273

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

2104

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

2105

for c in tcp_server.clients),

3274

2106

signature="oa{sv}")

3275

2107

3276

2108

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

3277

2109

def RemoveClient(self, object_path):

3278

2110

"D-Bus method"

3279

for c in tcp_server.clients.values():

2111

for c in tcp_server.clients:

3280

2112

if c.dbus_object_path == object_path:

3281

del tcp_server.clients[c.name]

2113

tcp_server.clients.remove(c)

3282

2114

c.remove_from_connection()

3283

# Don't signal the disabling

2115

# Don't signal anything except ClientRemoved

3284

2116

c.disable(quiet=True)

3285

# Emit D-Bus signal for removal

3286

self.client_removed_signal(c)

2117

# Emit D-Bus signal

2118

self.ClientRemoved(object_path, c.name)

3287

2119

return

3288

2120

raise KeyError(object_path)

3289

2121

3290

2122

del _interface

3291

3292

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3293

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

3294

def GetManagedObjects(self):

3295

"""D-Bus method"""

3296

return dbus.Dictionary(

3297

{ client.dbus_object_path:

3298

dbus.Dictionary(

3299

{ interface: client.GetAll(interface)

3300

for interface in

3301

client._get_all_interface_names()})

3302

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

3303

3304

def client_added_signal(self, client):

3305

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

3306

if use_dbus:

3307

# New standard signal

3308

self.InterfacesAdded(

3309

client.dbus_object_path,

3310

dbus.Dictionary(

3311

{ interface: client.GetAll(interface)

3312

for interface in

3313

client._get_all_interface_names()}))

3314

# Old signal

3315

self.ClientAdded(client.dbus_object_path)

3316

3317

def client_removed_signal(self, client):

3318

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

3319

if use_dbus:

3320

# New standard signal

3321

self.InterfacesRemoved(

3322

client.dbus_object_path,

3323

client._get_all_interface_names())

3324

# Old signal

3325

self.ClientRemoved(client.dbus_object_path,

3326

client.name)

3327

2123

3328

mandos_dbus_service = MandosDBusService()

2124

class MandosDBusServiceTransitional(MandosDBusService):

2125

__metaclass__ = AlternateDBusNamesMetaclass

2126

mandos_dbus_service = MandosDBusServiceTransitional()

3329

2127

3330

# Save modules to variables to exempt the modules from being

3331

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

3332

mp = multiprocessing

3333

wn = wnull

3334

2128

def cleanup():

3335

2129

"Cleanup function; run on exit"

3336

if zeroconf:

3337

service.cleanup()

3338

3339

mp.active_children()

3340

wn.close()

3341

if not (tcp_server.clients or client_settings):

3342

return

3343

3344

# Store client before exiting. Secrets are encrypted with key

3345

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

3346

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

3347

clients = {}

3348

with PGPEngine() as pgp:

3349

for client in tcp_server.clients.values():

3350

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

3351

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

3352

key)

3353

client_dict = {}

3354

3355

# A list of attributes that can not be pickled

3356

# + secret.

3357

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

3358

"checker", "server_settings" }

3359

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

3360

.Object):

3361

exclude.add(name)

3362

3363

client_dict["encrypted_secret"] = (client

3364

.encrypted_secret)

3365

for attr in client.client_structure:

3366

if attr not in exclude:

3367

client_dict[attr] = getattr(client, attr)

3368

3369

clients[client.name] = client_dict

3370

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

3371

3372

try:

3373

with tempfile.NamedTemporaryFile(

3374

mode='wb',

3375

suffix=".pickle",

3376

prefix='clients-',

3377

dir=os.path.dirname(stored_state_path),

3378

delete=False) as stored_state:

3379

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

3380

protocol = 2)

3381

tempname = stored_state.name

3382

os.rename(tempname, stored_state_path)

3383

except (IOError, OSError) as e:

3384

if not debug:

3385

try:

3386

os.remove(tempname)

3387

except NameError:

3388

pass

3389

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

3390

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

3391

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

3392

else:

3393

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

3394

exc_info=e)

3395

raise

3396

3397

# Delete all clients, and settings from config

2130

service.cleanup()

2131

3398

2132

while tcp_server.clients:

3399

name, client = tcp_server.clients.popitem()

2133

client = tcp_server.clients.pop()

3400

2134

if use_dbus:

3401

2135

client.remove_from_connection()

3402

# Don't signal the disabling

2136

client.disable_hook = None

2137

# Don't signal anything except ClientRemoved

3403

2138

client.disable(quiet=True)

3404

# Emit D-Bus signal for removal

3405

2139

if use_dbus:

3406

mandos_dbus_service.client_removed_signal(client)

3407

client_settings.clear()

2140

# Emit D-Bus signal

2141

mandos_dbus_service.ClientRemoved(client

2142

.dbus_object_path,

2143

client.name)

3408

2144

3409

2145

atexit.register(cleanup)

3410

2146

3411

for client in tcp_server.clients.values():

2147

for client in tcp_server.clients:

3412

2148

if use_dbus:

3413

# Emit D-Bus signal for adding

3414

mandos_dbus_service.client_added_signal(client)

3415

# Need to initiate checking of clients

3416

if client.enabled:

3417

client.init_checker()

2149

# Emit D-Bus signal

2150

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2151

client.enable()

3418

2152

3419

2153

tcp_server.enable()

3420

2154

tcp_server.server_activate()

3421

2155

3422

2156

# Find out what port we got

3423

if zeroconf:

3424

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

2157

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

3425

2158

if use_ipv6:

3426

2159

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

3427

" flowinfo %d, scope_id %d",

3428

*tcp_server.socket.getsockname())

2160

" flowinfo %d, scope_id %d"

2161

% tcp_server.socket.getsockname())

3429

2162

else: # IPv4

3430

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

3431

*tcp_server.socket.getsockname())

2163

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

2164

% tcp_server.socket.getsockname())

3432

2165

3433

2166

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

3434

2167

3435

2168

try:

3436

if zeroconf:

3437

# From the Avahi example code

3438

try:

3439

service.activate()

3440

except dbus.exceptions.DBusException as error:

3441

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

3442

cleanup()

3443

sys.exit(1)

3444

# End of Avahi example code

2169

# From the Avahi example code

2170

try:

2171

service.activate()

2172

except dbus.exceptions.DBusException as error:

2173

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

2174

cleanup()

2175

sys.exit(1)

2176

# End of Avahi example code

3445

2177

3446

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

3447

lambda *args, **kwargs:

3448

(tcp_server.handle_request

3449

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

2178

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

2179

lambda *args, **kwargs:

2180

(tcp_server.handle_request

2181

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

3450

2182

3451

2183

logger.debug("Starting main loop")

3452

2184

main_loop.run()

3453

2185

except AvahiError as error:

3454

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

2186

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

3455

2187

cleanup()

3456

2188

sys.exit(1)

3457

2189

except KeyboardInterrupt: