/mandos/release : revision 237.7.350

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

38

43

import socket

39

44

import argparse

40

45

import datetime

41

46

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

49

51

import sys

50

52

import re

51

53

import os

60

62

import struct

61

63

import fcntl

62

64

import functools

63

import cPickle as pickle

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

64

69

import multiprocessing

65

70

import types

71

import binascii

72

import tempfile

73

import itertools

74

import collections

75

import codecs

66

76

67

77

import dbus

68

78

import dbus.service

69

import gobject

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

70

83

import avahi

71

84

from dbus.mainloop.glib import DBusGMainLoop

72

85

import ctypes

82

95

except ImportError:

83

96

SO_BINDTODEVICE = None

84

97

85

86

version = "1.4.0"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

90

syslogger = (logging.handlers.SysLogHandler

91

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.1"

102

stored_state_file = "clients.pickle"

103

104

logger = logging.getLogger()

105

syslogger = None

106

107

try:

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

110

except (OSError, AttributeError):

111

112

def if_nametoindex(interface):

113

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

114

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

115

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

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

117

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

118

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

119

return interface_index

120

121

122

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

123

"""init logger and add loglevel"""

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

129

syslogger.setFormatter(logging.Formatter

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

134

if debug:

135

console = logging.StreamHandler()

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

141

logger.setLevel(level)

142

143

144

class PGPError(Exception):

145

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

146

pass

147

148

149

class PGPEngine(object):

150

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

151

152

def __init__(self):

153

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

154

self.gnupgargs = ['--batch',

155

'--home', self.tempdir,

156

'--force-mdc',

157

'--quiet',

158

'--no-use-agent']

159

160

def __enter__(self):

161

return self

162

163

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

164

self._cleanup()

165

return False

166

167

def __del__(self):

168

self._cleanup()

169

170

def _cleanup(self):

171

if self.tempdir is not None:

172

# Delete contents of tempdir

173

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

174

topdown = False):

175

for filename in files:

176

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

177

for dirname in dirs:

178

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

179

# Remove tempdir

180

os.rmdir(self.tempdir)

181

self.tempdir = None

182

183

def password_encode(self, password):

184

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

185

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

186

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

187

if len(encoded) > 2048:

188

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

189

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

190

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

191

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

192

return encoded

193

194

def encrypt(self, data, password):

195

passphrase = self.password_encode(password)

196

with tempfile.NamedTemporaryFile(

197

dir=self.tempdir) as passfile:

198

passfile.write(passphrase)

199

passfile.flush()

200

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

201

'--passphrase-file',

202

passfile.name]

203

+ self.gnupgargs,

204

stdin = subprocess.PIPE,

205

stdout = subprocess.PIPE,

206

stderr = subprocess.PIPE)

207

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

208

if proc.returncode != 0:

209

raise PGPError(err)

210

return ciphertext

211

212

def decrypt(self, data, password):

213

passphrase = self.password_encode(password)

214

with tempfile.NamedTemporaryFile(

215

dir = self.tempdir) as passfile:

216

passfile.write(passphrase)

217

passfile.flush()

218

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

219

'--passphrase-file',

220

passfile.name]

221

+ self.gnupgargs,

222

stdin = subprocess.PIPE,

223

stdout = subprocess.PIPE,

224

stderr = subprocess.PIPE)

225

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

226

if proc.returncode != 0:

227

raise PGPError(err)

228

return decrypted_plaintext

229

103

230

104

231

class AvahiError(Exception):

105

232

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

106

233

self.value = value

107

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

108

def __unicode__(self):

109

return unicode(repr(self.value))

234

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

235

**kwargs)

236

110

237

111

238

class AvahiServiceError(AvahiError):

112

239

pass

113

240

241

114

242

class AvahiGroupError(AvahiError):

115

243

pass

116

244

123

251

Used to optionally bind to the specified interface.

124

252

name: string; Example: 'Mandos'

125

253

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

126

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

254

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

127

255

port: integer; what port to announce

128

256

TXT: list of strings; TXT record for the service

129

257

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

135

263

server: D-Bus Server

136

264

bus: dbus.SystemBus()

137

265

"""

138

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

139

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

140

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

141

protocol = avahi.PROTO_UNSPEC, bus = None):

266

267

def __init__(self,

268

interface = avahi.IF_UNSPEC,

269

name = None,

270

servicetype = None,

271

port = None,

272

TXT = None,

273

domain = "",

274

host = "",

275

max_renames = 32768,

276

protocol = avahi.PROTO_UNSPEC,

277

bus = None):

142

278

self.interface = interface

143

279

self.name = name

144

280

self.type = servicetype

153

289

self.server = None

154

290

self.bus = bus

155

291

self.entry_group_state_changed_match = None

156

def rename(self):

292

293

def rename(self, remove=True):

157

294

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

158

295

if self.rename_count >= self.max_renames:

159

296

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

160

297

" after %i retries, exiting.",

161

298

self.rename_count)

162

299

raise AvahiServiceError("Too many renames")

163

self.name = unicode(self.server

164

.GetAlternativeServiceName(self.name))

300

self.name = str(

301

self.server.GetAlternativeServiceName(self.name))

302

self.rename_count += 1

165

303

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

166

304

self.name)

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

self.remove()

305

if remove:

306

self.remove()

172

307

try:

173

308

self.add()

174

309

except dbus.exceptions.DBusException as error:

175

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

176

self.cleanup()

177

os._exit(1)

178

self.rename_count += 1

310

if (error.get_dbus_name()

311

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

312

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

313

return self.rename(remove=False)

314

else:

315

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

316

self.cleanup()

317

os._exit(1)

318

179

319

def remove(self):

180

320

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

181

321

if self.entry_group_state_changed_match is not None:

183

323

self.entry_group_state_changed_match = None

184

324

if self.group is not None:

185

325

self.group.Reset()

326

186

327

def add(self):

187

328

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

188

329

self.remove()

193

334

avahi.DBUS_INTERFACE_ENTRY_GROUP)

194

335

self.entry_group_state_changed_match = (

195

336

self.group.connect_to_signal(

196

'StateChanged', self .entry_group_state_changed))

337

'StateChanged', self.entry_group_state_changed))

197

338

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

198

339

self.name, self.type)

199

340

self.group.AddService(

205

346

dbus.UInt16(self.port),

206

347

avahi.string_array_to_txt_array(self.TXT))

207

348

self.group.Commit()

349

208

350

def entry_group_state_changed(self, state, error):

209

351

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

210

352

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

216

358

self.rename()

217

359

elif state == avahi.ENTRY_GROUP_FAILURE:

218

360

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

219

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

361

str(error))

362

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

363

222

364

def cleanup(self):

223

365

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

224

366

if self.group is not None:

225

367

try:

226

368

self.group.Free()

227

369

except (dbus.exceptions.UnknownMethodException,

228

dbus.exceptions.DBusException) as e:

370

dbus.exceptions.DBusException):

229

371

pass

230

372

self.group = None

231

373

self.remove()

374

232

375

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

233

376

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

234

377

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

235

bad_states = { avahi.SERVER_INVALID:

236

"Zeroconf server invalid",

237

avahi.SERVER_REGISTERING: None,

238

avahi.SERVER_COLLISION:

239

"Zeroconf server name collision",

240

avahi.SERVER_FAILURE:

241

"Zeroconf server failure" }

378

bad_states = {

379

avahi.SERVER_INVALID: "Zeroconf server invalid",

380

avahi.SERVER_REGISTERING: None,

381

avahi.SERVER_COLLISION: "Zeroconf server name collision",

382

avahi.SERVER_FAILURE: "Zeroconf server failure",

383

}

242

384

if state in bad_states:

243

385

if bad_states[state] is not None:

244

386

if error is None:

247

389

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

248

390

self.cleanup()

249

391

elif state == avahi.SERVER_RUNNING:

250

self.add()

392

try:

393

self.add()

394

except dbus.exceptions.DBusException as error:

395

if (error.get_dbus_name()

396

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

397

logger.info("Local Zeroconf service name"

398

" collision.")

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

251

404

else:

252

405

if error is None:

253

406

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

254

407

else:

255

408

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

409

256

410

def activate(self):

257

411

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

258

412

if self.server is None:

262

416

follow_name_owner_changes=True),

263

417

avahi.DBUS_INTERFACE_SERVER)

264

418

self.server.connect_to_signal("StateChanged",

265

self.server_state_changed)

419

self.server_state_changed)

266

420

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

267

421

268

422

269

def _timedelta_to_milliseconds(td):

270

"Convert a datetime.timedelta() to milliseconds"

271

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

272

+ (td.seconds * 1000)

273

+ (td.microseconds // 1000))

274

423

class AvahiServiceToSyslog(AvahiService):

424

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

425

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

426

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

427

syslogger.setFormatter(logging.Formatter(

428

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

429

.format(self.name)))

430

return ret

431

432

# Pretend that we have a GnuTLS module

433

class GnuTLS(object):

434

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

435

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

436

437

_library = ctypes.cdll.LoadLibrary(

438

ctypes.util.find_library("gnutls"))

439

_need_version = "3.3.0"

440

def __init__(self):

441

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

442

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

443

# happens.

444

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

445

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

446

.format(self._need_version))

447

448

# Unless otherwise indicated, the constants and types below are

449

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

450

451

# Constants

452

E_SUCCESS = 0

453

E_INTERRUPTED = -52

454

E_AGAIN = -28

455

CRT_OPENPGP = 2

456

CLIENT = 2

457

SHUT_RDWR = 0

458

CRD_CERTIFICATE = 1

459

E_NO_CERTIFICATE_FOUND = -49

460

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

461

462

# Types

463

class session_int(ctypes.Structure):

464

_fields_ = []

465

session_t = ctypes.POINTER(session_int)

466

class certificate_credentials_st(ctypes.Structure):

467

_fields_ = []

468

certificate_credentials_t = ctypes.POINTER(

469

certificate_credentials_st)

470

certificate_type_t = ctypes.c_int

471

class datum_t(ctypes.Structure):

472

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

473

('size', ctypes.c_uint)]

474

class openpgp_crt_int(ctypes.Structure):

475

_fields_ = []

476

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

477

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

478

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

479

credentials_type_t = ctypes.c_int #

480

transport_ptr_t = ctypes.c_void_p

481

close_request_t = ctypes.c_int

482

483

# Exceptions

484

class Error(Exception):

485

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

486

# exception might be raised from within GnuTLS.__init__,

487

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

488

# global variable has happened.

489

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

490

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

491

# code is passed, convert it to a string with

492

# gnutls.strerror()

493

self.code = code

494

if message is None and code is not None:

495

message = GnuTLS.strerror(code)

496

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

497

message, *args)

498

499

class CertificateSecurityError(Error):

500

pass

501

502

# Classes

503

class Credentials(object):

504

def __init__(self):

505

self._c_object = gnutls.certificate_credentials_t()

506

gnutls.certificate_allocate_credentials(

507

ctypes.byref(self._c_object))

508

self.type = gnutls.CRD_CERTIFICATE

509

510

def __del__(self):

511

gnutls.certificate_free_credentials(self._c_object)

512

513

class ClientSession(object):

514

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

515

self._c_object = gnutls.session_t()

516

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

517

gnutls.set_default_priority(self._c_object)

518

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

519

gnutls.handshake_set_private_extensions(self._c_object,

520

True)

521

self.socket = socket

522

if credentials is None:

523

credentials = gnutls.Credentials()

524

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

525

ctypes.cast(credentials._c_object,

526

ctypes.c_void_p))

527

self.credentials = credentials

528

529

def __del__(self):

530

gnutls.deinit(self._c_object)

531

532

def handshake(self):

533

return gnutls.handshake(self._c_object)

534

535

def send(self, data):

536

data = bytes(data)

537

data_len = len(data)

538

while data_len > 0:

539

data_len -= gnutls.record_send(self._c_object,

540

data[-data_len:],

541

data_len)

542

543

def bye(self):

544

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

545

546

# Error handling functions

547

def _error_code(result):

548

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

549

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

550

if result >= 0:

551

return result

552

if result == gnutls.E_NO_CERTIFICATE_FOUND:

553

raise gnutls.CertificateSecurityError(code = result)

554

raise gnutls.Error(code = result)

555

556

def _retry_on_error(result, func, arguments):

557

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

558

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

559

while result < 0:

560

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

561

return _error_code(result)

562

result = func(*arguments)

563

return result

564

565

# Unless otherwise indicated, the function declarations below are

566

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

567

568

# Functions

569

priority_set_direct = _library.gnutls_priority_set_direct

570

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

571

ctypes.POINTER(ctypes.c_char_p)]

572

priority_set_direct.restype = _error_code

573

574

init = _library.gnutls_init

575

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

576

init.restype = _error_code

577

578

set_default_priority = _library.gnutls_set_default_priority

579

set_default_priority.argtypes = [session_t]

580

set_default_priority.restype = _error_code

581

582

record_send = _library.gnutls_record_send

583

record_send.argtypes = [session_t, ctypes.c_void_p,

584

ctypes.c_size_t]

585

record_send.restype = ctypes.c_ssize_t

586

record_send.errcheck = _retry_on_error

587

588

certificate_allocate_credentials = (

589

_library.gnutls_certificate_allocate_credentials)

590

certificate_allocate_credentials.argtypes = [

591

ctypes.POINTER(certificate_credentials_t)]

592

certificate_allocate_credentials.restype = _error_code

593

594

certificate_free_credentials = (

595

_library.gnutls_certificate_free_credentials)

596

certificate_free_credentials.argtypes = [certificate_credentials_t]

597

certificate_free_credentials.restype = None

598

599

handshake_set_private_extensions = (

600

_library.gnutls_handshake_set_private_extensions)

601

handshake_set_private_extensions.argtypes = [session_t,

602

ctypes.c_int]

603

handshake_set_private_extensions.restype = None

604

605

credentials_set = _library.gnutls_credentials_set

606

credentials_set.argtypes = [session_t, credentials_type_t,

607

ctypes.c_void_p]

608

credentials_set.restype = _error_code

609

610

strerror = _library.gnutls_strerror

611

strerror.argtypes = [ctypes.c_int]

612

strerror.restype = ctypes.c_char_p

613

614

certificate_type_get = _library.gnutls_certificate_type_get

615

certificate_type_get.argtypes = [session_t]

616

certificate_type_get.restype = _error_code

617

618

certificate_get_peers = _library.gnutls_certificate_get_peers

619

certificate_get_peers.argtypes = [session_t,

620

ctypes.POINTER(ctypes.c_uint)]

621

certificate_get_peers.restype = ctypes.POINTER(datum_t)

622

623

global_set_log_level = _library.gnutls_global_set_log_level

624

global_set_log_level.argtypes = [ctypes.c_int]

625

global_set_log_level.restype = None

626

627

global_set_log_function = _library.gnutls_global_set_log_function

628

global_set_log_function.argtypes = [log_func]

629

global_set_log_function.restype = None

630

631

deinit = _library.gnutls_deinit

632

deinit.argtypes = [session_t]

633

deinit.restype = None

634

635

handshake = _library.gnutls_handshake

636

handshake.argtypes = [session_t]

637

handshake.restype = _error_code

638

handshake.errcheck = _retry_on_error

639

640

transport_set_ptr = _library.gnutls_transport_set_ptr

641

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

642

transport_set_ptr.restype = None

643

644

bye = _library.gnutls_bye

645

bye.argtypes = [session_t, close_request_t]

646

bye.restype = _error_code

647

bye.errcheck = _retry_on_error

648

649

check_version = _library.gnutls_check_version

650

check_version.argtypes = [ctypes.c_char_p]

651

check_version.restype = ctypes.c_char_p

652

653

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

654

655

openpgp_crt_init = _library.gnutls_openpgp_crt_init

656

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

657

openpgp_crt_init.restype = _error_code

658

659

openpgp_crt_import = _library.gnutls_openpgp_crt_import

660

openpgp_crt_import.argtypes = [openpgp_crt_t,

661

ctypes.POINTER(datum_t),

662

openpgp_crt_fmt_t]

663

openpgp_crt_import.restype = _error_code

664

665

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

666

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

667

ctypes.POINTER(ctypes.c_uint)]

668

openpgp_crt_verify_self.restype = _error_code

669

670

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

671

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

672

openpgp_crt_deinit.restype = None

673

674

openpgp_crt_get_fingerprint = (

675

_library.gnutls_openpgp_crt_get_fingerprint)

676

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

677

ctypes.c_void_p,

678

ctypes.POINTER(

679

ctypes.c_size_t)]

680

openpgp_crt_get_fingerprint.restype = _error_code

681

682

# Remove non-public functions

683

del _error_code, _retry_on_error

684

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

685

gnutls = GnuTLS()

686

687

def call_pipe(connection, # : multiprocessing.Connection

688

func, *args, **kwargs):

689

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

690

691

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

692

return value on the provided multiprocessing.Connection.

693

"""

694

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

695

connection.close()

696

275

697

class Client(object):

276

698

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

277

699

278

700

Attributes:

279

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

701

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

280

702

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

281

703

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

282

704

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

289

711

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

290

712

checker_initiator_tag: a gobject event source tag, or None

291

713

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

714

client_structure: Object describing what attributes a client has

715

and is used for storing the client at exit

292

716

current_checker_command: string; current running checker_command

293

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

294

717

disable_initiator_tag: a gobject event source tag, or None

295

718

enabled: bool()

296

719

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

299

722

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

300

723

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

301

724

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

302

last_enabled: datetime.datetime(); (UTC)

725

last_checker_status: integer between 0 and 255 reflecting exit

726

status of last checker. -1 reflects crashed

727

checker, -2 means no checker completed yet.

728

last_checker_signal: The signal which killed the last checker, if

729

last_checker_status is -1

730

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

303

731

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

304

732

D-Bus identifiers

305

733

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

306

734

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

307

735

until this client is disabled

308

extended_timeout: extra long timeout when password has been sent

736

extended_timeout: extra long timeout when secret has been sent

309

737

runtime_expansions: Allowed attributes for runtime expansion.

310

738

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

311

739

disabled, or None

740

server_settings: The server_settings dict from main()

312

741

"""

313

742

314

743

runtime_expansions = ("approval_delay", "approval_duration",

315

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

316

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

744

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

745

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

746

"last_approval_request", "last_checked_ok",

317

747

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

318

319

def timeout_milliseconds(self):

320

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

322

323

def extended_timeout_milliseconds(self):

324

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

326

327

def interval_milliseconds(self):

328

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

330

331

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

748

client_defaults = {

749

"timeout": "PT5M",

750

"extended_timeout": "PT15M",

751

"interval": "PT2M",

752

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

753

"host": "",

754

"approval_delay": "PT0S",

755

"approval_duration": "PT1S",

756

"approved_by_default": "True",

757

"enabled": "True",

758

}

759

760

@staticmethod

761

def config_parser(config):

762

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

763

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

764

with exceptions for any special settings as defined above.

765

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

766

value given the same arguments.

767

"""

768

settings = {}

769

for client_name in config.sections():

770

section = dict(config.items(client_name))

771

client = settings[client_name] = {}

772

773

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

774

# Reformat values from string types to Python types

775

client["approved_by_default"] = config.getboolean(

776

client_name, "approved_by_default")

777

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

778

"enabled")

779

780

# Uppercase and remove spaces from fingerprint for later

781

# comparison purposes with return value from the

782

# fingerprint() function

783

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

784

.replace(" ", ""))

785

if "secret" in section:

786

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

787

elif "secfile" in section:

788

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

789

(section["secfile"])),

790

"rb") as secfile:

791

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

792

else:

793

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

794

.format(section))

795

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

796

client["extended_timeout"] = string_to_delta(

797

section["extended_timeout"])

798

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

799

client["approval_delay"] = string_to_delta(

800

section["approval_delay"])

801

client["approval_duration"] = string_to_delta(

802

section["approval_duration"])

803

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

804

client["last_approval_request"] = None

805

client["last_checked_ok"] = None

806

client["last_checker_status"] = -2

807

808

return settings

809

810

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

338

811

self.name = name

339

if config is None:

340

config = {}

812

if server_settings is None:

813

server_settings = {}

814

self.server_settings = server_settings

815

# adding all client settings

816

for setting, value in settings.items():

817

setattr(self, setting, value)

818

819

if self.enabled:

820

if not hasattr(self, "last_enabled"):

821

self.last_enabled = datetime.datetime.utcnow()

822

if not hasattr(self, "expires"):

823

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

824

+ self.timeout)

825

else:

826

self.last_enabled = None

827

self.expires = None

828

341

829

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

342

# Uppercase and remove spaces from fingerprint for later

343

# comparison purposes with return value from the fingerprint()

344

# function

345

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

346

.replace(" ", ""))

347

830

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

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

831

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

832

datetime.datetime.utcnow())

833

834

# attributes specific for this server instance

369

835

self.checker = None

370

836

self.checker_initiator_tag = None

371

837

self.disable_initiator_tag = None

372

self.expires = None

373

838

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

375

839

self.current_checker_command = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

840

self.approved = None

380

841

self.approvals_pending = 0

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

self.changedstate = (multiprocessing_manager

386

.Condition(multiprocessing_manager

387

.Lock()))

842

self.changedstate = multiprocessing_manager.Condition(

843

multiprocessing_manager.Lock())

844

self.client_structure = [attr

845

for attr in self.__dict__.iterkeys()

846

if not attr.startswith("_")]

847

self.client_structure.append("client_structure")

848

849

for name, t in inspect.getmembers(

850

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

851

if not name.startswith("_"):

852

self.client_structure.append(name)

388

853

854

# Send notice to process children that client state has changed

389

855

def send_changedstate(self):

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

856

with self.changedstate:

857

self.changedstate.notify_all()

393

858

394

859

def enable(self):

395

860

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

396

861

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

397

862

# Already enabled

398

863

return

399

self.send_changedstate()

400

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

401

# and every interval from then on.

402

self.checker_initiator_tag = (gobject.timeout_add

403

(self.interval_milliseconds(),

404

self.start_checker))

405

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

406

864

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

410

865

self.enabled = True

411

866

self.last_enabled = datetime.datetime.utcnow()

412

# Also start a new checker *right now*.

413

self.start_checker()

867

self.init_checker()

868

self.send_changedstate()

414

869

415

870

def disable(self, quiet=True):

416

871

"""Disable this client."""

417

872

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

418

873

return False

419

874

if not quiet:

420

self.send_changedstate()

421

if not quiet:

422

875

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

423

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

876

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

424

877

gobject.source_remove(self.disable_initiator_tag)

425

878

self.disable_initiator_tag = None

426

879

self.expires = None

427

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

880

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

428

881

gobject.source_remove(self.checker_initiator_tag)

429

882

self.checker_initiator_tag = None

430

883

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

433

884

self.enabled = False

885

if not quiet:

886

self.send_changedstate()

434

887

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

435

888

return False

436

889

437

890

def __del__(self):

438

self.disable_hook = None

439

891

self.disable()

440

892

441

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

893

def init_checker(self):

894

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

895

# and every interval from then on.

896

if self.checker_initiator_tag is not None:

897

gobject.source_remove(self.checker_initiator_tag)

898

self.checker_initiator_tag = gobject.timeout_add(

899

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

900

self.start_checker)

901

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

902

if self.disable_initiator_tag is not None:

903

gobject.source_remove(self.disable_initiator_tag)

904

self.disable_initiator_tag = gobject.timeout_add(

905

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

906

# Also start a new checker *right now*.

907

self.start_checker()

908

909

def checker_callback(self, source, condition, connection,

910

command):

442

911

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

443

912

self.checker_callback_tag = None

444

913

self.checker = None

445

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

914

# Read return code from connection (see call_pipe)

915

returncode = connection.recv()

916

connection.close()

917

918

if returncode >= 0:

919

self.last_checker_status = returncode

920

self.last_checker_signal = None

921

if self.last_checker_status == 0:

448

922

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

449

923

vars(self))

450

924

self.checked_ok()

451

925

else:

452

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

453

vars(self))

926

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

454

927

else:

928

self.last_checker_status = -1

929

self.last_checker_signal = -returncode

455

930

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

456

931

vars(self))

457

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

932

return False

933

934

def checked_ok(self):

935

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

936

self.last_checked_ok = datetime.datetime.utcnow()

937

self.last_checker_status = 0

938

self.last_checker_signal = None

939

self.bump_timeout()

940

941

def bump_timeout(self, timeout=None):

942

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

464

943

if timeout is None:

465

944

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

467

gobject.source_remove(self.disable_initiator_tag)

468

self.disable_initiator_tag = (gobject.timeout_add

469

(_timedelta_to_milliseconds

470

(timeout), self.disable))

471

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

945

if self.disable_initiator_tag is not None:

946

gobject.source_remove(self.disable_initiator_tag)

947

self.disable_initiator_tag = None

948

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

949

self.disable_initiator_tag = gobject.timeout_add(

950

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

951

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

472

952

473

953

def need_approval(self):

474

954

self.last_approval_request = datetime.datetime.utcnow()

479

959

If a checker already exists, leave it running and do

480

960

nothing."""

481

961

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

482

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

483

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

484

# client would inevitably timeout, since no checker would get

485

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

962

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

963

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

964

# would inevitably timeout, since no checker would get a

965

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

486

966

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

487

967

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

488

968

# should be.

489

969

490

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

491

try:

492

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

493

except (AttributeError, OSError) as error:

494

if (isinstance(error, OSError)

495

and error.errno != errno.ECHILD):

496

raise error

497

else:

498

if pid:

499

logger.warning("Checker was a zombie")

500

gobject.source_remove(self.checker_callback_tag)

501

self.checker_callback(pid, status,

502

self.current_checker_command)

970

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

971

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

972

self.checker.join()

973

self.checker = None

503

974

# Start a new checker if needed

504

975

if self.checker is None:

976

# Escape attributes for the shell

977

escaped_attrs = {

978

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

979

for attr in self.runtime_expansions }

505

980

try:

506

# In case checker_command has exactly one % operator

507

command = self.checker_command % self.host

508

except TypeError:

509

# Escape attributes for the shell

510

escaped_attrs = dict(

511

(attr,

512

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

513

errors=

514

'replace')))

515

for attr in

516

self.runtime_expansions)

517

518

try:

519

command = self.checker_command % escaped_attrs

520

except TypeError as error:

521

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

522

' %s', self.checker_command, error)

523

return True # Try again later

981

command = self.checker_command % escaped_attrs

982

except TypeError as error:

983

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

984

self.checker_command,

985

exc_info=error)

986

return True # Try again later

524

987

self.current_checker_command = command

525

try:

526

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

527

command, self.name)

528

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

529

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

530

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

531

# always replaced by /dev/null.)

532

self.checker = subprocess.Popen(command,

533

close_fds=True,

534

shell=True, cwd="/")

535

self.checker_callback_tag = (gobject.child_watch_add

536

(self.checker.pid,

537

self.checker_callback,

538

data=command))

539

# The checker may have completed before the gobject

540

# watch was added. Check for this.

541

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

542

if pid:

543

gobject.source_remove(self.checker_callback_tag)

544

self.checker_callback(pid, status, command)

545

except OSError as error:

546

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

547

error)

988

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

989

self.name)

990

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

991

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

992

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

993

# always replaced by /dev/null.)

994

# The exception is when not debugging but nevertheless

995

# running in the foreground; use the previously

996

# created wnull.

997

popen_args = { "close_fds": True,

998

"shell": True,

999

"cwd": "/" }

1000

if (not self.server_settings["debug"]

1001

and self.server_settings["foreground"]):

1002

popen_args.update({"stdout": wnull,

1003

"stderr": wnull })

1004

pipe = multiprocessing.Pipe(duplex = False)

1005

self.checker = multiprocessing.Process(

1006

target = call_pipe,

1007

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

1008

kwargs = popen_args)

1009

self.checker.start()

1010

self.checker_callback_tag = gobject.io_add_watch(

1011

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

1012

self.checker_callback, pipe[0], command)

548

1013

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

549

1014

return True

550

1015

556

1021

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

557

1022

return

558

1023

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

559

try:

560

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

561

#time.sleep(0.5)

562

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

563

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

564

except OSError as error:

565

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

566

raise

1024

self.checker.terminate()

567

1025

self.checker = None

568

1026

569

1027

570

def dbus_service_property(dbus_interface, signature="v",

571

access="readwrite", byte_arrays=False):

1028

def dbus_service_property(dbus_interface,

1029

signature="v",

1030

access="readwrite",

1031

byte_arrays=False):

572

1032

"""Decorators for marking methods of a DBusObjectWithProperties to

573

1033

become properties on the D-Bus.

574

1034

583

1043

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

584

1044

if byte_arrays and signature != "ay":

585

1045

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

586

" signature %r" % signature)

1046

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

1047

587

1048

def decorator(func):

588

1049

func._dbus_is_property = True

589

1050

func._dbus_interface = dbus_interface

594

1055

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

595

1056

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

596

1057

return func

1058

1059

return decorator

1060

1061

1062

def dbus_interface_annotations(dbus_interface):

1063

"""Decorator for marking functions returning interface annotations

1064

1065

Usage:

1066

1067

@dbus_interface_annotations("org.example.Interface")

1068

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

1069

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

1070

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

1071

"false"}

1072

"""

1073

1074

def decorator(func):

1075

func._dbus_is_interface = True

1076

func._dbus_interface = dbus_interface

1077

func._dbus_name = dbus_interface

1078

return func

1079

1080

return decorator

1081

1082

1083

def dbus_annotations(annotations):

1084

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

1085

Usage:

1086

1087

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

1088

"org.freedesktop.DBus.Property."

1089

"EmitsChangedSignal": "false"})

1090

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

1091

access="r")

1092

def Property_dbus_property(self):

1093

return dbus.Boolean(False)

1094

1095

See also the DBusObjectWithAnnotations class.

1096

"""

1097

1098

def decorator(func):

1099

func._dbus_annotations = annotations

1100

return func

1101

597

1102

return decorator

598

1103

599

1104

600

1105

class DBusPropertyException(dbus.exceptions.DBusException):

601

1106

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

602

1107

"""

603

def __unicode__(self):

604

return unicode(str(self))

1108

pass

605

1109

606

1110

607

1111

class DBusPropertyAccessException(DBusPropertyException):

616

1120

pass

617

1121

618

1122

619

class DBusObjectWithProperties(dbus.service.Object):

1123

class DBusObjectWithAnnotations(dbus.service.Object):

1124

"""A D-Bus object with annotations.

1125

1126

Classes inheriting from this can use the dbus_annotations

1127

decorator to add annotations to methods or signals.

1128

"""

1129

1130

@staticmethod

1131

def _is_dbus_thing(thing):

1132

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

1133

1134

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

1135

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

1136

"""

1137

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

1138

False)

1139

1140

def _get_all_dbus_things(self, thing):

1141

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

1142

"""

1143

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

1144

athing.__get__(self))

1145

for cls in self.__class__.__mro__

1146

for name, athing in

1147

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

1148

1149

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1150

out_signature = "s",

1151

path_keyword = 'object_path',

1152

connection_keyword = 'connection')

1153

def Introspect(self, object_path, connection):

1154

"""Overloading of standard D-Bus method.

1155

1156

Inserts annotation tags on methods and signals.

1157

"""

1158

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

1159

connection)

1160

try:

1161

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

1162

1163

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

1164

# Add annotation tags

1165

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

1166

for tag in if_tag.getElementsByTagName(typ):

1167

annots = dict()

1168

for name, prop in (self.

1169

_get_all_dbus_things(typ)):

1170

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

1171

and prop._dbus_interface

1172

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

1173

annots.update(getattr(

1174

prop, "_dbus_annotations", {}))

1175

for name, value in annots.items():

1176

ann_tag = document.createElement(

1177

"annotation")

1178

ann_tag.setAttribute("name", name)

1179

ann_tag.setAttribute("value", value)

1180

tag.appendChild(ann_tag)

1181

# Add interface annotation tags

1182

for annotation, value in dict(

1183

itertools.chain.from_iterable(

1184

annotations().items()

1185

for name, annotations

1186

in self._get_all_dbus_things("interface")

1187

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

1188

)).items():

1189

ann_tag = document.createElement("annotation")

1190

ann_tag.setAttribute("name", annotation)

1191

ann_tag.setAttribute("value", value)

1192

if_tag.appendChild(ann_tag)

1193

# Fix argument name for the Introspect method itself

1194

if (if_tag.getAttribute("name")

1195

== dbus.INTROSPECTABLE_IFACE):

1196

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

1197

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

1198

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

1199

if (arg.getAttribute("direction")

1200

== "out"):

1201

arg.setAttribute("name",

1202

"xml_data")

1203

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

1204

document.unlink()

1205

except (AttributeError, xml.dom.DOMException,

1206

xml.parsers.expat.ExpatError) as error:

1207

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

1208

exc_info=error)

1209

return xmlstring

1210

1211

1212

class DBusObjectWithProperties(DBusObjectWithAnnotations):

620

1213

"""A D-Bus object with properties.

621

1214

622

1215

Classes inheriting from this can use the dbus_service_property

624

1217

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

625

1218

"""

626

1219

627

@staticmethod

628

def _is_dbus_property(obj):

629

return getattr(obj, "_dbus_is_property", False)

630

631

def _get_all_dbus_properties(self):

632

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

633

"""

634

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

635

for cls in self.__class__.__mro__

636

for name, prop in

637

inspect.getmembers(cls, self._is_dbus_property))

638

639

1220

def _get_dbus_property(self, interface_name, property_name):

640

1221

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

641

1222

property with the specified name and interface.

642

1223

"""

643

for cls in self.__class__.__mro__:

644

for name, value in (inspect.getmembers

645

(cls, self._is_dbus_property)):

1224

for cls in self.__class__.__mro__:

1225

for name, value in inspect.getmembers(

1226

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

646

1227

if (value._dbus_name == property_name

647

1228

and value._dbus_interface == interface_name):

648

1229

return value.__get__(self)

649

1230

650

1231

# No such property

651

raise DBusPropertyNotFound(self.dbus_object_path + ":"

652

+ interface_name + "."

653

+ property_name)

654

655

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

1232

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

1233

self.dbus_object_path, interface_name, property_name))

1234

1235

@classmethod

1236

def _get_all_interface_names(cls):

1237

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

1238

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

1239

"_dbus_interface", None)

1240

for x in (inspect.getmro(cls))

1241

for attr in dir(x))

1242

if name is not None)

1243

1244

@dbus.service.method(dbus.PROPERTIES_IFACE,

1245

in_signature="ss",

656

1246

out_signature="v")

657

1247

def Get(self, interface_name, property_name):

658

1248

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

676

1266

# The byte_arrays option is not supported yet on

677

1267

# signatures other than "ay".

678

1268

if prop._dbus_signature != "ay":

679

raise ValueError

680

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

681

for byte in value))

1269

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

1270

"'ay' signature {!r}"

1271

.format(prop._dbus_signature))

1272

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

1273

for byte in value))

682

1274

prop(value)

683

1275

684

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

1276

@dbus.service.method(dbus.PROPERTIES_IFACE,

1277

in_signature="s",

685

1278

out_signature="a{sv}")

686

1279

def GetAll(self, interface_name):

687

1280

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

689

1282

690

1283

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

691

1284

"""

692

all = {}

693

for name, prop in self._get_all_dbus_properties():

1285

properties = {}

1286

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

694

1287

if (interface_name

695

1288

and interface_name != prop._dbus_interface):

696

1289

# Interface non-empty but did not match

700

1293

continue

701

1294

value = prop()

702

1295

if not hasattr(value, "variant_level"):

703

all[name] = value

1296

properties[name] = value

704

1297

continue

705

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

706

value.variant_level+1)

707

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

1298

properties[name] = type(value)(

1299

value, variant_level = value.variant_level + 1)

1300

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

1301

1302

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

1303

def PropertiesChanged(self, interface_name, changed_properties,

1304

invalidated_properties):

1305

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

1306

standard.

1307

"""

1308

pass

708

1309

709

1310

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

710

1311

out_signature="s",

711

1312

path_keyword='object_path',

712

1313

connection_keyword='connection')

713

1314

def Introspect(self, object_path, connection):

714

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

1315

"""Overloading of standard D-Bus method.

1316

1317

Inserts property tags and interface annotation tags.

715

1318

"""

716

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

717

connection)

1319

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1320

object_path,

1321

connection)

718

1322

try:

719

1323

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

1324

720

1325

def make_tag(document, name, prop):

721

1326

e = document.createElement("property")

722

1327

e.setAttribute("name", name)

723

1328

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

724

1329

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

725

1330

return e

1331

726

1332

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

1333

# Add property tags

727

1334

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

728

1335

for name, prop

729

in self._get_all_dbus_properties()

1336

in self._get_all_dbus_things("property")

730

1337

if prop._dbus_interface

731

1338

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

732

1339

if_tag.appendChild(tag)

1340

# Add annotation tags for properties

1341

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

1342

annots = dict()

1343

for name, prop in self._get_all_dbus_things(

1344

"property"):

1345

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

1346

and prop._dbus_interface

1347

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

1348

annots.update(getattr(

1349

prop, "_dbus_annotations", {}))

1350

for name, value in annots.items():

1351

ann_tag = document.createElement(

1352

"annotation")

1353

ann_tag.setAttribute("name", name)

1354

ann_tag.setAttribute("value", value)

1355

tag.appendChild(ann_tag)

733

1356

# Add the names to the return values for the

734

1357

# "org.freedesktop.DBus.Properties" methods

735

1358

if (if_tag.getAttribute("name")

750

1373

except (AttributeError, xml.dom.DOMException,

751

1374

xml.parsers.expat.ExpatError) as error:

752

1375

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

753

error)

754

return xmlstring

755

756

757

def datetime_to_dbus (dt, variant_level=0):

1376

exc_info=error)

1377

return xmlstring

1378

1379

try:

1380

dbus.OBJECT_MANAGER_IFACE

1381

except AttributeError:

1382

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

1383

1384

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1385

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

1386

1387

Classes inheriting from this exposes the standard

1388

GetManagedObjects call and the InterfacesAdded and

1389

InterfacesRemoved signals on the standard

1390

"org.freedesktop.DBus.ObjectManager" interface.

1391

1392

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

1393

manually.

1394

"""

1395

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1396

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

1397

def GetManagedObjects(self):

1398

"""This function must be overridden"""

1399

raise NotImplementedError()

1400

1401

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1402

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

1403

def InterfacesAdded(self, object_path, interfaces_and_properties):

1404

pass

1405

1406

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

1407

def InterfacesRemoved(self, object_path, interfaces):

1408

pass

1409

1410

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1411

out_signature = "s",

1412

path_keyword = 'object_path',

1413

connection_keyword = 'connection')

1414

def Introspect(self, object_path, connection):

1415

"""Overloading of standard D-Bus method.

1416

1417

Override return argument name of GetManagedObjects to be

1418

"objpath_interfaces_and_properties"

1419

"""

1420

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1421

object_path,

1422

connection)

1423

try:

1424

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

1425

1426

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

1427

# Fix argument name for the GetManagedObjects method

1428

if (if_tag.getAttribute("name")

1429

== dbus.OBJECT_MANAGER_IFACE):

1430

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

1431

if (cn.getAttribute("name")

1432

== "GetManagedObjects"):

1433

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

1434

if (arg.getAttribute("direction")

1435

== "out"):

1436

arg.setAttribute(

1437

"name",

1438

"objpath_interfaces"

1439

"_and_properties")

1440

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

1441

document.unlink()

1442

except (AttributeError, xml.dom.DOMException,

1443

xml.parsers.expat.ExpatError) as error:

1444

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

1445

exc_info = error)

1446

return xmlstring

1447

1448

def datetime_to_dbus(dt, variant_level=0):

758

1449

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

759

1450

if dt is None:

760

1451

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

761

return dbus.String(dt.isoformat(),

762

variant_level=variant_level)

763

764

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

765

.__metaclass__):

766

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

767

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

1452

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

1453

1454

1455

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1456

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

1457

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

1458

interface names according to the "alt_interface_names" mapping.

1459

Usage:

1460

1461

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

1462

"net.example.AlternateInterface"})

1463

class SampleDBusObject(dbus.service.Object):

1464

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

1465

def SampleDBusMethod():

1466

pass

1467

1468

The above "SampleDBusMethod" on "SampleDBusObject" will be

1469

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

1470

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

1471

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

1472

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

1473

1474

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

1475

(from DBusObjectWithProperties) and interfaces (from the

1476

dbus_interface_annotations decorator).

768

1477

"""

769

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

770

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

771

# methods, signals, or properties in them

772

for base in (b for b in bases

773

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

774

# Go though all attributes of the base class

775

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

1478

1479

def wrapper(cls):

1480

for orig_interface_name, alt_interface_name in (

1481

alt_interface_names.items()):

1482

attr = {}

1483

interface_names = set()

1484

# Go though all attributes of the class

1485

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

776

1486

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

777

1487

# with the wrong interface name

778

1488

if (not hasattr(attribute, "_dbus_interface")

779

or not attribute._dbus_interface

780

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

1489

or not attribute._dbus_interface.startswith(

1490

orig_interface_name)):

781

1491

continue

782

1492

# Create an alternate D-Bus interface name based on

783

1493

# the current name

784

alt_interface = (attribute._dbus_interface

785

.replace("se.recompile.Mandos",

786

"se.bsnet.fukt.Mandos"))

1494

alt_interface = attribute._dbus_interface.replace(

1495

orig_interface_name, alt_interface_name)

1496

interface_names.add(alt_interface)

787

1497

# Is this a D-Bus signal?

788

1498

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

789

# Extract the original non-method function by

790

# black magic

791

nonmethod_func = (dict(

1499

if sys.version_info.major == 2:

1500

# Extract the original non-method undecorated

1501

# function by black magic

1502

nonmethod_func = (dict(

792

1503

zip(attribute.func_code.co_freevars,

793

attribute.__closure__))["func"]

794

.cell_contents)

1504

attribute.__closure__))

1505

["func"].cell_contents)

1506

else:

1507

nonmethod_func = attribute

795

1508

# Create a new, but exactly alike, function

796

1509

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

797

1510

# with the alternate D-Bus interface name

798

new_function = (dbus.service.signal

799

(alt_interface,

800

attribute._dbus_signature)

801

(types.FunctionType(

802

nonmethod_func.func_code,

803

nonmethod_func.func_globals,

804

nonmethod_func.func_name,

805

nonmethod_func.func_defaults,

806

nonmethod_func.func_closure)))

1511

if sys.version_info.major == 2:

1512

new_function = types.FunctionType(

1513

nonmethod_func.func_code,

1514

nonmethod_func.func_globals,

1515

nonmethod_func.func_name,

1516

nonmethod_func.func_defaults,

1517

nonmethod_func.func_closure)

1518

else:

1519

new_function = types.FunctionType(

1520

nonmethod_func.__code__,

1521

nonmethod_func.__globals__,

1522

nonmethod_func.__name__,

1523

nonmethod_func.__defaults__,

1524

nonmethod_func.__closure__)

1525

new_function = (dbus.service.signal(

1526

alt_interface,

1527

attribute._dbus_signature)(new_function))

1528

# Copy annotations, if any

1529

try:

1530

new_function._dbus_annotations = dict(

1531

attribute._dbus_annotations)

1532

except AttributeError:

1533

pass

807

1534

# Define a creator of a function to call both the

808

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

809

# signals gets sent when the function is called

1535

# original and alternate functions, so both the

1536

# original and alternate signals gets sent when

1537

# the function is called

810

1538

def fixscope(func1, func2):

811

1539

"""This function is a scope container to pass

812

1540

func1 and func2 to the "call_both" function

813

1541

outside of its arguments"""

1542

1543

@functools.wraps(func2)

814

1544

def call_both(*args, **kwargs):

815

1545

"""This function will emit two D-Bus

816

1546

signals by calling func1 and func2"""

817

1547

func1(*args, **kwargs)

818

1548

func2(*args, **kwargs)

1549

# Make wrapper function look like a D-Bus signal

1550

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

1551

if name.startswith("_dbus_"):

1552

setattr(call_both, name, attr)

1553

819

1554

return call_both

820

1555

# Create the "call_both" function and add it to

821

1556

# the class

822

attr[attrname] = fixscope(attribute,

823

new_function)

1557

attr[attrname] = fixscope(attribute, new_function)

824

1558

# Is this a D-Bus method?

825

1559

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

826

1560

# Create a new, but exactly alike, function

827

1561

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

828

1562

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

829

1563

# to the class.

830

attr[attrname] = (dbus.service.method

831

(alt_interface,

832

attribute._dbus_in_signature,

833

attribute._dbus_out_signature)

834

(types.FunctionType

835

(attribute.func_code,

836

attribute.func_globals,

837

attribute.func_name,

838

attribute.func_defaults,

839

attribute.func_closure)))

1564

attr[attrname] = (

1565

dbus.service.method(

1566

alt_interface,

1567

attribute._dbus_in_signature,

1568

attribute._dbus_out_signature)

1569

(types.FunctionType(attribute.func_code,

1570

attribute.func_globals,

1571

attribute.func_name,

1572

attribute.func_defaults,

1573

attribute.func_closure)))

1574

# Copy annotations, if any

1575

try:

1576

attr[attrname]._dbus_annotations = dict(

1577

attribute._dbus_annotations)

1578

except AttributeError:

1579

pass

840

1580

# Is this a D-Bus property?

841

1581

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

842

1582

# Create a new, but exactly alike, function

843

1583

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

844

1584

# property with the alternate D-Bus interface

845

1585

# name. Add it to the class.

846

attr[attrname] = (dbus_service_property

847

(alt_interface,

848

attribute._dbus_signature,

849

attribute._dbus_access,

850

attribute

851

._dbus_get_args_options

852

["byte_arrays"])

853

(types.FunctionType

854

(attribute.func_code,

855

attribute.func_globals,

856

attribute.func_name,

857

attribute.func_defaults,

858

attribute.func_closure)))

859

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

860

1586

attr[attrname] = (dbus_service_property(

1587

alt_interface, attribute._dbus_signature,

1588

attribute._dbus_access,

1589

attribute._dbus_get_args_options

1590

["byte_arrays"])

1591

(types.FunctionType(

1592

attribute.func_code,

1593

attribute.func_globals,

1594

attribute.func_name,

1595

attribute.func_defaults,

1596

attribute.func_closure)))

1597

# Copy annotations, if any

1598

try:

1599

attr[attrname]._dbus_annotations = dict(

1600

attribute._dbus_annotations)

1601

except AttributeError:

1602

pass

1603

# Is this a D-Bus interface?

1604

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

1605

# Create a new, but exactly alike, function

1606

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

1607

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

1608

# to the class.

1609

attr[attrname] = (

1610

dbus_interface_annotations(alt_interface)

1611

(types.FunctionType(attribute.func_code,

1612

attribute.func_globals,

1613

attribute.func_name,

1614

attribute.func_defaults,

1615

attribute.func_closure)))

1616

if deprecate:

1617

# Deprecate all alternate interfaces

1618

iname="_AlternateDBusNames_interface_annotation{}"

1619

for interface_name in interface_names:

1620

1621

@dbus_interface_annotations(interface_name)

1622

def func(self):

1623

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

1624

"true" }

1625

# Find an unused name

1626

for aname in (iname.format(i)

1627

for i in itertools.count()):

1628

if aname not in attr:

1629

attr[aname] = func

1630

break

1631

if interface_names:

1632

# Replace the class with a new subclass of it with

1633

# methods, signals, etc. as created above.

1634

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

1635

(cls, ), attr)

1636

return cls

1637

1638

return wrapper

1639

1640

1641

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

1642

"se.bsnet.fukt.Mandos"})

861

1643

class ClientDBus(Client, DBusObjectWithProperties):

862

1644

"""A Client class using D-Bus

863

1645

867

1649

"""

868

1650

869

1651

runtime_expansions = (Client.runtime_expansions

870

+ ("dbus_object_path",))

1652

+ ("dbus_object_path", ))

1653

1654

_interface = "se.recompile.Mandos.Client"

871

1655

872

1656

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

873

1657

874

1658

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

875

self._approvals_pending = 0

876

1659

self.bus = bus

877

1660

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

878

1661

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

879

1662

# the D-Bus

880

