/mandos/trunk : revision 856

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

28

# along with this program. If not, see

29

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

30

#

31

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

31

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

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

38

46

import socket

39

import optparse

47

import argparse

40

48

import datetime

41

49

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

49

54

import sys

50

55

import re

51

56

import os

60

65

import struct

61

66

import fcntl

62

67

import functools

63

import cPickle as pickle

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

64

72

import multiprocessing

73

import types

74

import binascii

75

import tempfile

76

import itertools

77

import collections

78

import codecs

65

79

66

80

import dbus

67

81

import dbus.service

68

import gobject

69

import avahi

82

from gi.repository import GLib

70

83

from dbus.mainloop.glib import DBusGMainLoop

71

84

import ctypes

72

85

import ctypes.util

73

86

import xml.dom.minidom

74

87

import inspect

75

88

89

# Try to find the value of SO_BINDTODEVICE:

76

90

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:

77

93

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

78

94

except AttributeError:

79

95

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

80

98

from IN import SO_BINDTODEVICE

81

99

except ImportError:

82

SO_BINDTODEVICE = None

83

84

85

version = "1.2.3"

86

87

#logger = logging.getLogger('mandos')

88

logger = logging.Logger('mandos')

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

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

92

syslogger.setFormatter(logging.Formatter

93

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

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

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

99

' %(levelname)s:'

100

' %(message)s'))

101

logger.addHandler(console)

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

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

102

299

103

300

class AvahiError(Exception):

104

301

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

105

302

self.value = value

106

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

107

def __unicode__(self):

108

return unicode(repr(self.value))

303

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

304

**kwargs)

305

109

306

110

307

class AvahiServiceError(AvahiError):

111

308

pass

112

309

310

113

311

class AvahiGroupError(AvahiError):

114

312

pass

115

313

122

320

Used to optionally bind to the specified interface.

123

321

name: string; Example: 'Mandos'

124

322

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

125

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

323

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

126

324

port: integer; what port to announce

127

325

TXT: list of strings; TXT record for the service

128

326

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

134

332

server: D-Bus Server

135

333

bus: dbus.SystemBus()

136

334

"""

137

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

138

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

139

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

140

protocol = avahi.PROTO_UNSPEC, bus = None):

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

141

347

self.interface = interface

142

348

self.name = name

143

349

self.type = servicetype

151

357

self.group = None # our entry group

152

358

self.server = None

153

359

self.bus = bus

154

def rename(self):

360

self.entry_group_state_changed_match = None

361

362

def rename(self, remove=True):

155

363

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

156

364

if self.rename_count >= self.max_renames:

157

365

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

158

366

" after %i retries, exiting.",

159

367

self.rename_count)

160

368

raise AvahiServiceError("Too many renames")

161

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

369

self.name = str(

370

self.server.GetAlternativeServiceName(self.name))

371

self.rename_count += 1

162

372

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

163

373

self.name)

164

syslogger.setFormatter(logging.Formatter

165

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

166

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

167

% self.name))

168

self.remove()

374

if remove:

375

self.remove()

169

376

try:

170

377

self.add()

171

except dbus.exceptions.DBusException, error:

172

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

173

self.cleanup()

174

os._exit(1)

175

self.rename_count += 1

378

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

176

388

def remove(self):

177

389

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

390

if self.entry_group_state_changed_match is not None:

391

self.entry_group_state_changed_match.remove()

392

self.entry_group_state_changed_match = None

178

393

if self.group is not None:

179

394

self.group.Reset()

395

180

396

def add(self):

181

397

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

398

self.remove()

182

399

if self.group is None:

183

400

self.group = dbus.Interface(

184

401

self.bus.get_object(avahi.DBUS_NAME,

185

402

self.server.EntryGroupNew()),

186

403

avahi.DBUS_INTERFACE_ENTRY_GROUP)

187

self.group.connect_to_signal('StateChanged',

188

self

189

.entry_group_state_changed)

404

self.entry_group_state_changed_match = (

405

self.group.connect_to_signal(

406

'StateChanged', self.entry_group_state_changed))

190

407

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

191

408

self.name, self.type)

192

409

self.group.AddService(

198

415

dbus.UInt16(self.port),

199

416

avahi.string_array_to_txt_array(self.TXT))

200

417

self.group.Commit()

418

201

419

def entry_group_state_changed(self, state, error):

202

420

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

203

421

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

209

427

self.rename()

210

428

elif state == avahi.ENTRY_GROUP_FAILURE:

211

429

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

212

unicode(error))

213

raise AvahiGroupError("State changed: %s"

214

% unicode(error))

430

str(error))

431

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

432

215

433

def cleanup(self):

216

434

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

217

435

if self.group is not None:

218

self.group.Free()

436

try:

437

self.group.Free()

438

except (dbus.exceptions.UnknownMethodException,

439

dbus.exceptions.DBusException):

440

pass

219

441

self.group = None

220

def server_state_changed(self, state):

442

self.remove()

443

444

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

221

445

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

222

446

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

223

if state == avahi.SERVER_COLLISION:

224

logger.error("Zeroconf server name collision")

225

self.remove()

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

}

453

if state in bad_states:

454

if bad_states[state] is not None:

455

if error is None:

456

logger.error(bad_states[state])

457

else:

458

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

459

self.cleanup()

226

460

elif state == avahi.SERVER_RUNNING:

227

self.add()

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)

473

else:

474

if error is None:

475

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

476

else:

477

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

478

228

479

def activate(self):

229

480

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

230

481

if self.server is None:

231

482

self.server = dbus.Interface(

232

483

self.bus.get_object(avahi.DBUS_NAME,

233

avahi.DBUS_PATH_SERVER),

484

avahi.DBUS_PATH_SERVER,

485

follow_name_owner_changes=True),

234

486

avahi.DBUS_INTERFACE_SERVER)

235

487

self.server.connect_to_signal("StateChanged",

236

self.server_state_changed)

488

self.server_state_changed)

237

489

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

238

490

239

491

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

240

766

class Client(object):

241

767

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

242

768

243

769

Attributes:

244

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

770

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

245

771

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

246

772

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

247

773

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

248

774

to see if the client lives.

249

775

'None' if no process is running.

250

checker_callback_tag: a gobject event source tag, or None

776

checker_callback_tag: a GLib event source tag, or None

251

777

checker_command: string; External command which is run to check

252

778

if client lives. %() expansions are done at

253

779

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

254

780

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

255

checker_initiator_tag: a gobject event source tag, or None

781

checker_initiator_tag: a GLib event source tag, or None

256

782

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

257

785

current_checker_command: string; current running checker_command

258

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

259

disable_initiator_tag: a gobject event source tag, or None

786

disable_initiator_tag: a GLib event source tag, or None

260

787

enabled: bool()

261

788

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

262

789

uniquely identify the client

264

791

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

265

792

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

266

793

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

267

last_enabled: datetime.datetime(); (UTC)

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

268

800

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

269

801

D-Bus identifiers

270

802

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

271

803

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

272

804

until this client is disabled

805

extended_timeout: extra long timeout when secret has been sent

273

806

runtime_expansions: Allowed attributes for runtime expansion.

807

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

808

disabled, or None

809

server_settings: The server_settings dict from main()

274

810

"""

275

811

276

812

runtime_expansions = ("approval_delay", "approval_duration",

277

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

278

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

813

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

814

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

815

"last_approval_request", "last_checked_ok",

279

816

"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

}

280

828

281

829

@staticmethod

282

def _timedelta_to_milliseconds(td):

283

"Convert a datetime.timedelta() to milliseconds"

284

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

285

+ (td.seconds * 1000)

286

+ (td.microseconds // 1000))

287

288

def timeout_milliseconds(self):

289

"Return the 'timeout' attribute in milliseconds"

290

return self._timedelta_to_milliseconds(self.timeout)

291

292

def interval_milliseconds(self):

293

"Return the 'interval' attribute in milliseconds"

294

return self._timedelta_to_milliseconds(self.interval)

295

296

def approval_delay_milliseconds(self):

297

return self._timedelta_to_milliseconds(self.approval_delay)

298

299

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

300

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

301

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

302

attribute."""

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

303

882

self.name = name

304

if config is None:

305

config = {}

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

306

900

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

307

# Uppercase and remove spaces from fingerprint for later

308

# comparison purposes with return value from the fingerprint()

309

# function

310

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

311

.replace(" ", ""))

312

901

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

313

if "secret" in config:

314

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

315

elif "secfile" in config:

316

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

317

(config["secfile"])),

318

"rb") as secfile:

319

self.secret = secfile.read()

320

else:

321

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

322

% self.name)

323

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

324

self.created = datetime.datetime.utcnow()

325

self.enabled = False

326

self.last_approval_request = None

327

self.last_enabled = None

328

self.last_checked_ok = None

329

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

330

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

331

self.disable_hook = disable_hook

902

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

903

datetime.datetime.utcnow())

904

905

# attributes specific for this server instance

332

906

self.checker = None

333

907

self.checker_initiator_tag = None

334

908

self.disable_initiator_tag = None

335

909

self.checker_callback_tag = None

336

self.checker_command = config["checker"]

337

910

self.current_checker_command = None

338

self.last_connect = None

339

self._approved = None

340

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

341

True)

911

self.approved = None

342

912

self.approvals_pending = 0

343

self.approval_delay = string_to_delta(

344

config["approval_delay"])

345

self.approval_duration = string_to_delta(

346

config["approval_duration"])

347

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

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)

348

924

925

# Send notice to process children that client state has changed

349

926

def send_changedstate(self):

350

self.changedstate.acquire()

351

self.changedstate.notify_all()

352

self.changedstate.release()

353

927

with self.changedstate:

928

self.changedstate.notify_all()

929

354

930

def enable(self):

355

931

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

356

932

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

357

933

# Already enabled

358

934

return

359

self.send_changedstate()

935

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

936

self.enabled = True

360

937

self.last_enabled = datetime.datetime.utcnow()

361

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

362

# and every interval from then on.

363

self.checker_initiator_tag = (gobject.timeout_add

364

(self.interval_milliseconds(),

365

self.start_checker))

366

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

367

self.disable_initiator_tag = (gobject.timeout_add

368

(self.timeout_milliseconds(),

369

self.disable))

370

self.enabled = True

371

# Also start a new checker *right now*.

372

self.start_checker()

938

self.init_checker()

939

self.send_changedstate()

373

940

374

941

def disable(self, quiet=True):

375

942

"""Disable this client."""

376

943

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

377

944

return False

378

945

if not quiet:

379

self.send_changedstate()

380

if not quiet:

381

946

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

382

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

383

gobject.source_remove(self.disable_initiator_tag)

947

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

948

GLib.source_remove(self.disable_initiator_tag)

384

949

self.disable_initiator_tag = None

385

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

386

gobject.source_remove(self.checker_initiator_tag)

950

self.expires = None

951

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

952

GLib.source_remove(self.checker_initiator_tag)

387

953

self.checker_initiator_tag = None

388

954

self.stop_checker()

389

if self.disable_hook:

390

self.disable_hook(self)

391

955

self.enabled = False

392

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

956

if not quiet:

957

self.send_changedstate()

958

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

393

959

return False

394

960

395

961

def __del__(self):

396

self.disable_hook = None

397

962

self.disable()

398

963

399

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

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

400

982

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

401

983

self.checker_callback_tag = None

402

984

self.checker = None

403

if os.WIFEXITED(condition):

404

exitstatus = os.WEXITSTATUS(condition)

405

if exitstatus == 0:

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:

406

993

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

407

994

vars(self))

408

995

self.checked_ok()

409

996

else:

410

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

411

vars(self))

997

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

412

998

else:

999

self.last_checker_status = -1

1000

self.last_checker_signal = -returncode

413

1001

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

414

1002

vars(self))

1003

return False

415

1004

416

1005

def checked_ok(self):

417

"""Bump up the timeout for this client.

418

419

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

420

alive and well.

421

"""

1006

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

422

1007

self.last_checked_ok = datetime.datetime.utcnow()

423

gobject.source_remove(self.disable_initiator_tag)

424

self.disable_initiator_tag = (gobject.timeout_add

425

(self.timeout_milliseconds(),

426

self.disable))

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

1014

if timeout is None:

1015

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

427

1023

428

1024

def need_approval(self):

429

1025

self.last_approval_request = datetime.datetime.utcnow()

434

1030

If a checker already exists, leave it running and do

435

1031

nothing."""

436

1032

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

437

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

438

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

439

# client would inevitably timeout, since no checker would get

440

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

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

441

1037

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

442

1038

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

443

1039

# should be.

444

1040

445

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

446

try:

447

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

448

except (AttributeError, OSError), error:

449

if (isinstance(error, OSError)

450

and error.errno != errno.ECHILD):

451

raise error

452

else:

453

if pid:

454

logger.warning("Checker was a zombie")

455

gobject.source_remove(self.checker_callback_tag)

456

self.checker_callback(pid, status,

457

self.current_checker_command)

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

458

1045

# Start a new checker if needed

459

1046

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 }

460

1051

try:

461

# In case checker_command has exactly one % operator

462

command = self.checker_command % self.host

463

except TypeError:

464

# Escape attributes for the shell

465

escaped_attrs = dict(

466

(attr,

467

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

468

errors=

469

'replace')))

470

for attr in

471

self.runtime_expansions)

472

473

try:

474

command = self.checker_command % escaped_attrs

475

except TypeError, error:

476

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

477

' %s', self.checker_command, error)

478

return True # Try again later

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

479

1058

self.current_checker_command = command

480

try:

481

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

482

command, self.name)

483

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

484

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

485

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

486

# always replaced by /dev/null.)

487

self.checker = subprocess.Popen(command,

488

close_fds=True,

489

shell=True, cwd="/")

490

self.checker_callback_tag = (gobject.child_watch_add

491

(self.checker.pid,

492

self.checker_callback,

493

data=command))

494

# The checker may have completed before the gobject

495

# watch was added. Check for this.

496

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

497

if pid:

498

gobject.source_remove(self.checker_callback_tag)

499

self.checker_callback(pid, status, command)

500

except OSError, error:

501

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

502

error)

503

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

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

504

1085

return True

505

1086

506

1087

def stop_checker(self):

507

1088

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

508

1089

if self.checker_callback_tag:

509

gobject.source_remove(self.checker_callback_tag)

1090

GLib.source_remove(self.checker_callback_tag)

510

1091

self.checker_callback_tag = None

511

1092

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

512

1093

return

513

1094

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

514

try:

515

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

516

#time.sleep(0.5)

517

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

518

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

519

except OSError, error:

520

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

521

raise

1095

self.checker.terminate()

522

1096

self.checker = None

523

1097

524

def dbus_service_property(dbus_interface, signature="v",

525

access="readwrite", byte_arrays=False):

1098

1099

def dbus_service_property(dbus_interface,

1100

signature="v",

1101

access="readwrite",

1102

byte_arrays=False):

526

1103

"""Decorators for marking methods of a DBusObjectWithProperties to

527

1104

become properties on the D-Bus.

528

1105

537

1114

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

538

1115

if byte_arrays and signature != "ay":

539

1116

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

540

" signature %r" % signature)

1117

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

1118

541

1119

def decorator(func):

542

1120

func._dbus_is_property = True

543

1121

func._dbus_interface = dbus_interface

548

1126

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

549

1127

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

550

1128

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

551

1173

return decorator

552

1174

553

1175

554

1176

class DBusPropertyException(dbus.exceptions.DBusException):

555

1177

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

556

1178

"""

557

def __unicode__(self):

558

return unicode(str(self))

1179

pass

559

1180

560

1181

561

1182

class DBusPropertyAccessException(DBusPropertyException):

570

1191

pass

571

1192

572

1193

573

class DBusObjectWithProperties(dbus.service.Object):

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

574

1284

"""A D-Bus object with properties.

575

1285

576

1286

Classes inheriting from this can use the dbus_service_property

577

1287

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

578

1288

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

579

1289

"""

580

1290

581

@staticmethod

582

def _is_dbus_property(obj):

583

return getattr(obj, "_dbus_is_property", False)

584

585

def _get_all_dbus_properties(self):

586

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

587

"""

588

return ((prop._dbus_name, prop)

589

for name, prop in

590

inspect.getmembers(self, self._is_dbus_property))

591

592

1291

def _get_dbus_property(self, interface_name, property_name):

593

1292

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

594

1293

property with the specified name and interface.

595

1294

"""

596

for name in (property_name,

597

property_name + "_dbus_property"):

598

prop = getattr(self, name, None)

599

if (prop is None

600

or not self._is_dbus_property(prop)

601

or prop._dbus_name != property_name

602

or (interface_name and prop._dbus_interface

603

and interface_name != prop._dbus_interface)):

604

continue

605

return prop

1295

for cls in self.__class__.__mro__:

1296

for name, value in inspect.getmembers(

1297

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

1298

if (value._dbus_name == property_name

1299

and value._dbus_interface == interface_name):

1300

return value.__get__(self)

1301

606

1302

# No such property

607

raise DBusPropertyNotFound(self.dbus_object_path + ":"

608

+ interface_name + "."

609

+ property_name)

610

611

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

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

612

1317

out_signature="v")

613

1318

def Get(self, interface_name, property_name):

614

1319

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

632

1337

# The byte_arrays option is not supported yet on

633

1338

# signatures other than "ay".

634

1339

if prop._dbus_signature != "ay":

635

raise ValueError

636

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

637

for byte in value))

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

638

1345

prop(value)

639

1346

640

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

1347

@dbus.service.method(dbus.PROPERTIES_IFACE,

1348

in_signature="s",

641

1349

out_signature="a{sv}")

642

1350

def GetAll(self, interface_name):

643

1351

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

644

1352

standard.

645

1353

646

1354

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

647

1355

"""

648

all = {}

649

for name, prop in self._get_all_dbus_properties():

1356

properties = {}

1357

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

650

1358

if (interface_name

651

1359

and interface_name != prop._dbus_interface):

652

1360

# Interface non-empty but did not match

656

1364

continue

657

1365

value = prop()

658

1366

if not hasattr(value, "variant_level"):

659

all[name] = value

1367

properties[name] = value

660

1368

continue

661

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

662

value.variant_level+1)

663

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

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

664

1380

665

1381

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

666

1382

out_signature="s",

667

1383

path_keyword='object_path',

668

1384

connection_keyword='connection')

669

1385

def Introspect(self, object_path, connection):

670

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

1386

"""Overloading of standard D-Bus method.

1387

1388

Inserts property tags and interface annotation tags.

671

1389

"""

672

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

673

connection)

1390

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1391

object_path,

1392

connection)

674

1393

try:

675

1394

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

1395

676

1396

def make_tag(document, name, prop):

677

1397

e = document.createElement("property")

678

1398

e.setAttribute("name", name)

679

1399

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

680

1400

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

681

1401

return e

1402

682

1403

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

1404

# Add property tags

683

1405

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

684

1406

for name, prop

685

in self._get_all_dbus_properties()

1407

in self._get_all_dbus_things("property")

686

1408

if prop._dbus_interface

687

1409

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

688

1410

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)

689

1427

# Add the names to the return values for the

690

1428

# "org.freedesktop.DBus.Properties" methods

691

1429

if (if_tag.getAttribute("name")

704

1442

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

705

1443

document.unlink()

706

1444

except (AttributeError, xml.dom.DOMException,

707

xml.parsers.expat.ExpatError), error:

708

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

709

error)

710

return xmlstring

711

712

1445

xml.parsers.expat.ExpatError) as error:

1446

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

1520

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

1521

if dt is None:

1522

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

1548

"""

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

1557

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

1558

# with the wrong interface name

1559

if (not hasattr(attribute, "_dbus_interface")

1560

or not attribute._dbus_interface.startswith(

1561

orig_interface_name)):

1562

continue

1563

# Create an alternate D-Bus interface name based on

1564

# the current name

1565

alt_interface = attribute._dbus_interface.replace(

1566

orig_interface_name, alt_interface_name)

1567

interface_names.add(alt_interface)

1568

# Is this a D-Bus signal?

1569

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(

1574

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)

1582

# Create a new, but exactly alike, function

1583

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

1584

# 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

1595

# 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

1599

def fixscope(func1, func2):

1600

"""This function is a scope container to pass

1601

func1 and func2 to the "call_both" function

1602

outside of its arguments"""

1603

1604

@functools.wraps(func2)

1605

def call_both(*args, **kwargs):

1606

"""This function will emit two D-Bus

1607

signals by calling func1 and func2"""

1608

func1(*args, **kwargs)

1609

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

return call_both

1616

# Create the "call_both" function and add it to

1617

# the class

1618

attr[attrname] = fixscope(attribute, new_function)

1619

# Is this a D-Bus method?

1620

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

1621

# Create a new, but exactly alike, function

1622

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

1623

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

1624

# 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

1637

# Is this a D-Bus property?

1638

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

1639

# Create a new, but exactly alike, function

1640

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

1641

# property with the alternate D-Bus interface

1642

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

713

1695

class ClientDBus(Client, DBusObjectWithProperties):

714

1696

"""A Client class using D-Bus

715

1697

719

1701

"""

720

1702

721

1703

runtime_expansions = (Client.runtime_expansions

722

+ ("dbus_object_path",))

1704

+ ("dbus_object_path", ))

1705

1706

_interface = "se.recompile.Mandos.Client"

723

1707

724

1708

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

725

1709

726

1710

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

727

self._approvals_pending = 0

728

1711

self.bus = bus

729

1712

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

730

1713

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

731

1714

# the D-Bus

732

client_object_name = unicode(self.name).translate(

1715

client_object_name = str(self.name).translate(

733

1716

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

734

1717

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

735

self.dbus_object_path = (dbus.ObjectPath

736

("/clients/" + client_object_name))

1718

self.dbus_object_path = dbus.ObjectPath(

1719

"/clients/" + client_object_name)

737

1720

DBusObjectWithProperties.__init__(self, self.bus,

738

1721

self.dbus_object_path)

739

740

def _get_approvals_pending(self):

741

return self._approvals_pending

742

def _set_approvals_pending(self, value):

743

old_value = self._approvals_pending

744

self._approvals_pending = value

745

bval = bool(value)

746

if (hasattr(self, "dbus_object_path")

747

and bval is not bool(old_value)):

748

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

749

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

750

dbus_bool)

751

752

approvals_pending = property(_get_approvals_pending,

753

_set_approvals_pending)

754

del _get_approvals_pending, _set_approvals_pending

755

756

@staticmethod

757

def _datetime_to_dbus(dt, variant_level=0):

758

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

759

return dbus.String(dt.isoformat(),

760

variant_level=variant_level)

761

762

def enable(self):

763

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

764

r = Client.enable(self)

765

if oldstate != self.enabled:

766

# Emit D-Bus signals

767

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

768

dbus.Boolean(True, variant_level=1))

769

self.PropertyChanged(

770

dbus.String("LastEnabled"),

771

self._datetime_to_dbus(self.last_enabled,

772

variant_level=1))

773

return r

774

775

def disable(self, quiet = False):

776

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

777

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

778

if not quiet and oldstate != self.enabled:

779

# Emit D-Bus signal

780

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

781

dbus.Boolean(False, variant_level=1))

782

return r

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

1728

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

1729

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.

1733

dbus_name: D-Bus name of the variable

1734

type_func: Function that transform the value before sending it

1735

to the D-Bus. Default: no transform

1736

variant_level: D-Bus variant level. Default: 1

1737

"""

1738

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

1739

1740

def setter(self, value):

1741

if hasattr(self, "dbus_object_path"):

1742

if (not hasattr(self, attrname) or

1743

type_func(getattr(self, attrname, None))

1744

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

1760

setattr(self, attrname, value)

1761

1762

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

1763

1764

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1765

approvals_pending = notifychangeproperty(dbus.Boolean,

1766

"ApprovalPending",

1767

type_func = bool)

1768

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

1769

last_enabled = notifychangeproperty(datetime_to_dbus,

1770

"LastEnabled")

1771

checker = notifychangeproperty(

1772

dbus.Boolean, "CheckerRunning",

1773

type_func = lambda checker: checker is not None)

1774

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1775

"LastCheckedOK")

1776

last_checker_status = notifychangeproperty(dbus.Int16,

1777

"LastCheckerStatus")

1778

last_approval_request = notifychangeproperty(

1779

datetime_to_dbus, "LastApprovalRequest")

1780

approved_by_default = notifychangeproperty(dbus.Boolean,

1781

"ApprovedByDefault")

1782

approval_delay = notifychangeproperty(

1783

dbus.UInt64, "ApprovalDelay",

1784

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

1785

approval_duration = notifychangeproperty(

1786

dbus.UInt64, "ApprovalDuration",

1787

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

1788

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

1789

timeout = notifychangeproperty(

1790

dbus.UInt64, "Timeout",

1791

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

1792

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)

1798

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

1799

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

1800

invalidate_only=True)

1801

1802

del notifychangeproperty

783

1803

784

1804

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

785

1805

try:

790

1810

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

791

1811

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

792

1812

793

def checker_callback(self, pid, condition, command,

794

*args, **kwargs):

795

self.checker_callback_tag = None

796

self.checker = None

797

# Emit D-Bus signal

798

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

799

dbus.Boolean(False, variant_level=1))

800

if os.WIFEXITED(condition):

801

exitstatus = os.WEXITSTATUS(condition)

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:

802

1820

# Emit D-Bus signal

803

1821

self.CheckerCompleted(dbus.Int16(exitstatus),

804

dbus.Int64(condition),

1822

# This is specific to GNU libC

1823

dbus.Int64(exitstatus << 8),

805

1824

dbus.String(command))

806

1825

else:

807

1826

# Emit D-Bus signal

808

1827

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

809

dbus.Int64(condition),

1828

dbus.Int64(

1829

# This is specific to GNU libC

1830

(exitstatus << 8)

1831

| self.last_checker_signal),

810

1832

dbus.String(command))

811

812

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

813

*args, **kwargs)

814

815

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

816

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

817

# Emit D-Bus signal

818

self.PropertyChanged(

819

dbus.String("LastCheckedOK"),

820

(self._datetime_to_dbus(self.last_checked_ok,

821

variant_level=1)))

822

return r

823

824

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

825

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

826

# Emit D-Bus signal

827

self.PropertyChanged(

828

dbus.String("LastApprovalRequest"),

829

(self._datetime_to_dbus(self.last_approval_request,

830

variant_level=1)))

831

return r

1833

return ret

832

1834

833

1835

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

834

old_checker = self.checker

835

if self.checker is not None:

836

old_checker_pid = self.checker.pid

837

else:

838

old_checker_pid = None

1836

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

839

1837

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

840

1838

# Only if new checker process was started

841

1839

if (self.checker is not None

842

1840

and old_checker_pid != self.checker.pid):

843

1841

# Emit D-Bus signal

844

1842

self.CheckerStarted(self.current_checker_command)

845

self.PropertyChanged(

846

dbus.String("CheckerRunning"),

847

dbus.Boolean(True, variant_level=1))

848

1843

return r

849

1844

850

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

851

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

852

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

853

if (old_checker is not None

854

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

855

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

856

dbus.Boolean(False, variant_level=1))

857

return r

858

859

1845

def _reset_approved(self):

860

self._approved = None

1846

self.approved = None

861

1847

return False

862

1848

863

1849

def approve(self, value=True):

1850

self.approved = value

1851

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

1852

* 1000), self._reset_approved)

864

1853

self.send_changedstate()

865

self._approved = value

866

gobject.timeout_add(self._timedelta_to_milliseconds

867

(self.approval_duration),

868

self._reset_approved)

869

870

1854

871

1855

## D-Bus methods, signals & properties

872

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

1856

1857

## Interfaces

873

1858

874

1859

## Signals

875

1860

886

1871

pass

887

1872

888

1873

# PropertyChanged - signal

1874

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

889

1875

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

890

1876

def PropertyChanged(self, property, value):

891

1877

"D-Bus signal"

922

1908

# CheckedOK - method

923

1909

@dbus.service.method(_interface)

924

1910

def CheckedOK(self):

925

return self.checked_ok()

1911

self.checked_ok()

926

1912

927

1913

# Enable - method

1914

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

928

1915

@dbus.service.method(_interface)

929

1916

def Enable(self):

930

1917

"D-Bus method"

931

1918

self.enable()

932

1919

933

1920

# StartChecker - method

1921

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

934

1922

@dbus.service.method(_interface)

935

1923

def StartChecker(self):

936

1924

"D-Bus method"

937

1925

self.start_checker()

938

1926

939

1927

# Disable - method

1928

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

940

1929

@dbus.service.method(_interface)

941

1930

def Disable(self):

942

1931

"D-Bus method"

943

1932

self.disable()

944

1933

945

1934

# StopChecker - method

1935

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

946

1936

@dbus.service.method(_interface)

947

1937

def StopChecker(self):

948

1938

self.stop_checker()

955

1945

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

956

1946

957

1947

# ApprovedByDefault - property

958

@dbus_service_property(_interface, signature="b",

1948

@dbus_service_property(_interface,

1949

signature="b",

959

1950

access="readwrite")

960

1951

def ApprovedByDefault_dbus_property(self, value=None):

961

1952

if value is None: # get

962

1953

return dbus.Boolean(self.approved_by_default)

963

1954

self.approved_by_default = bool(value)

964

# Emit D-Bus signal

965

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

966

dbus.Boolean(value, variant_level=1))

967

1955

968

1956

# ApprovalDelay - property

969

@dbus_service_property(_interface, signature="t",

1957

@dbus_service_property(_interface,

1958

signature="t",

970

1959

access="readwrite")

971

1960

def ApprovalDelay_dbus_property(self, value=None):

972

1961

if value is None: # get

973

return dbus.UInt64(self.approval_delay_milliseconds())

1962

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

1963

* 1000)

974

1964

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

975

# Emit D-Bus signal

976

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

977

dbus.UInt64(value, variant_level=1))

978

1965

979

1966

# ApprovalDuration - property

980

@dbus_service_property(_interface, signature="t",

1967

@dbus_service_property(_interface,

1968

signature="t",

981

1969

access="readwrite")

982

1970

def ApprovalDuration_dbus_property(self, value=None):

983

1971

if value is None: # get

984

return dbus.UInt64(self._timedelta_to_milliseconds(

985

self.approval_duration))

1972

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

1973

* 1000)

986

1974

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

987

# Emit D-Bus signal

988

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

989

dbus.UInt64(value, variant_level=1))

990

1975

991

1976

# Name - property

1977

@dbus_annotations(

1978

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

992

1979

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

993

1980

def Name_dbus_property(self):

994

1981

return dbus.String(self.name)

995

1982

996

1983

# Fingerprint - property

1984

@dbus_annotations(

1985

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

997

1986

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

998

1987

def Fingerprint_dbus_property(self):

999

1988

return dbus.String(self.fingerprint)

1000

1989

1001

1990

# Host - property

1002

@dbus_service_property(_interface, signature="s",

1991

@dbus_service_property(_interface,

1992

signature="s",

1003

1993

access="readwrite")

1004

1994

def Host_dbus_property(self, value=None):

1005

1995

if value is None: # get

1006

1996

return dbus.String(self.host)

1007

self.host = value

1008

# Emit D-Bus signal

1009

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

1010

dbus.String(value, variant_level=1))

1997

self.host = str(value)

1011

1998

1012

1999

# Created - property

2000

@dbus_annotations(

2001

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

1013

2002

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

1014

2003

def Created_dbus_property(self):

1015

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

2004

return datetime_to_dbus(self.created)

1016

2005

1017

2006

# LastEnabled - property

1018

2007

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

1019

2008

def LastEnabled_dbus_property(self):

1020

if self.last_enabled is None:

1021

return dbus.String("")

1022

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

2009

return datetime_to_dbus(self.last_enabled)

1023

2010

1024

2011

# Enabled - property

1025

@dbus_service_property(_interface, signature="b",

2012

@dbus_service_property(_interface,

2013

signature="b",

1026

2014

access="readwrite")

1027

2015

def Enabled_dbus_property(self, value=None):

1028

2016

if value is None: # get

1033

2021

self.disable()

1034

2022

1035

2023

# LastCheckedOK - property

1036

@dbus_service_property(_interface, signature="s",

2024

@dbus_service_property(_interface,

2025

signature="s",

1037

2026

access="readwrite")

1038

2027

def LastCheckedOK_dbus_property(self, value=None):

1039

2028

if value is not None:

1040

2029

self.checked_ok()

1041

2030

return

1042

if self.last_checked_ok is None:

1043

return dbus.String("")

1044

return dbus.String(self._datetime_to_dbus(self

1045

.last_checked_ok))

2031

return datetime_to_dbus(self.last_checked_ok)

2032

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

# Expires - property

2039

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

2040

def Expires_dbus_property(self):

2041

return datetime_to_dbus(self.expires)

1046

2042

1047

2043

# LastApprovalRequest - property

1048

2044

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

1049

2045

def LastApprovalRequest_dbus_property(self):

1050

if self.last_approval_request is None:

1051

return dbus.String("")

1052

return dbus.String(self.

1053

_datetime_to_dbus(self

1054

.last_approval_request))

2046

return datetime_to_dbus(self.last_approval_request)

1055

2047

1056

2048

# Timeout - property

1057

@dbus_service_property(_interface, signature="t",

2049

@dbus_service_property(_interface,

2050

signature="t",

1058

2051

access="readwrite")

1059

2052

def Timeout_dbus_property(self, value=None):

1060

2053

if value is None: # get

1061

return dbus.UInt64(self.timeout_milliseconds())

2054

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

2055

old_timeout = self.timeout

1062

2056

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

1063

# Emit D-Bus signal

1064

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

1065

dbus.UInt64(value, variant_level=1))

1066

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

1067

return

1068

# Reschedule timeout

1069

gobject.source_remove(self.disable_initiator_tag)

1070

self.disable_initiator_tag = None

1071

time_to_die = (self.

1072

_timedelta_to_milliseconds((self

1073

.last_checked_ok

1074

+ self.timeout)

1075

- datetime.datetime

1076

.utcnow()))

1077

if time_to_die <= 0:

1078

# The timeout has passed

1079

self.disable()

1080

else:

1081

self.disable_initiator_tag = (gobject.timeout_add

1082

(time_to_die, self.disable))

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)

2072

2073

# ExtendedTimeout - property

2074

@dbus_service_property(_interface,

2075

signature="t",

2076

access="readwrite")

2077

def ExtendedTimeout_dbus_property(self, value=None):

2078

if value is None: # get

2079

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

2080

* 1000)

2081

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

1083

2082

1084

2083

# Interval - property

1085

@dbus_service_property(_interface, signature="t",

2084

@dbus_service_property(_interface,

2085

signature="t",

1086

2086

access="readwrite")

1087

2087

def Interval_dbus_property(self, value=None):

1088

2088

if value is None: # get

1089

return dbus.UInt64(self.interval_milliseconds())

2089

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

1090

2090

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

1091

# Emit D-Bus signal

1092

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

1093

dbus.UInt64(value, variant_level=1))

1094

2091

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

1095

2092

return

1096

# Reschedule checker run

1097

gobject.source_remove(self.checker_initiator_tag)

1098

self.checker_initiator_tag = (gobject.timeout_add

1099

(value, self.start_checker))

1100

self.start_checker() # Start one now, too

1101

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

2099

1102

2100

# Checker - property

1103

@dbus_service_property(_interface, signature="s",

2101

@dbus_service_property(_interface,

2102

signature="s",

1104

2103

access="readwrite")

1105

2104

def Checker_dbus_property(self, value=None):

1106

2105

if value is None: # get

1107

2106

return dbus.String(self.checker_command)

1108

self.checker_command = value

1109

# Emit D-Bus signal

1110

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

1111

dbus.String(self.checker_command,

1112

variant_level=1))

2107

self.checker_command = str(value)

1113

2108

1114

2109

# CheckerRunning - property

1115

@dbus_service_property(_interface, signature="b",

2110

@dbus_service_property(_interface,

2111

signature="b",

1116

2112

access="readwrite")

1117

2113

def CheckerRunning_dbus_property(self, value=None):

1118

2114

if value is None: # get

1123

2119

self.stop_checker()

1124

2120

1125

2121

# ObjectPath - property

2122

@dbus_annotations(

2123

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

2124

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

1126

2125

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

1127

2126

def ObjectPath_dbus_property(self):

1128

2127

return self.dbus_object_path # is already a dbus.ObjectPath

1129

2128

1130

2129

# Secret = property

1131

@dbus_service_property(_interface, signature="ay",

1132

access="write", byte_arrays=True)

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)

1133

2137

def Secret_dbus_property(self, value):

1134

self.secret = str(value)

2138

self.secret = bytes(value)

1135

2139

1136

2140

del _interface

1137

2141

1141

2145

self._pipe = child_pipe

1142

2146

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

1143

2147

if not self._pipe.recv():

1144

raise KeyError()

1145

2148

raise KeyError(fpr)

2149

1146

2150

def __getattribute__(self, name):

1147

if(name == '_pipe'):

2151

if name == '_pipe':

1148

2152

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

1149

2153

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

1150

2154

data = self._pipe.recv()

1151

2155

if data[0] == 'data':

1152

2156

return data[1]

1153

2157

if data[0] == 'function':

2158

1154

2159

def func(*args, **kwargs):

1155

2160

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

1156

2161

return self._pipe.recv()[1]

2162

1157

2163

return func

1158

2164

1159

2165

def __setattr__(self, name, value):

1160

if(name == '_pipe'):

2166

if name == '_pipe':

1161

2167

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

1162

2168

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

1163

2169

1171

2177

def handle(self):

1172

2178

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

1173

2179

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

1174

unicode(self.client_address))

2180

str(self.client_address))

1175

2181

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

1176

2182

self.server.child_pipe.fileno())

1177

1178

session = (gnutls.connection

1179

.ClientSession(self.request,

1180

gnutls.connection

1181

.X509Credentials()))

1182

1183

# Note: gnutls.connection.X509Credentials is really a

1184

# generic GnuTLS certificate credentials object so long as

1185

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

1186

# here despite using OpenPGP certificates.

1187

2183

2184

session = gnutls.ClientSession(self.request)

2185

1188

2186

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

1189

2187

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

1190

2188

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

1193

2191

priority = self.server.gnutls_priority

1194

2192

if priority is None:

1195

2193

priority = "NORMAL"

1196

(gnutls.library.functions

1197

.gnutls_priority_set_direct(session._c_object,

1198

priority, None))

1199

2194

gnutls.priority_set_direct(session._c_object,

2195

priority.encode("utf-8"),

2196

None)

2197

1200

2198

# Start communication using the Mandos protocol

1201

2199

# Get protocol number

1202

2200

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

1203

2201

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

1204

2202

try:

1205

2203

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

1206

raise RuntimeError

1207

except (ValueError, IndexError, RuntimeError), error:

2204

raise RuntimeError(line)

2205

except (ValueError, IndexError, RuntimeError) as error:

1208

2206

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

1209

2207

return

1210

2208

1211

2209

# Start GnuTLS connection

1212

2210

try:

1213

2211

session.handshake()

1214

except gnutls.errors.GNUTLSError, error:

2212

except gnutls.Error as error:

1215

2213

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

1216

2214

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

1217

2215

# established. Just abandon the request.

1218

2216

return

1219

2217

logger.debug("Handshake succeeded")

1220

2218

1221

2219

approval_required = False

1222

2220

try:

1223

2221

try:

1224

fpr = self.fingerprint(self.peer_certificate

1225

(session))

1226

except (TypeError, gnutls.errors.GNUTLSError), error:

2222

fpr = self.fingerprint(

2223

self.peer_certificate(session))

2224

except (TypeError, gnutls.Error) as error:

1227

2225

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

1228

2226

return

1229

2227

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

1230

2228

1231

2229

try:

1232

2230

client = ProxyClient(child_pipe, fpr,

1233

2231

self.client_address)

1241

2239

1242

2240

while True:

1243

2241

if not client.enabled:

1244

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

1245

client.name)

2242

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

2243

client.name)

1246

2244

if self.server.use_dbus:

1247

2245

# Emit D-Bus signal

1248

client.Rejected("Disabled")

2246

client.Rejected("Disabled")

1249

2247

return

1250

2248

1251

if client._approved or not client.approval_delay:

2249

if client.approved or not client.approval_delay:

1252

2250

#We are approved or approval is disabled

1253

2251

break

1254

elif client._approved is None:

2252

elif client.approved is None:

1255

2253

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

1256

2254

client.name)

1257

2255

if self.server.use_dbus:

1258

2256

# Emit D-Bus signal

1259

2257

client.NeedApproval(

1260

client.approval_delay_milliseconds(),

1261

client.approved_by_default)

2258

client.approval_delay.total_seconds()

2259

* 1000, client.approved_by_default)

1262

2260

else:

1263

2261

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

1264

2262

client.name)

1268

2266

return

1269

2267

1270

2268

#wait until timeout or approved

1271

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

1272

2269

time = datetime.datetime.now()

1273

2270

client.changedstate.acquire()

1274

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

2271

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

1275

2272

client.changedstate.release()

1276

2273

time2 = datetime.datetime.now()

1277

2274

if (time2 - time) >= delay:

1288

2285

else:

1289

2286

delay -= time2 - time

1290

2287

1291

sent_size = 0

1292

while sent_size < len(client.secret):

1293

try:

1294

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

1295

except (gnutls.errors.GNUTLSError), error:

1296

logger.warning("gnutls send failed")

1297

return

1298

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

1299

sent, len(client.secret)

1300

- (sent_size + sent))

1301

sent_size += sent

1302

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

2294

1303

2295

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

1304

# bump the timeout as if seen

1305

client.checked_ok()

2296

# bump the timeout using extended_timeout

2297

client.bump_timeout(client.extended_timeout)

1306

2298

if self.server.use_dbus:

1307

2299

# Emit D-Bus signal

1308

2300

client.GotSecret()

1312

2304

client.approvals_pending -= 1

1313

2305

try:

1314

2306

session.bye()

1315

except (gnutls.errors.GNUTLSError), error:

1316

logger.warning("GnuTLS bye failed")

2307

except gnutls.Error as error:

2308

logger.warning("GnuTLS bye failed",

2309

exc_info=error)

1317

2310

1318

2311

@staticmethod

1319

2312

def peer_certificate(session):

1320

2313

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

1321

2314

# If not an OpenPGP certificate...

1322

if (gnutls.library.functions

1323

.gnutls_certificate_type_get(session._c_object)

1324

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1325

# ...do the normal thing

1326

return session.peer_certificate

2315

if (gnutls.certificate_type_get(session._c_object)

2316

!= gnutls.CRT_OPENPGP):

2317

# ...return invalid data

2318

return b""

1327

2319

list_size = ctypes.c_uint(1)

1328

cert_list = (gnutls.library.functions

1329

.gnutls_certificate_get_peers

2320

cert_list = (gnutls.certificate_get_peers

1330

2321

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

1331

2322

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

1332

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

1333

" certificate")

2323

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

1334

2324

if list_size.value == 0:

1335

2325

return None

1336

2326

cert = cert_list[0]

1340

2330

def fingerprint(openpgp):

1341

2331

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1342

2332

# New GnuTLS "datum" with the OpenPGP public key

1343

datum = (gnutls.library.types

1344

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

1345

ctypes.POINTER

1346

(ctypes.c_ubyte)),

1347

ctypes.c_uint(len(openpgp))))

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

1348

2337

# New empty GnuTLS certificate

1349

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1350

(gnutls.library.functions

1351

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2338

crt = gnutls.openpgp_crt_t()

2339

gnutls.openpgp_crt_init(ctypes.byref(crt))

1352

2340

# Import the OpenPGP public key into the certificate

1353

(gnutls.library.functions

1354

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

1355

gnutls.library.constants

1356

.GNUTLS_OPENPGP_FMT_RAW))

2341

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

2342

gnutls.OPENPGP_FMT_RAW)

1357

2343

# Verify the self signature in the key

1358

2344

crtverify = ctypes.c_uint()

1359

(gnutls.library.functions

1360

.gnutls_openpgp_crt_verify_self(crt, 0,

1361

ctypes.byref(crtverify)))

2345

gnutls.openpgp_crt_verify_self(crt, 0,

2346

ctypes.byref(crtverify))

1362

2347

if crtverify.value != 0:

1363

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1364

raise (gnutls.errors.CertificateSecurityError

1365

("Verify failed"))

2348

gnutls.openpgp_crt_deinit(crt)

2349

raise gnutls.CertificateSecurityError("Verify failed")

1366

2350

# New buffer for the fingerprint

1367

2351

buf = ctypes.create_string_buffer(20)

1368

2352

buf_len = ctypes.c_size_t()

1369

2353

# Get the fingerprint from the certificate into the buffer

1370

(gnutls.library.functions

1371

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

1372

ctypes.byref(buf_len)))

2354

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

2355

ctypes.byref(buf_len))

1373

2356

# Deinit the certificate

1374

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2357

gnutls.openpgp_crt_deinit(crt)

1375

2358

# Convert the buffer to a Python bytestring

1376

2359

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

1377

2360

# Convert the bytestring to hexadecimal notation

1378

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

2361

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

1379

2362

return hex_fpr

1380

2363

1381

2364

1382

2365

class MultiprocessingMixIn(object):

1383

2366

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

2367

1384

2368

def sub_process_main(self, request, address):

1385

2369

try:

1386

2370

self.finish_request(request, address)

1387

except:

2371

except Exception:

1388

2372

self.handle_error(request, address)

1389

2373

self.close_request(request)

1390

2374

1391

2375

def process_request(self, request, address):

1392

2376

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

1393

multiprocessing.Process(target = self.sub_process_main,

1394

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

2377

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

2378

args = (request, address))

2379

proc.start()

2380

return proc

2381

1395

2382

1396

2383

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1397

2384

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

2385

1398

2386

def process_request(self, request, client_address):

1399

2387

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

1400

2388

1401

2389

This function creates a new pipe in self.pipe

1402

2390

"""

1403

2391

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1404

1405

super(MultiprocessingMixInWithPipe,

1406

self).process_request(request, client_address)

2392

2393

proc = MultiprocessingMixIn.process_request(self, request,

2394

client_address)

1407

2395

self.child_pipe.close()

1408

self.add_pipe(parent_pipe)

1409

1410

def add_pipe(self, parent_pipe):

2396

self.add_pipe(parent_pipe, proc)

2397

2398

def add_pipe(self, parent_pipe, proc):

1411

2399

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

1412

raise NotImplementedError

2400

raise NotImplementedError()

2401

1413

2402

1414

2403

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1415

2404

socketserver.TCPServer, object):

1420

2409

interface: None or a network interface name (string)

1421

2410

use_ipv6: Boolean; to use IPv6 or not

1422

2411

"""

2412

1423

2413

def __init__(self, server_address, RequestHandlerClass,

1424

interface=None, use_ipv6=True):

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

"""

1425

2420

self.interface = interface

1426

2421

if use_ipv6:

1427

2422

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.

1428

2449

socketserver.TCPServer.__init__(self, server_address,

1429

2450

RequestHandlerClass)

2451

1430

2452

def server_bind(self):

1431

2453

"""This overrides the normal server_bind() function

1432

2454

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

1433

2455

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

1434

2456

if self.interface is not None:

1435

2457

if SO_BINDTODEVICE is None:

1436

logger.error("SO_BINDTODEVICE does not exist;"

1437

" cannot bind to interface %s",

1438

self.interface)

1439

else:

1440

try:

1441

self.socket.setsockopt(socket.SOL_SOCKET,

1442

SO_BINDTODEVICE,

1443

str(self.interface

1444

+ '\0'))

1445

except socket.error, error:

1446

if error[0] == errno.EPERM:

1447

logger.error("No permission to"

1448

" bind to interface %s",

1449

self.interface)

1450

elif error[0] == errno.ENOPROTOOPT:

1451

logger.error("SO_BINDTODEVICE not available;"

1452

" cannot bind to interface %s",

1453

self.interface)

1454

else:

1455

raise

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

1456

2479

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

1457

2480

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

1458

2481

if not self.server_address[0]:

1459

2482

if self.address_family == socket.AF_INET6:

1460

2483

any_address = "::" # in6addr_any

1461

2484

else:

1462

any_address = socket.INADDR_ANY

2485

any_address = "0.0.0.0" # INADDR_ANY

1463

2486

self.server_address = (any_address,

1464

2487

self.server_address[1])

1465

2488

elif not self.server_address[1]:

1466

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

1467

0)

2489

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

1468

2490

# if self.interface:

1469

2491

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

1470

2492

# 0, # port

1482

2504

gnutls_priority GnuTLS priority string

1483

2505

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

1484

2506

1485

Assumes a gobject.MainLoop event loop.

2507

Assumes a GLib.MainLoop event loop.

1486

2508

"""

2509

1487

2510

def __init__(self, server_address, RequestHandlerClass,

1488

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

1489

gnutls_priority=None, use_dbus=True):

2511

interface=None,

2512

use_ipv6=True,

2513

clients=None,

2514

gnutls_priority=None,

2515

use_dbus=True,

2516

socketfd=None):

1490

2517

self.enabled = False

1491

2518

self.clients = clients

1492

2519

if self.clients is None:

1493

self.clients = set()

2520

self.clients = {}

1494

2521

self.use_dbus = use_dbus

1495

2522

self.gnutls_priority = gnutls_priority

1496

2523

IPv6_TCPServer.__init__(self, server_address,

1497

2524

RequestHandlerClass,

1498

2525

interface = interface,

1499

use_ipv6 = use_ipv6)

2526

use_ipv6 = use_ipv6,

2527

socketfd = socketfd)

2528

1500

2529

def server_activate(self):

1501

2530

if self.enabled:

1502

2531

return socketserver.TCPServer.server_activate(self)

2532

1503

2533

def enable(self):

1504

2534

self.enabled = True

1505

def add_pipe(self, parent_pipe):

2535

2536

def add_pipe(self, parent_pipe, proc):

1506

2537

# Call "handle_ipc" for both data and EOF events

1507

gobject.io_add_watch(parent_pipe.fileno(),

1508

gobject.IO_IN | gobject.IO_HUP,

1509

functools.partial(self.handle_ipc,

1510

parent_pipe = parent_pipe))

1511

1512

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

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,

1513

2548

client_object=None):

1514

condition_names = {

1515

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

1516

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

1517

# blocking).

1518

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

1519

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

1520

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

1521

# broken, usually for pipes and

1522

# sockets).

1523

}

1524

conditions_string = ' | '.join(name

1525

for cond, name in

1526

condition_names.iteritems()

1527

if cond & condition)

1528

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

1529

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

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

1530

2553

return False

1531

2554

1532

2555

# Read a request from the child

1537

2560

fpr = request[1]

1538

2561

address = request[2]

1539

2562

1540

for c in self.clients:

2563

for c in self.clients.values():

1541

2564

if c.fingerprint == fpr:

1542

2565

client = c

1543

2566

break

1544

2567

else:

1545

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

1546

"dress: %s", fpr, address)

2568

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

2569

"dress: %s", fpr, address)

1547

2570

if self.use_dbus:

1548

2571

# Emit D-Bus signal

1549

mandos_dbus_service.ClientNotFound(fpr, address[0])

2572

mandos_dbus_service.ClientNotFound(fpr,

2573

address[0])

1550

2574

parent_pipe.send(False)

1551

2575

return False

1552

2576

1553

gobject.io_add_watch(parent_pipe.fileno(),

1554

gobject.IO_IN | gobject.IO_HUP,

1555

functools.partial(self.handle_ipc,

1556

parent_pipe = parent_pipe,

1557

client_object = client))

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

1558

2584

parent_pipe.send(True)

1559

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

2585

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

2586

# same fileno

1560

2587

return False

1561

2588

if command == 'funcall':

1562

2589

funcname = request[1]

1563

2590

args = request[2]

1564

2591

kwargs = request[3]

1565

2592

1566

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

1567

2593

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

2594

funcname)(*args,

2595

**kwargs)))

2596

1568

2597

if command == 'getattr':

1569

2598

attrname = request[1]

1570

if callable(client_object.__getattribute__(attrname)):

1571

parent_pipe.send(('function',))

2599

if isinstance(client_object.__getattribute__(attrname),

2600

collections.Callable):

2601

parent_pipe.send(('function', ))

1572

2602

else:

1573

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

2603

parent_pipe.send((

2604

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

1574

2605

1575

2606

if command == 'setattr':

1576

2607

attrname = request[1]

1577

2608

value = request[2]

1578

2609

setattr(client_object, attrname, value)

1579

2610

1580

2611

return True

1581

2612

1582

2613

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

1583

2710

def string_to_delta(interval):

1584

2711

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

1585

2712

1596

2723

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

1597

2724

datetime.timedelta(0, 330)

1598

2725

"""

2726

2727

try:

2728

return rfc3339_duration_to_delta(interval)

2729

except ValueError:

2730

pass

2731

1599

2732

timevalue = datetime.timedelta(0)

1600

2733

for s in interval.split():

1601

2734

try:

1602

suffix = unicode(s[-1])

2735

suffix = s[-1]

1603

2736

value = int(s[:-1])

1604

2737

if suffix == "d":

1605

2738

delta = datetime.timedelta(value)

1612

2745

elif suffix == "w":

1613

2746

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

1614

2747

else:

1615

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

1616

except (ValueError, IndexError), e:

2748

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

2749

except IndexError as e:

1617

2750

raise ValueError(*(e.args))

1618

2751

timevalue += delta

1619

2752

return timevalue

1620

2753

1621

2754

1622

def if_nametoindex(interface):

1623

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

1624

1625

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

1626

global if_nametoindex

1627

try:

1628

if_nametoindex = (ctypes.cdll.LoadLibrary

1629

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

1630

.if_nametoindex)

1631

except (OSError, AttributeError):

1632

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

1633

def if_nametoindex(interface):

1634

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

1635

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

1636

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

1637

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1638

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

1639

interface))

1640

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

1641

ifreq[16:20])[0]

1642

return interface_index

1643

return if_nametoindex(interface)

1644

1645

1646

2755

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

1647

2756

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

1648

2757

1656

2765

sys.exit()

1657

2766

if not noclose:

1658

2767

# Close all standard open file descriptors

1659

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

2768

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

1660

2769

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

1661

2770

raise OSError(errno.ENODEV,

1662

"%s not a character device"

1663

% os.path.devnull)

2771

"{} not a character device"

2772

.format(os.devnull))

1664

2773

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

1665

2774

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

1666

2775

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

1673

2782

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

1674

2783

# Parsing of options, both command line and config file

1675

2784

1676

parser = optparse.OptionParser(version = "%%prog %s" % version)

1677

parser.add_option("-i", "--interface", type="string",

1678

metavar="IF", help="Bind to interface IF")

1679

parser.add_option("-a", "--address", type="string",

1680

help="Address to listen for requests on")

1681

parser.add_option("-p", "--port", type="int",

1682

help="Port number to receive requests on")

1683

parser.add_option("--check", action="store_true",

1684

help="Run self-test")

1685

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

1686

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

1687

" terminal")

1688

parser.add_option("--debuglevel", type="string", metavar="LEVEL",

1689

help="Debug level for stdout output")

1690

parser.add_option("--priority", type="string", help="GnuTLS"

1691

" priority string (see GnuTLS documentation)")

1692

parser.add_option("--servicename", type="string",

1693

metavar="NAME", help="Zeroconf service name")

1694

parser.add_option("--configdir", type="string",

1695

default="/etc/mandos", metavar="DIR",

1696

help="Directory to search for configuration"

1697

" files")

1698

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

1699

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

1700

" system bus interface")

1701

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

1702

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

1703

options = parser.parse_args()[0]

2785

parser = argparse.ArgumentParser()

2786

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

2787

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

2788

help="show version number and exit")

2789

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

2790

help="Bind to interface IF")

2791

parser.add_argument("-a", "--address",

2792

help="Address to listen for requests on")

2793

parser.add_argument("-p", "--port", type=int,

2794

help="Port number to receive requests on")

2795

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

2796

help="Run self-test")

2797

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

2798

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

2799

" to terminal", default=None)

2800

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

2801

help="Debug level for stdout output")

2802

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

2803

" priority string (see GnuTLS documentation)")

2804

parser.add_argument("--servicename",

2805

metavar="NAME", help="Zeroconf service name")

2806

parser.add_argument("--configdir",

2807

default="/etc/mandos", metavar="DIR",

2808

help="Directory to search for configuration"

2809

" files")

2810

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

2811

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

2812

" system bus interface", default=None)

2813

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

2830

options = parser.parse_args()

1704

2831

1705

2832

if options.check:

1706

2833

import doctest

1707

doctest.testmod()

1708

sys.exit()

2834

fail_count, test_count = doctest.testmod()

2835

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

1709

2836

1710

2837

# Default values for config file for server-global settings

1711

2838

server_defaults = { "interface": "",

1713

2840

"port": "",

1714

2841

"debug": "False",

1715

2842

"priority":

1716

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

2843

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

2844

":+SIGN-DSA-SHA256",

1717

2845

"servicename": "Mandos",

1718

2846

"use_dbus": "True",

1719

2847

"use_ipv6": "True",

1720

2848

"debuglevel": "",

1721

}

2849

"restore": "True",

2850

"socket": "",

2851

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

2852

"foreground": "False",

2853

"zeroconf": "True",

2854

}

1722

2855

1723

2856

# Parse config file for server-global settings

1724

2857

server_config = configparser.SafeConfigParser(server_defaults)

1725

2858

del server_defaults

1726

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

1727

"mandos.conf"))

2859

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

1728

2860

# Convert the SafeConfigParser object to a dict

1729

2861

server_settings = server_config.defaults()

1730

2862

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

1731

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

2863

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

1732

2864

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

1733

2865

option)

1734

2866

if server_settings["port"]:

1735

2867

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

1736

2868

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

1737

2878

del server_config

1738

2879

1739

2880

# Override the settings from the config file with command line

1740

2881

# options, if set.

1741

2882

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

1742

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

1743

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

2883

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

2884

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

2885

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

1744

2886

value = getattr(options, option)

1745

2887

if value is not None:

1746

2888

server_settings[option] = value

1747

2889

del options

1748

2890

# Force all strings to be unicode

1749

2891

for option in server_settings.keys():

1750

if type(server_settings[option]) is str:

1751

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

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

1752

2902

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

1753

2903

1754

2904

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

1755

2905

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

1756

2911

# For convenience

1757

2912

debug = server_settings["debug"]

1758

2913

debuglevel = server_settings["debuglevel"]

1759

2914

use_dbus = server_settings["use_dbus"]

1760

2915

use_ipv6 = server_settings["use_ipv6"]

1761

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

1762

2930

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

1763

syslogger.setFormatter(logging.Formatter

1764

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

1765

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

1766

% server_settings["servicename"]))

2931

syslogger.setFormatter(

2932

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

2933

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

2934

server_settings["servicename"])))

1767

2935

1768

2936

# Parse config file with clients

1769

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

1770

"interval": "5m",

1771

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

1772

"host": "",

1773

"approval_delay": "0s",

1774

"approval_duration": "1s",

1775

}

1776

client_config = configparser.SafeConfigParser(client_defaults)

2937

client_config = configparser.SafeConfigParser(Client

2938

.client_defaults)

1777

2939

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

1778

2940

"clients.conf"))

1779

2941

1780

2942

global mandos_dbus_service

1781

2943

mandos_dbus_service = None

1782

2944

1783

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

1784

server_settings["port"]),

1785

ClientHandler,

1786

interface=(server_settings["interface"]

1787

or None),

1788

use_ipv6=use_ipv6,

1789

gnutls_priority=

1790

server_settings["priority"],

1791

use_dbus=use_dbus)

1792

if not debug:

1793

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

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

1794

2961

try:

1795

pidfile = open(pidfilename, "w")

1796

except IOError:

1797

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

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)

1798

2966

1799

try:

1800

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

1801

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

1802

except KeyError:

2967

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

2968

("mandos", "mandos"),

2969

("nobody", "nogroup")):

1803

2970

try:

1804

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

1805

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

2971

uid = pwd.getpwnam(name).pw_uid

2972

gid = pwd.getpwnam(group).pw_gid

2973

break

1806

2974

except KeyError:

1807

try:

1808

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

1809

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

1810

except KeyError:

1811

uid = 65534

1812

gid = 65534

2975

continue

2976

else:

2977

uid = 65534

2978

gid = 65534

1813

2979

try:

1814

2980

os.setgid(gid)

1815

2981

os.setuid(uid)

1816

except OSError, error:

1817

if error[0] != errno.EPERM:

1818

raise error

2982

if debug:

2983

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

2984

gid))

2985

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

1819

2990

1820

if not debug and not debuglevel:

1821

syslogger.setLevel(logging.WARNING)

1822

console.setLevel(logging.WARNING)

1823

if debuglevel:

1824

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

1825

syslogger.setLevel(level)

1826

console.setLevel(level)

1827

1828

2991

if debug:

1829

2992

# Enable all possible GnuTLS debugging

1830

2993

1831

2994

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

1832

2995

# - GnuTLS manual

1833

gnutls.library.functions.gnutls_global_set_log_level(11)

2996

gnutls.global_set_log_level(11)

1834

2997

1835

@gnutls.library.types.gnutls_log_func

2998

@gnutls.log_func

1836

2999

def debug_gnutls(level, string):

1837

3000

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

1838

3001

1839

(gnutls.library.functions

1840

.gnutls_global_set_log_function(debug_gnutls))

3002

gnutls.global_set_log_function(debug_gnutls)

1841

3003

1842

3004

# Redirect stdin so all checkers get /dev/null

1843

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

3005

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

1844

3006

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

1845

3007

if null > 2:

1846

3008

os.close(null)

1847

else:

1848

# No console logging

1849

logger.removeHandler(console)

1850

3009

1851

3010

# Need to fork before connecting to D-Bus

1852

if not debug:

3011

if not foreground:

1853

3012

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

1854

3013

daemon()

1855

3014

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

1856

3019

global main_loop

1857

3020

# From the Avahi example code

1858

DBusGMainLoop(set_as_default=True )

1859

main_loop = gobject.MainLoop()

3021

DBusGMainLoop(set_as_default=True)

3022

main_loop = GLib.MainLoop()

1860

3023

bus = dbus.SystemBus()

1861

3024

# End of Avahi example code

1862

3025

if use_dbus:

1863

3026

try:

1864

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

1865

bus, do_not_queue=True)

1866

except dbus.exceptions.NameExistsException, e:

1867

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

3027

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)

1868

3035

use_dbus = False

1869

3036

server_settings["use_dbus"] = False

1870

3037

tcp_server.use_dbus = False

1871

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1872

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

1873

servicetype = "_mandos._tcp",

1874

protocol = protocol, bus = bus)

1875

if server_settings["interface"]:

1876

service.interface = (if_nametoindex

1877

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

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

1878

3048

1879

3049

global multiprocessing_manager

1880

3050

multiprocessing_manager = multiprocessing.Manager()

1882

3052

client_class = Client

1883

3053

if use_dbus:

1884

3054

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

1885

def client_config_items(config, section):

1886

special_settings = {

1887

"approved_by_default":

1888

lambda: config.getboolean(section,

1889

"approved_by_default"),

1890

}

1891

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

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

1892

3182

try:

1893

yield (name, special_settings[name]())

1894

except KeyError:

1895

yield (name, value)

1896

1897

tcp_server.clients.update(set(

1898

client_class(name = section,

1899

config= dict(client_config_items(

1900

client_config, section)))

1901

for section in client_config.sections()))

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

1902

3208

if not tcp_server.clients:

1903

3209

logger.warning("No clients defined")

1904

1905

if not debug:

1906

try:

1907

with pidfile:

1908

pid = os.getpid()

1909

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

1910

del pidfile

1911

except IOError:

1912

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

1913

pidfilename, pid)

1914

except NameError:

1915

# "pidfile" was never created

1916

pass

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

1917

3221

del pidfilename

3222

3223

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

3224

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3225

lambda: main_loop.quit() and False)

3226

3227

if use_dbus:

1918

3228

1919

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

1920

1921

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

1922

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

1923

1924

if use_dbus:

1925

class MandosDBusService(dbus.service.Object):

3229

@alternate_dbus_interfaces(

3230

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

3231

class MandosDBusService(DBusObjectWithObjectManager):

1926

3232

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

3233

1927

3234

def __init__(self):

1928

3235

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

1929

_interface = "se.bsnet.fukt.Mandos"

3236

3237

_interface = "se.recompile.Mandos"

1930

3238

1931

3239

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

1932

3240

def ClientAdded(self, objpath):

1938

3246

"D-Bus signal"

1939

3247

pass

1940

3248

3249

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

3250

"true"})

1941

3251

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

1942

3252

def ClientRemoved(self, objpath, name):

1943

3253

"D-Bus signal"

1944

3254

pass

1945

3255

3256

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

3257

"true"})

1946

3258

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

1947

3259

def GetAllClients(self):

1948

3260

"D-Bus method"

1949

return dbus.Array(c.dbus_object_path

1950

for c in tcp_server.clients)

3261

return dbus.Array(c.dbus_object_path for c in

3262

tcp_server.clients.values())

1951

3263

3264

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

3265

"true"})

1952

3266

@dbus.service.method(_interface,

1953

3267

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

1954

3268

def GetAllClientsWithProperties(self):

1955

3269

"D-Bus method"

1956

3270

return dbus.Dictionary(

1957

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

1958

for c in tcp_server.clients),

3271

{ c.dbus_object_path: c.GetAll(

3272

"se.recompile.Mandos.Client")

3273

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

1959

3274

signature="oa{sv}")

1960

3275

1961

3276

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

1962

3277

def RemoveClient(self, object_path):

1963

3278

"D-Bus method"

1964

for c in tcp_server.clients:

3279

for c in tcp_server.clients.values():

1965

3280

if c.dbus_object_path == object_path:

1966

tcp_server.clients.remove(c)

3281

del tcp_server.clients[c.name]

1967

3282

c.remove_from_connection()

1968

# Don't signal anything except ClientRemoved

3283

# Don't signal the disabling

1969

3284

c.disable(quiet=True)

1970

# Emit D-Bus signal

1971

self.ClientRemoved(object_path, c.name)

3285

# Emit D-Bus signal for removal

3286

self.client_removed_signal(c)

1972

3287

return

1973

3288

raise KeyError(object_path)

1974

3289

1975

3290

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)

1976

3327

1977

3328

mandos_dbus_service = MandosDBusService()

1978

3329

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

1979

3334

def cleanup():

1980

3335

"Cleanup function; run on exit"

1981

service.cleanup()

1982

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

1983

3398

while tcp_server.clients:

1984

client = tcp_server.clients.pop()

3399

name, client = tcp_server.clients.popitem()

1985

3400

if use_dbus:

1986

3401

client.remove_from_connection()

1987

client.disable_hook = None

1988

# Don't signal anything except ClientRemoved

3402

# Don't signal the disabling

1989

3403

client.disable(quiet=True)

3404

# Emit D-Bus signal for removal

1990

3405

if use_dbus:

1991

# Emit D-Bus signal

1992

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

1993

client.name)

3406

mandos_dbus_service.client_removed_signal(client)

3407

client_settings.clear()

1994

3408

1995

3409

atexit.register(cleanup)

1996

3410

1997

for client in tcp_server.clients:

3411

for client in tcp_server.clients.values():

1998

3412

if use_dbus:

1999

# Emit D-Bus signal

2000

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2001

client.enable()

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

2002

3418

2003

3419

tcp_server.enable()

2004

3420

tcp_server.server_activate()

2005

3421

2006

3422

# Find out what port we got

2007

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

3423

if zeroconf:

3424

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

2008

3425

if use_ipv6:

2009

3426

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

2010

" flowinfo %d, scope_id %d"

2011

% tcp_server.socket.getsockname())

3427

" flowinfo %d, scope_id %d",

3428

*tcp_server.socket.getsockname())

2012

3429

else: # IPv4

2013

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

2014

% tcp_server.socket.getsockname())

3430

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

3431

*tcp_server.socket.getsockname())

2015

3432

2016

3433

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

2017

3434

2018

3435

try:

2019

# From the Avahi example code

2020

try:

2021

service.activate()

2022

except dbus.exceptions.DBusException, error:

2023

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

2024

cleanup()

2025

sys.exit(1)

2026

# End of Avahi example code

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

2027

3445

2028

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

2029

lambda *args, **kwargs:

2030

(tcp_server.handle_request

2031

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

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

2032

3450

2033

3451

logger.debug("Starting main loop")

2034

3452

main_loop.run()

2035

except AvahiError, error:

2036

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

3453

except AvahiError as error:

3454

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

2037

3455

cleanup()

2038

3456

sys.exit(1)

2039

3457

except KeyboardInterrupt:

2044

3462

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

2045

3463

cleanup()

2046

3464

3465

2047

3466

if __name__ == '__main__':

2048

3467

main()