/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

66

71

import binascii

67

72

import tempfile

73

import itertools

74

import collections

75

import codecs

68

76

69

77

import dbus

70

78

import dbus.service

71

import gobject

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

72

83

import avahi

73

84

from dbus.mainloop.glib import DBusGMainLoop

74

85

import ctypes

75

86

import ctypes.util

76

87

import xml.dom.minidom

77

88

import inspect

78

import GnuPGInterface

79

89

80

90

try:

81

91

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except ImportError:

86

96

SO_BINDTODEVICE = None

87

97

88

version = "1.5.2"

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.1"

89

102

stored_state_file = "clients.pickle"

90

103

91

104

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

105

syslogger = None

95

106

96

107

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

100

110

except (OSError, AttributeError):

111

101

112

def if_nametoindex(interface):

102

113

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

103

114

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

104

115

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

105

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

117

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

118

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

110

119

return interface_index

111

120

112

121

113

122

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

114

123

"""init logger and add loglevel"""

115

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

116

129

syslogger.setFormatter(logging.Formatter

117

130

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

118

131

' %(message)s'))

135

148

136

149

class PGPEngine(object):

137

150

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

151

138

152

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

153

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

self.gnupg.options.extra_args.extend(['--force-mdc',

145

'--quiet',

146

'--no-use-agent'])

154

self.gnupgargs = ['--batch',

155

'--home', self.tempdir,

156

'--force-mdc',

157

'--quiet',

158

'--no-use-agent']

147

159

148

160

def __enter__(self):

149

161

return self

150

162

151

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

163

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

152

164

self._cleanup()

153

165

return False

154

166

171

183

def password_encode(self, password):

172

184

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

173

185

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

174

return b"mandos" + binascii.hexlify(password)

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

175

193

176

194

def encrypt(self, data, password):

177

self.gnupg.passphrase = self.password_encode(password)

178

with open(os.devnull) as devnull:

179

try:

180

proc = self.gnupg.run(['--symmetric'],

181

create_fhs=['stdin', 'stdout'],

182

attach_fhs={'stderr': devnull})

183

with contextlib.closing(proc.handles['stdin']) as f:

184

f.write(data)

185

with contextlib.closing(proc.handles['stdout']) as f:

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

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)

191

210

return ciphertext

192

211

193

212

def decrypt(self, data, password):

194

self.gnupg.passphrase = self.password_encode(password)

195

with open(os.devnull) as devnull:

196

try:

197

proc = self.gnupg.run(['--decrypt'],

198

create_fhs=['stdin', 'stdout'],

199

attach_fhs={'stderr': devnull})

200

with contextlib.closing(proc.handles['stdin'] ) as f:

201

f.write(data)

202

with contextlib.closing(proc.handles['stdout']) as f:

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

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)

208

228

return decrypted_plaintext

209

229

210

230

211

212

231

class AvahiError(Exception):

213

232

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

214

233

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

234

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

235

**kwargs)

236

218

237

219

238

class AvahiServiceError(AvahiError):

220

239

pass

221

240

241

222

242

class AvahiGroupError(AvahiError):

223

243

pass

224

244

231

251

Used to optionally bind to the specified interface.

232

252

name: string; Example: 'Mandos'

233

253

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

234

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

254

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

235

255

port: integer; what port to announce

236

256

TXT: list of strings; TXT record for the service

237

257

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

243

263

server: D-Bus Server

244

264

bus: dbus.SystemBus()

245

265

"""

246

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

247

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

248

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

249

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

250

278

self.interface = interface

251

279

self.name = name

252

280

self.type = servicetype

261

289

self.server = None

262

290

self.bus = bus

263

291

self.entry_group_state_changed_match = None

264

def rename(self):

292

293

def rename(self, remove=True):

265

294

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

266

295

if self.rename_count >= self.max_renames:

267

296

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

268

297

" after %i retries, exiting.",

269

298

self.rename_count)

270

299

raise AvahiServiceError("Too many renames")

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

300

self.name = str(

301

self.server.GetAlternativeServiceName(self.name))

302

self.rename_count += 1

273

303

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

274

304

self.name)

275

self.remove()

305

if remove:

306

self.remove()

276

307

try:

277

308

self.add()

278

309

except dbus.exceptions.DBusException as error:

279

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

280

self.cleanup()

281

os._exit(1)

282

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

283

319

def remove(self):

284

320

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

285

321

if self.entry_group_state_changed_match is not None:

287

323

self.entry_group_state_changed_match = None

288

324

if self.group is not None:

289

325

self.group.Reset()

326

290

327

def add(self):

291

328

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

292

329

self.remove()

309

346

dbus.UInt16(self.port),

310

347

avahi.string_array_to_txt_array(self.TXT))

311

348

self.group.Commit()

349

312

350

def entry_group_state_changed(self, state, error):

313

351

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

314

352

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

320

358

self.rename()

321

359

elif state == avahi.ENTRY_GROUP_FAILURE:

322

360

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

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

361

str(error))

362

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

363

326

364

def cleanup(self):

327

365

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

328

366

if self.group is not None:

333

371

pass

334

372

self.group = None

335

373

self.remove()

374

336

375

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

337

376

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

338

377

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

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"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

}

346

384

if state in bad_states:

347

385

if bad_states[state] is not None:

348

386

if error is None:

351

389

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

352

390

self.cleanup()

353

391

elif state == avahi.SERVER_RUNNING:

354

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)

355

404

else:

356

405

if error is None:

357

406

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

358

407

else:

359

408

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

409

360

410

def activate(self):

361

411

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

362

412

if self.server is None:

366

416

follow_name_owner_changes=True),

367

417

avahi.DBUS_INTERFACE_SERVER)

368

418

self.server.connect_to_signal("StateChanged",

369

self.server_state_changed)

419

self.server_state_changed)

370

420

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

371

421

422

372

423

class AvahiServiceToSyslog(AvahiService):

373

def rename(self):

424

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

374

425

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

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

426

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

427

syslogger.setFormatter(logging.Formatter(

428

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

429

.format(self.name)))

380

430

return ret

381

431

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

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

388

680

class Client(object):

389

681

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

390

682

415

707

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

416

708

last_checker_status: integer between 0 and 255 reflecting exit

417

709

status of last checker. -1 reflects crashed

418

checker, or None.

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

419

713

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

420

714

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

421

715

D-Bus identifiers

426

720

runtime_expansions: Allowed attributes for runtime expansion.

427

721

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

428

722

disabled, or None

723

server_settings: The server_settings dict from main()

429

724

"""

430

725

431

726

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

727

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

728

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

729

"last_approval_request", "last_checked_ok",

434

730

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

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

460

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

461

743

@staticmethod

462

744

def config_parser(config):

463

745

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

478

760

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

479

761

"enabled")

480

762

763

# Uppercase and remove spaces from fingerprint for later

764

# comparison purposes with return value from the

765

# fingerprint() function

481

766

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

482

767

.replace(" ", ""))

483

768

if "secret" in section:

488

773

"rb") as secfile:

489

774

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

490

775

else:

491

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

492

% section)

776

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

777

.format(section))

493

778

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

494

779

client["extended_timeout"] = string_to_delta(

495

780

section["extended_timeout"])

501

786

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

502

787

client["last_approval_request"] = None

503

788

client["last_checked_ok"] = None

504

client["last_checker_status"] = None

789

client["last_checker_status"] = -2

505

790

506

791

return settings

507

508

509

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

510

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

511

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

512

attribute."""

792

793

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

513

794

self.name = name

795

if server_settings is None:

796

server_settings = {}

797

self.server_settings = server_settings

514

798

# adding all client settings

515

for setting, value in settings.iteritems():

799

for setting, value in settings.items():

516

800

setattr(self, setting, value)

517

801

518

802

if self.enabled:

524

808

else:

525

809

self.last_enabled = None

526

810

self.expires = None

527

811

528

812

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

532

813

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

533

814

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

534

815

datetime.datetime.utcnow())

535

816

536

817

# attributes specific for this server instance

537

818

self.checker = None

538

819

self.checker_initiator_tag = None

541

822

self.current_checker_command = None

542

823

self.approved = None

543

824

self.approvals_pending = 0

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

825

self.changedstate = multiprocessing_manager.Condition(

826

multiprocessing_manager.Lock())

827

self.client_structure = [attr

828

for attr in self.__dict__.iterkeys()

549

829

if not attr.startswith("_")]

550

830

self.client_structure.append("client_structure")

551

831

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

832

for name, t in inspect.getmembers(

833

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

556

834

if not name.startswith("_"):

557

835

self.client_structure.append(name)

558

836

566

844

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

567

845

# Already enabled

568

846

return

569

self.send_changedstate()

570

847

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

571

848

self.enabled = True

572

849

self.last_enabled = datetime.datetime.utcnow()

573

850

self.init_checker()

851

self.send_changedstate()

574

852

575

853

def disable(self, quiet=True):

576

854

"""Disable this client."""

577

855

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

578

856

return False

579

857

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

858

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

583

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

859

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

584

860

gobject.source_remove(self.disable_initiator_tag)

585

861

self.disable_initiator_tag = None

586

862

self.expires = None

587

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

863

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

588

864

gobject.source_remove(self.checker_initiator_tag)

589

865

self.checker_initiator_tag = None

590

866

self.stop_checker()

591

867

self.enabled = False

868

if not quiet:

869

self.send_changedstate()

592

870

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

593

871

return False

594

872

598

876

def init_checker(self):

599

877

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

600

878

# and every interval from then on.

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

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)

604

884

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

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)

608

889

# Also start a new checker *right now*.

609

890

self.start_checker()

610

891

611

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

892

def checker_callback(self, source, condition, connection,

893

command):

612

894

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

613

895

self.checker_callback_tag = None

614

896

self.checker = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

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

617

904

if self.last_checker_status == 0:

618

905

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

619

906

vars(self))

620

907

self.checked_ok()

621

908

else:

622

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

623

vars(self))

909

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

624

910

else:

625

911

self.last_checker_status = -1

912

self.last_checker_signal = -returncode

626

913

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

627

914

vars(self))

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

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

633

alive and well.

634

"""

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

635

926

if timeout is None:

636

927

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

638

928

if self.disable_initiator_tag is not None:

639

929

gobject.source_remove(self.disable_initiator_tag)

930

self.disable_initiator_tag = None

640

931

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

932

self.disable_initiator_tag = gobject.timeout_add(

933

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

644

934

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

645

935

646

936

def need_approval(self):

652

942

If a checker already exists, leave it running and do

653

943

nothing."""

654

944

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

# 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

659

949

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

660

950

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

661

951

# should be.

662

952

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

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

676

957

# Start a new checker if needed

677

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 }

678

963

try:

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

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

697

970

self.current_checker_command = command

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

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

720

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)

721

996

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

722

997

return True

723

998

729

1004

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

730

1005

return

731

1006

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

732

try:

733

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

734

#time.sleep(0.5)

735

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

736

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

737

except OSError as error:

738

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

739

raise

1007

self.checker.terminate()

740

1008

self.checker = None

741

1009

742

1010

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1011

def dbus_service_property(dbus_interface,

1012

signature="v",

1013

access="readwrite",

1014

byte_arrays=False):

745

1015

"""Decorators for marking methods of a DBusObjectWithProperties to

746

1016

become properties on the D-Bus.

747

1017

756

1026

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

757

1027

if byte_arrays and signature != "ay":

758

1028

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

759

" signature %r" % signature)

1029

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

1030

760

1031

def decorator(func):

761

1032

func._dbus_is_property = True

762

1033

func._dbus_interface = dbus_interface

767

1038

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

768

1039

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

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

770

1085

return decorator

771

1086

772

1087

773

1088

class DBusPropertyException(dbus.exceptions.DBusException):

774

1089

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

775

1090

"""

776

def __unicode__(self):

777

return unicode(str(self))

1091

pass

778

1092

779

1093

780

1094

class DBusPropertyAccessException(DBusPropertyException):

789

1103

pass

790

1104

791

1105

792

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

793

1196

"""A D-Bus object with properties.

794

1197

795

1198

Classes inheriting from this can use the dbus_service_property

797

1200

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

798

1201

"""

799

1202

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

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

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

812

1203

def _get_dbus_property(self, interface_name, property_name):

813

1204

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

814

1205

property with the specified name and interface.

815

1206

"""

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

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

819

1210

if (value._dbus_name == property_name

820

1211

and value._dbus_interface == interface_name):

821

1212

return value.__get__(self)

822

1213

823

1214

# No such property

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

829

1229

out_signature="v")

830

1230

def Get(self, interface_name, property_name):

831

1231

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

849

1249

# The byte_arrays option is not supported yet on

850

1250

# signatures other than "ay".

851

1251

if prop._dbus_signature != "ay":

852

raise ValueError

1252

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

1253

"'ay' signature {!r}"

1254

.format(prop._dbus_signature))

853

1255

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

854

1256

for byte in value))

855

1257

prop(value)

856

1258

857

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

1259

@dbus.service.method(dbus.PROPERTIES_IFACE,

1260

in_signature="s",

858

1261

out_signature="a{sv}")

859

1262

def GetAll(self, interface_name):

860

1263

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

863

1266

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

864

1267

"""

865

1268

properties = {}

866

for name, prop in self._get_all_dbus_properties():

1269

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

867

1270

if (interface_name

868

1271

and interface_name != prop._dbus_interface):

869

1272

# Interface non-empty but did not match

875

1278

if not hasattr(value, "variant_level"):

876

1279

properties[name] = value

877

1280

continue

878

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

879

value.variant_level+1)

1281

properties[name] = type(value)(

1282

value, variant_level = value.variant_level + 1)

880

1283

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

881

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

1292

882

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

883

1294

out_signature="s",

884

1295

path_keyword='object_path',

885

1296

connection_keyword='connection')

886

1297

def Introspect(self, object_path, connection):

887

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

888

1301

"""

889

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

890

connection)

1302

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1303

object_path,

1304

connection)

891

1305

try:

892

1306

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

1307

893

1308

def make_tag(document, name, prop):

894

1309

e = document.createElement("property")

895

1310

e.setAttribute("name", name)

896

1311

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

897

1312

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

898

1313

return e

1314

899

1315

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

1316

# Add property tags

900

1317

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

901

1318

for name, prop

902

in self._get_all_dbus_properties()

1319

in self._get_all_dbus_things("property")

903

1320

if prop._dbus_interface

904

1321

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

905

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)

906

1339

# Add the names to the return values for the

907

1340

# "org.freedesktop.DBus.Properties" methods

908

1341

if (if_tag.getAttribute("name")

923

1356

except (AttributeError, xml.dom.DOMException,

924

1357

xml.parsers.expat.ExpatError) as error:

925

1358

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

926

error)

927

return xmlstring

928

929

930

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

931

1432

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

932

1433

if dt is None:

933

1434

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

942

1460

"""

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

950

1469

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

951

1470

# with the wrong interface name

952

1471

if (not hasattr(attribute, "_dbus_interface")

953

or not attribute._dbus_interface

954

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

1472

or not attribute._dbus_interface.startswith(

1473

orig_interface_name)):

955

1474

continue

956

1475

# Create an alternate D-Bus interface name based on

957

1476

# the current name

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1477

alt_interface = attribute._dbus_interface.replace(

1478

orig_interface_name, alt_interface_name)

1479

interface_names.add(alt_interface)

961

1480

# Is this a D-Bus signal?

962

1481

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

963

# Extract the original non-method function by

964

# black magic

965

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(

966

1486

zip(attribute.func_code.co_freevars,

967

attribute.__closure__))["func"]

968

.cell_contents)

1487

attribute.__closure__))

1488

["func"].cell_contents)

1489

else:

1490

nonmethod_func = attribute

969

1491

# Create a new, but exactly alike, function

970

1492

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

971

1493

# with the alternate D-Bus interface name

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

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

981

1517

# Define a creator of a function to call both the

982

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

983

# 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

984

1521

def fixscope(func1, func2):

985

1522

"""This function is a scope container to pass

986

1523

func1 and func2 to the "call_both" function

987

1524

outside of its arguments"""

1525

1526

@functools.wraps(func2)

988

1527

def call_both(*args, **kwargs):

989

1528

"""This function will emit two D-Bus

990

1529

signals by calling func1 and func2"""

991

1530

func1(*args, **kwargs)

992

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

993

1537

return call_both

994

1538

# Create the "call_both" function and add it to

995

1539

# the class

996

attr[attrname] = fixscope(attribute,

997

new_function)

1540

attr[attrname] = fixscope(attribute, new_function)

998

1541

# Is this a D-Bus method?

999

1542

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

1000

1543

# Create a new, but exactly alike, function

1001

1544

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

1002

1545

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

1003

1546

# to the class.

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

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

1014

1563

# Is this a D-Bus property?

1015

1564

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

1016

1565

# Create a new, but exactly alike, function

1017

1566

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

1018

1567

# property with the alternate D-Bus interface

1019

1568

# name. Add it to the class.

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

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

1034

1035

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

1036

1626

class ClientDBus(Client, DBusObjectWithProperties):

1037

1627

"""A Client class using D-Bus

1038

1628

1042

1632

"""

1043

1633

1044

1634

runtime_expansions = (Client.runtime_expansions

1045

+ ("dbus_object_path",))

1635

+ ("dbus_object_path", ))

1636

1637

_interface = "se.recompile.Mandos.Client"

1046

1638

1047

1639

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

1048

1640

1051

1643

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

1052

1644

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

1053

1645

# the D-Bus

1054

client_object_name = unicode(self.name).translate(

1646

client_object_name = str(self.name).translate(

1055

1647

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

1056

1648

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

1057

self.dbus_object_path = (dbus.ObjectPath

1058

("/clients/" + client_object_name))

1649

self.dbus_object_path = dbus.ObjectPath(

1650

"/clients/" + client_object_name)

1059

1651

DBusObjectWithProperties.__init__(self, self.bus,

1060

1652

self.dbus_object_path)

1061

1062

def notifychangeproperty(transform_func,

1063

dbus_name, type_func=lambda x: x,

1064

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

1065

1659

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

1066

1660

its changes to DBus.

1067

1661

1072

1666

to the D-Bus. Default: no transform

1073

1667

variant_level: D-Bus variant level. Default: 1

1074

1668

"""

1075

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

1669

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

1670

1076

1671

def setter(self, value):

1077

1672

if hasattr(self, "dbus_object_path"):

1078

1673

if (not hasattr(self, attrname) or

1079

1674

type_func(getattr(self, attrname, None))

1080

1675

!= type_func(value)):

1081

dbus_value = transform_func(type_func(value),

1082

variant_level

1083

=variant_level)

1084

self.PropertyChanged(dbus.String(dbus_name),

1085

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

1086

1691

setattr(self, attrname, value)

1087

1692

1088

1693

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

1089

1694

1090

1091

1695

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1092

1696

approvals_pending = notifychangeproperty(dbus.Boolean,

1093

1697

"ApprovalPending",

1095

1699

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

1096

1700

last_enabled = notifychangeproperty(datetime_to_dbus,

1097

1701

"LastEnabled")

1098

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

1099

type_func = lambda checker:

1100

checker is not None)

1702

checker = notifychangeproperty(

1703

dbus.Boolean, "CheckerRunning",

1704

type_func = lambda checker: checker is not None)

1101

1705

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1102

1706

"LastCheckedOK")

1707

last_checker_status = notifychangeproperty(dbus.Int16,

1708

"LastCheckerStatus")

1103

1709

last_approval_request = notifychangeproperty(

1104

1710

datetime_to_dbus, "LastApprovalRequest")

1105

1711

approved_by_default = notifychangeproperty(dbus.Boolean,

1106

1712

"ApprovedByDefault")

1107

approval_delay = notifychangeproperty(dbus.UInt64,

1108

"ApprovalDelay",

1109

type_func =

1110

timedelta_to_milliseconds)

1713

approval_delay = notifychangeproperty(

1714

dbus.UInt64, "ApprovalDelay",

1715

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

1111

1716

approval_duration = notifychangeproperty(

1112

1717

dbus.UInt64, "ApprovalDuration",

1113

type_func = timedelta_to_milliseconds)

1718

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

1114

1719

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

1115

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

1116

type_func =

1117

timedelta_to_milliseconds)

1720

timeout = notifychangeproperty(

1721

dbus.UInt64, "Timeout",

1722

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

1118

1723

extended_timeout = notifychangeproperty(

1119

1724

dbus.UInt64, "ExtendedTimeout",

1120

type_func = timedelta_to_milliseconds)

1121

interval = notifychangeproperty(dbus.UInt64,

1122

"Interval",

1123

type_func =

1124

timedelta_to_milliseconds)

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)

1125

1729

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

1730

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

1731

invalidate_only=True)

1126

1732

1127

1733

del notifychangeproperty

1128

1734

1135

1741

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

1136

1742

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

1137

1743

1138

def checker_callback(self, pid, condition, command,

1139

*args, **kwargs):

1140

self.checker_callback_tag = None

1141

self.checker = None

1142

if os.WIFEXITED(condition):

1143

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:

1144

1751

# Emit D-Bus signal

1145

1752

self.CheckerCompleted(dbus.Int16(exitstatus),

1146

dbus.Int64(condition),

1753

# This is specific to GNU libC

1754

dbus.Int64(exitstatus << 8),

1147

1755

dbus.String(command))

1148

1756

else:

1149

1757

# Emit D-Bus signal

1150

1758

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

1151

dbus.Int64(condition),

1759

dbus.Int64(

1760

# This is specific to GNU libC

1761

(exitstatus << 8)

1762

| self.last_checker_signal),

1152

1763

dbus.String(command))

1153

1154

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

1155

*args, **kwargs)

1764

return ret

1156

1765

1157

1766

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

1158

old_checker = self.checker

1159

if self.checker is not None:

1160

old_checker_pid = self.checker.pid

1161

else:

1162

old_checker_pid = None

1767

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

1163

1768

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

1164

1769

# Only if new checker process was started

1165

1770

if (self.checker is not None

1173

1778

return False

1174

1779

1175

1780

def approve(self, value=True):

1176

self.send_changedstate()

1177

1781

self.approved = value

1178

gobject.timeout_add(timedelta_to_milliseconds

1179

(self.approval_duration),

1180

self._reset_approved)

1181

1782

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

1783

* 1000), self._reset_approved)

1784

self.send_changedstate()

1182

1785

1183

1786

## D-Bus methods, signals & properties

1184

_interface = "se.recompile.Mandos.Client"

1787

1788

## Interfaces

1185

1789

1186

1790

## Signals

1187

1791

1198

1802

pass

1199

1803

1200

1804

# PropertyChanged - signal

1805

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

1201

1806

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

1202

1807

def PropertyChanged(self, property, value):

1203

1808

"D-Bus signal"

1237

1842

self.checked_ok()

1238

1843

1239

1844

# Enable - method

1845

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

1240

1846

@dbus.service.method(_interface)

1241

1847

def Enable(self):

1242

1848

"D-Bus method"

1243

1849

self.enable()

1244

1850

1245

1851

# StartChecker - method

1852

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

1246

1853

@dbus.service.method(_interface)

1247

1854

def StartChecker(self):

1248

1855

"D-Bus method"

1249

1856

self.start_checker()

1250

1857

1251

1858

# Disable - method

1859

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

1252

1860

@dbus.service.method(_interface)

1253

1861

def Disable(self):

1254

1862

"D-Bus method"

1255

1863

self.disable()

1256

1864

1257

1865

# StopChecker - method

1866

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

1258

1867

@dbus.service.method(_interface)

1259

1868

def StopChecker(self):

1260

1869

self.stop_checker()

1267

1876

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

1268

1877

1269

1878

# ApprovedByDefault - property

1270

@dbus_service_property(_interface, signature="b",

1879

@dbus_service_property(_interface,

1880

signature="b",

1271

1881

access="readwrite")

1272

1882

def ApprovedByDefault_dbus_property(self, value=None):

1273

1883

if value is None: # get

1275

1885

self.approved_by_default = bool(value)

1276

1886

1277

1887

# ApprovalDelay - property

1278

@dbus_service_property(_interface, signature="t",

1888

@dbus_service_property(_interface,

1889

signature="t",

1279

1890

access="readwrite")

1280

1891

def ApprovalDelay_dbus_property(self, value=None):

1281

1892

if value is None: # get

1282

return dbus.UInt64(self.approval_delay_milliseconds())

1893

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

1894

* 1000)

1283

1895

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

1284

1896

1285

1897

# ApprovalDuration - property

1286

@dbus_service_property(_interface, signature="t",

1898

@dbus_service_property(_interface,

1899

signature="t",

1287

1900

access="readwrite")

1288

1901

def ApprovalDuration_dbus_property(self, value=None):

1289

1902

if value is None: # get

1290

return dbus.UInt64(timedelta_to_milliseconds(

1291

self.approval_duration))

1903

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

1904

* 1000)

1292

1905

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

1293

1906

1294

1907

# Name - property

1908

@dbus_annotations(

1909

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

1295

1910

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

1296

1911

def Name_dbus_property(self):

1297

1912

return dbus.String(self.name)

1298

1913

1299

1914

# Fingerprint - property

1915

@dbus_annotations(

1916

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

1300

1917

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

1301

1918

def Fingerprint_dbus_property(self):

1302

1919

return dbus.String(self.fingerprint)

1303

1920

1304

1921

# Host - property

1305

@dbus_service_property(_interface, signature="s",

1922

@dbus_service_property(_interface,

1923

signature="s",

1306

1924

access="readwrite")

1307

1925

def Host_dbus_property(self, value=None):

1308

1926

if value is None: # get

1309

1927

return dbus.String(self.host)

1310

self.host = unicode(value)

1928

self.host = str(value)

1311

1929

1312

1930

# Created - property

1931

@dbus_annotations(

1932

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

1313

1933

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

1314

1934

def Created_dbus_property(self):

1315

1935

return datetime_to_dbus(self.created)

1320

1940

return datetime_to_dbus(self.last_enabled)

1321

1941

1322

1942

# Enabled - property

1323

@dbus_service_property(_interface, signature="b",

1943

@dbus_service_property(_interface,

1944

signature="b",

1324

1945

access="readwrite")

1325

1946

def Enabled_dbus_property(self, value=None):

1326

1947

if value is None: # get

1331

1952

self.disable()

1332

1953

1333

1954

# LastCheckedOK - property

1334

@dbus_service_property(_interface, signature="s",

1955

@dbus_service_property(_interface,

1956

signature="s",

1335

1957

access="readwrite")

1336

1958

def LastCheckedOK_dbus_property(self, value=None):

1337

1959

if value is not None:

1339

1961

return

1340

1962

return datetime_to_dbus(self.last_checked_ok)

1341

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

1342

1969

# Expires - property

1343

1970

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

1344

1971

def Expires_dbus_property(self):

1350

1977

return datetime_to_dbus(self.last_approval_request)

1351

1978

1352

1979

# Timeout - property

1353

@dbus_service_property(_interface, signature="t",

1980

@dbus_service_property(_interface,

1981

signature="t",

1354

1982

access="readwrite")

1355

1983

def Timeout_dbus_property(self, value=None):

1356

1984

if value is None: # get

1357

return dbus.UInt64(self.timeout_milliseconds())

1985

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

1986

old_timeout = self.timeout

1358

1987

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

1359

# Reschedule timeout

1988

# Reschedule disabling

1360

1989

if self.enabled:

1361

1990

now = datetime.datetime.utcnow()

1362

time_to_die = timedelta_to_milliseconds(

1363

(self.last_checked_ok + self.timeout) - now)

1364

if time_to_die <= 0:

1991

self.expires += self.timeout - old_timeout

1992

if self.expires <= now:

1365

1993

# The timeout has passed

1366

1994

self.disable()

1367

1995

else:

1368

self.expires = (now +

1369

datetime.timedelta(milliseconds =

1370

time_to_die))

1371

1996

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

1372

1997

is None):

1373

1998

return

1374

1999

gobject.source_remove(self.disable_initiator_tag)

1375

self.disable_initiator_tag = (gobject.timeout_add

1376

(time_to_die,

1377

self.disable))

2000

self.disable_initiator_tag = gobject.timeout_add(

2001

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

2002

self.disable)

1378

2003

1379

2004

# ExtendedTimeout - property

1380

@dbus_service_property(_interface, signature="t",

2005

@dbus_service_property(_interface,

2006

signature="t",

1381

2007

access="readwrite")

1382

2008

def ExtendedTimeout_dbus_property(self, value=None):

1383

2009

if value is None: # get

1384

return dbus.UInt64(self.extended_timeout_milliseconds())

2010

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

2011

* 1000)

1385

2012

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

1386

2013

1387

2014

# Interval - property

1388

@dbus_service_property(_interface, signature="t",

2015

@dbus_service_property(_interface,

2016

signature="t",

1389

2017

access="readwrite")

1390

2018

def Interval_dbus_property(self, value=None):

1391

2019

if value is None: # get

1392

return dbus.UInt64(self.interval_milliseconds())

2020

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

1393

2021

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

1394

2022

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

1395

2023

return

1396

2024

if self.enabled:

1397

2025

# Reschedule checker run

1398

2026

gobject.source_remove(self.checker_initiator_tag)

1399

self.checker_initiator_tag = (gobject.timeout_add

1400

(value, self.start_checker))

1401

self.start_checker() # Start one now, too

2027

self.checker_initiator_tag = gobject.timeout_add(

2028

value, self.start_checker)

2029

self.start_checker() # Start one now, too

1402

2030

1403

2031

# Checker - property

1404

@dbus_service_property(_interface, signature="s",

2032

@dbus_service_property(_interface,

2033

signature="s",

1405

2034

access="readwrite")

1406

2035

def Checker_dbus_property(self, value=None):

1407

2036

if value is None: # get

1408

2037

return dbus.String(self.checker_command)

1409

self.checker_command = unicode(value)

2038

self.checker_command = str(value)

1410

2039

1411

2040

# CheckerRunning - property

1412

@dbus_service_property(_interface, signature="b",

2041

@dbus_service_property(_interface,

2042

signature="b",

1413

2043

access="readwrite")

1414

2044

def CheckerRunning_dbus_property(self, value=None):

1415

2045

if value is None: # get

1420

2050

self.stop_checker()

1421

2051

1422

2052

# ObjectPath - property

2053

@dbus_annotations(

2054

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

2055

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

1423

2056

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

1424

2057

def ObjectPath_dbus_property(self):

1425

2058

return self.dbus_object_path # is already a dbus.ObjectPath

1426

2059

1427

2060

# Secret = property

1428

@dbus_service_property(_interface, signature="ay",

1429

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)

1430

2068

def Secret_dbus_property(self, value):

1431

self.secret = str(value)

2069

self.secret = bytes(value)

1432

2070

1433

2071

del _interface

1434

2072

1438

2076

self._pipe = child_pipe

1439

2077

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

1440

2078

if not self._pipe.recv():

1441

raise KeyError()

2079

raise KeyError(fpr)

1442

2080

1443

2081

def __getattribute__(self, name):

1444

2082

if name == '_pipe':

1448

2086

if data[0] == 'data':

1449

2087

return data[1]

1450

2088

if data[0] == 'function':

2089

1451

2090

def func(*args, **kwargs):

1452

2091

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

1453

2092

return self._pipe.recv()[1]

2093

1454

2094

return func

1455

2095

1456

2096

def __setattr__(self, name, value):

1459

2099

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

1460

2100

1461

2101

1462

class ClientDBusTransitional(ClientDBus):

1463

__metaclass__ = AlternateDBusNamesMetaclass

1464

1465

1466

2102

class ClientHandler(socketserver.BaseRequestHandler, object):

1467

2103

"""A class to handle client connections.

1468

2104

1472

2108

def handle(self):

1473

2109

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

1474

2110

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

1475

unicode(self.client_address))

2111

str(self.client_address))

1476

2112

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

1477

2113

self.server.child_pipe.fileno())

1478

2114

1479

session = (gnutls.connection

1480

.ClientSession(self.request,

1481

gnutls.connection

1482

.X509Credentials()))

1483

1484

# Note: gnutls.connection.X509Credentials is really a

1485

# generic GnuTLS certificate credentials object so long as

1486

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

1487

# here despite using OpenPGP certificates.

2115

session = gnutls.ClientSession(self.request)

1488

2116

1489

2117

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

1490

2118

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

1494

2122

priority = self.server.gnutls_priority

1495

2123

if priority is None:

1496

2124

priority = "NORMAL"

1497

(gnutls.library.functions

1498

.gnutls_priority_set_direct(session._c_object,

1499

priority, None))

2125

gnutls.priority_set_direct(session._c_object, priority,

2126

None)

1500

2127

1501

2128

# Start communication using the Mandos protocol

1502

2129

# Get protocol number

1504

2131

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

1505

2132

try:

1506

2133

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

1507

raise RuntimeError

2134

raise RuntimeError(line)

1508

2135

except (ValueError, IndexError, RuntimeError) as error:

1509

2136

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

1510

2137

return

1512

2139

# Start GnuTLS connection

1513

2140

try:

1514

2141

session.handshake()

1515

except gnutls.errors.GNUTLSError as error:

2142

except gnutls.Error as error:

1516

2143

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

1517

2144

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

1518

2145

# established. Just abandon the request.

1522

2149

approval_required = False

1523

2150

try:

1524

2151

try:

1525

fpr = self.fingerprint(self.peer_certificate

1526

(session))

1527

except (TypeError,

1528

gnutls.errors.GNUTLSError) as error:

2152

fpr = self.fingerprint(

2153

self.peer_certificate(session))

2154

except (TypeError, gnutls.Error) as error:

1529

2155

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

1530

2156

return

1531

2157

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

1544

2170

while True:

1545

2171

if not client.enabled:

1546

2172

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

1547

client.name)

2173

client.name)

1548

2174

if self.server.use_dbus:

1549

2175

# Emit D-Bus signal

1550

2176

client.Rejected("Disabled")

1559

2185

if self.server.use_dbus:

1560

2186

# Emit D-Bus signal

1561

2187

client.NeedApproval(

1562

client.approval_delay_milliseconds(),

1563

client.approved_by_default)

2188

client.approval_delay.total_seconds()

2189

* 1000, client.approved_by_default)

1564

2190

else:

1565

2191

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

1566

2192

client.name)

1572

2198

#wait until timeout or approved

1573

2199

time = datetime.datetime.now()

1574

2200

client.changedstate.acquire()

1575

(client.changedstate.wait

1576

(float(client.timedelta_to_milliseconds(delay)

1577

/ 1000)))

2201

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

1578

2202

client.changedstate.release()

1579

2203

time2 = datetime.datetime.now()

1580

2204

if (time2 - time) >= delay:

1595

2219

while sent_size < len(client.secret):

1596

2220

try:

1597

2221

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

1598

except gnutls.errors.GNUTLSError as error:

1599

logger.warning("gnutls send failed")

2222

except gnutls.Error as error:

2223

logger.warning("gnutls send failed",

2224

exc_info=error)

1600

2225

return

1601

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

1602

sent, len(client.secret)

1603

- (sent_size + sent))

2226

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

2227

len(client.secret) - (sent_size

2228

+ sent))

1604

2229

sent_size += sent

1605

2230

1606

2231

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

1607

2232

# bump the timeout using extended_timeout

1608

client.checked_ok(client.extended_timeout)

2233

client.bump_timeout(client.extended_timeout)

1609

2234

if self.server.use_dbus:

1610

2235

# Emit D-Bus signal

1611

2236

client.GotSecret()

1615

2240

client.approvals_pending -= 1

1616

2241

try:

1617

2242

session.bye()

1618

except gnutls.errors.GNUTLSError as error:

1619

logger.warning("GnuTLS bye failed")

2243

except gnutls.Error as error:

2244

logger.warning("GnuTLS bye failed",

2245

exc_info=error)

1620

2246

1621

2247

@staticmethod

1622

2248

def peer_certificate(session):

1623

2249

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

1624

2250

# If not an OpenPGP certificate...

1625

if (gnutls.library.functions

1626

.gnutls_certificate_type_get(session._c_object)

1627

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1628

# ...do the normal thing

1629

return session.peer_certificate

2251

if (gnutls.certificate_type_get(session._c_object)

2252

!= gnutls.CRT_OPENPGP):

2253

# ...return invalid data

2254

return b""

1630

2255

list_size = ctypes.c_uint(1)

1631

cert_list = (gnutls.library.functions

1632

.gnutls_certificate_get_peers

2256

cert_list = (gnutls.certificate_get_peers

1633

2257

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

1634

2258

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

1635

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

1636

" certificate")

2259

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

1637

2260

if list_size.value == 0:

1638

2261

return None

1639

2262

cert = cert_list[0]

1643

2266

def fingerprint(openpgp):

1644

2267

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1645

2268

# New GnuTLS "datum" with the OpenPGP public key

1646

datum = (gnutls.library.types

1647

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

1648

ctypes.POINTER

1649

(ctypes.c_ubyte)),

1650

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

1651

2273

# New empty GnuTLS certificate

1652

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1653

(gnutls.library.functions

1654

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2274

crt = gnutls.openpgp_crt_t()

2275

gnutls.openpgp_crt_init(ctypes.byref(crt))

1655

2276

# Import the OpenPGP public key into the certificate

1656

(gnutls.library.functions

1657

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

1658

gnutls.library.constants

1659

.GNUTLS_OPENPGP_FMT_RAW))

2277

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

2278

gnutls.OPENPGP_FMT_RAW)

1660

2279

# Verify the self signature in the key

1661

2280

crtverify = ctypes.c_uint()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_verify_self(crt, 0,

1664

ctypes.byref(crtverify)))

2281

gnutls.openpgp_crt_verify_self(crt, 0,

2282

ctypes.byref(crtverify))

1665

2283

if crtverify.value != 0:

1666

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1667

raise (gnutls.errors.CertificateSecurityError

1668

("Verify failed"))

2284

gnutls.openpgp_crt_deinit(crt)

2285

raise gnutls.CertificateSecurityError("Verify failed")

1669

2286

# New buffer for the fingerprint

1670

2287

buf = ctypes.create_string_buffer(20)

1671

2288

buf_len = ctypes.c_size_t()

1672

2289

# Get the fingerprint from the certificate into the buffer

1673

(gnutls.library.functions

1674

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

1675

ctypes.byref(buf_len)))

2290

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

2291

ctypes.byref(buf_len))

1676

2292

# Deinit the certificate

1677

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2293

gnutls.openpgp_crt_deinit(crt)

1678

2294

# Convert the buffer to a Python bytestring

1679

2295

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

1680

2296

# Convert the bytestring to hexadecimal notation

1684

2300

1685

2301

class MultiprocessingMixIn(object):

1686

2302

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

2303

1687

2304

def sub_process_main(self, request, address):

1688

2305

try:

1689

2306

self.finish_request(request, address)

1694

2311

def process_request(self, request, address):

1695

2312

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

1696

2313

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

1697

args = (request,

1698

address))

2314

args = (request, address))

1699

2315

proc.start()

1700

2316

return proc

1701

2317

1702

2318

1703

2319

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1704

2320

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

2321

1705

2322

def process_request(self, request, client_address):

1706

2323

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

1707

2324

1716

2333

1717

2334

def add_pipe(self, parent_pipe, proc):

1718

2335

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

1719

raise NotImplementedError

2336

raise NotImplementedError()

1720

2337

1721

2338

1722

2339

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1728

2345

interface: None or a network interface name (string)

1729

2346

use_ipv6: Boolean; to use IPv6 or not

1730

2347

"""

2348

1731

2349

def __init__(self, server_address, RequestHandlerClass,

1732

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

"""

1733

2356

self.interface = interface

1734

2357

if use_ipv6:

1735

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.

1736

2385

socketserver.TCPServer.__init__(self, server_address,

1737

2386

RequestHandlerClass)

2387

1738

2388

def server_bind(self):

1739

2389

"""This overrides the normal server_bind() function

1740

2390

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

1746

2396

self.interface)

1747

2397

else:

1748

2398

try:

1749

self.socket.setsockopt(socket.SOL_SOCKET,

1750

SO_BINDTODEVICE,

1751

str(self.interface

1752

+ '\0'))

2399

self.socket.setsockopt(

2400

socket.SOL_SOCKET, SO_BINDTODEVICE,

2401

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

1753

2402

except socket.error as error:

1754

if error[0] == errno.EPERM:

1755

logger.error("No permission to"

1756

" bind to interface %s",

1757

self.interface)

1758

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:

1759

2407

logger.error("SO_BINDTODEVICE not available;"

1760

2408

" cannot bind to interface %s",

1761

2409

self.interface)

2410

elif error.errno == errno.ENODEV:

2411

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

2412

" cannot bind", self.interface)

1762

2413

else:

1763

2414

raise

1764

2415

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

1767

2418

if self.address_family == socket.AF_INET6:

1768

2419

any_address = "::" # in6addr_any

1769

2420

else:

1770

any_address = socket.INADDR_ANY

2421

any_address = "0.0.0.0" # INADDR_ANY

1771

2422

self.server_address = (any_address,

1772

2423

self.server_address[1])

1773

2424

elif not self.server_address[1]:

1774

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

1775

0)

2425

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

1776

2426

# if self.interface:

1777

2427

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

1778

2428

# 0, # port

1792

2442

1793

2443

Assumes a gobject.MainLoop event loop.

1794

2444

"""

2445

1795

2446

def __init__(self, server_address, RequestHandlerClass,

1796

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

1797

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

1798

2453

self.enabled = False

1799

2454

self.clients = clients

1800

2455

if self.clients is None:

1804

2459

IPv6_TCPServer.__init__(self, server_address,

1805

2460

RequestHandlerClass,

1806

2461

interface = interface,

1807

use_ipv6 = use_ipv6)

2462

use_ipv6 = use_ipv6,

2463

socketfd = socketfd)

2464

1808

2465

def server_activate(self):

1809

2466

if self.enabled:

1810

2467

return socketserver.TCPServer.server_activate(self)

1814

2471

1815

2472

def add_pipe(self, parent_pipe, proc):

1816

2473

# Call "handle_ipc" for both data and EOF events

1817

gobject.io_add_watch(parent_pipe.fileno(),

1818

gobject.IO_IN | gobject.IO_HUP,

1819

functools.partial(self.handle_ipc,

1820

parent_pipe =

1821

parent_pipe,

1822

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

1823

2480

1824

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

1825

proc = None, client_object=None):

1826

condition_names = {

1827

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

1828

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

1829

# blocking).

1830

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

1831

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

1832

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

1833

# broken, usually for pipes and

1834

# sockets).

1835

}

1836

conditions_string = ' | '.join(name

1837

for cond, name in

1838

condition_names.iteritems()

1839

if cond & condition)

2481

def handle_ipc(self, source, condition,

2482

parent_pipe=None,

2483

proc = None,

2484

client_object=None):

1840

2485

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

1841

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

2486

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

1842

2487

# Wait for other process to exit

1843

2488

proc.join()

1844

2489

return False

1865

2510

parent_pipe.send(False)

1866

2511

return False

1867

2512

1868

gobject.io_add_watch(parent_pipe.fileno(),

1869

gobject.IO_IN | gobject.IO_HUP,

1870

functools.partial(self.handle_ipc,

1871

parent_pipe =

1872

parent_pipe,

1873

proc = proc,

1874

client_object =

1875

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

1876

2520

parent_pipe.send(True)

1877

2521

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

1878

2522

# same fileno

1884

2528

1885

2529

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

1886

2530

funcname)(*args,

1887

**kwargs)))

2531

**kwargs)))

1888

2532

1889

2533

if command == 'getattr':

1890

2534

attrname = request[1]

1891

if callable(client_object.__getattribute__(attrname)):

1892

parent_pipe.send(('function',))

2535

if isinstance(client_object.__getattribute__(attrname),

2536

collections.Callable):

2537

parent_pipe.send(('function', ))

1893

2538

else:

1894

parent_pipe.send(('data', client_object

1895

.__getattribute__(attrname)))

2539

parent_pipe.send((

2540

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

1896

2541

1897

2542

if command == 'setattr':

1898

2543

attrname = request[1]

1902

2547

return True

1903

2548

1904

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

1905

2646

def string_to_delta(interval):

1906

2647

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

1907

2648

1918

2659

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

1919

2660

datetime.timedelta(0, 330)

1920

2661

"""

2662

2663

try:

2664

return rfc3339_duration_to_delta(interval)

2665

except ValueError:

2666

pass

2667

1921

2668

timevalue = datetime.timedelta(0)

1922

2669

for s in interval.split():

1923

2670

try:

1924

suffix = unicode(s[-1])

2671

suffix = s[-1]

1925

2672

value = int(s[:-1])

1926

2673

if suffix == "d":

1927

2674

delta = datetime.timedelta(value)

1934

2681

elif suffix == "w":

1935

2682

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

1936

2683

else:

1937

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

1938

except (ValueError, IndexError) as e:

2684

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

2685

except IndexError as e:

1939

2686

raise ValueError(*(e.args))

1940

2687

timevalue += delta

1941

2688

return timevalue

1954

2701

sys.exit()

1955

2702

if not noclose:

1956

2703

# Close all standard open file descriptors

1957

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

2704

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

1958

2705

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

1959

2706

raise OSError(errno.ENODEV,

1960

"%s not a character device"

1961

% os.path.devnull)

2707

"{} not a character device"

2708

.format(os.devnull))

1962

2709

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

1963

2710

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

1964

2711

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

1973

2720

1974

2721

parser = argparse.ArgumentParser()

1975

2722

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

1976

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

2723

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

1977

2724

help="show version number and exit")

1978

2725

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

1979

2726

help="Bind to interface IF")

1985

2732

help="Run self-test")

1986

2733

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

1987

2734

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

1988

" to terminal")

2735

" to terminal", default=None)

1989

2736

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

1990

2737

help="Debug level for stdout output")

1991

2738

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

1998

2745

" files")

1999

2746

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

2000

2747

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

2001

" system bus interface")

2748

" system bus interface", default=None)

2002

2749

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

2003

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

2750

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

2751

default=None)

2004

2752

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

2005

2753

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

2006

" state")

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

2007

2758

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

2008

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)

2009

2765

2010

2766

options = parser.parse_args()

2011

2767

2012

2768

if options.check:

2013

2769

import doctest

2014

doctest.testmod()

2015

sys.exit()

2770

fail_count, test_count = doctest.testmod()

2771

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

2016

2772

2017

2773

# Default values for config file for server-global settings

2018

2774

server_defaults = { "interface": "",

2020

2776

"port": "",

2021

2777

"debug": "False",

2022

2778

"priority":

2023

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

2779

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

2780

":+SIGN-DSA-SHA256",

2024

2781

"servicename": "Mandos",

2025

2782

"use_dbus": "True",

2026

2783

"use_ipv6": "True",

2027

2784

"debuglevel": "",

2028

2785

"restore": "True",

2029

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

2030

}

2786

"socket": "",

2787

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

2788

"foreground": "False",

2789

"zeroconf": "True",

2790

}

2031

2791

2032

2792

# Parse config file for server-global settings

2033

2793

server_config = configparser.SafeConfigParser(server_defaults)

2034

2794

del server_defaults

2035

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

2036

"mandos.conf"))

2795

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

2037

2796

# Convert the SafeConfigParser object to a dict

2038

2797

server_settings = server_config.defaults()

2039

2798

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

2040

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

2799

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

2041

2800

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

2042

2801

option)

2043

2802

if server_settings["port"]:

2044

2803

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

2045

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

2046

2814

del server_config

2047

2815

2048

2816

# Override the settings from the config file with command line

2049

2817

# options, if set.

2050

2818

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

2051

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

2052

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

2053

"statedir"):

2819

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

2820

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

2821

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

2054

2822

value = getattr(options, option)

2055

2823

if value is not None:

2056

2824

server_settings[option] = value

2057

2825

del options

2058

2826

# Force all strings to be unicode

2059

2827

for option in server_settings.keys():

2060

if type(server_settings[option]) is str:

2061

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

2062

2838

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

2063

2839

2064

2840

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

2065

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

2066

2847

# For convenience

2067

2848

debug = server_settings["debug"]

2068

2849

debuglevel = server_settings["debuglevel"]

2070

2851

use_ipv6 = server_settings["use_ipv6"]

2071

2852

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

2072

2853

stored_state_file)

2854

foreground = server_settings["foreground"]

2855

zeroconf = server_settings["zeroconf"]

2073

2856

2074

2857

if debug:

2075

2858

initlogger(debug, logging.DEBUG)

2081

2864

initlogger(debug, level)

2082

2865

2083

2866

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

2084

syslogger.setFormatter(logging.Formatter

2085

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

2086

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

2087

% server_settings["servicename"]))

2867

syslogger.setFormatter(

2868

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

2869

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

2870

server_settings["servicename"])))

2088

2871

2089

2872

# Parse config file with clients

2090

2873

client_config = configparser.SafeConfigParser(Client

2095

2878

global mandos_dbus_service

2096

2879

mandos_dbus_service = None

2097

2880

2098

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

2099

server_settings["port"]),

2100

ClientHandler,

2101

interface=(server_settings["interface"]

2102

or None),

2103

use_ipv6=use_ipv6,

2104

gnutls_priority=

2105

server_settings["priority"],

2106

use_dbus=use_dbus)

2107

if not debug:

2108

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

2109

2897

try:

2110

pidfile = open(pidfilename, "w")

2111

except IOError:

2112

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)

2113

2902

2114

try:

2115

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

2116

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

2117

except KeyError:

2903

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

2118

2904

try:

2119

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

2120

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

2905

uid = pwd.getpwnam(name).pw_uid

2906

gid = pwd.getpwnam(name).pw_gid

2907

break

2121

2908

except KeyError:

2122

try:

2123

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

2124

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

2125

except KeyError:

2126

uid = 65534

2127

gid = 65534

2909

continue

2910

else:

2911

uid = 65534

2912

gid = 65534

2128

2913

try:

2129

2914

os.setgid(gid)

2130

2915

os.setuid(uid)

2131

2916

except OSError as error:

2132

if error[0] != errno.EPERM:

2133

raise error

2917

if error.errno != errno.EPERM:

2918

raise

2134

2919

2135

2920

if debug:

2136

2921

# Enable all possible GnuTLS debugging

2137

2922

2138

2923

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

2139

2924

# - GnuTLS manual

2140

gnutls.library.functions.gnutls_global_set_log_level(11)

2925

gnutls.global_set_log_level(11)

2141

2926

2142

@gnutls.library.types.gnutls_log_func

2927

@gnutls.log_func

2143

2928

def debug_gnutls(level, string):

2144

2929

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

2145

2930

2146

(gnutls.library.functions

2147

.gnutls_global_set_log_function(debug_gnutls))

2931

gnutls.global_set_log_function(debug_gnutls)

2148

2932

2149

2933

# Redirect stdin so all checkers get /dev/null

2150

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

2934

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

2151

2935

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

2152

2936

if null > 2:

2153

2937

os.close(null)

2154

2938

2155

2939

# Need to fork before connecting to D-Bus

2156

if not debug:

2940

if not foreground:

2157

2941

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

2158

2942

daemon()

2159

2943

2944

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

2945

# need to inform gobject that threads will be used.

2160

2946

gobject.threads_init()

2161

2947

2162

2948

global main_loop

2163

2949

# From the Avahi example code

2164

DBusGMainLoop(set_as_default=True )

2950

DBusGMainLoop(set_as_default=True)

2165

2951

main_loop = gobject.MainLoop()

2166

2952

bus = dbus.SystemBus()

2167

2953

# End of Avahi example code

2168

2954

if use_dbus:

2169

2955

try:

2170

2956

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

2171

bus, do_not_queue=True)

2172

old_bus_name = (dbus.service.BusName

2173

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

2174

do_not_queue=True))

2175

except dbus.exceptions.NameExistsException as e:

2176

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)

2177

2964

use_dbus = False

2178

2965

server_settings["use_dbus"] = False

2179

2966

tcp_server.use_dbus = False

2180

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2181

service = AvahiServiceToSyslog(name =

2182

server_settings["servicename"],

2183

servicetype = "_mandos._tcp",

2184

protocol = protocol, bus = bus)

2185

if server_settings["interface"]:

2186

service.interface = (if_nametoindex

2187

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

2188

2977

2189

2978

global multiprocessing_manager

2190

2979

multiprocessing_manager = multiprocessing.Manager()

2191

2980

2192

2981

client_class = Client

2193

2982

if use_dbus:

2194

client_class = functools.partial(ClientDBusTransitional,

2195

bus = bus)

2983

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

2196

2984

2197

2985

client_settings = Client.config_parser(client_config)

2198

2986

old_client_settings = {}

2199

2987

clients_data = {}

2200

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

2201

2997

# Get client data and settings from last running state.

2202

2998

if server_settings["restore"]:

2203

2999

try:

2204

3000

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

2205

clients_data, old_client_settings = (pickle.load

2206

(stored_state))

3001

clients_data, old_client_settings = pickle.load(

3002

stored_state)

2207

3003

os.remove(stored_state_path)

2208

3004

except IOError as e:

2209

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

2210

.format(e))

2211

if e.errno != errno.ENOENT:

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)

2212

3011

raise

2213

3012

except EOFError as e:

2214

3013

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

2215

"EOFError: {0}".format(e))

3014

"EOFError:",

3015

exc_info=e)

2216

3016

2217

3017

with PGPEngine() as pgp:

2218

for client_name, client in clients_data.iteritems():

3018

for client_name, client in clients_data.items():

3019

# Skip removed clients

3020

if client_name not in client_settings:

3021

continue

3022

2219

3023

# Decide which value to use after restoring saved state.

2220

3024

# We have three different values: Old config file,

2221

3025

# new config file, and saved state.

2226

3030

# For each value in new config, check if it

2227

3031

# differs from the old config value (Except for

2228

3032

# the "secret" attribute)

2229

if (name != "secret" and

2230

value != old_client_settings[client_name]

2231

[name]):

3033

if (name != "secret"

3034

and (value !=

3035

old_client_settings[client_name][name])):

2232

3036

client[name] = value

2233

3037

except KeyError:

2234

3038

pass

2235

3039

2236

3040

# Clients who has passed its expire date can still be

2237

# enabled if its last checker was successful. Clients

3041

# enabled if its last checker was successful. A Client

2238

3042

# whose checker succeeded before we stored its state is

2239

3043

# assumed to have successfully run all checkers during

2240

3044

# downtime.

2242

3046

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

2243

3047

if not client["last_checked_ok"]:

2244

3048

logger.warning(

2245

"disabling client {0} - Client never "

2246

"performed a successful checker"

2247

.format(client_name))

3049

"disabling client {} - Client never "

3050

"performed a successful checker".format(

3051

client_name))

2248

3052

client["enabled"] = False

2249

3053

elif client["last_checker_status"] != 0:

2250

3054

logger.warning(

2251

"disabling client {0} - Client "

2252

"last checker failed with error code {1}"

2253

.format(client_name,

2254

client["last_checker_status"]))

3055

"disabling client {} - Client last"

3056

" checker failed with error code"

3057

" {}".format(

3058

client_name,

3059

client["last_checker_status"]))

2255

3060

client["enabled"] = False

2256

3061

else:

2257

client["expires"] = (datetime.datetime

2258

.utcnow()

2259

+ client["timeout"])

3062

client["expires"] = (

3063

datetime.datetime.utcnow()

3064

+ client["timeout"])

2260

3065

logger.debug("Last checker succeeded,"

2261

" keeping {0} enabled"

2262

.format(client_name))

3066

" keeping {} enabled".format(

3067

client_name))

2263

3068

try:

2264

client["secret"] = (

2265

pgp.decrypt(client["encrypted_secret"],

2266

client_settings[client_name]

2267

["secret"]))

3069

client["secret"] = pgp.decrypt(

3070

client["encrypted_secret"],

3071

client_settings[client_name]["secret"])

2268

3072

except PGPError:

2269

3073

# If decryption fails, we use secret from new settings

2270

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

2271

.format(client_name))

2272

client["secret"] = (

2273

client_settings[client_name]["secret"])

2274

3074

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

3075

client_name))

3076

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

3077

["secret"])

2275

3078

2276

3079

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

2277

3080

for client_name in (set(old_client_settings)

2280

3083

for client_name in (set(client_settings)

2281

3084

- set(old_client_settings)):

2282

3085

clients_data[client_name] = client_settings[client_name]

2283

3086

2284

3087

# Create all client objects

2285

for client_name, client in clients_data.iteritems():

3088

for client_name, client in clients_data.items():

2286

3089

tcp_server.clients[client_name] = client_class(

2287

name = client_name, settings = client)

3090

name = client_name,

3091

settings = client,

3092

server_settings = server_settings)

2288

3093

2289

3094

if not tcp_server.clients:

2290

3095

logger.warning("No clients defined")

2291

2292

if not debug:

2293

try:

2294

with pidfile:

2295

pid = os.getpid()

2296

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

2297

del pidfile

2298

except IOError:

2299

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

2300

pidfilename, pid)

2301

except NameError:

2302

# "pidfile" was never created

2303

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

2304

3107

del pidfilename

2305

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

2306

3108

2307

3109

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

2308

3110

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

2309

3111

2310

3112

if use_dbus:

2311

class MandosDBusService(dbus.service.Object):

3113

3114

@alternate_dbus_interfaces(

3115

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

3116

class MandosDBusService(DBusObjectWithObjectManager):

2312

3117

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

3118

2313

3119

def __init__(self):

2314

3120

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

3121

2315

3122

_interface = "se.recompile.Mandos"

2316

3123

2317

3124

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

2324

3131

"D-Bus signal"

2325

3132

pass

2326

3133

3134

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

3135

"true"})

2327

3136

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

2328

3137

def ClientRemoved(self, objpath, name):

2329

3138

"D-Bus signal"

2330

3139

pass

2331

3140

3141

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

3142

"true"})

2332

3143

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

2333

3144

def GetAllClients(self):

2334

3145

"D-Bus method"

2335

return dbus.Array(c.dbus_object_path

2336

for c in

3146

return dbus.Array(c.dbus_object_path for c in

2337

3147

tcp_server.clients.itervalues())

2338

3148

3149

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

3150

"true"})

2339

3151

@dbus.service.method(_interface,

2340

3152

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

2341

3153

def GetAllClientsWithProperties(self):

2342

3154

"D-Bus method"

2343

3155

return dbus.Dictionary(

2344

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

2345

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

3156

{ c.dbus_object_path: c.GetAll(

3157

"se.recompile.Mandos.Client")

3158

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

2346

3159

signature="oa{sv}")

2347

3160

2348

3161

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

2352

3165

if c.dbus_object_path == object_path:

2353

3166

del tcp_server.clients[c.name]

2354

3167

c.remove_from_connection()

2355

# Don't signal anything except ClientRemoved

3168

# Don't signal the disabling

2356

3169

c.disable(quiet=True)

2357

# Emit D-Bus signal

2358

self.ClientRemoved(object_path, c.name)

3170

# Emit D-Bus signal for removal

3171

self.client_removed_signal(c)

2359

3172

return

2360

3173

raise KeyError(object_path)

2361

3174

2362

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)

2363

3212

2364

class MandosDBusServiceTransitional(MandosDBusService):

2365

__metaclass__ = AlternateDBusNamesMetaclass

2366

mandos_dbus_service = MandosDBusServiceTransitional()

3213

mandos_dbus_service = MandosDBusService()

2367

3214

2368

3215

def cleanup():

2369

3216

"Cleanup function; run on exit"

2370

service.cleanup()

3217

if zeroconf:

3218

service.cleanup()

2371

3219

2372

3220

multiprocessing.active_children()

3221

wnull.close()

2373

3222

if not (tcp_server.clients or client_settings):

2374

3223

return

2375

3224

2386

3235

2387

3236

# A list of attributes that can not be pickled

2388

3237

# + secret.

2389

exclude = set(("bus", "changedstate", "secret",

2390

"checker"))

2391

for name, typ in (inspect.getmembers

2392

(dbus.service.Object)):

3238

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

3239

"checker", "server_settings" }

3240

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

3241

.Object):

2393

3242

exclude.add(name)

2394

3243

2395

3244

client_dict["encrypted_secret"] = (client

2402

3251

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

2403

3252

2404

3253

try:

2405

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2406

prefix="clients-",

2407

dir=os.path.dirname

2408

(stored_state_path))

2409

with os.fdopen(tempfd, "wb") as stored_state:

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:

2410

3260

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

3261

tempname = stored_state.name

2411

3262

os.rename(tempname, stored_state_path)

2412

3263

except (IOError, OSError) as e:

2413

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

2414

.format(e))

2415

3264

if not debug:

2416

3265

try:

2417

3266

os.remove(tempname)

2418

3267

except NameError:

2419

3268

pass

2420

if e.errno not in set((errno.ENOENT, errno.EACCES,

2421

errno.EEXIST)):

2422

raise e

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

2423

3276

2424

3277

# Delete all clients, and settings from config

2425

3278

while tcp_server.clients:

2426

3279

name, client = tcp_server.clients.popitem()

2427

3280

if use_dbus:

2428

3281

client.remove_from_connection()

2429

# Don't signal anything except ClientRemoved

3282

# Don't signal the disabling

2430

3283

client.disable(quiet=True)

3284

# Emit D-Bus signal for removal

2431

3285

if use_dbus:

2432

# Emit D-Bus signal

2433

mandos_dbus_service.ClientRemoved(client

2434

.dbus_object_path,

2435

client.name)

3286

mandos_dbus_service.client_removed_signal(client)

2436

3287

client_settings.clear()

2437

3288

2438

3289

atexit.register(cleanup)

2439

3290

2440

3291

for client in tcp_server.clients.itervalues():

2441

3292

if use_dbus:

2442

# Emit D-Bus signal

2443

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3293

# Emit D-Bus signal for adding

3294

mandos_dbus_service.client_added_signal(client)

2444

3295

# Need to initiate checking of clients

2445

3296

if client.enabled:

2446

3297

client.init_checker()

2449

3300

tcp_server.server_activate()

2450

3301

2451

3302

# Find out what port we got

2452

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

3303

if zeroconf:

3304

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

2453

3305

if use_ipv6:

2454

3306

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

2455

" flowinfo %d, scope_id %d"

2456

% tcp_server.socket.getsockname())

3307

" flowinfo %d, scope_id %d",

3308

*tcp_server.socket.getsockname())

2457

3309

else: # IPv4

2458

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

2459

% tcp_server.socket.getsockname())

3310

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

3311

*tcp_server.socket.getsockname())

2460

3312

2461

3313

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

2462

3314

2463

3315

try:

2464

# From the Avahi example code

2465

try:

2466

service.activate()

2467

except dbus.exceptions.DBusException as error:

2468

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

2469

cleanup()

2470

sys.exit(1)

2471

# 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

2472

3325

2473

3326

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

2474

3327

lambda *args, **kwargs:

2478

3331

logger.debug("Starting main loop")

2479

3332

main_loop.run()

2480

3333

except AvahiError as error:

2481

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

3334

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

2482

3335

cleanup()

2483

3336

sys.exit(1)

2484

3337

except KeyboardInterrupt:

2489

3342

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

2490

3343

cleanup()

2491

3344

3345

2492

3346

if __name__ == '__main__':

2493

3347

main()