/mandos/release : revision 289

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

37

import SocketServer as socketserver

43

38

import socket

44

39

import argparse

45

40

import datetime

46

41

import errno

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

51

49

import sys

52

50

import re

53

51

import os

62

60

import struct

63

61

import fcntl

64

62

import functools

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

63

import cPickle as pickle

69

64

import multiprocessing

70

65

import types

71

import binascii

72

import tempfile

73

import itertools

74

import collections

75

import codecs

76

66

77

67

import dbus

78

68

import dbus.service

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

69

import gobject

83

70

import avahi

84

71

from dbus.mainloop.glib import DBusGMainLoop

85

72

import ctypes

95

82

except ImportError:

96

83

SO_BINDTODEVICE = None

97

84

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.2"

102

stored_state_file = "clients.pickle"

103

104

logger = logging.getLogger()

105

syslogger = None

106

107

try:

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

110

except (OSError, AttributeError):

111

112

def if_nametoindex(interface):

113

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

114

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

115

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

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

117

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

118

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

119

return interface_index

120

121

122

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

123

"""init logger and add loglevel"""

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

129

syslogger.setFormatter(logging.Formatter

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

134

if debug:

135

console = logging.StreamHandler()

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

141

logger.setLevel(level)

142

143

144

class PGPError(Exception):

145

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

146

pass

147

148

149

class PGPEngine(object):

150

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

151

152

def __init__(self):

153

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

154

self.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']

170

171

def __enter__(self):

172

return self

173

174

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

175

self._cleanup()

176

return False

177

178

def __del__(self):

179

self._cleanup()

180

181

def _cleanup(self):

182

if self.tempdir is not None:

183

# Delete contents of tempdir

184

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

185

topdown = False):

186

for filename in files:

187

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

188

for dirname in dirs:

189

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

190

# Remove tempdir

191

os.rmdir(self.tempdir)

192

self.tempdir = None

193

194

def password_encode(self, password):

195

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

196

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

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

204

205

def encrypt(self, data, password):

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)

221

return ciphertext

222

223

def decrypt(self, data, password):

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)

239

return decrypted_plaintext

240

85

86

version = "1.4.1"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

90

syslogger = (logging.handlers.SysLogHandler

91

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

241

103

242

104

class AvahiError(Exception):

243

105

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

244

106

self.value = value

245

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

246

**kwargs)

247

107

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

108

def __unicode__(self):

109

return unicode(repr(self.value))

248

110

249

111

class AvahiServiceError(AvahiError):

250

112

pass

251

113

252

253

114

class AvahiGroupError(AvahiError):

254

115

pass

255

116

262

123

Used to optionally bind to the specified interface.

263

124

name: string; Example: 'Mandos'

264

125

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

265

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

126

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

266

127

port: integer; what port to announce

267

128

TXT: list of strings; TXT record for the service

268

129

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

274

135

server: D-Bus Server

275

136

bus: dbus.SystemBus()

276

137

"""

277

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

138

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

139

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

140

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

141

protocol = avahi.PROTO_UNSPEC, bus = None):

289

142

self.interface = interface

290

143

self.name = name

291

144

self.type = servicetype

300

153

self.server = None

301

154

self.bus = bus

302

155

self.entry_group_state_changed_match = None

303

304

def rename(self, remove=True):

156

def rename(self):

305

157

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

306

158

if self.rename_count >= self.max_renames:

307

159

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

308

160

" after %i retries, exiting.",

309

161

self.rename_count)

310

162

raise AvahiServiceError("Too many renames")

311

self.name = str(

312

self.server.GetAlternativeServiceName(self.name))

313

self.rename_count += 1

163

self.name = unicode(self.server

164

.GetAlternativeServiceName(self.name))

314

165

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

315

166

self.name)

316

if remove:

317

self.remove()

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

self.remove()

318

172

try:

319

173

self.add()

320

174

except dbus.exceptions.DBusException as error:

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)

329

175

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

176

self.cleanup()

177

os._exit(1)

178

self.rename_count += 1

330

179

def remove(self):

331

180

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

332

181

if self.entry_group_state_changed_match is not None:

334

183

self.entry_group_state_changed_match = None

335

184

if self.group is not None:

336

185

self.group.Reset()

337

338

186

def add(self):

339

187

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

340

188

self.remove()

345

193

avahi.DBUS_INTERFACE_ENTRY_GROUP)

346

194

self.entry_group_state_changed_match = (

347

195

self.group.connect_to_signal(

348

'StateChanged', self.entry_group_state_changed))

196

'StateChanged', self .entry_group_state_changed))

349

197

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

350

198

self.name, self.type)

351

199

self.group.AddService(

357

205

dbus.UInt16(self.port),

358

206

avahi.string_array_to_txt_array(self.TXT))

359

207

self.group.Commit()

360

361

208

def entry_group_state_changed(self, state, error):

362

209

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

363

210

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

369

216

self.rename()

370

217

elif state == avahi.ENTRY_GROUP_FAILURE:

371

218

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

372

str(error))

373

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

374

219

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

375

222

def cleanup(self):

376

223

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

377

224

if self.group is not None:

378

225

try:

379

226

self.group.Free()

380

227

except (dbus.exceptions.UnknownMethodException,

381

dbus.exceptions.DBusException):

228

dbus.exceptions.DBusException) as e:

382

229

pass

383

230

self.group = None

384

231

self.remove()

385

386

232

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

387

233

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

388

234

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

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

}

235

bad_states = { avahi.SERVER_INVALID:

236

"Zeroconf server invalid",

237

avahi.SERVER_REGISTERING: None,

238

avahi.SERVER_COLLISION:

239

"Zeroconf server name collision",

240

avahi.SERVER_FAILURE:

241

"Zeroconf server failure" }

395

242

if state in bad_states:

396

243

if bad_states[state] is not None:

397

244

if error is None:

400

247

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

401

248

self.cleanup()

402

249

elif state == avahi.SERVER_RUNNING:

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)

250

self.add()

415

251

else:

416

252

if error is None:

417

253

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

418

254

else:

419

255

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

420

421

256

def activate(self):

422

257

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

423

258

if self.server is None:

427

262

follow_name_owner_changes=True),

428

263

avahi.DBUS_INTERFACE_SERVER)

429

264

self.server.connect_to_signal("StateChanged",

430

self.server_state_changed)

265

self.server_state_changed)

431

266

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

432

267

433

268

434

class AvahiServiceToSyslog(AvahiService):

435

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

436

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

437

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

438

syslogger.setFormatter(logging.Formatter(

439

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

440

.format(self.name)))

441

return ret

442

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

707

269

def _timedelta_to_milliseconds(td):

270

"Convert a datetime.timedelta() to milliseconds"

271

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

272

+ (td.seconds * 1000)

273

+ (td.microseconds // 1000))

274

708

275

class Client(object):

709

276

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

710

277

711

278

Attributes:

712

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

279

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

713

280

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

714

281

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

715

282

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

722

289

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

723

290

checker_initiator_tag: a gobject event source tag, or None

724

291

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

725

client_structure: Object describing what attributes a client has

726

and is used for storing the client at exit

727

292

current_checker_command: string; current running checker_command

293

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

728

294

disable_initiator_tag: a gobject event source tag, or None

729

295

enabled: bool()

730

296

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

733

299

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

734

300

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

735

301

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

736

last_checker_status: integer between 0 and 255 reflecting exit

737

status of last checker. -1 reflects crashed

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

741

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

302

last_enabled: datetime.datetime(); (UTC)

742

303

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

743

304

D-Bus identifiers

744

305

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

745

306

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

746

307

until this client is disabled

747

extended_timeout: extra long timeout when secret has been sent

308

extended_timeout: extra long timeout when password has been sent

748

309

runtime_expansions: Allowed attributes for runtime expansion.

749

310

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

750

311

disabled, or None

751

server_settings: The server_settings dict from main()

752

312

"""

753

313

754

314

runtime_expansions = ("approval_delay", "approval_duration",

755

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

756

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

757

"last_approval_request", "last_checked_ok",

315

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

316

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

758

317

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

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

}

770

771

@staticmethod

772

def config_parser(config):

773

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

774

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

775

with exceptions for any special settings as defined above.

776

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

777

value given the same arguments.

778

"""

779

settings = {}

780

for client_name in config.sections():

781

section = dict(config.items(client_name))

782

client = settings[client_name] = {}

783

784

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

785

# Reformat values from string types to Python types

786

client["approved_by_default"] = config.getboolean(

787

client_name, "approved_by_default")

788

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

789

"enabled")

790

791

# Uppercase and remove spaces from fingerprint for later

792

# comparison purposes with return value from the

793

# fingerprint() function

794

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

795

.replace(" ", ""))

796

if "secret" in section:

797

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

798

elif "secfile" in section:

799

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

800

(section["secfile"])),

801

"rb") as secfile:

802

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

803

else:

804

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

805

.format(section))

806

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

807

client["extended_timeout"] = string_to_delta(

808

section["extended_timeout"])

809

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

810

client["approval_delay"] = string_to_delta(

811

section["approval_delay"])

812

client["approval_duration"] = string_to_delta(

813

section["approval_duration"])

814

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

815

client["last_approval_request"] = None

816

client["last_checked_ok"] = None

817

client["last_checker_status"] = -2

818

819

return settings

820

821

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

318

319

def timeout_milliseconds(self):

320

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

322

323

def extended_timeout_milliseconds(self):

324

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

326

327

def interval_milliseconds(self):

328

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

330

331

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

822

338

self.name = name

823

if server_settings is None:

824

server_settings = {}

825

self.server_settings = server_settings

826

# adding all client settings

827

for setting, value in settings.items():

828

setattr(self, setting, value)

829

830

if self.enabled:

831

if not hasattr(self, "last_enabled"):

832

self.last_enabled = datetime.datetime.utcnow()

833

if not hasattr(self, "expires"):

834

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

835

+ self.timeout)

836

else:

837

self.last_enabled = None

838

self.expires = None

839

339

if config is None:

340

config = {}

840

341

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

342

# Uppercase and remove spaces from fingerprint for later

343

# comparison purposes with return value from the fingerprint()

344

# function

345

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

346

.replace(" ", ""))

841

347

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

842

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

843

datetime.datetime.utcnow())

844

845

# attributes specific for this server instance

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

846

369

self.checker = None

847

370

self.checker_initiator_tag = None

848

371

self.disable_initiator_tag = None

372

self.expires = None

849

373

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

850

375

self.current_checker_command = None

851

self.approved = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

852

380

self.approvals_pending = 0

853

self.changedstate = multiprocessing_manager.Condition(

854

multiprocessing_manager.Lock())

855

self.client_structure = [attr

856

for attr in self.__dict__.iterkeys()

857

if not attr.startswith("_")]

858

self.client_structure.append("client_structure")

859

860

for name, t in inspect.getmembers(

861

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

862

if not name.startswith("_"):

863

self.client_structure.append(name)

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

self.changedstate = (multiprocessing_manager

386

.Condition(multiprocessing_manager

387

.Lock()))

864

388

865

# Send notice to process children that client state has changed

866

389

def send_changedstate(self):

867

with self.changedstate:

868

self.changedstate.notify_all()

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

869

393

870

394

def enable(self):

871

395

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

872

396

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

873

397

# Already enabled

874

398

return

399

self.send_changedstate()

400

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

401

# and every interval from then on.

402

self.checker_initiator_tag = (gobject.timeout_add

403

(self.interval_milliseconds(),

404

self.start_checker))

405

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

875

406

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

876

410

self.enabled = True

877

411

self.last_enabled = datetime.datetime.utcnow()

878

self.init_checker()

879

self.send_changedstate()

412

# Also start a new checker *right now*.

413

self.start_checker()

880

414

881

415

def disable(self, quiet=True):

882

416

"""Disable this client."""

883

417

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

884

418

return False

885

419

if not quiet:

420

self.send_changedstate()

421

if not quiet:

886

422

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

887

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

423

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

888

424

gobject.source_remove(self.disable_initiator_tag)

889

425

self.disable_initiator_tag = None

890

426

self.expires = None

891

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

427

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

892

428

gobject.source_remove(self.checker_initiator_tag)

893

429

self.checker_initiator_tag = None

894

430

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

895

433

self.enabled = False

896

if not quiet:

897

self.send_changedstate()

898

434

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

899

435

return False

900

436

901

437

def __del__(self):

438

self.disable_hook = None

902

439

self.disable()

903

440

904

def init_checker(self):

905

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

906

# and every interval from then on.

907

if self.checker_initiator_tag is not None:

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)

912

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

913

if self.disable_initiator_tag is not None:

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)

917

# Also start a new checker *right now*.

918

self.start_checker()

919

920

def checker_callback(self, source, condition, connection,

921

command):

441

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

922

442

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

923

443

self.checker_callback_tag = None

924

444

self.checker = None

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

932

if self.last_checker_status == 0:

445

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

933

448

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

934

449

vars(self))

935

450

self.checked_ok()

936

451

else:

937

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

452

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

453

vars(self))

938

454

else:

939

self.last_checker_status = -1

940

self.last_checker_signal = -returncode

941

455

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

942

456

vars(self))

943

return False

944

945

def checked_ok(self):

946

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

947

self.last_checked_ok = datetime.datetime.utcnow()

948

self.last_checker_status = 0

949

self.last_checker_signal = None

950

self.bump_timeout()

951

952

def bump_timeout(self, timeout=None):

953

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

457

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

954

464

if timeout is None:

955

465

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

956

467

if self.disable_initiator_tag is not None:

957

468

gobject.source_remove(self.disable_initiator_tag)

958

self.disable_initiator_tag = None

959

469

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

960

self.disable_initiator_tag = gobject.timeout_add(

961

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

470

self.disable_initiator_tag = (gobject.timeout_add

471

(_timedelta_to_milliseconds

472

(timeout), self.disable))

962

473

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

963

474

964

475

def need_approval(self):

970

481

If a checker already exists, leave it running and do

971

482

nothing."""

972

483

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

973

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

974

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

975

# would inevitably timeout, since no checker would get a

976

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

484

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

485

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

486

# client would inevitably timeout, since no checker would get

487

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

977

488

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

978

489

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

979

490

# should be.

980

491

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

492

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

493

try:

494

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

495

except (AttributeError, OSError) as error:

496

if (isinstance(error, OSError)

497

and error.errno != errno.ECHILD):

498

raise error

499

else:

500

if pid:

501

logger.warning("Checker was a zombie")

502

gobject.source_remove(self.checker_callback_tag)

503

self.checker_callback(pid, status,

504

self.current_checker_command)

985

505

# Start a new checker if needed

986

506

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 }

991

507

try:

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

508

# In case checker_command has exactly one % operator

509

command = self.checker_command % self.host

510

except TypeError:

511

# Escape attributes for the shell

512

escaped_attrs = dict(

513

(attr,

514

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

515

errors=

516

'replace')))

517

for attr in

518

self.runtime_expansions)

519

520

try:

521

command = self.checker_command % escaped_attrs

522

except TypeError as error:

523

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

524

' %s', self.checker_command, error)

525

return True # Try again later

998

526

self.current_checker_command = command

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)

527

try:

528

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

529

command, self.name)

530

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

531

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

532

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

533

# always replaced by /dev/null.)

534

self.checker = subprocess.Popen(command,

535

close_fds=True,

536

shell=True, cwd="/")

537

self.checker_callback_tag = (gobject.child_watch_add

538

(self.checker.pid,

539

self.checker_callback,

540

data=command))

541

# The checker may have completed before the gobject

542

# watch was added. Check for this.

543

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

544

if pid:

545

gobject.source_remove(self.checker_callback_tag)

546

self.checker_callback(pid, status, command)

547

except OSError as error:

548

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

549

error)

1024

550

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

1025

551

return True

1026

552

1032

558

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

1033

559

return

1034

560

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

1035

self.checker.terminate()

561

try:

562

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

563

#time.sleep(0.5)

564

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

565

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

566

except OSError as error:

567

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

568

raise

1036

569

self.checker = None

1037

570

1038

571

1039

def dbus_service_property(dbus_interface,

1040

signature="v",

1041

access="readwrite",

1042

byte_arrays=False):

572

def dbus_service_property(dbus_interface, signature="v",

573

access="readwrite", byte_arrays=False):

1043

574

"""Decorators for marking methods of a DBusObjectWithProperties to

1044

575

become properties on the D-Bus.

1045

576

1054

585

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

1055

586

if byte_arrays and signature != "ay":

1056

587

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

1057

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

1058

588

" signature %r" % signature)

1059

589

def decorator(func):

1060

590

func._dbus_is_property = True

1061

591

func._dbus_interface = dbus_interface

1066

596

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

1067

597

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1068

598

return func

1069

1070

return decorator

1071

1072

1073

def dbus_interface_annotations(dbus_interface):

1074

"""Decorator for marking functions returning interface annotations

1075

1076

Usage:

1077

1078

@dbus_interface_annotations("org.example.Interface")

1079

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

1080

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

1081

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

1082

"false"}

1083

"""

1084

1085

def decorator(func):

1086

func._dbus_is_interface = True

1087

func._dbus_interface = dbus_interface

1088

func._dbus_name = dbus_interface

1089

return func

1090

1091

return decorator

1092

1093

1094

def dbus_annotations(annotations):

1095

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

1096

Usage:

1097

1098

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

1099

"org.freedesktop.DBus.Property."

1100

"EmitsChangedSignal": "false"})

1101

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

1102

access="r")

1103

def Property_dbus_property(self):

1104

return dbus.Boolean(False)

1105

1106

See also the DBusObjectWithAnnotations class.

1107

"""

1108

1109

def decorator(func):

1110

func._dbus_annotations = annotations

1111

return func

1112

1113

599

return decorator

1114

600

1115

601

1116

602

class DBusPropertyException(dbus.exceptions.DBusException):

1117

603

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

1118

604

"""

1119

pass

605

def __unicode__(self):

606

return unicode(str(self))

1120

607

1121

608

1122

609

class DBusPropertyAccessException(DBusPropertyException):

1131

618

pass

1132

619

1133

620

1134

class DBusObjectWithAnnotations(dbus.service.Object):

1135

"""A D-Bus object with annotations.

1136

1137

Classes inheriting from this can use the dbus_annotations

1138

decorator to add annotations to methods or signals.

1139

"""

1140

1141

@staticmethod

1142

def _is_dbus_thing(thing):

1143

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

1144

1145

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

1146

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

1147

"""

1148

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

1149

False)

1150

1151

def _get_all_dbus_things(self, thing):

1152

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

1153

"""

1154

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

1155

athing.__get__(self))

1156

for cls in self.__class__.__mro__

1157

for name, athing in

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

621

class DBusObjectWithProperties(dbus.service.Object):

1224

622

"""A D-Bus object with properties.

1225

623

1226

624

Classes inheriting from this can use the dbus_service_property

1228

626

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

1229

627

"""

1230

628

629

@staticmethod

630

def _is_dbus_property(obj):

631

return getattr(obj, "_dbus_is_property", False)

632

633

def _get_all_dbus_properties(self):

634

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

635

"""

636

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

637

for cls in self.__class__.__mro__

638

for name, prop in

639

inspect.getmembers(cls, self._is_dbus_property))

640

1231

641

def _get_dbus_property(self, interface_name, property_name):

1232

642

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

1233

643

property with the specified name and interface.

1234

644

"""

1235

for cls in self.__class__.__mro__:

1236

for name, value in inspect.getmembers(

1237

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

645

for cls in self.__class__.__mro__:

646

for name, value in (inspect.getmembers

647

(cls, self._is_dbus_property)):

1238

648

if (value._dbus_name == property_name

1239

649

and value._dbus_interface == interface_name):

1240

650

return value.__get__(self)

1241

651

1242

652

# No such property

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

653

raise DBusPropertyNotFound(self.dbus_object_path + ":"

654

+ interface_name + "."

655

+ property_name)

656

657

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

1257

658

out_signature="v")

1258

659

def Get(self, interface_name, property_name):

1259

660

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

1277

678

# The byte_arrays option is not supported yet on

1278

679

# signatures other than "ay".

1279

680

if prop._dbus_signature != "ay":

1280

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

1281

"'ay' signature {!r}"

1282

.format(prop._dbus_signature))

1283

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

1284

for byte in value))

681

raise ValueError

682

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

683

for byte in value))

1285

684

prop(value)

1286

685

1287

@dbus.service.method(dbus.PROPERTIES_IFACE,

1288

in_signature="s",

686

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

1289

687

out_signature="a{sv}")

1290

688

def GetAll(self, interface_name):

1291

689

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

1293

691

1294

692

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

1295

693

"""

1296

properties = {}

1297

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

694

all = {}

695

for name, prop in self._get_all_dbus_properties():

1298

696

if (interface_name

1299

697

and interface_name != prop._dbus_interface):

1300

698

# Interface non-empty but did not match

1304

702

continue

1305

703

value = prop()

1306

704

if not hasattr(value, "variant_level"):

1307

properties[name] = value

705

all[name] = value

1308

706

continue

1309

properties[name] = type(value)(

1310

value, variant_level = value.variant_level + 1)

1311

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

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

707

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

708

value.variant_level+1)

709

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

1320

710

1321

711

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1322

712

out_signature="s",

1323

713

path_keyword='object_path',

1324

714

connection_keyword='connection')

1325

715

def Introspect(self, object_path, connection):

1326

"""Overloading of standard D-Bus method.

1327

1328

Inserts property tags and interface annotation tags.

716

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

1329

717

"""

1330

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1331

object_path,

1332

connection)

718

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

719

connection)

1333

720

try:

1334

721

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

1335

1336

722

def make_tag(document, name, prop):

1337

723

e = document.createElement("property")

1338

724

e.setAttribute("name", name)

1339

725

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

1340

726

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

1341

727

return e

1342

1343

728

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

1344

# Add property tags

1345

729

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

1346

730

for name, prop

1347

in self._get_all_dbus_things("property")

731

in self._get_all_dbus_properties()

1348

732

if prop._dbus_interface

1349

733

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

1350

734

if_tag.appendChild(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)

1367

735

# Add the names to the return values for the

1368

736

# "org.freedesktop.DBus.Properties" methods

1369

737

if (if_tag.getAttribute("name")

1384

752

except (AttributeError, xml.dom.DOMException,

1385

753

xml.parsers.expat.ExpatError) as error:

1386

754

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

1387

exc_info=error)

1388

return xmlstring

1389

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

755

error)

756

return xmlstring

757

758

759

def datetime_to_dbus (dt, variant_level=0):

1460

760

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

1461

761

if dt is None:

1462

762

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

1463

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

1464

1465

1466

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1467

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

1468

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

1469

interface names according to the "alt_interface_names" mapping.

1470

Usage:

1471

1472

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

1473

"net.example.AlternateInterface"})

1474

class SampleDBusObject(dbus.service.Object):

1475

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

1476

def SampleDBusMethod():

1477

pass

1478

1479

The above "SampleDBusMethod" on "SampleDBusObject" will be

1480

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

1481

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

1482

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

1483

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

1484

1485

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

1486

(from DBusObjectWithProperties) and interfaces (from the

1487

dbus_interface_annotations decorator).

763

return dbus.String(dt.isoformat(),

764

variant_level=variant_level)

765

766

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

767

.__metaclass__):

768

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

769

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

1488

770

"""

1489

1490

def wrapper(cls):

1491

for orig_interface_name, alt_interface_name in (

1492

alt_interface_names.items()):

1493

attr = {}

1494

interface_names = set()

1495

# Go though all attributes of the class

1496

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

771

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

772

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

773

# methods, signals, or properties in them

774

for base in (b for b in bases

775

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

776

# Go though all attributes of the base class

777

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

1497

778

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

1498

779

# with the wrong interface name

1499

780

if (not hasattr(attribute, "_dbus_interface")

1500

or not attribute._dbus_interface.startswith(

1501

orig_interface_name)):

781

or not attribute._dbus_interface

782

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

1502

783

continue

1503

784

# Create an alternate D-Bus interface name based on

1504

785

# the current name

1505

alt_interface = attribute._dbus_interface.replace(

1506

orig_interface_name, alt_interface_name)

1507

interface_names.add(alt_interface)

786

alt_interface = (attribute._dbus_interface

787

.replace("se.recompile.Mandos",

788

"se.bsnet.fukt.Mandos"))

1508

789

# Is this a D-Bus signal?

1509

790

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

1510

if sys.version_info.major == 2:

1511

# Extract the original non-method undecorated

1512

# function by black magic

1513

nonmethod_func = (dict(

791

# Extract the original non-method function by

792

# black magic

793

nonmethod_func = (dict(

1514

794

zip(attribute.func_code.co_freevars,

1515

attribute.__closure__))

1516

["func"].cell_contents)

1517

else:

1518

nonmethod_func = attribute

795

attribute.__closure__))["func"]

796

.cell_contents)

1519

797

# Create a new, but exactly alike, function

1520

798

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

1521

799

# with the alternate D-Bus interface name

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

1539

# Copy annotations, if any

1540

try:

1541

new_function._dbus_annotations = dict(

1542

attribute._dbus_annotations)

1543

except AttributeError:

1544

pass

800

new_function = (dbus.service.signal

801

(alt_interface,

802

attribute._dbus_signature)

803

(types.FunctionType(

804

nonmethod_func.func_code,

805

nonmethod_func.func_globals,

806

nonmethod_func.func_name,

807

nonmethod_func.func_defaults,

808

nonmethod_func.func_closure)))

1545

809

# Define a creator of a function to call both the

1546

# original and alternate functions, so both the

1547

# original and alternate signals gets sent when

1548

# the function is called

810

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

811

# signals gets sent when the function is called

1549

812

def fixscope(func1, func2):

1550

813

"""This function is a scope container to pass

1551

814

func1 and func2 to the "call_both" function

1552

815

outside of its arguments"""

1553

1554

@functools.wraps(func2)

1555

816

def call_both(*args, **kwargs):

1556

817

"""This function will emit two D-Bus

1557

818

signals by calling func1 and func2"""

1558

819

func1(*args, **kwargs)

1559

820

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

1565

821

return call_both

1566

822

# Create the "call_both" function and add it to

1567

823

# the class

1568

attr[attrname] = fixscope(attribute, new_function)

824

attr[attrname] = fixscope(attribute,

825

new_function)

1569

826

# Is this a D-Bus method?

1570

827

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

1571

828

# Create a new, but exactly alike, function

1572

829

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

1573

830

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

1574

831

# to the class.

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

1585

# Copy annotations, if any

1586

try:

1587

attr[attrname]._dbus_annotations = dict(

1588

attribute._dbus_annotations)

1589

except AttributeError:

1590

pass

832

attr[attrname] = (dbus.service.method

833

(alt_interface,

834

attribute._dbus_in_signature,

835

attribute._dbus_out_signature)

836

(types.FunctionType

837

(attribute.func_code,

838

attribute.func_globals,

839

attribute.func_name,

840

attribute.func_defaults,

841

attribute.func_closure)))

1591

842

# Is this a D-Bus property?

1592

843

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

1593

844

# Create a new, but exactly alike, function

1594

845

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

1595

846

# property with the alternate D-Bus interface

1596

847

# name. Add it to the class.

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

1608

# Copy annotations, if any

1609

try:

1610

attr[attrname]._dbus_annotations = dict(

1611

attribute._dbus_annotations)

1612

except AttributeError:

1613

pass

1614

# Is this a D-Bus interface?

1615

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

1616

# Create a new, but exactly alike, function

1617

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

1618

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

1619

# to the class.

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

1627

if deprecate:

1628

# Deprecate all alternate interfaces

1629

iname="_AlternateDBusNames_interface_annotation{}"

1630

for interface_name in interface_names:

1631

1632

@dbus_interface_annotations(interface_name)

1633

def func(self):

1634

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

1635

"true" }

1636

# Find an unused name

1637

for aname in (iname.format(i)

1638

for i in itertools.count()):

1639

if aname not in attr:

1640

attr[aname] = func

1641

break

1642

if interface_names:

1643

# Replace the class with a new subclass of it with

1644

# methods, signals, etc. as created above.

1645

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

1646

(cls, ), attr)

1647

return cls

1648

1649

return wrapper

1650

1651

1652

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

1653

"se.bsnet.fukt.Mandos"})

848

attr[attrname] = (dbus_service_property

849

(alt_interface,

850

attribute._dbus_signature,

851

attribute._dbus_access,

852

attribute

853

._dbus_get_args_options

854

["byte_arrays"])

855

(types.FunctionType

856

(attribute.func_code,

857

attribute.func_globals,

858

attribute.func_name,

859

attribute.func_defaults,

860

attribute.func_closure)))

861

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

862

1654

863

class ClientDBus(Client, DBusObjectWithProperties):

1655

864

"""A Client class using D-Bus

1656

865

1660

869

"""

1661

870

1662

871

runtime_expansions = (Client.runtime_expansions

1663

+ ("dbus_object_path", ))

1664

1665

_interface = "se.recompile.Mandos.Client"

872

+ ("dbus_object_path",))

1666

873

1667

874

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

1668

875

1669

876

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

877

self._approvals_pending = 0

1670

878

self.bus = bus

1671

879

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

1672

880

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

1673

881

# the D-Bus

1674

client_object_name = str(self.name).translate(

882

client_object_name = unicode(self.name).translate(

1675

883

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

1676

884

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

1677

self.dbus_object_path = dbus.ObjectPath(

1678

"/clients/" + client_object_name)

885

self.dbus_object_path = (dbus.ObjectPath

886

("/clients/" + client_object_name))

1679

887

DBusObjectWithProperties.__init__(self, self.bus,

1680

888

self.dbus_object_path)

1681

1682

def notifychangeproperty(transform_func, dbus_name,

1683

type_func=lambda x: x,

1684

variant_level=1,

1685

invalidate_only=False,

1686

_interface=_interface):

889

890

def notifychangeproperty(transform_func,

891

dbus_name, type_func=lambda x: x,

892

variant_level=1):

1687

893

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

1688

894

its changes to DBus.

1689

895

1690

896

transform_fun: Function that takes a value and a variant_level

1691

897

and transforms it to a D-Bus type.

1692

898

dbus_name: D-Bus name of the variable

1694

900

to the D-Bus. Default: no transform

1695

901

variant_level: D-Bus variant level. Default: 1

1696

902

"""

1697

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

1698

903

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

1699

904

def setter(self, value):

1700

905

if hasattr(self, "dbus_object_path"):

1701

906

if (not hasattr(self, attrname) or

1702

907

type_func(getattr(self, attrname, None))

1703

908

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

909

dbus_value = transform_func(type_func(value),

910

variant_level

911

=variant_level)

912

self.PropertyChanged(dbus.String(dbus_name),

913

dbus_value)

1719

914

setattr(self, attrname, value)

1720

915

1721

916

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

1722

917

918

1723

919

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1724

920

approvals_pending = notifychangeproperty(dbus.Boolean,

1725

921

"ApprovalPending",

1727

923

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

1728

924

last_enabled = notifychangeproperty(datetime_to_dbus,

1729

925

"LastEnabled")

1730

checker = notifychangeproperty(

1731

dbus.Boolean, "CheckerRunning",

1732

type_func = lambda checker: checker is not None)

926

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

927

type_func = lambda checker:

928

checker is not None)

1733

929

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1734

930

"LastCheckedOK")

1735

last_checker_status = notifychangeproperty(dbus.Int16,

1736

"LastCheckerStatus")

1737

931

last_approval_request = notifychangeproperty(

1738

932

datetime_to_dbus, "LastApprovalRequest")

1739

933

approved_by_default = notifychangeproperty(dbus.Boolean,

1740

934

"ApprovedByDefault")

1741

approval_delay = notifychangeproperty(

1742

dbus.UInt64, "ApprovalDelay",

1743

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

935

approval_delay = notifychangeproperty(dbus.UInt16,

936

"ApprovalDelay",

937

type_func =

938

_timedelta_to_milliseconds)

1744

939

approval_duration = notifychangeproperty(

1745

dbus.UInt64, "ApprovalDuration",

1746

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

940

dbus.UInt16, "ApprovalDuration",

941

type_func = _timedelta_to_milliseconds)

1747

942

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

1748

timeout = notifychangeproperty(

1749

dbus.UInt64, "Timeout",

1750

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

943

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

944

type_func =

945

_timedelta_to_milliseconds)

1751

946

extended_timeout = notifychangeproperty(

1752

dbus.UInt64, "ExtendedTimeout",

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)

947

dbus.UInt16, "ExtendedTimeout",

948

type_func = _timedelta_to_milliseconds)

949

interval = notifychangeproperty(dbus.UInt16,

950

"Interval",

951

type_func =

952

_timedelta_to_milliseconds)

1757

953

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

1758

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

1759

invalidate_only=True)

1760

954

1761

955

del notifychangeproperty

1762

956

1769

963

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

1770

964

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

1771

965

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:

966

def checker_callback(self, pid, condition, command,

967

*args, **kwargs):

968

self.checker_callback_tag = None

969

self.checker = None

970

if os.WIFEXITED(condition):

971

exitstatus = os.WEXITSTATUS(condition)

1779

972

# Emit D-Bus signal

1780

973

self.CheckerCompleted(dbus.Int16(exitstatus),

1781

# This is specific to GNU libC

1782

dbus.Int64(exitstatus << 8),

974

dbus.Int64(condition),

1783

975

dbus.String(command))

1784

976

else:

1785

977

# Emit D-Bus signal

1786

978

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

1787

dbus.Int64(

1788

# This is specific to GNU libC

1789

(exitstatus << 8)

1790

| self.last_checker_signal),

979

dbus.Int64(condition),

1791

980

dbus.String(command))

1792

return ret

981

982

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

983

*args, **kwargs)

1793

984

1794

985

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

1795

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

986

old_checker = self.checker

987

if self.checker is not None:

988

old_checker_pid = self.checker.pid

989

else:

990

old_checker_pid = None

1796

991

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

1797

992

# Only if new checker process was started

1798

993

if (self.checker is not None

1802

997

return r

1803

998

1804

999

def _reset_approved(self):

1805

self.approved = None

1000

self._approved = None

1806

1001

return False

1807

1002

1808

1003

def approve(self, value=True):

1809

self.approved = value

1810

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

1811

* 1000), self._reset_approved)

1812

1004

self.send_changedstate()

1005

self._approved = value

1006

gobject.timeout_add(_timedelta_to_milliseconds

1007

(self.approval_duration),

1008

self._reset_approved)

1009

1813

1010

1814

1011

## D-Bus methods, signals & properties

1815

1816

## Interfaces

1012

_interface = "se.recompile.Mandos.Client"

1817

1013

1818

1014

## Signals

1819

1015

1830

1026

pass

1831

1027

1832

1028

# PropertyChanged - signal

1833

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

1834

1029

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

1835

1030

def PropertyChanged(self, property, value):

1836

1031

"D-Bus signal"

1870

1065

self.checked_ok()

1871

1066

1872

1067

# Enable - method

1873

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

1874

1068

@dbus.service.method(_interface)

1875

1069

def Enable(self):

1876

1070

"D-Bus method"

1877

1071

self.enable()

1878

1072

1879

1073

# StartChecker - method

1880

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

1881

1074

@dbus.service.method(_interface)

1882

1075

def StartChecker(self):

1883

1076

"D-Bus method"

1884

1077

self.start_checker()

1885

1078

1886

1079

# Disable - method

1887

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

1888

1080

@dbus.service.method(_interface)

1889

1081

def Disable(self):

1890

1082

"D-Bus method"

1891

1083

self.disable()

1892

1084

1893

1085

# StopChecker - method

1894

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

1895

1086

@dbus.service.method(_interface)

1896

1087

def StopChecker(self):

1897

1088

self.stop_checker()

1904

1095

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

1905

1096

1906

1097

# ApprovedByDefault - property

1907

@dbus_service_property(_interface,

1908

signature="b",

1098

@dbus_service_property(_interface, signature="b",

1909

1099

access="readwrite")

1910

1100

def ApprovedByDefault_dbus_property(self, value=None):

1911

1101

if value is None: # get

1913

1103

self.approved_by_default = bool(value)

1914

1104

1915

1105

# ApprovalDelay - property

1916

@dbus_service_property(_interface,

1917

signature="t",

1106

@dbus_service_property(_interface, signature="t",

1918

1107

access="readwrite")

1919

1108

def ApprovalDelay_dbus_property(self, value=None):

1920

1109

if value is None: # get

1921

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

1922

* 1000)

1110

return dbus.UInt64(self.approval_delay_milliseconds())

1923

1111

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

1924

1112

1925

1113

# ApprovalDuration - property

1926

@dbus_service_property(_interface,

1927

signature="t",

1114

@dbus_service_property(_interface, signature="t",

1928

1115

access="readwrite")

1929

1116

def ApprovalDuration_dbus_property(self, value=None):

1930

1117

if value is None: # get

1931

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

1932

* 1000)

1118

return dbus.UInt64(_timedelta_to_milliseconds(

1119

self.approval_duration))

1933

1120

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

1934

1121

1935

1122

# Name - property

1936

@dbus_annotations(

1937

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

1938

1123

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

1939

1124

def Name_dbus_property(self):

1940

1125

return dbus.String(self.name)

1941

1126

1942

1127

# Fingerprint - property

1943

@dbus_annotations(

1944

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

1945

1128

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

1946

1129

def Fingerprint_dbus_property(self):

1947

1130

return dbus.String(self.fingerprint)

1948

1131

1949

1132

# Host - property

1950

@dbus_service_property(_interface,

1951

signature="s",

1133

@dbus_service_property(_interface, signature="s",

1952

1134

access="readwrite")

1953

1135

def Host_dbus_property(self, value=None):

1954

1136

if value is None: # get

1955

1137

return dbus.String(self.host)

1956

self.host = str(value)

1138

self.host = value

1957

1139

1958

1140

# Created - property

1959

@dbus_annotations(

1960

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

1961

1141

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

1962

1142

def Created_dbus_property(self):

1963

return datetime_to_dbus(self.created)

1143

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

1964

1144

1965

1145

# LastEnabled - property

1966

1146

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

1968

1148

return datetime_to_dbus(self.last_enabled)

1969

1149

1970

1150

# Enabled - property

1971

@dbus_service_property(_interface,

1972

signature="b",

1151

@dbus_service_property(_interface, signature="b",

1973

1152

access="readwrite")

1974

1153

def Enabled_dbus_property(self, value=None):

1975

1154

if value is None: # get

1980

1159

self.disable()

1981

1160

1982

1161

# LastCheckedOK - property

1983

@dbus_service_property(_interface,

1984

signature="s",

1162

@dbus_service_property(_interface, signature="s",

1985

1163

access="readwrite")

1986

1164

def LastCheckedOK_dbus_property(self, value=None):

1987

1165

if value is not None:

1989

1167

return

1990

1168

return datetime_to_dbus(self.last_checked_ok)

1991

1169

1992

# LastCheckerStatus - property

1993

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

1994

def LastCheckerStatus_dbus_property(self):

1995

return dbus.Int16(self.last_checker_status)

1996

1997

1170

# Expires - property

1998

1171

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

1999

1172

def Expires_dbus_property(self):

2005

1178

return datetime_to_dbus(self.last_approval_request)

2006

1179

2007

1180

# Timeout - property

2008

@dbus_service_property(_interface,

2009

signature="t",

1181

@dbus_service_property(_interface, signature="t",

2010

1182

access="readwrite")

2011

1183

def Timeout_dbus_property(self, value=None):

2012

1184

if value is None: # get

2013

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

2014

old_timeout = self.timeout

1185

return dbus.UInt64(self.timeout_milliseconds())

2015

1186

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

2016

# Reschedule disabling

2017

if self.enabled:

2018

now = datetime.datetime.utcnow()

2019

self.expires += self.timeout - old_timeout

2020

if self.expires <= now:

2021

# The timeout has passed

2022

self.disable()

2023

else:

2024

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

2025

is None):

2026

return

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)

1187

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

1188

return

1189

# Reschedule timeout

1190

gobject.source_remove(self.disable_initiator_tag)

1191

self.disable_initiator_tag = None

1192

self.expires = None

1193

time_to_die = _timedelta_to_milliseconds((self

1194

.last_checked_ok

1195

+ self.timeout)

1196

- datetime.datetime

1197

.utcnow())

1198

if time_to_die <= 0:

1199

# The timeout has passed

1200

self.disable()

1201

else:

1202

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

1203

+ datetime.timedelta(milliseconds =

1204

time_to_die))

1205

self.disable_initiator_tag = (gobject.timeout_add

1206

(time_to_die, self.disable))

2031

1207

2032

1208

# ExtendedTimeout - property

2033

@dbus_service_property(_interface,

2034

signature="t",

1209

@dbus_service_property(_interface, signature="t",

2035

1210

access="readwrite")

2036

1211

def ExtendedTimeout_dbus_property(self, value=None):

2037

1212

if value is None: # get

2038

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

2039

* 1000)

1213

return dbus.UInt64(self.extended_timeout_milliseconds())

2040

1214

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

2041

1215

2042

1216

# Interval - property

2043

@dbus_service_property(_interface,

2044

signature="t",

1217

@dbus_service_property(_interface, signature="t",

2045

1218

access="readwrite")

2046

1219

def Interval_dbus_property(self, value=None):

2047

1220

if value is None: # get

2048

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

1221

return dbus.UInt64(self.interval_milliseconds())

2049

1222

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

2050

1223

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

2051

1224

return

2052

if self.enabled:

2053

# Reschedule checker run

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

1225

# Reschedule checker run

1226

gobject.source_remove(self.checker_initiator_tag)

1227

self.checker_initiator_tag = (gobject.timeout_add

1228

(value, self.start_checker))

1229

self.start_checker() # Start one now, too

2058

1230

2059

1231

# Checker - property

2060

@dbus_service_property(_interface,

2061

signature="s",

1232

@dbus_service_property(_interface, signature="s",

2062

1233

access="readwrite")

2063

1234

def Checker_dbus_property(self, value=None):

2064

1235

if value is None: # get

2065

1236

return dbus.String(self.checker_command)

2066

self.checker_command = str(value)

1237

self.checker_command = value

2067

1238

2068

1239

# CheckerRunning - property

2069

@dbus_service_property(_interface,

2070

signature="b",

1240

@dbus_service_property(_interface, signature="b",

2071

1241

access="readwrite")

2072

1242

def CheckerRunning_dbus_property(self, value=None):

2073

1243

if value is None: # get

2078

1248

self.stop_checker()

2079

1249

2080

1250

# ObjectPath - property

2081

@dbus_annotations(

2082

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

2083

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

2084

1251

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

2085

1252

def ObjectPath_dbus_property(self):

2086

1253

return self.dbus_object_path # is already a dbus.ObjectPath

2087

1254

2088

1255

# Secret = property

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)

1256

@dbus_service_property(_interface, signature="ay",

1257

access="write", byte_arrays=True)

2096

1258

def Secret_dbus_property(self, value):

2097

self.secret = bytes(value)

1259

self.secret = str(value)

2098

1260

2099

1261

del _interface

2100

1262

2104

1266

self._pipe = child_pipe

2105

1267

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

2106

1268

if not self._pipe.recv():

2107

raise KeyError(fpr)

1269

raise KeyError()

2108

1270

2109

1271

def __getattribute__(self, name):

2110

if name == '_pipe':

1272

if(name == '_pipe'):

2111

1273

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

2112

1274

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

2113

1275

data = self._pipe.recv()

2114

1276

if data[0] == 'data':

2115

1277

return data[1]

2116

1278

if data[0] == 'function':

2117

2118

1279

def func(*args, **kwargs):

2119

1280

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

2120

1281

return self._pipe.recv()[1]

2121

2122

1282

return func

2123

1283

2124

1284

def __setattr__(self, name, value):

2125

if name == '_pipe':

1285

if(name == '_pipe'):

2126

1286

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

2127

1287

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

2128

1288

1289

class ClientDBusTransitional(ClientDBus):

1290

__metaclass__ = AlternateDBusNamesMetaclass

2129

1291

2130

1292

class ClientHandler(socketserver.BaseRequestHandler, object):

2131

1293

"""A class to handle client connections.

2136

1298

def handle(self):

2137

1299

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

2138

1300

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

2139

str(self.client_address))

1301

unicode(self.client_address))

2140

1302

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

2141

1303

self.server.child_pipe.fileno())

2142

1304

2143

session = gnutls.ClientSession(self.request)

1305

session = (gnutls.connection

1306

.ClientSession(self.request,

1307

gnutls.connection

1308

.X509Credentials()))

1309

1310

# Note: gnutls.connection.X509Credentials is really a

1311

# generic GnuTLS certificate credentials object so long as

1312

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

1313

# here despite using OpenPGP certificates.

2144

1314

2145

1315

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

2146

1316

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

2150

1320

priority = self.server.gnutls_priority

2151

1321

if priority is None:

2152

1322

priority = "NORMAL"

2153

gnutls.priority_set_direct(session._c_object, priority,

2154

None)

1323

(gnutls.library.functions

1324

.gnutls_priority_set_direct(session._c_object,

1325

priority, None))

2155

1326

2156

1327

# Start communication using the Mandos protocol

2157

1328

# Get protocol number

2159

1330

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

2160

1331

try:

2161

1332

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

2162

raise RuntimeError(line)

1333

raise RuntimeError

2163

1334

except (ValueError, IndexError, RuntimeError) as error:

2164

1335

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

2165

1336

return

2167

1338

# Start GnuTLS connection

2168

1339

try:

2169

1340

session.handshake()

2170

except gnutls.Error as error:

1341

except gnutls.errors.GNUTLSError as error:

2171

1342

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

2172

1343

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

2173

1344

# established. Just abandon the request.

2177

1348

approval_required = False

2178

1349

try:

2179

1350

try:

2180

fpr = self.fingerprint(

2181

self.peer_certificate(session))

2182

except (TypeError, gnutls.Error) as error:

1351

fpr = self.fingerprint(self.peer_certificate

1352

(session))

1353

except (TypeError,

1354

gnutls.errors.GNUTLSError) as error:

2183

1355

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

2184

1356

return

2185

1357

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

2198

1370

while True:

2199

1371

if not client.enabled:

2200

1372

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

2201

client.name)

1373

client.name)

2202

1374

if self.server.use_dbus:

2203

1375

# Emit D-Bus signal

2204

1376

client.Rejected("Disabled")

2205

1377

return

2206

1378

2207

if client.approved or not client.approval_delay:

1379

if client._approved or not client.approval_delay:

2208

1380

#We are approved or approval is disabled

2209

1381

break

2210

elif client.approved is None:

1382

elif client._approved is None:

2211

1383

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

2212

1384

client.name)

2213

1385

if self.server.use_dbus:

2214

1386

# Emit D-Bus signal

2215

1387

client.NeedApproval(

2216

client.approval_delay.total_seconds()

2217

* 1000, client.approved_by_default)

1388

client.approval_delay_milliseconds(),

1389

client.approved_by_default)

2218

1390

else:

2219

1391

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

2220

1392

client.name)

2226

1398

#wait until timeout or approved

2227

1399

time = datetime.datetime.now()

2228

1400

client.changedstate.acquire()

2229

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

1401

(client.changedstate.wait

1402

(float(client._timedelta_to_milliseconds(delay)

1403

/ 1000)))

2230

1404

client.changedstate.release()

2231

1405

time2 = datetime.datetime.now()

2232

1406

if (time2 - time) >= delay:

2243

1417

else:

2244

1418

delay -= time2 - time

2245

1419

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

1420

sent_size = 0

1421

while sent_size < len(client.secret):

1422

try:

1423

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

1424

except gnutls.errors.GNUTLSError as error:

1425

logger.warning("gnutls send failed")

1426

return

1427

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

1428

sent, len(client.secret)

1429

- (sent_size + sent))

1430

sent_size += sent

2252

1431

2253

1432

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

2254

1433

# bump the timeout using extended_timeout

2255

client.bump_timeout(client.extended_timeout)

1434

client.checked_ok(client.extended_timeout)

2256

1435

if self.server.use_dbus:

2257

1436

# Emit D-Bus signal

2258

1437

client.GotSecret()

2262

1441

client.approvals_pending -= 1

2263

1442

try:

2264

1443

session.bye()

2265

except gnutls.Error as error:

2266

logger.warning("GnuTLS bye failed",

2267

exc_info=error)

1444

except gnutls.errors.GNUTLSError as error:

1445

logger.warning("GnuTLS bye failed")

2268

1446

2269

1447

@staticmethod

2270

1448

def peer_certificate(session):

2271

1449

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

2272

1450

# If not an OpenPGP certificate...

2273

if (gnutls.certificate_type_get(session._c_object)

2274

!= gnutls.CRT_OPENPGP):

2275

# ...return invalid data

2276

return b""

1451

if (gnutls.library.functions

1452

.gnutls_certificate_type_get(session._c_object)

1453

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1454

# ...do the normal thing

1455

return session.peer_certificate

2277

1456

list_size = ctypes.c_uint(1)

2278

cert_list = (gnutls.certificate_get_peers

1457

cert_list = (gnutls.library.functions

1458

.gnutls_certificate_get_peers

2279

1459

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

2280

1460

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

2281

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

1461

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

1462

" certificate")

2282

1463

if list_size.value == 0:

2283

1464

return None

2284

1465

cert = cert_list[0]

2288

1469

def fingerprint(openpgp):

2289

1470

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2290

1471

# New GnuTLS "datum" with the OpenPGP public key

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

1472

datum = (gnutls.library.types

1473

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

1474

ctypes.POINTER

1475

(ctypes.c_ubyte)),

1476

ctypes.c_uint(len(openpgp))))

2295

1477

# New empty GnuTLS certificate

2296

crt = gnutls.openpgp_crt_t()

2297

gnutls.openpgp_crt_init(ctypes.byref(crt))

1478

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1479

(gnutls.library.functions

1480

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2298

1481

# Import the OpenPGP public key into the certificate

2299

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

2300

gnutls.OPENPGP_FMT_RAW)

1482

(gnutls.library.functions

1483

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

1484

gnutls.library.constants

1485

.GNUTLS_OPENPGP_FMT_RAW))

2301

1486

# Verify the self signature in the key

2302

1487

crtverify = ctypes.c_uint()

2303

gnutls.openpgp_crt_verify_self(crt, 0,

2304

ctypes.byref(crtverify))

1488

(gnutls.library.functions

1489

.gnutls_openpgp_crt_verify_self(crt, 0,

1490

ctypes.byref(crtverify)))

2305

1491

if crtverify.value != 0:

2306

gnutls.openpgp_crt_deinit(crt)

2307

raise gnutls.CertificateSecurityError("Verify failed")

1492

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1493

raise (gnutls.errors.CertificateSecurityError

1494

("Verify failed"))

2308

1495

# New buffer for the fingerprint

2309

1496

buf = ctypes.create_string_buffer(20)

2310

1497

buf_len = ctypes.c_size_t()

2311

1498

# Get the fingerprint from the certificate into the buffer

2312

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

2313

ctypes.byref(buf_len))

1499

(gnutls.library.functions

1500

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

1501

ctypes.byref(buf_len)))

2314

1502

# Deinit the certificate

2315

gnutls.openpgp_crt_deinit(crt)

1503

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2316

1504

# Convert the buffer to a Python bytestring

2317

1505

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

2318

1506

# Convert the bytestring to hexadecimal notation

2319

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

1507

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

2320

1508

return hex_fpr

2321

1509

2322

1510

2323

1511

class MultiprocessingMixIn(object):

2324

1512

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

2325

2326

1513

def sub_process_main(self, request, address):

2327

1514

try:

2328

1515

self.finish_request(request, address)

2329

except Exception:

1516

except:

2330

1517

self.handle_error(request, address)

2331

1518

self.close_request(request)

2332

1519

2333

1520

def process_request(self, request, address):

2334

1521

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

2335

1522

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

2336

args = (request, address))

1523

args = (request,

1524

address))

2337

1525

proc.start()

2338

1526

return proc

2339

1527

2340

1528

2341

1529

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2342

1530

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

2343

2344

1531

def process_request(self, request, client_address):

2345

1532

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

2346

1533

2355

1542

2356

1543

def add_pipe(self, parent_pipe, proc):

2357

1544

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

2358

raise NotImplementedError()

1545

raise NotImplementedError

2359

1546

2360

1547

2361

1548

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2367

1554

interface: None or a network interface name (string)

2368

1555

use_ipv6: Boolean; to use IPv6 or not

2369

1556

"""

2370

2371

1557

def __init__(self, server_address, RequestHandlerClass,

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

"""

1558

interface=None, use_ipv6=True):

2378

1559

self.interface = interface

2379

1560

if use_ipv6:

2380

1561

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.

2407

1562

socketserver.TCPServer.__init__(self, server_address,

2408

1563

RequestHandlerClass)

2409

2410

1564

def server_bind(self):

2411

1565

"""This overrides the normal server_bind() function

2412

1566

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

2418

1572

self.interface)

2419

1573

else:

2420

1574

try:

2421

self.socket.setsockopt(

2422

socket.SOL_SOCKET, SO_BINDTODEVICE,

2423

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

1575

self.socket.setsockopt(socket.SOL_SOCKET,

1576

SO_BINDTODEVICE,

1577

str(self.interface

1578

+ '\0'))

2424

1579

except socket.error as error:

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:

1580

if error[0] == errno.EPERM:

1581

logger.error("No permission to"

1582

" bind to interface %s",

1583

self.interface)

1584

elif error[0] == errno.ENOPROTOOPT:

2429

1585

logger.error("SO_BINDTODEVICE not available;"

2430

1586

" cannot bind to interface %s",

2431

1587

self.interface)

2432

elif error.errno == errno.ENODEV:

2433

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

2434

" cannot bind", self.interface)

2435

1588

else:

2436

1589

raise

2437

1590

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

2440

1593

if self.address_family == socket.AF_INET6:

2441

1594

any_address = "::" # in6addr_any

2442

1595

else:

2443

any_address = "0.0.0.0" # INADDR_ANY

1596

any_address = socket.INADDR_ANY

2444

1597

self.server_address = (any_address,

2445

1598

self.server_address[1])

2446

1599

elif not self.server_address[1]:

2447

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

1600

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

1601

0)

2448

1602

# if self.interface:

2449

1603

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

2450

1604

# 0, # port

2464

1618

2465

1619

Assumes a gobject.MainLoop event loop.

2466

1620

"""

2467

2468

1621

def __init__(self, server_address, RequestHandlerClass,

2469

interface=None,

2470

use_ipv6=True,

2471

clients=None,

2472

gnutls_priority=None,

2473

use_dbus=True,

2474

socketfd=None):

1622

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

1623

gnutls_priority=None, use_dbus=True):

2475

1624

self.enabled = False

2476

1625

self.clients = clients

2477

1626

if self.clients is None:

2478

self.clients = {}

1627

self.clients = set()

2479

1628

self.use_dbus = use_dbus

2480

1629

self.gnutls_priority = gnutls_priority

2481

1630

IPv6_TCPServer.__init__(self, server_address,

2482

1631

RequestHandlerClass,

2483

1632

interface = interface,

2484

use_ipv6 = use_ipv6,

2485

socketfd = socketfd)

2486

1633

use_ipv6 = use_ipv6)

2487

1634

def server_activate(self):

2488

1635

if self.enabled:

2489

1636

return socketserver.TCPServer.server_activate(self)

2493

1640

2494

1641

def add_pipe(self, parent_pipe, proc):

2495

1642

# Call "handle_ipc" for both data and EOF events

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

1643

gobject.io_add_watch(parent_pipe.fileno(),

1644

gobject.IO_IN | gobject.IO_HUP,

1645

functools.partial(self.handle_ipc,

1646

parent_pipe =

1647

parent_pipe,

1648

proc = proc))

2502

1649

2503

def handle_ipc(self, source, condition,

2504

parent_pipe=None,

2505

proc = None,

2506

client_object=None):

1650

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

1651

proc = None, client_object=None):

1652

condition_names = {

1653

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

1654

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

1655

# blocking).

1656

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

1657

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

1658

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

1659

# broken, usually for pipes and

1660

# sockets).

1661

}

1662

conditions_string = ' | '.join(name

1663

for cond, name in

1664

condition_names.iteritems()

1665

if cond & condition)

2507

1666

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

2508

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

1667

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

2509

1668

# Wait for other process to exit

2510

1669

proc.join()

2511

1670

return False

2518

1677

fpr = request[1]

2519

1678

address = request[2]

2520

1679

2521

for c in self.clients.itervalues():

1680

for c in self.clients:

2522

1681

if c.fingerprint == fpr:

2523

1682

client = c

2524

1683

break

2532

1691

parent_pipe.send(False)

2533

1692

return False

2534

1693

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

1694

gobject.io_add_watch(parent_pipe.fileno(),

1695

gobject.IO_IN | gobject.IO_HUP,

1696

functools.partial(self.handle_ipc,

1697

parent_pipe =

1698

parent_pipe,

1699

proc = proc,

1700

client_object =

1701

client))

2542

1702

parent_pipe.send(True)

2543

1703

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

2544

1704

# same fileno

2550

1710

2551

1711

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

2552

1712

funcname)(*args,

2553

**kwargs)))

1713

**kwargs)))

2554

1714

2555

1715

if command == 'getattr':

2556

1716

attrname = request[1]

2557

if isinstance(client_object.__getattribute__(attrname),

2558

collections.Callable):

2559

parent_pipe.send(('function', ))

1717

if callable(client_object.__getattribute__(attrname)):

1718

parent_pipe.send(('function',))

2560

1719

else:

2561

parent_pipe.send((

2562

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

1720

parent_pipe.send(('data', client_object

1721

.__getattribute__(attrname)))

2563

1722

2564

1723

if command == 'setattr':

2565

1724

attrname = request[1]

2569

1728

return True

2570

1729

2571

1730

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

2668

1731

def string_to_delta(interval):

2669

1732

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

2670

1733

2681

1744

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

2682

1745

datetime.timedelta(0, 330)

2683

1746

"""

2684

2685

try:

2686

return rfc3339_duration_to_delta(interval)

2687

except ValueError:

2688

pass

2689

2690

1747

timevalue = datetime.timedelta(0)

2691

1748

for s in interval.split():

2692

1749

try:

2693

suffix = s[-1]

1750

suffix = unicode(s[-1])

2694

1751

value = int(s[:-1])

2695

1752

if suffix == "d":

2696

1753

delta = datetime.timedelta(value)

2703

1760

elif suffix == "w":

2704

1761

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

2705

1762

else:

2706

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

2707

except IndexError as e:

1763

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

1764

except (ValueError, IndexError) as e:

2708

1765

raise ValueError(*(e.args))

2709

1766

timevalue += delta

2710

1767

return timevalue

2711

1768

2712

1769

1770

def if_nametoindex(interface):

1771

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

1772

1773

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

1774

global if_nametoindex

1775

try:

1776

if_nametoindex = (ctypes.cdll.LoadLibrary

1777

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

1778

.if_nametoindex)

1779

except (OSError, AttributeError):

1780

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

1781

def if_nametoindex(interface):

1782

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

1783

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

1784

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

1785

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1786

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

1787

interface))

1788

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

1789

ifreq[16:20])[0]

1790

return interface_index

1791

return if_nametoindex(interface)

1792

1793

2713

1794

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

2714

1795

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

2715

1796

2723

1804

sys.exit()

2724

1805

if not noclose:

2725

1806

# Close all standard open file descriptors

2726

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

1807

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

2727

1808

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

2728

1809

raise OSError(errno.ENODEV,

2729

"{} not a character device"

2730

.format(os.devnull))

1810

"%s not a character device"

1811

% os.path.devnull)

2731

1812

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

2732

1813

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

2733

1814

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

2742

1823

2743

1824

parser = argparse.ArgumentParser()

2744

1825

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

2745

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

1826

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

2746

1827

help="show version number and exit")

2747

1828

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

2748

1829

help="Bind to interface IF")

2754

1835

help="Run self-test")

2755

1836

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

2756

1837

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

2757

" to terminal", default=None)

1838

" to terminal")

2758

1839

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

2759

1840

help="Debug level for stdout output")

2760

1841

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

2767

1848

" files")

2768

1849

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

2769

1850

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

2770

" system bus interface", default=None)

1851

" system bus interface")

2771

1852

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

2772

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

2773

default=None)

2774

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

2775

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

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

2780

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

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)

2787

1853

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

2788

1854

options = parser.parse_args()

2789

1855

2790

1856

if options.check:

2791

1857

import doctest

2792

fail_count, test_count = doctest.testmod()

2793

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

1858

doctest.testmod()

1859

sys.exit()

2794

1860

2795

1861

# Default values for config file for server-global settings

2796

1862

server_defaults = { "interface": "",

2798

1864

"port": "",

2799

1865

"debug": "False",

2800

1866

"priority":

2801

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

2802

":+SIGN-DSA-SHA256",

1867

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

2803

1868

"servicename": "Mandos",

2804

1869

"use_dbus": "True",

2805

1870

"use_ipv6": "True",

2806

1871

"debuglevel": "",

2807

"restore": "True",

2808

"socket": "",

2809

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

2810

"foreground": "False",

2811

"zeroconf": "True",

2812

}

1872

}

2813

1873

2814

1874

# Parse config file for server-global settings

2815

1875

server_config = configparser.SafeConfigParser(server_defaults)

2816

1876

del server_defaults

2817

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

1877

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

1878

"mandos.conf"))

2818

1879

# Convert the SafeConfigParser object to a dict

2819

1880

server_settings = server_config.defaults()

2820

1881

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

2821

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

1882

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

2822

1883

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

2823

1884

option)

2824

1885

if server_settings["port"]:

2825

1886

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

2826

1887

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

2836

1888

del server_config

2837

1889

2838

1890

# Override the settings from the config file with command line

2839

1891

# options, if set.

2840

1892

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

2841

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

2842

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

2843

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

1893

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

1894

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

2844

1895

value = getattr(options, option)

2845

1896

if value is not None:

2846

1897

server_settings[option] = value

2847

1898

del options

2848

1899

# Force all strings to be unicode

2849

1900

for option in server_settings.keys():

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

1901

if type(server_settings[option]) is str:

1902

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

2860

1903

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

2861

1904

2862

1905

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

2863

1906

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

2869

1907

# For convenience

2870

1908

debug = server_settings["debug"]

2871

1909

debuglevel = server_settings["debuglevel"]

2872

1910

use_dbus = server_settings["use_dbus"]

2873

1911

use_ipv6 = server_settings["use_ipv6"]

2874

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

2875

stored_state_file)

2876

foreground = server_settings["foreground"]

2877

zeroconf = server_settings["zeroconf"]

2878

2879

if debug:

2880

initlogger(debug, logging.DEBUG)

2881

else:

2882

if not debuglevel:

2883

initlogger(debug)

2884

else:

2885

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

2886

initlogger(debug, level)

2887

1912

2888

1913

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

2889

syslogger.setFormatter(

2890

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

2891

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

2892

server_settings["servicename"])))

1914

syslogger.setFormatter(logging.Formatter

1915

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

1916

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

1917

% server_settings["servicename"]))

2893

1918

2894

1919

# Parse config file with clients

2895

client_config = configparser.SafeConfigParser(Client

2896

.client_defaults)

1920

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

1921

"extended_timeout": "15m",

1922

"interval": "2m",

1923

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

1924

"host": "",

1925

"approval_delay": "0s",

1926

"approval_duration": "1s",

1927

}

1928

client_config = configparser.SafeConfigParser(client_defaults)

2897

1929

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

2898

1930

"clients.conf"))

2899

1931

2900

1932

global mandos_dbus_service

2901

1933

mandos_dbus_service = None

2902

1934

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

1935

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

1936

server_settings["port"]),

1937

ClientHandler,

1938

interface=(server_settings["interface"]

1939

or None),

1940

use_ipv6=use_ipv6,

1941

gnutls_priority=

1942

server_settings["priority"],

1943

use_dbus=use_dbus)

1944

if not debug:

1945

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

2919

1946

try:

2920

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

2921

except IOError as e:

2922

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

2923

exc_info=e)

1947

pidfile = open(pidfilename, "w")

1948

except IOError:

1949

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

2924

1950

2925

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

1951

try:

1952

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

1953

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

1954

except KeyError:

2926

1955

try:

2927

uid = pwd.getpwnam(name).pw_uid

2928

gid = pwd.getpwnam(name).pw_gid

2929

break

1956

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

1957

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

2930

1958

except KeyError:

2931

continue

2932

else:

2933

uid = 65534

2934

gid = 65534

1959

try:

1960

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

1961

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

1962

except KeyError:

1963

uid = 65534

1964

gid = 65534

2935

1965

try:

2936

1966

os.setgid(gid)

2937

1967

os.setuid(uid)

2938

1968

except OSError as error:

2939

if error.errno != errno.EPERM:

2940

raise

1969

if error[0] != errno.EPERM:

1970

raise error

1971

1972

if not debug and not debuglevel:

1973

syslogger.setLevel(logging.WARNING)

1974

console.setLevel(logging.WARNING)

1975

if debuglevel:

1976

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

1977

syslogger.setLevel(level)

1978

console.setLevel(level)

2941

1979

2942

1980

if debug:

2943

1981

# Enable all possible GnuTLS debugging

2944

1982

2945

1983

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

2946

1984

# - GnuTLS manual

2947

gnutls.global_set_log_level(11)

1985

gnutls.library.functions.gnutls_global_set_log_level(11)

2948

1986

2949

@gnutls.log_func

1987

@gnutls.library.types.gnutls_log_func

2950

1988

def debug_gnutls(level, string):

2951

1989

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

2952

1990

2953

gnutls.global_set_log_function(debug_gnutls)

1991

(gnutls.library.functions

1992

.gnutls_global_set_log_function(debug_gnutls))

2954

1993

2955

1994

# Redirect stdin so all checkers get /dev/null

2956

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

1995

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

2957

1996

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

2958

1997

if null > 2:

2959

1998

os.close(null)

1999

else:

2000

# No console logging

2001

logger.removeHandler(console)

2960

2002

2961

2003

# Need to fork before connecting to D-Bus

2962

if not foreground:

2004

if not debug:

2963

2005

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

2964

2006

daemon()

2965

2007

2966

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

2967

# need to inform gobject that threads will be used.

2968

gobject.threads_init()

2969

2970

2008

global main_loop

2971

2009

# From the Avahi example code

2972

DBusGMainLoop(set_as_default=True)

2010

DBusGMainLoop(set_as_default=True )

2973

2011

main_loop = gobject.MainLoop()

2974

2012

bus = dbus.SystemBus()

2975

2013

# End of Avahi example code

2976

2014

if use_dbus:

2977

2015

try:

2978

2016

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

2979

bus,

2980

do_not_queue=True)

2981

old_bus_name = dbus.service.BusName(

2982

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

2983

do_not_queue=True)

2984

except dbus.exceptions.DBusException as e:

2985

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

2017

bus, do_not_queue=True)

2018

old_bus_name = (dbus.service.BusName

2019

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

2020

do_not_queue=True))

2021

except dbus.exceptions.NameExistsException as e:

2022

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

2986

2023

use_dbus = False

2987

2024

server_settings["use_dbus"] = False

2988

2025

tcp_server.use_dbus = False

2989

if zeroconf:

2990

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2991

service = AvahiServiceToSyslog(

2992

name = server_settings["servicename"],

2993

servicetype = "_mandos._tcp",

2994

protocol = protocol,

2995

bus = bus)

2996

if server_settings["interface"]:

2997

service.interface = if_nametoindex(

2998

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

2026

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2027

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

2028

servicetype = "_mandos._tcp",

2029

protocol = protocol, bus = bus)

2030

if server_settings["interface"]:

2031

service.interface = (if_nametoindex

2032

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

2999

2033

3000

2034

global multiprocessing_manager

3001

2035

multiprocessing_manager = multiprocessing.Manager()

3002

2036

3003

2037

client_class = Client

3004

2038

if use_dbus:

3005

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

3006

3007

client_settings = Client.config_parser(client_config)

3008

old_client_settings = {}

3009

clients_data = {}

3010

3011

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

3012

global wnull

3013

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

3014

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

3015

# mode

3016

if debug or not foreground:

3017

wnull.close()

3018

3019

# Get client data and settings from last running state.

3020

if server_settings["restore"]:

3021

try:

3022

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

3023

clients_data, old_client_settings = pickle.load(

3024

stored_state)

3025

os.remove(stored_state_path)

3026

except IOError as e:

3027

if e.errno == errno.ENOENT:

3028

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

3029

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

3030

else:

3031

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

3032

exc_info=e)

3033

raise

3034

except EOFError as e:

3035

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

3036

"EOFError:",

3037

exc_info=e)

3038

3039

with PGPEngine() as pgp:

3040

for client_name, client in clients_data.items():

3041

# Skip removed clients

3042

if client_name not in client_settings:

3043

continue

3044

3045

# Decide which value to use after restoring saved state.

3046

# We have three different values: Old config file,

3047

# new config file, and saved state.

3048

# New config value takes precedence if it differs from old

3049

# config value, otherwise use saved state.

3050

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

3051

try:

3052

# For each value in new config, check if it

3053

# differs from the old config value (Except for

3054

# the "secret" attribute)

3055

if (name != "secret"

3056

and (value !=

3057

old_client_settings[client_name][name])):

3058

client[name] = value

3059

except KeyError:

3060

pass

3061

3062

# Clients who has passed its expire date can still be

3063

# enabled if its last checker was successful. A Client

3064

# whose checker succeeded before we stored its state is

3065

# assumed to have successfully run all checkers during

3066

# downtime.

3067

if client["enabled"]:

3068

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

3069

if not client["last_checked_ok"]:

3070

logger.warning(

3071

"disabling client {} - Client never "

3072

"performed a successful checker".format(

3073

client_name))

3074

client["enabled"] = False

3075

elif client["last_checker_status"] != 0:

3076

logger.warning(

3077

"disabling client {} - Client last"

3078

" checker failed with error code"

3079

" {}".format(

3080

client_name,

3081

client["last_checker_status"]))

3082

client["enabled"] = False

3083

else:

3084

client["expires"] = (

3085

datetime.datetime.utcnow()

3086

+ client["timeout"])

3087

logger.debug("Last checker succeeded,"

3088

" keeping {} enabled".format(

3089

client_name))

2039

client_class = functools.partial(ClientDBusTransitional,

2040

bus = bus)

2041

def client_config_items(config, section):

2042

special_settings = {

2043

"approved_by_default":

2044

lambda: config.getboolean(section,

2045

"approved_by_default"),

2046

}

2047

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

3090

2048

try:

3091

client["secret"] = pgp.decrypt(

3092

client["encrypted_secret"],

3093

client_settings[client_name]["secret"])

3094

except PGPError:

3095

# If decryption fails, we use secret from new settings

3096

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

3097

client_name))

3098

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

3099

["secret"])

3100

3101

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

3102

for client_name in (set(old_client_settings)

3103

- set(client_settings)):

3104

del clients_data[client_name]

3105

for client_name in (set(client_settings)

3106

- set(old_client_settings)):

3107

clients_data[client_name] = client_settings[client_name]

3108

3109

# Create all client objects

3110

for client_name, client in clients_data.items():

3111

tcp_server.clients[client_name] = client_class(

3112

name = client_name,

3113

settings = client,

3114

server_settings = server_settings)

3115

2049

yield (name, special_settings[name]())

2050

except KeyError:

2051

yield (name, value)

2052

2053

tcp_server.clients.update(set(

2054

client_class(name = section,

2055

config= dict(client_config_items(

2056

client_config, section)))

2057

for section in client_config.sections()))

3116

2058

if not tcp_server.clients:

3117

2059

logger.warning("No clients defined")

3118

3119

if not foreground:

3120

if pidfile is not None:

3121

pid = os.getpid()

3122

try:

3123

with pidfile:

3124

print(pid, file=pidfile)

3125

except IOError:

3126

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

3127

pidfilename, pid)

3128

del pidfile

2060

2061

if not debug:

2062

try:

2063

with pidfile:

2064

pid = os.getpid()

2065

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

2066

del pidfile

2067

except IOError:

2068

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

2069

pidfilename, pid)

2070

except NameError:

2071

# "pidfile" was never created

2072

pass

3129

2073

del pidfilename

2074

2075

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

3130

2076

3131

2077

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

3132

2078

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

3133

2079

3134

2080

if use_dbus:

3135

3136

@alternate_dbus_interfaces(

3137

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

3138

class MandosDBusService(DBusObjectWithObjectManager):

2081

class MandosDBusService(dbus.service.Object):

3139

2082

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

3140

3141

2083

def __init__(self):

3142

2084

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

3143

3144

2085

_interface = "se.recompile.Mandos"

3145

2086

3146

2087

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

3153

2094

"D-Bus signal"

3154

2095

pass

3155

2096

3156

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

3157

"true"})

3158

2097

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

3159

2098

def ClientRemoved(self, objpath, name):

3160

2099

"D-Bus signal"

3161

2100

pass

3162

2101

3163

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

3164

"true"})

3165

2102

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

3166

2103

def GetAllClients(self):

3167

2104

"D-Bus method"

3168

return dbus.Array(c.dbus_object_path for c in

3169

tcp_server.clients.itervalues())

2105

return dbus.Array(c.dbus_object_path

2106

for c in tcp_server.clients)

3170

2107

3171

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

3172

"true"})

3173

2108

@dbus.service.method(_interface,

3174

2109

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

3175

2110

def GetAllClientsWithProperties(self):

3176

2111

"D-Bus method"

3177

2112

return dbus.Dictionary(

3178

{ c.dbus_object_path: c.GetAll(

3179

"se.recompile.Mandos.Client")

3180

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

2113

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

2114

for c in tcp_server.clients),

3181

2115

signature="oa{sv}")

3182

2116

3183

2117

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

3184

2118

def RemoveClient(self, object_path):

3185

2119

"D-Bus method"

3186

for c in tcp_server.clients.itervalues():

2120

for c in tcp_server.clients:

3187

2121

if c.dbus_object_path == object_path:

3188

del tcp_server.clients[c.name]

2122

tcp_server.clients.remove(c)

3189

2123

c.remove_from_connection()

3190

# Don't signal the disabling

2124

# Don't signal anything except ClientRemoved

3191

2125

c.disable(quiet=True)

3192

# Emit D-Bus signal for removal

3193

self.client_removed_signal(c)

2126

# Emit D-Bus signal

2127

self.ClientRemoved(object_path, c.name)

3194

2128

return

3195

2129

raise KeyError(object_path)

3196

2130

3197

2131

del _interface

3198

3199

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3200

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

3201

def GetManagedObjects(self):

3202

"""D-Bus method"""

3203

return dbus.Dictionary(

3204

{ client.dbus_object_path:

3205

dbus.Dictionary(

3206

{ interface: client.GetAll(interface)

3207

for interface in

3208

client._get_all_interface_names()})

3209

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

3210

3211

def client_added_signal(self, client):

3212

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

3213

if use_dbus:

3214

# New standard signal

3215

self.InterfacesAdded(

3216

client.dbus_object_path,

3217

dbus.Dictionary(

3218

{ interface: client.GetAll(interface)

3219

for interface in

3220

client._get_all_interface_names()}))

3221

# Old signal

3222

self.ClientAdded(client.dbus_object_path)

3223

3224

def client_removed_signal(self, client):

3225

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

3226

if use_dbus:

3227

# New standard signal

3228

self.InterfacesRemoved(

3229

client.dbus_object_path,

3230

client._get_all_interface_names())

3231

# Old signal

3232

self.ClientRemoved(client.dbus_object_path,

3233

client.name)

3234

2132

3235

mandos_dbus_service = MandosDBusService()

2133

class MandosDBusServiceTransitional(MandosDBusService):

2134

__metaclass__ = AlternateDBusNamesMetaclass

2135

mandos_dbus_service = MandosDBusServiceTransitional()

3236

2136

3237

2137

def cleanup():

3238

2138

"Cleanup function; run on exit"

3239

if zeroconf:

3240

service.cleanup()

2139

service.cleanup()

3241

2140

3242

2141

multiprocessing.active_children()

3243

wnull.close()

3244

if not (tcp_server.clients or client_settings):

3245

return

3246

3247

# Store client before exiting. Secrets are encrypted with key

3248

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

3249

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

3250

clients = {}

3251

with PGPEngine() as pgp:

3252

for client in tcp_server.clients.itervalues():

3253

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

3254

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

3255

key)

3256

client_dict = {}

3257

3258

# A list of attributes that can not be pickled

3259

# + secret.

3260

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

3261

"checker", "server_settings" }

3262

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

3263

.Object):

3264

exclude.add(name)

3265

3266

client_dict["encrypted_secret"] = (client

3267

.encrypted_secret)

3268

for attr in client.client_structure:

3269

if attr not in exclude:

3270

client_dict[attr] = getattr(client, attr)

3271

3272

clients[client.name] = client_dict

3273

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

3274

3275

try:

3276

with tempfile.NamedTemporaryFile(

3277

mode='wb',

3278

suffix=".pickle",

3279

prefix='clients-',

3280

dir=os.path.dirname(stored_state_path),

3281

delete=False) as stored_state:

3282

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

3283

tempname = stored_state.name

3284

os.rename(tempname, stored_state_path)

3285

except (IOError, OSError) as e:

3286

if not debug:

3287

try:

3288

os.remove(tempname)

3289

except NameError:

3290

pass

3291

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

3292

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

3293

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

3294

else:

3295

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

3296

exc_info=e)

3297

raise

3298

3299

# Delete all clients, and settings from config

3300

2142

while tcp_server.clients:

3301

name, client = tcp_server.clients.popitem()

2143

client = tcp_server.clients.pop()

3302

2144

if use_dbus:

3303

2145

client.remove_from_connection()

3304

# Don't signal the disabling

2146

client.disable_hook = None

2147

# Don't signal anything except ClientRemoved

3305

2148

client.disable(quiet=True)

3306

# Emit D-Bus signal for removal

3307

2149

if use_dbus:

3308

mandos_dbus_service.client_removed_signal(client)

3309

client_settings.clear()

2150

# Emit D-Bus signal

2151

mandos_dbus_service.ClientRemoved(client

2152

.dbus_object_path,

2153

client.name)

3310

2154

3311

2155

atexit.register(cleanup)

3312

2156

3313

for client in tcp_server.clients.itervalues():

2157

for client in tcp_server.clients:

3314

2158

if use_dbus:

3315

# Emit D-Bus signal for adding

3316

mandos_dbus_service.client_added_signal(client)

3317

# Need to initiate checking of clients

3318

if client.enabled:

3319

client.init_checker()

2159

# Emit D-Bus signal

2160

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2161

client.enable()

3320

2162

3321

2163

tcp_server.enable()

3322

2164

tcp_server.server_activate()

3323

2165

3324

2166

# Find out what port we got

3325

if zeroconf:

3326

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

2167

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

3327

2168

if use_ipv6:

3328

2169

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

3329

" flowinfo %d, scope_id %d",

3330

*tcp_server.socket.getsockname())

2170

" flowinfo %d, scope_id %d"

2171

% tcp_server.socket.getsockname())

3331

2172

else: # IPv4

3332

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

3333

*tcp_server.socket.getsockname())

2173

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

2174

% tcp_server.socket.getsockname())

3334

2175

3335

2176

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

3336

2177

3337

2178

try:

3338

if zeroconf:

3339

# From the Avahi example code

3340

try:

3341

service.activate()

3342

except dbus.exceptions.DBusException as error:

3343

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

3344

cleanup()

3345

sys.exit(1)

3346

# End of Avahi example code

2179

# From the Avahi example code

2180

try:

2181

service.activate()

2182

except dbus.exceptions.DBusException as error:

2183

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

2184

cleanup()

2185

sys.exit(1)

2186

# End of Avahi example code

3347

2187

3348

2188

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

3349

2189

lambda *args, **kwargs:

3353

2193

logger.debug("Starting main loop")

3354

2194

main_loop.run()

3355

2195

except AvahiError as error:

3356

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

2196

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

3357

2197

cleanup()

3358

2198

sys.exit(1)

3359

2199

except KeyboardInterrupt: