/mandos/release : revision 237.7.369

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

36

37

from future_builtins import *

38

39

import SocketServer as socketserver

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

40

43

import socket

41

44

import argparse

42

45

import datetime

43

46

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

51

import sys

52

import re

53

import os

62

import struct

63

import fcntl

64

import functools

65

import cPickle as pickle

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

66

69

import multiprocessing

67

70

import types

68

71

import binascii

69

72

import tempfile

70

73

import itertools

74

import collections

75

import codecs

71

76

72

77

import dbus

73

78

import dbus.service

74

import gobject

79

try:

80

from gi.repository import GObject

81

except ImportError:

82

import gobject as GObject

75

83

import avahi

76

84

from dbus.mainloop.glib import DBusGMainLoop

77

85

import ctypes

78

86

import ctypes.util

79

87

import xml.dom.minidom

80

88

import inspect

81

import GnuPGInterface

82

89

83

90

try:

84

91

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

88

95

except ImportError:

89

96

SO_BINDTODEVICE = None

90

97

91

version = "1.5.3"

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.3"

92

102

stored_state_file = "clients.pickle"

93

103

94

104

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

105

syslogger = None

98

106

99

107

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

103

110

except (OSError, AttributeError):

111

104

112

def if_nametoindex(interface):

105

113

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

106

114

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

107

115

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

108

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

117

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

118

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

113

119

return interface_index

114

120

115

121

116

122

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

117

123

"""init logger and add loglevel"""

118

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

119

129

syslogger.setFormatter(logging.Formatter

120

130

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

121

131

' %(message)s'))

138

148

139

149

class PGPEngine(object):

140

150

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

151

141

152

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

153

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

154

self.gpg = "gpg"

155

try:

156

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

157

for line in output.splitlines():

158

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

159

if name == "gpg":

160

self.gpg = path

161

break

162

except OSError as e:

163

if e.errno != errno.ENOENT:

164

raise

165

self.gnupgargs = ['--batch',

166

'--homedir', self.tempdir,

167

'--force-mdc',

168

'--quiet',

169

'--no-use-agent']

150

170

151

171

def __enter__(self):

152

172

return self

153

173

154

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

174

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

155

175

self._cleanup()

156

176

return False

157

177

174

194

def password_encode(self, password):

175

195

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

176

196

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

177

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

197

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

198

if len(encoded) > 2048:

199

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

200

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

201

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

202

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

203

return encoded

178

204

179

205

def encrypt(self, data, password):

180

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

181

with open(os.devnull, "w") as devnull:

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

206

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(

208

dir=self.tempdir) as passfile:

209

passfile.write(passphrase)

210

passfile.flush()

211

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

212

'--passphrase-file',

213

passfile.name]

214

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

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

219

if proc.returncode != 0:

220

raise PGPError(err)

194

221

return ciphertext

195

222

196

223

def decrypt(self, data, password):

197

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

198

with open(os.devnull, "w") as devnull:

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

224

passphrase = self.password_encode(password)

225

with tempfile.NamedTemporaryFile(

226

dir = self.tempdir) as passfile:

227

passfile.write(passphrase)

228

passfile.flush()

229

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

230

'--passphrase-file',

231

passfile.name]

232

+ self.gnupgargs,

233

stdin = subprocess.PIPE,

234

stdout = subprocess.PIPE,

235

stderr = subprocess.PIPE)

236

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

237

if proc.returncode != 0:

238

raise PGPError(err)

211

239

return decrypted_plaintext

212

240

213

241

214

242

class AvahiError(Exception):

215

243

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

216

244

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

245

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

246

**kwargs)

247

220

248

221

249

class AvahiServiceError(AvahiError):

222

250

pass

223

251

252

224

253

class AvahiGroupError(AvahiError):

225

254

pass

226

255

233

262

Used to optionally bind to the specified interface.

234

263

name: string; Example: 'Mandos'

235

264

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

236

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

265

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

237

266

port: integer; what port to announce

238

267

TXT: list of strings; TXT record for the service

239

268

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

246

275

bus: dbus.SystemBus()

247

276

"""

248

277

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

278

def __init__(self,

279

interface = avahi.IF_UNSPEC,

280

name = None,

281

servicetype = None,

282

port = None,

283

TXT = None,

284

domain = "",

285

host = "",

286

max_renames = 32768,

287

protocol = avahi.PROTO_UNSPEC,

288

bus = None):

253

289

self.interface = interface

254

290

self.name = name

255

291

self.type = servicetype

265

301

self.bus = bus

266

302

self.entry_group_state_changed_match = None

267

303

268

def rename(self):

304

def rename(self, remove=True):

269

305

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

270

306

if self.rename_count >= self.max_renames:

271

307

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

272

308

" after %i retries, exiting.",

273

309

self.rename_count)

274

310

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

311

self.name = str(

312

self.server.GetAlternativeServiceName(self.name))

313

self.rename_count += 1

277

314

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

278

315

self.name)

279

self.remove()

316

if remove:

317

self.remove()

280

318

try:

281

319

self.add()

282

320

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

321

if (error.get_dbus_name()

322

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

323

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

324

return self.rename(remove=False)

325

else:

326

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

327

self.cleanup()

328

os._exit(1)

287

329

288

330

def remove(self):

289

331

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

327

369

self.rename()

328

370

elif state == avahi.ENTRY_GROUP_FAILURE:

329

371

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

330

unicode(error))

331

raise AvahiGroupError("State changed: {0!s}"

332

.format(error))

372

str(error))

373

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

333

374

334

375

def cleanup(self):

335

376

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

345

386

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

346

387

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

347

388

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

389

bad_states = {

390

avahi.SERVER_INVALID: "Zeroconf server invalid",

391

avahi.SERVER_REGISTERING: None,

392

avahi.SERVER_COLLISION: "Zeroconf server name collision",

393

avahi.SERVER_FAILURE: "Zeroconf server failure",

394

}

355

395

if state in bad_states:

356

396

if bad_states[state] is not None:

357

397

if error is None:

360

400

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

361

401

self.cleanup()

362

402

elif state == avahi.SERVER_RUNNING:

363

self.add()

403

try:

404

self.add()

405

except dbus.exceptions.DBusException as error:

406

if (error.get_dbus_name()

407

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

408

logger.info("Local Zeroconf service name"

409

" collision.")

410

return self.rename(remove=False)

411

else:

412

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

413

self.cleanup()

414

os._exit(1)

364

415

else:

365

416

if error is None:

366

417

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

376

427

follow_name_owner_changes=True),

377

428

avahi.DBUS_INTERFACE_SERVER)

378

429

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

430

self.server_state_changed)

380

431

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

381

432

433

382

434

class AvahiServiceToSyslog(AvahiService):

383

def rename(self):

435

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

384

436

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

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

('Mandos ({0}) [%(process)d]:'

388

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

389

.format(self.name)))

437

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

438

syslogger.setFormatter(logging.Formatter(

439

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

440

.format(self.name)))

390

441

return ret

391

442

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

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

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

443

# Pretend that we have a GnuTLS module

444

class GnuTLS(object):

445

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

446

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

447

448

_library = ctypes.cdll.LoadLibrary(

449

ctypes.util.find_library("gnutls"))

450

_need_version = "3.3.0"

451

def __init__(self):

452

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

453

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

454

# happens.

455

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

456

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

457

.format(self._need_version))

458

459

# Unless otherwise indicated, the constants and types below are

460

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

461

462

# Constants

463

E_SUCCESS = 0

464

E_INTERRUPTED = -52

465

E_AGAIN = -28

466

CRT_OPENPGP = 2

467

CLIENT = 2

468

SHUT_RDWR = 0

469

CRD_CERTIFICATE = 1

470

E_NO_CERTIFICATE_FOUND = -49

471

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

472

473

# Types

474

class session_int(ctypes.Structure):

475

_fields_ = []

476

session_t = ctypes.POINTER(session_int)

477

class certificate_credentials_st(ctypes.Structure):

478

_fields_ = []

479

certificate_credentials_t = ctypes.POINTER(

480

certificate_credentials_st)

481

certificate_type_t = ctypes.c_int

482

class datum_t(ctypes.Structure):

483

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

484

('size', ctypes.c_uint)]

485

class openpgp_crt_int(ctypes.Structure):

486

_fields_ = []

487

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

488

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

489

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

490

credentials_type_t = ctypes.c_int #

491

transport_ptr_t = ctypes.c_void_p

492

close_request_t = ctypes.c_int

493

494

# Exceptions

495

class Error(Exception):

496

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

497

# exception might be raised from within GnuTLS.__init__,

498

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

499

# global variable has happened.

500

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

501

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

502

# code is passed, convert it to a string with

503

# gnutls.strerror()

504

self.code = code

505

if message is None and code is not None:

506

message = GnuTLS.strerror(code)

507

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

508

message, *args)

509

510

class CertificateSecurityError(Error):

511

pass

512

513

# Classes

514

class Credentials(object):

515

def __init__(self):

516

self._c_object = gnutls.certificate_credentials_t()

517

gnutls.certificate_allocate_credentials(

518

ctypes.byref(self._c_object))

519

self.type = gnutls.CRD_CERTIFICATE

520

521

def __del__(self):

522

gnutls.certificate_free_credentials(self._c_object)

523

524

class ClientSession(object):

525

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

526

self._c_object = gnutls.session_t()

527

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

528

gnutls.set_default_priority(self._c_object)

529

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

530

gnutls.handshake_set_private_extensions(self._c_object,

531

True)

532

self.socket = socket

533

if credentials is None:

534

credentials = gnutls.Credentials()

535

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

536

ctypes.cast(credentials._c_object,

537

ctypes.c_void_p))

538

self.credentials = credentials

539

540

def __del__(self):

541

gnutls.deinit(self._c_object)

542

543

def handshake(self):

544

return gnutls.handshake(self._c_object)

545

546

def send(self, data):

547

data = bytes(data)

548

data_len = len(data)

549

while data_len > 0:

550

data_len -= gnutls.record_send(self._c_object,

551

data[-data_len:],

552

data_len)

553

554

def bye(self):

555

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

556

557

# Error handling functions

558

def _error_code(result):

559

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

560

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

561

if result >= 0:

562

return result

563

if result == gnutls.E_NO_CERTIFICATE_FOUND:

564

raise gnutls.CertificateSecurityError(code = result)

565

raise gnutls.Error(code = result)

566

567

def _retry_on_error(result, func, arguments):

568

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

569

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

570

while result < 0:

571

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

572

return _error_code(result)

573

result = func(*arguments)

574

return result

575

576

# Unless otherwise indicated, the function declarations below are

577

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

578

579

# Functions

580

priority_set_direct = _library.gnutls_priority_set_direct

581

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

582

ctypes.POINTER(ctypes.c_char_p)]

583

priority_set_direct.restype = _error_code

584

585

init = _library.gnutls_init

586

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

587

init.restype = _error_code

588

589

set_default_priority = _library.gnutls_set_default_priority

590

set_default_priority.argtypes = [session_t]

591

set_default_priority.restype = _error_code

592

593

record_send = _library.gnutls_record_send

594

record_send.argtypes = [session_t, ctypes.c_void_p,

595

ctypes.c_size_t]

596

record_send.restype = ctypes.c_ssize_t

597

record_send.errcheck = _retry_on_error

598

599

certificate_allocate_credentials = (

600

_library.gnutls_certificate_allocate_credentials)

601

certificate_allocate_credentials.argtypes = [

602

ctypes.POINTER(certificate_credentials_t)]

603

certificate_allocate_credentials.restype = _error_code

604

605

certificate_free_credentials = (

606

_library.gnutls_certificate_free_credentials)

607

certificate_free_credentials.argtypes = [certificate_credentials_t]

608

certificate_free_credentials.restype = None

609

610

handshake_set_private_extensions = (

611

_library.gnutls_handshake_set_private_extensions)

612

handshake_set_private_extensions.argtypes = [session_t,

613

ctypes.c_int]

614

handshake_set_private_extensions.restype = None

615

616

credentials_set = _library.gnutls_credentials_set

617

credentials_set.argtypes = [session_t, credentials_type_t,

618

ctypes.c_void_p]

619

credentials_set.restype = _error_code

620

621

strerror = _library.gnutls_strerror

622

strerror.argtypes = [ctypes.c_int]

623

strerror.restype = ctypes.c_char_p

624

625

certificate_type_get = _library.gnutls_certificate_type_get

626

certificate_type_get.argtypes = [session_t]

627

certificate_type_get.restype = _error_code

628

629

certificate_get_peers = _library.gnutls_certificate_get_peers

630

certificate_get_peers.argtypes = [session_t,

631

ctypes.POINTER(ctypes.c_uint)]

632

certificate_get_peers.restype = ctypes.POINTER(datum_t)

633

634

global_set_log_level = _library.gnutls_global_set_log_level

635

global_set_log_level.argtypes = [ctypes.c_int]

636

global_set_log_level.restype = None

637

638

global_set_log_function = _library.gnutls_global_set_log_function

639

global_set_log_function.argtypes = [log_func]

640

global_set_log_function.restype = None

641

642

deinit = _library.gnutls_deinit

643

deinit.argtypes = [session_t]

644

deinit.restype = None

645

646

handshake = _library.gnutls_handshake

647

handshake.argtypes = [session_t]

648

handshake.restype = _error_code

649

handshake.errcheck = _retry_on_error

650

651

transport_set_ptr = _library.gnutls_transport_set_ptr

652

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

653

transport_set_ptr.restype = None

654

655

bye = _library.gnutls_bye

656

bye.argtypes = [session_t, close_request_t]

657

bye.restype = _error_code

658

bye.errcheck = _retry_on_error

659

660

check_version = _library.gnutls_check_version

661

check_version.argtypes = [ctypes.c_char_p]

662

check_version.restype = ctypes.c_char_p

663

664

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

665

666

openpgp_crt_init = _library.gnutls_openpgp_crt_init

667

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

668

openpgp_crt_init.restype = _error_code

669

670

openpgp_crt_import = _library.gnutls_openpgp_crt_import

671

openpgp_crt_import.argtypes = [openpgp_crt_t,

672

ctypes.POINTER(datum_t),

673

openpgp_crt_fmt_t]

674

openpgp_crt_import.restype = _error_code

675

676

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

677

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

678

ctypes.POINTER(ctypes.c_uint)]

679

openpgp_crt_verify_self.restype = _error_code

680

681

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

682

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

683

openpgp_crt_deinit.restype = None

684

685

openpgp_crt_get_fingerprint = (

686

_library.gnutls_openpgp_crt_get_fingerprint)

687

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

688

ctypes.c_void_p,

689

ctypes.POINTER(

690

ctypes.c_size_t)]

691

openpgp_crt_get_fingerprint.restype = _error_code

692

693

# Remove non-public functions

694

del _error_code, _retry_on_error

695

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

696

gnutls = GnuTLS()

697

698

def call_pipe(connection, # : multiprocessing.Connection

699

func, *args, **kwargs):

700

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

701

702

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

703

return value on the provided multiprocessing.Connection.

704

"""

705

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

706

connection.close()

397

707

398

708

class Client(object):

399

709

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

405

715

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

406

716

to see if the client lives.

407

717

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

718

checker_callback_tag: a GObject event source tag, or None

409

719

checker_command: string; External command which is run to check

410

720

if client lives. %() expansions are done at

411

721

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

412

722

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

413

checker_initiator_tag: a gobject event source tag, or None

723

checker_initiator_tag: a GObject event source tag, or None

414

724

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

415

725

client_structure: Object describing what attributes a client has

416

726

and is used for storing the client at exit

417

727

current_checker_command: string; current running checker_command

418

disable_initiator_tag: a gobject event source tag, or None

728

disable_initiator_tag: a GObject event source tag, or None

419

729

enabled: bool()

420

730

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

421

731

uniquely identify the client

426

736

last_checker_status: integer between 0 and 255 reflecting exit

427

737

status of last checker. -1 reflects crashed

428

738

checker, -2 means no checker completed yet.

739

last_checker_signal: The signal which killed the last checker, if

740

last_checker_status is -1

429

741

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

430

742

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

431

743

D-Bus identifiers

436

748

runtime_expansions: Allowed attributes for runtime expansion.

437

749

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

438

750

disabled, or None

751

server_settings: The server_settings dict from main()

439

752

"""

440

753

441

754

runtime_expansions = ("approval_delay", "approval_duration",

442

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

443

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

755

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

756

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

757

"last_approval_request", "last_checked_ok",

444

758

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

445

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

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

759

client_defaults = {

760

"timeout": "PT5M",

761

"extended_timeout": "PT15M",

762

"interval": "PT2M",

763

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

764

"host": "",

765

"approval_delay": "PT0S",

766

"approval_duration": "PT1S",

767

"approved_by_default": "True",

768

"enabled": "True",

769

}

470

770

471

771

@staticmethod

472

772

def config_parser(config):

488

788

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

489

789

"enabled")

490

790

791

# Uppercase and remove spaces from fingerprint for later

792

# comparison purposes with return value from the

793

# fingerprint() function

491

794

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

492

795

.replace(" ", ""))

493

796

if "secret" in section:

498

801

"rb") as secfile:

499

802

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

500

803

else:

501

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

804

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

502

805

.format(section))

503

806

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

504

807

client["extended_timeout"] = string_to_delta(

515

818

516

819

return settings

517

820

518

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

821

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

519

822

self.name = name

823

if server_settings is None:

824

server_settings = {}

825

self.server_settings = server_settings

520

826

# adding all client settings

521

for setting, value in settings.iteritems():

827

for setting, value in settings.items():

522

828

setattr(self, setting, value)

523

829

524

830

if self.enabled:

532

838

self.expires = None

533

839

534

840

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

538

841

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

539

842

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

540

843

datetime.datetime.utcnow())

547

850

self.current_checker_command = None

548

851

self.approved = None

549

852

self.approvals_pending = 0

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

853

self.changedstate = multiprocessing_manager.Condition(

854

multiprocessing_manager.Lock())

855

self.client_structure = [attr

856

for attr in self.__dict__.iterkeys()

555

857

if not attr.startswith("_")]

556

858

self.client_structure.append("client_structure")

557

859

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

860

for name, t in inspect.getmembers(

861

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

562

862

if not name.startswith("_"):

563

863

self.client_structure.append(name)

564

864

585

885

if not quiet:

586

886

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

587

887

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

588

gobject.source_remove(self.disable_initiator_tag)

888

GObject.source_remove(self.disable_initiator_tag)

589

889

self.disable_initiator_tag = None

590

890

self.expires = None

591

891

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

592

gobject.source_remove(self.checker_initiator_tag)

892

GObject.source_remove(self.checker_initiator_tag)

593

893

self.checker_initiator_tag = None

594

894

self.stop_checker()

595

895

self.enabled = False

596

896

if not quiet:

597

897

self.send_changedstate()

598

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

898

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

599

899

return False

600

900

601

901

def __del__(self):

605

905

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

606

906

# and every interval from then on.

607

907

if self.checker_initiator_tag is not None:

608

gobject.source_remove(self.checker_initiator_tag)

609

self.checker_initiator_tag = (gobject.timeout_add

610

(self.interval_milliseconds(),

611

self.start_checker))

908

GObject.source_remove(self.checker_initiator_tag)

909

self.checker_initiator_tag = GObject.timeout_add(

910

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

911

self.start_checker)

612

912

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

613

913

if self.disable_initiator_tag is not None:

614

gobject.source_remove(self.disable_initiator_tag)

615

self.disable_initiator_tag = (gobject.timeout_add

616

(self.timeout_milliseconds(),

617

self.disable))

914

GObject.source_remove(self.disable_initiator_tag)

915

self.disable_initiator_tag = GObject.timeout_add(

916

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

618

917

# Also start a new checker *right now*.

619

918

self.start_checker()

620

919

621

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

920

def checker_callback(self, source, condition, connection,

921

command):

622

922

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

623

923

self.checker_callback_tag = None

624

924

self.checker = None

625

if os.WIFEXITED(condition):

626

self.last_checker_status = os.WEXITSTATUS(condition)

925

# Read return code from connection (see call_pipe)

926

returncode = connection.recv()

927

connection.close()

928

929

if returncode >= 0:

930

self.last_checker_status = returncode

931

self.last_checker_signal = None

627

932

if self.last_checker_status == 0:

628

933

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

629

934

vars(self))

630

935

self.checked_ok()

631

936

else:

632

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

633

vars(self))

937

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

634

938

else:

635

939

self.last_checker_status = -1

940

self.last_checker_signal = -returncode

636

941

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

637

942

vars(self))

943

return False

638

944

639

945

def checked_ok(self):

640

946

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

641

947

self.last_checked_ok = datetime.datetime.utcnow()

642

948

self.last_checker_status = 0

949

self.last_checker_signal = None

643

950

self.bump_timeout()

644

951

645

952

def bump_timeout(self, timeout=None):

647

954

if timeout is None:

648

955

timeout = self.timeout

649

956

if self.disable_initiator_tag is not None:

650

gobject.source_remove(self.disable_initiator_tag)

957

GObject.source_remove(self.disable_initiator_tag)

651

958

self.disable_initiator_tag = None

652

959

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

653

self.disable_initiator_tag = (gobject.timeout_add

654

(timedelta_to_milliseconds

655

(timeout), self.disable))

960

self.disable_initiator_tag = GObject.timeout_add(

961

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

656

962

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

657

963

658

964

def need_approval(self):

672

978

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

673

979

# should be.

674

980

675

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

676

try:

677

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

678

except (AttributeError, OSError) as error:

679

if (isinstance(error, OSError)

680

and error.errno != errno.ECHILD):

681

raise error

682

else:

683

if pid:

684

logger.warning("Checker was a zombie")

685

gobject.source_remove(self.checker_callback_tag)

686

self.checker_callback(pid, status,

687

self.current_checker_command)

981

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

982

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

983

self.checker.join()

984

self.checker = None

688

985

# Start a new checker if needed

689

986

if self.checker is None:

987

# Escape attributes for the shell

988

escaped_attrs = {

989

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

990

for attr in self.runtime_expansions }

690

991

try:

691

# In case checker_command has exactly one % operator

692

command = self.checker_command % self.host

693

except TypeError:

694

# Escape attributes for the shell

695

escaped_attrs = dict(

696

(attr,

697

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

698

errors=

699

'replace')))

700

for attr in

701

self.runtime_expansions)

702

703

try:

704

command = self.checker_command % escaped_attrs

705

except TypeError as error:

706

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

707

self.checker_command, exc_info=error)

708

return True # Try again later

992

command = self.checker_command % escaped_attrs

993

except TypeError as error:

994

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

995

self.checker_command,

996

exc_info=error)

997

return True # Try again later

709

998

self.current_checker_command = command

710

try:

711

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

712

command, self.name)

713

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

714

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

715

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

716

# always replaced by /dev/null.)

717

self.checker = subprocess.Popen(command,

718

close_fds=True,

719

shell=True, cwd="/")

720

self.checker_callback_tag = (gobject.child_watch_add

721

(self.checker.pid,

722

self.checker_callback,

723

data=command))

724

# The checker may have completed before the gobject

725

# watch was added. Check for this.

726

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

727

if pid:

728

gobject.source_remove(self.checker_callback_tag)

729

self.checker_callback(pid, status, command)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

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

999

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

1000

self.name)

1001

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

1002

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

1003

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

1004

# always replaced by /dev/null.)

1005

# The exception is when not debugging but nevertheless

1006

# running in the foreground; use the previously

1007

# created wnull.

1008

popen_args = { "close_fds": True,

1009

"shell": True,

1010

"cwd": "/" }

1011

if (not self.server_settings["debug"]

1012

and self.server_settings["foreground"]):

1013

popen_args.update({"stdout": wnull,

1014

"stderr": wnull })

1015

pipe = multiprocessing.Pipe(duplex = False)

1016

self.checker = multiprocessing.Process(

1017

target = call_pipe,

1018

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

1019

kwargs = popen_args)

1020

self.checker.start()

1021

self.checker_callback_tag = GObject.io_add_watch(

1022

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

1023

self.checker_callback, pipe[0], command)

1024

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

734

1025

return True

735

1026

736

1027

def stop_checker(self):

737

1028

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

738

1029

if self.checker_callback_tag:

739

gobject.source_remove(self.checker_callback_tag)

1030

GObject.source_remove(self.checker_callback_tag)

740

1031

self.checker_callback_tag = None

741

1032

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

742

1033

return

743

1034

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

744

try:

745

self.checker.terminate()

746

#time.sleep(0.5)

747

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

748

# self.checker.kill()

749

except OSError as error:

750

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

751

raise

1035

self.checker.terminate()

752

1036

self.checker = None

753

1037

754

1038

755

def dbus_service_property(dbus_interface, signature="v",

756

access="readwrite", byte_arrays=False):

1039

def dbus_service_property(dbus_interface,

1040

signature="v",

1041

access="readwrite",

1042

byte_arrays=False):

757

1043

"""Decorators for marking methods of a DBusObjectWithProperties to

758

1044

become properties on the D-Bus.

759

1045

768

1054

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

769

1055

if byte_arrays and signature != "ay":

770

1056

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

771

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

1057

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

1058

772

1059

def decorator(func):

773

1060

func._dbus_is_property = True

774

1061

func._dbus_interface = dbus_interface

779

1066

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

780

1067

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

781

1068

return func

1069

782

1070

return decorator

783

1071

784

1072

793

1081

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

794

1082

"false"}

795

1083

"""

1084

796

1085

def decorator(func):

797

1086

func._dbus_is_interface = True

798

1087

func._dbus_interface = dbus_interface

799

1088

func._dbus_name = dbus_interface

800

1089

return func

1090

801

1091

return decorator

802

1092

803

1093

805

1095

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

806

1096

Usage:

807

1097

1098

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

1099

"org.freedesktop.DBus.Property."

1100

"EmitsChangedSignal": "false"})

808

1101

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

809

1102

access="r")

810

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

811

"org.freedesktop.DBus.Property."

812

"EmitsChangedSignal": "false"})

813

1103

def Property_dbus_property(self):

814

1104

return dbus.Boolean(False)

1105

1106

See also the DBusObjectWithAnnotations class.

815

1107

"""

1108

816

1109

def decorator(func):

817

1110

func._dbus_annotations = annotations

818

1111

return func

1112

819

1113

return decorator

820

1114

821

1115

822

1116

class DBusPropertyException(dbus.exceptions.DBusException):

823

1117

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

824

1118

"""

825

def __unicode__(self):

826

return unicode(str(self))

1119

pass

827

1120

828

1121

829

1122

class DBusPropertyAccessException(DBusPropertyException):

838

1131

pass

839

1132

840

1133

841

class DBusObjectWithProperties(dbus.service.Object):

842

"""A D-Bus object with properties.

1134

class DBusObjectWithAnnotations(dbus.service.Object):

1135

"""A D-Bus object with annotations.

843

1136

844

Classes inheriting from this can use the dbus_service_property

845

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

846

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

1137

Classes inheriting from this can use the dbus_annotations

1138

decorator to add annotations to methods or signals.

847

1139

"""

848

1140

849

1141

@staticmethod

853

1145

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

854

1146

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

855

1147

"""

856

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

1148

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

857

1149

False)

858

1150

859

1151

def _get_all_dbus_things(self, thing):

860

1152

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

861

1153

"""

862

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

863

name),

1154

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

864

1155

athing.__get__(self))

865

1156

for cls in self.__class__.__mro__

866

1157

for name, athing in

867

inspect.getmembers(cls,

868

self._is_dbus_thing(thing)))

1158

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

1159

1160

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1161

out_signature = "s",

1162

path_keyword = 'object_path',

1163

connection_keyword = 'connection')

1164

def Introspect(self, object_path, connection):

1165

"""Overloading of standard D-Bus method.

1166

1167

Inserts annotation tags on methods and signals.

1168

"""

1169

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

1170

connection)

1171

try:

1172

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

1173

1174

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

1175

# Add annotation tags

1176

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

1177

for tag in if_tag.getElementsByTagName(typ):

1178

annots = dict()

1179

for name, prop in (self.

1180

_get_all_dbus_things(typ)):

1181

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

1182

and prop._dbus_interface

1183

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

1184

annots.update(getattr(

1185

prop, "_dbus_annotations", {}))

1186

for name, value in annots.items():

1187

ann_tag = document.createElement(

1188

"annotation")

1189

ann_tag.setAttribute("name", name)

1190

ann_tag.setAttribute("value", value)

1191

tag.appendChild(ann_tag)

1192

# Add interface annotation tags

1193

for annotation, value in dict(

1194

itertools.chain.from_iterable(

1195

annotations().items()

1196

for name, annotations

1197

in self._get_all_dbus_things("interface")

1198

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

1199

)).items():

1200

ann_tag = document.createElement("annotation")

1201

ann_tag.setAttribute("name", annotation)

1202

ann_tag.setAttribute("value", value)

1203

if_tag.appendChild(ann_tag)

1204

# Fix argument name for the Introspect method itself

1205

if (if_tag.getAttribute("name")

1206

== dbus.INTROSPECTABLE_IFACE):

1207

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

1208

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

1209

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

1210

if (arg.getAttribute("direction")

1211

== "out"):

1212

arg.setAttribute("name",

1213

"xml_data")

1214

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

1215

document.unlink()

1216

except (AttributeError, xml.dom.DOMException,

1217

xml.parsers.expat.ExpatError) as error:

1218

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

1219

exc_info=error)

1220

return xmlstring

1221

1222

1223

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1224

"""A D-Bus object with properties.

1225

1226

Classes inheriting from this can use the dbus_service_property

1227

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

1228

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

1229

"""

869

1230

870

1231

def _get_dbus_property(self, interface_name, property_name):

871

1232

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

872

1233

property with the specified name and interface.

873

1234

"""

874

for cls in self.__class__.__mro__:

875

for name, value in (inspect.getmembers

876

(cls,

877

self._is_dbus_thing("property"))):

1235

for cls in self.__class__.__mro__:

1236

for name, value in inspect.getmembers(

1237

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

878

1238

if (value._dbus_name == property_name

879

1239

and value._dbus_interface == interface_name):

880

1240

return value.__get__(self)

881

1241

882

1242

# No such property

883

raise DBusPropertyNotFound(self.dbus_object_path + ":"

884

+ interface_name + "."

885

+ property_name)

886

887

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

1243

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

1244

self.dbus_object_path, interface_name, property_name))

1245

1246

@classmethod

1247

def _get_all_interface_names(cls):

1248

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

1249

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

1250

"_dbus_interface", None)

1251

for x in (inspect.getmro(cls))

1252

for attr in dir(x))

1253

if name is not None)

1254

1255

@dbus.service.method(dbus.PROPERTIES_IFACE,

1256

in_signature="ss",

888

1257

out_signature="v")

889

1258

def Get(self, interface_name, property_name):

890

1259

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

908

1277

# The byte_arrays option is not supported yet on

909

1278

# signatures other than "ay".

910

1279

if prop._dbus_signature != "ay":

911

raise ValueError

1280

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

1281

"'ay' signature {!r}"

1282

.format(prop._dbus_signature))

912

1283

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

913

1284

for byte in value))

914

1285

prop(value)

915

1286

916

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

1287

@dbus.service.method(dbus.PROPERTIES_IFACE,

1288

in_signature="s",

917

1289

out_signature="a{sv}")

918

1290

def GetAll(self, interface_name):

919

1291

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

934

1306

if not hasattr(value, "variant_level"):

935

1307

properties[name] = value

936

1308

continue

937

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

938

value.variant_level+1)

1309

properties[name] = type(value)(

1310

value, variant_level = value.variant_level + 1)

939

1311

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

940

1312

1313

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

1314

def PropertiesChanged(self, interface_name, changed_properties,

1315

invalidated_properties):

1316

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

1317

standard.

1318

"""

1319

pass

1320

941

1321

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

942

1322

out_signature="s",

943

1323

path_keyword='object_path',

947

1327

948

1328

Inserts property tags and interface annotation tags.

949

1329

"""

950

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

951

connection)

1330

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1331

object_path,

1332

connection)

952

1333

try:

953

1334

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

1335

954

1336

def make_tag(document, name, prop):

955

1337

e = document.createElement("property")

956

1338

e.setAttribute("name", name)

957

1339

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

958

1340

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

959

1341

return e

1342

960

1343

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

961

1344

# Add property tags

962

1345

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

965

1348

if prop._dbus_interface

966

1349

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

967

1350

if_tag.appendChild(tag)

968

# Add annotation tags

969

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

970

for tag in if_tag.getElementsByTagName(typ):

971

annots = dict()

972

for name, prop in (self.

973

_get_all_dbus_things(typ)):

974

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

975

and prop._dbus_interface

976

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

977

annots.update(getattr

978

(prop,

979

"_dbus_annotations",

980

{}))

981

for name, value in annots.iteritems():

982

ann_tag = document.createElement(

983

"annotation")

984

ann_tag.setAttribute("name", name)

985

ann_tag.setAttribute("value", value)

986

tag.appendChild(ann_tag)

987

# Add interface annotation tags

988

for annotation, value in dict(

989

itertools.chain.from_iterable(

990

annotations().iteritems()

991

for name, annotations in

992

self._get_all_dbus_things("interface")

993

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

994

)).iteritems():

995

ann_tag = document.createElement("annotation")

996

ann_tag.setAttribute("name", annotation)

997

ann_tag.setAttribute("value", value)

998

if_tag.appendChild(ann_tag)

1351

# Add annotation tags for properties

1352

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

1353

annots = dict()

1354

for name, prop in self._get_all_dbus_things(

1355

"property"):

1356

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

1357

and prop._dbus_interface

1358

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

1359

annots.update(getattr(

1360

prop, "_dbus_annotations", {}))

1361

for name, value in annots.items():

1362

ann_tag = document.createElement(

1363

"annotation")

1364

ann_tag.setAttribute("name", name)

1365

ann_tag.setAttribute("value", value)

1366

tag.appendChild(ann_tag)

999

1367

# Add the names to the return values for the

1000

1368

# "org.freedesktop.DBus.Properties" methods

1001

1369

if (if_tag.getAttribute("name")

1019

1387

exc_info=error)

1020

1388

return xmlstring

1021

1389

1022

1023

def datetime_to_dbus (dt, variant_level=0):

1390

try:

1391

dbus.OBJECT_MANAGER_IFACE

1392

except AttributeError:

1393

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

1394

1395

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1396

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

1397

1398

Classes inheriting from this exposes the standard

1399

GetManagedObjects call and the InterfacesAdded and

1400

InterfacesRemoved signals on the standard

1401

"org.freedesktop.DBus.ObjectManager" interface.

1402

1403

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

1404

manually.

1405

"""

1406

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1407

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

1408

def GetManagedObjects(self):

1409

"""This function must be overridden"""

1410

raise NotImplementedError()

1411

1412

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1413

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

1414

def InterfacesAdded(self, object_path, interfaces_and_properties):

1415

pass

1416

1417

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

1418

def InterfacesRemoved(self, object_path, interfaces):

1419

pass

1420

1421

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1422

out_signature = "s",

1423

path_keyword = 'object_path',

1424

connection_keyword = 'connection')

1425

def Introspect(self, object_path, connection):

1426

"""Overloading of standard D-Bus method.

1427

1428

Override return argument name of GetManagedObjects to be

1429

"objpath_interfaces_and_properties"

1430

"""

1431

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1432

object_path,

1433

connection)

1434

try:

1435

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

1436

1437

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

1438

# Fix argument name for the GetManagedObjects method

1439

if (if_tag.getAttribute("name")

1440

== dbus.OBJECT_MANAGER_IFACE):

1441

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

1442

if (cn.getAttribute("name")

1443

== "GetManagedObjects"):

1444

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

1445

if (arg.getAttribute("direction")

1446

== "out"):

1447

arg.setAttribute(

1448

"name",

1449

"objpath_interfaces"

1450

"_and_properties")

1451

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

1452

document.unlink()

1453

except (AttributeError, xml.dom.DOMException,

1454

xml.parsers.expat.ExpatError) as error:

1455

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

1456

exc_info = error)

1457

return xmlstring

1458

1459

def datetime_to_dbus(dt, variant_level=0):

1024

1460

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

1025

1461

if dt is None:

1026

1462

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

1027

return dbus.String(dt.isoformat(),

1028

variant_level=variant_level)

1463

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

1029

1464

1030

1465

1031

1466

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1034

1469

interface names according to the "alt_interface_names" mapping.

1035

1470

Usage:

1036

1471

1037

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

1038

"net.example.AlternateInterface"})

1472

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

1473

"net.example.AlternateInterface"})

1039

1474

class SampleDBusObject(dbus.service.Object):

1040

1475

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

1041

1476

def SampleDBusMethod():

1051

1486

(from DBusObjectWithProperties) and interfaces (from the

1052

1487

dbus_interface_annotations decorator).

1053

1488

"""

1489

1054

1490

def wrapper(cls):

1055

1491

for orig_interface_name, alt_interface_name in (

1056

alt_interface_names.iteritems()):

1492

alt_interface_names.items()):

1057

1493

attr = {}

1058

1494

interface_names = set()

1059

1495

# Go though all attributes of the class

1061

1497

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

1062

1498

# with the wrong interface name

1063

1499

if (not hasattr(attribute, "_dbus_interface")

1064

or not attribute._dbus_interface

1065

.startswith(orig_interface_name)):

1500

or not attribute._dbus_interface.startswith(

1501

orig_interface_name)):

1066

1502

continue

1067

1503

# Create an alternate D-Bus interface name based on

1068

1504

# the current name

1069

alt_interface = (attribute._dbus_interface

1070

.replace(orig_interface_name,

1071

alt_interface_name))

1505

alt_interface = attribute._dbus_interface.replace(

1506

orig_interface_name, alt_interface_name)

1072

1507

interface_names.add(alt_interface)

1073

1508

# Is this a D-Bus signal?

1074

1509

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

1075

# Extract the original non-method function by

1076

# black magic

1077

nonmethod_func = (dict(

1510

if sys.version_info.major == 2:

1511

# Extract the original non-method undecorated

1512

# function by black magic

1513

nonmethod_func = (dict(

1078

1514

zip(attribute.func_code.co_freevars,

1079

attribute.__closure__))["func"]

1080

.cell_contents)

1515

attribute.__closure__))

1516

["func"].cell_contents)

1517

else:

1518

nonmethod_func = attribute

1081

1519

# Create a new, but exactly alike, function

1082

1520

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

1083

1521

# with the alternate D-Bus interface name

1084

new_function = (dbus.service.signal

1085

(alt_interface,

1086

attribute._dbus_signature)

1087

(types.FunctionType(

1088

nonmethod_func.func_code,

1089

nonmethod_func.func_globals,

1090

nonmethod_func.func_name,

1091

nonmethod_func.func_defaults,

1092

nonmethod_func.func_closure)))

1522

if sys.version_info.major == 2:

1523

new_function = types.FunctionType(

1524

nonmethod_func.func_code,

1525

nonmethod_func.func_globals,

1526

nonmethod_func.func_name,

1527

nonmethod_func.func_defaults,

1528

nonmethod_func.func_closure)

1529

else:

1530

new_function = types.FunctionType(

1531

nonmethod_func.__code__,

1532

nonmethod_func.__globals__,

1533

nonmethod_func.__name__,

1534

nonmethod_func.__defaults__,

1535

nonmethod_func.__closure__)

1536

new_function = (dbus.service.signal(

1537

alt_interface,

1538

attribute._dbus_signature)(new_function))

1093

1539

# Copy annotations, if any

1094

1540

try:

1095

new_function._dbus_annotations = (

1096

dict(attribute._dbus_annotations))

1541

new_function._dbus_annotations = dict(

1542

attribute._dbus_annotations)

1097

1543

except AttributeError:

1098

1544

pass

1099

1545

# Define a creator of a function to call both the

1104

1550

"""This function is a scope container to pass

1105

1551

func1 and func2 to the "call_both" function

1106

1552

outside of its arguments"""

1553

1554

@functools.wraps(func2)

1107

1555

def call_both(*args, **kwargs):

1108

1556

"""This function will emit two D-Bus

1109

1557

signals by calling func1 and func2"""

1110

1558

func1(*args, **kwargs)

1111

1559

func2(*args, **kwargs)

1560

# Make wrapper function look like a D-Bus signal

1561

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

1562

if name.startswith("_dbus_"):

1563

setattr(call_both, name, attr)

1564

1112

1565

return call_both

1113

1566

# Create the "call_both" function and add it to

1114

1567

# the class

1119

1572

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

1120

1573

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

1121

1574

# to the class.

1122

attr[attrname] = (dbus.service.method

1123

(alt_interface,

1124

attribute._dbus_in_signature,

1125

attribute._dbus_out_signature)

1126

(types.FunctionType

1127

(attribute.func_code,

1128

attribute.func_globals,

1129

attribute.func_name,

1130

attribute.func_defaults,

1131

attribute.func_closure)))

1575

attr[attrname] = (

1576

dbus.service.method(

1577

alt_interface,

1578

attribute._dbus_in_signature,

1579

attribute._dbus_out_signature)

1580

(types.FunctionType(attribute.func_code,

1581

attribute.func_globals,

1582

attribute.func_name,

1583

attribute.func_defaults,

1584

attribute.func_closure)))

1132

1585

# Copy annotations, if any

1133

1586

try:

1134

attr[attrname]._dbus_annotations = (

1135

dict(attribute._dbus_annotations))

1587

attr[attrname]._dbus_annotations = dict(

1588

attribute._dbus_annotations)

1136

1589

except AttributeError:

1137

1590

pass

1138

1591

# Is this a D-Bus property?

1141

1594

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

1142

1595

# property with the alternate D-Bus interface

1143

1596

# name. Add it to the class.

1144

attr[attrname] = (dbus_service_property

1145

(alt_interface,

1146

attribute._dbus_signature,

1147

attribute._dbus_access,

1148

attribute

1149

._dbus_get_args_options

1150

["byte_arrays"])

1151

(types.FunctionType

1152

(attribute.func_code,

1153

attribute.func_globals,

1154

attribute.func_name,

1155

attribute.func_defaults,

1156

attribute.func_closure)))

1597

attr[attrname] = (dbus_service_property(

1598

alt_interface, attribute._dbus_signature,

1599

attribute._dbus_access,

1600

attribute._dbus_get_args_options

1601

["byte_arrays"])

1602

(types.FunctionType(

1603

attribute.func_code,

1604

attribute.func_globals,

1605

attribute.func_name,

1606

attribute.func_defaults,

1607

attribute.func_closure)))

1157

1608

# Copy annotations, if any

1158

1609

try:

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1610

attr[attrname]._dbus_annotations = dict(

1611

attribute._dbus_annotations)

1161

1612

except AttributeError:

1162

1613

pass

1163

1614

# Is this a D-Bus interface?

1166

1617

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

1167

1618

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

1168

1619

# to the class.

1169

attr[attrname] = (dbus_interface_annotations

1170

(alt_interface)

1171

(types.FunctionType

1172

(attribute.func_code,

1173

attribute.func_globals,

1174

attribute.func_name,

1175

attribute.func_defaults,

1176

attribute.func_closure)))

1620

attr[attrname] = (

1621

dbus_interface_annotations(alt_interface)

1622

(types.FunctionType(attribute.func_code,

1623

attribute.func_globals,

1624

attribute.func_name,

1625

attribute.func_defaults,

1626

attribute.func_closure)))

1177

1627

if deprecate:

1178

1628

# Deprecate all alternate interfaces

1179

iname="_AlternateDBusNames_interface_annotation{0}"

1629

iname="_AlternateDBusNames_interface_annotation{}"

1180

1630

for interface_name in interface_names:

1631

1181

1632

@dbus_interface_annotations(interface_name)

1182

1633

def func(self):

1183

1634

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

1184

"true" }

1635

"true" }

1185

1636

# Find an unused name

1186

1637

for aname in (iname.format(i)

1187

1638

for i in itertools.count()):

1191

1642

if interface_names:

1192

1643

# Replace the class with a new subclass of it with

1193

1644

# methods, signals, etc. as created above.

1194

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

1195

(cls,), attr)

1645

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

1646

(cls, ), attr)

1196

1647

return cls

1648

1197

1649

return wrapper

1198

1650

1199

1651

1200

1652

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

1201

"se.bsnet.fukt.Mandos"})

1653

"se.bsnet.fukt.Mandos"})

1202

1654

class ClientDBus(Client, DBusObjectWithProperties):

1203

1655

"""A Client class using D-Bus

1204

1656

1208

1660

"""

1209

1661

1210

1662

runtime_expansions = (Client.runtime_expansions

1211

+ ("dbus_object_path",))

1663

+ ("dbus_object_path", ))

1664

1665

_interface = "se.recompile.Mandos.Client"

1212

1666

1213

1667

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

1214

1668

1217

1671

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

1218

1672

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

1219

1673

# the D-Bus

1220

client_object_name = unicode(self.name).translate(

1674

client_object_name = str(self.name).translate(

1221

1675

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

1222

1676

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

1223

self.dbus_object_path = (dbus.ObjectPath

1224

("/clients/" + client_object_name))

1677

self.dbus_object_path = dbus.ObjectPath(

1678

"/clients/" + client_object_name)

1225

1679

DBusObjectWithProperties.__init__(self, self.bus,

1226

1680

self.dbus_object_path)

1227

1681

1228

def notifychangeproperty(transform_func,

1229

dbus_name, type_func=lambda x: x,

1230

variant_level=1):

1682

def notifychangeproperty(transform_func, dbus_name,

1683

type_func=lambda x: x,

1684

variant_level=1,

1685

invalidate_only=False,

1686

_interface=_interface):

1231

1687

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

1232

1688

its changes to DBus.

1233

1689

1238

1694

to the D-Bus. Default: no transform

1239

1695

variant_level: D-Bus variant level. Default: 1

1240

1696

"""

1241

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

1697

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

1698

1242

1699

def setter(self, value):

1243

1700

if hasattr(self, "dbus_object_path"):

1244

1701

if (not hasattr(self, attrname) or

1245

1702

type_func(getattr(self, attrname, None))

1246

1703

!= type_func(value)):

1247

dbus_value = transform_func(type_func(value),

1248

variant_level

1249

=variant_level)

1250

self.PropertyChanged(dbus.String(dbus_name),

1251

dbus_value)

1704

if invalidate_only:

1705

self.PropertiesChanged(

1706

_interface, dbus.Dictionary(),

1707

dbus.Array((dbus_name, )))

1708

else:

1709

dbus_value = transform_func(

1710

type_func(value),

1711

variant_level = variant_level)

1712

self.PropertyChanged(dbus.String(dbus_name),

1713

dbus_value)

1714

self.PropertiesChanged(

1715

_interface,

1716

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

1717

dbus_value }),

1718

dbus.Array())

1252

1719

setattr(self, attrname, value)

1253

1720

1254

1721

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

1260

1727

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

1261

1728

last_enabled = notifychangeproperty(datetime_to_dbus,

1262

1729

"LastEnabled")

1263

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

1264

type_func = lambda checker:

1265

checker is not None)

1730

checker = notifychangeproperty(

1731

dbus.Boolean, "CheckerRunning",

1732

type_func = lambda checker: checker is not None)

1266

1733

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1267

1734

"LastCheckedOK")

1268

1735

last_checker_status = notifychangeproperty(dbus.Int16,

1271

1738

datetime_to_dbus, "LastApprovalRequest")

1272

1739

approved_by_default = notifychangeproperty(dbus.Boolean,

1273

1740

"ApprovedByDefault")

1274

approval_delay = notifychangeproperty(dbus.UInt64,

1275

"ApprovalDelay",

1276

type_func =

1277

timedelta_to_milliseconds)

1741

approval_delay = notifychangeproperty(

1742

dbus.UInt64, "ApprovalDelay",

1743

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

1278

1744

approval_duration = notifychangeproperty(

1279

1745

dbus.UInt64, "ApprovalDuration",

1280

type_func = timedelta_to_milliseconds)

1746

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

1281

1747

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

1282

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

1283

type_func =

1284

timedelta_to_milliseconds)

1748

timeout = notifychangeproperty(

1749

dbus.UInt64, "Timeout",

1750

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

1285

1751

extended_timeout = notifychangeproperty(

1286

1752

dbus.UInt64, "ExtendedTimeout",

1287

type_func = timedelta_to_milliseconds)

1288

interval = notifychangeproperty(dbus.UInt64,

1289

"Interval",

1290

type_func =

1291

timedelta_to_milliseconds)

1753

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

1754

interval = notifychangeproperty(

1755

dbus.UInt64, "Interval",

1756

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

1292

1757

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

1758

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

1759

invalidate_only=True)

1293

1760

1294

1761

del notifychangeproperty

1295

1762

1302

1769

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

1303

1770

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

1304

1771

1305

def checker_callback(self, pid, condition, command,

1306

*args, **kwargs):

1307

self.checker_callback_tag = None

1308

self.checker = None

1309

if os.WIFEXITED(condition):

1310

exitstatus = os.WEXITSTATUS(condition)

1772

def checker_callback(self, source, condition,

1773

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

1774

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

1775

connection, command, *args,

1776

**kwargs)

1777

exitstatus = self.last_checker_status

1778

if exitstatus >= 0:

1311

1779

# Emit D-Bus signal

1312

1780

self.CheckerCompleted(dbus.Int16(exitstatus),

1313

dbus.Int64(condition),

1781

# This is specific to GNU libC

1782

dbus.Int64(exitstatus << 8),

1314

1783

dbus.String(command))

1315

1784

else:

1316

1785

# Emit D-Bus signal

1317

1786

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

1318

dbus.Int64(condition),

1787

dbus.Int64(

1788

# This is specific to GNU libC

1789

(exitstatus << 8)

1790

| self.last_checker_signal),

1319

1791

dbus.String(command))

1320

1321

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

1322

*args, **kwargs)

1792

return ret

1323

1793

1324

1794

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

1325

old_checker = self.checker

1326

if self.checker is not None:

1327

old_checker_pid = self.checker.pid

1328

else:

1329

old_checker_pid = None

1795

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

1330

1796

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

1331

1797

# Only if new checker process was started

1332

1798

if (self.checker is not None

1341

1807

1342

1808

def approve(self, value=True):

1343

1809

self.approved = value

1344

gobject.timeout_add(timedelta_to_milliseconds

1345

(self.approval_duration),

1346

self._reset_approved)

1810

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

1811

* 1000), self._reset_approved)

1347

1812

self.send_changedstate()

1348

1813

1349

1814

## D-Bus methods, signals & properties

1350

_interface = "se.recompile.Mandos.Client"

1351

1815

1352

1816

## Interfaces

1353

1817

1354

@dbus_interface_annotations(_interface)

1355

def _foo(self):

1356

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

1357

"false"}

1358

1359

1818

## Signals

1360

1819

1361

1820

# CheckerCompleted - signal

1371

1830

pass

1372

1831

1373

1832

# PropertyChanged - signal

1833

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

1374

1834

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

1375

1835

def PropertyChanged(self, property, value):

1376

1836

"D-Bus signal"

1410

1870

self.checked_ok()

1411

1871

1412

1872

# Enable - method

1873

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

1413

1874

@dbus.service.method(_interface)

1414

1875

def Enable(self):

1415

1876

"D-Bus method"

1416

1877

self.enable()

1417

1878

1418

1879

# StartChecker - method

1880

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

1419

1881

@dbus.service.method(_interface)

1420

1882

def StartChecker(self):

1421

1883

"D-Bus method"

1422

1884

self.start_checker()

1423

1885

1424

1886

# Disable - method

1887

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

1425

1888

@dbus.service.method(_interface)

1426

1889

def Disable(self):

1427

1890

"D-Bus method"

1428

1891

self.disable()

1429

1892

1430

1893

# StopChecker - method

1894

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

1431

1895

@dbus.service.method(_interface)

1432

1896

def StopChecker(self):

1433

1897

self.stop_checker()

1440

1904

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

1441

1905

1442

1906

# ApprovedByDefault - property

1443

@dbus_service_property(_interface, signature="b",

1907

@dbus_service_property(_interface,

1908

signature="b",

1444

1909

access="readwrite")

1445

1910

def ApprovedByDefault_dbus_property(self, value=None):

1446

1911

if value is None: # get

1448

1913

self.approved_by_default = bool(value)

1449

1914

1450

1915

# ApprovalDelay - property

1451

@dbus_service_property(_interface, signature="t",

1916

@dbus_service_property(_interface,

1917

signature="t",

1452

1918

access="readwrite")

1453

1919

def ApprovalDelay_dbus_property(self, value=None):

1454

1920

if value is None: # get

1455

return dbus.UInt64(self.approval_delay_milliseconds())

1921

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

1922

* 1000)

1456

1923

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

1457

1924

1458

1925

# ApprovalDuration - property

1459

@dbus_service_property(_interface, signature="t",

1926

@dbus_service_property(_interface,

1927

signature="t",

1460

1928

access="readwrite")

1461

1929

def ApprovalDuration_dbus_property(self, value=None):

1462

1930

if value is None: # get

1463

return dbus.UInt64(timedelta_to_milliseconds(

1464

self.approval_duration))

1931

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

1932

* 1000)

1465

1933

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

1466

1934

1467

1935

# Name - property

1936

@dbus_annotations(

1937

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

1468

1938

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

1469

1939

def Name_dbus_property(self):

1470

1940

return dbus.String(self.name)

1471

1941

1472

1942

# Fingerprint - property

1943

@dbus_annotations(

1944

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

1473

1945

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

1474

1946

def Fingerprint_dbus_property(self):

1475

1947

return dbus.String(self.fingerprint)

1476

1948

1477

1949

# Host - property

1478

@dbus_service_property(_interface, signature="s",

1950

@dbus_service_property(_interface,

1951

signature="s",

1479

1952

access="readwrite")

1480

1953

def Host_dbus_property(self, value=None):

1481

1954

if value is None: # get

1482

1955

return dbus.String(self.host)

1483

self.host = unicode(value)

1956

self.host = str(value)

1484

1957

1485

1958

# Created - property

1959

@dbus_annotations(

1960

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

1486

1961

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

1487

1962

def Created_dbus_property(self):

1488

1963

return datetime_to_dbus(self.created)

1493

1968

return datetime_to_dbus(self.last_enabled)

1494

1969

1495

1970

# Enabled - property

1496

@dbus_service_property(_interface, signature="b",

1971

@dbus_service_property(_interface,

1972

signature="b",

1497

1973

access="readwrite")

1498

1974

def Enabled_dbus_property(self, value=None):

1499

1975

if value is None: # get

1504

1980

self.disable()

1505

1981

1506

1982

# LastCheckedOK - property

1507

@dbus_service_property(_interface, signature="s",

1983

@dbus_service_property(_interface,

1984

signature="s",

1508

1985

access="readwrite")

1509

1986

def LastCheckedOK_dbus_property(self, value=None):

1510

1987

if value is not None:

1513

1990

return datetime_to_dbus(self.last_checked_ok)

1514

1991

1515

1992

# LastCheckerStatus - property

1516

@dbus_service_property(_interface, signature="n",

1517

access="read")

1993

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

1518

1994

def LastCheckerStatus_dbus_property(self):

1519

1995

return dbus.Int16(self.last_checker_status)

1520

1996

1529

2005

return datetime_to_dbus(self.last_approval_request)

1530

2006

1531

2007

# Timeout - property

1532

@dbus_service_property(_interface, signature="t",

2008

@dbus_service_property(_interface,

2009

signature="t",

1533

2010

access="readwrite")

1534

2011

def Timeout_dbus_property(self, value=None):

1535

2012

if value is None: # get

1536

return dbus.UInt64(self.timeout_milliseconds())

2013

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

1537

2014

old_timeout = self.timeout

1538

2015

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

1539

2016

# Reschedule disabling

1547

2024

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

1548

2025

is None):

1549

2026

return

1550

gobject.source_remove(self.disable_initiator_tag)

1551

self.disable_initiator_tag = (

1552

gobject.timeout_add(

1553

timedelta_to_milliseconds(self.expires - now),

1554

self.disable))

2027

GObject.source_remove(self.disable_initiator_tag)

2028

self.disable_initiator_tag = GObject.timeout_add(

2029

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

2030

self.disable)

1555

2031

1556

2032

# ExtendedTimeout - property

1557

@dbus_service_property(_interface, signature="t",

2033

@dbus_service_property(_interface,

2034

signature="t",

1558

2035

access="readwrite")

1559

2036

def ExtendedTimeout_dbus_property(self, value=None):

1560

2037

if value is None: # get

1561

return dbus.UInt64(self.extended_timeout_milliseconds())

2038

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

2039

* 1000)

1562

2040

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

1563

2041

1564

2042

# Interval - property

1565

@dbus_service_property(_interface, signature="t",

2043

@dbus_service_property(_interface,

2044

signature="t",

1566

2045

access="readwrite")

1567

2046

def Interval_dbus_property(self, value=None):

1568

2047

if value is None: # get

1569

return dbus.UInt64(self.interval_milliseconds())

2048

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

1570

2049

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

1571

2050

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

1572

2051

return

1573

2052

if self.enabled:

1574

2053

# Reschedule checker run

1575

gobject.source_remove(self.checker_initiator_tag)

1576

self.checker_initiator_tag = (gobject.timeout_add

1577

(value, self.start_checker))

1578

self.start_checker() # Start one now, too

2054

GObject.source_remove(self.checker_initiator_tag)

2055

self.checker_initiator_tag = GObject.timeout_add(

2056

value, self.start_checker)

2057

self.start_checker() # Start one now, too

1579

2058

1580

2059

# Checker - property

1581

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1582

2062

access="readwrite")

1583

2063

def Checker_dbus_property(self, value=None):

1584

2064

if value is None: # get

1585

2065

return dbus.String(self.checker_command)

1586

self.checker_command = unicode(value)

2066

self.checker_command = str(value)

1587

2067

1588

2068

# CheckerRunning - property

1589

@dbus_service_property(_interface, signature="b",

2069

@dbus_service_property(_interface,

2070

signature="b",

1590

2071

access="readwrite")

1591

2072

def CheckerRunning_dbus_property(self, value=None):

1592

2073

if value is None: # get

1597

2078

self.stop_checker()

1598

2079

1599

2080

# ObjectPath - property

2081

@dbus_annotations(

2082

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

2083

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

1600

2084

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

1601

2085

def ObjectPath_dbus_property(self):

1602

2086

return self.dbus_object_path # is already a dbus.ObjectPath

1603

2087

1604

2088

# Secret = property

1605

@dbus_service_property(_interface, signature="ay",

1606

access="write", byte_arrays=True)

2089

@dbus_annotations(

2090

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

2091

"invalidates"})

2092

@dbus_service_property(_interface,

2093

signature="ay",

2094

access="write",

2095

byte_arrays=True)

1607

2096

def Secret_dbus_property(self, value):

1608

self.secret = str(value)

2097

self.secret = bytes(value)

1609

2098

1610

2099

del _interface

1611

2100

1615

2104

self._pipe = child_pipe

1616

2105

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

1617

2106

if not self._pipe.recv():

1618

raise KeyError()

2107

raise KeyError(fpr)

1619

2108

1620

2109

def __getattribute__(self, name):

1621

2110

if name == '_pipe':

1625

2114

if data[0] == 'data':

1626

2115

return data[1]

1627

2116

if data[0] == 'function':

2117

1628

2118

def func(*args, **kwargs):

1629

2119

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

1630

2120

return self._pipe.recv()[1]

2121

1631

2122

return func

1632

2123

1633

2124

def __setattr__(self, name, value):

1645

2136

def handle(self):

1646

2137

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

1647

2138

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

1648

unicode(self.client_address))

2139

str(self.client_address))

1649

2140

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

1650

2141

self.server.child_pipe.fileno())

1651

2142

1652

session = (gnutls.connection

1653

.ClientSession(self.request,

1654

gnutls.connection

1655

.X509Credentials()))

1656

1657

# Note: gnutls.connection.X509Credentials is really a

1658

# generic GnuTLS certificate credentials object so long as

1659

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

1660

# here despite using OpenPGP certificates.

2143

session = gnutls.ClientSession(self.request)

1661

2144

1662

2145

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

1663

2146

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

1667

2150

priority = self.server.gnutls_priority

1668

2151

if priority is None:

1669

2152

priority = "NORMAL"

1670

(gnutls.library.functions

1671

.gnutls_priority_set_direct(session._c_object,

1672

priority, None))

2153

gnutls.priority_set_direct(session._c_object, priority,

2154

None)

1673

2155

1674

2156

# Start communication using the Mandos protocol

1675

2157

# Get protocol number

1677

2159

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

1678

2160

try:

1679

2161

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

1680

raise RuntimeError

2162

raise RuntimeError(line)

1681

2163

except (ValueError, IndexError, RuntimeError) as error:

1682

2164

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

1683

2165

return

1685

2167

# Start GnuTLS connection

1686

2168

try:

1687

2169

session.handshake()

1688

except gnutls.errors.GNUTLSError as error:

2170

except gnutls.Error as error:

1689

2171

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

1690

2172

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

1691

2173

# established. Just abandon the request.

1695

2177

approval_required = False

1696

2178

try:

1697

2179

try:

1698

fpr = self.fingerprint(self.peer_certificate

1699

(session))

1700

except (TypeError,

1701

gnutls.errors.GNUTLSError) as error:

2180

fpr = self.fingerprint(

2181

self.peer_certificate(session))

2182

except (TypeError, gnutls.Error) as error:

1702

2183

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

1703

2184

return

1704

2185

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

1717

2198

while True:

1718

2199

if not client.enabled:

1719

2200

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

1720

client.name)

2201

client.name)

1721

2202

if self.server.use_dbus:

1722

2203

# Emit D-Bus signal

1723

2204

client.Rejected("Disabled")

1732

2213

if self.server.use_dbus:

1733

2214

# Emit D-Bus signal

1734

2215

client.NeedApproval(

1735

client.approval_delay_milliseconds(),

1736

client.approved_by_default)

2216

client.approval_delay.total_seconds()

2217

* 1000, client.approved_by_default)

1737

2218

else:

1738

2219

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

1739

2220

client.name)

1745

2226

#wait until timeout or approved

1746

2227

time = datetime.datetime.now()

1747

2228

client.changedstate.acquire()

1748

client.changedstate.wait(

1749

float(timedelta_to_milliseconds(delay)

1750

/ 1000))

2229

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

1751

2230

client.changedstate.release()

1752

2231

time2 = datetime.datetime.now()

1753

2232

if (time2 - time) >= delay:

1764

2243

else:

1765

2244

delay -= time2 - time

1766

2245

1767

sent_size = 0

1768

while sent_size < len(client.secret):

1769

try:

1770

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

1771

except gnutls.errors.GNUTLSError as error:

1772

logger.warning("gnutls send failed",

1773

exc_info=error)

1774

return

1775

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

1776

sent, len(client.secret)

1777

- (sent_size + sent))

1778

sent_size += sent

2246

try:

2247

session.send(client.secret)

2248

except gnutls.Error as error:

2249

logger.warning("gnutls send failed",

2250

exc_info = error)

2251

return

1779

2252

1780

2253

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

1781

2254

# bump the timeout using extended_timeout

1789

2262

client.approvals_pending -= 1

1790

2263

try:

1791

2264

session.bye()

1792

except gnutls.errors.GNUTLSError as error:

2265

except gnutls.Error as error:

1793

2266

logger.warning("GnuTLS bye failed",

1794

2267

exc_info=error)

1795

2268

1797

2270

def peer_certificate(session):

1798

2271

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

1799

2272

# If not an OpenPGP certificate...

1800

if (gnutls.library.functions

1801

.gnutls_certificate_type_get(session._c_object)

1802

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1803

# ...do the normal thing

1804

return session.peer_certificate

2273

if (gnutls.certificate_type_get(session._c_object)

2274

!= gnutls.CRT_OPENPGP):

2275

# ...return invalid data

2276

return b""

1805

2277

list_size = ctypes.c_uint(1)

1806

cert_list = (gnutls.library.functions

1807

.gnutls_certificate_get_peers

2278

cert_list = (gnutls.certificate_get_peers

1808

2279

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

1809

2280

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

1810

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

1811

" certificate")

2281

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

1812

2282

if list_size.value == 0:

1813

2283

return None

1814

2284

cert = cert_list[0]

1818

2288

def fingerprint(openpgp):

1819

2289

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1820

2290

# New GnuTLS "datum" with the OpenPGP public key

1821

datum = (gnutls.library.types

1822

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

1823

ctypes.POINTER

1824

(ctypes.c_ubyte)),

1825

ctypes.c_uint(len(openpgp))))

2291

datum = gnutls.datum_t(

2292

ctypes.cast(ctypes.c_char_p(openpgp),

2293

ctypes.POINTER(ctypes.c_ubyte)),

2294

ctypes.c_uint(len(openpgp)))

1826

2295

# New empty GnuTLS certificate

1827

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1828

(gnutls.library.functions

1829

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2296

crt = gnutls.openpgp_crt_t()

2297

gnutls.openpgp_crt_init(ctypes.byref(crt))

1830

2298

# Import the OpenPGP public key into the certificate

1831

(gnutls.library.functions

1832

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

1833

gnutls.library.constants

1834

.GNUTLS_OPENPGP_FMT_RAW))

2299

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

2300

gnutls.OPENPGP_FMT_RAW)

1835

2301

# Verify the self signature in the key

1836

2302

crtverify = ctypes.c_uint()

1837

(gnutls.library.functions

1838

.gnutls_openpgp_crt_verify_self(crt, 0,

1839

ctypes.byref(crtverify)))

2303

gnutls.openpgp_crt_verify_self(crt, 0,

2304

ctypes.byref(crtverify))

1840

2305

if crtverify.value != 0:

1841

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1842

raise (gnutls.errors.CertificateSecurityError

1843

("Verify failed"))

2306

gnutls.openpgp_crt_deinit(crt)

2307

raise gnutls.CertificateSecurityError("Verify failed")

1844

2308

# New buffer for the fingerprint

1845

2309

buf = ctypes.create_string_buffer(20)

1846

2310

buf_len = ctypes.c_size_t()

1847

2311

# Get the fingerprint from the certificate into the buffer

1848

(gnutls.library.functions

1849

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

1850

ctypes.byref(buf_len)))

2312

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

2313

ctypes.byref(buf_len))

1851

2314

# Deinit the certificate

1852

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2315

gnutls.openpgp_crt_deinit(crt)

1853

2316

# Convert the buffer to a Python bytestring

1854

2317

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

1855

2318

# Convert the bytestring to hexadecimal notation

1859

2322

1860

2323

class MultiprocessingMixIn(object):

1861

2324

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

2325

1862

2326

def sub_process_main(self, request, address):

1863

2327

try:

1864

2328

self.finish_request(request, address)

1876

2340

1877

2341

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1878

2342

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

2343

1879

2344

def process_request(self, request, client_address):

1880

2345

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

1881

2346

1890

2355

1891

2356

def add_pipe(self, parent_pipe, proc):

1892

2357

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

1893

raise NotImplementedError

2358

raise NotImplementedError()

1894

2359

1895

2360

1896

2361

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1902

2367

interface: None or a network interface name (string)

1903

2368

use_ipv6: Boolean; to use IPv6 or not

1904

2369

"""

2370

1905

2371

def __init__(self, server_address, RequestHandlerClass,

1906

interface=None, use_ipv6=True):

2372

interface=None,

2373

use_ipv6=True,

2374

socketfd=None):

2375

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

2376

creating a new one with socket.socket().

2377

"""

1907

2378

self.interface = interface

1908

2379

if use_ipv6:

1909

2380

self.address_family = socket.AF_INET6

2381

if socketfd is not None:

2382

# Save the file descriptor

2383

self.socketfd = socketfd

2384

# Save the original socket.socket() function

2385

self.socket_socket = socket.socket

2386

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

2387

#

2388

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

2389

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

2390

# patching socket.socket.)

2391

#

2392

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

2393

@functools.wraps(socket.socket)

2394

def socket_wrapper(*args, **kwargs):

2395

# Restore original function so subsequent calls are

2396

# not affected.

2397

socket.socket = self.socket_socket

2398

del self.socket_socket

2399

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

2400

# saved file descriptor.

2401

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

2402

# Replace socket.socket() function with wrapper

2403

socket.socket = socket_wrapper

2404

# The socketserver.TCPServer.__init__ will call

2405

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

2406

# socket_wrapper(), if socketfd was set.

1910

2407

socketserver.TCPServer.__init__(self, server_address,

1911

2408

RequestHandlerClass)

2409

1912

2410

def server_bind(self):

1913

2411

"""This overrides the normal server_bind() function

1914

2412

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

1920

2418

self.interface)

1921

2419

else:

1922

2420

try:

1923

self.socket.setsockopt(socket.SOL_SOCKET,

1924

SO_BINDTODEVICE,

1925

str(self.interface

1926

+ '\0'))

2421

self.socket.setsockopt(

2422

socket.SOL_SOCKET, SO_BINDTODEVICE,

2423

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

1927

2424

except socket.error as error:

1928

if error[0] == errno.EPERM:

1929

logger.error("No permission to"

1930

" bind to interface %s",

1931

self.interface)

1932

elif error[0] == errno.ENOPROTOOPT:

2425

if error.errno == errno.EPERM:

2426

logger.error("No permission to bind to"

2427

" interface %s", self.interface)

2428

elif error.errno == errno.ENOPROTOOPT:

1933

2429

logger.error("SO_BINDTODEVICE not available;"

1934

2430

" cannot bind to interface %s",

1935

2431

self.interface)

2432

elif error.errno == errno.ENODEV:

2433

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

2434

" cannot bind", self.interface)

1936

2435

else:

1937

2436

raise

1938

2437

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

1941

2440

if self.address_family == socket.AF_INET6:

1942

2441

any_address = "::" # in6addr_any

1943

2442

else:

1944

any_address = socket.INADDR_ANY

2443

any_address = "0.0.0.0" # INADDR_ANY

1945

2444

self.server_address = (any_address,

1946

2445

self.server_address[1])

1947

2446

elif not self.server_address[1]:

1948

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

1949

0)

2447

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

1950

2448

# if self.interface:

1951

2449

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

1952

2450

# 0, # port

1964

2462

gnutls_priority GnuTLS priority string

1965

2463

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

1966

2464

1967

Assumes a gobject.MainLoop event loop.

2465

Assumes a GObject.MainLoop event loop.

1968

2466

"""

2467

1969

2468

def __init__(self, server_address, RequestHandlerClass,

1970

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

1971

gnutls_priority=None, use_dbus=True):

2469

interface=None,

2470

use_ipv6=True,

2471

clients=None,

2472

gnutls_priority=None,

2473

use_dbus=True,

2474

socketfd=None):

1972

2475

self.enabled = False

1973

2476

self.clients = clients

1974

2477

if self.clients is None:

1978

2481

IPv6_TCPServer.__init__(self, server_address,

1979

2482

RequestHandlerClass,

1980

2483

interface = interface,

1981

use_ipv6 = use_ipv6)

2484

use_ipv6 = use_ipv6,

2485

socketfd = socketfd)

2486

1982

2487

def server_activate(self):

1983

2488

if self.enabled:

1984

2489

return socketserver.TCPServer.server_activate(self)

1988

2493

1989

2494

def add_pipe(self, parent_pipe, proc):

1990

2495

# Call "handle_ipc" for both data and EOF events

1991

gobject.io_add_watch(parent_pipe.fileno(),

1992

gobject.IO_IN | gobject.IO_HUP,

1993

functools.partial(self.handle_ipc,

1994

parent_pipe =

1995

parent_pipe,

1996

proc = proc))

2496

GObject.io_add_watch(

2497

parent_pipe.fileno(),

2498

GObject.IO_IN | GObject.IO_HUP,

2499

functools.partial(self.handle_ipc,

2500

parent_pipe = parent_pipe,

2501

proc = proc))

1997

2502

1998

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

1999

proc = None, client_object=None):

2503

def handle_ipc(self, source, condition,

2504

parent_pipe=None,

2505

proc = None,

2506

client_object=None):

2000

2507

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

2001

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

2508

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

2002

2509

# Wait for other process to exit

2003

2510

proc.join()

2004

2511

return False

2025

2532

parent_pipe.send(False)

2026

2533

return False

2027

2534

2028

gobject.io_add_watch(parent_pipe.fileno(),

2029

gobject.IO_IN | gobject.IO_HUP,

2030

functools.partial(self.handle_ipc,

2031

parent_pipe =

2032

parent_pipe,

2033

proc = proc,

2034

client_object =

2035

client))

2535

GObject.io_add_watch(

2536

parent_pipe.fileno(),

2537

GObject.IO_IN | GObject.IO_HUP,

2538

functools.partial(self.handle_ipc,

2539

parent_pipe = parent_pipe,

2540

proc = proc,

2541

client_object = client))

2036

2542

parent_pipe.send(True)

2037

2543

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

2038

2544

# same fileno

2044

2550

2045

2551

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

2046

2552

funcname)(*args,

2047

**kwargs)))

2553

**kwargs)))

2048

2554

2049

2555

if command == 'getattr':

2050

2556

attrname = request[1]

2051

if callable(client_object.__getattribute__(attrname)):

2052

parent_pipe.send(('function',))

2557

if isinstance(client_object.__getattribute__(attrname),

2558

collections.Callable):

2559

parent_pipe.send(('function', ))

2053

2560

else:

2054

parent_pipe.send(('data', client_object

2055

.__getattribute__(attrname)))

2561

parent_pipe.send((

2562

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

2056

2563

2057

2564

if command == 'setattr':

2058

2565

attrname = request[1]

2062

2569

return True

2063

2570

2064

2571

2572

def rfc3339_duration_to_delta(duration):

2573

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

2574

2575

>>> rfc3339_duration_to_delta("P7D")

2576

datetime.timedelta(7)

2577

>>> rfc3339_duration_to_delta("PT60S")

2578

datetime.timedelta(0, 60)

2579

>>> rfc3339_duration_to_delta("PT60M")

2580

datetime.timedelta(0, 3600)

2581

>>> rfc3339_duration_to_delta("PT24H")

2582

datetime.timedelta(1)

2583

>>> rfc3339_duration_to_delta("P1W")

2584

datetime.timedelta(7)

2585

>>> rfc3339_duration_to_delta("PT5M30S")

2586

datetime.timedelta(0, 330)

2587

>>> rfc3339_duration_to_delta("P1DT3M20S")

2588

datetime.timedelta(1, 200)

2589

"""

2590

2591

# Parsing an RFC 3339 duration with regular expressions is not

2592

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

2593

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

2594

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

2595

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

2596

# avoid excessive use of external libraries.

2597

2598

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

2599

Token = collections.namedtuple("Token", (

2600

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

2601

# a "group" containing digits

2602

"value", # datetime.timedelta or None

2603

"followers")) # Tokens valid after this token

2604

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

2605

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

2606

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

2607

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

2608

datetime.timedelta(seconds=1),

2609

frozenset((token_end, )))

2610

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

2611

datetime.timedelta(minutes=1),

2612

frozenset((token_second, token_end)))

2613

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

2614

datetime.timedelta(hours=1),

2615

frozenset((token_minute, token_end)))

2616

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

2617

None,

2618

frozenset((token_hour, token_minute,

2619

token_second)))

2620

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

2621

datetime.timedelta(days=1),

2622

frozenset((token_time, token_end)))

2623

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

2624

datetime.timedelta(weeks=4),

2625

frozenset((token_day, token_end)))

2626

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

2627

datetime.timedelta(weeks=52),

2628

frozenset((token_month, token_end)))

2629

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

2630

datetime.timedelta(weeks=1),

2631

frozenset((token_end, )))

2632

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

2633

frozenset((token_year, token_month,

2634

token_day, token_time,

2635

token_week)))

2636

# Define starting values

2637

value = datetime.timedelta() # Value so far

2638

found_token = None

2639

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

2640

s = duration # String left to parse

2641

# Loop until end token is found

2642

while found_token is not token_end:

2643

# Search for any currently valid tokens

2644

for token in followers:

2645

match = token.regexp.match(s)

2646

if match is not None:

2647

# Token found

2648

if token.value is not None:

2649

# Value found, parse digits

2650

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

2651

# Add to value so far

2652

value += factor * token.value

2653

# Strip token from string

2654

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

2655

# Go to found token

2656

found_token = token

2657

# Set valid next tokens

2658

followers = found_token.followers

2659

break

2660

else:

2661

# No currently valid tokens were found

2662

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

2663

.format(duration))

2664

# End token found

2665

return value

2666

2667

2065

2668

def string_to_delta(interval):

2066

2669

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

2067

2670

2078

2681

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

2079

2682

datetime.timedelta(0, 330)

2080

2683

"""

2684

2685

try:

2686

return rfc3339_duration_to_delta(interval)

2687

except ValueError:

2688

pass

2689

2081

2690

timevalue = datetime.timedelta(0)

2082

2691

for s in interval.split():

2083

2692

try:

2084

suffix = unicode(s[-1])

2693

suffix = s[-1]

2085

2694

value = int(s[:-1])

2086

2695

if suffix == "d":

2087

2696

delta = datetime.timedelta(value)

2094

2703

elif suffix == "w":

2095

2704

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

2096

2705

else:

2097

raise ValueError("Unknown suffix {0!r}"

2098

.format(suffix))

2099

except (ValueError, IndexError) as e:

2706

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

2707

except IndexError as e:

2100

2708

raise ValueError(*(e.args))

2101

2709

timevalue += delta

2102

2710

return timevalue

2118

2726

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

2119

2727

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

2120

2728

raise OSError(errno.ENODEV,

2121

"{0} not a character device"

2729

"{} not a character device"

2122

2730

.format(os.devnull))

2123

2731

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

2124

2732

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

2134

2742

2135

2743

parser = argparse.ArgumentParser()

2136

2744

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

2137

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

2745

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

2138

2746

help="show version number and exit")

2139

2747

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

2140

2748

help="Bind to interface IF")

2146

2754

help="Run self-test")

2147

2755

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

2148

2756

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

2149

" to terminal")

2757

" to terminal", default=None)

2150

2758

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

2151

2759

help="Debug level for stdout output")

2152

2760

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

2159

2767

" files")

2160

2768

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

2161

2769

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

2162

" system bus interface")

2770

" system bus interface", default=None)

2163

2771

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

2164

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

2772

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

2773

default=None)

2165

2774

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

2166

2775

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

2167

" state")

2776

" state", default=None)

2777

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

2778

help="Specify a file descriptor to a network"

2779

" socket to use instead of creating one")

2168

2780

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

2169

2781

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

2782

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

2783

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

2784

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

2785

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

2786

default=None)

2170

2787

2171

2788

options = parser.parse_args()

2172

2789

2173

2790

if options.check:

2174

2791

import doctest

2175

doctest.testmod()

2176

sys.exit()

2792

fail_count, test_count = doctest.testmod()

2793

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

2177

2794

2178

2795

# Default values for config file for server-global settings

2179

2796

server_defaults = { "interface": "",

2181

2798

"port": "",

2182

2799

"debug": "False",

2183

2800

"priority":

2184

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

2801

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

2802

":+SIGN-DSA-SHA256",

2185

2803

"servicename": "Mandos",

2186

2804

"use_dbus": "True",

2187

2805

"use_ipv6": "True",

2188

2806

"debuglevel": "",

2189

2807

"restore": "True",

2190

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

2191

}

2808

"socket": "",

2809

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

2810

"foreground": "False",

2811

"zeroconf": "True",

2812

}

2192

2813

2193

2814

# Parse config file for server-global settings

2194

2815

server_config = configparser.SafeConfigParser(server_defaults)

2195

2816

del server_defaults

2196

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

2197

"mandos.conf"))

2817

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

2198

2818

# Convert the SafeConfigParser object to a dict

2199

2819

server_settings = server_config.defaults()

2200

2820

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

2201

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

2821

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

2202

2822

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

2203

2823

option)

2204

2824

if server_settings["port"]:

2205

2825

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

2206

2826

"port")

2827

if server_settings["socket"]:

2828

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

2829

"socket")

2830

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

2831

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

2832

# happen with a supplied network socket.

2833

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

2834

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

2835

["socket"])

2207

2836

del server_config

2208

2837

2209

2838

# Override the settings from the config file with command line

2210

2839

# options, if set.

2211

2840

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

2212

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

2213

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

2214

"statedir"):

2841

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

2842

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

2843

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

2215

2844

value = getattr(options, option)

2216

2845

if value is not None:

2217

2846

server_settings[option] = value

2218

2847

del options

2219

2848

# Force all strings to be unicode

2220

2849

for option in server_settings.keys():

2221

if type(server_settings[option]) is str:

2222

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

2850

if isinstance(server_settings[option], bytes):

2851

server_settings[option] = (server_settings[option]

2852

.decode("utf-8"))

2853

# Force all boolean options to be boolean

2854

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

2855

"foreground", "zeroconf"):

2856

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

2857

# Debug implies foreground

2858

if server_settings["debug"]:

2859

server_settings["foreground"] = True

2223

2860

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

2224

2861

2225

2862

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

2226

2863

2864

if (not server_settings["zeroconf"]

2865

and not (server_settings["port"]

2866

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

2867

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

2868

2227

2869

# For convenience

2228

2870

debug = server_settings["debug"]

2229

2871

debuglevel = server_settings["debuglevel"]

2231

2873

use_ipv6 = server_settings["use_ipv6"]

2232

2874

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

2233

2875

stored_state_file)

2876

foreground = server_settings["foreground"]

2877

zeroconf = server_settings["zeroconf"]

2234

2878

2235

2879

if debug:

2236

2880

initlogger(debug, logging.DEBUG)

2242

2886

initlogger(debug, level)

2243

2887

2244

2888

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

2245

syslogger.setFormatter(logging.Formatter

2246

('Mandos ({0}) [%(process)d]:'

2247

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

2248

.format(server_settings

2249

["servicename"])))

2889

syslogger.setFormatter(

2890

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

2891

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

2892

server_settings["servicename"])))

2250

2893

2251

2894

# Parse config file with clients

2252

2895

client_config = configparser.SafeConfigParser(Client

2257

2900

global mandos_dbus_service

2258

2901

mandos_dbus_service = None

2259

2902

2260

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

2261

server_settings["port"]),

2262

ClientHandler,

2263

interface=(server_settings["interface"]

2264

or None),

2265

use_ipv6=use_ipv6,

2266

gnutls_priority=

2267

server_settings["priority"],

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

2903

socketfd = None

2904

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

2905

socketfd = server_settings["socket"]

2906

tcp_server = MandosServer(

2907

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

2908

ClientHandler,

2909

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

2910

use_ipv6=use_ipv6,

2911

gnutls_priority=server_settings["priority"],

2912

use_dbus=use_dbus,

2913

socketfd=socketfd)

2914

if not foreground:

2915

pidfilename = "/run/mandos.pid"

2916

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

2917

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

2918

pidfile = None

2271

2919

try:

2272

pidfile = open(pidfilename, "w")

2920

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

2273

2921

except IOError as e:

2274

2922

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

2275

2923

exc_info=e)

2276

2924

2277

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

2925

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

2926

("mandos", "mandos"),

2927

("nobody", "nogroup")):

2278

2928

try:

2279

2929

uid = pwd.getpwnam(name).pw_uid

2280

gid = pwd.getpwnam(name).pw_gid

2930

gid = pwd.getpwnam(group).pw_gid

2281

2931

break

2282

2932

except KeyError:

2283

2933

continue

2288

2938

os.setgid(gid)

2289

2939

os.setuid(uid)

2290

2940

except OSError as error:

2291

if error[0] != errno.EPERM:

2292

raise error

2941

if error.errno != errno.EPERM:

2942

raise

2293

2943

2294

2944

if debug:

2295

2945

# Enable all possible GnuTLS debugging

2296

2946

2297

2947

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

2298

2948

# - GnuTLS manual

2299

gnutls.library.functions.gnutls_global_set_log_level(11)

2949

gnutls.global_set_log_level(11)

2300

2950

2301

@gnutls.library.types.gnutls_log_func

2951

@gnutls.log_func

2302

2952

def debug_gnutls(level, string):

2303

2953

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

2304

2954

2305

(gnutls.library.functions

2306

.gnutls_global_set_log_function(debug_gnutls))

2955

gnutls.global_set_log_function(debug_gnutls)

2307

2956

2308

2957

# Redirect stdin so all checkers get /dev/null

2309

2958

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

2312

2961

os.close(null)

2313

2962

2314

2963

# Need to fork before connecting to D-Bus

2315

if not debug:

2964

if not foreground:

2316

2965

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

2317

2966

daemon()

2318

2967

2319

gobject.threads_init()

2968

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

2969

# need to inform GObject that threads will be used.

2970

GObject.threads_init()

2320

2971

2321

2972

global main_loop

2322

2973

# From the Avahi example code

2323

2974

DBusGMainLoop(set_as_default=True)

2324

main_loop = gobject.MainLoop()

2975

main_loop = GObject.MainLoop()

2325

2976

bus = dbus.SystemBus()

2326

2977

# End of Avahi example code

2327

2978

if use_dbus:

2328

2979

try:

2329

2980

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

2330

bus, do_not_queue=True)

2331

old_bus_name = (dbus.service.BusName

2332

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

2333

do_not_queue=True))

2334

except dbus.exceptions.NameExistsException as e:

2981

bus,

2982

do_not_queue=True)

2983

old_bus_name = dbus.service.BusName(

2984

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

2985

do_not_queue=True)

2986

except dbus.exceptions.DBusException as e:

2335

2987

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

2336

2988

use_dbus = False

2337

2989

server_settings["use_dbus"] = False

2338

2990

tcp_server.use_dbus = False

2339

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2340

service = AvahiServiceToSyslog(name =

2341

server_settings["servicename"],

2342

servicetype = "_mandos._tcp",

2343

protocol = protocol, bus = bus)

2344

if server_settings["interface"]:

2345

service.interface = (if_nametoindex

2346

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

2991

if zeroconf:

2992

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2993

service = AvahiServiceToSyslog(

2994

name = server_settings["servicename"],

2995

servicetype = "_mandos._tcp",

2996

protocol = protocol,

2997

bus = bus)

2998

if server_settings["interface"]:

2999

service.interface = if_nametoindex(

3000

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

2347

3001

2348

3002

global multiprocessing_manager

2349

3003

multiprocessing_manager = multiprocessing.Manager()

2356

3010

old_client_settings = {}

2357

3011

clients_data = {}

2358

3012

3013

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

3014

global wnull

3015

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

3016

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

3017

# mode

3018

if debug or not foreground:

3019

wnull.close()

3020

2359

3021

# Get client data and settings from last running state.

2360

3022

if server_settings["restore"]:

2361

3023

try:

2362

3024

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

2363

clients_data, old_client_settings = (pickle.load

2364

(stored_state))

3025

clients_data, old_client_settings = pickle.load(

3026

stored_state)

2365

3027

os.remove(stored_state_path)

2366

3028

except IOError as e:

2367

3029

if e.errno == errno.ENOENT:

2368

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

2369

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

3030

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

3031

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

2370

3032

else:

2371

3033

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

2372

3034

exc_info=e)

2373

3035

raise

2374

3036

except EOFError as e:

2375

3037

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

2376

"EOFError:", exc_info=e)

3038

"EOFError:",

3039

exc_info=e)

2377

3040

2378

3041

with PGPEngine() as pgp:

2379

for client_name, client in clients_data.iteritems():

3042

for client_name, client in clients_data.items():

3043

# Skip removed clients

3044

if client_name not in client_settings:

3045

continue

3046

2380

3047

# Decide which value to use after restoring saved state.

2381

3048

# We have three different values: Old config file,

2382

3049

# new config file, and saved state.

2387

3054

# For each value in new config, check if it

2388

3055

# differs from the old config value (Except for

2389

3056

# the "secret" attribute)

2390

if (name != "secret" and

2391

value != old_client_settings[client_name]

2392

[name]):

3057

if (name != "secret"

3058

and (value !=

3059

old_client_settings[client_name][name])):

2393

3060

client[name] = value

2394

3061

except KeyError:

2395

3062

pass

2396

3063

2397

3064

# Clients who has passed its expire date can still be

2398

# enabled if its last checker was successful. Clients

3065

# enabled if its last checker was successful. A Client

2399

3066

# whose checker succeeded before we stored its state is

2400

3067

# assumed to have successfully run all checkers during

2401

3068

# downtime.

2403

3070

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

2404

3071

if not client["last_checked_ok"]:

2405

3072

logger.warning(

2406

"disabling client {0} - Client never "

2407

"performed a successful checker"

2408

.format(client_name))

3073

"disabling client {} - Client never "

3074

"performed a successful checker".format(

3075

client_name))

2409

3076

client["enabled"] = False

2410

3077

elif client["last_checker_status"] != 0:

2411

3078

logger.warning(

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2414

.format(client_name,

2415

client["last_checker_status"]))

3079

"disabling client {} - Client last"

3080

" checker failed with error code"

3081

" {}".format(

3082

client_name,

3083

client["last_checker_status"]))

2416

3084

client["enabled"] = False

2417

3085

else:

2418

client["expires"] = (datetime.datetime

2419

.utcnow()

2420

+ client["timeout"])

3086

client["expires"] = (

3087

datetime.datetime.utcnow()

3088

+ client["timeout"])

2421

3089

logger.debug("Last checker succeeded,"

2422

" keeping {0} enabled"

2423

.format(client_name))

3090

" keeping {} enabled".format(

3091

client_name))

2424

3092

try:

2425

client["secret"] = (

2426

pgp.decrypt(client["encrypted_secret"],

2427

client_settings[client_name]

2428

["secret"]))

3093

client["secret"] = pgp.decrypt(

3094

client["encrypted_secret"],

3095

client_settings[client_name]["secret"])

2429

3096

except PGPError:

2430

3097

# If decryption fails, we use secret from new settings

2431

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

2432

.format(client_name))

2433

client["secret"] = (

2434

client_settings[client_name]["secret"])

3098

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

3099

client_name))

3100

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

3101

["secret"])

2435

3102

2436

3103

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

2437

3104

for client_name in (set(old_client_settings)

2442

3109

clients_data[client_name] = client_settings[client_name]

2443

3110

2444

3111

# Create all client objects

2445

for client_name, client in clients_data.iteritems():

3112

for client_name, client in clients_data.items():

2446

3113

tcp_server.clients[client_name] = client_class(

2447

name = client_name, settings = client)

3114

name = client_name,

3115

settings = client,

3116

server_settings = server_settings)

2448

3117

2449

3118

if not tcp_server.clients:

2450

3119

logger.warning("No clients defined")

2451

3120

2452

if not debug:

2453

try:

2454

with pidfile:

2455

pid = os.getpid()

2456

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

2457

del pidfile

2458

except IOError:

2459

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

2460

pidfilename, pid)

2461

except NameError:

2462

# "pidfile" was never created

2463

pass

3121

if not foreground:

3122

if pidfile is not None:

3123

pid = os.getpid()

3124

try:

3125

with pidfile:

3126

print(pid, file=pidfile)

3127

except IOError:

3128

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

3129

pidfilename, pid)

3130

del pidfile

2464

3131

del pidfilename

2465

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

2466

3132

2467

3133

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

2468

3134

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

2469

3135

2470

3136

if use_dbus:

2471

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

2472

"se.bsnet.fukt.Mandos"})

2473

class MandosDBusService(DBusObjectWithProperties):

3137

3138

@alternate_dbus_interfaces(

3139

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

3140

class MandosDBusService(DBusObjectWithObjectManager):

2474

3141

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

3142

2475

3143

def __init__(self):

2476

3144

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

3145

2477

3146

_interface = "se.recompile.Mandos"

2478

3147

2479

@dbus_interface_annotations(_interface)

2480

def _foo(self):

2481

return { "org.freedesktop.DBus.Property"

2482

".EmitsChangedSignal":

2483

"false"}

2484

2485

3148

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

2486

3149

def ClientAdded(self, objpath):

2487

3150

"D-Bus signal"

2492

3155

"D-Bus signal"

2493

3156

pass

2494

3157

3158

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

3159

"true"})

2495

3160

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

2496

3161

def ClientRemoved(self, objpath, name):

2497

3162

"D-Bus signal"

2498

3163

pass

2499

3164

3165

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

3166

"true"})

2500

3167

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

2501

3168

def GetAllClients(self):

2502

3169

"D-Bus method"

2503

return dbus.Array(c.dbus_object_path

2504

for c in

3170

return dbus.Array(c.dbus_object_path for c in

2505

3171

tcp_server.clients.itervalues())

2506

3172

3173

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

3174

"true"})

2507

3175

@dbus.service.method(_interface,

2508

3176

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

2509

3177

def GetAllClientsWithProperties(self):

2510

3178

"D-Bus method"

2511

3179

return dbus.Dictionary(

2512

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

2513

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

3180

{ c.dbus_object_path: c.GetAll(

3181

"se.recompile.Mandos.Client")

3182

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

2514

3183

signature="oa{sv}")

2515

3184

2516

3185

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

2520

3189

if c.dbus_object_path == object_path:

2521

3190

del tcp_server.clients[c.name]

2522

3191

c.remove_from_connection()

2523

# Don't signal anything except ClientRemoved

3192

# Don't signal the disabling

2524

3193

c.disable(quiet=True)

2525

# Emit D-Bus signal

2526

self.ClientRemoved(object_path, c.name)

3194

# Emit D-Bus signal for removal

3195

self.client_removed_signal(c)

2527

3196

return

2528

3197

raise KeyError(object_path)

2529

3198

2530

3199

del _interface

3200

3201

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3202

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

3203

def GetManagedObjects(self):

3204

"""D-Bus method"""

3205

return dbus.Dictionary(

3206

{ client.dbus_object_path:

3207

dbus.Dictionary(

3208

{ interface: client.GetAll(interface)

3209

for interface in

3210

client._get_all_interface_names()})

3211

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

3212

3213

def client_added_signal(self, client):

3214

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

3215

if use_dbus:

3216

# New standard signal

3217

self.InterfacesAdded(

3218

client.dbus_object_path,

3219

dbus.Dictionary(

3220

{ interface: client.GetAll(interface)

3221

for interface in

3222

client._get_all_interface_names()}))

3223

# Old signal

3224

self.ClientAdded(client.dbus_object_path)

3225

3226

def client_removed_signal(self, client):

3227

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

3228

if use_dbus:

3229

# New standard signal

3230

self.InterfacesRemoved(

3231

client.dbus_object_path,

3232

client._get_all_interface_names())

3233

# Old signal

3234

self.ClientRemoved(client.dbus_object_path,

3235

client.name)

2531

3236

2532

3237

mandos_dbus_service = MandosDBusService()

2533

3238

2534

3239

def cleanup():

2535

3240

"Cleanup function; run on exit"

2536

service.cleanup()

3241

if zeroconf:

3242

service.cleanup()

2537

3243

2538

3244

multiprocessing.active_children()

3245

wnull.close()

2539

3246

if not (tcp_server.clients or client_settings):

2540

3247

return

2541

3248

2552

3259

2553

3260

# A list of attributes that can not be pickled

2554

3261

# + secret.

2555

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

2556

"checker"))

2557

for name, typ in (inspect.getmembers

2558

(dbus.service.Object)):

3262

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

3263

"checker", "server_settings" }

3264

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

3265

.Object):

2559

3266

exclude.add(name)

2560

3267

2561

3268

client_dict["encrypted_secret"] = (client

2568

3275

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

2569

3276

2570

3277

try:

2571

with (tempfile.NamedTemporaryFile

2572

(mode='wb', suffix=".pickle", prefix='clients-',

2573

dir=os.path.dirname(stored_state_path),

2574

delete=False)) as stored_state:

3278

with tempfile.NamedTemporaryFile(

3279

mode='wb',

3280

suffix=".pickle",

3281

prefix='clients-',

3282

dir=os.path.dirname(stored_state_path),

3283

delete=False) as stored_state:

2575

3284

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

2576

tempname=stored_state.name

3285

tempname = stored_state.name

2577

3286

os.rename(tempname, stored_state_path)

2578

3287

except (IOError, OSError) as e:

2579

3288

if not debug:

2582

3291

except NameError:

2583

3292

pass

2584

3293

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

2585

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

3294

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

2586

3295

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

2587

3296

else:

2588

3297

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

2589

3298

exc_info=e)

2590

raise e

3299

raise

2591

3300

2592

3301

# Delete all clients, and settings from config

2593

3302

while tcp_server.clients:

2594

3303

name, client = tcp_server.clients.popitem()

2595

3304

if use_dbus:

2596

3305

client.remove_from_connection()

2597

# Don't signal anything except ClientRemoved

3306

# Don't signal the disabling

2598

3307

client.disable(quiet=True)

3308

# Emit D-Bus signal for removal

2599

3309

if use_dbus:

2600

# Emit D-Bus signal

2601

mandos_dbus_service.ClientRemoved(client

2602

.dbus_object_path,

2603

client.name)

3310

mandos_dbus_service.client_removed_signal(client)

2604

3311

client_settings.clear()

2605

3312

2606

3313

atexit.register(cleanup)

2607

3314

2608

3315

for client in tcp_server.clients.itervalues():

2609

3316

if use_dbus:

2610

# Emit D-Bus signal

2611

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3317

# Emit D-Bus signal for adding

3318

mandos_dbus_service.client_added_signal(client)

2612

3319

# Need to initiate checking of clients

2613

3320

if client.enabled:

2614

3321

client.init_checker()

2617

3324

tcp_server.server_activate()

2618

3325

2619

3326

# Find out what port we got

2620

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

3327

if zeroconf:

3328

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

2621

3329

if use_ipv6:

2622

3330

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

2623

3331

" flowinfo %d, scope_id %d",

2629

3337

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

2630

3338

2631

3339

try:

2632

# From the Avahi example code

2633

try:

2634

service.activate()

2635

except dbus.exceptions.DBusException as error:

2636

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

2637

cleanup()

2638

sys.exit(1)

2639

# End of Avahi example code

3340

if zeroconf:

3341

# From the Avahi example code

3342

try:

3343

service.activate()

3344

except dbus.exceptions.DBusException as error:

3345

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

3346

cleanup()

3347

sys.exit(1)

3348

# End of Avahi example code

2640

3349

2641

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

3350

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

2642

3351

lambda *args, **kwargs:

2643

3352

(tcp_server.handle_request

2644

3353

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

2657

3366

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

2658

3367

cleanup()

2659

3368

3369

2660

3370

if __name__ == '__main__':

2661

3371

main()