client_object_name = unicode(self.name).translate(

1663

client_object_name = str(self.name).translate(

881

1664

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

882

1665

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

883

self.dbus_object_path = (dbus.ObjectPath

884

("/clients/" + client_object_name))

1666

self.dbus_object_path = dbus.ObjectPath(

1667

"/clients/" + client_object_name)

885

1668

DBusObjectWithProperties.__init__(self, self.bus,

886

1669

self.dbus_object_path)

887

888

def notifychangeproperty(transform_func,

889

dbus_name, type_func=lambda x: x,

890

variant_level=1):

1670

1671

def notifychangeproperty(transform_func, dbus_name,

1672

type_func=lambda x: x,

1673

variant_level=1,

1674

invalidate_only=False,

1675

_interface=_interface):

891

1676

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

892

1677

its changes to DBus.

893

1678

894

1679

transform_fun: Function that takes a value and a variant_level

895

1680

and transforms it to a D-Bus type.

896

1681

dbus_name: D-Bus name of the variable

898

1683

to the D-Bus. Default: no transform

899

1684

variant_level: D-Bus variant level. Default: 1

900

1685

"""

901

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

1686

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

1687

902

1688

def setter(self, value):

903

1689

if hasattr(self, "dbus_object_path"):

904

1690

if (not hasattr(self, attrname) or

905

1691

type_func(getattr(self, attrname, None))

906

1692

!= type_func(value)):

907

dbus_value = transform_func(type_func(value),

908

variant_level

909

=variant_level)

910

self.PropertyChanged(dbus.String(dbus_name),

911

dbus_value)

1693

if invalidate_only:

1694

self.PropertiesChanged(

1695

_interface, dbus.Dictionary(),

1696

dbus.Array((dbus_name, )))

1697

else:

1698

dbus_value = transform_func(

1699

type_func(value),

1700

variant_level = variant_level)

1701

self.PropertyChanged(dbus.String(dbus_name),

1702

dbus_value)

1703

self.PropertiesChanged(

1704

_interface,

1705

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

1706

dbus_value }),

1707

dbus.Array())

912

1708

setattr(self, attrname, value)

913

1709

914

1710

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

915

1711

916

917

1712

expires = notifychangeproperty(datetime_to_dbus, "Expires")

918

1713

approvals_pending = notifychangeproperty(dbus.Boolean,

919

1714

"ApprovalPending",

921

1716

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

922

1717

last_enabled = notifychangeproperty(datetime_to_dbus,

923

1718

"LastEnabled")

924

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

925

type_func = lambda checker:

926

checker is not None)

1719

checker = notifychangeproperty(

1720

dbus.Boolean, "CheckerRunning",

1721

type_func = lambda checker: checker is not None)

927

1722

last_checked_ok = notifychangeproperty(datetime_to_dbus,

928

1723

"LastCheckedOK")

1724

last_checker_status = notifychangeproperty(dbus.Int16,

1725

"LastCheckerStatus")

929

1726

last_approval_request = notifychangeproperty(

930

1727

datetime_to_dbus, "LastApprovalRequest")

931

1728

approved_by_default = notifychangeproperty(dbus.Boolean,

932

1729

"ApprovedByDefault")

933

approval_delay = notifychangeproperty(dbus.UInt16,

934

"ApprovalDelay",

935

type_func =

936

_timedelta_to_milliseconds)

1730

approval_delay = notifychangeproperty(

1731

dbus.UInt64, "ApprovalDelay",

1732

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

937

1733

approval_duration = notifychangeproperty(

938

dbus.UInt16, "ApprovalDuration",

939

type_func = _timedelta_to_milliseconds)

1734

dbus.UInt64, "ApprovalDuration",

1735

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

940

1736

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

941

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

942

type_func =

943

_timedelta_to_milliseconds)

1737

timeout = notifychangeproperty(

1738

dbus.UInt64, "Timeout",

1739

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

944

1740

extended_timeout = notifychangeproperty(

945

dbus.UInt16, "ExtendedTimeout",

946

type_func = _timedelta_to_milliseconds)

947

interval = notifychangeproperty(dbus.UInt16,

948

"Interval",

949

type_func =

950

_timedelta_to_milliseconds)

1741

dbus.UInt64, "ExtendedTimeout",

1742

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

1743

interval = notifychangeproperty(

1744

dbus.UInt64, "Interval",

1745

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

951

1746

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

1747

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

1748

invalidate_only=True)

952

1749

953

1750

del notifychangeproperty

954

1751

961

1758

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

962

1759

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

963

1760

964

def checker_callback(self, pid, condition, command,

965

*args, **kwargs):

966

self.checker_callback_tag = None

967

self.checker = None

968

if os.WIFEXITED(condition):

969

exitstatus = os.WEXITSTATUS(condition)

1761

def checker_callback(self, source, condition,

1762

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

1763

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

1764

connection, command, *args,

1765

**kwargs)

1766

exitstatus = self.last_checker_status

1767

if exitstatus >= 0:

970

1768

# Emit D-Bus signal

971

1769

self.CheckerCompleted(dbus.Int16(exitstatus),

972

dbus.Int64(condition),

1770

# This is specific to GNU libC

1771

dbus.Int64(exitstatus << 8),

973

1772

dbus.String(command))

974

1773

else:

975

1774

# Emit D-Bus signal

976

1775

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

977

dbus.Int64(condition),

1776

dbus.Int64(

1777

# This is specific to GNU libC

1778

(exitstatus << 8)

1779

| self.last_checker_signal),

978

1780

dbus.String(command))

979

980

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

981

*args, **kwargs)

1781

return ret

982

1782

983

1783

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

984

old_checker = self.checker

985

if self.checker is not None:

986

old_checker_pid = self.checker.pid

987

else:

988

old_checker_pid = None

1784

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

989

1785

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

990

1786

# Only if new checker process was started

991

1787

if (self.checker is not None

995

1791

return r

996

1792

997

1793

def _reset_approved(self):

998

self._approved = None

1794

self.approved = None

999

1795

return False

1000

1796

1001

1797

def approve(self, value=True):

1798

self.approved = value

1799

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

1800

* 1000), self._reset_approved)

1002

1801

self.send_changedstate()

1003

self._approved = value

1004

gobject.timeout_add(_timedelta_to_milliseconds

1005

(self.approval_duration),

1006

self._reset_approved)

1007

1008

1802

1009

1803

## D-Bus methods, signals & properties

1010

_interface = "se.recompile.Mandos.Client"

1804

1805

## Interfaces

1011

1806

1012

1807

## Signals

1013

1808

1024

1819

pass

1025

1820

1026

1821

# PropertyChanged - signal

1822

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

1027

1823

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

1028

1824

def PropertyChanged(self, property, value):

1029

1825

"D-Bus signal"

1063

1859

self.checked_ok()

1064

1860

1065

1861

# Enable - method

1862

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

1066

1863

@dbus.service.method(_interface)

1067

1864

def Enable(self):

1068

1865

"D-Bus method"

1069

1866

self.enable()

1070

1867

1071

1868

# StartChecker - method

1869

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

1072

1870

@dbus.service.method(_interface)

1073

1871

def StartChecker(self):

1074

1872

"D-Bus method"

1075

1873

self.start_checker()

1076

1874

1077

1875

# Disable - method

1876

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

1078

1877

@dbus.service.method(_interface)

1079

1878

def Disable(self):

1080

1879

"D-Bus method"

1081

1880

self.disable()

1082

1881

1083

1882

# StopChecker - method

1883

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

1084

1884

@dbus.service.method(_interface)

1085

1885

def StopChecker(self):

1086

1886

self.stop_checker()

1093

1893

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

1094

1894

1095

1895

# ApprovedByDefault - property

1096

@dbus_service_property(_interface, signature="b",

1896

@dbus_service_property(_interface,

1897

signature="b",

1097

1898

access="readwrite")

1098

1899

def ApprovedByDefault_dbus_property(self, value=None):

1099

1900

if value is None: # get

1101

1902

self.approved_by_default = bool(value)

1102

1903

1103

1904

# ApprovalDelay - property

1104

@dbus_service_property(_interface, signature="t",

1905

@dbus_service_property(_interface,

1906

signature="t",

1105

1907

access="readwrite")

1106

1908

def ApprovalDelay_dbus_property(self, value=None):

1107

1909

if value is None: # get

1108

return dbus.UInt64(self.approval_delay_milliseconds())

1910

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

1911

* 1000)

1109

1912

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

1110

1913

1111

1914

# ApprovalDuration - property

1112

@dbus_service_property(_interface, signature="t",

1915

@dbus_service_property(_interface,

1916

signature="t",

1113

1917

access="readwrite")

1114

1918

def ApprovalDuration_dbus_property(self, value=None):

1115

1919

if value is None: # get

1116

return dbus.UInt64(_timedelta_to_milliseconds(

1117

self.approval_duration))

1920

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

1921

* 1000)

1118

1922

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

1119

1923

1120

1924

# Name - property

1925

@dbus_annotations(

1926

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

1121

1927

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

1122

1928

def Name_dbus_property(self):

1123

1929

return dbus.String(self.name)

1124

1930

1125

1931

# Fingerprint - property

1932

@dbus_annotations(

1933

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

1126

1934

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

1127

1935

def Fingerprint_dbus_property(self):

1128

1936

return dbus.String(self.fingerprint)

1129

1937

1130

1938

# Host - property

1131

@dbus_service_property(_interface, signature="s",

1939

@dbus_service_property(_interface,

1940

signature="s",

1132

1941

access="readwrite")

1133

1942

def Host_dbus_property(self, value=None):

1134

1943

if value is None: # get

1135

1944

return dbus.String(self.host)

1136

self.host = value

1945

self.host = str(value)

1137

1946

1138

1947

# Created - property

1948

@dbus_annotations(

1949

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

1139

1950

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

1140

1951

def Created_dbus_property(self):

1141

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

1952

return datetime_to_dbus(self.created)

1142

1953

1143

1954

# LastEnabled - property

1144

1955

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

1146

1957

return datetime_to_dbus(self.last_enabled)

1147

1958

1148

1959

# Enabled - property

1149

@dbus_service_property(_interface, signature="b",

1960

@dbus_service_property(_interface,

1961

signature="b",

1150

1962

access="readwrite")

1151

1963

def Enabled_dbus_property(self, value=None):

1152

1964

if value is None: # get

1157

1969

self.disable()

1158

1970

1159

1971

# LastCheckedOK - property

1160

@dbus_service_property(_interface, signature="s",

1972

@dbus_service_property(_interface,

1973

signature="s",

1161

1974

access="readwrite")

1162

1975

def LastCheckedOK_dbus_property(self, value=None):

1163

1976

if value is not None:

1165

1978

return

1166

1979

return datetime_to_dbus(self.last_checked_ok)

1167

1980

1981

# LastCheckerStatus - property

1982

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

1983

def LastCheckerStatus_dbus_property(self):

1984

return dbus.Int16(self.last_checker_status)

1985

1168

1986

# Expires - property

1169

1987

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

1170

1988

def Expires_dbus_property(self):

1176

1994

return datetime_to_dbus(self.last_approval_request)

1177

1995

1178

1996

# Timeout - property

1179

@dbus_service_property(_interface, signature="t",

1997

@dbus_service_property(_interface,

1998

signature="t",

1180

1999

access="readwrite")

1181

2000

def Timeout_dbus_property(self, value=None):

1182

2001

if value is None: # get

1183

return dbus.UInt64(self.timeout_milliseconds())

2002

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

2003

old_timeout = self.timeout

1184

2004

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

1185

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

1186

return

1187

# Reschedule timeout

1188

gobject.source_remove(self.disable_initiator_tag)

1189

self.disable_initiator_tag = None

1190

self.expires = None

1191

time_to_die = _timedelta_to_milliseconds((self

1192

.last_checked_ok

1193

+ self.timeout)

1194

- datetime.datetime

1195

.utcnow())

1196

if time_to_die <= 0:

1197

# The timeout has passed

1198

self.disable()

1199

else:

1200

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

1201

+ datetime.timedelta(milliseconds =

1202

time_to_die))

1203

self.disable_initiator_tag = (gobject.timeout_add

1204

(time_to_die, self.disable))

2005

# Reschedule disabling

2006

if self.enabled:

2007

now = datetime.datetime.utcnow()

2008

self.expires += self.timeout - old_timeout

2009

if self.expires <= now:

2010

# The timeout has passed

2011

self.disable()

2012

else:

2013

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

2014

is None):

2015

return

2016

gobject.source_remove(self.disable_initiator_tag)

2017

self.disable_initiator_tag = gobject.timeout_add(

2018

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

2019

self.disable)

1205

2020

1206

2021

# ExtendedTimeout - property

1207

@dbus_service_property(_interface, signature="t",

2022

@dbus_service_property(_interface,

2023

signature="t",

1208

2024

access="readwrite")

1209

2025

def ExtendedTimeout_dbus_property(self, value=None):

1210

2026

if value is None: # get

1211

return dbus.UInt64(self.extended_timeout_milliseconds())

2027

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

2028

* 1000)

1212

2029

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

1213

2030

1214

2031

# Interval - property

1215

@dbus_service_property(_interface, signature="t",

2032

@dbus_service_property(_interface,

2033

signature="t",

1216

2034

access="readwrite")

1217

2035

def Interval_dbus_property(self, value=None):

1218

2036

if value is None: # get

1219

return dbus.UInt64(self.interval_milliseconds())

2037

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

1220

2038

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

1221

2039

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

1222

2040

return

1223

# Reschedule checker run

1224

gobject.source_remove(self.checker_initiator_tag)

1225

self.checker_initiator_tag = (gobject.timeout_add

1226

(value, self.start_checker))

1227

self.start_checker() # Start one now, too

2041

if self.enabled:

2042

# Reschedule checker run

2043

gobject.source_remove(self.checker_initiator_tag)

2044

self.checker_initiator_tag = gobject.timeout_add(

2045

value, self.start_checker)

2046

self.start_checker() # Start one now, too

1228

2047

1229

2048

# Checker - property

1230

@dbus_service_property(_interface, signature="s",

2049

@dbus_service_property(_interface,

2050

signature="s",

1231

2051

access="readwrite")

1232

2052

def Checker_dbus_property(self, value=None):

1233

2053

if value is None: # get

1234

2054

return dbus.String(self.checker_command)

1235

self.checker_command = value

2055

self.checker_command = str(value)

1236

2056

1237

2057

# CheckerRunning - property

1238

@dbus_service_property(_interface, signature="b",

2058

@dbus_service_property(_interface,

2059

signature="b",

1239

2060

access="readwrite")

1240

2061

def CheckerRunning_dbus_property(self, value=None):

1241

2062

if value is None: # get

1246

2067

self.stop_checker()

1247

2068

1248

2069

# ObjectPath - property

2070

@dbus_annotations(

2071

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

2072

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

1249

2073

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

1250

2074

def ObjectPath_dbus_property(self):

1251

2075

return self.dbus_object_path # is already a dbus.ObjectPath

1252

2076

1253

2077

# Secret = property

1254

@dbus_service_property(_interface, signature="ay",

1255

access="write", byte_arrays=True)

2078

@dbus_annotations(

2079

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

2080

"invalidates"})

2081

@dbus_service_property(_interface,

2082

signature="ay",

2083

access="write",

2084

byte_arrays=True)

1256

2085

def Secret_dbus_property(self, value):

1257

self.secret = str(value)

2086

self.secret = bytes(value)

1258

2087

1259

2088

del _interface

1260

2089

1264

2093

self._pipe = child_pipe

1265

2094

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

1266

2095

if not self._pipe.recv():

1267

raise KeyError()

2096

raise KeyError(fpr)

1268

2097

1269

2098

def __getattribute__(self, name):

1270

if(name == '_pipe'):

2099

if name == '_pipe':

1271

2100

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

1272

2101

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

1273

2102

data = self._pipe.recv()

1274

2103

if data[0] == 'data':

1275

2104

return data[1]

1276

2105

if data[0] == 'function':

2106

1277

2107

def func(*args, **kwargs):

1278

2108

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

1279

2109

return self._pipe.recv()[1]

2110

1280

2111

return func

1281

2112

1282

2113

def __setattr__(self, name, value):

1283

if(name == '_pipe'):

2114

if name == '_pipe':

1284

2115

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

1285

2116

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

1286

2117

1287

class ClientDBusTransitional(ClientDBus):

1288

__metaclass__ = AlternateDBusNamesMetaclass

1289

2118

1290

2119

class ClientHandler(socketserver.BaseRequestHandler, object):

1291

2120

"""A class to handle client connections.

1296

2125

def handle(self):

1297

2126

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

1298

2127

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

1299

unicode(self.client_address))

2128

str(self.client_address))

1300

2129

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

1301

2130

self.server.child_pipe.fileno())

1302

2131

1303

session = (gnutls.connection

1304

.ClientSession(self.request,

1305

gnutls.connection

1306

.X509Credentials()))

1307

1308

# Note: gnutls.connection.X509Credentials is really a

1309

# generic GnuTLS certificate credentials object so long as

1310

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

1311

# here despite using OpenPGP certificates.

2132

session = gnutls.ClientSession(self.request)

1312

2133

1313

2134

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

1314

2135

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

1318

2139

priority = self.server.gnutls_priority

1319

2140

if priority is None:

1320

2141

priority = "NORMAL"

1321

(gnutls.library.functions

1322

.gnutls_priority_set_direct(session._c_object,

1323

priority, None))

2142

gnutls.priority_set_direct(session._c_object, priority,

2143

None)

1324

2144

1325

2145

# Start communication using the Mandos protocol

1326

2146

# Get protocol number

1328

2148

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

1329

2149

try:

1330

2150

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

1331

raise RuntimeError

2151

raise RuntimeError(line)

1332

2152

except (ValueError, IndexError, RuntimeError) as error:

1333

2153

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

1334

2154

return

1336

2156

# Start GnuTLS connection

1337

2157

try:

1338

2158

session.handshake()

1339

except gnutls.errors.GNUTLSError as error:

2159

except gnutls.Error as error:

1340

2160

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

1341

2161

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

1342

2162

# established. Just abandon the request.

1346

2166

approval_required = False

1347

2167

try:

1348

2168

try:

1349

fpr = self.fingerprint(self.peer_certificate

1350

(session))

1351

except (TypeError,

1352

gnutls.errors.GNUTLSError) as error:

2169

fpr = self.fingerprint(

2170

self.peer_certificate(session))

2171

except (TypeError, gnutls.Error) as error:

1353

2172

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

1354

2173

return

1355

2174

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

1368

2187

while True:

1369

2188

if not client.enabled:

1370

2189

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

1371

client.name)

2190

client.name)

1372

2191

if self.server.use_dbus:

1373

2192

# Emit D-Bus signal

1374

2193

client.Rejected("Disabled")

1375

2194

return

1376

2195

1377

if client._approved or not client.approval_delay:

2196

if client.approved or not client.approval_delay:

1378

2197

#We are approved or approval is disabled

1379

2198

break

1380

elif client._approved is None:

2199

elif client.approved is None:

1381

2200

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

1382

2201

client.name)

1383

2202

if self.server.use_dbus:

1384

2203

# Emit D-Bus signal

1385

2204

client.NeedApproval(

1386

client.approval_delay_milliseconds(),

1387

client.approved_by_default)

2205

client.approval_delay.total_seconds()

2206

* 1000, client.approved_by_default)

1388

2207

else:

1389

2208

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

1390

2209

client.name)

1396

2215

#wait until timeout or approved

1397

2216

time = datetime.datetime.now()

1398

2217

client.changedstate.acquire()

1399

(client.changedstate.wait

1400

(float(client._timedelta_to_milliseconds(delay)

1401

/ 1000)))

2218

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

1402

2219

client.changedstate.release()

1403

2220

time2 = datetime.datetime.now()

1404

2221

if (time2 - time) >= delay:

1415

2232

else:

1416

2233

delay -= time2 - time

1417

2234

1418

sent_size = 0

1419

while sent_size < len(client.secret):

1420

try:

1421

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

1422

except gnutls.errors.GNUTLSError as error:

1423

logger.warning("gnutls send failed")

1424

return

1425

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

1426

sent, len(client.secret)

1427

- (sent_size + sent))

1428

sent_size += sent

2235

try:

2236

session.send(client.secret)

2237

except gnutls.Error as error:

2238

logger.warning("gnutls send failed",

2239

exc_info = error)

2240

return

1429

2241

1430

2242

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

1431

2243

# bump the timeout using extended_timeout

1432

client.checked_ok(client.extended_timeout)

2244

client.bump_timeout(client.extended_timeout)

1433

2245

if self.server.use_dbus:

1434

2246

# Emit D-Bus signal

1435

2247

client.GotSecret()

1439

2251

client.approvals_pending -= 1

1440

2252

try:

1441

2253

session.bye()

1442

except gnutls.errors.GNUTLSError as error:

1443

logger.warning("GnuTLS bye failed")

2254

except gnutls.Error as error:

2255

logger.warning("GnuTLS bye failed",

2256

exc_info=error)

1444

2257

1445

2258

@staticmethod

1446

2259

def peer_certificate(session):

1447

2260

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

1448

2261

# If not an OpenPGP certificate...

1449

if (gnutls.library.functions

1450

.gnutls_certificate_type_get(session._c_object)

1451

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1452

# ...do the normal thing

1453

return session.peer_certificate

2262

if (gnutls.certificate_type_get(session._c_object)

2263

!= gnutls.CRT_OPENPGP):

2264

# ...return invalid data

2265

return b""

1454

2266

list_size = ctypes.c_uint(1)

1455

cert_list = (gnutls.library.functions

1456

.gnutls_certificate_get_peers

2267

cert_list = (gnutls.certificate_get_peers

1457

2268

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

1458

2269

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

1459

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

1460

" certificate")

2270

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

1461

2271

if list_size.value == 0:

1462

2272

return None

1463

2273

cert = cert_list[0]

1467

2277

def fingerprint(openpgp):

1468

2278

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1469

2279

# New GnuTLS "datum" with the OpenPGP public key

1470

datum = (gnutls.library.types

1471

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

1472

ctypes.POINTER

1473

(ctypes.c_ubyte)),

1474

ctypes.c_uint(len(openpgp))))

2280

datum = gnutls.datum_t(

2281

ctypes.cast(ctypes.c_char_p(openpgp),

2282

ctypes.POINTER(ctypes.c_ubyte)),

2283

ctypes.c_uint(len(openpgp)))

1475

2284

# New empty GnuTLS certificate

1476

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1477

(gnutls.library.functions

1478

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2285

crt = gnutls.openpgp_crt_t()

2286

gnutls.openpgp_crt_init(ctypes.byref(crt))

1479

2287

# Import the OpenPGP public key into the certificate

1480

(gnutls.library.functions

1481

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

1482

gnutls.library.constants

1483

.GNUTLS_OPENPGP_FMT_RAW))

2288

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

2289

gnutls.OPENPGP_FMT_RAW)

1484

2290

# Verify the self signature in the key

1485

2291

crtverify = ctypes.c_uint()

1486

(gnutls.library.functions

1487

.gnutls_openpgp_crt_verify_self(crt, 0,

1488

ctypes.byref(crtverify)))

2292

gnutls.openpgp_crt_verify_self(crt, 0,

2293

ctypes.byref(crtverify))

1489

2294

if crtverify.value != 0:

1490

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1491

raise (gnutls.errors.CertificateSecurityError

1492

("Verify failed"))

2295

gnutls.openpgp_crt_deinit(crt)

2296

raise gnutls.CertificateSecurityError("Verify failed")

1493

2297

# New buffer for the fingerprint

1494

2298

buf = ctypes.create_string_buffer(20)

1495

2299

buf_len = ctypes.c_size_t()

1496

2300

# Get the fingerprint from the certificate into the buffer

1497

(gnutls.library.functions

1498

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

1499

ctypes.byref(buf_len)))

2301

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

2302

ctypes.byref(buf_len))

1500

2303

# Deinit the certificate

1501

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2304

gnutls.openpgp_crt_deinit(crt)

1502

2305

# Convert the buffer to a Python bytestring

1503

2306

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

1504

2307

# Convert the bytestring to hexadecimal notation

1505

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

2308

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

1506

2309

return hex_fpr

1507

2310

1508

2311

1509

2312

class MultiprocessingMixIn(object):

1510

2313

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

2314

1511

2315

def sub_process_main(self, request, address):

1512

2316

try:

1513

2317

self.finish_request(request, address)

1514

except:

2318

except Exception:

1515

2319

self.handle_error(request, address)

1516

2320

self.close_request(request)

1517

2321

1518

2322

def process_request(self, request, address):

1519

2323

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

1520

2324

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

1521

args = (request,

1522

address))

2325

args = (request, address))

1523

2326

proc.start()

1524

2327

return proc

1525

2328

1526

2329

1527

2330

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1528

2331

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

2332

1529

2333

def process_request(self, request, client_address):

1530

2334

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

1531

2335

1540

2344

1541

2345

def add_pipe(self, parent_pipe, proc):

1542

2346

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

1543

raise NotImplementedError

2347

raise NotImplementedError()

1544

2348

1545

2349

1546

2350

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1552

2356

interface: None or a network interface name (string)

1553

2357

use_ipv6: Boolean; to use IPv6 or not

1554

2358

"""

2359

1555

2360

def __init__(self, server_address, RequestHandlerClass,

1556

interface=None, use_ipv6=True):

2361

interface=None,

2362

use_ipv6=True,

2363

socketfd=None):

2364

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

2365

creating a new one with socket.socket().

2366

"""

1557

2367

self.interface = interface

1558

2368

if use_ipv6:

1559

2369

self.address_family = socket.AF_INET6

2370

if socketfd is not None:

2371

# Save the file descriptor

2372

self.socketfd = socketfd

2373

# Save the original socket.socket() function

2374

self.socket_socket = socket.socket

2375

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

2376

#

2377

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

2378

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

2379

# patching socket.socket.)

2380

#

2381

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

2382

@functools.wraps(socket.socket)

2383

def socket_wrapper(*args, **kwargs):

2384

# Restore original function so subsequent calls are

2385

# not affected.

2386

socket.socket = self.socket_socket

2387

del self.socket_socket

2388

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

2389

# saved file descriptor.

2390

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

2391

# Replace socket.socket() function with wrapper

2392

socket.socket = socket_wrapper

2393

# The socketserver.TCPServer.__init__ will call

2394

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

2395

# socket_wrapper(), if socketfd was set.

1560

2396

socketserver.TCPServer.__init__(self, server_address,

1561

2397

RequestHandlerClass)

2398

1562

2399

def server_bind(self):

1563

2400

"""This overrides the normal server_bind() function

1564

2401

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

1570

2407

self.interface)

1571

2408

else:

1572

2409

try:

1573

self.socket.setsockopt(socket.SOL_SOCKET,

1574

SO_BINDTODEVICE,

1575

str(self.interface

1576

+ '\0'))

2410

self.socket.setsockopt(

2411

socket.SOL_SOCKET, SO_BINDTODEVICE,

2412

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

1577

2413

except socket.error as error:

1578

if error[0] == errno.EPERM:

1579

logger.error("No permission to"

1580

" bind to interface %s",

1581

self.interface)

1582

elif error[0] == errno.ENOPROTOOPT:

2414

if error.errno == errno.EPERM:

2415

logger.error("No permission to bind to"

2416

" interface %s", self.interface)

2417

elif error.errno == errno.ENOPROTOOPT:

1583

2418

logger.error("SO_BINDTODEVICE not available;"

1584

2419

" cannot bind to interface %s",

1585

2420

self.interface)

2421

elif error.errno == errno.ENODEV:

2422

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

2423

" cannot bind", self.interface)

1586

2424

else:

1587

2425

raise

1588

2426

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

1591

2429

if self.address_family == socket.AF_INET6:

1592

2430

any_address = "::" # in6addr_any

1593

2431

else:

1594

any_address = socket.INADDR_ANY

2432

any_address = "0.0.0.0" # INADDR_ANY

1595

2433

self.server_address = (any_address,

1596

2434

self.server_address[1])

1597

2435

elif not self.server_address[1]:

1598

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

1599

0)

2436

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

1600

2437

# if self.interface:

1601

2438

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

1602

2439

# 0, # port

1616

2453

1617

2454

Assumes a gobject.MainLoop event loop.

1618

2455

"""

2456

1619

2457

def __init__(self, server_address, RequestHandlerClass,

1620

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

1621

gnutls_priority=None, use_dbus=True):

2458

interface=None,

2459

use_ipv6=True,

2460

clients=None,

2461

gnutls_priority=None,

2462

use_dbus=True,

2463

socketfd=None):

1622

2464

self.enabled = False

1623

2465

self.clients = clients

1624

2466

if self.clients is None:

1625

self.clients = set()

2467

self.clients = {}

1626

2468

self.use_dbus = use_dbus

1627

2469

self.gnutls_priority = gnutls_priority

1628

2470

IPv6_TCPServer.__init__(self, server_address,

1629

2471

RequestHandlerClass,

1630

2472

interface = interface,

1631

use_ipv6 = use_ipv6)

2473

use_ipv6 = use_ipv6,

2474

socketfd = socketfd)

2475

1632

2476

def server_activate(self):

1633

2477

if self.enabled:

1634

2478

return socketserver.TCPServer.server_activate(self)

1638

2482

1639

2483

def add_pipe(self, parent_pipe, proc):

1640

2484

# Call "handle_ipc" for both data and EOF events

1641

gobject.io_add_watch(parent_pipe.fileno(),

1642

gobject.IO_IN | gobject.IO_HUP,

1643

functools.partial(self.handle_ipc,

1644

parent_pipe =

1645

parent_pipe,

1646

proc = proc))

2485

gobject.io_add_watch(

2486

parent_pipe.fileno(),

2487

gobject.IO_IN | gobject.IO_HUP,

2488

functools.partial(self.handle_ipc,

2489

parent_pipe = parent_pipe,

2490

proc = proc))

1647

2491

1648

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

1649

proc = None, client_object=None):

1650

condition_names = {

1651

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

1652

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

1653

# blocking).

1654

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

1655

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

1656

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

1657

# broken, usually for pipes and

1658

# sockets).

1659

}

1660

conditions_string = ' | '.join(name

1661

for cond, name in

1662

condition_names.iteritems()

1663

if cond & condition)

2492

def handle_ipc(self, source, condition,

2493

parent_pipe=None,

2494

proc = None,

2495

client_object=None):

1664

2496

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

1665

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

2497

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

1666

2498

# Wait for other process to exit

1667

2499

proc.join()

1668

2500

return False

1675

2507

fpr = request[1]

1676

2508

address = request[2]

1677

2509

1678

for c in self.clients:

2510

for c in self.clients.itervalues():

1679

2511

if c.fingerprint == fpr:

1680

2512

client = c

1681

2513

break

1689

2521

parent_pipe.send(False)

1690

2522

return False

1691

2523

1692

gobject.io_add_watch(parent_pipe.fileno(),

1693

gobject.IO_IN | gobject.IO_HUP,

1694

functools.partial(self.handle_ipc,

1695

parent_pipe =

1696

parent_pipe,

1697

proc = proc,

1698

client_object =

1699

client))

2524

gobject.io_add_watch(

2525

parent_pipe.fileno(),

2526

gobject.IO_IN | gobject.IO_HUP,

2527

functools.partial(self.handle_ipc,

2528

parent_pipe = parent_pipe,

2529

proc = proc,

2530

client_object = client))

1700

2531

parent_pipe.send(True)

1701

2532

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

1702

2533

# same fileno

1708

2539

1709

2540

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

1710

2541

funcname)(*args,

1711

**kwargs)))

2542

**kwargs)))

1712

2543

1713

2544

if command == 'getattr':

1714

2545

attrname = request[1]

1715

if callable(client_object.__getattribute__(attrname)):

1716

parent_pipe.send(('function',))

2546

if isinstance(client_object.__getattribute__(attrname),

2547

collections.Callable):

2548

parent_pipe.send(('function', ))

1717

2549

else:

1718

parent_pipe.send(('data', client_object

1719

.__getattribute__(attrname)))

2550

parent_pipe.send((

2551

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

1720

2552

1721

2553

if command == 'setattr':

1722

2554

attrname = request[1]

1726

2558

return True

1727

2559

1728

2560

2561

def rfc3339_duration_to_delta(duration):

2562

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

2563

2564

>>> rfc3339_duration_to_delta("P7D")

2565

datetime.timedelta(7)

2566

>>> rfc3339_duration_to_delta("PT60S")

2567

datetime.timedelta(0, 60)

2568

>>> rfc3339_duration_to_delta("PT60M")

2569

datetime.timedelta(0, 3600)

2570

>>> rfc3339_duration_to_delta("PT24H")

2571

datetime.timedelta(1)

2572

>>> rfc3339_duration_to_delta("P1W")

2573

datetime.timedelta(7)

2574

>>> rfc3339_duration_to_delta("PT5M30S")

2575

datetime.timedelta(0, 330)

2576

>>> rfc3339_duration_to_delta("P1DT3M20S")

2577

datetime.timedelta(1, 200)

2578

"""

2579

2580

# Parsing an RFC 3339 duration with regular expressions is not

2581

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

2582

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

2583

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

2584

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

2585

# avoid excessive use of external libraries.

2586

2587

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

2588

Token = collections.namedtuple("Token", (

2589

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

2590

# a "group" containing digits

2591

"value", # datetime.timedelta or None

2592

"followers")) # Tokens valid after this token

2593

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

2594

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

2595

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

2596

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

2597

datetime.timedelta(seconds=1),

2598

frozenset((token_end, )))

2599

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

2600

datetime.timedelta(minutes=1),

2601

frozenset((token_second, token_end)))

2602

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

2603

datetime.timedelta(hours=1),

2604

frozenset((token_minute, token_end)))

2605

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

2606

None,

2607

frozenset((token_hour, token_minute,

2608

token_second)))

2609

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

2610

datetime.timedelta(days=1),

2611

frozenset((token_time, token_end)))

2612

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

2613

datetime.timedelta(weeks=4),

2614

frozenset((token_day, token_end)))

2615

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

2616

datetime.timedelta(weeks=52),

2617

frozenset((token_month, token_end)))

2618

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

2619

datetime.timedelta(weeks=1),

2620

frozenset((token_end, )))

2621

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

2622

frozenset((token_year, token_month,

2623

token_day, token_time,

2624

token_week)))

2625

# Define starting values

2626

value = datetime.timedelta() # Value so far

2627

found_token = None

2628

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

2629

s = duration # String left to parse

2630

# Loop until end token is found

2631

while found_token is not token_end:

2632

# Search for any currently valid tokens

2633

for token in followers:

2634

match = token.regexp.match(s)

2635

if match is not None:

2636

# Token found

2637

if token.value is not None:

2638

# Value found, parse digits

2639

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

2640

# Add to value so far

2641

value += factor * token.value

2642

# Strip token from string

2643

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

2644

# Go to found token

2645

found_token = token

2646

# Set valid next tokens

2647

followers = found_token.followers

2648

break

2649

else:

2650

# No currently valid tokens were found

2651

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

2652

.format(duration))

2653

# End token found

2654

return value

2655

2656

1729

2657

def string_to_delta(interval):

1730

2658

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

1731

2659

1742

2670

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

1743

2671

datetime.timedelta(0, 330)

1744

2672

"""

2673

2674

try:

2675

return rfc3339_duration_to_delta(interval)

2676

except ValueError:

2677

pass

2678

1745

2679

timevalue = datetime.timedelta(0)

1746

2680

for s in interval.split():

1747

2681

try:

1748

suffix = unicode(s[-1])

2682

suffix = s[-1]

1749

2683

value = int(s[:-1])

1750

2684

if suffix == "d":

1751

2685

delta = datetime.timedelta(value)

1758

2692

elif suffix == "w":

1759

2693

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

1760

2694

else:

1761

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

1762

except (ValueError, IndexError) as e:

2695

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

2696

except IndexError as e:

1763

2697

raise ValueError(*(e.args))

1764

2698

timevalue += delta

1765

2699

return timevalue

1766

2700

1767

2701

1768

def if_nametoindex(interface):

1769

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

1770

1771

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

1772

global if_nametoindex

1773

try:

1774

if_nametoindex = (ctypes.cdll.LoadLibrary

1775

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

1776

.if_nametoindex)

1777

except (OSError, AttributeError):

1778

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

1779

def if_nametoindex(interface):

1780

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

1781

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

1782

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

1783

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1784

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

1785

interface))

1786

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

1787

ifreq[16:20])[0]

1788

return interface_index

1789

return if_nametoindex(interface)

1790

1791

1792

2702

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

1793

2703

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

1794

2704

1802

2712

sys.exit()

1803

2713

if not noclose:

1804

2714

# Close all standard open file descriptors

1805

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

2715

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

1806

2716

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

1807

2717

raise OSError(errno.ENODEV,

1808

"%s not a character device"

1809

% os.path.devnull)

2718

"{} not a character device"

2719

.format(os.devnull))

1810

2720

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

1811

2721

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

1812

2722

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

1821

2731

1822

2732

parser = argparse.ArgumentParser()

1823

2733

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

1824

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

2734

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

1825

2735

help="show version number and exit")

1826

2736

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

1827

2737

help="Bind to interface IF")

1833

2743

help="Run self-test")

1834

2744

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

1835

2745

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

1836

" to terminal")

2746

" to terminal", default=None)

1837

2747

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

1838

2748

help="Debug level for stdout output")

1839

2749

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

1846

2756

" files")

1847

2757

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

1848

2758

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

1849

" system bus interface")

2759

" system bus interface", default=None)

1850

2760

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

1851

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

2761

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

2762

default=None)

2763

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

2764

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

2765

" state", default=None)

2766

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

2767

help="Specify a file descriptor to a network"

2768

" socket to use instead of creating one")

2769

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

2770

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

2771

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

2772

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

2773

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

2774

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

2775

default=None)

2776

1852

2777

options = parser.parse_args()

1853

2778

1854

2779

if options.check:

1855

2780

import doctest

1856

doctest.testmod()

1857

sys.exit()

2781

fail_count, test_count = doctest.testmod()

2782

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

1858

2783

1859

2784

# Default values for config file for server-global settings

1860

2785

server_defaults = { "interface": "",

1862

2787

"port": "",

1863

2788

"debug": "False",

1864

2789

"priority":

1865

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

2790

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

2791

":+SIGN-DSA-SHA256",

1866

2792

"servicename": "Mandos",

1867

2793

"use_dbus": "True",

1868

2794

"use_ipv6": "True",

1869

2795

"debuglevel": "",

1870

}

2796

"restore": "True",

2797

"socket": "",

2798

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

2799

"foreground": "False",

2800

"zeroconf": "True",

2801

}

1871

2802

1872

2803

# Parse config file for server-global settings

1873

2804

server_config = configparser.SafeConfigParser(server_defaults)

1874

2805

del server_defaults

1875

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

1876

"mandos.conf"))

2806

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

1877

2807

# Convert the SafeConfigParser object to a dict

1878

2808

server_settings = server_config.defaults()

1879

2809

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

1880

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

2810

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

1881

2811

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

1882

2812

option)

1883

2813

if server_settings["port"]:

1884

2814

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

1885

2815

"port")

2816

if server_settings["socket"]:

2817

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

2818

"socket")

2819

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

2820

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

2821

# happen with a supplied network socket.

2822

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

2823

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

2824

["socket"])

1886

2825

del server_config

1887

2826

1888

2827

# Override the settings from the config file with command line

1889

2828

# options, if set.

1890

2829

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

1891

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

1892

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

2830

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

2831

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

2832

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

1893

2833

value = getattr(options, option)

1894

2834

if value is not None:

1895

2835

server_settings[option] = value

1896

2836

del options

1897

2837

# Force all strings to be unicode

1898

2838

for option in server_settings.keys():

1899

if type(server_settings[option]) is str:

1900

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

2839

if isinstance(server_settings[option], bytes):

2840

server_settings[option] = (server_settings[option]

2841

.decode("utf-8"))

2842

# Force all boolean options to be boolean

2843

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

2844

"foreground", "zeroconf"):

2845

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

2846

# Debug implies foreground

2847

if server_settings["debug"]:

2848

server_settings["foreground"] = True

1901

2849

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

1902

2850

1903

2851

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

1904

2852

2853

if (not server_settings["zeroconf"]

2854

and not (server_settings["port"]

2855

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

2856

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

2857

1905

2858

# For convenience

1906

2859

debug = server_settings["debug"]

1907

2860

debuglevel = server_settings["debuglevel"]

1908

2861

use_dbus = server_settings["use_dbus"]

1909

2862

use_ipv6 = server_settings["use_ipv6"]

2863

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

2864

stored_state_file)

2865

foreground = server_settings["foreground"]

2866

zeroconf = server_settings["zeroconf"]

2867

2868

if debug:

2869

initlogger(debug, logging.DEBUG)

2870

else:

2871

if not debuglevel:

2872

initlogger(debug)

2873

else:

2874

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

2875

initlogger(debug, level)

1910

2876

1911

2877

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

1912

syslogger.setFormatter(logging.Formatter

1913

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

1914

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

1915

% server_settings["servicename"]))

2878

syslogger.setFormatter(

2879

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

2880

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

2881

server_settings["servicename"])))

1916

2882

1917

2883

# Parse config file with clients

1918

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

1919

"extended_timeout": "15m",

1920

"interval": "2m",

1921

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

1922

"host": "",

1923

"approval_delay": "0s",

1924

"approval_duration": "1s",

1925

}

1926

client_config = configparser.SafeConfigParser(client_defaults)

2884

client_config = configparser.SafeConfigParser(Client

2885

.client_defaults)

1927

2886

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

1928

2887

"clients.conf"))

1929

2888

1930

2889

global mandos_dbus_service

1931

2890

mandos_dbus_service = None

1932

2891

1933

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

1934

server_settings["port"]),

1935

ClientHandler,

1936

interface=(server_settings["interface"]

1937

or None),

1938

use_ipv6=use_ipv6,

1939

gnutls_priority=

1940

server_settings["priority"],

1941

use_dbus=use_dbus)

1942

if not debug:

1943

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

2892

socketfd = None

2893

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

2894

socketfd = server_settings["socket"]

2895

tcp_server = MandosServer(

2896

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

2897

ClientHandler,

2898

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

2899

use_ipv6=use_ipv6,

2900

gnutls_priority=server_settings["priority"],

2901

use_dbus=use_dbus,

2902

socketfd=socketfd)

2903

if not foreground:

2904

pidfilename = "/run/mandos.pid"

2905

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

2906

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

2907

pidfile = None

1944

2908

try:

1945

pidfile = open(pidfilename, "w")

1946

except IOError:

1947

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

2909

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

2910

except IOError as e:

2911

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

2912

exc_info=e)

1948

2913

1949

try:

1950

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

1951

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

1952

except KeyError:

2914

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

1953

2915

try:

1954

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

1955

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

2916

uid = pwd.getpwnam(name).pw_uid

2917

gid = pwd.getpwnam(name).pw_gid

2918

break

1956

2919

except KeyError:

1957

try:

1958

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

1959

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

1960

except KeyError:

1961

uid = 65534

1962

gid = 65534

2920

continue

2921

else:

2922

uid = 65534

2923

gid = 65534

1963

2924

try:

1964

2925

os.setgid(gid)

1965

2926

os.setuid(uid)

1966

2927

except OSError as error:

1967

if error[0] != errno.EPERM:

1968

raise error

1969

1970

if not debug and not debuglevel:

1971

syslogger.setLevel(logging.WARNING)

1972

console.setLevel(logging.WARNING)

1973

if debuglevel:

1974

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

1975

syslogger.setLevel(level)

1976

console.setLevel(level)

2928

if error.errno != errno.EPERM:

2929

raise

1977

2930

1978

2931

if debug:

1979

2932

# Enable all possible GnuTLS debugging

1980

2933

1981

2934

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

1982

2935

# - GnuTLS manual

1983

gnutls.library.functions.gnutls_global_set_log_level(11)

2936

gnutls.global_set_log_level(11)

1984

2937

1985

@gnutls.library.types.gnutls_log_func

2938

@gnutls.log_func

1986

2939

def debug_gnutls(level, string):

1987

2940

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

1988

2941

1989

(gnutls.library.functions

1990

.gnutls_global_set_log_function(debug_gnutls))

2942

gnutls.global_set_log_function(debug_gnutls)

1991

2943

1992

2944

# Redirect stdin so all checkers get /dev/null

1993

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

2945

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

1994

2946

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

1995

2947

if null > 2:

1996

2948

os.close(null)

1997

else:

1998

# No console logging

1999

logger.removeHandler(console)

2000

2949

2001

2950

# Need to fork before connecting to D-Bus

2002

if not debug:

2951

if not foreground:

2003

2952

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

2004

2953

daemon()

2005

2954

2955

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

2956

# need to inform gobject that threads will be used.

2957

gobject.threads_init()

2958

2006

2959

global main_loop

2007

2960

# From the Avahi example code

2008

DBusGMainLoop(set_as_default=True )

2961

DBusGMainLoop(set_as_default=True)

2009

2962

main_loop = gobject.MainLoop()

2010

2963

bus = dbus.SystemBus()

2011

2964

# End of Avahi example code

2012

2965

if use_dbus:

2013

2966

try:

2014

2967

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

2015

bus, do_not_queue=True)

2016

old_bus_name = (dbus.service.BusName

2017

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

2018

do_not_queue=True))

2019

except dbus.exceptions.NameExistsException as e:

2020

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

2968

bus,

2969

do_not_queue=True)

2970

old_bus_name = dbus.service.BusName(

2971

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

2972

do_not_queue=True)

2973

except dbus.exceptions.DBusException as e:

2974

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

2021

2975

use_dbus = False

2022

2976

server_settings["use_dbus"] = False

2023

2977

tcp_server.use_dbus = False

2024

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2025

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

2026

servicetype = "_mandos._tcp",

2027

protocol = protocol, bus = bus)

2028

if server_settings["interface"]:

2029

service.interface = (if_nametoindex

2030

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

2978

if zeroconf:

2979

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2980

service = AvahiServiceToSyslog(

2981

name = server_settings["servicename"],

2982

servicetype = "_mandos._tcp",

2983

protocol = protocol,

2984

bus = bus)

2985

if server_settings["interface"]:

2986

service.interface = if_nametoindex(

2987

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

2031

2988

2032

2989

global multiprocessing_manager

2033

2990

multiprocessing_manager = multiprocessing.Manager()

2034

2991

2035

2992

client_class = Client

2036

2993

if use_dbus:

2037

client_class = functools.partial(ClientDBusTransitional,

2038

bus = bus)

2039

def client_config_items(config, section):

2040

special_settings = {

2041

"approved_by_default":

2042

lambda: config.getboolean(section,

2043

"approved_by_default"),

2044

}

2045

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

2994

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

2995

2996

client_settings = Client.config_parser(client_config)

2997

old_client_settings = {}

2998

clients_data = {}

2999

3000

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

3001

global wnull

3002

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

3003

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

3004

# mode

3005

if debug or not foreground:

3006

wnull.close()

3007

3008

# Get client data and settings from last running state.

3009

if server_settings["restore"]:

3010

try:

3011

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

3012

clients_data, old_client_settings = pickle.load(

3013

stored_state)

3014

os.remove(stored_state_path)

3015

except IOError as e:

3016

if e.errno == errno.ENOENT:

3017

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

3018

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

3019

else:

3020

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

3021

exc_info=e)

3022

raise

3023

except EOFError as e:

3024

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

3025

"EOFError:",

3026

exc_info=e)

3027

3028

with PGPEngine() as pgp:

3029

for client_name, client in clients_data.items():

3030

# Skip removed clients

3031

if client_name not in client_settings:

3032

continue

3033

3034

# Decide which value to use after restoring saved state.

3035

# We have three different values: Old config file,

3036

# new config file, and saved state.

3037

# New config value takes precedence if it differs from old

3038

# config value, otherwise use saved state.

3039

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

3040

try:

3041

# For each value in new config, check if it

3042

# differs from the old config value (Except for

3043

# the "secret" attribute)

3044

if (name != "secret"

3045

and (value !=

3046

old_client_settings[client_name][name])):

3047

client[name] = value

3048

except KeyError:

3049

pass

3050

3051

# Clients who has passed its expire date can still be

3052

# enabled if its last checker was successful. A Client

3053

# whose checker succeeded before we stored its state is

3054

# assumed to have successfully run all checkers during

3055

# downtime.

3056

if client["enabled"]:

3057

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

3058

if not client["last_checked_ok"]:

3059

logger.warning(

3060

"disabling client {} - Client never "

3061

"performed a successful checker".format(

3062

client_name))

3063

client["enabled"] = False

3064

elif client["last_checker_status"] != 0:

3065

logger.warning(

3066

"disabling client {} - Client last"

3067

" checker failed with error code"

3068

" {}".format(

3069

client_name,

3070

client["last_checker_status"]))

3071

client["enabled"] = False

3072

else:

3073

client["expires"] = (

3074

datetime.datetime.utcnow()

3075

+ client["timeout"])

3076

logger.debug("Last checker succeeded,"

3077

" keeping {} enabled".format(

3078

client_name))

2046

3079

try:

2047

yield (name, special_settings[name]())

2048

except KeyError:

2049

yield (name, value)

2050

2051

tcp_server.clients.update(set(

2052

client_class(name = section,

2053

config= dict(client_config_items(

2054

client_config, section)))

2055

for section in client_config.sections()))

3080

client["secret"] = pgp.decrypt(

3081

client["encrypted_secret"],

3082

client_settings[client_name]["secret"])

3083

except PGPError:

3084

# If decryption fails, we use secret from new settings

3085

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

3086

client_name))

3087

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

3088

["secret"])

3089

3090

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

3091

for client_name in (set(old_client_settings)

3092

- set(client_settings)):

3093

del clients_data[client_name]

3094

for client_name in (set(client_settings)

3095

- set(old_client_settings)):

3096

clients_data[client_name] = client_settings[client_name]

3097

3098

# Create all client objects

3099

for client_name, client in clients_data.items():

3100

tcp_server.clients[client_name] = client_class(

3101

name = client_name,

3102

settings = client,

3103

server_settings = server_settings)

3104

2056

3105

if not tcp_server.clients:

2057

3106

logger.warning("No clients defined")

2058

2059

if not debug:

2060

try:

2061

with pidfile:

2062

pid = os.getpid()

2063

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

2064

del pidfile

2065

except IOError:

2066

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

2067

pidfilename, pid)

2068

except NameError:

2069

# "pidfile" was never created

2070

pass

3107

3108

if not foreground:

3109

if pidfile is not None:

3110

pid = os.getpid()

3111

try:

3112

with pidfile:

3113

print(pid, file=pidfile)

3114

except IOError:

3115

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

3116

pidfilename, pid)

3117

del pidfile

2071

3118

del pidfilename

2072

2073

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

2074

3119

2075

3120

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

2076

3121

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

2077

3122

2078

3123

if use_dbus:

2079

class MandosDBusService(dbus.service.Object):

3124

3125

@alternate_dbus_interfaces(

3126

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

3127

class MandosDBusService(DBusObjectWithObjectManager):

2080

3128

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

3129

2081

3130

def __init__(self):

2082

3131

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

3132

2083

3133

_interface = "se.recompile.Mandos"

2084

3134

2085

3135

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

2092

3142

"D-Bus signal"

2093

3143

pass

2094

3144

3145

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

3146

"true"})

2095

3147

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

2096

3148

def ClientRemoved(self, objpath, name):

2097

3149

"D-Bus signal"

2098

3150

pass

2099

3151

3152

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

3153

"true"})

2100

3154

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

2101

3155

def GetAllClients(self):

2102

3156

"D-Bus method"

2103

return dbus.Array(c.dbus_object_path

2104

for c in tcp_server.clients)

3157

return dbus.Array(c.dbus_object_path for c in

3158

tcp_server.clients.itervalues())

2105

3159

3160

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

3161

"true"})

2106

3162

@dbus.service.method(_interface,

2107

3163

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

2108

3164

def GetAllClientsWithProperties(self):

2109

3165

"D-Bus method"

2110

3166

return dbus.Dictionary(

2111

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

2112

for c in tcp_server.clients),

3167

{ c.dbus_object_path: c.GetAll(

3168

"se.recompile.Mandos.Client")

3169

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

2113

3170

signature="oa{sv}")

2114

3171

2115

3172

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

2116

3173

def RemoveClient(self, object_path):

2117

3174

"D-Bus method"

2118

for c in tcp_server.clients:

3175

for c in tcp_server.clients.itervalues():

2119

3176

if c.dbus_object_path == object_path:

2120

tcp_server.clients.remove(c)

3177

del tcp_server.clients[c.name]

2121

3178

c.remove_from_connection()

2122

# Don't signal anything except ClientRemoved

3179

# Don't signal the disabling

2123

3180

c.disable(quiet=True)

2124

# Emit D-Bus signal

2125

self.ClientRemoved(object_path, c.name)

3181

# Emit D-Bus signal for removal

3182

self.client_removed_signal(c)

2126

3183

return

2127

3184

raise KeyError(object_path)

2128

3185

2129

3186

del _interface

3187

3188

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3189

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

3190

def GetManagedObjects(self):

3191

"""D-Bus method"""

3192

return dbus.Dictionary(

3193

{ client.dbus_object_path:

3194

dbus.Dictionary(

3195

{ interface: client.GetAll(interface)

3196

for interface in

3197

client._get_all_interface_names()})

3198

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

3199

3200

def client_added_signal(self, client):

3201

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

3202

if use_dbus:

3203

# New standard signal

3204

self.InterfacesAdded(

3205

client.dbus_object_path,

3206

dbus.Dictionary(

3207

{ interface: client.GetAll(interface)

3208

for interface in

3209

client._get_all_interface_names()}))

3210

# Old signal

3211

self.ClientAdded(client.dbus_object_path)

3212

3213

def client_removed_signal(self, client):

3214

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

3215

if use_dbus:

3216

# New standard signal

3217

self.InterfacesRemoved(

3218

client.dbus_object_path,

3219

client._get_all_interface_names())

3220

# Old signal

3221

self.ClientRemoved(client.dbus_object_path,

3222

client.name)

2130

3223

2131

class MandosDBusServiceTransitional(MandosDBusService):

2132

__metaclass__ = AlternateDBusNamesMetaclass

2133

mandos_dbus_service = MandosDBusServiceTransitional()

3224

mandos_dbus_service = MandosDBusService()

2134

3225

2135

3226

def cleanup():

2136

3227

"Cleanup function; run on exit"

2137

service.cleanup()

3228

if zeroconf:

3229

service.cleanup()

2138

3230

2139

3231

multiprocessing.active_children()

3232

wnull.close()

3233

if not (tcp_server.clients or client_settings):

3234

return

3235

3236

# Store client before exiting. Secrets are encrypted with key

3237

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

3238

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

3239

clients = {}

3240

with PGPEngine() as pgp:

3241

for client in tcp_server.clients.itervalues():

3242

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

3243

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

3244

key)

3245

client_dict = {}

3246

3247

# A list of attributes that can not be pickled

3248

# + secret.

3249

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

3250

"checker", "server_settings" }

3251

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

3252

.Object):

3253

exclude.add(name)

3254

3255

client_dict["encrypted_secret"] = (client

3256

.encrypted_secret)

3257

for attr in client.client_structure:

3258

if attr not in exclude:

3259

client_dict[attr] = getattr(client, attr)

3260

3261

clients[client.name] = client_dict

3262

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

3263

3264

try:

3265

with tempfile.NamedTemporaryFile(

3266

mode='wb',

3267

suffix=".pickle",

3268

prefix='clients-',

3269

dir=os.path.dirname(stored_state_path),

3270

delete=False) as stored_state:

3271

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

3272

tempname = stored_state.name

3273

os.rename(tempname, stored_state_path)

3274

except (IOError, OSError) as e:

3275

if not debug:

3276

try:

3277

os.remove(tempname)

3278

except NameError:

3279

pass

3280

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

3281

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

3282

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

3283

else:

3284

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

3285

exc_info=e)

3286

raise

3287

3288

# Delete all clients, and settings from config

2140

3289

while tcp_server.clients:

2141

client = tcp_server.clients.pop()

3290

name, client = tcp_server.clients.popitem()

2142

3291

if use_dbus:

2143

3292

client.remove_from_connection()

2144

client.disable_hook = None

2145

# Don't signal anything except ClientRemoved

3293

# Don't signal the disabling

2146

3294

client.disable(quiet=True)

3295

# Emit D-Bus signal for removal

2147

3296

if use_dbus:

2148

# Emit D-Bus signal

2149

mandos_dbus_service.ClientRemoved(client

2150

.dbus_object_path,

2151

client.name)

3297

mandos_dbus_service.client_removed_signal(client)

3298

client_settings.clear()

2152

3299

2153

3300

atexit.register(cleanup)

2154

3301

2155

for client in tcp_server.clients:

3302

for client in tcp_server.clients.itervalues():

2156

3303

if use_dbus:

2157

# Emit D-Bus signal

2158

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2159

client.enable()

3304

# Emit D-Bus signal for adding

3305

mandos_dbus_service.client_added_signal(client)

3306

# Need to initiate checking of clients

3307

if client.enabled:

3308

client.init_checker()

2160

3309

2161

3310

tcp_server.enable()

2162

3311

tcp_server.server_activate()

2163

3312

2164

3313

# Find out what port we got

2165

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

3314

if zeroconf:

3315

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

2166

3316

if use_ipv6:

2167

3317

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

2168

" flowinfo %d, scope_id %d"

2169

% tcp_server.socket.getsockname())

3318

" flowinfo %d, scope_id %d",

3319

*tcp_server.socket.getsockname())

2170

3320

else: # IPv4

2171

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

2172

% tcp_server.socket.getsockname())

3321

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

3322

*tcp_server.socket.getsockname())

2173

3323

2174

3324

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

2175

3325

2176

3326

try:

2177

# From the Avahi example code

2178

try:

2179

service.activate()

2180

except dbus.exceptions.DBusException as error:

2181

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

2182

cleanup()

2183

sys.exit(1)

2184

# End of Avahi example code

3327

if zeroconf:

3328

# From the Avahi example code

3329

try:

3330

service.activate()

3331

except dbus.exceptions.DBusException as error:

3332

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

3333

cleanup()

3334

sys.exit(1)

3335

# End of Avahi example code

2185

3336

2186

3337

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

2187

3338

lambda *args, **kwargs:

2191

3342

logger.debug("Starting main loop")

2192

3343

main_loop.run()

2193

3344

except AvahiError as error:

2194

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

3345

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

2195

3346

cleanup()

2196

3347

sys.exit(1)

2197

3348

except KeyboardInterrupt: