/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

416

708

last_checker_status: integer between 0 and 255 reflecting exit

417

709

status of last checker. -1 reflects crashed

418

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

504

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

915

return False

628

916

629

917

def checked_ok(self):

630

918

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

631

919

self.last_checked_ok = datetime.datetime.utcnow()

632

920

self.last_checker_status = 0

921

self.last_checker_signal = None

633

922

self.bump_timeout()

634

923

635

924

def bump_timeout(self, timeout=None):

638

927

timeout = self.timeout

639

928

if self.disable_initiator_tag is not None:

640

929

gobject.source_remove(self.disable_initiator_tag)

930

self.disable_initiator_tag = None

641

931

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

642

self.disable_initiator_tag = (gobject.timeout_add

643

(timedelta_to_milliseconds

644

(timeout), self.disable))

932

self.disable_initiator_tag = gobject.timeout_add(

933

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

645

934

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

646

935

647

936

def need_approval(self):

653

942

If a checker already exists, leave it running and do

654

943

nothing."""

655

944

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

656

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

657

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

658

# client would inevitably timeout, since no checker would get

659

# 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

660

949

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

661

950

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

662

951

# should be.

663

952

664

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

665

try:

666

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

667

except (AttributeError, OSError) as error:

668

if (isinstance(error, OSError)

669

and error.errno != errno.ECHILD):

670

raise error

671

else:

672

if pid:

673

logger.warning("Checker was a zombie")

674

gobject.source_remove(self.checker_callback_tag)

675

self.checker_callback(pid, status,

676

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

677

957

# Start a new checker if needed

678

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 }

679

963

try:

680

# In case checker_command has exactly one % operator

681

command = self.checker_command % self.host

682

except TypeError:

683

# Escape attributes for the shell

684

escaped_attrs = dict(

685

(attr,

686

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

687

errors=

688

'replace')))

689

for attr in

690

self.runtime_expansions)

691

692

try:

693

command = self.checker_command % escaped_attrs

694

except TypeError as error:

695

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

696

' %s', self.checker_command, error)

697

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

698

970

self.current_checker_command = command

699

try:

700

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

701

command, self.name)

702

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

703

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

704

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

705

# always replaced by /dev/null.)

706

self.checker = subprocess.Popen(command,

707

close_fds=True,

708

shell=True, cwd="/")

709

self.checker_callback_tag = (gobject.child_watch_add

710

(self.checker.pid,

711

self.checker_callback,

712

data=command))

713

# The checker may have completed before the gobject

714

# watch was added. Check for this.

715

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

716

if pid:

717

gobject.source_remove(self.checker_callback_tag)

718

self.checker_callback(pid, status, command)

719

except OSError as error:

720

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

721

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)

722

996

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

723

997

return True

724

998

730

1004

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

731

1005

return

732

1006

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

733

try:

734

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

735

#time.sleep(0.5)

736

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

737

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

738

except OSError as error:

739

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

740

raise

1007

self.checker.terminate()

741

1008

self.checker = None

742

1009

743

1010

744

def dbus_service_property(dbus_interface, signature="v",

745

access="readwrite", byte_arrays=False):

1011

def dbus_service_property(dbus_interface,

1012

signature="v",

1013

access="readwrite",

1014

byte_arrays=False):

746

1015

"""Decorators for marking methods of a DBusObjectWithProperties to

747

1016

become properties on the D-Bus.

748

1017

757

1026

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

758

1027

if byte_arrays and signature != "ay":

759

1028

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

760

" signature %r" % signature)

1029

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

1030

761

1031

def decorator(func):

762

1032

func._dbus_is_property = True

763

1033

func._dbus_interface = dbus_interface

768

1038

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

769

1039

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

770

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

771

1085

return decorator

772

1086

773

1087

774

1088

class DBusPropertyException(dbus.exceptions.DBusException):

775

1089

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

776

1090

"""

777

def __unicode__(self):

778

return unicode(str(self))

1091

pass

779

1092

780

1093

781

1094

class DBusPropertyAccessException(DBusPropertyException):

790

1103

pass

791

1104

792

1105

793

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

794

1196

"""A D-Bus object with properties.

795

1197

796

1198

Classes inheriting from this can use the dbus_service_property

798

1200

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

799

1201

"""

800

1202

801

@staticmethod

802

def _is_dbus_property(obj):

803

return getattr(obj, "_dbus_is_property", False)

804

805

def _get_all_dbus_properties(self):

806

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

807

"""

808

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

809

for cls in self.__class__.__mro__

810

for name, prop in

811

inspect.getmembers(cls, self._is_dbus_property))

812

813

1203

def _get_dbus_property(self, interface_name, property_name):

814

1204

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

815

1205

property with the specified name and interface.

816

1206

"""

817

for cls in self.__class__.__mro__:

818

for name, value in (inspect.getmembers

819

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

820

1210

if (value._dbus_name == property_name

821

1211

and value._dbus_interface == interface_name):

822

1212

return value.__get__(self)

823

1213

824

1214

# No such property

825

raise DBusPropertyNotFound(self.dbus_object_path + ":"

826

+ interface_name + "."

827

+ property_name)

828

829

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

830

1229

out_signature="v")

831

1230

def Get(self, interface_name, property_name):

832

1231

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

850

1249

# The byte_arrays option is not supported yet on

851

1250

# signatures other than "ay".

852

1251

if prop._dbus_signature != "ay":

853

raise ValueError

1252

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

1253

"'ay' signature {!r}"

1254

.format(prop._dbus_signature))

854

1255

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

855

1256

for byte in value))

856

1257

prop(value)

857

1258

858

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

1259

@dbus.service.method(dbus.PROPERTIES_IFACE,

1260

in_signature="s",

859

1261

out_signature="a{sv}")

860

1262

def GetAll(self, interface_name):

861

1263

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

864

1266

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

865

1267

"""

866

1268

properties = {}

867

for name, prop in self._get_all_dbus_properties():

1269

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

868

1270

if (interface_name

869

1271

and interface_name != prop._dbus_interface):

870

1272

# Interface non-empty but did not match

876

1278

if not hasattr(value, "variant_level"):

877

1279

properties[name] = value

878

1280

continue

879

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

880

value.variant_level+1)

1281

properties[name] = type(value)(

1282

value, variant_level = value.variant_level + 1)

881

1283

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

882

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

883

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

884

1294

out_signature="s",

885

1295

path_keyword='object_path',

886

1296

connection_keyword='connection')

887

1297

def Introspect(self, object_path, connection):

888

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

889

1301

"""

890

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

891

connection)

1302

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1303

object_path,

1304

connection)

892

1305

try:

893

1306

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

1307

894

1308

def make_tag(document, name, prop):

895

1309

e = document.createElement("property")

896

1310

e.setAttribute("name", name)

897

1311

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

898

1312

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

899

1313

return e

1314

900

1315

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

1316

# Add property tags

901

1317

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

902

1318

for name, prop

903

in self._get_all_dbus_properties()

1319

in self._get_all_dbus_things("property")

904

1320

if prop._dbus_interface

905

1321

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

906

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)

907

1339

# Add the names to the return values for the

908

1340

# "org.freedesktop.DBus.Properties" methods

909

1341

if (if_tag.getAttribute("name")

924

1356

except (AttributeError, xml.dom.DOMException,

925

1357

xml.parsers.expat.ExpatError) as error:

926

1358

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

927

error)

928

return xmlstring

929

930

931

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

932

1432

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

933

1433

if dt is None:

934

1434

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

935

return dbus.String(dt.isoformat(),

936

variant_level=variant_level)

937

938

939

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

940

.__metaclass__):

941

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

942

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

943

1460

"""

944

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

945

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

946

# methods, signals, or properties in them

947

for base in (b for b in bases

948

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

949

# Go though all attributes of the base class

950

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

951

1469

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

952

1470

# with the wrong interface name

953

1471

if (not hasattr(attribute, "_dbus_interface")

954

or not attribute._dbus_interface

955

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

1472

or not attribute._dbus_interface.startswith(

1473

orig_interface_name)):

956

1474

continue

957

1475

# Create an alternate D-Bus interface name based on

958

1476

# the current name

959

alt_interface = (attribute._dbus_interface

960

.replace("se.recompile.Mandos",

961

"se.bsnet.fukt.Mandos"))

1477

alt_interface = attribute._dbus_interface.replace(

1478

orig_interface_name, alt_interface_name)

1479

interface_names.add(alt_interface)

962

1480

# Is this a D-Bus signal?

963

1481

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

964

# Extract the original non-method function by

965

# black magic

966

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(

967

1486

zip(attribute.func_code.co_freevars,

968

attribute.__closure__))["func"]

969

.cell_contents)

1487

attribute.__closure__))

1488

["func"].cell_contents)

1489

else:

1490

nonmethod_func = attribute

970

1491

# Create a new, but exactly alike, function

971

1492

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

972

1493

# with the alternate D-Bus interface name

973

new_function = (dbus.service.signal

974

(alt_interface,

975

attribute._dbus_signature)

976

(types.FunctionType(

977

nonmethod_func.func_code,

978

nonmethod_func.func_globals,

979

nonmethod_func.func_name,

980

nonmethod_func.func_defaults,

981

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

982

1517

# Define a creator of a function to call both the

983

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

984

# 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

985

1521

def fixscope(func1, func2):

986

1522

"""This function is a scope container to pass

987

1523

func1 and func2 to the "call_both" function

988

1524

outside of its arguments"""

1525

1526

@functools.wraps(func2)

989

1527

def call_both(*args, **kwargs):

990

1528

"""This function will emit two D-Bus

991

1529

signals by calling func1 and func2"""

992

1530

func1(*args, **kwargs)

993

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

994

1537

return call_both

995

1538

# Create the "call_both" function and add it to

996

1539

# the class

997

attr[attrname] = fixscope(attribute,

998

new_function)

1540

attr[attrname] = fixscope(attribute, new_function)

999

1541

# Is this a D-Bus method?

1000

1542

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

1001

1543

# Create a new, but exactly alike, function

1002

1544

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

1003

1545

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

1004

1546

# to the class.

1005

attr[attrname] = (dbus.service.method

1006

(alt_interface,

1007

attribute._dbus_in_signature,

1008

attribute._dbus_out_signature)

1009

(types.FunctionType

1010

(attribute.func_code,

1011

attribute.func_globals,

1012

attribute.func_name,

1013

attribute.func_defaults,

1014

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

1015

1563

# Is this a D-Bus property?

1016

1564

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

1017

1565

# Create a new, but exactly alike, function

1018

1566

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

1019

1567

# property with the alternate D-Bus interface

1020

1568

# name. Add it to the class.

1021

attr[attrname] = (dbus_service_property

1022

(alt_interface,

1023

attribute._dbus_signature,

1024

attribute._dbus_access,

1025

attribute

1026

._dbus_get_args_options

1027

["byte_arrays"])

1028

(types.FunctionType

1029

(attribute.func_code,

1030

attribute.func_globals,

1031

attribute.func_name,

1032

attribute.func_defaults,

1033

attribute.func_closure)))

1034

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

1035

1036

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

1037

1626

class ClientDBus(Client, DBusObjectWithProperties):

1038

1627

"""A Client class using D-Bus

1039

1628

1043

1632

"""

1044

1633

1045

1634

runtime_expansions = (Client.runtime_expansions

1046

+ ("dbus_object_path",))

1635

+ ("dbus_object_path", ))

1636

1637

_interface = "se.recompile.Mandos.Client"

1047

1638

1048

1639

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

1049

1640

1052

1643

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

1053

1644

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

1054

1645

# the D-Bus

1055

client_object_name = unicode(self.name).translate(

1646

client_object_name = str(self.name).translate(

1056

1647

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

1057

1648

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

1058

self.dbus_object_path = (dbus.ObjectPath

1059

("/clients/" + client_object_name))

1649

self.dbus_object_path = dbus.ObjectPath(

1650

"/clients/" + client_object_name)

1060

1651

DBusObjectWithProperties.__init__(self, self.bus,

1061

1652

self.dbus_object_path)

1062

1063

def notifychangeproperty(transform_func,

1064

dbus_name, type_func=lambda x: x,

1065

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

1066

1659

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

1067

1660

its changes to DBus.

1068

1661

1073

1666

to the D-Bus. Default: no transform

1074

1667

variant_level: D-Bus variant level. Default: 1

1075

1668

"""

1076

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

1669

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

1670

1077

1671

def setter(self, value):

1078

1672

if hasattr(self, "dbus_object_path"):

1079

1673

if (not hasattr(self, attrname) or

1080

1674

type_func(getattr(self, attrname, None))

1081

1675

!= type_func(value)):

1082

dbus_value = transform_func(type_func(value),

1083

variant_level

1084

=variant_level)

1085

self.PropertyChanged(dbus.String(dbus_name),

1086

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

1087

1691

setattr(self, attrname, value)

1088

1692

1089

1693

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

1090

1694

1091

1092

1695

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1093

1696

approvals_pending = notifychangeproperty(dbus.Boolean,

1094

1697

"ApprovalPending",

1096

1699

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

1097

1700

last_enabled = notifychangeproperty(datetime_to_dbus,

1098

1701

"LastEnabled")

1099

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

1100

type_func = lambda checker:

1101

checker is not None)

1702

checker = notifychangeproperty(

1703

dbus.Boolean, "CheckerRunning",

1704

type_func = lambda checker: checker is not None)

1102

1705

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1103

1706

"LastCheckedOK")

1104

1707

last_checker_status = notifychangeproperty(dbus.Int16,

1107

1710

datetime_to_dbus, "LastApprovalRequest")

1108

1711

approved_by_default = notifychangeproperty(dbus.Boolean,

1109

1712

"ApprovedByDefault")

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1713

approval_delay = notifychangeproperty(

1714

dbus.UInt64, "ApprovalDelay",

1715

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

1114

1716

approval_duration = notifychangeproperty(

1115

1717

dbus.UInt64, "ApprovalDuration",

1116

type_func = timedelta_to_milliseconds)

1718

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

1117

1719

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1720

timeout = notifychangeproperty(

1721

dbus.UInt64, "Timeout",

1722

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

1121

1723

extended_timeout = notifychangeproperty(

1122

1724

dbus.UInt64, "ExtendedTimeout",

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

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)

1128

1729

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

1730

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

1731

invalidate_only=True)

1129

1732

1130

1733

del notifychangeproperty

1131

1734

1138

1741

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

1139

1742

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

1140

1743

1141

def checker_callback(self, pid, condition, command,

1142

*args, **kwargs):

1143

self.checker_callback_tag = None

1144

self.checker = None

1145

if os.WIFEXITED(condition):

1146

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:

1147

1751

# Emit D-Bus signal

1148

1752

self.CheckerCompleted(dbus.Int16(exitstatus),

1149

dbus.Int64(condition),

1753

# This is specific to GNU libC

1754

dbus.Int64(exitstatus << 8),

1150

1755

dbus.String(command))

1151

1756

else:

1152

1757

# Emit D-Bus signal

1153

1758

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

1154

dbus.Int64(condition),

1759

dbus.Int64(

1760

# This is specific to GNU libC

1761

(exitstatus << 8)

1762

| self.last_checker_signal),

1155

1763

dbus.String(command))

1156

1157

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

1158

*args, **kwargs)

1764

return ret

1159

1765

1160

1766

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

1161

old_checker = self.checker

1162

if self.checker is not None:

1163

old_checker_pid = self.checker.pid

1164

else:

1165

old_checker_pid = None

1767

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

1166

1768

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

1167

1769

# Only if new checker process was started

1168

1770

if (self.checker is not None

1176

1778

return False

1177

1779

1178

1780

def approve(self, value=True):

1179

self.send_changedstate()

1180

1781

self.approved = value

1181

gobject.timeout_add(timedelta_to_milliseconds

1182

(self.approval_duration),

1183

self._reset_approved)

1184

1782

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

1783

* 1000), self._reset_approved)

1784

self.send_changedstate()

1185

1785

1186

1786

## D-Bus methods, signals & properties

1187

_interface = "se.recompile.Mandos.Client"

1787

1788

## Interfaces

1188

1789

1189

1790

## Signals

1190

1791

1201

1802

pass

1202

1803

1203

1804

# PropertyChanged - signal

1805

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

1204

1806

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

1205

1807

def PropertyChanged(self, property, value):

1206

1808

"D-Bus signal"

1240

1842

self.checked_ok()

1241

1843

1242

1844

# Enable - method

1845

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

1243

1846

@dbus.service.method(_interface)

1244

1847

def Enable(self):

1245

1848

"D-Bus method"

1246

1849

self.enable()

1247

1850

1248

1851

# StartChecker - method

1852

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

1249

1853

@dbus.service.method(_interface)

1250

1854

def StartChecker(self):

1251

1855

"D-Bus method"

1252

1856

self.start_checker()

1253

1857

1254

1858

# Disable - method

1859

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

1255

1860

@dbus.service.method(_interface)

1256

1861

def Disable(self):

1257

1862

"D-Bus method"

1258

1863

self.disable()

1259

1864

1260

1865

# StopChecker - method

1866

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

1261

1867

@dbus.service.method(_interface)

1262

1868

def StopChecker(self):

1263

1869

self.stop_checker()

1270

1876

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

1271

1877

1272

1878

# ApprovedByDefault - property

1273

@dbus_service_property(_interface, signature="b",

1879

@dbus_service_property(_interface,

1880

signature="b",

1274

1881

access="readwrite")

1275

1882

def ApprovedByDefault_dbus_property(self, value=None):

1276

1883

if value is None: # get

1278

1885

self.approved_by_default = bool(value)

1279

1886

1280

1887

# ApprovalDelay - property

1281

@dbus_service_property(_interface, signature="t",

1888

@dbus_service_property(_interface,

1889

signature="t",

1282

1890

access="readwrite")

1283

1891

def ApprovalDelay_dbus_property(self, value=None):

1284

1892

if value is None: # get

1285

return dbus.UInt64(self.approval_delay_milliseconds())

1893

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

1894

* 1000)

1286

1895

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

1287

1896

1288

1897

# ApprovalDuration - property

1289

@dbus_service_property(_interface, signature="t",

1898

@dbus_service_property(_interface,

1899

signature="t",

1290

1900

access="readwrite")

1291

1901

def ApprovalDuration_dbus_property(self, value=None):

1292

1902

if value is None: # get

1293

return dbus.UInt64(timedelta_to_milliseconds(

1294

self.approval_duration))

1903

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

1904

* 1000)

1295

1905

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

1296

1906

1297

1907

# Name - property

1908

@dbus_annotations(

1909

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

1298

1910

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

1299

1911

def Name_dbus_property(self):

1300

1912

return dbus.String(self.name)

1301

1913

1302

1914

# Fingerprint - property

1915

@dbus_annotations(

1916

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

1303

1917

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

1304

1918

def Fingerprint_dbus_property(self):

1305

1919

return dbus.String(self.fingerprint)

1306

1920

1307

1921

# Host - property

1308

@dbus_service_property(_interface, signature="s",

1922

@dbus_service_property(_interface,

1923

signature="s",

1309

1924

access="readwrite")

1310

1925

def Host_dbus_property(self, value=None):

1311

1926

if value is None: # get

1312

1927

return dbus.String(self.host)

1313

self.host = unicode(value)

1928

self.host = str(value)

1314

1929

1315

1930

# Created - property

1931

@dbus_annotations(

1932

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

1316

1933

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

1317

1934

def Created_dbus_property(self):

1318

1935

return datetime_to_dbus(self.created)

1323

1940

return datetime_to_dbus(self.last_enabled)

1324

1941

1325

1942

# Enabled - property

1326

@dbus_service_property(_interface, signature="b",

1943

@dbus_service_property(_interface,

1944

signature="b",

1327

1945

access="readwrite")

1328

1946

def Enabled_dbus_property(self, value=None):

1329

1947

if value is None: # get

1334

1952

self.disable()

1335

1953

1336

1954

# LastCheckedOK - property

1337

@dbus_service_property(_interface, signature="s",

1955

@dbus_service_property(_interface,

1956

signature="s",

1338

1957

access="readwrite")

1339

1958

def LastCheckedOK_dbus_property(self, value=None):

1340

1959

if value is not None:

1343

1962

return datetime_to_dbus(self.last_checked_ok)

1344

1963

1345

1964

# LastCheckerStatus - property

1346

@dbus_service_property(_interface, signature="n",

1347

access="read")

1965

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

1348

1966

def LastCheckerStatus_dbus_property(self):

1349

1967

return dbus.Int16(self.last_checker_status)

1350

1968

1359

1977

return datetime_to_dbus(self.last_approval_request)

1360

1978

1361

1979

# Timeout - property

1362

@dbus_service_property(_interface, signature="t",

1980

@dbus_service_property(_interface,

1981

signature="t",

1363

1982

access="readwrite")

1364

1983

def Timeout_dbus_property(self, value=None):

1365

1984

if value is None: # get

1366

return dbus.UInt64(self.timeout_milliseconds())

1985

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

1986

old_timeout = self.timeout

1367

1987

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

1368

# Reschedule timeout

1988

# Reschedule disabling

1369

1989

if self.enabled:

1370

1990

now = datetime.datetime.utcnow()

1371

time_to_die = timedelta_to_milliseconds(

1372

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

1373

if time_to_die <= 0:

1991

self.expires += self.timeout - old_timeout

1992

if self.expires <= now:

1374

1993

# The timeout has passed

1375

1994

self.disable()

1376

1995

else:

1377

self.expires = (now +

1378

datetime.timedelta(milliseconds =

1379

time_to_die))

1380

1996

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

1381

1997

is None):

1382

1998

return

1383

1999

gobject.source_remove(self.disable_initiator_tag)

1384

self.disable_initiator_tag = (gobject.timeout_add

1385

(time_to_die,

1386

self.disable))

2000

self.disable_initiator_tag = gobject.timeout_add(

2001

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

2002

self.disable)

1387

2003

1388

2004

# ExtendedTimeout - property

1389

@dbus_service_property(_interface, signature="t",

2005

@dbus_service_property(_interface,

2006

signature="t",

1390

2007

access="readwrite")

1391

2008

def ExtendedTimeout_dbus_property(self, value=None):

1392

2009

if value is None: # get

1393

return dbus.UInt64(self.extended_timeout_milliseconds())

2010

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

2011

* 1000)

1394

2012

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

1395

2013

1396

2014

# Interval - property

1397

@dbus_service_property(_interface, signature="t",

2015

@dbus_service_property(_interface,

2016

signature="t",

1398

2017

access="readwrite")

1399

2018

def Interval_dbus_property(self, value=None):

1400

2019

if value is None: # get

1401

return dbus.UInt64(self.interval_milliseconds())

2020

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

1402

2021

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

1403

2022

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

1404

2023

return

1405

2024

if self.enabled:

1406

2025

# Reschedule checker run

1407

2026

gobject.source_remove(self.checker_initiator_tag)

1408

self.checker_initiator_tag = (gobject.timeout_add

1409

(value, self.start_checker))

1410

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

1411

2030

1412

2031

# Checker - property

1413

@dbus_service_property(_interface, signature="s",

2032

@dbus_service_property(_interface,

2033

signature="s",

1414

2034

access="readwrite")

1415

2035

def Checker_dbus_property(self, value=None):

1416

2036

if value is None: # get

1417

2037

return dbus.String(self.checker_command)

1418

self.checker_command = unicode(value)

2038

self.checker_command = str(value)

1419

2039

1420

2040

# CheckerRunning - property

1421

@dbus_service_property(_interface, signature="b",

2041

@dbus_service_property(_interface,

2042

signature="b",

1422

2043

access="readwrite")

1423

2044

def CheckerRunning_dbus_property(self, value=None):

1424

2045

if value is None: # get

1429

2050

self.stop_checker()

1430

2051

1431

2052

# ObjectPath - property

2053

@dbus_annotations(

2054

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

2055

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

1432

2056

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

1433

2057

def ObjectPath_dbus_property(self):

1434

2058

return self.dbus_object_path # is already a dbus.ObjectPath

1435

2059

1436

2060

# Secret = property

1437

@dbus_service_property(_interface, signature="ay",

1438

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)

1439

2068

def Secret_dbus_property(self, value):

1440

self.secret = str(value)

2069

self.secret = bytes(value)

1441

2070

1442

2071

del _interface

1443

2072

1447

2076

self._pipe = child_pipe

1448

2077

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

1449

2078

if not self._pipe.recv():

1450

raise KeyError()

2079

raise KeyError(fpr)

1451

2080

1452

2081

def __getattribute__(self, name):

1453

2082

if name == '_pipe':

1457

2086

if data[0] == 'data':

1458

2087

return data[1]

1459

2088

if data[0] == 'function':

2089

1460

2090

def func(*args, **kwargs):

1461

2091

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

1462

2092

return self._pipe.recv()[1]

2093

1463

2094

return func

1464

2095

1465

2096

def __setattr__(self, name, value):

1468

2099

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

1469

2100

1470

2101

1471

class ClientDBusTransitional(ClientDBus):

1472

__metaclass__ = AlternateDBusNamesMetaclass

1473

1474

1475

2102

class ClientHandler(socketserver.BaseRequestHandler, object):

1476

2103

"""A class to handle client connections.

1477

2104

1481

2108

def handle(self):

1482

2109

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

1483

2110

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

1484

unicode(self.client_address))

2111

str(self.client_address))

1485

2112

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

1486

2113

self.server.child_pipe.fileno())

1487

2114

1488

session = (gnutls.connection

1489

.ClientSession(self.request,

1490

gnutls.connection

1491

.X509Credentials()))

1492

1493

# Note: gnutls.connection.X509Credentials is really a

1494

# generic GnuTLS certificate credentials object so long as

1495

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

1496

# here despite using OpenPGP certificates.

2115

session = gnutls.ClientSession(self.request)

1497

2116

1498

2117

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

1499

2118

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

1503

2122

priority = self.server.gnutls_priority

1504

2123

if priority is None:

1505

2124

priority = "NORMAL"

1506

(gnutls.library.functions

1507

.gnutls_priority_set_direct(session._c_object,

1508

priority, None))

2125

gnutls.priority_set_direct(session._c_object, priority,

2126

None)

1509

2127

1510

2128

# Start communication using the Mandos protocol

1511

2129

# Get protocol number

1513

2131

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

1514

2132

try:

1515

2133

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

1516

raise RuntimeError

2134

raise RuntimeError(line)

1517

2135

except (ValueError, IndexError, RuntimeError) as error:

1518

2136

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

1519

2137

return

1521

2139

# Start GnuTLS connection

1522

2140

try:

1523

2141

session.handshake()

1524

except gnutls.errors.GNUTLSError as error:

2142

except gnutls.Error as error:

1525

2143

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

1526

2144

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

1527

2145

# established. Just abandon the request.

1531

2149

approval_required = False

1532

2150

try:

1533

2151

try:

1534

fpr = self.fingerprint(self.peer_certificate

1535

(session))

1536

except (TypeError,

1537

gnutls.errors.GNUTLSError) as error:

2152

fpr = self.fingerprint(

2153

self.peer_certificate(session))

2154

except (TypeError, gnutls.Error) as error:

1538

2155

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

1539

2156

return

1540

2157

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

1553

2170

while True:

1554

2171

if not client.enabled:

1555

2172

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

1556

client.name)

2173

client.name)

1557

2174

if self.server.use_dbus:

1558

2175

# Emit D-Bus signal

1559

2176

client.Rejected("Disabled")

1568

2185

if self.server.use_dbus:

1569

2186

# Emit D-Bus signal

1570

2187

client.NeedApproval(

1571

client.approval_delay_milliseconds(),

1572

client.approved_by_default)

2188

client.approval_delay.total_seconds()

2189

* 1000, client.approved_by_default)

1573

2190

else:

1574

2191

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

1575

2192

client.name)

1581

2198

#wait until timeout or approved

1582

2199

time = datetime.datetime.now()

1583

2200

client.changedstate.acquire()

1584

(client.changedstate.wait

1585

(float(client.timedelta_to_milliseconds(delay)

1586

/ 1000)))

2201

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

1587

2202

client.changedstate.release()

1588

2203

time2 = datetime.datetime.now()

1589

2204

if (time2 - time) >= delay:

1604

2219

while sent_size < len(client.secret):

1605

2220

try:

1606

2221

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

1607

except gnutls.errors.GNUTLSError as error:

1608

logger.warning("gnutls send failed")

2222

except gnutls.Error as error:

2223

logger.warning("gnutls send failed",

2224

exc_info=error)

1609

2225

return

1610

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

1611

sent, len(client.secret)

1612

- (sent_size + sent))

2226

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

2227

len(client.secret) - (sent_size

2228

+ sent))

1613

2229

sent_size += sent

1614

2230

1615

2231

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

1624

2240

client.approvals_pending -= 1

1625

2241

try:

1626

2242

session.bye()

1627

except gnutls.errors.GNUTLSError as error:

1628

logger.warning("GnuTLS bye failed")

2243

except gnutls.Error as error:

2244

logger.warning("GnuTLS bye failed",

2245

exc_info=error)

1629

2246

1630

2247

@staticmethod

1631

2248

def peer_certificate(session):

1632

2249

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

1633

2250

# If not an OpenPGP certificate...

1634

if (gnutls.library.functions

1635

.gnutls_certificate_type_get(session._c_object)

1636

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1637

# ...do the normal thing

1638

return session.peer_certificate

2251

if (gnutls.certificate_type_get(session._c_object)

2252

!= gnutls.CRT_OPENPGP):

2253

# ...return invalid data

2254

return b""

1639

2255

list_size = ctypes.c_uint(1)

1640

cert_list = (gnutls.library.functions

1641

.gnutls_certificate_get_peers

2256

cert_list = (gnutls.certificate_get_peers

1642

2257

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

1643

2258

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

1644

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

1645

" certificate")

2259

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

1646

2260

if list_size.value == 0:

1647

2261

return None

1648

2262

cert = cert_list[0]

1652

2266

def fingerprint(openpgp):

1653

2267

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1654

2268

# New GnuTLS "datum" with the OpenPGP public key

1655

datum = (gnutls.library.types

1656

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

1657

ctypes.POINTER

1658

(ctypes.c_ubyte)),

1659

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

1660

2273

# New empty GnuTLS certificate

1661

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2274

crt = gnutls.openpgp_crt_t()

2275

gnutls.openpgp_crt_init(ctypes.byref(crt))

1664

2276

# Import the OpenPGP public key into the certificate

1665

(gnutls.library.functions

1666

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

1667

gnutls.library.constants

1668

.GNUTLS_OPENPGP_FMT_RAW))

2277

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

2278

gnutls.OPENPGP_FMT_RAW)

1669

2279

# Verify the self signature in the key

1670

2280

crtverify = ctypes.c_uint()

1671

(gnutls.library.functions

1672

.gnutls_openpgp_crt_verify_self(crt, 0,

1673

ctypes.byref(crtverify)))

2281

gnutls.openpgp_crt_verify_self(crt, 0,

2282

ctypes.byref(crtverify))

1674

2283

if crtverify.value != 0:

1675

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1676

raise (gnutls.errors.CertificateSecurityError

1677

("Verify failed"))

2284

gnutls.openpgp_crt_deinit(crt)

2285

raise gnutls.CertificateSecurityError("Verify failed")

1678

2286

# New buffer for the fingerprint

1679

2287

buf = ctypes.create_string_buffer(20)

1680

2288

buf_len = ctypes.c_size_t()

1681

2289

# Get the fingerprint from the certificate into the buffer

1682

(gnutls.library.functions

1683

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

1684

ctypes.byref(buf_len)))

2290

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

2291

ctypes.byref(buf_len))

1685

2292

# Deinit the certificate

1686

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2293

gnutls.openpgp_crt_deinit(crt)

1687

2294

# Convert the buffer to a Python bytestring

1688

2295

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

1689

2296

# Convert the bytestring to hexadecimal notation

1693

2300

1694

2301

class MultiprocessingMixIn(object):

1695

2302

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

2303

1696

2304

def sub_process_main(self, request, address):

1697

2305

try:

1698

2306

self.finish_request(request, address)

1703

2311

def process_request(self, request, address):

1704

2312

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

1705

2313

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

1706

args = (request,

1707

address))

2314

args = (request, address))

1708

2315

proc.start()

1709

2316

return proc

1710

2317

1711

2318

1712

2319

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1713

2320

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

2321

1714

2322

def process_request(self, request, client_address):

1715

2323

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

1716

2324

1725

2333

1726

2334

def add_pipe(self, parent_pipe, proc):

1727

2335

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

1728

raise NotImplementedError

2336

raise NotImplementedError()

1729

2337

1730

2338

1731

2339

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1737

2345

interface: None or a network interface name (string)

1738

2346

use_ipv6: Boolean; to use IPv6 or not

1739

2347

"""

2348

1740

2349

def __init__(self, server_address, RequestHandlerClass,

1741

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

"""

1742

2356

self.interface = interface

1743

2357

if use_ipv6:

1744

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.

1745

2385

socketserver.TCPServer.__init__(self, server_address,

1746

2386

RequestHandlerClass)

2387

1747

2388

def server_bind(self):

1748

2389

"""This overrides the normal server_bind() function

1749

2390

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

1755

2396

self.interface)

1756

2397

else:

1757

2398

try:

1758

self.socket.setsockopt(socket.SOL_SOCKET,

1759

SO_BINDTODEVICE,

1760

str(self.interface

1761

+ '\0'))

2399

self.socket.setsockopt(

2400

socket.SOL_SOCKET, SO_BINDTODEVICE,

2401

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

1762

2402

except socket.error as error:

1763

if error[0] == errno.EPERM:

1764

logger.error("No permission to"

1765

" bind to interface %s",

1766

self.interface)

1767

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:

1768

2407

logger.error("SO_BINDTODEVICE not available;"

1769

2408

" cannot bind to interface %s",

1770

2409

self.interface)

2410

elif error.errno == errno.ENODEV:

2411

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

2412

" cannot bind", self.interface)

1771

2413

else:

1772

2414

raise

1773

2415

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

1776

2418

if self.address_family == socket.AF_INET6:

1777

2419

any_address = "::" # in6addr_any

1778

2420

else:

1779

any_address = socket.INADDR_ANY

2421

any_address = "0.0.0.0" # INADDR_ANY

1780

2422

self.server_address = (any_address,

1781

2423

self.server_address[1])

1782

2424

elif not self.server_address[1]:

1783

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

1784

0)

2425

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

1785

2426

# if self.interface:

1786

2427

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

1787

2428

# 0, # port

1801

2442

1802

2443

Assumes a gobject.MainLoop event loop.

1803

2444

"""

2445

1804

2446

def __init__(self, server_address, RequestHandlerClass,

1805

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

1806

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

1807

2453

self.enabled = False

1808

2454

self.clients = clients

1809

2455

if self.clients is None:

1813

2459

IPv6_TCPServer.__init__(self, server_address,

1814

2460

RequestHandlerClass,

1815

2461

interface = interface,

1816

use_ipv6 = use_ipv6)

2462

use_ipv6 = use_ipv6,

2463

socketfd = socketfd)

2464

1817

2465

def server_activate(self):

1818

2466

if self.enabled:

1819

2467

return socketserver.TCPServer.server_activate(self)

1823

2471

1824

2472

def add_pipe(self, parent_pipe, proc):

1825

2473

# Call "handle_ipc" for both data and EOF events

1826

gobject.io_add_watch(parent_pipe.fileno(),

1827

gobject.IO_IN | gobject.IO_HUP,

1828

functools.partial(self.handle_ipc,

1829

parent_pipe =

1830

parent_pipe,

1831

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

1832

2480

1833

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

1834

proc = None, client_object=None):

1835

condition_names = {

1836

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

1837

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

1838

# blocking).

1839

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

1840

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

1841

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

1842

# broken, usually for pipes and

1843

# sockets).

1844

}

1845

conditions_string = ' | '.join(name

1846

for cond, name in

1847

condition_names.iteritems()

1848

if cond & condition)

2481

def handle_ipc(self, source, condition,

2482

parent_pipe=None,

2483

proc = None,

2484

client_object=None):

1849

2485

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

1850

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

2486

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

1851

2487

# Wait for other process to exit

1852

2488

proc.join()

1853

2489

return False

1874

2510

parent_pipe.send(False)

1875

2511

return False

1876

2512

1877

gobject.io_add_watch(parent_pipe.fileno(),

1878

gobject.IO_IN | gobject.IO_HUP,

1879

functools.partial(self.handle_ipc,

1880

parent_pipe =

1881

parent_pipe,

1882

proc = proc,

1883

client_object =

1884

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

1885

2520

parent_pipe.send(True)

1886

2521

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

1887

2522

# same fileno

1893

2528

1894

2529

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

1895

2530

funcname)(*args,

1896

**kwargs)))

2531

**kwargs)))

1897

2532

1898

2533

if command == 'getattr':

1899

2534

attrname = request[1]

1900

if callable(client_object.__getattribute__(attrname)):

1901

parent_pipe.send(('function',))

2535

if isinstance(client_object.__getattribute__(attrname),

2536

collections.Callable):

2537

parent_pipe.send(('function', ))

1902

2538

else:

1903

parent_pipe.send(('data', client_object

1904

.__getattribute__(attrname)))

2539

parent_pipe.send((

2540

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

1905

2541

1906

2542

if command == 'setattr':

1907

2543

attrname = request[1]

1911

2547

return True

1912

2548

1913

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

1914

2646

def string_to_delta(interval):

1915

2647

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

1916

2648

1927

2659

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

1928

2660

datetime.timedelta(0, 330)

1929

2661

"""

2662

2663

try:

2664

return rfc3339_duration_to_delta(interval)

2665

except ValueError:

2666

pass

2667

1930

2668

timevalue = datetime.timedelta(0)

1931

2669

for s in interval.split():

1932

2670

try:

1933

suffix = unicode(s[-1])

2671

suffix = s[-1]

1934

2672

value = int(s[:-1])

1935

2673

if suffix == "d":

1936

2674

delta = datetime.timedelta(value)

1943

2681

elif suffix == "w":

1944

2682

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

1945

2683

else:

1946

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

1947

except (ValueError, IndexError) as e:

2684

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

2685

except IndexError as e:

1948

2686

raise ValueError(*(e.args))

1949

2687

timevalue += delta

1950

2688

return timevalue

1963

2701

sys.exit()

1964

2702

if not noclose:

1965

2703

# Close all standard open file descriptors

1966

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

2704

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

1967

2705

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

1968

2706

raise OSError(errno.ENODEV,

1969

"%s not a character device"

1970

% os.path.devnull)

2707

"{} not a character device"

2708

.format(os.devnull))

1971

2709

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

1972

2710

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

1973

2711

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

1982

2720

1983

2721

parser = argparse.ArgumentParser()

1984

2722

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

1985

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

2723

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

1986

2724

help="show version number and exit")

1987

2725

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

1988

2726

help="Bind to interface IF")

1994

2732

help="Run self-test")

1995

2733

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

1996

2734

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

1997

" to terminal")

2735

" to terminal", default=None)

1998

2736

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

1999

2737

help="Debug level for stdout output")

2000

2738

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

2007

2745

" files")

2008

2746

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

2009

2747

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

2010

" system bus interface")

2748

" system bus interface", default=None)

2011

2749

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

2012

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

2750

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

2751

default=None)

2013

2752

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

2014

2753

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

2015

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

2016

2758

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

2017

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)

2018

2765

2019

2766

options = parser.parse_args()

2020

2767

2021

2768

if options.check:

2022

2769

import doctest

2023

doctest.testmod()

2024

sys.exit()

2770

fail_count, test_count = doctest.testmod()

2771

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

2025

2772

2026

2773

# Default values for config file for server-global settings

2027

2774

server_defaults = { "interface": "",

2029

2776

"port": "",

2030

2777

"debug": "False",

2031

2778

"priority":

2032

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

2779

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

2780

":+SIGN-DSA-SHA256",

2033

2781

"servicename": "Mandos",

2034

2782

"use_dbus": "True",

2035

2783

"use_ipv6": "True",

2036

2784

"debuglevel": "",

2037

2785

"restore": "True",

2038

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

2039

}

2786

"socket": "",

2787

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

2788

"foreground": "False",

2789

"zeroconf": "True",

2790

}

2040

2791

2041

2792

# Parse config file for server-global settings

2042

2793

server_config = configparser.SafeConfigParser(server_defaults)

2043

2794

del server_defaults

2044

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

2045

"mandos.conf"))

2795

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

2046

2796

# Convert the SafeConfigParser object to a dict

2047

2797

server_settings = server_config.defaults()

2048

2798

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

2049

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

2799

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

2050

2800

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

2051

2801

option)

2052

2802

if server_settings["port"]:

2053

2803

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

2054

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

2055

2814

del server_config

2056

2815

2057

2816

# Override the settings from the config file with command line

2058

2817

# options, if set.

2059

2818

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

2060

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

2061

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

2062

"statedir"):

2819

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

2820

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

2821

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

2063

2822

value = getattr(options, option)

2064

2823

if value is not None:

2065

2824

server_settings[option] = value

2066

2825

del options

2067

2826

# Force all strings to be unicode

2068

2827

for option in server_settings.keys():

2069

if type(server_settings[option]) is str:

2070

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

2071

2838

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

2072

2839

2073

2840

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

2074

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

2075

2847

# For convenience

2076

2848

debug = server_settings["debug"]

2077

2849

debuglevel = server_settings["debuglevel"]

2079

2851

use_ipv6 = server_settings["use_ipv6"]

2080

2852

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

2081

2853

stored_state_file)

2854

foreground = server_settings["foreground"]

2855

zeroconf = server_settings["zeroconf"]

2082

2856

2083

2857

if debug:

2084

2858

initlogger(debug, logging.DEBUG)

2090

2864

initlogger(debug, level)

2091

2865

2092

2866

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

2093

syslogger.setFormatter(logging.Formatter

2094

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

2095

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

2096

% server_settings["servicename"]))

2867

syslogger.setFormatter(

2868

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

2869

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

2870

server_settings["servicename"])))

2097

2871

2098

2872

# Parse config file with clients

2099

2873

client_config = configparser.SafeConfigParser(Client

2104

2878

global mandos_dbus_service

2105

2879

mandos_dbus_service = None

2106

2880

2107

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

2108

server_settings["port"]),

2109

ClientHandler,

2110

interface=(server_settings["interface"]

2111

or None),

2112

use_ipv6=use_ipv6,

2113

gnutls_priority=

2114

server_settings["priority"],

2115

use_dbus=use_dbus)

2116

if not debug:

2117

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

2118

2897

try:

2119

pidfile = open(pidfilename, "w")

2120

except IOError:

2121

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)

2122

2902

2123

try:

2124

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

2125

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

2126

except KeyError:

2903

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

2127

2904

try:

2128

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

2129

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

2905

uid = pwd.getpwnam(name).pw_uid

2906

gid = pwd.getpwnam(name).pw_gid

2907

break

2130

2908

except KeyError:

2131

try:

2132

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

2133

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

2134

except KeyError:

2135

uid = 65534

2136

gid = 65534

2909

continue

2910

else:

2911

uid = 65534

2912

gid = 65534

2137

2913

try:

2138

2914

os.setgid(gid)

2139

2915

os.setuid(uid)

2140

2916

except OSError as error:

2141

if error[0] != errno.EPERM:

2142

raise error

2917

if error.errno != errno.EPERM:

2918

raise

2143

2919

2144

2920

if debug:

2145

2921

# Enable all possible GnuTLS debugging

2146

2922

2147

2923

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

2148

2924

# - GnuTLS manual

2149

gnutls.library.functions.gnutls_global_set_log_level(11)

2925

gnutls.global_set_log_level(11)

2150

2926

2151

@gnutls.library.types.gnutls_log_func

2927

@gnutls.log_func

2152

2928

def debug_gnutls(level, string):

2153

2929

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

2154

2930

2155

(gnutls.library.functions

2156

.gnutls_global_set_log_function(debug_gnutls))

2931

gnutls.global_set_log_function(debug_gnutls)

2157

2932

2158

2933

# Redirect stdin so all checkers get /dev/null

2159

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

2934

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

2160

2935

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

2161

2936

if null > 2:

2162

2937

os.close(null)

2163

2938

2164

2939

# Need to fork before connecting to D-Bus

2165

if not debug:

2940

if not foreground:

2166

2941

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

2167

2942

daemon()

2168

2943

2944

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

2945

# need to inform gobject that threads will be used.

2169

2946

gobject.threads_init()

2170

2947

2171

2948

global main_loop

2172

2949

# From the Avahi example code

2173

DBusGMainLoop(set_as_default=True )

2950

DBusGMainLoop(set_as_default=True)

2174

2951

main_loop = gobject.MainLoop()

2175

2952

bus = dbus.SystemBus()

2176

2953

# End of Avahi example code

2177

2954

if use_dbus:

2178

2955

try:

2179

2956

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

2180

bus, do_not_queue=True)

2181

old_bus_name = (dbus.service.BusName

2182

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

2183

do_not_queue=True))

2184

except dbus.exceptions.NameExistsException as e:

2185

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)

2186

2964

use_dbus = False

2187

2965

server_settings["use_dbus"] = False

2188

2966

tcp_server.use_dbus = False

2189

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2190

service = AvahiServiceToSyslog(name =

2191

server_settings["servicename"],

2192

servicetype = "_mandos._tcp",

2193

protocol = protocol, bus = bus)

2194

if server_settings["interface"]:

2195

service.interface = (if_nametoindex

2196

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

2197

2977

2198

2978

global multiprocessing_manager

2199

2979

multiprocessing_manager = multiprocessing.Manager()

2200

2980

2201

2981

client_class = Client

2202

2982

if use_dbus:

2203

client_class = functools.partial(ClientDBusTransitional,

2204

bus = bus)

2983

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

2205

2984

2206

2985

client_settings = Client.config_parser(client_config)

2207

2986

old_client_settings = {}

2208

2987

clients_data = {}

2209

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

2210

2997

# Get client data and settings from last running state.

2211

2998

if server_settings["restore"]:

2212

2999

try:

2213

3000

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

2214

clients_data, old_client_settings = (pickle.load

2215

(stored_state))

3001

clients_data, old_client_settings = pickle.load(

3002

stored_state)

2216

3003

os.remove(stored_state_path)

2217

3004

except IOError as e:

2218

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

2219

.format(e))

2220

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)

2221

3011

raise

2222

3012

except EOFError as e:

2223

3013

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

2224

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

3014

"EOFError:",

3015

exc_info=e)

2225

3016

2226

3017

with PGPEngine() as pgp:

2227

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

2228

3023

# Decide which value to use after restoring saved state.

2229

3024

# We have three different values: Old config file,

2230

3025

# new config file, and saved state.

2235

3030

# For each value in new config, check if it

2236

3031

# differs from the old config value (Except for

2237

3032

# the "secret" attribute)

2238

if (name != "secret" and

2239

value != old_client_settings[client_name]

2240

[name]):

3033

if (name != "secret"

3034

and (value !=

3035

old_client_settings[client_name][name])):

2241

3036

client[name] = value

2242

3037

except KeyError:

2243

3038

pass

2244

3039

2245

3040

# Clients who has passed its expire date can still be

2246

# enabled if its last checker was successful. Clients

3041

# enabled if its last checker was successful. A Client

2247

3042

# whose checker succeeded before we stored its state is

2248

3043

# assumed to have successfully run all checkers during

2249

3044

# downtime.

2251

3046

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

2252

3047

if not client["last_checked_ok"]:

2253

3048

logger.warning(

2254

"disabling client {0} - Client never "

2255

"performed a successful checker"

2256

.format(client_name))

3049

"disabling client {} - Client never "

3050

"performed a successful checker".format(

3051

client_name))

2257

3052

client["enabled"] = False

2258

3053

elif client["last_checker_status"] != 0:

2259

3054

logger.warning(

2260

"disabling client {0} - Client "

2261

"last checker failed with error code {1}"

2262

.format(client_name,

2263

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

2264

3060

client["enabled"] = False

2265

3061

else:

2266

client["expires"] = (datetime.datetime

2267

.utcnow()

2268

+ client["timeout"])

3062

client["expires"] = (

3063

datetime.datetime.utcnow()

3064

+ client["timeout"])

2269

3065

logger.debug("Last checker succeeded,"

2270

" keeping {0} enabled"

2271

.format(client_name))

3066

" keeping {} enabled".format(

3067

client_name))

2272

3068

try:

2273

client["secret"] = (

2274

pgp.decrypt(client["encrypted_secret"],

2275

client_settings[client_name]

2276

["secret"]))

3069

client["secret"] = pgp.decrypt(

3070

client["encrypted_secret"],

3071

client_settings[client_name]["secret"])

2277

3072

except PGPError:

2278

3073

# If decryption fails, we use secret from new settings

2279

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

2280

.format(client_name))

2281

client["secret"] = (

2282

client_settings[client_name]["secret"])

2283

3074

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

3075

client_name))

3076

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

3077

["secret"])

2284

3078

2285

3079

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

2286

3080

for client_name in (set(old_client_settings)

2289

3083

for client_name in (set(client_settings)

2290

3084

- set(old_client_settings)):

2291

3085

clients_data[client_name] = client_settings[client_name]

2292

3086

2293

3087

# Create all client objects

2294

for client_name, client in clients_data.iteritems():

3088

for client_name, client in clients_data.items():

2295

3089

tcp_server.clients[client_name] = client_class(

2296

name = client_name, settings = client)

3090

name = client_name,

3091

settings = client,

3092

server_settings = server_settings)

2297

3093

2298

3094

if not tcp_server.clients:

2299

3095

logger.warning("No clients defined")

2300

2301

if not debug:

2302

try:

2303

with pidfile:

2304

pid = os.getpid()

2305

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

2306

del pidfile

2307

except IOError:

2308

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

2309

pidfilename, pid)

2310

except NameError:

2311

# "pidfile" was never created

2312

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

2313

3107

del pidfilename

2314

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

2315

3108

2316

3109

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

2317

3110

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

2318

3111

2319

3112

if use_dbus:

2320

class MandosDBusService(dbus.service.Object):

3113

3114

@alternate_dbus_interfaces(

3115

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

3116

class MandosDBusService(DBusObjectWithObjectManager):

2321

3117

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

3118

2322

3119

def __init__(self):

2323

3120

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

3121

2324

3122

_interface = "se.recompile.Mandos"

2325

3123

2326

3124

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

2333

3131

"D-Bus signal"

2334

3132

pass

2335

3133

3134

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

3135

"true"})

2336

3136

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

2337

3137

def ClientRemoved(self, objpath, name):

2338

3138

"D-Bus signal"

2339

3139

pass

2340

3140

3141

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

3142

"true"})

2341

3143

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

2342

3144

def GetAllClients(self):

2343

3145

"D-Bus method"

2344

return dbus.Array(c.dbus_object_path

2345

for c in

3146

return dbus.Array(c.dbus_object_path for c in

2346

3147

tcp_server.clients.itervalues())

2347

3148

3149

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

3150

"true"})

2348

3151

@dbus.service.method(_interface,

2349

3152

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

2350

3153

def GetAllClientsWithProperties(self):

2351

3154

"D-Bus method"

2352

3155

return dbus.Dictionary(

2353

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

2354

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

2355

3159

signature="oa{sv}")

2356

3160

2357

3161

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

2361

3165

if c.dbus_object_path == object_path:

2362

3166

del tcp_server.clients[c.name]

2363

3167

c.remove_from_connection()

2364

# Don't signal anything except ClientRemoved

3168

# Don't signal the disabling

2365

3169

c.disable(quiet=True)

2366

# Emit D-Bus signal

2367

self.ClientRemoved(object_path, c.name)

3170

# Emit D-Bus signal for removal

3171

self.client_removed_signal(c)

2368

3172

return

2369

3173

raise KeyError(object_path)

2370

3174

2371

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)

2372

3212

2373

class MandosDBusServiceTransitional(MandosDBusService):

2374

__metaclass__ = AlternateDBusNamesMetaclass

2375

mandos_dbus_service = MandosDBusServiceTransitional()

3213

mandos_dbus_service = MandosDBusService()

2376

3214

2377

3215

def cleanup():

2378

3216

"Cleanup function; run on exit"

2379

service.cleanup()

3217

if zeroconf:

3218

service.cleanup()

2380

3219

2381

3220

multiprocessing.active_children()

3221

wnull.close()

2382

3222

if not (tcp_server.clients or client_settings):

2383

3223

return

2384

3224

2395

3235

2396

3236

# A list of attributes that can not be pickled

2397

3237

# + secret.

2398

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

2399

"checker"))

2400

for name, typ in (inspect.getmembers

2401

(dbus.service.Object)):

3238

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

3239

"checker", "server_settings" }

3240

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

3241

.Object):

2402

3242

exclude.add(name)

2403

3243

2404

3244

client_dict["encrypted_secret"] = (client

2411

3251

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

2412

3252

2413

3253

try:

2414

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

2415

prefix="clients-",

2416

dir=os.path.dirname

2417

(stored_state_path))

2418

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:

2419

3260

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

3261

tempname = stored_state.name

2420

3262

os.rename(tempname, stored_state_path)

2421

3263

except (IOError, OSError) as e:

2422

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

2423

.format(e))

2424

3264

if not debug:

2425

3265

try:

2426

3266

os.remove(tempname)

2427

3267

except NameError:

2428

3268

pass

2429

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

2430

errno.EEXIST)):

2431

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

2432

3276

2433

3277

# Delete all clients, and settings from config

2434

3278

while tcp_server.clients:

2435

3279

name, client = tcp_server.clients.popitem()

2436

3280

if use_dbus:

2437

3281

client.remove_from_connection()

2438

# Don't signal anything except ClientRemoved

3282

# Don't signal the disabling

2439

3283

client.disable(quiet=True)

3284

# Emit D-Bus signal for removal

2440

3285

if use_dbus:

2441

# Emit D-Bus signal

2442

mandos_dbus_service.ClientRemoved(client

2443

.dbus_object_path,

2444

client.name)

3286

mandos_dbus_service.client_removed_signal(client)

2445

3287

client_settings.clear()

2446

3288

2447

3289

atexit.register(cleanup)

2448

3290

2449

3291

for client in tcp_server.clients.itervalues():

2450

3292

if use_dbus:

2451

# Emit D-Bus signal

2452

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3293

# Emit D-Bus signal for adding

3294

mandos_dbus_service.client_added_signal(client)

2453

3295

# Need to initiate checking of clients

2454

3296

if client.enabled:

2455

3297

client.init_checker()

2458

3300

tcp_server.server_activate()

2459

3301

2460

3302

# Find out what port we got

2461

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

3303

if zeroconf:

3304

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

2462

3305

if use_ipv6:

2463

3306

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

2464

" flowinfo %d, scope_id %d"

2465

% tcp_server.socket.getsockname())

3307

" flowinfo %d, scope_id %d",

3308

*tcp_server.socket.getsockname())

2466

3309

else: # IPv4

2467

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

2468

% tcp_server.socket.getsockname())

3310

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

3311

*tcp_server.socket.getsockname())

2469

3312

2470

3313

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

2471

3314

2472

3315

try:

2473

# From the Avahi example code

2474

try:

2475

service.activate()

2476

except dbus.exceptions.DBusException as error:

2477

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

2478

cleanup()

2479

sys.exit(1)

2480

# 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

2481

3325

2482

3326

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

2483

3327

lambda *args, **kwargs:

2487

3331

logger.debug("Starting main loop")

2488

3332

main_loop.run()

2489

3333

except AvahiError as error:

2490

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

3334

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

2491

3335

cleanup()

2492

3336

sys.exit(1)

2493

3337

except KeyboardInterrupt:

2498

3342

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

2499

3343

cleanup()

2500

3344

3345

2501

3346

if __name__ == '__main__':

2502

3347

main()