/mandos/trunk : revision 815

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

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

31

# Contact the authors at <mandos@fukt.bsnet.se>.

31

# Contact the authors at <mandos@recompile.se>.

32

#

33

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

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

90

syslogger = (logging.handlers.SysLogHandler

91

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.3"

102

stored_state_file = "clients.pickle"

103

104

logger = logging.getLogger()

105

syslogger = None

106

107

try:

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

110

except (OSError, AttributeError):

111

112

def if_nametoindex(interface):

113

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

114

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

115

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

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

117

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

118

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

119

return interface_index

120

121

122

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

123

"""init logger and add loglevel"""

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

129

syslogger.setFormatter(logging.Formatter

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

134

if debug:

135

console = logging.StreamHandler()

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

141

logger.setLevel(level)

142

143

144

class PGPError(Exception):

145

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

146

pass

147

148

149

class PGPEngine(object):

150

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

151

152

def __init__(self):

153

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

154

self.gpg = "gpg"

155

try:

156

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

157

for line in output.splitlines():

158

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

159

if name == "gpg":

160

self.gpg = path

161

break

162

except OSError as e:

163

if e.errno != errno.ENOENT:

164

raise

165

self.gnupgargs = ['--batch',

166

'--homedir', self.tempdir,

167

'--force-mdc',

168

'--quiet',

169

'--no-use-agent']

170

171

def __enter__(self):

172

return self

173

174

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

175

self._cleanup()

176

return False

177

178

def __del__(self):

179

self._cleanup()

180

181

def _cleanup(self):

182

if self.tempdir is not None:

183

# Delete contents of tempdir

184

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

185

topdown = False):

186

for filename in files:

187

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

188

for dirname in dirs:

189

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

190

# Remove tempdir

191

os.rmdir(self.tempdir)

192

self.tempdir = None

193

194

def password_encode(self, password):

195

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

196

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

197

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

198

if len(encoded) > 2048:

199

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

200

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

201

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

202

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

203

return encoded

204

205

def encrypt(self, data, password):

206

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(

208

dir=self.tempdir) as passfile:

209

passfile.write(passphrase)

210

passfile.flush()

211

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

212

'--passphrase-file',

213

passfile.name]

214

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

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

219

if proc.returncode != 0:

220

raise PGPError(err)

221

return ciphertext

222

223

def decrypt(self, data, password):

224

passphrase = self.password_encode(password)

225

with tempfile.NamedTemporaryFile(

226

dir = self.tempdir) as passfile:

227

passfile.write(passphrase)

228

passfile.flush()

229

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

230

'--passphrase-file',

231

passfile.name]

232

+ self.gnupgargs,

233

stdin = subprocess.PIPE,

234

stdout = subprocess.PIPE,

235

stderr = subprocess.PIPE)

236

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

237

if proc.returncode != 0:

238

raise PGPError(err)

239

return decrypted_plaintext

240

103

241

104

242

class AvahiError(Exception):

105

243

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

106

244

self.value = value

107

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

108

def __unicode__(self):

109

return unicode(repr(self.value))

245

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

246

**kwargs)

247

110

248

111

249

class AvahiServiceError(AvahiError):

112

250

pass

113

251

252

114

253

class AvahiGroupError(AvahiError):

115

254

pass

116

255

123

262

Used to optionally bind to the specified interface.

124

263

name: string; Example: 'Mandos'

125

264

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

126

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

265

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

127

266

port: integer; what port to announce

128

267

TXT: list of strings; TXT record for the service

129

268

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

135

274

server: D-Bus Server

136

275

bus: dbus.SystemBus()

137

276

"""

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

277

278

def __init__(self,

279

interface = avahi.IF_UNSPEC,

280

name = None,

281

servicetype = None,

282

port = None,

283

TXT = None,

284

domain = "",

285

host = "",

286

max_renames = 32768,

287

protocol = avahi.PROTO_UNSPEC,

288

bus = None):

142

289

self.interface = interface

143

290

self.name = name

144

291

self.type = servicetype

153

300

self.server = None

154

301

self.bus = bus

155

302

self.entry_group_state_changed_match = None

156

def rename(self):

303

304

def rename(self, remove=True):

157

305

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

158

306

if self.rename_count >= self.max_renames:

159

307

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

160

308

" after %i retries, exiting.",

161

309

self.rename_count)

162

310

raise AvahiServiceError("Too many renames")

163

self.name = unicode(self.server.GetAlternativeServiceName(self.name))

311

self.name = str(

312

self.server.GetAlternativeServiceName(self.name))

313

self.rename_count += 1

164

314

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

165

315

self.name)

166

syslogger.setFormatter(logging.Formatter

167

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

168

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

169

% self.name))

170

self.remove()

316

if remove:

317

self.remove()

171

318

try:

172

319

self.add()

173

320

except dbus.exceptions.DBusException as error:

174

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

175

self.cleanup()

176

os._exit(1)

177

self.rename_count += 1

321

if (error.get_dbus_name()

322

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

323

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

324

return self.rename(remove=False)

325

else:

326

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

327

self.cleanup()

328

os._exit(1)

329

178

330

def remove(self):

179

331

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

180

332

if self.entry_group_state_changed_match is not None:

182

334

self.entry_group_state_changed_match = None

183

335

if self.group is not None:

184

336

self.group.Reset()

337

185

338

def add(self):

186

339

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

187

340

self.remove()

192

345

avahi.DBUS_INTERFACE_ENTRY_GROUP)

193

346

self.entry_group_state_changed_match = (

194

347

self.group.connect_to_signal(

195

'StateChanged', self .entry_group_state_changed))

348

'StateChanged', self.entry_group_state_changed))

196

349

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

197

350

self.name, self.type)

198

351

self.group.AddService(

204

357

dbus.UInt16(self.port),

205

358

avahi.string_array_to_txt_array(self.TXT))

206

359

self.group.Commit()

360

207

361

def entry_group_state_changed(self, state, error):

208

362

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

209

363

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

215

369

self.rename()

216

370

elif state == avahi.ENTRY_GROUP_FAILURE:

217

371

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

218

unicode(error))

219

raise AvahiGroupError("State changed: %s"

220

% unicode(error))

372

str(error))

373

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

374

221

375

def cleanup(self):

222

376

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

223

377

if self.group is not None:

224

378

try:

225

379

self.group.Free()

226

380

except (dbus.exceptions.UnknownMethodException,

227

dbus.exceptions.DBusException) as e:

381

dbus.exceptions.DBusException):

228

382

pass

229

383

self.group = None

230

384

self.remove()

385

231

386

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

232

387

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

233

388

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

234

bad_states = { avahi.SERVER_INVALID:

235

"Zeroconf server invalid",

236

avahi.SERVER_REGISTERING: None,

237

avahi.SERVER_COLLISION:

238

"Zeroconf server name collision",

239

avahi.SERVER_FAILURE:

240

"Zeroconf server failure" }

389

bad_states = {

390

avahi.SERVER_INVALID: "Zeroconf server invalid",

391

avahi.SERVER_REGISTERING: None,

392

avahi.SERVER_COLLISION: "Zeroconf server name collision",

393

avahi.SERVER_FAILURE: "Zeroconf server failure",

394

}

241

395

if state in bad_states:

242

396

if bad_states[state] is not None:

243

397

if error is None:

246

400

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

247

401

self.cleanup()

248

402

elif state == avahi.SERVER_RUNNING:

249

self.add()

403

try:

404

self.add()

405

except dbus.exceptions.DBusException as error:

406

if (error.get_dbus_name()

407

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

408

logger.info("Local Zeroconf service name"

409

" collision.")

410

return self.rename(remove=False)

411

else:

412

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

413

self.cleanup()

414

os._exit(1)

250

415

else:

251

416

if error is None:

252

417

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

253

418

else:

254

419

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

420

255

421

def activate(self):

256

422

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

257

423

if self.server is None:

261

427

follow_name_owner_changes=True),

262

428

avahi.DBUS_INTERFACE_SERVER)

263

429

self.server.connect_to_signal("StateChanged",

264

self.server_state_changed)

430

self.server_state_changed)

265

431

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

266

432

267

433

268

def _timedelta_to_milliseconds(td):

269

"Convert a datetime.timedelta() to milliseconds"

270

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

271

+ (td.seconds * 1000)

272

+ (td.microseconds // 1000))

273

434

class AvahiServiceToSyslog(AvahiService):

435

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

436

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

437

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

438

syslogger.setFormatter(logging.Formatter(

439

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

440

.format(self.name)))

441

return ret

442

443

# Pretend that we have a GnuTLS module

444

class GnuTLS(object):

445

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

446

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

447

448

_library = ctypes.cdll.LoadLibrary(

449

ctypes.util.find_library("gnutls"))

450

_need_version = "3.3.0"

451

def __init__(self):

452

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

453

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

454

# happens.

455

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

456

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

457

.format(self._need_version))

458

459

# Unless otherwise indicated, the constants and types below are

460

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

461

462

# Constants

463

E_SUCCESS = 0

464

E_INTERRUPTED = -52

465

E_AGAIN = -28

466

CRT_OPENPGP = 2

467

CLIENT = 2

468

SHUT_RDWR = 0

469

CRD_CERTIFICATE = 1

470

E_NO_CERTIFICATE_FOUND = -49

471

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

472

473

# Types

474

class session_int(ctypes.Structure):

475

_fields_ = []

476

session_t = ctypes.POINTER(session_int)

477

class certificate_credentials_st(ctypes.Structure):

478

_fields_ = []

479

certificate_credentials_t = ctypes.POINTER(

480

certificate_credentials_st)

481

certificate_type_t = ctypes.c_int

482

class datum_t(ctypes.Structure):

483

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

484

('size', ctypes.c_uint)]

485

class openpgp_crt_int(ctypes.Structure):

486

_fields_ = []

487

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

488

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

489

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

490

credentials_type_t = ctypes.c_int #

491

transport_ptr_t = ctypes.c_void_p

492

close_request_t = ctypes.c_int

493

494

# Exceptions

495

class Error(Exception):

496

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

497

# exception might be raised from within GnuTLS.__init__,

498

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

499

# global variable has happened.

500

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

501

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

502

# code is passed, convert it to a string with

503

# gnutls.strerror()

504

self.code = code

505

if message is None and code is not None:

506

message = GnuTLS.strerror(code)

507

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

508

message, *args)

509

510

class CertificateSecurityError(Error):

511

pass

512

513

# Classes

514

class Credentials(object):

515

def __init__(self):

516

self._c_object = gnutls.certificate_credentials_t()

517

gnutls.certificate_allocate_credentials(

518

ctypes.byref(self._c_object))

519

self.type = gnutls.CRD_CERTIFICATE

520

521

def __del__(self):

522

gnutls.certificate_free_credentials(self._c_object)

523

524

class ClientSession(object):

525

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

526

self._c_object = gnutls.session_t()

527

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

528

gnutls.set_default_priority(self._c_object)

529

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

530

gnutls.handshake_set_private_extensions(self._c_object,

531

True)

532

self.socket = socket

533

if credentials is None:

534

credentials = gnutls.Credentials()

535

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

536

ctypes.cast(credentials._c_object,

537

ctypes.c_void_p))

538

self.credentials = credentials

539

540

def __del__(self):

541

gnutls.deinit(self._c_object)

542

543

def handshake(self):

544

return gnutls.handshake(self._c_object)

545

546

def send(self, data):

547

data = bytes(data)

548

data_len = len(data)

549

while data_len > 0:

550

data_len -= gnutls.record_send(self._c_object,

551

data[-data_len:],

552

data_len)

553

554

def bye(self):

555

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

556

557

# Error handling functions

558

def _error_code(result):

559

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

560

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

561

if result >= 0:

562

return result

563

if result == gnutls.E_NO_CERTIFICATE_FOUND:

564

raise gnutls.CertificateSecurityError(code = result)

565

raise gnutls.Error(code = result)

566

567

def _retry_on_error(result, func, arguments):

568

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

569

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

570

while result < 0:

571

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

572

return _error_code(result)

573

result = func(*arguments)

574

return result

575

576

# Unless otherwise indicated, the function declarations below are

577

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

578

579

# Functions

580

priority_set_direct = _library.gnutls_priority_set_direct

581

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

582

ctypes.POINTER(ctypes.c_char_p)]

583

priority_set_direct.restype = _error_code

584

585

init = _library.gnutls_init

586

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

587

init.restype = _error_code

588

589

set_default_priority = _library.gnutls_set_default_priority

590

set_default_priority.argtypes = [session_t]

591

set_default_priority.restype = _error_code

592

593

record_send = _library.gnutls_record_send

594

record_send.argtypes = [session_t, ctypes.c_void_p,

595

ctypes.c_size_t]

596

record_send.restype = ctypes.c_ssize_t

597

record_send.errcheck = _retry_on_error

598

599

certificate_allocate_credentials = (

600

_library.gnutls_certificate_allocate_credentials)

601

certificate_allocate_credentials.argtypes = [

602

ctypes.POINTER(certificate_credentials_t)]

603

certificate_allocate_credentials.restype = _error_code

604

605

certificate_free_credentials = (

606

_library.gnutls_certificate_free_credentials)

607

certificate_free_credentials.argtypes = [certificate_credentials_t]

608

certificate_free_credentials.restype = None

609

610

handshake_set_private_extensions = (

611

_library.gnutls_handshake_set_private_extensions)

612

handshake_set_private_extensions.argtypes = [session_t,

613

ctypes.c_int]

614

handshake_set_private_extensions.restype = None

615

616

credentials_set = _library.gnutls_credentials_set

617

credentials_set.argtypes = [session_t, credentials_type_t,

618

ctypes.c_void_p]

619

credentials_set.restype = _error_code

620

621

strerror = _library.gnutls_strerror

622

strerror.argtypes = [ctypes.c_int]

623

strerror.restype = ctypes.c_char_p

624

625

certificate_type_get = _library.gnutls_certificate_type_get

626

certificate_type_get.argtypes = [session_t]

627

certificate_type_get.restype = _error_code

628

629

certificate_get_peers = _library.gnutls_certificate_get_peers

630

certificate_get_peers.argtypes = [session_t,

631

ctypes.POINTER(ctypes.c_uint)]

632

certificate_get_peers.restype = ctypes.POINTER(datum_t)

633

634

global_set_log_level = _library.gnutls_global_set_log_level

635

global_set_log_level.argtypes = [ctypes.c_int]

636

global_set_log_level.restype = None

637

638

global_set_log_function = _library.gnutls_global_set_log_function

639

global_set_log_function.argtypes = [log_func]

640

global_set_log_function.restype = None

641

642

deinit = _library.gnutls_deinit

643

deinit.argtypes = [session_t]

644

deinit.restype = None

645

646

handshake = _library.gnutls_handshake

647

handshake.argtypes = [session_t]

648

handshake.restype = _error_code

649

handshake.errcheck = _retry_on_error

650

651

transport_set_ptr = _library.gnutls_transport_set_ptr

652

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

653

transport_set_ptr.restype = None

654

655

bye = _library.gnutls_bye

656

bye.argtypes = [session_t, close_request_t]

657

bye.restype = _error_code

658

bye.errcheck = _retry_on_error

659

660

check_version = _library.gnutls_check_version

661

check_version.argtypes = [ctypes.c_char_p]

662

check_version.restype = ctypes.c_char_p

663

664

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

665

666

openpgp_crt_init = _library.gnutls_openpgp_crt_init

667

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

668

openpgp_crt_init.restype = _error_code

669

670

openpgp_crt_import = _library.gnutls_openpgp_crt_import

671

openpgp_crt_import.argtypes = [openpgp_crt_t,

672

ctypes.POINTER(datum_t),

673

openpgp_crt_fmt_t]

674

openpgp_crt_import.restype = _error_code

675

676

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

677

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

678

ctypes.POINTER(ctypes.c_uint)]

679

openpgp_crt_verify_self.restype = _error_code

680

681

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

682

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

683

openpgp_crt_deinit.restype = None

684

685

openpgp_crt_get_fingerprint = (

686

_library.gnutls_openpgp_crt_get_fingerprint)

687

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

688

ctypes.c_void_p,

689

ctypes.POINTER(

690

ctypes.c_size_t)]

691

openpgp_crt_get_fingerprint.restype = _error_code

692

693

# Remove non-public functions

694

del _error_code, _retry_on_error

695

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

696

gnutls = GnuTLS()

697

698

def call_pipe(connection, # : multiprocessing.Connection

699

func, *args, **kwargs):

700

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

701

702

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

703

return value on the provided multiprocessing.Connection.

704

"""

705

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

706

connection.close()

707

274

708

class Client(object):

275

709

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

276

710

277

711

Attributes:

278

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

712

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

279

713

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

280

714

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

281

715

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

288

722

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

289

723

checker_initiator_tag: a gobject event source tag, or None

290

724

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

725

client_structure: Object describing what attributes a client has

726

and is used for storing the client at exit

291

727

current_checker_command: string; current running checker_command

292

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

293

728

disable_initiator_tag: a gobject event source tag, or None

294

729

enabled: bool()

295

730

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

298

733

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

299

734

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

300

735

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

301

last_enabled: datetime.datetime(); (UTC)

736

last_checker_status: integer between 0 and 255 reflecting exit

737

status of last checker. -1 reflects crashed

738

checker, -2 means no checker completed yet.

739

last_checker_signal: The signal which killed the last checker, if

740

last_checker_status is -1

741

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

302

742

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

303

743

D-Bus identifiers

304

744

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

305

745

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

306

746

until this client is disabled

307

extended_timeout: extra long timeout when password has been sent

747

extended_timeout: extra long timeout when secret has been sent

308

748

runtime_expansions: Allowed attributes for runtime expansion.

309

749

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

310

750

disabled, or None

751

server_settings: The server_settings dict from main()

311

752

"""

312

753

313

754

runtime_expansions = ("approval_delay", "approval_duration",

314

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

315

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

755

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

756

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

757

"last_approval_request", "last_checked_ok",

316

758

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

317

318

def timeout_milliseconds(self):

319

"Return the 'timeout' attribute in milliseconds"

320

return _timedelta_to_milliseconds(self.timeout)

321

322

def extended_timeout_milliseconds(self):

323

"Return the 'extended_timeout' attribute in milliseconds"

324

return _timedelta_to_milliseconds(self.extended_timeout)

325

326

def interval_milliseconds(self):

327

"Return the 'interval' attribute in milliseconds"

328

return _timedelta_to_milliseconds(self.interval)

329

330

def approval_delay_milliseconds(self):

331

return _timedelta_to_milliseconds(self.approval_delay)

332

333

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

334

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

335

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

336

attribute."""

759

client_defaults = {

760

"timeout": "PT5M",

761

"extended_timeout": "PT15M",

762

"interval": "PT2M",

763

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

764

"host": "",

765

"approval_delay": "PT0S",

766

"approval_duration": "PT1S",

767

"approved_by_default": "True",

768

"enabled": "True",

769

}

770

771

@staticmethod

772

def config_parser(config):

773

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

774

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

775

with exceptions for any special settings as defined above.

776

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

777

value given the same arguments.

778

"""

779

settings = {}

780

for client_name in config.sections():

781

section = dict(config.items(client_name))

782

client = settings[client_name] = {}

783

784

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

785

# Reformat values from string types to Python types

786

client["approved_by_default"] = config.getboolean(

787

client_name, "approved_by_default")

788

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

789

"enabled")

790

791

# Uppercase and remove spaces from fingerprint for later

792

# comparison purposes with return value from the

793

# fingerprint() function

794

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

795

.replace(" ", ""))

796

if "secret" in section:

797

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

798

elif "secfile" in section:

799

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

800

(section["secfile"])),

801

"rb") as secfile:

802

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

803

else:

804

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

805

.format(section))

806

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

807

client["extended_timeout"] = string_to_delta(

808

section["extended_timeout"])

809

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

810

client["approval_delay"] = string_to_delta(

811

section["approval_delay"])

812

client["approval_duration"] = string_to_delta(

813

section["approval_duration"])

814

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

815

client["last_approval_request"] = None

816

client["last_checked_ok"] = None

817

client["last_checker_status"] = -2

818

819

return settings

820

821

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

337

822

self.name = name

338

if config is None:

339

config = {}

823

if server_settings is None:

824

server_settings = {}

825

self.server_settings = server_settings

826

# adding all client settings

827

for setting, value in settings.items():

828

setattr(self, setting, value)

829

830

if self.enabled:

831

if not hasattr(self, "last_enabled"):

832

self.last_enabled = datetime.datetime.utcnow()

833

if not hasattr(self, "expires"):

834

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

835

+ self.timeout)

836

else:

837

self.last_enabled = None

838

self.expires = None

839

340

840

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

341

# Uppercase and remove spaces from fingerprint for later

342

# comparison purposes with return value from the fingerprint()

343

# function

344

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

345

.replace(" ", ""))

346

841

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

347

if "secret" in config:

348

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

349

elif "secfile" in config:

350

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

351

(config["secfile"])),

352

"rb") as secfile:

353

self.secret = secfile.read()

354

else:

355

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

356

% self.name)

357

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

358

self.created = datetime.datetime.utcnow()

359

self.enabled = False

360

self.last_approval_request = None

361

self.last_enabled = None

362

self.last_checked_ok = None

363

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

364

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

365

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

366

self.disable_hook = disable_hook

842

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

843

datetime.datetime.utcnow())

844

845

# attributes specific for this server instance

367

846

self.checker = None

368

847

self.checker_initiator_tag = None

369

848

self.disable_initiator_tag = None

370

self.expires = None

371

849

self.checker_callback_tag = None

372

self.checker_command = config["checker"]

373

850

self.current_checker_command = None

374

self.last_connect = None

375

self._approved = None

376

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

377

True)

851

self.approved = None

378

852

self.approvals_pending = 0

379

self.approval_delay = string_to_delta(

380

config["approval_delay"])

381

self.approval_duration = string_to_delta(

382

config["approval_duration"])

383

self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())

853

self.changedstate = multiprocessing_manager.Condition(

854

multiprocessing_manager.Lock())

855

self.client_structure = [attr

856

for attr in self.__dict__.iterkeys()

857

if not attr.startswith("_")]

858

self.client_structure.append("client_structure")

859

860

for name, t in inspect.getmembers(

861

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

862

if not name.startswith("_"):

863

self.client_structure.append(name)

384

864

865

# Send notice to process children that client state has changed

385

866

def send_changedstate(self):

386

self.changedstate.acquire()

387

self.changedstate.notify_all()

388

self.changedstate.release()

389

867

with self.changedstate:

868

self.changedstate.notify_all()

869

390

870

def enable(self):

391

871

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

392

872

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

393

873

# Already enabled

394

874

return

395

self.send_changedstate()

396

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

397

# and every interval from then on.

398

self.checker_initiator_tag = (gobject.timeout_add

399

(self.interval_milliseconds(),

400

self.start_checker))

401

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

402

875

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

403

self.disable_initiator_tag = (gobject.timeout_add

404

(self.timeout_milliseconds(),

405

self.disable))

406

876

self.enabled = True

407

877

self.last_enabled = datetime.datetime.utcnow()

408

# Also start a new checker *right now*.

409

self.start_checker()

878

self.init_checker()

879

self.send_changedstate()

410

880

411

881

def disable(self, quiet=True):

412

882

"""Disable this client."""

413

883

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

414

884

return False

415

885

if not quiet:

416

self.send_changedstate()

417

if not quiet:

418

886

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

419

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

887

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

420

888

gobject.source_remove(self.disable_initiator_tag)

421

889

self.disable_initiator_tag = None

422

890

self.expires = None

423

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

891

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

424

892

gobject.source_remove(self.checker_initiator_tag)

425

893

self.checker_initiator_tag = None

426

894

self.stop_checker()

427

if self.disable_hook:

428

self.disable_hook(self)

429

895

self.enabled = False

896

if not quiet:

897

self.send_changedstate()

430

898

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

431

899

return False

432

900

433

901

def __del__(self):

434

self.disable_hook = None

435

902

self.disable()

436

903

437

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

904

def init_checker(self):

905

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

906

# and every interval from then on.

907

if self.checker_initiator_tag is not None:

908

gobject.source_remove(self.checker_initiator_tag)

909

self.checker_initiator_tag = gobject.timeout_add(

910

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

911

self.start_checker)

912

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

913

if self.disable_initiator_tag is not None:

914

gobject.source_remove(self.disable_initiator_tag)

915

self.disable_initiator_tag = gobject.timeout_add(

916

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

917

# Also start a new checker *right now*.

918

self.start_checker()

919

920

def checker_callback(self, source, condition, connection,

921

command):

438

922

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

439

923

self.checker_callback_tag = None

440

924

self.checker = None

441

if os.WIFEXITED(condition):

442

exitstatus = os.WEXITSTATUS(condition)

443

if exitstatus == 0:

925

# Read return code from connection (see call_pipe)

926

returncode = connection.recv()

927

connection.close()

928

929

if returncode >= 0:

930

self.last_checker_status = returncode

931

self.last_checker_signal = None

932

if self.last_checker_status == 0:

444

933

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

445

934

vars(self))

446

935

self.checked_ok()

447

936

else:

448

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

449

vars(self))

937

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

450

938

else:

939

self.last_checker_status = -1

940

self.last_checker_signal = -returncode

451

941

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

452

942

vars(self))

453

454

def checked_ok(self, timeout=None):

455

"""Bump up the timeout for this client.

456

457

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

458

alive and well.

459

"""

943

return False

944

945

def checked_ok(self):

946

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

947

self.last_checked_ok = datetime.datetime.utcnow()

948

self.last_checker_status = 0

949

self.last_checker_signal = None

950

self.bump_timeout()

951

952

def bump_timeout(self, timeout=None):

953

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

460

954

if timeout is None:

461

955

timeout = self.timeout

462

self.last_checked_ok = datetime.datetime.utcnow()

463

gobject.source_remove(self.disable_initiator_tag)

464

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

465

self.disable_initiator_tag = (gobject.timeout_add

466

(_timedelta_to_milliseconds(timeout),

467

self.disable))

956

if self.disable_initiator_tag is not None:

957

gobject.source_remove(self.disable_initiator_tag)

958

self.disable_initiator_tag = None

959

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

960

self.disable_initiator_tag = gobject.timeout_add(

961

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

962

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

468

963

469

964

def need_approval(self):

470

965

self.last_approval_request = datetime.datetime.utcnow()

475

970

If a checker already exists, leave it running and do

476

971

nothing."""

477

972

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

478

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

479

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

480

# client would inevitably timeout, since no checker would get

481

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

973

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

974

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

975

# would inevitably timeout, since no checker would get a

976

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

482

977

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

483

978

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

484

979

# should be.

485

980

486

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

487

try:

488

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

489

except (AttributeError, OSError) as error:

490

if (isinstance(error, OSError)

491

and error.errno != errno.ECHILD):

492

raise error

493

else:

494

if pid:

495

logger.warning("Checker was a zombie")

496

gobject.source_remove(self.checker_callback_tag)

497

self.checker_callback(pid, status,

498

self.current_checker_command)

981

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

982

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

983

self.checker.join()

984

self.checker = None

499

985

# Start a new checker if needed

500

986

if self.checker is None:

987

# Escape attributes for the shell

988

escaped_attrs = {

989

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

990

for attr in self.runtime_expansions }

501

991

try:

502

# In case checker_command has exactly one % operator

503

command = self.checker_command % self.host

504

except TypeError:

505

# Escape attributes for the shell

506

escaped_attrs = dict(

507

(attr,

508

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

509

errors=

510

'replace')))

511

for attr in

512

self.runtime_expansions)

513

514

try:

515

command = self.checker_command % escaped_attrs

516

except TypeError as error:

517

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

518

' %s', self.checker_command, error)

519

return True # Try again later

992

command = self.checker_command % escaped_attrs

993

except TypeError as error:

994

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

995

self.checker_command,

996

exc_info=error)

997

return True # Try again later

520

998

self.current_checker_command = command

521

try:

522

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

523

command, self.name)

524

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

525

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

526

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

527

# always replaced by /dev/null.)

528

self.checker = subprocess.Popen(command,

529

close_fds=True,

530

shell=True, cwd="/")

531

self.checker_callback_tag = (gobject.child_watch_add

532

(self.checker.pid,

533

self.checker_callback,

534

data=command))

535

# The checker may have completed before the gobject

536

# watch was added. Check for this.

537

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

538

if pid:

539

gobject.source_remove(self.checker_callback_tag)

540

self.checker_callback(pid, status, command)

541

except OSError as error:

542

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

543

error)

999

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

1000

self.name)

1001

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

1002

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

1003

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

1004

# always replaced by /dev/null.)

1005

# The exception is when not debugging but nevertheless

1006

# running in the foreground; use the previously

1007

# created wnull.

1008

popen_args = { "close_fds": True,

1009

"shell": True,

1010

"cwd": "/" }

1011

if (not self.server_settings["debug"]

1012

and self.server_settings["foreground"]):

1013

popen_args.update({"stdout": wnull,

1014

"stderr": wnull })

1015

pipe = multiprocessing.Pipe(duplex = False)

1016

self.checker = multiprocessing.Process(

1017

target = call_pipe,

1018

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

1019

kwargs = popen_args)

1020

self.checker.start()

1021

self.checker_callback_tag = gobject.io_add_watch(

1022

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

1023

self.checker_callback, pipe[0], command)

544

1024

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

545

1025

return True

546

1026

552

1032

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

553

1033

return

554

1034

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

555

try:

556

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

557

#time.sleep(0.5)

558

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

559

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

560

except OSError as error:

561

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

562

raise

1035

self.checker.terminate()

563

1036

self.checker = None

564

1037

565

1038

566

def dbus_service_property(dbus_interface, signature="v",

567

access="readwrite", byte_arrays=False):

1039

def dbus_service_property(dbus_interface,

1040

signature="v",

1041

access="readwrite",

1042

byte_arrays=False):

568

1043

"""Decorators for marking methods of a DBusObjectWithProperties to

569

1044

become properties on the D-Bus.

570

1045

579

1054

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

580

1055

if byte_arrays and signature != "ay":

581

1056

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

582

" signature %r" % signature)

1057

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

1058

583

1059

def decorator(func):

584

1060

func._dbus_is_property = True

585

1061

func._dbus_interface = dbus_interface

590

1066

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

591

1067

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

592

1068

return func

1069

1070

return decorator

1071

1072

1073

def dbus_interface_annotations(dbus_interface):

1074

"""Decorator for marking functions returning interface annotations

1075

1076

Usage:

1077

1078

@dbus_interface_annotations("org.example.Interface")

1079

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

1080

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

1081

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

1082

"false"}

1083

"""

1084

1085

def decorator(func):

1086

func._dbus_is_interface = True

1087

func._dbus_interface = dbus_interface

1088

func._dbus_name = dbus_interface

1089

return func

1090

1091

return decorator

1092

1093

1094

def dbus_annotations(annotations):

1095

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

1096

Usage:

1097

1098

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

1099

"org.freedesktop.DBus.Property."

1100

"EmitsChangedSignal": "false"})

1101

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

1102

access="r")

1103

def Property_dbus_property(self):

1104

return dbus.Boolean(False)

1105

1106

See also the DBusObjectWithAnnotations class.

1107

"""

1108

1109

def decorator(func):

1110

func._dbus_annotations = annotations

1111

return func

1112

593

1113

return decorator

594

1114

595

1115

596

1116

class DBusPropertyException(dbus.exceptions.DBusException):

597

1117

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

598

1118

"""

599

def __unicode__(self):

600

return unicode(str(self))

1119

pass

601

1120

602

1121

603

1122

class DBusPropertyAccessException(DBusPropertyException):

612

1131

pass

613

1132

614

1133

615

class DBusObjectWithProperties(dbus.service.Object):

1134

class DBusObjectWithAnnotations(dbus.service.Object):

1135

"""A D-Bus object with annotations.

1136

1137

Classes inheriting from this can use the dbus_annotations

1138

decorator to add annotations to methods or signals.

1139

"""

1140

1141

@staticmethod

1142

def _is_dbus_thing(thing):

1143

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

1144

1145

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

1146

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

1147

"""

1148

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

1149

False)

1150

1151

def _get_all_dbus_things(self, thing):

1152

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

1153

"""

1154

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

1155

athing.__get__(self))

1156

for cls in self.__class__.__mro__

1157

for name, athing in

1158

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

1159

1160

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1161

out_signature = "s",

1162

path_keyword = 'object_path',

1163

connection_keyword = 'connection')

1164

def Introspect(self, object_path, connection):

1165

"""Overloading of standard D-Bus method.

1166

1167

Inserts annotation tags on methods and signals.

1168

"""

1169

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

1170

connection)

1171

try:

1172

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

1173

1174

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

1175

# Add annotation tags

1176

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

1177

for tag in if_tag.getElementsByTagName(typ):

1178

annots = dict()

1179

for name, prop in (self.

1180

_get_all_dbus_things(typ)):

1181

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

1182

and prop._dbus_interface

1183

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

1184

annots.update(getattr(

1185

prop, "_dbus_annotations", {}))

1186

for name, value in annots.items():

1187

ann_tag = document.createElement(

1188

"annotation")

1189

ann_tag.setAttribute("name", name)

1190

ann_tag.setAttribute("value", value)

1191

tag.appendChild(ann_tag)

1192

# Add interface annotation tags

1193

for annotation, value in dict(

1194

itertools.chain.from_iterable(

1195

annotations().items()

1196

for name, annotations

1197

in self._get_all_dbus_things("interface")

1198

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

1199

)).items():

1200

ann_tag = document.createElement("annotation")

1201

ann_tag.setAttribute("name", annotation)

1202

ann_tag.setAttribute("value", value)

1203

if_tag.appendChild(ann_tag)

1204

# Fix argument name for the Introspect method itself

1205

if (if_tag.getAttribute("name")

1206

== dbus.INTROSPECTABLE_IFACE):

1207

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

1208

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

1209

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

1210

if (arg.getAttribute("direction")

1211

== "out"):

1212

arg.setAttribute("name",

1213

"xml_data")

1214

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

1215

document.unlink()

1216

except (AttributeError, xml.dom.DOMException,

1217

xml.parsers.expat.ExpatError) as error:

1218

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

1219

exc_info=error)

1220

return xmlstring

1221

1222

1223

class DBusObjectWithProperties(DBusObjectWithAnnotations):

616

1224

"""A D-Bus object with properties.

617

1225

618

1226

Classes inheriting from this can use the dbus_service_property

620

1228

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

621

1229

"""

622

1230

623

@staticmethod

624

def _is_dbus_property(obj):

625

return getattr(obj, "_dbus_is_property", False)

626

627

def _get_all_dbus_properties(self):

628

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

629

"""

630

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

631

for cls in self.__class__.__mro__

632

for name, prop in inspect.getmembers(cls, self._is_dbus_property))

633

634

1231

def _get_dbus_property(self, interface_name, property_name):

635

1232

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

636

1233

property with the specified name and interface.

637

1234

"""

638

for cls in self.__class__.__mro__:

639

for name, value in inspect.getmembers(cls, self._is_dbus_property):

640

if value._dbus_name == property_name and value._dbus_interface == interface_name:

1235

for cls in self.__class__.__mro__:

1236

for name, value in inspect.getmembers(

1237

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

1238

if (value._dbus_name == property_name

1239

and value._dbus_interface == interface_name):

641

1240

return value.__get__(self)

642

1241

643

1242

# No such property

644

raise DBusPropertyNotFound(self.dbus_object_path + ":"

645

+ interface_name + "."

646

+ property_name)

647

648

649

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

1243

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

1244

self.dbus_object_path, interface_name, property_name))

1245

1246

@classmethod

1247

def _get_all_interface_names(cls):

1248

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

1249

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

1250

"_dbus_interface", None)

1251

for x in (inspect.getmro(cls))

1252

for attr in dir(x))

1253

if name is not None)

1254

1255

@dbus.service.method(dbus.PROPERTIES_IFACE,

1256

in_signature="ss",

650

1257

out_signature="v")

651

1258

def Get(self, interface_name, property_name):

652

1259

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

670

1277

# The byte_arrays option is not supported yet on

671

1278

# signatures other than "ay".

672

1279

if prop._dbus_signature != "ay":

673

raise ValueError

674

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

675

for byte in value))

1280

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

1281

"'ay' signature {!r}"

1282

.format(prop._dbus_signature))

1283

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

1284

for byte in value))

676

1285

prop(value)

677

1286

678

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

1287

@dbus.service.method(dbus.PROPERTIES_IFACE,

1288

in_signature="s",

679

1289

out_signature="a{sv}")

680

1290

def GetAll(self, interface_name):

681

1291

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

683

1293

684

1294

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

685

1295

"""

686

all = {}

687

for name, prop in self._get_all_dbus_properties():

1296

properties = {}

1297

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

688

1298

if (interface_name

689

1299

and interface_name != prop._dbus_interface):

690

1300

# Interface non-empty but did not match

694

1304

continue

695

1305

value = prop()

696

1306

if not hasattr(value, "variant_level"):

697

all[name] = value

1307

properties[name] = value

698

1308

continue

699

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

700

value.variant_level+1)

701

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

1309

properties[name] = type(value)(

1310

value, variant_level = value.variant_level + 1)

1311

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

1312

1313

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

1314

def PropertiesChanged(self, interface_name, changed_properties,

1315

invalidated_properties):

1316

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

1317

standard.

1318

"""

1319

pass

702

1320

703

1321

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

704

1322

out_signature="s",

705

1323

path_keyword='object_path',

706

1324

connection_keyword='connection')

707

1325

def Introspect(self, object_path, connection):

708

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

1326

"""Overloading of standard D-Bus method.

1327

1328

Inserts property tags and interface annotation tags.

709

1329

"""

710

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

711

connection)

1330

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1331

object_path,

1332

connection)

712

1333

try:

713

1334

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

1335

714

1336

def make_tag(document, name, prop):

715

1337

e = document.createElement("property")

716

1338

e.setAttribute("name", name)

717

1339

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

718

1340

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

719

1341

return e

1342

720

1343

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

1344

# Add property tags

721

1345

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

722

1346

for name, prop

723

in self._get_all_dbus_properties()

1347

in self._get_all_dbus_things("property")

724

1348

if prop._dbus_interface

725

1349

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

726

1350

if_tag.appendChild(tag)

1351

# Add annotation tags for properties

1352

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

1353

annots = dict()

1354

for name, prop in self._get_all_dbus_things(

1355

"property"):

1356

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

1357

and prop._dbus_interface

1358

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

1359

annots.update(getattr(

1360

prop, "_dbus_annotations", {}))

1361

for name, value in annots.items():

1362

ann_tag = document.createElement(

1363

"annotation")

1364

ann_tag.setAttribute("name", name)

1365

ann_tag.setAttribute("value", value)

1366

tag.appendChild(ann_tag)

727

1367

# Add the names to the return values for the

728

1368

# "org.freedesktop.DBus.Properties" methods

729

1369

if (if_tag.getAttribute("name")

744

1384

except (AttributeError, xml.dom.DOMException,

745

1385

xml.parsers.expat.ExpatError) as error:

746

1386

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

747

error)

748

return xmlstring

749

750

751

def datetime_to_dbus (dt, variant_level=0):

1387

exc_info=error)

1388

return xmlstring

1389

1390

try:

1391

dbus.OBJECT_MANAGER_IFACE

1392

except AttributeError:

1393

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

1394

1395

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1396

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

1397

1398

Classes inheriting from this exposes the standard

1399

GetManagedObjects call and the InterfacesAdded and

1400

InterfacesRemoved signals on the standard

1401

"org.freedesktop.DBus.ObjectManager" interface.

1402

1403

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

1404

manually.

1405

"""

1406

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1407

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

1408

def GetManagedObjects(self):

1409

"""This function must be overridden"""

1410

raise NotImplementedError()

1411

1412

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1413

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

1414

def InterfacesAdded(self, object_path, interfaces_and_properties):

1415

pass

1416

1417

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

1418

def InterfacesRemoved(self, object_path, interfaces):

1419

pass

1420

1421

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1422

out_signature = "s",

1423

path_keyword = 'object_path',

1424

connection_keyword = 'connection')

1425

def Introspect(self, object_path, connection):

1426

"""Overloading of standard D-Bus method.

1427

1428

Override return argument name of GetManagedObjects to be

1429

"objpath_interfaces_and_properties"

1430

"""

1431

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1432

object_path,

1433

connection)

1434

try:

1435

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

1436

1437

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

1438

# Fix argument name for the GetManagedObjects method

1439

if (if_tag.getAttribute("name")

1440

== dbus.OBJECT_MANAGER_IFACE):

1441

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

1442

if (cn.getAttribute("name")

1443

== "GetManagedObjects"):

1444

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

1445

if (arg.getAttribute("direction")

1446

== "out"):

1447

arg.setAttribute(

1448

"name",

1449

"objpath_interfaces"

1450

"_and_properties")

1451

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

1452

document.unlink()

1453

except (AttributeError, xml.dom.DOMException,

1454

xml.parsers.expat.ExpatError) as error:

1455

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

1456

exc_info = error)

1457

return xmlstring

1458

1459

def datetime_to_dbus(dt, variant_level=0):

752

1460

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

753

1461

if dt is None:

754

1462

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

755

return dbus.String(dt.isoformat(),

756

variant_level=variant_level)

757

758

class transitional_dbus_metaclass(DBusObjectWithProperties.__metaclass__):

759

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

760

for attrname, old_dbusobj in inspect.getmembers(bases[0]):

761

new_interface = getattr(old_dbusobj, "_dbus_interface", "").replace("se.bsnet.fukt.", "se.recompile.")

762

if (getattr(old_dbusobj, "_dbus_is_signal", False)

763

and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):

764

unwrappedfunc = dict(zip(old_dbusobj.func_code.co_freevars,

765

old_dbusobj.__closure__))["func"].cell_contents

766

newfunc = types.FunctionType(unwrappedfunc.func_code,

767

unwrappedfunc.func_globals,

768

unwrappedfunc.func_name,

769

unwrappedfunc.func_defaults,

770

unwrappedfunc.func_closure)

771

new_dbusfunc = dbus.service.signal(

772

new_interface, old_dbusobj._dbus_signature)(newfunc)

773

attr["_transitional_" + attrname] = new_dbusfunc

774

775

def fixscope(func1, func2):

776

def newcall(*args, **kwargs):

777

func1(*args, **kwargs)

778

func2(*args, **kwargs)

779

return newcall

780

781

attr[attrname] = fixscope(old_dbusobj, new_dbusfunc)

782

783

elif (getattr(old_dbusobj, "_dbus_is_method", False)

784

and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):

785

new_dbusfunc = (dbus.service.method

786

(new_interface,

787

old_dbusobj._dbus_in_signature,

788

old_dbusobj._dbus_out_signature)

789

(types.FunctionType

790

(old_dbusobj.func_code,

791

old_dbusobj.func_globals,

792

old_dbusobj.func_name,

793

old_dbusobj.func_defaults,

794

old_dbusobj.func_closure)))

795

796

attr[attrname] = new_dbusfunc

797

elif (getattr(old_dbusobj, "_dbus_is_property", False)

798

and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):

799

new_dbusfunc = (dbus_service_property

800

(new_interface,

801

old_dbusobj._dbus_signature,

802

old_dbusobj._dbus_access,

803

old_dbusobj._dbus_get_args_options["byte_arrays"])

804

(types.FunctionType

805

(old_dbusobj.func_code,

806

old_dbusobj.func_globals,

807

old_dbusobj.func_name,

808

old_dbusobj.func_defaults,

809

old_dbusobj.func_closure)))

810

811

attr[attrname] = new_dbusfunc

812

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

813

1463

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

1464

1465

1466

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1467

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

1468

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

1469

interface names according to the "alt_interface_names" mapping.

1470

Usage:

1471

1472

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

1473

"net.example.AlternateInterface"})

1474

class SampleDBusObject(dbus.service.Object):

1475

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

1476

def SampleDBusMethod():

1477

pass

1478

1479

The above "SampleDBusMethod" on "SampleDBusObject" will be

1480

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

1481

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

1482

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

1483

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

1484

1485

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

1486

(from DBusObjectWithProperties) and interfaces (from the

1487

dbus_interface_annotations decorator).

1488

"""

1489

1490

def wrapper(cls):

1491

for orig_interface_name, alt_interface_name in (

1492

alt_interface_names.items()):

1493

attr = {}

1494

interface_names = set()

1495

# Go though all attributes of the class

1496

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

1497

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

1498

# with the wrong interface name

1499

if (not hasattr(attribute, "_dbus_interface")

1500

or not attribute._dbus_interface.startswith(

1501

orig_interface_name)):

1502

continue

1503

# Create an alternate D-Bus interface name based on

1504

# the current name

1505

alt_interface = attribute._dbus_interface.replace(

1506

orig_interface_name, alt_interface_name)

1507

interface_names.add(alt_interface)

1508

# Is this a D-Bus signal?

1509

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

1510

if sys.version_info.major == 2:

1511

# Extract the original non-method undecorated

1512

# function by black magic

1513

nonmethod_func = (dict(

1514

zip(attribute.func_code.co_freevars,

1515

attribute.__closure__))

1516

["func"].cell_contents)

1517

else:

1518

nonmethod_func = attribute

1519

# Create a new, but exactly alike, function

1520

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

1521

# with the alternate D-Bus interface name

1522

if sys.version_info.major == 2:

1523

new_function = types.FunctionType(

1524

nonmethod_func.func_code,

1525

nonmethod_func.func_globals,

1526

nonmethod_func.func_name,

1527

nonmethod_func.func_defaults,

1528

nonmethod_func.func_closure)

1529

else:

1530

new_function = types.FunctionType(

1531

nonmethod_func.__code__,

1532

nonmethod_func.__globals__,

1533

nonmethod_func.__name__,

1534

nonmethod_func.__defaults__,

1535

nonmethod_func.__closure__)

1536

new_function = (dbus.service.signal(

1537

alt_interface,

1538

attribute._dbus_signature)(new_function))

1539

# Copy annotations, if any

1540

try:

1541

new_function._dbus_annotations = dict(

1542

attribute._dbus_annotations)

1543

except AttributeError:

1544

pass

1545

# Define a creator of a function to call both the

1546

# original and alternate functions, so both the

1547

# original and alternate signals gets sent when

1548

# the function is called

1549

def fixscope(func1, func2):

1550

"""This function is a scope container to pass

1551

func1 and func2 to the "call_both" function

1552

outside of its arguments"""

1553

1554

@functools.wraps(func2)

1555

def call_both(*args, **kwargs):

1556

"""This function will emit two D-Bus

1557

signals by calling func1 and func2"""

1558

func1(*args, **kwargs)

1559

func2(*args, **kwargs)

1560

# Make wrapper function look like a D-Bus signal

1561

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

1562

if name.startswith("_dbus_"):

1563

setattr(call_both, name, attr)

1564

1565

return call_both

1566

# Create the "call_both" function and add it to

1567

# the class

1568

attr[attrname] = fixscope(attribute, new_function)

1569

# Is this a D-Bus method?

1570

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

1571

# Create a new, but exactly alike, function

1572

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

1573

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

1574

# to the class.

1575

attr[attrname] = (

1576

dbus.service.method(

1577

alt_interface,

1578

attribute._dbus_in_signature,

1579

attribute._dbus_out_signature)

1580

(types.FunctionType(attribute.func_code,

1581

attribute.func_globals,

1582

attribute.func_name,

1583

attribute.func_defaults,

1584

attribute.func_closure)))

1585

# Copy annotations, if any

1586

try:

1587

attr[attrname]._dbus_annotations = dict(

1588

attribute._dbus_annotations)

1589

except AttributeError:

1590

pass

1591

# Is this a D-Bus property?

1592

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

1593

# Create a new, but exactly alike, function

1594

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

1595

# property with the alternate D-Bus interface

1596

# name. Add it to the class.

1597

attr[attrname] = (dbus_service_property(

1598

alt_interface, attribute._dbus_signature,

1599

attribute._dbus_access,

1600

attribute._dbus_get_args_options

1601

["byte_arrays"])

1602

(types.FunctionType(

1603

attribute.func_code,

1604

attribute.func_globals,

1605

attribute.func_name,

1606

attribute.func_defaults,

1607

attribute.func_closure)))

1608

# Copy annotations, if any

1609

try:

1610

attr[attrname]._dbus_annotations = dict(

1611

attribute._dbus_annotations)

1612

except AttributeError:

1613

pass

1614

# Is this a D-Bus interface?

1615

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

1616

# Create a new, but exactly alike, function

1617

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

1618

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

1619

# to the class.

1620

attr[attrname] = (

1621

dbus_interface_annotations(alt_interface)

1622

(types.FunctionType(attribute.func_code,

1623

attribute.func_globals,

1624

attribute.func_name,

1625

attribute.func_defaults,

1626

attribute.func_closure)))

1627

if deprecate:

1628

# Deprecate all alternate interfaces

1629

iname="_AlternateDBusNames_interface_annotation{}"

1630

for interface_name in interface_names:

1631

1632

@dbus_interface_annotations(interface_name)

1633

def func(self):

1634

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

1635

"true" }

1636

# Find an unused name

1637

for aname in (iname.format(i)

1638

for i in itertools.count()):

1639

if aname not in attr:

1640

attr[aname] = func

1641

break

1642

if interface_names:

1643

# Replace the class with a new subclass of it with

1644

# methods, signals, etc. as created above.

1645

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

1646

(cls, ), attr)

1647

return cls

1648

1649

return wrapper

1650

1651

1652

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

1653

"se.bsnet.fukt.Mandos"})

814

1654

class ClientDBus(Client, DBusObjectWithProperties):

815

1655

"""A Client class using D-Bus

816

1656

820

1660

"""

821

1661

822

1662

runtime_expansions = (Client.runtime_expansions

823

+ ("dbus_object_path",))

1663

+ ("dbus_object_path", ))

1664

1665

_interface = "se.recompile.Mandos.Client"

824

1666

825

1667

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

826

1668

827

1669

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

828

self._approvals_pending = 0

829

1670

self.bus = bus

830

1671

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

831

1672

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

832

1673

# the D-Bus

833

client_object_name = unicode(self.name).translate(

1674

client_object_name = str(self.name).translate(

834

1675

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

835

1676

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

836

self.dbus_object_path = (dbus.ObjectPath

837

("/clients/" + client_object_name))

1677

self.dbus_object_path = dbus.ObjectPath(

1678

"/clients/" + client_object_name)

838

1679

DBusObjectWithProperties.__init__(self, self.bus,

839

1680

self.dbus_object_path)

1681

1682

def notifychangeproperty(transform_func, dbus_name,

1683

type_func=lambda x: x,

1684

variant_level=1,

1685

invalidate_only=False,

1686

_interface=_interface):

1687

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

1688

its changes to DBus.

840

1689

841

def notifychangeproperty(transform_func,

842

dbus_name, type_func=lambda x: x,

843

variant_level=1):

844

""" Modify a variable so that its a property that announce its

845

changes to DBus.

846

transform_fun: Function that takes a value and transform it to

847

DBus type.

848

dbus_name: DBus name of the variable

1690

transform_fun: Function that takes a value and a variant_level

1691

and transforms it to a D-Bus type.

1692

dbus_name: D-Bus name of the variable

849

1693

type_func: Function that transform the value before sending it

850

to DBus

851

variant_level: DBus variant level. default: 1

1694

to the D-Bus. Default: no transform

1695

variant_level: D-Bus variant level. Default: 1

852

1696

"""

853

real_value = [None,]

1697

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

1698

854

1699

def setter(self, value):

855

old_value = real_value[0]

856

real_value[0] = value

857

1700

if hasattr(self, "dbus_object_path"):

858

if type_func(old_value) != type_func(real_value[0]):

859

dbus_value = transform_func(type_func(real_value[0]),

860

variant_level)

861

self.PropertyChanged(dbus.String(dbus_name),

862

dbus_value)

1701

if (not hasattr(self, attrname) or

1702

type_func(getattr(self, attrname, None))

1703

!= type_func(value)):

1704

if invalidate_only:

1705

self.PropertiesChanged(

1706

_interface, dbus.Dictionary(),

1707

dbus.Array((dbus_name, )))

1708

else:

1709

dbus_value = transform_func(

1710

type_func(value),

1711

variant_level = variant_level)

1712

self.PropertyChanged(dbus.String(dbus_name),

1713

dbus_value)

1714

self.PropertiesChanged(

1715

_interface,

1716

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

1717

dbus_value }),

1718

dbus.Array())

1719

setattr(self, attrname, value)

863

1720

864

return property(lambda self: real_value[0], setter)

865

1721

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

866

1722

867

1723

expires = notifychangeproperty(datetime_to_dbus, "Expires")

868

1724

approvals_pending = notifychangeproperty(dbus.Boolean,

871

1727

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

872

1728

last_enabled = notifychangeproperty(datetime_to_dbus,

873

1729

"LastEnabled")

874

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

875

type_func = lambda checker: checker is not None)

1730

checker = notifychangeproperty(

1731

dbus.Boolean, "CheckerRunning",

1732

type_func = lambda checker: checker is not None)

876

1733

last_checked_ok = notifychangeproperty(datetime_to_dbus,

877

1734

"LastCheckedOK")

878

last_approval_request = notifychangeproperty(datetime_to_dbus,

879

"LastApprovalRequest")

1735

last_checker_status = notifychangeproperty(dbus.Int16,

1736

"LastCheckerStatus")

1737

last_approval_request = notifychangeproperty(

1738

datetime_to_dbus, "LastApprovalRequest")

880

1739

approved_by_default = notifychangeproperty(dbus.Boolean,

881

1740

"ApprovedByDefault")

882

approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",

883

type_func = _timedelta_to_milliseconds)

884

approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",

885

type_func = _timedelta_to_milliseconds)

1741

approval_delay = notifychangeproperty(

1742

dbus.UInt64, "ApprovalDelay",

1743

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

1744

approval_duration = notifychangeproperty(

1745

dbus.UInt64, "ApprovalDuration",

1746

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

886

1747

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

887

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

888

type_func = _timedelta_to_milliseconds)

889

extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",

890

type_func = _timedelta_to_milliseconds)

891

interval = notifychangeproperty(dbus.UInt16, "Interval",

892

type_func = _timedelta_to_milliseconds)

1748

timeout = notifychangeproperty(

1749

dbus.UInt64, "Timeout",

1750

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

1751

extended_timeout = notifychangeproperty(

1752

dbus.UInt64, "ExtendedTimeout",

1753

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

1754

interval = notifychangeproperty(

1755

dbus.UInt64, "Interval",

1756

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

893

1757

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

1758

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

1759

invalidate_only=True)

894

1760

895

1761

del notifychangeproperty

896

1762

903

1769

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

904

1770

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

905

1771

906

def checker_callback(self, pid, condition, command,

907

*args, **kwargs):

908

self.checker_callback_tag = None

909

self.checker = None

910

if os.WIFEXITED(condition):

911

exitstatus = os.WEXITSTATUS(condition)

1772

def checker_callback(self, source, condition,

1773

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

1774

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

1775

connection, command, *args,

1776

**kwargs)

1777

exitstatus = self.last_checker_status

1778

if exitstatus >= 0:

912

1779

# Emit D-Bus signal

913

1780

self.CheckerCompleted(dbus.Int16(exitstatus),

914

dbus.Int64(condition),

1781

# This is specific to GNU libC

1782

dbus.Int64(exitstatus << 8),

915

1783

dbus.String(command))

916

1784

else:

917

1785

# Emit D-Bus signal

918

1786

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

919

dbus.Int64(condition),

1787

dbus.Int64(

1788

# This is specific to GNU libC

1789

(exitstatus << 8)

1790

| self.last_checker_signal),

920

1791

dbus.String(command))

921

922

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

923

*args, **kwargs)

1792

return ret

924

1793

925

1794

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

926

old_checker = self.checker

927

if self.checker is not None:

928

old_checker_pid = self.checker.pid

929

else:

930

old_checker_pid = None

1795

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

931

1796

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

932

1797

# Only if new checker process was started

933

1798

if (self.checker is not None

937

1802

return r

938

1803

939

1804

def _reset_approved(self):

940

self._approved = None

1805

self.approved = None

941

1806

return False

942

1807

943

1808

def approve(self, value=True):

1809

self.approved = value

1810

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

1811

* 1000), self._reset_approved)

944

1812

self.send_changedstate()

945

self._approved = value

946

gobject.timeout_add(_timedelta_to_milliseconds

947

(self.approval_duration),

948

self._reset_approved)

949

950

1813

951

1814

## D-Bus methods, signals & properties

952

_interface = "se.bsnet.fukt.Mandos.Client"

953

1815

1816

## Interfaces

1817

954

1818

## Signals

955

1819

956

1820

# CheckerCompleted - signal

966

1830

pass

967

1831

968

1832

# PropertyChanged - signal

1833

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

969

1834

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

970

1835

def PropertyChanged(self, property, value):

971

1836

"D-Bus signal"

1005

1870

self.checked_ok()

1006

1871

1007

1872

# Enable - method

1873

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

1008

1874

@dbus.service.method(_interface)

1009

1875

def Enable(self):

1010

1876

"D-Bus method"

1011

1877

self.enable()

1012

1878

1013

1879

# StartChecker - method

1880

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

1014

1881

@dbus.service.method(_interface)

1015

1882

def StartChecker(self):

1016

1883

"D-Bus method"

1017

1884

self.start_checker()

1018

1885

1019

1886

# Disable - method

1887

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

1020

1888

@dbus.service.method(_interface)

1021

1889

def Disable(self):

1022

1890

"D-Bus method"

1023

1891

self.disable()

1024

1892

1025

1893

# StopChecker - method

1894

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

1026

1895

@dbus.service.method(_interface)

1027

1896

def StopChecker(self):

1028

1897

self.stop_checker()

1035

1904

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

1036

1905

1037

1906

# ApprovedByDefault - property

1038

@dbus_service_property(_interface, signature="b",

1907

@dbus_service_property(_interface,

1908

signature="b",

1039

1909

access="readwrite")

1040

1910

def ApprovedByDefault_dbus_property(self, value=None):

1041

1911

if value is None: # get

1043

1913

self.approved_by_default = bool(value)

1044

1914

1045

1915

# ApprovalDelay - property

1046

@dbus_service_property(_interface, signature="t",

1916

@dbus_service_property(_interface,

1917

signature="t",

1047

1918

access="readwrite")

1048

1919

def ApprovalDelay_dbus_property(self, value=None):

1049

1920

if value is None: # get

1050

return dbus.UInt64(self.approval_delay_milliseconds())

1921

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

1922

* 1000)

1051

1923

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

1052

1924

1053

1925

# ApprovalDuration - property

1054

@dbus_service_property(_interface, signature="t",

1926

@dbus_service_property(_interface,

1927

signature="t",

1055

1928

access="readwrite")

1056

1929

def ApprovalDuration_dbus_property(self, value=None):

1057

1930

if value is None: # get

1058

return dbus.UInt64(_timedelta_to_milliseconds(

1059

self.approval_duration))

1931

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

1932

* 1000)

1060

1933

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

1061

1934

1062

1935

# Name - property

1936

@dbus_annotations(

1937

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

1063

1938

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

1064

1939

def Name_dbus_property(self):

1065

1940

return dbus.String(self.name)

1066

1941

1067

1942

# Fingerprint - property

1943

@dbus_annotations(

1944

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

1068

1945

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

1069

1946

def Fingerprint_dbus_property(self):

1070

1947

return dbus.String(self.fingerprint)

1071

1948

1072

1949

# Host - property

1073

@dbus_service_property(_interface, signature="s",

1950

@dbus_service_property(_interface,

1951

signature="s",

1074

1952

access="readwrite")

1075

1953

def Host_dbus_property(self, value=None):

1076

1954

if value is None: # get

1077

1955

return dbus.String(self.host)

1078

self.host = value

1956

self.host = str(value)

1079

1957

1080

1958

# Created - property

1959

@dbus_annotations(

1960

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

1081

1961

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

1082

1962

def Created_dbus_property(self):

1083

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

1963

return datetime_to_dbus(self.created)

1084

1964

1085

1965

# LastEnabled - property

1086

1966

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

1088

1968

return datetime_to_dbus(self.last_enabled)

1089

1969

1090

1970

# Enabled - property

1091

@dbus_service_property(_interface, signature="b",

1971

@dbus_service_property(_interface,

1972

signature="b",

1092

1973

access="readwrite")

1093

1974

def Enabled_dbus_property(self, value=None):

1094

1975

if value is None: # get

1099

1980

self.disable()

1100

1981

1101

1982

# LastCheckedOK - property

1102

@dbus_service_property(_interface, signature="s",

1983

@dbus_service_property(_interface,

1984

signature="s",

1103

1985

access="readwrite")

1104

1986

def LastCheckedOK_dbus_property(self, value=None):

1105

1987

if value is not None:

1107

1989

return

1108

1990

return datetime_to_dbus(self.last_checked_ok)

1109

1991

1992

# LastCheckerStatus - property

1993

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

1994

def LastCheckerStatus_dbus_property(self):

1995

return dbus.Int16(self.last_checker_status)

1996

1110

1997

# Expires - property

1111

1998

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

1112

1999

def Expires_dbus_property(self):

1118

2005

return datetime_to_dbus(self.last_approval_request)

1119

2006

1120

2007

# Timeout - property

1121

@dbus_service_property(_interface, signature="t",

2008

@dbus_service_property(_interface,

2009

signature="t",

1122

2010

access="readwrite")

1123

2011

def Timeout_dbus_property(self, value=None):

1124

2012

if value is None: # get

1125

return dbus.UInt64(self.timeout_milliseconds())

2013

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

2014

old_timeout = self.timeout

1126

2015

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

1127

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

1128

return

1129

# Reschedule timeout

1130

gobject.source_remove(self.disable_initiator_tag)

1131

self.disable_initiator_tag = None

1132

self.expires = None

1133

time_to_die = (self.

1134

_timedelta_to_milliseconds((self

1135

.last_checked_ok

1136

+ self.timeout)

1137

- datetime.datetime

1138

.utcnow()))

1139

if time_to_die <= 0:

1140

# The timeout has passed

1141

self.disable()

1142

else:

1143

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

1144

+ datetime.timedelta(milliseconds = time_to_die))

1145

self.disable_initiator_tag = (gobject.timeout_add

1146

(time_to_die, self.disable))

2016

# Reschedule disabling

2017

if self.enabled:

2018

now = datetime.datetime.utcnow()

2019

self.expires += self.timeout - old_timeout

2020

if self.expires <= now:

2021

# The timeout has passed

2022

self.disable()

2023

else:

2024

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

2025

is None):

2026

return

2027

gobject.source_remove(self.disable_initiator_tag)

2028

self.disable_initiator_tag = gobject.timeout_add(

2029

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

2030

self.disable)

1147

2031

1148

2032

# ExtendedTimeout - property

1149

@dbus_service_property(_interface, signature="t",

2033

@dbus_service_property(_interface,

2034

signature="t",

1150

2035

access="readwrite")

1151

2036

def ExtendedTimeout_dbus_property(self, value=None):

1152

2037

if value is None: # get

1153

return dbus.UInt64(self.extended_timeout_milliseconds())

2038

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

2039

* 1000)

1154

2040

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

1155

2041

1156

2042

# Interval - property

1157

@dbus_service_property(_interface, signature="t",

2043

@dbus_service_property(_interface,

2044

signature="t",

1158

2045

access="readwrite")

1159

2046

def Interval_dbus_property(self, value=None):

1160

2047

if value is None: # get

1161

return dbus.UInt64(self.interval_milliseconds())

2048

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

1162

2049

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

1163

2050

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

1164

2051

return

1165

# Reschedule checker run

1166

gobject.source_remove(self.checker_initiator_tag)

1167

self.checker_initiator_tag = (gobject.timeout_add

1168

(value, self.start_checker))

1169

self.start_checker() # Start one now, too

2052

if self.enabled:

2053

# Reschedule checker run

2054

gobject.source_remove(self.checker_initiator_tag)

2055

self.checker_initiator_tag = gobject.timeout_add(

2056

value, self.start_checker)

2057

self.start_checker() # Start one now, too

1170

2058

1171

2059

# Checker - property

1172

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1173

2062

access="readwrite")

1174

2063

def Checker_dbus_property(self, value=None):

1175

2064

if value is None: # get

1176

2065

return dbus.String(self.checker_command)

1177

self.checker_command = value

2066

self.checker_command = str(value)

1178

2067

1179

2068

# CheckerRunning - property

1180

@dbus_service_property(_interface, signature="b",

2069

@dbus_service_property(_interface,

2070

signature="b",

1181

2071

access="readwrite")

1182

2072

def CheckerRunning_dbus_property(self, value=None):

1183

2073

if value is None: # get

1188

2078

self.stop_checker()

1189

2079

1190

2080

# ObjectPath - property

2081

@dbus_annotations(

2082

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

2083

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

1191

2084

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

1192

2085

def ObjectPath_dbus_property(self):

1193

2086

return self.dbus_object_path # is already a dbus.ObjectPath

1194

2087

1195

2088

# Secret = property

1196

@dbus_service_property(_interface, signature="ay",

1197

access="write", byte_arrays=True)

2089

@dbus_annotations(

2090

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

2091

"invalidates"})

2092

@dbus_service_property(_interface,

2093

signature="ay",

2094

access="write",

2095

byte_arrays=True)

1198

2096

def Secret_dbus_property(self, value):

1199

self.secret = str(value)

2097

self.secret = bytes(value)

1200

2098

1201

2099

del _interface

1202

2100

1206

2104

self._pipe = child_pipe

1207

2105

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

1208

2106

if not self._pipe.recv():

1209

raise KeyError()

2107

raise KeyError(fpr)

1210

2108

1211

2109

def __getattribute__(self, name):

1212

if(name == '_pipe'):

2110

if name == '_pipe':

1213

2111

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

1214

2112

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

1215

2113

data = self._pipe.recv()

1216

2114

if data[0] == 'data':

1217

2115

return data[1]

1218

2116

if data[0] == 'function':

2117

1219

2118

def func(*args, **kwargs):

1220

2119

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

1221

2120

return self._pipe.recv()[1]

2121

1222

2122

return func

1223

2123

1224

2124

def __setattr__(self, name, value):

1225

if(name == '_pipe'):

2125

if name == '_pipe':

1226

2126

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

1227

2127

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

1228

2128

1229

class ClientDBusTransitional(ClientDBus):

1230

__metaclass__ = transitional_dbus_metaclass

1231

2129

1232

2130

class ClientHandler(socketserver.BaseRequestHandler, object):

1233

2131

"""A class to handle client connections.

1238

2136

def handle(self):

1239

2137

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

1240

2138

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

1241

unicode(self.client_address))

2139

str(self.client_address))

1242

2140

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

1243

2141

self.server.child_pipe.fileno())

1244

2142

1245

session = (gnutls.connection

1246

.ClientSession(self.request,

1247

gnutls.connection

1248

.X509Credentials()))

1249

1250

# Note: gnutls.connection.X509Credentials is really a

1251

# generic GnuTLS certificate credentials object so long as

1252

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

1253

# here despite using OpenPGP certificates.

2143

session = gnutls.ClientSession(self.request)

1254

2144

1255

2145

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

1256

2146

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

1260

2150

priority = self.server.gnutls_priority

1261

2151

if priority is None:

1262

2152

priority = "NORMAL"

1263

(gnutls.library.functions

1264

.gnutls_priority_set_direct(session._c_object,

1265

priority, None))

2153

gnutls.priority_set_direct(session._c_object, priority,

2154

None)

1266

2155

1267

2156

# Start communication using the Mandos protocol

1268

2157

# Get protocol number

1270

2159

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

1271

2160

try:

1272

2161

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

1273

raise RuntimeError

2162

raise RuntimeError(line)

1274

2163

except (ValueError, IndexError, RuntimeError) as error:

1275

2164

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

1276

2165

return

1278

2167

# Start GnuTLS connection

1279

2168

try:

1280

2169

session.handshake()

1281

except gnutls.errors.GNUTLSError as error:

2170

except gnutls.Error as error:

1282

2171

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

1283

2172

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

1284

2173

# established. Just abandon the request.

1288

2177

approval_required = False

1289

2178

try:

1290

2179

try:

1291

fpr = self.fingerprint(self.peer_certificate

1292

(session))

1293

except (TypeError,

1294

gnutls.errors.GNUTLSError) as error:

2180

fpr = self.fingerprint(

2181

self.peer_certificate(session))

2182

except (TypeError, gnutls.Error) as error:

1295

2183

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

1296

2184

return

1297

2185

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

1310

2198

while True:

1311

2199

if not client.enabled:

1312

2200

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

1313

client.name)

2201

client.name)

1314

2202

if self.server.use_dbus:

1315

2203

# Emit D-Bus signal

1316

client.Rejected("Disabled")

2204

client.Rejected("Disabled")

1317

2205

return

1318

2206

1319

if client._approved or not client.approval_delay:

2207

if client.approved or not client.approval_delay:

1320

2208

#We are approved or approval is disabled

1321

2209

break

1322

elif client._approved is None:

2210

elif client.approved is None:

1323

2211

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

1324

2212

client.name)

1325

2213

if self.server.use_dbus:

1326

2214

# Emit D-Bus signal

1327

2215

client.NeedApproval(

1328

client.approval_delay_milliseconds(),

1329

client.approved_by_default)

2216

client.approval_delay.total_seconds()

2217

* 1000, client.approved_by_default)

1330

2218

else:

1331

2219

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

1332

2220

client.name)

1336

2224

return

1337

2225

1338

2226

#wait until timeout or approved

1339

#x = float(client._timedelta_to_milliseconds(delay))

1340

2227

time = datetime.datetime.now()

1341

2228

client.changedstate.acquire()

1342

client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))

2229

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

1343

2230

client.changedstate.release()

1344

2231

time2 = datetime.datetime.now()

1345

2232

if (time2 - time) >= delay:

1356

2243

else:

1357

2244

delay -= time2 - time

1358

2245

1359

sent_size = 0

1360

while sent_size < len(client.secret):

1361

try:

1362

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

1363

except gnutls.errors.GNUTLSError as error:

1364

logger.warning("gnutls send failed")

1365

return

1366

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

1367

sent, len(client.secret)

1368

- (sent_size + sent))

1369

sent_size += sent

2246

try:

2247

session.send(client.secret)

2248

except gnutls.Error as error:

2249

logger.warning("gnutls send failed",

2250

exc_info = error)

2251

return

1370

2252

1371

2253

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

1372

# bump the timeout as if seen

1373

client.checked_ok(client.extended_timeout)

2254

# bump the timeout using extended_timeout

2255

client.bump_timeout(client.extended_timeout)

1374

2256

if self.server.use_dbus:

1375

2257

# Emit D-Bus signal

1376

2258

client.GotSecret()

1380

2262

client.approvals_pending -= 1

1381

2263

try:

1382

2264

session.bye()

1383

except gnutls.errors.GNUTLSError as error:

1384

logger.warning("GnuTLS bye failed")

2265

except gnutls.Error as error:

2266

logger.warning("GnuTLS bye failed",

2267

exc_info=error)

1385

2268

1386

2269

@staticmethod

1387

2270

def peer_certificate(session):

1388

2271

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

1389

2272

# If not an OpenPGP certificate...

1390

if (gnutls.library.functions

1391

.gnutls_certificate_type_get(session._c_object)

1392

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1393

# ...do the normal thing

1394

return session.peer_certificate

2273

if (gnutls.certificate_type_get(session._c_object)

2274

!= gnutls.CRT_OPENPGP):

2275

# ...return invalid data

2276

return b""

1395

2277

list_size = ctypes.c_uint(1)

1396

cert_list = (gnutls.library.functions

1397

.gnutls_certificate_get_peers

2278

cert_list = (gnutls.certificate_get_peers

1398

2279

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

1399

2280

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

1400

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

1401

" certificate")

2281

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

1402

2282

if list_size.value == 0:

1403

2283

return None

1404

2284

cert = cert_list[0]

1408

2288

def fingerprint(openpgp):

1409

2289

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1410

2290

# New GnuTLS "datum" with the OpenPGP public key

1411

datum = (gnutls.library.types

1412

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

1413

ctypes.POINTER

1414

(ctypes.c_ubyte)),

1415

ctypes.c_uint(len(openpgp))))

2291

datum = gnutls.datum_t(

2292

ctypes.cast(ctypes.c_char_p(openpgp),

2293

ctypes.POINTER(ctypes.c_ubyte)),

2294

ctypes.c_uint(len(openpgp)))

1416

2295

# New empty GnuTLS certificate

1417

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1418

(gnutls.library.functions

1419

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2296

crt = gnutls.openpgp_crt_t()

2297

gnutls.openpgp_crt_init(ctypes.byref(crt))

1420

2298

# Import the OpenPGP public key into the certificate

1421

(gnutls.library.functions

1422

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

1423

gnutls.library.constants

1424

.GNUTLS_OPENPGP_FMT_RAW))

2299

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

2300

gnutls.OPENPGP_FMT_RAW)

1425

2301

# Verify the self signature in the key

1426

2302

crtverify = ctypes.c_uint()

1427

(gnutls.library.functions

1428

.gnutls_openpgp_crt_verify_self(crt, 0,

1429

ctypes.byref(crtverify)))

2303

gnutls.openpgp_crt_verify_self(crt, 0,

2304

ctypes.byref(crtverify))

1430

2305

if crtverify.value != 0:

1431

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1432

raise (gnutls.errors.CertificateSecurityError

1433

("Verify failed"))

2306

gnutls.openpgp_crt_deinit(crt)

2307

raise gnutls.CertificateSecurityError("Verify failed")

1434

2308

# New buffer for the fingerprint

1435

2309

buf = ctypes.create_string_buffer(20)

1436

2310

buf_len = ctypes.c_size_t()

1437

2311

# Get the fingerprint from the certificate into the buffer

1438

(gnutls.library.functions

1439

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

1440

ctypes.byref(buf_len)))

2312

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

2313

ctypes.byref(buf_len))

1441

2314

# Deinit the certificate

1442

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2315

gnutls.openpgp_crt_deinit(crt)

1443

2316

# Convert the buffer to a Python bytestring

1444

2317

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

1445

2318

# Convert the bytestring to hexadecimal notation

1446

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

2319

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

1447

2320

return hex_fpr

1448

2321

1449

2322

1450

2323

class MultiprocessingMixIn(object):

1451

2324

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

2325

1452

2326

def sub_process_main(self, request, address):

1453

2327

try:

1454

2328

self.finish_request(request, address)

1455

except:

2329

except Exception:

1456

2330

self.handle_error(request, address)

1457

2331

self.close_request(request)

1458

2332

1459

2333

def process_request(self, request, address):

1460

2334

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

1461

multiprocessing.Process(target = self.sub_process_main,

1462

args = (request, address)).start()

2335

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

2336

args = (request, address))

2337

proc.start()

2338

return proc

1463

2339

1464

2340

1465

2341

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1466

2342

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

2343

1467

2344

def process_request(self, request, client_address):

1468

2345

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

1469

2346

1471

2348

"""

1472

2349

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1473

2350

1474

super(MultiprocessingMixInWithPipe,

1475

self).process_request(request, client_address)

2351

proc = MultiprocessingMixIn.process_request(self, request,

2352

client_address)

1476

2353

self.child_pipe.close()

1477

self.add_pipe(parent_pipe)

2354

self.add_pipe(parent_pipe, proc)

1478

2355

1479

def add_pipe(self, parent_pipe):

2356

def add_pipe(self, parent_pipe, proc):

1480

2357

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

1481

raise NotImplementedError

2358

raise NotImplementedError()

1482

2359

1483

2360

1484

2361

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1490

2367

interface: None or a network interface name (string)

1491

2368

use_ipv6: Boolean; to use IPv6 or not

1492

2369

"""

2370

1493

2371

def __init__(self, server_address, RequestHandlerClass,

1494

interface=None, use_ipv6=True):

2372

interface=None,

2373

use_ipv6=True,

2374

socketfd=None):

2375

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

2376

creating a new one with socket.socket().

2377

"""

1495

2378

self.interface = interface

1496

2379

if use_ipv6:

1497

2380

self.address_family = socket.AF_INET6

2381

if socketfd is not None:

2382

# Save the file descriptor

2383

self.socketfd = socketfd

2384

# Save the original socket.socket() function

2385

self.socket_socket = socket.socket

2386

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

2387

#

2388

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

2389

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

2390

# patching socket.socket.)

2391

#

2392

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

2393

@functools.wraps(socket.socket)

2394

def socket_wrapper(*args, **kwargs):

2395

# Restore original function so subsequent calls are

2396

# not affected.

2397

socket.socket = self.socket_socket

2398

del self.socket_socket

2399

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

2400

# saved file descriptor.

2401

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

2402

# Replace socket.socket() function with wrapper

2403

socket.socket = socket_wrapper

2404

# The socketserver.TCPServer.__init__ will call

2405

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

2406

# socket_wrapper(), if socketfd was set.

1498

2407

socketserver.TCPServer.__init__(self, server_address,

1499

2408

RequestHandlerClass)

2409

1500

2410

def server_bind(self):

1501

2411

"""This overrides the normal server_bind() function

1502

2412

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

1508

2418

self.interface)

1509

2419

else:

1510

2420

try:

1511

self.socket.setsockopt(socket.SOL_SOCKET,

1512

SO_BINDTODEVICE,

1513

str(self.interface

1514

+ '\0'))

2421

self.socket.setsockopt(

2422

socket.SOL_SOCKET, SO_BINDTODEVICE,

2423

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

1515

2424

except socket.error as error:

1516

if error[0] == errno.EPERM:

1517

logger.error("No permission to"

1518

" bind to interface %s",

1519

self.interface)

1520

elif error[0] == errno.ENOPROTOOPT:

2425

if error.errno == errno.EPERM:

2426

logger.error("No permission to bind to"

2427

" interface %s", self.interface)

2428

elif error.errno == errno.ENOPROTOOPT:

1521

2429

logger.error("SO_BINDTODEVICE not available;"

1522

2430

" cannot bind to interface %s",

1523

2431

self.interface)

2432

elif error.errno == errno.ENODEV:

2433

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

2434

" cannot bind", self.interface)

1524

2435

else:

1525

2436

raise

1526

2437

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

1529

2440

if self.address_family == socket.AF_INET6:

1530

2441

any_address = "::" # in6addr_any

1531

2442

else:

1532

any_address = socket.INADDR_ANY

2443

any_address = "0.0.0.0" # INADDR_ANY

1533

2444

self.server_address = (any_address,

1534

2445

self.server_address[1])

1535

2446

elif not self.server_address[1]:

1536

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

1537

0)

2447

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

1538

2448

# if self.interface:

1539

2449

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

1540

2450

# 0, # port

1554

2464

1555

2465

Assumes a gobject.MainLoop event loop.

1556

2466

"""

2467

1557

2468

def __init__(self, server_address, RequestHandlerClass,

1558

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

1559

gnutls_priority=None, use_dbus=True):

2469

interface=None,

2470

use_ipv6=True,

2471

clients=None,

2472

gnutls_priority=None,

2473

use_dbus=True,

2474

socketfd=None):

1560

2475

self.enabled = False

1561

2476

self.clients = clients

1562

2477

if self.clients is None:

1563

self.clients = set()

2478

self.clients = {}

1564

2479

self.use_dbus = use_dbus

1565

2480

self.gnutls_priority = gnutls_priority

1566

2481

IPv6_TCPServer.__init__(self, server_address,

1567

2482

RequestHandlerClass,

1568

2483

interface = interface,

1569

use_ipv6 = use_ipv6)

2484

use_ipv6 = use_ipv6,

2485

socketfd = socketfd)

2486

1570

2487

def server_activate(self):

1571

2488

if self.enabled:

1572

2489

return socketserver.TCPServer.server_activate(self)

2490

1573

2491

def enable(self):

1574

2492

self.enabled = True

1575

def add_pipe(self, parent_pipe):

2493

2494

def add_pipe(self, parent_pipe, proc):

1576

2495

# Call "handle_ipc" for both data and EOF events

1577

gobject.io_add_watch(parent_pipe.fileno(),

1578

gobject.IO_IN | gobject.IO_HUP,

1579

functools.partial(self.handle_ipc,

1580

parent_pipe = parent_pipe))

1581

1582

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

2496

gobject.io_add_watch(

2497

parent_pipe.fileno(),

2498

gobject.IO_IN | gobject.IO_HUP,

2499

functools.partial(self.handle_ipc,

2500

parent_pipe = parent_pipe,

2501

proc = proc))

2502

2503

def handle_ipc(self, source, condition,

2504

parent_pipe=None,

2505

proc = None,

1583

2506

client_object=None):

1584

condition_names = {

1585

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

1586

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

1587

# blocking).

1588

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

1589

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

1590

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

1591

# broken, usually for pipes and

1592

# sockets).

1593

}

1594

conditions_string = ' | '.join(name

1595

for cond, name in

1596

condition_names.iteritems()

1597

if cond & condition)

1598

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

1599

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

2507

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

2508

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

2509

# Wait for other process to exit

2510

proc.join()

1600

2511

return False

1601

2512

1602

2513

# Read a request from the child

1607

2518

fpr = request[1]

1608

2519

address = request[2]

1609

2520

1610

for c in self.clients:

2521

for c in self.clients.itervalues():

1611

2522

if c.fingerprint == fpr:

1612

2523

client = c

1613

2524

break

1616

2527

"dress: %s", fpr, address)

1617

2528

if self.use_dbus:

1618

2529

# Emit D-Bus signal

1619

mandos_dbus_service.ClientNotFound(fpr, address[0])

2530

mandos_dbus_service.ClientNotFound(fpr,

2531

address[0])

1620

2532

parent_pipe.send(False)

1621

2533

return False

1622

2534

1623

gobject.io_add_watch(parent_pipe.fileno(),

1624

gobject.IO_IN | gobject.IO_HUP,

1625

functools.partial(self.handle_ipc,

1626

parent_pipe = parent_pipe,

1627

client_object = client))

2535

gobject.io_add_watch(

2536

parent_pipe.fileno(),

2537

gobject.IO_IN | gobject.IO_HUP,

2538

functools.partial(self.handle_ipc,

2539

parent_pipe = parent_pipe,

2540

proc = proc,

2541

client_object = client))

1628

2542

parent_pipe.send(True)

1629

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

2543

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

2544

# same fileno

1630

2545

return False

1631

2546

if command == 'funcall':

1632

2547

funcname = request[1]

1633

2548

args = request[2]

1634

2549

kwargs = request[3]

1635

2550

1636

parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))

2551

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

2552

funcname)(*args,

2553

**kwargs)))

1637

2554

1638

2555

if command == 'getattr':

1639

2556

attrname = request[1]

1640

if callable(client_object.__getattribute__(attrname)):

1641

parent_pipe.send(('function',))

2557

if isinstance(client_object.__getattribute__(attrname),

2558

collections.Callable):

2559

parent_pipe.send(('function', ))

1642

2560

else:

1643

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

2561

parent_pipe.send((

2562

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

1644

2563

1645

2564

if command == 'setattr':

1646

2565

attrname = request[1]

1650

2569

return True

1651

2570

1652

2571

2572

def rfc3339_duration_to_delta(duration):

2573

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

2574

2575

>>> rfc3339_duration_to_delta("P7D")

2576

datetime.timedelta(7)

2577

>>> rfc3339_duration_to_delta("PT60S")

2578

datetime.timedelta(0, 60)

2579

>>> rfc3339_duration_to_delta("PT60M")

2580

datetime.timedelta(0, 3600)

2581

>>> rfc3339_duration_to_delta("PT24H")

2582

datetime.timedelta(1)

2583

>>> rfc3339_duration_to_delta("P1W")

2584

datetime.timedelta(7)

2585

>>> rfc3339_duration_to_delta("PT5M30S")

2586

datetime.timedelta(0, 330)

2587

>>> rfc3339_duration_to_delta("P1DT3M20S")

2588

datetime.timedelta(1, 200)

2589

"""

2590

2591

# Parsing an RFC 3339 duration with regular expressions is not

2592

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

2593

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

2594

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

2595

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

2596

# avoid excessive use of external libraries.

2597

2598

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

2599

Token = collections.namedtuple("Token", (

2600

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

2601

# a "group" containing digits

2602

"value", # datetime.timedelta or None

2603

"followers")) # Tokens valid after this token

2604

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

2605

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

2606

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

2607

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

2608

datetime.timedelta(seconds=1),

2609

frozenset((token_end, )))

2610

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

2611

datetime.timedelta(minutes=1),

2612

frozenset((token_second, token_end)))

2613

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

2614

datetime.timedelta(hours=1),

2615

frozenset((token_minute, token_end)))

2616

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

2617

None,

2618

frozenset((token_hour, token_minute,

2619

token_second)))

2620

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

2621

datetime.timedelta(days=1),

2622

frozenset((token_time, token_end)))

2623

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

2624

datetime.timedelta(weeks=4),

2625

frozenset((token_day, token_end)))

2626

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

2627

datetime.timedelta(weeks=52),

2628

frozenset((token_month, token_end)))

2629

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

2630

datetime.timedelta(weeks=1),

2631

frozenset((token_end, )))

2632

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

2633

frozenset((token_year, token_month,

2634

token_day, token_time,

2635

token_week)))

2636

# Define starting values

2637

value = datetime.timedelta() # Value so far

2638

found_token = None

2639

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

2640

s = duration # String left to parse

2641

# Loop until end token is found

2642

while found_token is not token_end:

2643

# Search for any currently valid tokens

2644

for token in followers:

2645

match = token.regexp.match(s)

2646

if match is not None:

2647

# Token found

2648

if token.value is not None:

2649

# Value found, parse digits

2650

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

2651

# Add to value so far

2652

value += factor * token.value

2653

# Strip token from string

2654

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

2655

# Go to found token

2656

found_token = token

2657

# Set valid next tokens

2658

followers = found_token.followers

2659

break

2660

else:

2661

# No currently valid tokens were found

2662

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

2663

.format(duration))

2664

# End token found

2665

return value

2666

2667

1653

2668

def string_to_delta(interval):

1654

2669

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

1655

2670

1666

2681

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

1667

2682

datetime.timedelta(0, 330)

1668

2683

"""

2684

2685

try:

2686

return rfc3339_duration_to_delta(interval)

2687

except ValueError:

2688

pass

2689

1669

2690

timevalue = datetime.timedelta(0)

1670

2691

for s in interval.split():

1671

2692

try:

1672

suffix = unicode(s[-1])

2693

suffix = s[-1]

1673

2694

value = int(s[:-1])

1674

2695

if suffix == "d":

1675

2696

delta = datetime.timedelta(value)

1682

2703

elif suffix == "w":

1683

2704

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

1684

2705

else:

1685

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

1686

except (ValueError, IndexError) as e:

2706

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

2707

except IndexError as e:

1687

2708

raise ValueError(*(e.args))

1688

2709

timevalue += delta

1689

2710

return timevalue

1690

2711

1691

2712

1692

def if_nametoindex(interface):

1693

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

1694

1695

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

1696

global if_nametoindex

1697

try:

1698

if_nametoindex = (ctypes.cdll.LoadLibrary

1699

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

1700

.if_nametoindex)

1701

except (OSError, AttributeError):

1702

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

1703

def if_nametoindex(interface):

1704

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

1705

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

1706

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

1707

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1708

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

1709

interface))

1710

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

1711

ifreq[16:20])[0]

1712

return interface_index

1713

return if_nametoindex(interface)

1714

1715

1716

2713

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

1717

2714

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

1718

2715

1726

2723

sys.exit()

1727

2724

if not noclose:

1728

2725

# Close all standard open file descriptors

1729

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

2726

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

1730

2727

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

1731

2728

raise OSError(errno.ENODEV,

1732

"%s not a character device"

1733

% os.path.devnull)

2729

"{} not a character device"

2730

.format(os.devnull))

1734

2731

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

1735

2732

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

1736

2733

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

1745

2742

1746

2743

parser = argparse.ArgumentParser()

1747

2744

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

1748

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

2745

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

1749

2746

help="show version number and exit")

1750

2747

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

1751

2748

help="Bind to interface IF")

1757

2754

help="Run self-test")

1758

2755

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

1759

2756

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

1760

" to terminal")

2757

" to terminal", default=None)

1761

2758

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

1762

2759

help="Debug level for stdout output")

1763

2760

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

1770

2767

" files")

1771

2768

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

1772

2769

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

1773

" system bus interface")

2770

" system bus interface", default=None)

1774

2771

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

1775

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

2772

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

2773

default=None)

2774

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

2775

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

2776

" state", default=None)

2777

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

2778

help="Specify a file descriptor to a network"

2779

" socket to use instead of creating one")

2780

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

2781

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

2782

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

2783

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

2784

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

2785

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

2786

default=None)

2787

1776

2788

options = parser.parse_args()

1777

2789

1778

2790

if options.check:

1779

2791

import doctest

1780

doctest.testmod()

1781

sys.exit()

2792

fail_count, test_count = doctest.testmod()

2793

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

1782

2794

1783

2795

# Default values for config file for server-global settings

1784

2796

server_defaults = { "interface": "",

1786

2798

"port": "",

1787

2799

"debug": "False",

1788

2800

"priority":

1789

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

2801

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

2802

":+SIGN-DSA-SHA256",

1790

2803

"servicename": "Mandos",

1791

2804

"use_dbus": "True",

1792

2805

"use_ipv6": "True",

1793

2806

"debuglevel": "",

1794

}

2807

"restore": "True",

2808

"socket": "",

2809

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

2810

"foreground": "False",

2811

"zeroconf": "True",

2812

}

1795

2813

1796

2814

# Parse config file for server-global settings

1797

2815

server_config = configparser.SafeConfigParser(server_defaults)

1798

2816

del server_defaults

1799

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

1800

"mandos.conf"))

2817

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

1801

2818

# Convert the SafeConfigParser object to a dict

1802

2819

server_settings = server_config.defaults()

1803

2820

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

1804

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

2821

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

1805

2822

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

1806

2823

option)

1807

2824

if server_settings["port"]:

1808

2825

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

1809

2826

"port")

2827

if server_settings["socket"]:

2828

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

2829

"socket")

2830

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

2831

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

2832

# happen with a supplied network socket.

2833

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

2834

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

2835

["socket"])

1810

2836

del server_config

1811

2837

1812

2838

# Override the settings from the config file with command line

1813

2839

# options, if set.

1814

2840

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

1815

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

1816

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

2841

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

2842

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

2843

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

1817

2844

value = getattr(options, option)

1818

2845

if value is not None:

1819

2846

server_settings[option] = value

1820

2847

del options

1821

2848

# Force all strings to be unicode

1822

2849

for option in server_settings.keys():

1823

if type(server_settings[option]) is str:

1824

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

2850

if isinstance(server_settings[option], bytes):

2851

server_settings[option] = (server_settings[option]

2852

.decode("utf-8"))

2853

# Force all boolean options to be boolean

2854

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

2855

"foreground", "zeroconf"):

2856

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

2857

# Debug implies foreground

2858

if server_settings["debug"]:

2859

server_settings["foreground"] = True

1825

2860

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

1826

2861

1827

2862

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

1828

2863

2864

if (not server_settings["zeroconf"]

2865

and not (server_settings["port"]

2866

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

2867

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

2868

1829

2869

# For convenience

1830

2870

debug = server_settings["debug"]

1831

2871

debuglevel = server_settings["debuglevel"]

1832

2872

use_dbus = server_settings["use_dbus"]

1833

2873

use_ipv6 = server_settings["use_ipv6"]

2874

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

2875

stored_state_file)

2876

foreground = server_settings["foreground"]

2877

zeroconf = server_settings["zeroconf"]

2878

2879

if debug:

2880

initlogger(debug, logging.DEBUG)

2881

else:

2882

if not debuglevel:

2883

initlogger(debug)

2884

else:

2885

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

2886

initlogger(debug, level)

1834

2887

1835

2888

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

1836

syslogger.setFormatter(logging.Formatter

1837

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

1838

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

1839

% server_settings["servicename"]))

2889

syslogger.setFormatter(

2890

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

2891

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

2892

server_settings["servicename"])))

1840

2893

1841

2894

# Parse config file with clients

1842

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

1843

"extended_timeout": "15m",

1844

"interval": "2m",

1845

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

1846

"host": "",

1847

"approval_delay": "0s",

1848

"approval_duration": "1s",

1849

}

1850

client_config = configparser.SafeConfigParser(client_defaults)

2895

client_config = configparser.SafeConfigParser(Client

2896

.client_defaults)

1851

2897

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

1852

2898

"clients.conf"))

1853

2899

1854

2900

global mandos_dbus_service

1855

2901

mandos_dbus_service = None

1856

2902

1857

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

1858

server_settings["port"]),

1859

ClientHandler,

1860

interface=(server_settings["interface"]

1861

or None),

1862

use_ipv6=use_ipv6,

1863

gnutls_priority=

1864

server_settings["priority"],

1865

use_dbus=use_dbus)

1866

if not debug:

1867

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

2903

socketfd = None

2904

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

2905

socketfd = server_settings["socket"]

2906

tcp_server = MandosServer(

2907

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

2908

ClientHandler,

2909

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

2910

use_ipv6=use_ipv6,

2911

gnutls_priority=server_settings["priority"],

2912

use_dbus=use_dbus,

2913

socketfd=socketfd)

2914

if not foreground:

2915

pidfilename = "/run/mandos.pid"

2916

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

2917

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

2918

pidfile = None

1868

2919

try:

1869

pidfile = open(pidfilename, "w")

1870

except IOError:

1871

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

2920

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

2921

except IOError as e:

2922

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

2923

exc_info=e)

1872

2924

1873

try:

1874

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

1875

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

1876

except KeyError:

2925

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

1877

2926

try:

1878

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

1879

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

2927

uid = pwd.getpwnam(name).pw_uid

2928

gid = pwd.getpwnam(name).pw_gid

2929

break

1880

2930

except KeyError:

1881

try:

1882

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

1883

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

1884

except KeyError:

1885

uid = 65534

1886

gid = 65534

2931

continue

2932

else:

2933

uid = 65534

2934

gid = 65534

1887

2935

try:

1888

2936

os.setgid(gid)

1889

2937

os.setuid(uid)

1890

2938

except OSError as error:

1891

if error[0] != errno.EPERM:

1892

raise error

1893

1894

if not debug and not debuglevel:

1895

syslogger.setLevel(logging.WARNING)

1896

console.setLevel(logging.WARNING)

1897

if debuglevel:

1898

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

1899

syslogger.setLevel(level)

1900

console.setLevel(level)

2939

if error.errno != errno.EPERM:

2940

raise

1901

2941

1902

2942

if debug:

1903

2943

# Enable all possible GnuTLS debugging

1904

2944

1905

2945

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

1906

2946

# - GnuTLS manual

1907

gnutls.library.functions.gnutls_global_set_log_level(11)

2947

gnutls.global_set_log_level(11)

1908

2948

1909

@gnutls.library.types.gnutls_log_func

2949

@gnutls.log_func

1910

2950

def debug_gnutls(level, string):

1911

2951

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

1912

2952

1913

(gnutls.library.functions

1914

.gnutls_global_set_log_function(debug_gnutls))

2953

gnutls.global_set_log_function(debug_gnutls)

1915

2954

1916

2955

# Redirect stdin so all checkers get /dev/null

1917

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

2956

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

1918

2957

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

1919

2958

if null > 2:

1920

2959

os.close(null)

1921

else:

1922

# No console logging

1923

logger.removeHandler(console)

1924

2960

1925

2961

# Need to fork before connecting to D-Bus

1926

if not debug:

2962

if not foreground:

1927

2963

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

1928

2964

daemon()

1929

2965

2966

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

2967

# need to inform gobject that threads will be used.

2968

gobject.threads_init()

2969

1930

2970

global main_loop

1931

2971

# From the Avahi example code

1932

DBusGMainLoop(set_as_default=True )

2972

DBusGMainLoop(set_as_default=True)

1933

2973

main_loop = gobject.MainLoop()

1934

2974

bus = dbus.SystemBus()

1935

2975

# End of Avahi example code

1936

2976

if use_dbus:

1937

2977

try:

1938

bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",

1939

bus, do_not_queue=True)

1940

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

1941

bus, do_not_queue=True)

1942

except dbus.exceptions.NameExistsException as e:

1943

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

2978

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

2979

bus,

2980

do_not_queue=True)

2981

old_bus_name = dbus.service.BusName(

2982

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

2983

do_not_queue=True)

2984

except dbus.exceptions.DBusException as e:

2985

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

1944

2986

use_dbus = False

1945

2987

server_settings["use_dbus"] = False

1946

2988

tcp_server.use_dbus = False

1947

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1948

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

1949

servicetype = "_mandos._tcp",

1950

protocol = protocol, bus = bus)

1951

if server_settings["interface"]:

1952

service.interface = (if_nametoindex

1953

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

2989

if zeroconf:

2990

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2991

service = AvahiServiceToSyslog(

2992

name = server_settings["servicename"],

2993

servicetype = "_mandos._tcp",

2994

protocol = protocol,

2995

bus = bus)

2996

if server_settings["interface"]:

2997

service.interface = if_nametoindex(

2998

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

1954

2999

1955

3000

global multiprocessing_manager

1956

3001

multiprocessing_manager = multiprocessing.Manager()

1957

3002

1958

3003

client_class = Client

1959

3004

if use_dbus:

1960

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

1961

def client_config_items(config, section):

1962

special_settings = {

1963

"approved_by_default":

1964

lambda: config.getboolean(section,

1965

"approved_by_default"),

1966

}

1967

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

3005

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

3006

3007

client_settings = Client.config_parser(client_config)

3008

old_client_settings = {}

3009

clients_data = {}

3010

3011

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

3012

global wnull

3013

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

3014

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

3015

# mode

3016

if debug or not foreground:

3017

wnull.close()

3018

3019

# Get client data and settings from last running state.

3020

if server_settings["restore"]:

3021

try:

3022

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

3023

clients_data, old_client_settings = pickle.load(

3024

stored_state)

3025

os.remove(stored_state_path)

3026

except IOError as e:

3027

if e.errno == errno.ENOENT:

3028

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

3029

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

3030

else:

3031

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

3032

exc_info=e)

3033

raise

3034

except EOFError as e:

3035

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

3036

"EOFError:",

3037

exc_info=e)

3038

3039

with PGPEngine() as pgp:

3040

for client_name, client in clients_data.items():

3041

# Skip removed clients

3042

if client_name not in client_settings:

3043

continue

3044

3045

# Decide which value to use after restoring saved state.

3046

# We have three different values: Old config file,

3047

# new config file, and saved state.

3048

# New config value takes precedence if it differs from old

3049

# config value, otherwise use saved state.

3050

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

3051

try:

3052

# For each value in new config, check if it

3053

# differs from the old config value (Except for

3054

# the "secret" attribute)

3055

if (name != "secret"

3056

and (value !=

3057

old_client_settings[client_name][name])):

3058

client[name] = value

3059

except KeyError:

3060

pass

3061

3062

# Clients who has passed its expire date can still be

3063

# enabled if its last checker was successful. A Client

3064

# whose checker succeeded before we stored its state is

3065

# assumed to have successfully run all checkers during

3066

# downtime.

3067

if client["enabled"]:

3068

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

3069

if not client["last_checked_ok"]:

3070

logger.warning(

3071

"disabling client {} - Client never "

3072

"performed a successful checker".format(

3073

client_name))

3074

client["enabled"] = False

3075

elif client["last_checker_status"] != 0:

3076

logger.warning(

3077

"disabling client {} - Client last"

3078

" checker failed with error code"

3079

" {}".format(

3080

client_name,

3081

client["last_checker_status"]))

3082

client["enabled"] = False

3083

else:

3084

client["expires"] = (

3085

datetime.datetime.utcnow()

3086

+ client["timeout"])

3087

logger.debug("Last checker succeeded,"

3088

" keeping {} enabled".format(

3089

client_name))

1968

3090

try:

1969

yield (name, special_settings[name]())

1970

except KeyError:

1971

yield (name, value)

1972

1973

tcp_server.clients.update(set(

1974

client_class(name = section,

1975

config= dict(client_config_items(

1976

client_config, section)))

1977

for section in client_config.sections()))

3091

client["secret"] = pgp.decrypt(

3092

client["encrypted_secret"],

3093

client_settings[client_name]["secret"])

3094

except PGPError:

3095

# If decryption fails, we use secret from new settings

3096

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

3097

client_name))

3098

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

3099

["secret"])

3100

3101

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

3102

for client_name in (set(old_client_settings)

3103

- set(client_settings)):

3104

del clients_data[client_name]

3105

for client_name in (set(client_settings)

3106

- set(old_client_settings)):

3107

clients_data[client_name] = client_settings[client_name]

3108

3109

# Create all client objects

3110

for client_name, client in clients_data.items():

3111

tcp_server.clients[client_name] = client_class(

3112

name = client_name,

3113

settings = client,

3114

server_settings = server_settings)

3115

1978

3116

if not tcp_server.clients:

1979

3117

logger.warning("No clients defined")

1980

1981

if not debug:

1982

try:

1983

with pidfile:

1984

pid = os.getpid()

1985

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

1986

del pidfile

1987

except IOError:

1988

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

1989

pidfilename, pid)

1990

except NameError:

1991

# "pidfile" was never created

1992

pass

3118

3119

if not foreground:

3120

if pidfile is not None:

3121

pid = os.getpid()

3122

try:

3123

with pidfile:

3124

print(pid, file=pidfile)

3125

except IOError:

3126

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

3127

pidfilename, pid)

3128

del pidfile

1993

3129

del pidfilename

1994

1995

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

1996

3130

1997

3131

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

1998

3132

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

1999

3133

2000

3134

if use_dbus:

2001

class MandosDBusService(dbus.service.Object):

3135

3136

@alternate_dbus_interfaces(

3137

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

3138

class MandosDBusService(DBusObjectWithObjectManager):

2002

3139

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

3140

2003

3141

def __init__(self):

2004

3142

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

2005

_interface = "se.bsnet.fukt.Mandos"

3143

3144

_interface = "se.recompile.Mandos"

2006

3145

2007

3146

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

2008

3147

def ClientAdded(self, objpath):

2014

3153

"D-Bus signal"

2015

3154

pass

2016

3155

3156

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

3157

"true"})

2017

3158

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

2018

3159

def ClientRemoved(self, objpath, name):

2019

3160

"D-Bus signal"

2020

3161

pass

2021

3162

3163

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

3164

"true"})

2022

3165

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

2023

3166

def GetAllClients(self):

2024

3167

"D-Bus method"

2025

return dbus.Array(c.dbus_object_path

2026

for c in tcp_server.clients)

3168

return dbus.Array(c.dbus_object_path for c in

3169

tcp_server.clients.itervalues())

2027

3170

3171

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

3172

"true"})

2028

3173

@dbus.service.method(_interface,

2029

3174

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

2030

3175

def GetAllClientsWithProperties(self):

2031

3176

"D-Bus method"

2032

3177

return dbus.Dictionary(

2033

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

2034

for c in tcp_server.clients),

3178

{ c.dbus_object_path: c.GetAll(

3179

"se.recompile.Mandos.Client")

3180

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

2035

3181

signature="oa{sv}")

2036

3182

2037

3183

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

2038

3184

def RemoveClient(self, object_path):

2039

3185

"D-Bus method"

2040

for c in tcp_server.clients:

3186

for c in tcp_server.clients.itervalues():

2041

3187

if c.dbus_object_path == object_path:

2042

tcp_server.clients.remove(c)

3188

del tcp_server.clients[c.name]

2043

3189

c.remove_from_connection()

2044

# Don't signal anything except ClientRemoved

3190

# Don't signal the disabling

2045

3191

c.disable(quiet=True)

2046

# Emit D-Bus signal

2047

self.ClientRemoved(object_path, c.name)

3192

# Emit D-Bus signal for removal

3193

self.client_removed_signal(c)

2048

3194

return

2049

3195

raise KeyError(object_path)

2050

3196

2051

3197

del _interface

3198

3199

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3200

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

3201

def GetManagedObjects(self):

3202

"""D-Bus method"""

3203

return dbus.Dictionary(

3204

{ client.dbus_object_path:

3205

dbus.Dictionary(

3206

{ interface: client.GetAll(interface)

3207

for interface in

3208

client._get_all_interface_names()})

3209

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

3210

3211

def client_added_signal(self, client):

3212

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

3213

if use_dbus:

3214

# New standard signal

3215

self.InterfacesAdded(

3216

client.dbus_object_path,

3217

dbus.Dictionary(

3218

{ interface: client.GetAll(interface)

3219

for interface in

3220

client._get_all_interface_names()}))

3221

# Old signal

3222

self.ClientAdded(client.dbus_object_path)

3223

3224

def client_removed_signal(self, client):

3225

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

3226

if use_dbus:

3227

# New standard signal

3228

self.InterfacesRemoved(

3229

client.dbus_object_path,

3230

client._get_all_interface_names())

3231

# Old signal

3232

self.ClientRemoved(client.dbus_object_path,

3233

client.name)

2052

3234

2053

class MandosDBusServiceTransitional(MandosDBusService):

2054

__metaclass__ = transitional_dbus_metaclass

2055

mandos_dbus_service = MandosDBusServiceTransitional()

3235

mandos_dbus_service = MandosDBusService()

2056

3236

2057

3237

def cleanup():

2058

3238

"Cleanup function; run on exit"

2059

service.cleanup()

2060

3239

if zeroconf:

3240

service.cleanup()

3241

3242

multiprocessing.active_children()

3243

wnull.close()

3244

if not (tcp_server.clients or client_settings):

3245

return

3246

3247

# Store client before exiting. Secrets are encrypted with key

3248

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

3249

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

3250

clients = {}

3251

with PGPEngine() as pgp:

3252

for client in tcp_server.clients.itervalues():

3253

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

3254

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

3255

key)

3256

client_dict = {}

3257

3258

# A list of attributes that can not be pickled

3259

# + secret.

3260

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

3261

"checker", "server_settings" }

3262

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

3263

.Object):

3264

exclude.add(name)

3265

3266

client_dict["encrypted_secret"] = (client

3267

.encrypted_secret)

3268

for attr in client.client_structure:

3269

if attr not in exclude:

3270

client_dict[attr] = getattr(client, attr)

3271

3272

clients[client.name] = client_dict

3273

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

3274

3275

try:

3276

with tempfile.NamedTemporaryFile(

3277

mode='wb',

3278

suffix=".pickle",

3279

prefix='clients-',

3280

dir=os.path.dirname(stored_state_path),

3281

delete=False) as stored_state:

3282

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

3283

tempname = stored_state.name

3284

os.rename(tempname, stored_state_path)

3285

except (IOError, OSError) as e:

3286

if not debug:

3287

try:

3288

os.remove(tempname)

3289

except NameError:

3290

pass

3291

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

3292

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

3293

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

3294

else:

3295

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

3296

exc_info=e)

3297

raise

3298

3299

# Delete all clients, and settings from config

2061

3300

while tcp_server.clients:

2062

client = tcp_server.clients.pop()

3301

name, client = tcp_server.clients.popitem()

2063

3302

if use_dbus:

2064

3303

client.remove_from_connection()

2065

client.disable_hook = None

2066

# Don't signal anything except ClientRemoved

3304

# Don't signal the disabling

2067

3305

client.disable(quiet=True)

3306

# Emit D-Bus signal for removal

2068

3307

if use_dbus:

2069

# Emit D-Bus signal

2070

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2071

client.name)

3308

mandos_dbus_service.client_removed_signal(client)

3309

client_settings.clear()

2072

3310

2073

3311

atexit.register(cleanup)

2074

3312

2075

for client in tcp_server.clients:

3313

for client in tcp_server.clients.itervalues():

2076

3314

if use_dbus:

2077

# Emit D-Bus signal

2078

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2079

client.enable()

3315

# Emit D-Bus signal for adding

3316

mandos_dbus_service.client_added_signal(client)

3317

# Need to initiate checking of clients

3318

if client.enabled:

3319

client.init_checker()

2080

3320

2081

3321

tcp_server.enable()

2082

3322

tcp_server.server_activate()

2083

3323

2084

3324

# Find out what port we got

2085

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

3325

if zeroconf:

3326

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

2086

3327

if use_ipv6:

2087

3328

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

2088

" flowinfo %d, scope_id %d"

2089

% tcp_server.socket.getsockname())

3329

" flowinfo %d, scope_id %d",

3330

*tcp_server.socket.getsockname())

2090

3331

else: # IPv4

2091

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

2092

% tcp_server.socket.getsockname())

3332

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

3333

*tcp_server.socket.getsockname())

2093

3334

2094

3335

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

2095

3336

2096

3337

try:

2097

# From the Avahi example code

2098

try:

2099

service.activate()

2100

except dbus.exceptions.DBusException as error:

2101

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

2102

cleanup()

2103

sys.exit(1)

2104

# End of Avahi example code

3338

if zeroconf:

3339

# From the Avahi example code

3340

try:

3341

service.activate()

3342

except dbus.exceptions.DBusException as error:

3343

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

3344

cleanup()

3345

sys.exit(1)

3346

# End of Avahi example code

2105

3347

2106

3348

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

2107

3349

lambda *args, **kwargs:

2111

3353

logger.debug("Starting main loop")

2112

3354

main_loop.run()

2113

3355

except AvahiError as error:

2114

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

3356

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

2115

3357

cleanup()

2116

3358

sys.exit(1)

2117

3359

except KeyboardInterrupt: