/mandos/release : revision 237.7.349

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

38

43

import socket

39

44

import argparse

40

45

import datetime

41

46

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

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

49

51

import sys

50

52

import re

51

53

import os

60

62

import struct

61

63

import fcntl

62

64

import functools

63

import cPickle as pickle

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

64

69

import multiprocessing

65

70

import types

71

import binascii

72

import tempfile

73

import itertools

74

import collections

75

import codecs

66

76

67

77

import dbus

68

78

import dbus.service

69

import gobject

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

70

83

import avahi

71

84

from dbus.mainloop.glib import DBusGMainLoop

72

85

import ctypes

82

95

except ImportError:

83

96

SO_BINDTODEVICE = None

84

97

85

86

version = "1.4.1"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

90

syslogger = (logging.handlers.SysLogHandler

91

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.1"

102

stored_state_file = "clients.pickle"

103

104

logger = logging.getLogger()

105

syslogger = None

106

107

try:

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

110

except (OSError, AttributeError):

111

112

def if_nametoindex(interface):

113

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

114

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

115

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

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

117

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

118

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

119

return interface_index

120

121

122

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

123

"""init logger and add loglevel"""

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

129

syslogger.setFormatter(logging.Formatter

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

134

if debug:

135

console = logging.StreamHandler()

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

141

logger.setLevel(level)

142

143

144

class PGPError(Exception):

145

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

146

pass

147

148

149

class PGPEngine(object):

150

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

151

152

def __init__(self):

153

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

154

self.gnupgargs = ['--batch',

155

'--home', self.tempdir,

156

'--force-mdc',

157

'--quiet',

158

'--no-use-agent']

159

160

def __enter__(self):

161

return self

162

163

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

164

self._cleanup()

165

return False

166

167

def __del__(self):

168

self._cleanup()

169

170

def _cleanup(self):

171

if self.tempdir is not None:

172

# Delete contents of tempdir

173

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

174

topdown = False):

175

for filename in files:

176

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

177

for dirname in dirs:

178

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

179

# Remove tempdir

180

os.rmdir(self.tempdir)

181

self.tempdir = None

182

183

def password_encode(self, password):

184

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

185

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

186

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

187

if len(encoded) > 2048:

188

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

189

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

190

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

191

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

192

return encoded

193

194

def encrypt(self, data, password):

195

passphrase = self.password_encode(password)

196

with tempfile.NamedTemporaryFile(

197

dir=self.tempdir) as passfile:

198

passfile.write(passphrase)

199

passfile.flush()

200

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

201

'--passphrase-file',

202

passfile.name]

203

+ self.gnupgargs,

204

stdin = subprocess.PIPE,

205

stdout = subprocess.PIPE,

206

stderr = subprocess.PIPE)

207

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

208

if proc.returncode != 0:

209

raise PGPError(err)

210

return ciphertext

211

212

def decrypt(self, data, password):

213

passphrase = self.password_encode(password)

214

with tempfile.NamedTemporaryFile(

215

dir = self.tempdir) as passfile:

216

passfile.write(passphrase)

217

passfile.flush()

218

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

219

'--passphrase-file',

220

passfile.name]

221

+ self.gnupgargs,

222

stdin = subprocess.PIPE,

223

stdout = subprocess.PIPE,

224

stderr = subprocess.PIPE)

225

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

226

if proc.returncode != 0:

227

raise PGPError(err)

228

return decrypted_plaintext

229

103

230

104

231

class AvahiError(Exception):

105

232

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

106

233

self.value = value

107

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

108

def __unicode__(self):

109

return unicode(repr(self.value))

234

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

235

**kwargs)

236

110

237

111

238

class AvahiServiceError(AvahiError):

112

239

pass

113

240

241

114

242

class AvahiGroupError(AvahiError):

115

243

pass

116

244

123

251

Used to optionally bind to the specified interface.

124

252

name: string; Example: 'Mandos'

125

253

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

126

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

254

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

127

255

port: integer; what port to announce

128

256

TXT: list of strings; TXT record for the service

129

257

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

135

263

server: D-Bus Server

136

264

bus: dbus.SystemBus()

137

265

"""

138

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

139

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

140

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

141

protocol = avahi.PROTO_UNSPEC, bus = None):

266

267

def __init__(self,

268

interface = avahi.IF_UNSPEC,

269

name = None,

270

servicetype = None,

271

port = None,

272

TXT = None,

273

domain = "",

274

host = "",

275

max_renames = 32768,

276

protocol = avahi.PROTO_UNSPEC,

277

bus = None):

142

278

self.interface = interface

143

279

self.name = name

144

280

self.type = servicetype

153

289

self.server = None

154

290

self.bus = bus

155

291

self.entry_group_state_changed_match = None

156

def rename(self):

292

293

def rename(self, remove=True):

157

294

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

158

295

if self.rename_count >= self.max_renames:

159

296

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

160

297

" after %i retries, exiting.",

161

298

self.rename_count)

162

299

raise AvahiServiceError("Too many renames")

163

self.name = unicode(self.server

164

.GetAlternativeServiceName(self.name))

300

self.name = str(

301

self.server.GetAlternativeServiceName(self.name))

302

self.rename_count += 1

165

303

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

166

304

self.name)

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

self.remove()

305

if remove:

306

self.remove()

172

307

try:

173

308

self.add()

174

309

except dbus.exceptions.DBusException as error:

175

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

176

self.cleanup()

177

os._exit(1)

178

self.rename_count += 1

310

if (error.get_dbus_name()

311

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

312

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

313

return self.rename(remove=False)

314

else:

315

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

316

self.cleanup()

317

os._exit(1)

318

179

319

def remove(self):

180

320

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

181

321

if self.entry_group_state_changed_match is not None:

183

323

self.entry_group_state_changed_match = None

184

324

if self.group is not None:

185

325

self.group.Reset()

326

186

327

def add(self):

187

328

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

188

329

self.remove()

193

334

avahi.DBUS_INTERFACE_ENTRY_GROUP)

194

335

self.entry_group_state_changed_match = (

195

336

self.group.connect_to_signal(

196

'StateChanged', self .entry_group_state_changed))

337

'StateChanged', self.entry_group_state_changed))

197

338

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

198

339

self.name, self.type)

199

340

self.group.AddService(

205

346

dbus.UInt16(self.port),

206

347

avahi.string_array_to_txt_array(self.TXT))

207

348

self.group.Commit()

349

208

350

def entry_group_state_changed(self, state, error):

209

351

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

210

352

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

216

358

self.rename()

217

359

elif state == avahi.ENTRY_GROUP_FAILURE:

218

360

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

219

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

361

str(error))

362

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

363

222

364

def cleanup(self):

223

365

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

224

366

if self.group is not None:

225

367

try:

226

368

self.group.Free()

227

369

except (dbus.exceptions.UnknownMethodException,

228

dbus.exceptions.DBusException) as e:

370

dbus.exceptions.DBusException):

229

371

pass

230

372

self.group = None

231

373

self.remove()

374

232

375

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

233

376

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

234

377

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

235

bad_states = { avahi.SERVER_INVALID:

236

"Zeroconf server invalid",

237

avahi.SERVER_REGISTERING: None,

238

avahi.SERVER_COLLISION:

239

"Zeroconf server name collision",

240

avahi.SERVER_FAILURE:

241

"Zeroconf server failure" }

378

bad_states = {

379

avahi.SERVER_INVALID: "Zeroconf server invalid",

380

avahi.SERVER_REGISTERING: None,

381

avahi.SERVER_COLLISION: "Zeroconf server name collision",

382

avahi.SERVER_FAILURE: "Zeroconf server failure",

383

}

242

384

if state in bad_states:

243

385

if bad_states[state] is not None:

244

386

if error is None:

247

389

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

248

390

self.cleanup()

249

391

elif state == avahi.SERVER_RUNNING:

250

self.add()

392

try:

393

self.add()

394

except dbus.exceptions.DBusException as error:

395

if (error.get_dbus_name()

396

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

397

logger.info("Local Zeroconf service name"

398

" collision.")

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

251

404

else:

252

405

if error is None:

253

406

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

254

407

else:

255

408

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

409

256

410

def activate(self):

257

411

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

258

412

if self.server is None:

262

416

follow_name_owner_changes=True),

263

417

avahi.DBUS_INTERFACE_SERVER)

264

418

self.server.connect_to_signal("StateChanged",

265

self.server_state_changed)

419

self.server_state_changed)

266

420

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

267

421

268

422

269

def _timedelta_to_milliseconds(td):

270

"Convert a datetime.timedelta() to milliseconds"

271

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

272

+ (td.seconds * 1000)

273

+ (td.microseconds // 1000))

274

423

class AvahiServiceToSyslog(AvahiService):

424

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

425

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

426

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

427

syslogger.setFormatter(logging.Formatter(

428

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

429

.format(self.name)))

430

return ret

431

432

# Pretend that we have a GnuTLS module

433

class GnuTLS(object):

434

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

435

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

436

437

_library = ctypes.cdll.LoadLibrary(

438

ctypes.util.find_library("gnutls"))

439

_need_version = "3.3.0"

440

def __init__(self):

441

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

442

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

443

# happens.

444

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

445

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

446

.format(self._need_version))

447

448

# Unless otherwise indicated, the constants and types below are

449

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

450

451

# Constants

452

E_SUCCESS = 0

453

CRT_OPENPGP = 2

454

CLIENT = 2

455

SHUT_RDWR = 0

456

CRD_CERTIFICATE = 1

457

E_NO_CERTIFICATE_FOUND = -49

458

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

459

460

# Types

461

class session_int(ctypes.Structure):

462

_fields_ = []

463

session_t = ctypes.POINTER(session_int)

464

class certificate_credentials_st(ctypes.Structure):

465

_fields_ = []

466

certificate_credentials_t = ctypes.POINTER(

467

certificate_credentials_st)

468

certificate_type_t = ctypes.c_int

469

class datum_t(ctypes.Structure):

470

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

471

('size', ctypes.c_uint)]

472

class openpgp_crt_int(ctypes.Structure):

473

_fields_ = []

474

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

475

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

476

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

477

credentials_type_t = ctypes.c_int #

478

transport_ptr_t = ctypes.c_void_p

479

close_request_t = ctypes.c_int

480

481

# Exceptions

482

class Error(Exception):

483

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

484

# exception might be raised from within GnuTLS.__init__,

485

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

486

# global variable happens.

487

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

488

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

489

# code is passed, convert it to a string with

490

# gnutls.strerror()

491

if message is None and code is not None:

492

message = GnuTLS.strerror(code)

493

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

494

message, *args)

495

496

class CertificateSecurityError(Error):

497

pass

498

499

# Classes

500

class Credentials(object):

501

def __init__(self):

502

self._c_object = gnutls.certificate_credentials_t()

503

gnutls.certificate_allocate_credentials(

504

ctypes.byref(self._c_object))

505

self.type = gnutls.CRD_CERTIFICATE

506

507

def __del__(self):

508

gnutls.certificate_free_credentials(self._c_object)

509

510

class ClientSession(object):

511

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

512

self._c_object = gnutls.session_t()

513

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

514

gnutls.set_default_priority(self._c_object)

515

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

516

gnutls.handshake_set_private_extensions(self._c_object,

517

True)

518

self.socket = socket

519

if credentials is None:

520

credentials = gnutls.Credentials()

521

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

522

ctypes.cast(credentials._c_object,

523

ctypes.c_void_p))

524

self.credentials = credentials

525

526

def __del__(self):

527

gnutls.deinit(self._c_object)

528

529

def handshake(self):

530

return gnutls.handshake(self._c_object)

531

532

def send(self, data):

533

data = bytes(data)

534

if not data:

535

return 0

536

return gnutls.record_send(self._c_object, data, len(data))

537

538

def bye(self):

539

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

540

541

# Error handling function

542

def _error_code(result):

543

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

544

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

545

if result >= 0:

546

return result

547

if result == gnutls.E_NO_CERTIFICATE_FOUND:

548

raise gnutls.CertificateSecurityError(code = result)

549

raise gnutls.Error(code = result)

550

551

# Unless otherwise indicated, the function declarations below are

552

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

553

554

# Functions

555

priority_set_direct = _library.gnutls_priority_set_direct

556

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

557

ctypes.POINTER(ctypes.c_char_p)]

558

priority_set_direct.restype = _error_code

559

560

init = _library.gnutls_init

561

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

562

init.restype = _error_code

563

564

set_default_priority = _library.gnutls_set_default_priority

565

set_default_priority.argtypes = [session_t]

566

set_default_priority.restype = _error_code

567

568

record_send = _library.gnutls_record_send

569

record_send.argtypes = [session_t, ctypes.c_void_p,

570

ctypes.c_size_t]

571

record_send.restype = ctypes.c_ssize_t

572

573

certificate_allocate_credentials = (

574

_library.gnutls_certificate_allocate_credentials)

575

certificate_allocate_credentials.argtypes = [

576

ctypes.POINTER(certificate_credentials_t)]

577

certificate_allocate_credentials.restype = _error_code

578

579

certificate_free_credentials = (

580

_library.gnutls_certificate_free_credentials)

581

certificate_free_credentials.argtypes = [certificate_credentials_t]

582

certificate_free_credentials.restype = None

583

584

handshake_set_private_extensions = (

585

_library.gnutls_handshake_set_private_extensions)

586

handshake_set_private_extensions.argtypes = [session_t,

587

ctypes.c_int]

588

handshake_set_private_extensions.restype = None

589

590

credentials_set = _library.gnutls_credentials_set

591

credentials_set.argtypes = [session_t, credentials_type_t,

592

ctypes.c_void_p]

593

credentials_set.restype = _error_code

594

595

strerror = _library.gnutls_strerror

596

strerror.argtypes = [ctypes.c_int]

597

strerror.restype = ctypes.c_char_p

598

599

certificate_type_get = _library.gnutls_certificate_type_get

600

certificate_type_get.argtypes = [session_t]

601

certificate_type_get.restype = _error_code

602

603

certificate_get_peers = _library.gnutls_certificate_get_peers

604

certificate_get_peers.argtypes = [session_t,

605

ctypes.POINTER(ctypes.c_uint)]

606

certificate_get_peers.restype = ctypes.POINTER(datum_t)

607

608

global_set_log_level = _library.gnutls_global_set_log_level

609

global_set_log_level.argtypes = [ctypes.c_int]

610

global_set_log_level.restype = None

611

612

global_set_log_function = _library.gnutls_global_set_log_function

613

global_set_log_function.argtypes = [log_func]

614

global_set_log_function.restype = None

615

616

deinit = _library.gnutls_deinit

617

deinit.argtypes = [session_t]

618

deinit.restype = None

619

620

handshake = _library.gnutls_handshake

621

handshake.argtypes = [session_t]

622

handshake.restype = _error_code

623

624

transport_set_ptr = _library.gnutls_transport_set_ptr

625

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

626

transport_set_ptr.restype = None

627

628

bye = _library.gnutls_bye

629

bye.argtypes = [session_t, close_request_t]

630

bye.restype = _error_code

631

632

check_version = _library.gnutls_check_version

633

check_version.argtypes = [ctypes.c_char_p]

634

check_version.restype = ctypes.c_char_p

635

636

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

637

638

openpgp_crt_init = _library.gnutls_openpgp_crt_init

639

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

640

openpgp_crt_init.restype = _error_code

641

642

openpgp_crt_import = _library.gnutls_openpgp_crt_import

643

openpgp_crt_import.argtypes = [openpgp_crt_t,

644

ctypes.POINTER(datum_t),

645

openpgp_crt_fmt_t]

646

openpgp_crt_import.restype = _error_code

647

648

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

649

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

650

ctypes.POINTER(ctypes.c_uint)]

651

openpgp_crt_verify_self.restype = _error_code

652

653

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

654

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

655

openpgp_crt_deinit.restype = None

656

657

openpgp_crt_get_fingerprint = (

658

_library.gnutls_openpgp_crt_get_fingerprint)

659

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

660

ctypes.c_void_p,

661

ctypes.POINTER(

662

ctypes.c_size_t)]

663

openpgp_crt_get_fingerprint.restype = _error_code

664

665

# Remove non-public function

666

del _error_code

667

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

668

gnutls = GnuTLS()

669

670

def call_pipe(connection, # : multiprocessing.Connection

671

func, *args, **kwargs):

672

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

673

674

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

675

return value on the provided multiprocessing.Connection.

676

"""

677

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

678

connection.close()

679

275

680

class Client(object):

276

681

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

277

682

278

683

Attributes:

279

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

684

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

280

685

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

281

686

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

282

687

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

289

694

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

290

695

checker_initiator_tag: a gobject event source tag, or None

291

696

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

697

client_structure: Object describing what attributes a client has

698

and is used for storing the client at exit

292

699

current_checker_command: string; current running checker_command

293

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

294

700

disable_initiator_tag: a gobject event source tag, or None

295

701

enabled: bool()

296

702

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

299

705

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

300

706

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

301

707

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

302

last_enabled: datetime.datetime(); (UTC)

708

last_checker_status: integer between 0 and 255 reflecting exit

709

status of last checker. -1 reflects crashed

710

checker, -2 means no checker completed yet.

711

last_checker_signal: The signal which killed the last checker, if

712

last_checker_status is -1

713

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

303

714

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

304

715

D-Bus identifiers

305

716

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

306

717

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

307

718

until this client is disabled

308

extended_timeout: extra long timeout when password has been sent

719

extended_timeout: extra long timeout when secret has been sent

309

720

runtime_expansions: Allowed attributes for runtime expansion.

310

721

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

311

722

disabled, or None

723

server_settings: The server_settings dict from main()

312

724

"""

313

725

314

726

runtime_expansions = ("approval_delay", "approval_duration",

315

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

316

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

727

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

728

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

729

"last_approval_request", "last_checked_ok",

317

730

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

318

319

def timeout_milliseconds(self):

320

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

322

323

def extended_timeout_milliseconds(self):

324

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

326

327

def interval_milliseconds(self):

328

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

330

331

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

731

client_defaults = {

732

"timeout": "PT5M",

733

"extended_timeout": "PT15M",

734

"interval": "PT2M",

735

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

736

"host": "",

737

"approval_delay": "PT0S",

738

"approval_duration": "PT1S",

739

"approved_by_default": "True",

740

"enabled": "True",

741

}

742

743

@staticmethod

744

def config_parser(config):

745

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

746

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

747

with exceptions for any special settings as defined above.

748

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

749

value given the same arguments.

750

"""

751

settings = {}

752

for client_name in config.sections():

753

section = dict(config.items(client_name))

754

client = settings[client_name] = {}

755

756

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

757

# Reformat values from string types to Python types

758

client["approved_by_default"] = config.getboolean(

759

client_name, "approved_by_default")

760

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

761

"enabled")

762

763

# Uppercase and remove spaces from fingerprint for later

764

# comparison purposes with return value from the

765

# fingerprint() function

766

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

767

.replace(" ", ""))

768

if "secret" in section:

769

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

770

elif "secfile" in section:

771

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

772

(section["secfile"])),

773

"rb") as secfile:

774

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

775

else:

776

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

777

.format(section))

778

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

779

client["extended_timeout"] = string_to_delta(

780

section["extended_timeout"])

781

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

782

client["approval_delay"] = string_to_delta(

783

section["approval_delay"])

784

client["approval_duration"] = string_to_delta(

785

section["approval_duration"])

786

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

787

client["last_approval_request"] = None

788

client["last_checked_ok"] = None

789

client["last_checker_status"] = -2

790

791

return settings

792

793

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

338

794

self.name = name

339

if config is None:

340

config = {}

795

if server_settings is None:

796

server_settings = {}

797

self.server_settings = server_settings

798

# adding all client settings

799

for setting, value in settings.items():

800

setattr(self, setting, value)

801

802

if self.enabled:

803

if not hasattr(self, "last_enabled"):

804

self.last_enabled = datetime.datetime.utcnow()

805

if not hasattr(self, "expires"):

806

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

807

+ self.timeout)

808

else:

809

self.last_enabled = None

810

self.expires = None

811

341

812

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

342

# Uppercase and remove spaces from fingerprint for later

343

# comparison purposes with return value from the fingerprint()

344

# function

345

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

346

.replace(" ", ""))

347

813

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

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

814

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

815

datetime.datetime.utcnow())

816

817

# attributes specific for this server instance

369

818

self.checker = None

370

819

self.checker_initiator_tag = None

371

820

self.disable_initiator_tag = None

372

self.expires = None

373

821

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

375

822

self.current_checker_command = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

823

self.approved = None

380

824

self.approvals_pending = 0

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

self.changedstate = (multiprocessing_manager

386

.Condition(multiprocessing_manager

387

.Lock()))

825

self.changedstate = multiprocessing_manager.Condition(

826

multiprocessing_manager.Lock())

827

self.client_structure = [attr

828

for attr in self.__dict__.iterkeys()

829

if not attr.startswith("_")]

830

self.client_structure.append("client_structure")

831

832

for name, t in inspect.getmembers(

833

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

834

if not name.startswith("_"):

835

self.client_structure.append(name)

388

836

837

# Send notice to process children that client state has changed

389

838

def send_changedstate(self):

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

839

with self.changedstate:

840

self.changedstate.notify_all()

393

841

394

842

def enable(self):

395

843

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

396

844

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

397

845

# Already enabled

398

846

return

399

self.send_changedstate()

400

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

401

# and every interval from then on.

402

self.checker_initiator_tag = (gobject.timeout_add

403

(self.interval_milliseconds(),

404

self.start_checker))

405

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

406

847

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

410

848

self.enabled = True

411

849

self.last_enabled = datetime.datetime.utcnow()

412

# Also start a new checker *right now*.

413

self.start_checker()

850

self.init_checker()

851

self.send_changedstate()

414

852

415

853

def disable(self, quiet=True):

416

854

"""Disable this client."""

417

855

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

418

856

return False

419

857

if not quiet:

420

self.send_changedstate()

421

if not quiet:

422

858

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

423

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

859

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

424

860

gobject.source_remove(self.disable_initiator_tag)

425

861

self.disable_initiator_tag = None

426

862

self.expires = None

427

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

863

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

428

864

gobject.source_remove(self.checker_initiator_tag)

429

865

self.checker_initiator_tag = None

430

866

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

433

867

self.enabled = False

868

if not quiet:

869

self.send_changedstate()

434

870

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

435

871

return False

436

872

437

873

def __del__(self):

438

self.disable_hook = None

439

874

self.disable()

440

875

441

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

876

def init_checker(self):

877

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

878

# and every interval from then on.

879

if self.checker_initiator_tag is not None:

880

gobject.source_remove(self.checker_initiator_tag)

881

self.checker_initiator_tag = gobject.timeout_add(

882

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

883

self.start_checker)

884

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

885

if self.disable_initiator_tag is not None:

886

gobject.source_remove(self.disable_initiator_tag)

887

self.disable_initiator_tag = gobject.timeout_add(

888

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

889

# Also start a new checker *right now*.

890

self.start_checker()

891

892

def checker_callback(self, source, condition, connection,

893

command):

442

894

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

443

895

self.checker_callback_tag = None

444

896

self.checker = None

445

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

897

# Read return code from connection (see call_pipe)

898

returncode = connection.recv()

899

connection.close()

900

901

if returncode >= 0:

902

self.last_checker_status = returncode

903

self.last_checker_signal = None

904

if self.last_checker_status == 0:

448

905

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

449

906

vars(self))

450

907

self.checked_ok()

451

908

else:

452

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

453

vars(self))

909

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

454

910

else:

911

self.last_checker_status = -1

912

self.last_checker_signal = -returncode

455

913

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

456

914

vars(self))

457

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

915

return False

916

917

def checked_ok(self):

918

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

919

self.last_checked_ok = datetime.datetime.utcnow()

920

self.last_checker_status = 0

921

self.last_checker_signal = None

922

self.bump_timeout()

923

924

def bump_timeout(self, timeout=None):

925

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

464

926

if timeout is None:

465

927

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

467

928

if self.disable_initiator_tag is not None:

468

929

gobject.source_remove(self.disable_initiator_tag)

930

self.disable_initiator_tag = None

469

931

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

470

self.disable_initiator_tag = (gobject.timeout_add

471

(_timedelta_to_milliseconds

472

(timeout), self.disable))

932

self.disable_initiator_tag = gobject.timeout_add(

933

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

473

934

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

474

935

475

936

def need_approval(self):

481

942

If a checker already exists, leave it running and do

482

943

nothing."""

483

944

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

484

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

485

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

486

# client would inevitably timeout, since no checker would get

487

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

945

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

946

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

947

# would inevitably timeout, since no checker would get a

948

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

488

949

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

489

950

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

490

951

# should be.

491

952

492

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

493

try:

494

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

495

except (AttributeError, OSError) as error:

496

if (isinstance(error, OSError)

497

and error.errno != errno.ECHILD):

498

raise error

499

else:

500

if pid:

501

logger.warning("Checker was a zombie")

502

gobject.source_remove(self.checker_callback_tag)

503

self.checker_callback(pid, status,

504

self.current_checker_command)

953

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

954

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

955

self.checker.join()

956

self.checker = None

505

957

# Start a new checker if needed

506

958

if self.checker is None:

959

# Escape attributes for the shell

960

escaped_attrs = {

961

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

962

for attr in self.runtime_expansions }

507

963

try:

508

# In case checker_command has exactly one % operator

509

command = self.checker_command % self.host

510

except TypeError:

511

# Escape attributes for the shell

512

escaped_attrs = dict(

513

(attr,

514

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

515

errors=

516

'replace')))

517

for attr in

518

self.runtime_expansions)

519

520

try:

521

command = self.checker_command % escaped_attrs

522

except TypeError as error:

523

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

524

' %s', self.checker_command, error)

525

return True # Try again later

964

command = self.checker_command % escaped_attrs

965

except TypeError as error:

966

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

967

self.checker_command,

968

exc_info=error)

969

return True # Try again later

526

970

self.current_checker_command = command

527

try:

528

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

529

command, self.name)

530

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

531

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

532

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

533

# always replaced by /dev/null.)

534

self.checker = subprocess.Popen(command,

535

close_fds=True,

536

shell=True, cwd="/")

537

self.checker_callback_tag = (gobject.child_watch_add

538

(self.checker.pid,

539

self.checker_callback,

540

data=command))

541

# The checker may have completed before the gobject

542

# watch was added. Check for this.

543

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

544

if pid:

545

gobject.source_remove(self.checker_callback_tag)

546

self.checker_callback(pid, status, command)

547

except OSError as error:

548

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

549

error)

971

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

972

self.name)

973

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

974

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

975

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

976

# always replaced by /dev/null.)

977

# The exception is when not debugging but nevertheless

978

# running in the foreground; use the previously

979

# created wnull.

980

popen_args = { "close_fds": True,

981

"shell": True,

982

"cwd": "/" }

983

if (not self.server_settings["debug"]

984

and self.server_settings["foreground"]):

985

popen_args.update({"stdout": wnull,

986

"stderr": wnull })

987

pipe = multiprocessing.Pipe(duplex = False)

988

self.checker = multiprocessing.Process(

989

target = call_pipe,

990

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

991

kwargs = popen_args)

992

self.checker.start()

993

self.checker_callback_tag = gobject.io_add_watch(

994

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

995

self.checker_callback, pipe[0], command)

550

996

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

551

997

return True

552

998

558

1004

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

559

1005

return

560

1006

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

561

try:

562

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

563

#time.sleep(0.5)

564

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

565

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

566

except OSError as error:

567

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

568

raise

1007

self.checker.terminate()

569

1008

self.checker = None

570

1009

571

1010

572

def dbus_service_property(dbus_interface, signature="v",

573

access="readwrite", byte_arrays=False):

1011

def dbus_service_property(dbus_interface,

1012

signature="v",

1013

access="readwrite",

1014

byte_arrays=False):

574

1015

"""Decorators for marking methods of a DBusObjectWithProperties to

575

1016

become properties on the D-Bus.

576

1017

585

1026

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

586

1027

if byte_arrays and signature != "ay":

587

1028

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

588

" signature %r" % signature)

1029

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

1030

589

1031

def decorator(func):

590

1032

func._dbus_is_property = True

591

1033

func._dbus_interface = dbus_interface

596

1038

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

597

1039

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

598

1040

return func

1041

1042

return decorator

1043

1044

1045

def dbus_interface_annotations(dbus_interface):

1046

"""Decorator for marking functions returning interface annotations

1047

1048

Usage:

1049

1050

@dbus_interface_annotations("org.example.Interface")

1051

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

1052

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

1053

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

1054

"false"}

1055

"""

1056

1057

def decorator(func):

1058

func._dbus_is_interface = True

1059

func._dbus_interface = dbus_interface

1060

func._dbus_name = dbus_interface

1061

return func

1062

1063

return decorator

1064

1065

1066

def dbus_annotations(annotations):

1067

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

1068

Usage:

1069

1070

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

1071

"org.freedesktop.DBus.Property."

1072

"EmitsChangedSignal": "false"})

1073

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

1074

access="r")

1075

def Property_dbus_property(self):

1076

return dbus.Boolean(False)

1077

1078

See also the DBusObjectWithAnnotations class.

1079

"""

1080

1081

def decorator(func):

1082

func._dbus_annotations = annotations

1083

return func

1084

599

1085

return decorator

600

1086

601

1087

602

1088

class DBusPropertyException(dbus.exceptions.DBusException):

603

1089

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

604

1090

"""

605

def __unicode__(self):

606

return unicode(str(self))

1091

pass

607

1092

608

1093

609

1094

class DBusPropertyAccessException(DBusPropertyException):

618

1103

pass

619

1104

620

1105

621

class DBusObjectWithProperties(dbus.service.Object):

1106

class DBusObjectWithAnnotations(dbus.service.Object):

1107

"""A D-Bus object with annotations.

1108

1109

Classes inheriting from this can use the dbus_annotations

1110

decorator to add annotations to methods or signals.

1111

"""

1112

1113

@staticmethod

1114

def _is_dbus_thing(thing):

1115

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

1116

1117

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

1118

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

1119

"""

1120

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

1121

False)

1122

1123

def _get_all_dbus_things(self, thing):

1124

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

1125

"""

1126

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

1127

athing.__get__(self))

1128

for cls in self.__class__.__mro__

1129

for name, athing in

1130

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

1131

1132

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1133

out_signature = "s",

1134

path_keyword = 'object_path',

1135

connection_keyword = 'connection')

1136

def Introspect(self, object_path, connection):

1137

"""Overloading of standard D-Bus method.

1138

1139

Inserts annotation tags on methods and signals.

1140

"""

1141

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

1142

connection)

1143

try:

1144

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

1145

1146

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

1147

# Add annotation tags

1148

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

1149

for tag in if_tag.getElementsByTagName(typ):

1150

annots = dict()

1151

for name, prop in (self.

1152

_get_all_dbus_things(typ)):

1153

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

1154

and prop._dbus_interface

1155

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

1156

annots.update(getattr(

1157

prop, "_dbus_annotations", {}))

1158

for name, value in annots.items():

1159

ann_tag = document.createElement(

1160

"annotation")

1161

ann_tag.setAttribute("name", name)

1162

ann_tag.setAttribute("value", value)

1163

tag.appendChild(ann_tag)

1164

# Add interface annotation tags

1165

for annotation, value in dict(

1166

itertools.chain.from_iterable(

1167

annotations().items()

1168

for name, annotations

1169

in self._get_all_dbus_things("interface")

1170

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

1171

)).items():

1172

ann_tag = document.createElement("annotation")

1173

ann_tag.setAttribute("name", annotation)

1174

ann_tag.setAttribute("value", value)

1175

if_tag.appendChild(ann_tag)

1176

# Fix argument name for the Introspect method itself

1177

if (if_tag.getAttribute("name")

1178

== dbus.INTROSPECTABLE_IFACE):

1179

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

1180

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

1181

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

1182

if (arg.getAttribute("direction")

1183

== "out"):

1184

arg.setAttribute("name",

1185

"xml_data")

1186

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

1187

document.unlink()

1188

except (AttributeError, xml.dom.DOMException,

1189

xml.parsers.expat.ExpatError) as error:

1190

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

1191

exc_info=error)

1192

return xmlstring

1193

1194

1195

class DBusObjectWithProperties(DBusObjectWithAnnotations):

622

1196

"""A D-Bus object with properties.

623

1197

624

1198

Classes inheriting from this can use the dbus_service_property

626

1200

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

627

1201

"""

628

1202

629

@staticmethod

630

def _is_dbus_property(obj):

631

return getattr(obj, "_dbus_is_property", False)

632

633

def _get_all_dbus_properties(self):

634

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

635

"""

636

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

637

for cls in self.__class__.__mro__

638

for name, prop in

639

inspect.getmembers(cls, self._is_dbus_property))

640

641

1203

def _get_dbus_property(self, interface_name, property_name):

642

1204

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

643

1205

property with the specified name and interface.

644

1206

"""

645

for cls in self.__class__.__mro__:

646

for name, value in (inspect.getmembers

647

(cls, self._is_dbus_property)):

1207

for cls in self.__class__.__mro__:

1208

for name, value in inspect.getmembers(

1209

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

648

1210

if (value._dbus_name == property_name

649

1211

and value._dbus_interface == interface_name):

650

1212

return value.__get__(self)

651

1213

652

1214

# No such property

653

raise DBusPropertyNotFound(self.dbus_object_path + ":"

654

+ interface_name + "."

655

+ property_name)

656

657

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

1215

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

1216

self.dbus_object_path, interface_name, property_name))

1217

1218

@classmethod

1219

def _get_all_interface_names(cls):

1220

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

1221

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

1222

"_dbus_interface", None)

1223

for x in (inspect.getmro(cls))

1224

for attr in dir(x))

1225

if name is not None)

1226

1227

@dbus.service.method(dbus.PROPERTIES_IFACE,

1228

in_signature="ss",

658

1229

out_signature="v")

659

1230

def Get(self, interface_name, property_name):

660

1231

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

678

1249

# The byte_arrays option is not supported yet on

679

1250

# signatures other than "ay".

680

1251

if prop._dbus_signature != "ay":

681

raise ValueError

682

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

683

for byte in value))

1252

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

1253

"'ay' signature {!r}"

1254

.format(prop._dbus_signature))

1255

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

1256

for byte in value))

684

1257

prop(value)

685

1258

686

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

1259

@dbus.service.method(dbus.PROPERTIES_IFACE,

1260

in_signature="s",

687

1261

out_signature="a{sv}")

688

1262

def GetAll(self, interface_name):

689

1263

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

691

1265

692

1266

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

693

1267

"""

694

all = {}

695

for name, prop in self._get_all_dbus_properties():

1268

properties = {}

1269

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

696

1270

if (interface_name

697

1271

and interface_name != prop._dbus_interface):

698

1272

# Interface non-empty but did not match

702

1276

continue

703

1277

value = prop()

704

1278

if not hasattr(value, "variant_level"):

705

all[name] = value

1279

properties[name] = value

706

1280

continue

707

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

708

value.variant_level+1)

709

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

1281

properties[name] = type(value)(

1282

value, variant_level = value.variant_level + 1)

1283

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

1284

1285

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

1286

def PropertiesChanged(self, interface_name, changed_properties,

1287

invalidated_properties):

1288

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

1289

standard.

1290

"""

1291

pass

710

1292

711

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

712

1294

out_signature="s",

713

1295

path_keyword='object_path',

714

1296

connection_keyword='connection')

715

1297

def Introspect(self, object_path, connection):

716

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

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts property tags and interface annotation tags.

717

1301

"""

718

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

719

connection)

1302

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1303

object_path,

1304

connection)

720

1305

try:

721

1306

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

1307

722

1308

def make_tag(document, name, prop):

723

1309

e = document.createElement("property")

724

1310

e.setAttribute("name", name)

725

1311

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

726

1312

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

727

1313

return e

1314

728

1315

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

1316

# Add property tags

729

1317

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

730

1318

for name, prop

731

in self._get_all_dbus_properties()

1319

in self._get_all_dbus_things("property")

732

1320

if prop._dbus_interface

733

1321

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

734

1322

if_tag.appendChild(tag)

1323

# Add annotation tags for properties

1324

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

1325

annots = dict()

1326

for name, prop in self._get_all_dbus_things(

1327

"property"):

1328

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

1329

and prop._dbus_interface

1330

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

1331

annots.update(getattr(

1332

prop, "_dbus_annotations", {}))

1333

for name, value in annots.items():

1334

ann_tag = document.createElement(

1335

"annotation")

1336

ann_tag.setAttribute("name", name)

1337

ann_tag.setAttribute("value", value)

1338

tag.appendChild(ann_tag)

735

1339

# Add the names to the return values for the

736

1340

# "org.freedesktop.DBus.Properties" methods

737

1341

if (if_tag.getAttribute("name")

752

1356

except (AttributeError, xml.dom.DOMException,

753

1357

xml.parsers.expat.ExpatError) as error:

754

1358

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

755

error)

756

return xmlstring

757

758

759

def datetime_to_dbus (dt, variant_level=0):

1359

exc_info=error)

1360

return xmlstring

1361

1362

try:

1363

dbus.OBJECT_MANAGER_IFACE

1364

except AttributeError:

1365

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

1366

1367

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1368

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

1369

1370

Classes inheriting from this exposes the standard

1371

GetManagedObjects call and the InterfacesAdded and

1372

InterfacesRemoved signals on the standard

1373

"org.freedesktop.DBus.ObjectManager" interface.

1374

1375

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

1376

manually.

1377

"""

1378

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1379

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

1380

def GetManagedObjects(self):

1381

"""This function must be overridden"""

1382

raise NotImplementedError()

1383

1384

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1385

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

1386

def InterfacesAdded(self, object_path, interfaces_and_properties):

1387

pass

1388

1389

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

1390

def InterfacesRemoved(self, object_path, interfaces):

1391

pass

1392

1393

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1394

out_signature = "s",

1395

path_keyword = 'object_path',

1396

connection_keyword = 'connection')

1397

def Introspect(self, object_path, connection):

1398

"""Overloading of standard D-Bus method.

1399

1400

Override return argument name of GetManagedObjects to be

1401

"objpath_interfaces_and_properties"

1402

"""

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

1406

try:

1407

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

1408

1409

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

1410

# Fix argument name for the GetManagedObjects method

1411

if (if_tag.getAttribute("name")

1412

== dbus.OBJECT_MANAGER_IFACE):

1413

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

1414

if (cn.getAttribute("name")

1415

== "GetManagedObjects"):

1416

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

1417

if (arg.getAttribute("direction")

1418

== "out"):

1419

arg.setAttribute(

1420

"name",

1421

"objpath_interfaces"

1422

"_and_properties")

1423

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

1424

document.unlink()

1425

except (AttributeError, xml.dom.DOMException,

1426

xml.parsers.expat.ExpatError) as error:

1427

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

1428

exc_info = error)

1429

return xmlstring

1430

1431

def datetime_to_dbus(dt, variant_level=0):

760

1432

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

761

1433

if dt is None:

762

1434

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

763

return dbus.String(dt.isoformat(),

764

variant_level=variant_level)

765

766

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

767

.__metaclass__):

768

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

769

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

1435

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

1436

1437

1438

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1439

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

1440

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

1441

interface names according to the "alt_interface_names" mapping.

1442

Usage:

1443

1444

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

1445

"net.example.AlternateInterface"})

1446

class SampleDBusObject(dbus.service.Object):

1447

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

1448

def SampleDBusMethod():

1449

pass

1450

1451

The above "SampleDBusMethod" on "SampleDBusObject" will be

1452

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

1453

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

1454

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

1455

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

1456

1457

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

1458

(from DBusObjectWithProperties) and interfaces (from the

1459

dbus_interface_annotations decorator).

770

1460

"""

771

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

772

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

773

# methods, signals, or properties in them

774

for base in (b for b in bases

775

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

776

# Go though all attributes of the base class

777

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

1461

1462

def wrapper(cls):

1463

for orig_interface_name, alt_interface_name in (

1464

alt_interface_names.items()):

1465

attr = {}

1466

interface_names = set()

1467

# Go though all attributes of the class

1468

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

778

1469

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

779

1470

# with the wrong interface name

780

1471

if (not hasattr(attribute, "_dbus_interface")

781

or not attribute._dbus_interface

782

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

1472

or not attribute._dbus_interface.startswith(

1473

orig_interface_name)):

783

1474

continue

784

1475

# Create an alternate D-Bus interface name based on

785

1476

# the current name

786

alt_interface = (attribute._dbus_interface

787

.replace("se.recompile.Mandos",

788

"se.bsnet.fukt.Mandos"))

1477

alt_interface = attribute._dbus_interface.replace(

1478

orig_interface_name, alt_interface_name)

1479

interface_names.add(alt_interface)

789

1480

# Is this a D-Bus signal?

790

1481

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

791

# Extract the original non-method function by

792

# black magic

793

nonmethod_func = (dict(

1482

if sys.version_info.major == 2:

1483

# Extract the original non-method undecorated

1484

# function by black magic

1485

nonmethod_func = (dict(

794

1486

zip(attribute.func_code.co_freevars,

795

attribute.__closure__))["func"]

796

.cell_contents)

1487

attribute.__closure__))

1488

["func"].cell_contents)

1489

else:

1490

nonmethod_func = attribute

797

1491

# Create a new, but exactly alike, function

798

1492

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

799

1493

# with the alternate D-Bus interface name

800

new_function = (dbus.service.signal

801

(alt_interface,

802

attribute._dbus_signature)

803

(types.FunctionType(

804

nonmethod_func.func_code,

805

nonmethod_func.func_globals,

806

nonmethod_func.func_name,

807

nonmethod_func.func_defaults,

808

nonmethod_func.func_closure)))

1494

if sys.version_info.major == 2:

1495

new_function = types.FunctionType(

1496

nonmethod_func.func_code,

1497

nonmethod_func.func_globals,

1498

nonmethod_func.func_name,

1499

nonmethod_func.func_defaults,

1500

nonmethod_func.func_closure)

1501

else:

1502

new_function = types.FunctionType(

1503

nonmethod_func.__code__,

1504

nonmethod_func.__globals__,

1505

nonmethod_func.__name__,

1506

nonmethod_func.__defaults__,

1507

nonmethod_func.__closure__)

1508

new_function = (dbus.service.signal(

1509

alt_interface,

1510

attribute._dbus_signature)(new_function))

1511

# Copy annotations, if any

1512

try:

1513

new_function._dbus_annotations = dict(

1514

attribute._dbus_annotations)

1515

except AttributeError:

1516

pass

809

1517

# Define a creator of a function to call both the

810

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

811

# signals gets sent when the function is called

1518

# original and alternate functions, so both the

1519

# original and alternate signals gets sent when

1520

# the function is called

812

1521

def fixscope(func1, func2):

813

1522

"""This function is a scope container to pass

814

1523

func1 and func2 to the "call_both" function

815

1524

outside of its arguments"""

1525

1526

@functools.wraps(func2)

816

1527

def call_both(*args, **kwargs):

817

1528

"""This function will emit two D-Bus

818

1529

signals by calling func1 and func2"""

819

1530

func1(*args, **kwargs)

820

1531

func2(*args, **kwargs)

1532

# Make wrapper function look like a D-Bus signal

1533

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

1534

if name.startswith("_dbus_"):

1535

setattr(call_both, name, attr)

1536

821

1537

return call_both

822

1538

# Create the "call_both" function and add it to

823

1539

# the class

824

attr[attrname] = fixscope(attribute,

825

new_function)

1540

attr[attrname] = fixscope(attribute, new_function)

826

1541

# Is this a D-Bus method?

827

1542

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

828

1543

# Create a new, but exactly alike, function

829

1544

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

830

1545

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

831

1546

# to the class.

832

attr[attrname] = (dbus.service.method

833

(alt_interface,

834

attribute._dbus_in_signature,

835

attribute._dbus_out_signature)

836

(types.FunctionType

837

(attribute.func_code,

838

attribute.func_globals,

839

attribute.func_name,

840

attribute.func_defaults,

841

attribute.func_closure)))

1547

attr[attrname] = (

1548

dbus.service.method(

1549

alt_interface,

1550

attribute._dbus_in_signature,

1551

attribute._dbus_out_signature)

1552

(types.FunctionType(attribute.func_code,

1553

attribute.func_globals,

1554

attribute.func_name,

1555

attribute.func_defaults,

1556

attribute.func_closure)))

1557

# Copy annotations, if any

1558

try:

1559

attr[attrname]._dbus_annotations = dict(

1560

attribute._dbus_annotations)

1561

except AttributeError:

1562

pass

842

1563

# Is this a D-Bus property?

843

1564

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

844

1565

# Create a new, but exactly alike, function

845

1566

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

846

1567

# property with the alternate D-Bus interface

847

1568

# name. Add it to the class.

848

attr[attrname] = (dbus_service_property

849

(alt_interface,

850

attribute._dbus_signature,

851

attribute._dbus_access,

852

attribute

853

._dbus_get_args_options

854

["byte_arrays"])

855

(types.FunctionType

856

(attribute.func_code,

857

attribute.func_globals,

858

attribute.func_name,

859

attribute.func_defaults,

860

attribute.func_closure)))

861

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

862

1569

attr[attrname] = (dbus_service_property(

1570

alt_interface, attribute._dbus_signature,

1571

attribute._dbus_access,

1572

attribute._dbus_get_args_options

1573

["byte_arrays"])

1574

(types.FunctionType(

1575

attribute.func_code,

1576

attribute.func_globals,

1577

attribute.func_name,

1578

attribute.func_defaults,

1579

attribute.func_closure)))

1580

# Copy annotations, if any

1581

try:

1582

attr[attrname]._dbus_annotations = dict(

1583

attribute._dbus_annotations)

1584

except AttributeError:

1585

pass

1586

# Is this a D-Bus interface?

1587

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

1588

# Create a new, but exactly alike, function

1589

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

1590

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

1591

# to the class.

1592

attr[attrname] = (

1593

dbus_interface_annotations(alt_interface)

1594

(types.FunctionType(attribute.func_code,

1595

attribute.func_globals,

1596

attribute.func_name,

1597

attribute.func_defaults,

1598

attribute.func_closure)))

1599

if deprecate:

1600

# Deprecate all alternate interfaces

1601

iname="_AlternateDBusNames_interface_annotation{}"

1602

for interface_name in interface_names:

1603

1604

@dbus_interface_annotations(interface_name)

1605

def func(self):

1606

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

1607

"true" }

1608

# Find an unused name

1609

for aname in (iname.format(i)

1610

for i in itertools.count()):

1611

if aname not in attr:

1612

attr[aname] = func

1613

break

1614

if interface_names:

1615

# Replace the class with a new subclass of it with

1616

# methods, signals, etc. as created above.

1617

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

1618

(cls, ), attr)

1619

return cls

1620

1621

return wrapper

1622

1623

1624

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

1625

"se.bsnet.fukt.Mandos"})

863

1626

class ClientDBus(Client, DBusObjectWithProperties):

864

1627

"""A Client class using D-Bus

865

1628

869

1632

"""

870

1633

871

1634

runtime_expansions = (Client.runtime_expansions

872

+ ("dbus_object_path",))

1635

+ ("dbus_object_path", ))

1636

1637

_interface = "se.recompile.Mandos.Client"

873

1638

874

1639

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

875

1640

876

1641

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

877

self._approvals_pending = 0

878

1642

self.bus = bus

879

1643

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

880

1644

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

881

1645

# the D-Bus

882

client_object_name = unicode(self.name).translate(

1646

client_object_name = str(self.name).translate(

883

1647

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

884

1648

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

885

self.dbus_object_path = (dbus.ObjectPath

886

("/clients/" + client_object_name))

1649

self.dbus_object_path = dbus.ObjectPath(

1650

"/clients/" + client_object_name)

887

1651

DBusObjectWithProperties.__init__(self, self.bus,

888

1652

self.dbus_object_path)

889

890

def notifychangeproperty(transform_func,

891

dbus_name, type_func=lambda x: x,

892

variant_level=1):

1653

1654

def notifychangeproperty(transform_func, dbus_name,

1655

type_func=lambda x: x,

1656

variant_level=1,

1657

invalidate_only=False,

1658

_interface=_interface):

893

1659

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

894

1660

its changes to DBus.

895

1661

896

1662

transform_fun: Function that takes a value and a variant_level

897

1663

and transforms it to a D-Bus type.

898

1664

dbus_name: D-Bus name of the variable

900

1666

to the D-Bus. Default: no transform

901

1667

variant_level: D-Bus variant level. Default: 1

902

1668

"""

903

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

1669

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

1670

904

1671

def setter(self, value):

905

1672

if hasattr(self, "dbus_object_path"):

906

1673

if (not hasattr(self, attrname) or

907

1674

type_func(getattr(self, attrname, None))

908

1675

!= type_func(value)):

909

dbus_value = transform_func(type_func(value),

910

variant_level

911

=variant_level)

912

self.PropertyChanged(dbus.String(dbus_name),

913

dbus_value)

1676

if invalidate_only:

1677

self.PropertiesChanged(

1678

_interface, dbus.Dictionary(),

1679

dbus.Array((dbus_name, )))

1680

else:

1681

dbus_value = transform_func(

1682

type_func(value),

1683

variant_level = variant_level)

1684

self.PropertyChanged(dbus.String(dbus_name),

1685

dbus_value)

1686

self.PropertiesChanged(

1687

_interface,

1688

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

1689

dbus_value }),

1690

dbus.Array())

914

1691

setattr(self, attrname, value)

915

1692

916

1693

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

917

1694

918

919

1695

expires = notifychangeproperty(datetime_to_dbus, "Expires")

920

1696

approvals_pending = notifychangeproperty(dbus.Boolean,

921

1697

"ApprovalPending",

923

1699

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

924

1700

last_enabled = notifychangeproperty(datetime_to_dbus,

925

1701

"LastEnabled")

926

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

927

type_func = lambda checker:

928

checker is not None)

1702

checker = notifychangeproperty(

1703

dbus.Boolean, "CheckerRunning",

1704

type_func = lambda checker: checker is not None)

929

1705

last_checked_ok = notifychangeproperty(datetime_to_dbus,

930

1706

"LastCheckedOK")

1707

last_checker_status = notifychangeproperty(dbus.Int16,

1708

"LastCheckerStatus")

931

1709

last_approval_request = notifychangeproperty(

932

1710

datetime_to_dbus, "LastApprovalRequest")

933

1711

approved_by_default = notifychangeproperty(dbus.Boolean,

934

1712

"ApprovedByDefault")

935

approval_delay = notifychangeproperty(dbus.UInt16,

936

"ApprovalDelay",

937

type_func =

938

_timedelta_to_milliseconds)

1713

approval_delay = notifychangeproperty(

1714

dbus.UInt64, "ApprovalDelay",

1715

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

939

1716

approval_duration = notifychangeproperty(

940

dbus.UInt16, "ApprovalDuration",

941

type_func = _timedelta_to_milliseconds)

1717

dbus.UInt64, "ApprovalDuration",

1718

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

942

1719

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

943

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

944

type_func =

945

_timedelta_to_milliseconds)

1720

timeout = notifychangeproperty(

1721

dbus.UInt64, "Timeout",

1722

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

946

1723

extended_timeout = notifychangeproperty(

947

dbus.UInt16, "ExtendedTimeout",

948

type_func = _timedelta_to_milliseconds)

949

interval = notifychangeproperty(dbus.UInt16,

950

"Interval",

951

type_func =

952

_timedelta_to_milliseconds)

1724

dbus.UInt64, "ExtendedTimeout",

1725

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

1726

interval = notifychangeproperty(

1727

dbus.UInt64, "Interval",

1728

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

953

1729

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

1730

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

1731

invalidate_only=True)

954

1732

955

1733

del notifychangeproperty

956

1734

963

1741

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

964

1742

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

965

1743

966

def checker_callback(self, pid, condition, command,

967

*args, **kwargs):

968

self.checker_callback_tag = None

969

self.checker = None

970

if os.WIFEXITED(condition):

971

exitstatus = os.WEXITSTATUS(condition)

1744

def checker_callback(self, source, condition,

1745

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

1746

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

1747

connection, command, *args,

1748

**kwargs)

1749

exitstatus = self.last_checker_status

1750

if exitstatus >= 0:

972

1751

# Emit D-Bus signal

973

1752

self.CheckerCompleted(dbus.Int16(exitstatus),

974

dbus.Int64(condition),

1753

# This is specific to GNU libC

1754

dbus.Int64(exitstatus << 8),

975

1755

dbus.String(command))

976

1756

else:

977

1757

# Emit D-Bus signal

978

1758

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

979

dbus.Int64(condition),

1759

dbus.Int64(

1760

# This is specific to GNU libC

1761

(exitstatus << 8)

1762

| self.last_checker_signal),

980

1763

dbus.String(command))

981

982

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

983

*args, **kwargs)

1764

return ret

984

1765

985

1766

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

986

old_checker = self.checker

987

if self.checker is not None:

988

old_checker_pid = self.checker.pid

989

else:

990

old_checker_pid = None

1767

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

991

1768

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

992

1769

# Only if new checker process was started

993

1770

if (self.checker is not None

997

1774

return r

998

1775

999

1776

def _reset_approved(self):

1000

self._approved = None

1777

self.approved = None

1001

1778

return False

1002

1779

1003

1780

def approve(self, value=True):

1781

self.approved = value

1782

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

1783

* 1000), self._reset_approved)

1004

1784

self.send_changedstate()

1005

self._approved = value

1006

gobject.timeout_add(_timedelta_to_milliseconds

1007

(self.approval_duration),

1008

self._reset_approved)

1009

1010

1785

1011

1786

## D-Bus methods, signals & properties

1012

_interface = "se.recompile.Mandos.Client"

1787

1788

## Interfaces

1013

1789

1014

1790

## Signals

1015

1791

1026

1802

pass

1027

1803

1028

1804

# PropertyChanged - signal

1805

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

1029

1806

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

1030

1807

def PropertyChanged(self, property, value):

1031

1808

"D-Bus signal"

1065

1842

self.checked_ok()

1066

1843

1067

1844

# Enable - method

1845

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

1068

1846

@dbus.service.method(_interface)

1069

1847

def Enable(self):

1070

1848

"D-Bus method"

1071

1849

self.enable()

1072

1850

1073

1851

# StartChecker - method

1852

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

1074

1853

@dbus.service.method(_interface)

1075

1854

def StartChecker(self):

1076

1855

"D-Bus method"

1077

1856

self.start_checker()

1078

1857

1079

1858

# Disable - method

1859

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

1080

1860

@dbus.service.method(_interface)

1081

1861

def Disable(self):

1082

1862

"D-Bus method"

1083

1863

self.disable()

1084

1864

1085

1865

# StopChecker - method

1866

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

1086

1867

@dbus.service.method(_interface)

1087

1868

def StopChecker(self):

1088

1869

self.stop_checker()

1095

1876

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

1096

1877

1097

1878

# ApprovedByDefault - property

1098

@dbus_service_property(_interface, signature="b",

1879

@dbus_service_property(_interface,

1880

signature="b",

1099

1881

access="readwrite")

1100

1882

def ApprovedByDefault_dbus_property(self, value=None):

1101

1883

if value is None: # get

1103

1885

self.approved_by_default = bool(value)

1104

1886

1105

1887

# ApprovalDelay - property

1106

@dbus_service_property(_interface, signature="t",

1888

@dbus_service_property(_interface,

1889

signature="t",

1107

1890

access="readwrite")

1108

1891

def ApprovalDelay_dbus_property(self, value=None):

1109

1892

if value is None: # get

1110

return dbus.UInt64(self.approval_delay_milliseconds())

1893

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

1894

* 1000)

1111

1895

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

1112

1896

1113

1897

# ApprovalDuration - property

1114

@dbus_service_property(_interface, signature="t",

1898

@dbus_service_property(_interface,

1899

signature="t",

1115

1900

access="readwrite")

1116

1901

def ApprovalDuration_dbus_property(self, value=None):

1117

1902

if value is None: # get

1118

return dbus.UInt64(_timedelta_to_milliseconds(

1119

self.approval_duration))

1903

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

1904

* 1000)

1120

1905

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

1121

1906

1122

1907

# Name - property

1908

@dbus_annotations(

1909

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

1123

1910

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

1124

1911

def Name_dbus_property(self):

1125

1912

return dbus.String(self.name)

1126

1913

1127

1914

# Fingerprint - property

1915

@dbus_annotations(

1916

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

1128

1917

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

1129

1918

def Fingerprint_dbus_property(self):

1130

1919

return dbus.String(self.fingerprint)

1131

1920

1132

1921

# Host - property

1133

@dbus_service_property(_interface, signature="s",

1922

@dbus_service_property(_interface,

1923

signature="s",

1134

1924

access="readwrite")

1135

1925

def Host_dbus_property(self, value=None):

1136

1926

if value is None: # get

1137

1927

return dbus.String(self.host)

1138

self.host = value

1928

self.host = str(value)

1139

1929

1140

1930

# Created - property

1931

@dbus_annotations(

1932

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

1141

1933

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

1142

1934

def Created_dbus_property(self):

1143

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

1935

return datetime_to_dbus(self.created)

1144

1936

1145

1937

# LastEnabled - property

1146

1938

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

1148

1940

return datetime_to_dbus(self.last_enabled)

1149

1941

1150

1942

# Enabled - property

1151

@dbus_service_property(_interface, signature="b",

1943

@dbus_service_property(_interface,

1944

signature="b",

1152

1945

access="readwrite")

1153

1946

def Enabled_dbus_property(self, value=None):

1154

1947

if value is None: # get

1159

1952

self.disable()

1160

1953

1161

1954

# LastCheckedOK - property

1162

@dbus_service_property(_interface, signature="s",

1955

@dbus_service_property(_interface,

1956

signature="s",

1163

1957

access="readwrite")

1164

1958

def LastCheckedOK_dbus_property(self, value=None):

1165

1959

if value is not None:

1167

1961

return

1168

1962

return datetime_to_dbus(self.last_checked_ok)

1169

1963

1964

# LastCheckerStatus - property

1965

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

1966

def LastCheckerStatus_dbus_property(self):

1967

return dbus.Int16(self.last_checker_status)

1968

1170

1969

# Expires - property

1171

1970

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

1172

1971

def Expires_dbus_property(self):

1178

1977

return datetime_to_dbus(self.last_approval_request)

1179

1978

1180

1979

# Timeout - property

1181

@dbus_service_property(_interface, signature="t",

1980

@dbus_service_property(_interface,

1981

signature="t",

1182

1982

access="readwrite")

1183

1983

def Timeout_dbus_property(self, value=None):

1184

1984

if value is None: # get

1185

return dbus.UInt64(self.timeout_milliseconds())

1985

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

1986

old_timeout = self.timeout

1186

1987

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

1187

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

1188

return

1189

# Reschedule timeout

1190

gobject.source_remove(self.disable_initiator_tag)

1191

self.disable_initiator_tag = None

1192

self.expires = None

1193

time_to_die = _timedelta_to_milliseconds((self

1194

.last_checked_ok

1195

+ self.timeout)

1196

- datetime.datetime

1197

.utcnow())

1198

if time_to_die <= 0:

1199

# The timeout has passed

1200

self.disable()

1201

else:

1202

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

1203

+ datetime.timedelta(milliseconds =

1204

time_to_die))

1205

self.disable_initiator_tag = (gobject.timeout_add

1206

(time_to_die, self.disable))

1988

# Reschedule disabling

1989

if self.enabled:

1990

now = datetime.datetime.utcnow()

1991

self.expires += self.timeout - old_timeout

1992

if self.expires <= now:

1993

# The timeout has passed

1994

self.disable()

1995

else:

1996

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

1997

is None):

1998

return

1999

gobject.source_remove(self.disable_initiator_tag)

2000

self.disable_initiator_tag = gobject.timeout_add(

2001

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

2002

self.disable)

1207

2003

1208

2004

# ExtendedTimeout - property

1209

@dbus_service_property(_interface, signature="t",

2005

@dbus_service_property(_interface,

2006

signature="t",

1210

2007

access="readwrite")

1211

2008

def ExtendedTimeout_dbus_property(self, value=None):

1212

2009

if value is None: # get

1213

return dbus.UInt64(self.extended_timeout_milliseconds())

2010

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

2011

* 1000)

1214

2012

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

1215

2013

1216

2014

# Interval - property

1217

@dbus_service_property(_interface, signature="t",

2015

@dbus_service_property(_interface,

2016

signature="t",

1218

2017

access="readwrite")

1219

2018

def Interval_dbus_property(self, value=None):

1220

2019

if value is None: # get

1221

return dbus.UInt64(self.interval_milliseconds())

2020

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

1222

2021

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

1223

2022

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

1224

2023

return

1225

# Reschedule checker run

1226

gobject.source_remove(self.checker_initiator_tag)

1227

self.checker_initiator_tag = (gobject.timeout_add

1228

(value, self.start_checker))

1229

self.start_checker() # Start one now, too

2024

if self.enabled:

2025

# Reschedule checker run

2026

gobject.source_remove(self.checker_initiator_tag)

2027

self.checker_initiator_tag = gobject.timeout_add(

2028

value, self.start_checker)

2029

self.start_checker() # Start one now, too

1230

2030

1231

2031

# Checker - property

1232

@dbus_service_property(_interface, signature="s",

2032

@dbus_service_property(_interface,

2033

signature="s",

1233

2034

access="readwrite")

1234

2035

def Checker_dbus_property(self, value=None):

1235

2036

if value is None: # get

1236

2037

return dbus.String(self.checker_command)

1237

self.checker_command = value

2038

self.checker_command = str(value)

1238

2039

1239

2040

# CheckerRunning - property

1240

@dbus_service_property(_interface, signature="b",

2041

@dbus_service_property(_interface,

2042

signature="b",

1241

2043

access="readwrite")

1242

2044

def CheckerRunning_dbus_property(self, value=None):

1243

2045

if value is None: # get

1248

2050

self.stop_checker()

1249

2051

1250

2052

# ObjectPath - property

2053

@dbus_annotations(

2054

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

2055

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

1251

2056

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

1252

2057

def ObjectPath_dbus_property(self):

1253

2058

return self.dbus_object_path # is already a dbus.ObjectPath

1254

2059

1255

2060

# Secret = property

1256

@dbus_service_property(_interface, signature="ay",

1257

access="write", byte_arrays=True)

2061

@dbus_annotations(

2062

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

2063

"invalidates"})

2064

@dbus_service_property(_interface,

2065

signature="ay",

2066

access="write",

2067

byte_arrays=True)

1258

2068

def Secret_dbus_property(self, value):

1259

self.secret = str(value)

2069

self.secret = bytes(value)

1260

2070

1261

2071

del _interface

1262

2072

1266

2076

self._pipe = child_pipe

1267

2077

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

1268

2078

if not self._pipe.recv():

1269

raise KeyError()

2079

raise KeyError(fpr)

1270

2080

1271

2081

def __getattribute__(self, name):

1272

if(name == '_pipe'):

2082

if name == '_pipe':

1273

2083

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

1274

2084

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

1275

2085

data = self._pipe.recv()

1276

2086

if data[0] == 'data':

1277

2087

return data[1]

1278

2088

if data[0] == 'function':

2089

1279

2090

def func(*args, **kwargs):

1280

2091

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

1281

2092

return self._pipe.recv()[1]

2093

1282

2094

return func

1283

2095

1284

2096

def __setattr__(self, name, value):

1285

if(name == '_pipe'):

2097

if name == '_pipe':

1286

2098

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

1287

2099

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

1288

2100

1289

class ClientDBusTransitional(ClientDBus):

1290

__metaclass__ = AlternateDBusNamesMetaclass

1291

2101

1292

2102

class ClientHandler(socketserver.BaseRequestHandler, object):

1293

2103

"""A class to handle client connections.

1298

2108

def handle(self):

1299

2109

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

1300

2110

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

1301

unicode(self.client_address))

2111

str(self.client_address))

1302

2112

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

1303

2113

self.server.child_pipe.fileno())

1304

2114

1305

session = (gnutls.connection

1306

.ClientSession(self.request,

1307

gnutls.connection

1308

.X509Credentials()))

1309

1310

# Note: gnutls.connection.X509Credentials is really a

1311

# generic GnuTLS certificate credentials object so long as

1312

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

1313

# here despite using OpenPGP certificates.

2115

session = gnutls.ClientSession(self.request)

1314

2116

1315

2117

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

1316

2118

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

1320

2122

priority = self.server.gnutls_priority

1321

2123

if priority is None:

1322

2124

priority = "NORMAL"

1323

(gnutls.library.functions

1324

.gnutls_priority_set_direct(session._c_object,

1325

priority, None))

2125

gnutls.priority_set_direct(session._c_object, priority,

2126

None)

1326

2127

1327

2128

# Start communication using the Mandos protocol

1328

2129

# Get protocol number

1330

2131

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

1331

2132

try:

1332

2133

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

1333

raise RuntimeError

2134

raise RuntimeError(line)

1334

2135

except (ValueError, IndexError, RuntimeError) as error:

1335

2136

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

1336

2137

return

1338

2139

# Start GnuTLS connection

1339

2140

try:

1340

2141

session.handshake()

1341

except gnutls.errors.GNUTLSError as error:

2142

except gnutls.Error as error:

1342

2143

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

1343

2144

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

1344

2145

# established. Just abandon the request.

1348

2149

approval_required = False

1349

2150

try:

1350

2151

try:

1351

fpr = self.fingerprint(self.peer_certificate

1352

(session))

1353

except (TypeError,

1354

gnutls.errors.GNUTLSError) as error:

2152

fpr = self.fingerprint(

2153

self.peer_certificate(session))

2154

except (TypeError, gnutls.Error) as error:

1355

2155

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

1356

2156

return

1357

2157

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

1370

2170

while True:

1371

2171

if not client.enabled:

1372

2172

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

1373

client.name)

2173

client.name)

1374

2174

if self.server.use_dbus:

1375

2175

# Emit D-Bus signal

1376

2176

client.Rejected("Disabled")

1377

2177

return

1378

2178

1379

if client._approved or not client.approval_delay:

2179

if client.approved or not client.approval_delay:

1380

2180

#We are approved or approval is disabled

1381

2181

break

1382

elif client._approved is None:

2182

elif client.approved is None:

1383

2183

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

1384

2184

client.name)

1385

2185

if self.server.use_dbus:

1386

2186

# Emit D-Bus signal

1387

2187

client.NeedApproval(

1388

client.approval_delay_milliseconds(),

1389

client.approved_by_default)

2188

client.approval_delay.total_seconds()

2189

* 1000, client.approved_by_default)

1390

2190

else:

1391

2191

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

1392

2192

client.name)

1398

2198

#wait until timeout or approved

1399

2199

time = datetime.datetime.now()

1400

2200

client.changedstate.acquire()

1401

(client.changedstate.wait

1402

(float(client._timedelta_to_milliseconds(delay)

1403

/ 1000)))

2201

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

1404

2202

client.changedstate.release()

1405

2203

time2 = datetime.datetime.now()

1406

2204

if (time2 - time) >= delay:

1421

2219

while sent_size < len(client.secret):

1422

2220

try:

1423

2221

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

1424

except gnutls.errors.GNUTLSError as error:

1425

logger.warning("gnutls send failed")

2222

except gnutls.Error as error:

2223

logger.warning("gnutls send failed",

2224

exc_info=error)

1426

2225

return

1427

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

1428

sent, len(client.secret)

1429

- (sent_size + sent))

2226

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

2227

len(client.secret) - (sent_size

2228

+ sent))

1430

2229

sent_size += sent

1431

2230

1432

2231

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

1433

2232

# bump the timeout using extended_timeout

1434

client.checked_ok(client.extended_timeout)

2233

client.bump_timeout(client.extended_timeout)

1435

2234

if self.server.use_dbus:

1436

2235

# Emit D-Bus signal

1437

2236

client.GotSecret()

1441

2240

client.approvals_pending -= 1

1442

2241

try:

1443

2242

session.bye()

1444

except gnutls.errors.GNUTLSError as error:

1445

logger.warning("GnuTLS bye failed")

2243

except gnutls.Error as error:

2244

logger.warning("GnuTLS bye failed",

2245

exc_info=error)

1446

2246

1447

2247

@staticmethod

1448

2248

def peer_certificate(session):

1449

2249

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

1450

2250

# If not an OpenPGP certificate...

1451

if (gnutls.library.functions

1452

.gnutls_certificate_type_get(session._c_object)

1453

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1454

# ...do the normal thing

1455

return session.peer_certificate

2251

if (gnutls.certificate_type_get(session._c_object)

2252

!= gnutls.CRT_OPENPGP):

2253

# ...return invalid data

2254

return b""

1456

2255

list_size = ctypes.c_uint(1)

1457

cert_list = (gnutls.library.functions

1458

.gnutls_certificate_get_peers

2256

cert_list = (gnutls.certificate_get_peers

1459

2257

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

1460

2258

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

1461

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

1462

" certificate")

2259

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

1463

2260

if list_size.value == 0:

1464

2261

return None

1465

2262

cert = cert_list[0]

1469

2266

def fingerprint(openpgp):

1470

2267

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1471

2268

# New GnuTLS "datum" with the OpenPGP public key

1472

datum = (gnutls.library.types

1473

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

1474

ctypes.POINTER

1475

(ctypes.c_ubyte)),

1476

ctypes.c_uint(len(openpgp))))

2269

datum = gnutls.datum_t(

2270

ctypes.cast(ctypes.c_char_p(openpgp),

2271

ctypes.POINTER(ctypes.c_ubyte)),

2272

ctypes.c_uint(len(openpgp)))

1477

2273

# New empty GnuTLS certificate

1478

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1479

(gnutls.library.functions

1480

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2274

crt = gnutls.openpgp_crt_t()

2275

gnutls.openpgp_crt_init(ctypes.byref(crt))

1481

2276

# Import the OpenPGP public key into the certificate

1482

(gnutls.library.functions

1483

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

1484

gnutls.library.constants

1485

.GNUTLS_OPENPGP_FMT_RAW))

2277

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

2278

gnutls.OPENPGP_FMT_RAW)

1486

2279

# Verify the self signature in the key

1487

2280

crtverify = ctypes.c_uint()

1488

(gnutls.library.functions

1489

.gnutls_openpgp_crt_verify_self(crt, 0,

1490

ctypes.byref(crtverify)))

2281

gnutls.openpgp_crt_verify_self(crt, 0,

2282

ctypes.byref(crtverify))

1491

2283

if crtverify.value != 0:

1492

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1493

raise (gnutls.errors.CertificateSecurityError

1494

("Verify failed"))

2284

gnutls.openpgp_crt_deinit(crt)

2285

raise gnutls.CertificateSecurityError("Verify failed")

1495

2286

# New buffer for the fingerprint

1496

2287

buf = ctypes.create_string_buffer(20)

1497

2288

buf_len = ctypes.c_size_t()

1498

2289

# Get the fingerprint from the certificate into the buffer

1499

(gnutls.library.functions

1500

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

1501

ctypes.byref(buf_len)))

2290

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

2291

ctypes.byref(buf_len))

1502

2292

# Deinit the certificate

1503

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2293

gnutls.openpgp_crt_deinit(crt)

1504

2294

# Convert the buffer to a Python bytestring

1505

2295

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

1506

2296

# Convert the bytestring to hexadecimal notation

1507

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

2297

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

1508

2298

return hex_fpr

1509

2299

1510

2300

1511

2301

class MultiprocessingMixIn(object):

1512

2302

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

2303

1513

2304

def sub_process_main(self, request, address):

1514

2305

try:

1515

2306

self.finish_request(request, address)

1516

except:

2307

except Exception:

1517

2308

self.handle_error(request, address)

1518

2309

self.close_request(request)

1519

2310

1520

2311

def process_request(self, request, address):

1521

2312

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

1522

2313

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

1523

args = (request,

1524

address))

2314

args = (request, address))

1525

2315

proc.start()

1526

2316

return proc

1527

2317

1528

2318

1529

2319

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1530

2320

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

2321

1531

2322

def process_request(self, request, client_address):

1532

2323

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

1533

2324

1542

2333

1543

2334

def add_pipe(self, parent_pipe, proc):

1544

2335

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

1545

raise NotImplementedError

2336

raise NotImplementedError()

1546

2337

1547

2338

1548

2339

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1554

2345

interface: None or a network interface name (string)

1555

2346

use_ipv6: Boolean; to use IPv6 or not

1556

2347

"""

2348

1557

2349

def __init__(self, server_address, RequestHandlerClass,

1558

interface=None, use_ipv6=True):

2350

interface=None,

2351

use_ipv6=True,

2352

socketfd=None):

2353

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

2354

creating a new one with socket.socket().

2355

"""

1559

2356

self.interface = interface

1560

2357

if use_ipv6:

1561

2358

self.address_family = socket.AF_INET6

2359

if socketfd is not None:

2360

# Save the file descriptor

2361

self.socketfd = socketfd

2362

# Save the original socket.socket() function

2363

self.socket_socket = socket.socket

2364

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

2365

#

2366

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

2367

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

2368

# patching socket.socket.)

2369

#

2370

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

2371

@functools.wraps(socket.socket)

2372

def socket_wrapper(*args, **kwargs):

2373

# Restore original function so subsequent calls are

2374

# not affected.

2375

socket.socket = self.socket_socket

2376

del self.socket_socket

2377

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

2378

# saved file descriptor.

2379

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

2380

# Replace socket.socket() function with wrapper

2381

socket.socket = socket_wrapper

2382

# The socketserver.TCPServer.__init__ will call

2383

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

2384

# socket_wrapper(), if socketfd was set.

1562

2385

socketserver.TCPServer.__init__(self, server_address,

1563

2386

RequestHandlerClass)

2387

1564

2388

def server_bind(self):

1565

2389

"""This overrides the normal server_bind() function

1566

2390

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

1572

2396

self.interface)

1573

2397

else:

1574

2398

try:

1575

self.socket.setsockopt(socket.SOL_SOCKET,

1576

SO_BINDTODEVICE,

1577

str(self.interface

1578

+ '\0'))

2399

self.socket.setsockopt(

2400

socket.SOL_SOCKET, SO_BINDTODEVICE,

2401

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

1579

2402

except socket.error as error:

1580

if error[0] == errno.EPERM:

1581

logger.error("No permission to"

1582

" bind to interface %s",

1583

self.interface)

1584

elif error[0] == errno.ENOPROTOOPT:

2403

if error.errno == errno.EPERM:

2404

logger.error("No permission to bind to"

2405

" interface %s", self.interface)

2406

elif error.errno == errno.ENOPROTOOPT:

1585

2407

logger.error("SO_BINDTODEVICE not available;"

1586

2408

" cannot bind to interface %s",

1587

2409

self.interface)

2410

elif error.errno == errno.ENODEV:

2411

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

2412

" cannot bind", self.interface)

1588

2413

else:

1589

2414

raise

1590

2415

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

1593

2418

if self.address_family == socket.AF_INET6:

1594

2419

any_address = "::" # in6addr_any

1595

2420

else:

1596

any_address = socket.INADDR_ANY

2421

any_address = "0.0.0.0" # INADDR_ANY

1597

2422

self.server_address = (any_address,

1598

2423

self.server_address[1])

1599

2424

elif not self.server_address[1]:

1600

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

1601

0)

2425

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

1602

2426

# if self.interface:

1603

2427

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

1604

2428

# 0, # port

1618

2442

1619

2443

Assumes a gobject.MainLoop event loop.

1620

2444

"""

2445

1621

2446

def __init__(self, server_address, RequestHandlerClass,

1622

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

1623

gnutls_priority=None, use_dbus=True):

2447

interface=None,

2448

use_ipv6=True,

2449

clients=None,

2450

gnutls_priority=None,

2451

use_dbus=True,

2452

socketfd=None):

1624

2453

self.enabled = False

1625

2454

self.clients = clients

1626

2455

if self.clients is None:

1627

self.clients = set()

2456

self.clients = {}

1628

2457

self.use_dbus = use_dbus

1629

2458

self.gnutls_priority = gnutls_priority

1630

2459

IPv6_TCPServer.__init__(self, server_address,

1631

2460

RequestHandlerClass,

1632

2461

interface = interface,

1633

use_ipv6 = use_ipv6)

2462

use_ipv6 = use_ipv6,

2463

socketfd = socketfd)

2464

1634

2465

def server_activate(self):

1635

2466

if self.enabled:

1636

2467

return socketserver.TCPServer.server_activate(self)

1640

2471

1641

2472

def add_pipe(self, parent_pipe, proc):

1642

2473

# Call "handle_ipc" for both data and EOF events

1643

gobject.io_add_watch(parent_pipe.fileno(),

1644

gobject.IO_IN | gobject.IO_HUP,

1645

functools.partial(self.handle_ipc,

1646

parent_pipe =

1647

parent_pipe,

1648

proc = proc))

2474

gobject.io_add_watch(

2475

parent_pipe.fileno(),

2476

gobject.IO_IN | gobject.IO_HUP,

2477

functools.partial(self.handle_ipc,

2478

parent_pipe = parent_pipe,

2479

proc = proc))

1649

2480

1650

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

1651

proc = None, client_object=None):

1652

condition_names = {

1653

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

1654

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

1655

# blocking).

1656

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

1657

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

1658

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

1659

# broken, usually for pipes and

1660

# sockets).

1661

}

1662

conditions_string = ' | '.join(name

1663

for cond, name in

1664

condition_names.iteritems()

1665

if cond & condition)

2481

def handle_ipc(self, source, condition,

2482

parent_pipe=None,

2483

proc = None,

2484

client_object=None):

1666

2485

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

1667

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

2486

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

1668

2487

# Wait for other process to exit

1669

2488

proc.join()

1670

2489

return False

1677

2496

fpr = request[1]

1678

2497

address = request[2]

1679

2498

1680

for c in self.clients:

2499

for c in self.clients.itervalues():

1681

2500

if c.fingerprint == fpr:

1682

2501

client = c

1683

2502

break

1691

2510

parent_pipe.send(False)

1692

2511

return False

1693

2512

1694

gobject.io_add_watch(parent_pipe.fileno(),

1695

gobject.IO_IN | gobject.IO_HUP,

1696

functools.partial(self.handle_ipc,

1697

parent_pipe =

1698

parent_pipe,

1699

proc = proc,

1700

client_object =

1701

client))

2513

gobject.io_add_watch(

2514

parent_pipe.fileno(),

2515

gobject.IO_IN | gobject.IO_HUP,

2516

functools.partial(self.handle_ipc,

2517

parent_pipe = parent_pipe,

2518

proc = proc,

2519

client_object = client))

1702

2520

parent_pipe.send(True)

1703

2521

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

1704

2522

# same fileno

1710

2528

1711

2529

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

1712

2530

funcname)(*args,

1713

**kwargs)))

2531

**kwargs)))

1714

2532

1715

2533

if command == 'getattr':

1716

2534

attrname = request[1]

1717

if callable(client_object.__getattribute__(attrname)):

1718

parent_pipe.send(('function',))

2535

if isinstance(client_object.__getattribute__(attrname),

2536

collections.Callable):

2537

parent_pipe.send(('function', ))

1719

2538

else:

1720

parent_pipe.send(('data', client_object

1721

.__getattribute__(attrname)))

2539

parent_pipe.send((

2540

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

1722

2541

1723

2542

if command == 'setattr':

1724

2543

attrname = request[1]

1728

2547

return True

1729

2548

1730

2549

2550

def rfc3339_duration_to_delta(duration):

2551

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

2552

2553

>>> rfc3339_duration_to_delta("P7D")

2554

datetime.timedelta(7)

2555

>>> rfc3339_duration_to_delta("PT60S")

2556

datetime.timedelta(0, 60)

2557

>>> rfc3339_duration_to_delta("PT60M")

2558

datetime.timedelta(0, 3600)

2559

>>> rfc3339_duration_to_delta("PT24H")

2560

datetime.timedelta(1)

2561

>>> rfc3339_duration_to_delta("P1W")

2562

datetime.timedelta(7)

2563

>>> rfc3339_duration_to_delta("PT5M30S")

2564

datetime.timedelta(0, 330)

2565

>>> rfc3339_duration_to_delta("P1DT3M20S")

2566

datetime.timedelta(1, 200)

2567

"""

2568

2569

# Parsing an RFC 3339 duration with regular expressions is not

2570

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

2571

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

2572

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

2573

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

2574

# avoid excessive use of external libraries.

2575

2576

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

2577

Token = collections.namedtuple("Token", (

2578

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

2579

# a "group" containing digits

2580

"value", # datetime.timedelta or None

2581

"followers")) # Tokens valid after this token

2582

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

2583

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

2584

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

2585

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

2586

datetime.timedelta(seconds=1),

2587

frozenset((token_end, )))

2588

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

2589

datetime.timedelta(minutes=1),

2590

frozenset((token_second, token_end)))

2591

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

2592

datetime.timedelta(hours=1),

2593

frozenset((token_minute, token_end)))

2594

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

2595

None,

2596

frozenset((token_hour, token_minute,

2597

token_second)))

2598

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

2599

datetime.timedelta(days=1),

2600

frozenset((token_time, token_end)))

2601

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

2602

datetime.timedelta(weeks=4),

2603

frozenset((token_day, token_end)))

2604

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

2605

datetime.timedelta(weeks=52),

2606

frozenset((token_month, token_end)))

2607

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

2608

datetime.timedelta(weeks=1),

2609

frozenset((token_end, )))

2610

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

2611

frozenset((token_year, token_month,

2612

token_day, token_time,

2613

token_week)))

2614

# Define starting values

2615

value = datetime.timedelta() # Value so far

2616

found_token = None

2617

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

2618

s = duration # String left to parse

2619

# Loop until end token is found

2620

while found_token is not token_end:

2621

# Search for any currently valid tokens

2622

for token in followers:

2623

match = token.regexp.match(s)

2624

if match is not None:

2625

# Token found

2626

if token.value is not None:

2627

# Value found, parse digits

2628

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

2629

# Add to value so far

2630

value += factor * token.value

2631

# Strip token from string

2632

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

2633

# Go to found token

2634

found_token = token

2635

# Set valid next tokens

2636

followers = found_token.followers

2637

break

2638

else:

2639

# No currently valid tokens were found

2640

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

2641

.format(duration))

2642

# End token found

2643

return value

2644

2645

1731

2646

def string_to_delta(interval):

1732

2647

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

1733

2648

1744

2659

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

1745

2660

datetime.timedelta(0, 330)

1746

2661

"""

2662

2663

try:

2664

return rfc3339_duration_to_delta(interval)

2665

except ValueError:

2666

pass

2667

1747

2668

timevalue = datetime.timedelta(0)

1748

2669

for s in interval.split():

1749

2670

try:

1750

suffix = unicode(s[-1])

2671

suffix = s[-1]

1751

2672

value = int(s[:-1])

1752

2673

if suffix == "d":

1753

2674

delta = datetime.timedelta(value)

1760

2681

elif suffix == "w":

1761

2682

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

1762

2683

else:

1763

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

1764

except (ValueError, IndexError) as e:

2684

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

2685

except IndexError as e:

1765

2686

raise ValueError(*(e.args))

1766

2687

timevalue += delta

1767

2688

return timevalue

1768

2689

1769

2690

1770

def if_nametoindex(interface):

1771

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

1772

1773

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

1774

global if_nametoindex

1775

try:

1776

if_nametoindex = (ctypes.cdll.LoadLibrary

1777

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

1778

.if_nametoindex)

1779

except (OSError, AttributeError):

1780

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

1781

def if_nametoindex(interface):

1782

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

1783

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

1784

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

1785

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1786

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

1787

interface))

1788

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

1789

ifreq[16:20])[0]

1790

return interface_index

1791

return if_nametoindex(interface)

1792

1793

1794

2691

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

1795

2692

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

1796

2693

1804

2701

sys.exit()

1805

2702

if not noclose:

1806

2703

# Close all standard open file descriptors

1807

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

2704

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

1808

2705

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

1809

2706

raise OSError(errno.ENODEV,

1810

"%s not a character device"

1811

% os.path.devnull)

2707

"{} not a character device"

2708

.format(os.devnull))

1812

2709

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

1813

2710

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

1814

2711

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

1823

2720

1824

2721

parser = argparse.ArgumentParser()

1825

2722

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

1826

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

2723

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

1827

2724

help="show version number and exit")

1828

2725

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

1829

2726

help="Bind to interface IF")

1835

2732

help="Run self-test")

1836

2733

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

1837

2734

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

1838

" to terminal")

2735

" to terminal", default=None)

1839

2736

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

1840

2737

help="Debug level for stdout output")

1841

2738

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

1848

2745

" files")

1849

2746

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

1850

2747

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

1851

" system bus interface")

2748

" system bus interface", default=None)

1852

2749

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

1853

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

2750

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

2751

default=None)

2752

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

2753

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

2754

" state", default=None)

2755

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

2756

help="Specify a file descriptor to a network"

2757

" socket to use instead of creating one")

2758

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

2759

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

2760

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

2761

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

2762

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

2763

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

2764

default=None)

2765

1854

2766

options = parser.parse_args()

1855

2767

1856

2768

if options.check:

1857

2769

import doctest

1858

doctest.testmod()

1859

sys.exit()

2770

fail_count, test_count = doctest.testmod()

2771

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

1860

2772

1861

2773

# Default values for config file for server-global settings

1862

2774

server_defaults = { "interface": "",

1864

2776

"port": "",

1865

2777

"debug": "False",

1866

2778

"priority":

1867

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

2779

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

2780

":+SIGN-DSA-SHA256",

1868

2781

"servicename": "Mandos",

1869

2782

"use_dbus": "True",

1870

2783

"use_ipv6": "True",

1871

2784

"debuglevel": "",

1872

}

2785

"restore": "True",

2786

"socket": "",

2787

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

2788

"foreground": "False",

2789

"zeroconf": "True",

2790

}

1873

2791

1874

2792

# Parse config file for server-global settings

1875

2793

server_config = configparser.SafeConfigParser(server_defaults)

1876

2794

del server_defaults

1877

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

1878

"mandos.conf"))

2795

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

1879

2796

# Convert the SafeConfigParser object to a dict

1880

2797

server_settings = server_config.defaults()

1881

2798

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

1882

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

2799

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

1883

2800

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

1884

2801

option)

1885

2802

if server_settings["port"]:

1886

2803

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

1887

2804

"port")

2805

if server_settings["socket"]:

2806

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

2807

"socket")

2808

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

2809

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

2810

# happen with a supplied network socket.

2811

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

2812

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

2813

["socket"])

1888

2814

del server_config

1889

2815

1890

2816

# Override the settings from the config file with command line

1891

2817

# options, if set.

1892

2818

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

1893

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

1894

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

2819

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

2820

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

2821

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

1895

2822

value = getattr(options, option)

1896

2823

if value is not None:

1897

2824

server_settings[option] = value

1898

2825

del options

1899

2826

# Force all strings to be unicode

1900

2827

for option in server_settings.keys():

1901

if type(server_settings[option]) is str:

1902

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

2828

if isinstance(server_settings[option], bytes):

2829

server_settings[option] = (server_settings[option]

2830

.decode("utf-8"))

2831

# Force all boolean options to be boolean

2832

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

2833

"foreground", "zeroconf"):

2834

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

2835

# Debug implies foreground

2836

if server_settings["debug"]:

2837

server_settings["foreground"] = True

1903

2838

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

1904

2839

1905

2840

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

1906

2841

2842

if (not server_settings["zeroconf"]

2843

and not (server_settings["port"]

2844

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

2845

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

2846

1907

2847

# For convenience

1908

2848

debug = server_settings["debug"]

1909

2849

debuglevel = server_settings["debuglevel"]

1910

2850

use_dbus = server_settings["use_dbus"]

1911

2851

use_ipv6 = server_settings["use_ipv6"]

2852

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

2853

stored_state_file)

2854

foreground = server_settings["foreground"]

2855

zeroconf = server_settings["zeroconf"]

2856

2857

if debug:

2858

initlogger(debug, logging.DEBUG)

2859

else:

2860

if not debuglevel:

2861

initlogger(debug)

2862

else:

2863

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

2864

initlogger(debug, level)

1912

2865

1913

2866

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

1914

syslogger.setFormatter(logging.Formatter

1915

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

1916

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

1917

% server_settings["servicename"]))

2867

syslogger.setFormatter(

2868

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

2869

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

2870

server_settings["servicename"])))

1918

2871

1919

2872

# Parse config file with clients

1920

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

1921

"extended_timeout": "15m",

1922

"interval": "2m",

1923

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

1924

"host": "",

1925

"approval_delay": "0s",

1926

"approval_duration": "1s",

1927

}

1928

client_config = configparser.SafeConfigParser(client_defaults)

2873

client_config = configparser.SafeConfigParser(Client

2874

.client_defaults)

1929

2875

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

1930

2876

"clients.conf"))

1931

2877

1932

2878

global mandos_dbus_service

1933

2879

mandos_dbus_service = None

1934

2880

1935

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

1936

server_settings["port"]),

1937

ClientHandler,

1938

interface=(server_settings["interface"]

1939

or None),

1940

use_ipv6=use_ipv6,

1941

gnutls_priority=

1942

server_settings["priority"],

1943

use_dbus=use_dbus)

1944

if not debug:

1945

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

2881

socketfd = None

2882

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

2883

socketfd = server_settings["socket"]

2884

tcp_server = MandosServer(

2885

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

2886

ClientHandler,

2887

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

2888

use_ipv6=use_ipv6,

2889

gnutls_priority=server_settings["priority"],

2890

use_dbus=use_dbus,

2891

socketfd=socketfd)

2892

if not foreground:

2893

pidfilename = "/run/mandos.pid"

2894

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

2895

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

2896

pidfile = None

1946

2897

try:

1947

pidfile = open(pidfilename, "w")

1948

except IOError:

1949

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

2898

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

2899

except IOError as e:

2900

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

2901

exc_info=e)

1950

2902

1951

try:

1952

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

1953

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

1954

except KeyError:

2903

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

1955

2904

try:

1956

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

1957

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

2905

uid = pwd.getpwnam(name).pw_uid

2906

gid = pwd.getpwnam(name).pw_gid

2907

break

1958

2908

except KeyError:

1959

try:

1960

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

1961

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

1962

except KeyError:

1963

uid = 65534

1964

gid = 65534

2909

continue

2910

else:

2911

uid = 65534

2912

gid = 65534

1965

2913

try:

1966

2914

os.setgid(gid)

1967

2915

os.setuid(uid)

1968

2916

except OSError as error:

1969

if error[0] != errno.EPERM:

1970

raise error

1971

1972

if not debug and not debuglevel:

1973

syslogger.setLevel(logging.WARNING)

1974

console.setLevel(logging.WARNING)

1975

if debuglevel:

1976

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

1977

syslogger.setLevel(level)

1978

console.setLevel(level)

2917

if error.errno != errno.EPERM:

2918

raise

1979

2919

1980

2920

if debug:

1981

2921

# Enable all possible GnuTLS debugging

1982

2922

1983

2923

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

1984

2924

# - GnuTLS manual

1985

gnutls.library.functions.gnutls_global_set_log_level(11)

2925

gnutls.global_set_log_level(11)

1986

2926

1987

@gnutls.library.types.gnutls_log_func

2927

@gnutls.log_func

1988

2928

def debug_gnutls(level, string):

1989

2929

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

1990

2930

1991

(gnutls.library.functions

1992

.gnutls_global_set_log_function(debug_gnutls))

2931

gnutls.global_set_log_function(debug_gnutls)

1993

2932

1994

2933

# Redirect stdin so all checkers get /dev/null

1995

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

2934

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

1996

2935

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

1997

2936

if null > 2:

1998

2937

os.close(null)

1999

else:

2000

# No console logging

2001

logger.removeHandler(console)

2002

2938

2003

2939

# Need to fork before connecting to D-Bus

2004

if not debug:

2940

if not foreground:

2005

2941

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

2006

2942

daemon()

2007

2943

2944

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

2945

# need to inform gobject that threads will be used.

2946

gobject.threads_init()

2947

2008

2948

global main_loop

2009

2949

# From the Avahi example code

2010

DBusGMainLoop(set_as_default=True )

2950

DBusGMainLoop(set_as_default=True)

2011

2951

main_loop = gobject.MainLoop()

2012

2952

bus = dbus.SystemBus()

2013

2953

# End of Avahi example code

2014

2954

if use_dbus:

2015

2955

try:

2016

2956

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

2017

bus, do_not_queue=True)

2018

old_bus_name = (dbus.service.BusName

2019

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

2020

do_not_queue=True))

2021

except dbus.exceptions.NameExistsException as e:

2022

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

2957

bus,

2958

do_not_queue=True)

2959

old_bus_name = dbus.service.BusName(

2960

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

2961

do_not_queue=True)

2962

except dbus.exceptions.DBusException as e:

2963

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

2023

2964

use_dbus = False

2024

2965

server_settings["use_dbus"] = False

2025

2966

tcp_server.use_dbus = False

2026

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2027

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

2028

servicetype = "_mandos._tcp",

2029

protocol = protocol, bus = bus)

2030

if server_settings["interface"]:

2031

service.interface = (if_nametoindex

2032

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

2967

if zeroconf:

2968

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2969

service = AvahiServiceToSyslog(

2970

name = server_settings["servicename"],

2971

servicetype = "_mandos._tcp",

2972

protocol = protocol,

2973

bus = bus)

2974

if server_settings["interface"]:

2975

service.interface = if_nametoindex(

2976

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

2033

2977

2034

2978

global multiprocessing_manager

2035

2979

multiprocessing_manager = multiprocessing.Manager()

2036

2980

2037

2981

client_class = Client

2038

2982

if use_dbus:

2039

client_class = functools.partial(ClientDBusTransitional,

2040

bus = bus)

2041

def client_config_items(config, section):

2042

special_settings = {

2043

"approved_by_default":

2044

lambda: config.getboolean(section,

2045

"approved_by_default"),

2046

}

2047

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

2983

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

2984

2985

client_settings = Client.config_parser(client_config)

2986

old_client_settings = {}

2987

clients_data = {}

2988

2989

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

2990

global wnull

2991

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

2992

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

2993

# mode

2994

if debug or not foreground:

2995

wnull.close()

2996

2997

# Get client data and settings from last running state.

2998

if server_settings["restore"]:

2999

try:

3000

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

3001

clients_data, old_client_settings = pickle.load(

3002

stored_state)

3003

os.remove(stored_state_path)

3004

except IOError as e:

3005

if e.errno == errno.ENOENT:

3006

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

3007

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

3008

else:

3009

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

3010

exc_info=e)

3011

raise

3012

except EOFError as e:

3013

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

3014

"EOFError:",

3015

exc_info=e)

3016

3017

with PGPEngine() as pgp:

3018

for client_name, client in clients_data.items():

3019

# Skip removed clients

3020

if client_name not in client_settings:

3021

continue

3022

3023

# Decide which value to use after restoring saved state.

3024

# We have three different values: Old config file,

3025

# new config file, and saved state.

3026

# New config value takes precedence if it differs from old

3027

# config value, otherwise use saved state.

3028

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

3029

try:

3030

# For each value in new config, check if it

3031

# differs from the old config value (Except for

3032

# the "secret" attribute)

3033

if (name != "secret"

3034

and (value !=

3035

old_client_settings[client_name][name])):

3036

client[name] = value

3037

except KeyError:

3038

pass

3039

3040

# Clients who has passed its expire date can still be

3041

# enabled if its last checker was successful. A Client

3042

# whose checker succeeded before we stored its state is

3043

# assumed to have successfully run all checkers during

3044

# downtime.

3045

if client["enabled"]:

3046

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

3047

if not client["last_checked_ok"]:

3048

logger.warning(

3049

"disabling client {} - Client never "

3050

"performed a successful checker".format(

3051

client_name))

3052

client["enabled"] = False

3053

elif client["last_checker_status"] != 0:

3054

logger.warning(

3055

"disabling client {} - Client last"

3056

" checker failed with error code"

3057

" {}".format(

3058

client_name,

3059

client["last_checker_status"]))

3060

client["enabled"] = False

3061

else:

3062

client["expires"] = (

3063

datetime.datetime.utcnow()

3064

+ client["timeout"])

3065

logger.debug("Last checker succeeded,"

3066

" keeping {} enabled".format(

3067

client_name))

2048

3068

try:

2049

yield (name, special_settings[name]())

2050

except KeyError:

2051

yield (name, value)

2052

2053

tcp_server.clients.update(set(

2054

client_class(name = section,

2055

config= dict(client_config_items(

2056

client_config, section)))

2057

for section in client_config.sections()))

3069

client["secret"] = pgp.decrypt(

3070

client["encrypted_secret"],

3071

client_settings[client_name]["secret"])

3072

except PGPError:

3073

# If decryption fails, we use secret from new settings

3074

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

3075

client_name))

3076

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

3077

["secret"])

3078

3079

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

3080

for client_name in (set(old_client_settings)

3081

- set(client_settings)):

3082

del clients_data[client_name]

3083

for client_name in (set(client_settings)

3084

- set(old_client_settings)):

3085

clients_data[client_name] = client_settings[client_name]

3086

3087

# Create all client objects

3088

for client_name, client in clients_data.items():

3089

tcp_server.clients[client_name] = client_class(

3090

name = client_name,

3091

settings = client,

3092

server_settings = server_settings)

3093

2058

3094

if not tcp_server.clients:

2059

3095

logger.warning("No clients defined")

2060

2061

if not debug:

2062

try:

2063

with pidfile:

2064

pid = os.getpid()

2065

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

2066

del pidfile

2067

except IOError:

2068

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

2069

pidfilename, pid)

2070

except NameError:

2071

# "pidfile" was never created

2072

pass

3096

3097

if not foreground:

3098

if pidfile is not None:

3099

pid = os.getpid()

3100

try:

3101

with pidfile:

3102

print(pid, file=pidfile)

3103

except IOError:

3104

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

3105

pidfilename, pid)

3106

del pidfile

2073

3107

del pidfilename

2074

2075

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

2076

3108

2077

3109

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

2078

3110

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

2079

3111

2080

3112

if use_dbus:

2081

class MandosDBusService(dbus.service.Object):

3113

3114

@alternate_dbus_interfaces(

3115

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

3116

class MandosDBusService(DBusObjectWithObjectManager):

2082

3117

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

3118

2083

3119

def __init__(self):

2084

3120

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

3121

2085

3122

_interface = "se.recompile.Mandos"

2086

3123

2087

3124

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

2094

3131

"D-Bus signal"

2095

3132

pass

2096

3133

3134

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

3135

"true"})

2097

3136

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

2098

3137

def ClientRemoved(self, objpath, name):

2099

3138

"D-Bus signal"

2100

3139

pass

2101

3140

3141

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

3142

"true"})

2102

3143

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

2103

3144

def GetAllClients(self):

2104

3145

"D-Bus method"

2105

return dbus.Array(c.dbus_object_path

2106

for c in tcp_server.clients)

3146

return dbus.Array(c.dbus_object_path for c in

3147

tcp_server.clients.itervalues())

2107

3148

3149

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

3150

"true"})

2108

3151

@dbus.service.method(_interface,

2109

3152

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

2110

3153

def GetAllClientsWithProperties(self):

2111

3154

"D-Bus method"

2112

3155

return dbus.Dictionary(

2113

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

2114

for c in tcp_server.clients),

3156

{ c.dbus_object_path: c.GetAll(

3157

"se.recompile.Mandos.Client")

3158

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

2115

3159

signature="oa{sv}")

2116

3160

2117

3161

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

2118

3162

def RemoveClient(self, object_path):

2119

3163

"D-Bus method"

2120

for c in tcp_server.clients:

3164

for c in tcp_server.clients.itervalues():

2121

3165

if c.dbus_object_path == object_path:

2122

tcp_server.clients.remove(c)

3166

del tcp_server.clients[c.name]

2123

3167

c.remove_from_connection()

2124

# Don't signal anything except ClientRemoved

3168

# Don't signal the disabling

2125

3169

c.disable(quiet=True)

2126

# Emit D-Bus signal

2127

self.ClientRemoved(object_path, c.name)

3170

# Emit D-Bus signal for removal

3171

self.client_removed_signal(c)

2128

3172

return

2129

3173

raise KeyError(object_path)

2130

3174

2131

3175

del _interface

3176

3177

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3178

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

3179

def GetManagedObjects(self):

3180

"""D-Bus method"""

3181

return dbus.Dictionary(

3182

{ client.dbus_object_path:

3183

dbus.Dictionary(

3184

{ interface: client.GetAll(interface)

3185

for interface in

3186

client._get_all_interface_names()})

3187

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

3188

3189

def client_added_signal(self, client):

3190

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

3191

if use_dbus:

3192

# New standard signal

3193

self.InterfacesAdded(

3194

client.dbus_object_path,

3195

dbus.Dictionary(

3196

{ interface: client.GetAll(interface)

3197

for interface in

3198

client._get_all_interface_names()}))

3199

# Old signal

3200

self.ClientAdded(client.dbus_object_path)

3201

3202

def client_removed_signal(self, client):

3203

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

3204

if use_dbus:

3205

# New standard signal

3206

self.InterfacesRemoved(

3207

client.dbus_object_path,

3208

client._get_all_interface_names())

3209

# Old signal

3210

self.ClientRemoved(client.dbus_object_path,

3211

client.name)

2132

3212

2133

class MandosDBusServiceTransitional(MandosDBusService):

2134

__metaclass__ = AlternateDBusNamesMetaclass

2135

mandos_dbus_service = MandosDBusServiceTransitional()

3213

mandos_dbus_service = MandosDBusService()

2136

3214

2137

3215

def cleanup():

2138

3216

"Cleanup function; run on exit"

2139

service.cleanup()

3217

if zeroconf:

3218

service.cleanup()

2140

3219

2141

3220

multiprocessing.active_children()

3221

wnull.close()

3222

if not (tcp_server.clients or client_settings):

3223

return

3224

3225

# Store client before exiting. Secrets are encrypted with key

3226

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

3227

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

3228

clients = {}

3229

with PGPEngine() as pgp:

3230

for client in tcp_server.clients.itervalues():

3231

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

3232

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

3233

key)

3234

client_dict = {}

3235

3236

# A list of attributes that can not be pickled

3237

# + secret.

3238

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

3239

"checker", "server_settings" }

3240

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

3241

.Object):

3242

exclude.add(name)

3243

3244

client_dict["encrypted_secret"] = (client

3245

.encrypted_secret)

3246

for attr in client.client_structure:

3247

if attr not in exclude:

3248

client_dict[attr] = getattr(client, attr)

3249

3250

clients[client.name] = client_dict

3251

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

3252

3253

try:

3254

with tempfile.NamedTemporaryFile(

3255

mode='wb',

3256

suffix=".pickle",

3257

prefix='clients-',

3258

dir=os.path.dirname(stored_state_path),

3259

delete=False) as stored_state:

3260

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

3261

tempname = stored_state.name

3262

os.rename(tempname, stored_state_path)

3263

except (IOError, OSError) as e:

3264

if not debug:

3265

try:

3266

os.remove(tempname)

3267

except NameError:

3268

pass

3269

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

3270

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

3271

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

3272

else:

3273

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

3274

exc_info=e)

3275

raise

3276

3277

# Delete all clients, and settings from config

2142

3278

while tcp_server.clients:

2143

client = tcp_server.clients.pop()

3279

name, client = tcp_server.clients.popitem()

2144

3280

if use_dbus:

2145

3281

client.remove_from_connection()

2146

client.disable_hook = None

2147

# Don't signal anything except ClientRemoved

3282

# Don't signal the disabling

2148

3283

client.disable(quiet=True)

3284

# Emit D-Bus signal for removal

2149

3285

if use_dbus:

2150

# Emit D-Bus signal

2151

mandos_dbus_service.ClientRemoved(client

2152

.dbus_object_path,

2153

client.name)

3286

mandos_dbus_service.client_removed_signal(client)

3287

client_settings.clear()

2154

3288

2155

3289

atexit.register(cleanup)

2156

3290

2157

for client in tcp_server.clients:

3291

for client in tcp_server.clients.itervalues():

2158

3292

if use_dbus:

2159

# Emit D-Bus signal

2160

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2161

client.enable()

3293

# Emit D-Bus signal for adding

3294

mandos_dbus_service.client_added_signal(client)

3295

# Need to initiate checking of clients

3296

if client.enabled:

3297

client.init_checker()

2162

3298

2163

3299

tcp_server.enable()

2164

3300

tcp_server.server_activate()

2165

3301

2166

3302

# Find out what port we got

2167

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

3303

if zeroconf:

3304

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

2168

3305

if use_ipv6:

2169

3306

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

2170

" flowinfo %d, scope_id %d"

2171

% tcp_server.socket.getsockname())

3307

" flowinfo %d, scope_id %d",

3308

*tcp_server.socket.getsockname())

2172

3309

else: # IPv4

2173

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

2174

% tcp_server.socket.getsockname())

3310

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

3311

*tcp_server.socket.getsockname())

2175

3312

2176

3313

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

2177

3314

2178

3315

try:

2179

# From the Avahi example code

2180

try:

2181

service.activate()

2182

except dbus.exceptions.DBusException as error:

2183

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

2184

cleanup()

2185

sys.exit(1)

2186

# End of Avahi example code

3316

if zeroconf:

3317

# From the Avahi example code

3318

try:

3319

service.activate()

3320

except dbus.exceptions.DBusException as error:

3321

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

3322

cleanup()

3323

sys.exit(1)

3324

# End of Avahi example code

2187

3325

2188

3326

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

2189

3327

lambda *args, **kwargs:

2193

3331

logger.debug("Starting main loop")

2194

3332

main_loop.run()

2195

3333

except AvahiError as error:

2196

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

3334

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

2197

3335

cleanup()

2198

3336

sys.exit(1)

2199

3337

except KeyboardInterrupt: