/mandos/trunk : revision 24.1.174

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

28

# along with this program. If not, see

29

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

30

#

31

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

31

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

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

37

import SocketServer as socketserver

43

38

import socket

44

39

import argparse

45

40

import datetime

46

41

import errno

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

51

49

import sys

52

50

import re

53

51

import os

62

60

import struct

63

61

import fcntl

64

62

import functools

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

63

import cPickle as pickle

69

64

import multiprocessing

70

import types

71

import binascii

72

import tempfile

73

import itertools

74

import collections

75

import codecs

76

65

77

66

import dbus

78

67

import dbus.service

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

68

import gobject

83

69

import avahi

84

70

from dbus.mainloop.glib import DBusGMainLoop

85

71

import ctypes

95

81

except ImportError:

96

82

SO_BINDTODEVICE = None

97

83

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.1"

102

stored_state_file = "clients.pickle"

103

104

logger = logging.getLogger()

105

syslogger = None

106

107

try:

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

110

except (OSError, AttributeError):

111

112

def if_nametoindex(interface):

113

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

114

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

115

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

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

117

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

118

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

119

return interface_index

120

121

122

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

123

"""init logger and add loglevel"""

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

129

syslogger.setFormatter(logging.Formatter

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

134

if debug:

135

console = logging.StreamHandler()

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

141

logger.setLevel(level)

142

143

144

class PGPError(Exception):

145

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

146

pass

147

148

149

class PGPEngine(object):

150

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

151

152

def __init__(self):

153

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

154

self.gnupgargs = ['--batch',

155

'--home', self.tempdir,

156

'--force-mdc',

157

'--quiet',

158

'--no-use-agent']

159

160

def __enter__(self):

161

return self

162

163

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

164

self._cleanup()

165

return False

166

167

def __del__(self):

168

self._cleanup()

169

170

def _cleanup(self):

171

if self.tempdir is not None:

172

# Delete contents of tempdir

173

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

174

topdown = False):

175

for filename in files:

176

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

177

for dirname in dirs:

178

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

179

# Remove tempdir

180

os.rmdir(self.tempdir)

181

self.tempdir = None

182

183

def password_encode(self, password):

184

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

185

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

186

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

187

if len(encoded) > 2048:

188

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

189

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

190

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

191

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

192

return encoded

193

194

def encrypt(self, data, password):

195

passphrase = self.password_encode(password)

196

with tempfile.NamedTemporaryFile(

197

dir=self.tempdir) as passfile:

198

passfile.write(passphrase)

199

passfile.flush()

200

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

201

'--passphrase-file',

202

passfile.name]

203

+ self.gnupgargs,

204

stdin = subprocess.PIPE,

205

stdout = subprocess.PIPE,

206

stderr = subprocess.PIPE)

207

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

208

if proc.returncode != 0:

209

raise PGPError(err)

210

return ciphertext

211

212

def decrypt(self, data, password):

213

passphrase = self.password_encode(password)

214

with tempfile.NamedTemporaryFile(

215

dir = self.tempdir) as passfile:

216

passfile.write(passphrase)

217

passfile.flush()

218

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

219

'--passphrase-file',

220

passfile.name]

221

+ self.gnupgargs,

222

stdin = subprocess.PIPE,

223

stdout = subprocess.PIPE,

224

stderr = subprocess.PIPE)

225

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

226

if proc.returncode != 0:

227

raise PGPError(err)

228

return decrypted_plaintext

229

84

85

version = "1.3.0"

86

87

#logger = logging.getLogger('mandos')

88

logger = logging.Logger('mandos')

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

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

92

syslogger.setFormatter(logging.Formatter

93

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

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

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

99

' %(levelname)s:'

100

' %(message)s'))

101

logger.addHandler(console)

230

102

231

103

class AvahiError(Exception):

232

104

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

233

105

self.value = value

234

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

235

**kwargs)

236

106

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

107

def __unicode__(self):

108

return unicode(repr(self.value))

237

109

238

110

class AvahiServiceError(AvahiError):

239

111

pass

240

112

241

242

113

class AvahiGroupError(AvahiError):

243

114

pass

244

115

251

122

Used to optionally bind to the specified interface.

252

123

name: string; Example: 'Mandos'

253

124

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

254

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

125

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

255

126

port: integer; what port to announce

256

127

TXT: list of strings; TXT record for the service

257

128

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

263

134

server: D-Bus Server

264

135

bus: dbus.SystemBus()

265

136

"""

266

267

def __init__(self,

268

interface = avahi.IF_UNSPEC,

269

name = None,

270

servicetype = None,

271

port = None,

272

TXT = None,

273

domain = "",

274

host = "",

275

max_renames = 32768,

276

protocol = avahi.PROTO_UNSPEC,

277

bus = None):

137

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

138

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

139

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

140

protocol = avahi.PROTO_UNSPEC, bus = None):

278

141

self.interface = interface

279

142

self.name = name

280

143

self.type = servicetype

289

152

self.server = None

290

153

self.bus = bus

291

154

self.entry_group_state_changed_match = None

292

293

def rename(self, remove=True):

155

def rename(self):

294

156

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

295

157

if self.rename_count >= self.max_renames:

296

158

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

297

159

" after %i retries, exiting.",

298

160

self.rename_count)

299

161

raise AvahiServiceError("Too many renames")

300

self.name = str(

301

self.server.GetAlternativeServiceName(self.name))

302

self.rename_count += 1

162

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

303

163

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

304

164

self.name)

305

if remove:

306

self.remove()

165

syslogger.setFormatter(logging.Formatter

166

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

167

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

168

% self.name))

169

self.remove()

307

170

try:

308

171

self.add()

309

172

except dbus.exceptions.DBusException as error:

310

if (error.get_dbus_name()

311

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

312

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

313

return self.rename(remove=False)

314

else:

315

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

316

self.cleanup()

317

os._exit(1)

318

173

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

174

self.cleanup()

175

os._exit(1)

176

self.rename_count += 1

319

177

def remove(self):

320

178

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

321

179

if self.entry_group_state_changed_match is not None:

323

181

self.entry_group_state_changed_match = None

324

182

if self.group is not None:

325

183

self.group.Reset()

326

327

184

def add(self):

328

185

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

329

186

self.remove()

334

191

avahi.DBUS_INTERFACE_ENTRY_GROUP)

335

192

self.entry_group_state_changed_match = (

336

193

self.group.connect_to_signal(

337

'StateChanged', self.entry_group_state_changed))

194

'StateChanged', self .entry_group_state_changed))

338

195

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

339

196

self.name, self.type)

340

197

self.group.AddService(

346

203

dbus.UInt16(self.port),

347

204

avahi.string_array_to_txt_array(self.TXT))

348

205

self.group.Commit()

349

350

206

def entry_group_state_changed(self, state, error):

351

207

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

352

208

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

358

214

self.rename()

359

215

elif state == avahi.ENTRY_GROUP_FAILURE:

360

216

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

361

str(error))

362

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

363

217

unicode(error))

218

raise AvahiGroupError("State changed: %s"

219

% unicode(error))

364

220

def cleanup(self):

365

221

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

366

222

if self.group is not None:

367

223

try:

368

224

self.group.Free()

369

225

except (dbus.exceptions.UnknownMethodException,

370

dbus.exceptions.DBusException):

226

dbus.exceptions.DBusException) as e:

371

227

pass

372

228

self.group = None

373

229

self.remove()

374

375

230

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

376

231

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

377

232

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

378

bad_states = {

379

avahi.SERVER_INVALID: "Zeroconf server invalid",

380

avahi.SERVER_REGISTERING: None,

381

avahi.SERVER_COLLISION: "Zeroconf server name collision",

382

avahi.SERVER_FAILURE: "Zeroconf server failure",

383

}

233

bad_states = { avahi.SERVER_INVALID:

234

"Zeroconf server invalid",

235

avahi.SERVER_REGISTERING: None,

236

avahi.SERVER_COLLISION:

237

"Zeroconf server name collision",

238

avahi.SERVER_FAILURE:

239

"Zeroconf server failure" }

384

240

if state in bad_states:

385

241

if bad_states[state] is not None:

386

242

if error is None:

389

245

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

390

246

self.cleanup()

391

247

elif state == avahi.SERVER_RUNNING:

392

try:

393

self.add()

394

except dbus.exceptions.DBusException as error:

395

if (error.get_dbus_name()

396

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

397

logger.info("Local Zeroconf service name"

398

" collision.")

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

248

self.add()

404

249

else:

405

250

if error is None:

406

251

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

407

252

else:

408

253

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

409

410

254

def activate(self):

411

255

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

412

256

if self.server is None:

416

260

follow_name_owner_changes=True),

417

261

avahi.DBUS_INTERFACE_SERVER)

418

262

self.server.connect_to_signal("StateChanged",

419

self.server_state_changed)

263

self.server_state_changed)

420

264

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

421

265

422

266

423

class AvahiServiceToSyslog(AvahiService):

424

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

425

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

426

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

427

syslogger.setFormatter(logging.Formatter(

428

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

429

.format(self.name)))

430

return ret

431

432

# Pretend that we have a GnuTLS module

433

class GnuTLS(object):

434

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

435

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

436

437

_library = ctypes.cdll.LoadLibrary(

438

ctypes.util.find_library("gnutls"))

439

_need_version = "3.3.0"

440

def __init__(self):

441

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

442

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

443

# happens.

444

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

445

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

446

.format(self._need_version))

447

448

# Unless otherwise indicated, the constants and types below are

449

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

450

451

# Constants

452

E_SUCCESS = 0

453

E_INTERRUPTED = -52

454

E_AGAIN = -28

455

CRT_OPENPGP = 2

456

CLIENT = 2

457

SHUT_RDWR = 0

458

CRD_CERTIFICATE = 1

459

E_NO_CERTIFICATE_FOUND = -49

460

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

461

462

# Types

463

class session_int(ctypes.Structure):

464

_fields_ = []

465

session_t = ctypes.POINTER(session_int)

466

class certificate_credentials_st(ctypes.Structure):

467

_fields_ = []

468

certificate_credentials_t = ctypes.POINTER(

469

certificate_credentials_st)

470

certificate_type_t = ctypes.c_int

471

class datum_t(ctypes.Structure):

472

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

473

('size', ctypes.c_uint)]

474

class openpgp_crt_int(ctypes.Structure):

475

_fields_ = []

476

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

477

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

478

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

479

credentials_type_t = ctypes.c_int #

480

transport_ptr_t = ctypes.c_void_p

481

close_request_t = ctypes.c_int

482

483

# Exceptions

484

class Error(Exception):

485

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

486

# exception might be raised from within GnuTLS.__init__,

487

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

488

# global variable has happened.

489

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

490

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

491

# code is passed, convert it to a string with

492

# gnutls.strerror()

493

self.code = code

494

if message is None and code is not None:

495

message = GnuTLS.strerror(code)

496

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

497

message, *args)

498

499

class CertificateSecurityError(Error):

500

pass

501

502

# Classes

503

class Credentials(object):

504

def __init__(self):

505

self._c_object = gnutls.certificate_credentials_t()

506

gnutls.certificate_allocate_credentials(

507

ctypes.byref(self._c_object))

508

self.type = gnutls.CRD_CERTIFICATE

509

510

def __del__(self):

511

gnutls.certificate_free_credentials(self._c_object)

512

513

class ClientSession(object):

514

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

515

self._c_object = gnutls.session_t()

516

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

517

gnutls.set_default_priority(self._c_object)

518

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

519

gnutls.handshake_set_private_extensions(self._c_object,

520

True)

521

self.socket = socket

522

if credentials is None:

523

credentials = gnutls.Credentials()

524

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

525

ctypes.cast(credentials._c_object,

526

ctypes.c_void_p))

527

self.credentials = credentials

528

529

def __del__(self):

530

gnutls.deinit(self._c_object)

531

532

def handshake(self):

533

return gnutls.handshake(self._c_object)

534

535

def send(self, data):

536

data = bytes(data)

537

data_len = len(data)

538

while data_len > 0:

539

data_len -= gnutls.record_send(self._c_object,

540

data[-data_len:],

541

data_len)

542

543

def bye(self):

544

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

545

546

# Error handling functions

547

def _error_code(result):

548

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

549

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

550

if result >= 0:

551

return result

552

if result == gnutls.E_NO_CERTIFICATE_FOUND:

553

raise gnutls.CertificateSecurityError(code = result)

554

raise gnutls.Error(code = result)

555

556

def _retry_on_error(result, func, arguments):

557

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

558

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

559

while result < 0:

560

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

561

return _error_code(result)

562

result = func(*arguments)

563

return result

564

565

# Unless otherwise indicated, the function declarations below are

566

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

567

568

# Functions

569

priority_set_direct = _library.gnutls_priority_set_direct

570

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

571

ctypes.POINTER(ctypes.c_char_p)]

572

priority_set_direct.restype = _error_code

573

574

init = _library.gnutls_init

575

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

576

init.restype = _error_code

577

578

set_default_priority = _library.gnutls_set_default_priority

579

set_default_priority.argtypes = [session_t]

580

set_default_priority.restype = _error_code

581

582

record_send = _library.gnutls_record_send

583

record_send.argtypes = [session_t, ctypes.c_void_p,

584

ctypes.c_size_t]

585

record_send.restype = ctypes.c_ssize_t

586

record_send.errcheck = _retry_on_error

587

588

certificate_allocate_credentials = (

589

_library.gnutls_certificate_allocate_credentials)

590

certificate_allocate_credentials.argtypes = [

591

ctypes.POINTER(certificate_credentials_t)]

592

certificate_allocate_credentials.restype = _error_code

593

594

certificate_free_credentials = (

595

_library.gnutls_certificate_free_credentials)

596

certificate_free_credentials.argtypes = [certificate_credentials_t]

597

certificate_free_credentials.restype = None

598

599

handshake_set_private_extensions = (

600

_library.gnutls_handshake_set_private_extensions)

601

handshake_set_private_extensions.argtypes = [session_t,

602

ctypes.c_int]

603

handshake_set_private_extensions.restype = None

604

605

credentials_set = _library.gnutls_credentials_set

606

credentials_set.argtypes = [session_t, credentials_type_t,

607

ctypes.c_void_p]

608

credentials_set.restype = _error_code

609

610

strerror = _library.gnutls_strerror

611

strerror.argtypes = [ctypes.c_int]

612

strerror.restype = ctypes.c_char_p

613

614

certificate_type_get = _library.gnutls_certificate_type_get

615

certificate_type_get.argtypes = [session_t]

616

certificate_type_get.restype = _error_code

617

618

certificate_get_peers = _library.gnutls_certificate_get_peers

619

certificate_get_peers.argtypes = [session_t,

620

ctypes.POINTER(ctypes.c_uint)]

621

certificate_get_peers.restype = ctypes.POINTER(datum_t)

622

623

global_set_log_level = _library.gnutls_global_set_log_level

624

global_set_log_level.argtypes = [ctypes.c_int]

625

global_set_log_level.restype = None

626

627

global_set_log_function = _library.gnutls_global_set_log_function

628

global_set_log_function.argtypes = [log_func]

629

global_set_log_function.restype = None

630

631

deinit = _library.gnutls_deinit

632

deinit.argtypes = [session_t]

633

deinit.restype = None

634

635

handshake = _library.gnutls_handshake

636

handshake.argtypes = [session_t]

637

handshake.restype = _error_code

638

handshake.errcheck = _retry_on_error

639

640

transport_set_ptr = _library.gnutls_transport_set_ptr

641

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

642

transport_set_ptr.restype = None

643

644

bye = _library.gnutls_bye

645

bye.argtypes = [session_t, close_request_t]

646

bye.restype = _error_code

647

bye.errcheck = _retry_on_error

648

649

check_version = _library.gnutls_check_version

650

check_version.argtypes = [ctypes.c_char_p]

651

check_version.restype = ctypes.c_char_p

652

653

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

654

655

openpgp_crt_init = _library.gnutls_openpgp_crt_init

656

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

657

openpgp_crt_init.restype = _error_code

658

659

openpgp_crt_import = _library.gnutls_openpgp_crt_import

660

openpgp_crt_import.argtypes = [openpgp_crt_t,

661

ctypes.POINTER(datum_t),

662

openpgp_crt_fmt_t]

663

openpgp_crt_import.restype = _error_code

664

665

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

666

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

667

ctypes.POINTER(ctypes.c_uint)]

668

openpgp_crt_verify_self.restype = _error_code

669

670

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

671

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

672

openpgp_crt_deinit.restype = None

673

674

openpgp_crt_get_fingerprint = (

675

_library.gnutls_openpgp_crt_get_fingerprint)

676

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

677

ctypes.c_void_p,

678

ctypes.POINTER(

679

ctypes.c_size_t)]

680

openpgp_crt_get_fingerprint.restype = _error_code

681

682

# Remove non-public functions

683

del _error_code, _retry_on_error

684

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

685

gnutls = GnuTLS()

686

687

def call_pipe(connection, # : multiprocessing.Connection

688

func, *args, **kwargs):

689

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

690

691

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

692

return value on the provided multiprocessing.Connection.

693

"""

694

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

695

connection.close()

696

697

267

class Client(object):

698

268

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

699

269

700

270

Attributes:

701

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

271

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

702

272

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

703

273

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

704

274

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

711

281

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

712

282

checker_initiator_tag: a gobject event source tag, or None

713

283

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

714

client_structure: Object describing what attributes a client has

715

and is used for storing the client at exit

716

284

current_checker_command: string; current running checker_command

285

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

717

286

disable_initiator_tag: a gobject event source tag, or None

718

287

enabled: bool()

719

288

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

722

291

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

723

292

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

724

293

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

725

last_checker_status: integer between 0 and 255 reflecting exit

726

status of last checker. -1 reflects crashed

727

checker, -2 means no checker completed yet.

728

last_checker_signal: The signal which killed the last checker, if

729

last_checker_status is -1

730

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

294

last_enabled: datetime.datetime(); (UTC)

731

295

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

732

296

D-Bus identifiers

733

297

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

734

298

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

735

299

until this client is disabled

736

extended_timeout: extra long timeout when secret has been sent

737

300

runtime_expansions: Allowed attributes for runtime expansion.

738

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

739

disabled, or None

740

server_settings: The server_settings dict from main()

741

301

"""

742

302

743

303

runtime_expansions = ("approval_delay", "approval_duration",

744

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

745

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

746

"last_approval_request", "last_checked_ok",

304

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

305

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

747

306

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

748

client_defaults = {

749

"timeout": "PT5M",

750

"extended_timeout": "PT15M",

751

"interval": "PT2M",

752

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

753

"host": "",

754

"approval_delay": "PT0S",

755

"approval_duration": "PT1S",

756

"approved_by_default": "True",

757

"enabled": "True",

758

}

759

307

760

308

@staticmethod

761

def config_parser(config):

762

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

763

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

764

with exceptions for any special settings as defined above.

765

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

766

value given the same arguments.

767

"""

768

settings = {}

769

for client_name in config.sections():

770

section = dict(config.items(client_name))

771

client = settings[client_name] = {}

772

773

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

774

# Reformat values from string types to Python types

775

client["approved_by_default"] = config.getboolean(

776

client_name, "approved_by_default")

777

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

778

"enabled")

779

780

# Uppercase and remove spaces from fingerprint for later

781

# comparison purposes with return value from the

782

# fingerprint() function

783

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

784

.replace(" ", ""))

785

if "secret" in section:

786

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

787

elif "secfile" in section:

788

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

789

(section["secfile"])),

790

"rb") as secfile:

791

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

792

else:

793

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

794

.format(section))

795

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

796

client["extended_timeout"] = string_to_delta(

797

section["extended_timeout"])

798

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

799

client["approval_delay"] = string_to_delta(

800

section["approval_delay"])

801

client["approval_duration"] = string_to_delta(

802

section["approval_duration"])

803

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

804

client["last_approval_request"] = None

805

client["last_checked_ok"] = None

806

client["last_checker_status"] = -2

807

808

return settings

809

810

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

309

def _timedelta_to_milliseconds(td):

310

"Convert a datetime.timedelta() to milliseconds"

311

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

312

+ (td.seconds * 1000)

313

+ (td.microseconds // 1000))

314

315

def timeout_milliseconds(self):

316

"Return the 'timeout' attribute in milliseconds"

317

return self._timedelta_to_milliseconds(self.timeout)

318

319

def interval_milliseconds(self):

320

"Return the 'interval' attribute in milliseconds"

321

return self._timedelta_to_milliseconds(self.interval)

322

323

def approval_delay_milliseconds(self):

324

return self._timedelta_to_milliseconds(self.approval_delay)

325

326

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

327

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

328

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

329

attribute."""

811

330

self.name = name

812

if server_settings is None:

813

server_settings = {}

814

self.server_settings = server_settings

815

# adding all client settings

816

for setting, value in settings.items():

817

setattr(self, setting, value)

818

819

if self.enabled:

820

if not hasattr(self, "last_enabled"):

821

self.last_enabled = datetime.datetime.utcnow()

822

if not hasattr(self, "expires"):

823

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

824

+ self.timeout)

825

else:

826

self.last_enabled = None

827

self.expires = None

828

331

if config is None:

332

config = {}

829

333

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

334

# Uppercase and remove spaces from fingerprint for later

335

# comparison purposes with return value from the fingerprint()

336

# function

337

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

338

.replace(" ", ""))

830

339

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

831

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

832

datetime.datetime.utcnow())

833

834

# attributes specific for this server instance

340

if "secret" in config:

341

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

342

elif "secfile" in config:

343

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

344

(config["secfile"])),

345

"rb") as secfile:

346

self.secret = secfile.read()

347

else:

348

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

349

% self.name)

350

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

351

self.created = datetime.datetime.utcnow()

352

self.enabled = False

353

self.last_approval_request = None

354

self.last_enabled = None

355

self.last_checked_ok = None

356

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

357

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

358

self.disable_hook = disable_hook

835

359

self.checker = None

836

360

self.checker_initiator_tag = None

837

361

self.disable_initiator_tag = None

838

362

self.checker_callback_tag = None

363

self.checker_command = config["checker"]

839

364

self.current_checker_command = None

840

self.approved = None

365

self.last_connect = None

366

self._approved = None

367

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

368

True)

841

369

self.approvals_pending = 0

842

self.changedstate = multiprocessing_manager.Condition(

843

multiprocessing_manager.Lock())

844

self.client_structure = [attr

845

for attr in self.__dict__.iterkeys()

846

if not attr.startswith("_")]

847

self.client_structure.append("client_structure")

848

849

for name, t in inspect.getmembers(

850

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

851

if not name.startswith("_"):

852

self.client_structure.append(name)

370

self.approval_delay = string_to_delta(

371

config["approval_delay"])

372

self.approval_duration = string_to_delta(

373

config["approval_duration"])

374

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

853

375

854

# Send notice to process children that client state has changed

855

376

def send_changedstate(self):

856

with self.changedstate:

857

self.changedstate.notify_all()

858

377

self.changedstate.acquire()

378

self.changedstate.notify_all()

379

self.changedstate.release()

380

859

381

def enable(self):

860

382

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

861

383

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

862

384

# Already enabled

863

385

return

864

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

865

self.enabled = True

386

self.send_changedstate()

866

387

self.last_enabled = datetime.datetime.utcnow()

867

self.init_checker()

868

self.send_changedstate()

388

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

389

# and every interval from then on.

390

self.checker_initiator_tag = (gobject.timeout_add

391

(self.interval_milliseconds(),

392

self.start_checker))

393

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

394

self.disable_initiator_tag = (gobject.timeout_add

395

(self.timeout_milliseconds(),

396

self.disable))

397

self.enabled = True

398

# Also start a new checker *right now*.

399

self.start_checker()

869

400

870

401

def disable(self, quiet=True):

871

402

"""Disable this client."""

872

403

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

873

404

return False

874

405

if not quiet:

406

self.send_changedstate()

407

if not quiet:

875

408

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

876

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

409

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

877

410

gobject.source_remove(self.disable_initiator_tag)

878

411

self.disable_initiator_tag = None

879

self.expires = None

880

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

412

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

881

413

gobject.source_remove(self.checker_initiator_tag)

882

414

self.checker_initiator_tag = None

883

415

self.stop_checker()

416

if self.disable_hook:

417

self.disable_hook(self)

884

418

self.enabled = False

885

if not quiet:

886

self.send_changedstate()

887

419

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

888

420

return False

889

421

890

422

def __del__(self):

423

self.disable_hook = None

891

424

self.disable()

892

425

893

def init_checker(self):

894

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

895

# and every interval from then on.

896

if self.checker_initiator_tag is not None:

897

gobject.source_remove(self.checker_initiator_tag)

898

self.checker_initiator_tag = gobject.timeout_add(

899

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

900

self.start_checker)

901

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

902

if self.disable_initiator_tag is not None:

903

gobject.source_remove(self.disable_initiator_tag)

904

self.disable_initiator_tag = gobject.timeout_add(

905

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

906

# Also start a new checker *right now*.

907

self.start_checker()

908

909

def checker_callback(self, source, condition, connection,

910

command):

426

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

911

427

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

912

428

self.checker_callback_tag = None

913

429

self.checker = None

914

# Read return code from connection (see call_pipe)

915

returncode = connection.recv()

916

connection.close()

917

918

if returncode >= 0:

919

self.last_checker_status = returncode

920

self.last_checker_signal = None

921

if self.last_checker_status == 0:

430

if os.WIFEXITED(condition):

431

exitstatus = os.WEXITSTATUS(condition)

432

if exitstatus == 0:

922

433

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

923

434

vars(self))

924

435

self.checked_ok()

925

436

else:

926

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

437

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

438

vars(self))

927

439

else:

928

self.last_checker_status = -1

929

self.last_checker_signal = -returncode

930

440

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

931

441

vars(self))

932

return False

933

442

934

443

def checked_ok(self):

935

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

444

"""Bump up the timeout for this client.

445

446

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

447

alive and well.

448

"""

936

449

self.last_checked_ok = datetime.datetime.utcnow()

937

self.last_checker_status = 0

938

self.last_checker_signal = None

939

self.bump_timeout()

940

941

def bump_timeout(self, timeout=None):

942

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

943

if timeout is None:

944

timeout = self.timeout

945

if self.disable_initiator_tag is not None:

946

gobject.source_remove(self.disable_initiator_tag)

947

self.disable_initiator_tag = None

948

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

949

self.disable_initiator_tag = gobject.timeout_add(

950

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

951

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

450

gobject.source_remove(self.disable_initiator_tag)

451

self.disable_initiator_tag = (gobject.timeout_add

452

(self.timeout_milliseconds(),

453

self.disable))

952

454

953

455

def need_approval(self):

954

456

self.last_approval_request = datetime.datetime.utcnow()

959

461

If a checker already exists, leave it running and do

960

462

nothing."""

961

463

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

962

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

963

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

964

# would inevitably timeout, since no checker would get a

965

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

464

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

465

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

466

# client would inevitably timeout, since no checker would get

467

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

966

468

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

967

469

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

968

470

# should be.

969

471

970

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

971

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

972

self.checker.join()

973

self.checker = None

472

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

473

try:

474

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

475

except (AttributeError, OSError) as error:

476

if (isinstance(error, OSError)

477

and error.errno != errno.ECHILD):

478

raise error

479

else:

480

if pid:

481

logger.warning("Checker was a zombie")

482

gobject.source_remove(self.checker_callback_tag)

483

self.checker_callback(pid, status,

484

self.current_checker_command)

974

485

# Start a new checker if needed

975

486

if self.checker is None:

976

# Escape attributes for the shell

977

escaped_attrs = {

978

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

979

for attr in self.runtime_expansions }

980

487

try:

981

command = self.checker_command % escaped_attrs

982

except TypeError as error:

983

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

984

self.checker_command,

985

exc_info=error)

986

return True # Try again later

488

# In case checker_command has exactly one % operator

489

command = self.checker_command % self.host

490

except TypeError:

491

# Escape attributes for the shell

492

escaped_attrs = dict(

493

(attr,

494

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

495

errors=

496

'replace')))

497

for attr in

498

self.runtime_expansions)

499

500

try:

501

command = self.checker_command % escaped_attrs

502

except TypeError as error:

503

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

504

' %s', self.checker_command, error)

505

return True # Try again later

987

506

self.current_checker_command = command

988

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

989

self.name)

990

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

991

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

992

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

993

# always replaced by /dev/null.)

994

# The exception is when not debugging but nevertheless

995

# running in the foreground; use the previously

996

# created wnull.

997

popen_args = { "close_fds": True,

998

"shell": True,

999

"cwd": "/" }

1000

if (not self.server_settings["debug"]

1001

and self.server_settings["foreground"]):

1002

popen_args.update({"stdout": wnull,

1003

"stderr": wnull })

1004

pipe = multiprocessing.Pipe(duplex = False)

1005

self.checker = multiprocessing.Process(

1006

target = call_pipe,

1007

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

1008

kwargs = popen_args)

1009

self.checker.start()

1010

self.checker_callback_tag = gobject.io_add_watch(

1011

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

1012

self.checker_callback, pipe[0], command)

507

try:

508

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

509

command, self.name)

510

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

511

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

512

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

513

# always replaced by /dev/null.)

514

self.checker = subprocess.Popen(command,

515

close_fds=True,

516

shell=True, cwd="/")

517

self.checker_callback_tag = (gobject.child_watch_add

518

(self.checker.pid,

519

self.checker_callback,

520

data=command))

521

# The checker may have completed before the gobject

522

# watch was added. Check for this.

523

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

524

if pid:

525

gobject.source_remove(self.checker_callback_tag)

526

self.checker_callback(pid, status, command)

527

except OSError as error:

528

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

529

error)

1013

530

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

1014

531

return True

1015

532

1021

538

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

1022

539

return

1023

540

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

1024

self.checker.terminate()

541

try:

542

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

543

#time.sleep(0.5)

544

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

545

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

546

except OSError as error:

547

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

548

raise

1025

549

self.checker = None

1026

550

1027

1028

def dbus_service_property(dbus_interface,

1029

signature="v",

1030

access="readwrite",

1031

byte_arrays=False):

551

def dbus_service_property(dbus_interface, signature="v",

552

access="readwrite", byte_arrays=False):

1032

553

"""Decorators for marking methods of a DBusObjectWithProperties to

1033

554

become properties on the D-Bus.

1034

555

1043

564

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

1044

565

if byte_arrays and signature != "ay":

1045

566

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

1046

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

1047

567

" signature %r" % signature)

1048

568

def decorator(func):

1049

569

func._dbus_is_property = True

1050

570

func._dbus_interface = dbus_interface

1055

575

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

1056

576

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1057

577

return func

1058

1059

return decorator

1060

1061

1062

def dbus_interface_annotations(dbus_interface):

1063

"""Decorator for marking functions returning interface annotations

1064

1065

Usage:

1066

1067

@dbus_interface_annotations("org.example.Interface")

1068

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

1069

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

1070

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

1071

"false"}

1072

"""

1073

1074

def decorator(func):

1075

func._dbus_is_interface = True

1076

func._dbus_interface = dbus_interface

1077

func._dbus_name = dbus_interface

1078

return func

1079

1080

return decorator

1081

1082

1083

def dbus_annotations(annotations):

1084

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

1085

Usage:

1086

1087

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

1088

"org.freedesktop.DBus.Property."

1089

"EmitsChangedSignal": "false"})

1090

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

1091

access="r")

1092

def Property_dbus_property(self):

1093

return dbus.Boolean(False)

1094

1095

See also the DBusObjectWithAnnotations class.

1096

"""

1097

1098

def decorator(func):

1099

func._dbus_annotations = annotations

1100

return func

1101

1102

578

return decorator

1103

579

1104

580

1105

581

class DBusPropertyException(dbus.exceptions.DBusException):

1106

582

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

1107

583

"""

1108

pass

584

def __unicode__(self):

585

return unicode(str(self))

1109

586

1110

587

1111

588

class DBusPropertyAccessException(DBusPropertyException):

1120

597

pass

1121

598

1122

599

1123

class DBusObjectWithAnnotations(dbus.service.Object):

1124

"""A D-Bus object with annotations.

1125

1126

Classes inheriting from this can use the dbus_annotations

1127

decorator to add annotations to methods or signals.

1128

"""

1129

1130

@staticmethod

1131

def _is_dbus_thing(thing):

1132

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

1133

1134

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

1135

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

1136

"""

1137

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

1138

False)

1139

1140

def _get_all_dbus_things(self, thing):

1141

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

1142

"""

1143

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

1144

athing.__get__(self))

1145

for cls in self.__class__.__mro__

1146

for name, athing in

1147

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

1148

1149

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1150

out_signature = "s",

1151

path_keyword = 'object_path',

1152

connection_keyword = 'connection')

1153

def Introspect(self, object_path, connection):

1154

"""Overloading of standard D-Bus method.

1155

1156

Inserts annotation tags on methods and signals.

1157

"""

1158

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

1159

connection)

1160

try:

1161

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

1162

1163

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

1164

# Add annotation tags

1165

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

1166

for tag in if_tag.getElementsByTagName(typ):

1167

annots = dict()

1168

for name, prop in (self.

1169

_get_all_dbus_things(typ)):

1170

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

1171

and prop._dbus_interface

1172

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

1173

annots.update(getattr(

1174

prop, "_dbus_annotations", {}))

1175

for name, value in annots.items():

1176

ann_tag = document.createElement(

1177

"annotation")

1178

ann_tag.setAttribute("name", name)

1179

ann_tag.setAttribute("value", value)

1180

tag.appendChild(ann_tag)

1181

# Add interface annotation tags

1182

for annotation, value in dict(

1183

itertools.chain.from_iterable(

1184

annotations().items()

1185

for name, annotations

1186

in self._get_all_dbus_things("interface")

1187

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

1188

)).items():

1189

ann_tag = document.createElement("annotation")

1190

ann_tag.setAttribute("name", annotation)

1191

ann_tag.setAttribute("value", value)

1192

if_tag.appendChild(ann_tag)

1193

# Fix argument name for the Introspect method itself

1194

if (if_tag.getAttribute("name")

1195

== dbus.INTROSPECTABLE_IFACE):

1196

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

1197

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

1198

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

1199

if (arg.getAttribute("direction")

1200

== "out"):

1201

arg.setAttribute("name",

1202

"xml_data")

1203

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

1204

document.unlink()

1205

except (AttributeError, xml.dom.DOMException,

1206

xml.parsers.expat.ExpatError) as error:

1207

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

1208

exc_info=error)

1209

return xmlstring

1210

1211

1212

class DBusObjectWithProperties(DBusObjectWithAnnotations):

600

class DBusObjectWithProperties(dbus.service.Object):

1213

601

"""A D-Bus object with properties.

1214

602

1215

603

Classes inheriting from this can use the dbus_service_property

1216

604

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

1217

605

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

1218

606

"""

1219

607

608

@staticmethod

609

def _is_dbus_property(obj):

610

return getattr(obj, "_dbus_is_property", False)

611

612

def _get_all_dbus_properties(self):

613

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

614

"""

615

return ((prop._dbus_name, prop)

616

for name, prop in

617

inspect.getmembers(self, self._is_dbus_property))

618

1220

619

def _get_dbus_property(self, interface_name, property_name):

1221

620

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

1222

621

property with the specified name and interface.

1223

622

"""

1224

for cls in self.__class__.__mro__:

1225

for name, value in inspect.getmembers(

1226

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

1227

if (value._dbus_name == property_name

1228

and value._dbus_interface == interface_name):

1229

return value.__get__(self)

1230

623

for name in (property_name,

624

property_name + "_dbus_property"):

625

prop = getattr(self, name, None)

626

if (prop is None

627

or not self._is_dbus_property(prop)

628

or prop._dbus_name != property_name

629

or (interface_name and prop._dbus_interface

630

and interface_name != prop._dbus_interface)):

631

continue

632

return prop

1231

633

# No such property

1232

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

1233

self.dbus_object_path, interface_name, property_name))

1234

1235

@classmethod

1236

def _get_all_interface_names(cls):

1237

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

1238

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

1239

"_dbus_interface", None)

1240

for x in (inspect.getmro(cls))

1241

for attr in dir(x))

1242

if name is not None)

1243

1244

@dbus.service.method(dbus.PROPERTIES_IFACE,

1245

in_signature="ss",

634

raise DBusPropertyNotFound(self.dbus_object_path + ":"

635

+ interface_name + "."

636

+ property_name)

637

638

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

1246

639

out_signature="v")

1247

640

def Get(self, interface_name, property_name):

1248

641

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

1266

659

# The byte_arrays option is not supported yet on

1267

660

# signatures other than "ay".

1268

661

if prop._dbus_signature != "ay":

1269

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

1270

"'ay' signature {!r}"

1271

.format(prop._dbus_signature))

1272

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

1273

for byte in value))

662

raise ValueError

663

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

664

for byte in value))

1274

665

prop(value)

1275

666

1276

@dbus.service.method(dbus.PROPERTIES_IFACE,

1277

in_signature="s",

667

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

1278

668

out_signature="a{sv}")

1279

669

def GetAll(self, interface_name):

1280

670

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

1281

671

standard.

1282

672

1283

673

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

1284

674

"""

1285

properties = {}

1286

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

675

all = {}

676

for name, prop in self._get_all_dbus_properties():

1287

677

if (interface_name

1288

678

and interface_name != prop._dbus_interface):

1289

679

# Interface non-empty but did not match

1293

683

continue

1294

684

value = prop()

1295

685

if not hasattr(value, "variant_level"):

1296

properties[name] = value

686

all[name] = value

1297

687

continue

1298

properties[name] = type(value)(

1299

value, variant_level = value.variant_level + 1)

1300

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

1301

1302

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

1303

def PropertiesChanged(self, interface_name, changed_properties,

1304

invalidated_properties):

1305

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

1306

standard.

1307

"""

1308

pass

688

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

689

value.variant_level+1)

690

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

1309

691

1310

692

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1311

693

out_signature="s",

1312

694

path_keyword='object_path',

1313

695

connection_keyword='connection')

1314

696

def Introspect(self, object_path, connection):

1315

"""Overloading of standard D-Bus method.

1316

1317

Inserts property tags and interface annotation tags.

697

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

1318

698

"""

1319

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1320

object_path,

1321

connection)

699

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

700

connection)

1322

701

try:

1323

702

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

1324

1325

703

def make_tag(document, name, prop):

1326

704

e = document.createElement("property")

1327

705

e.setAttribute("name", name)

1328

706

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

1329

707

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

1330

708

return e

1331

1332

709

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

1333

# Add property tags

1334

710

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

1335

711

for name, prop

1336

in self._get_all_dbus_things("property")

712

in self._get_all_dbus_properties()

1337

713

if prop._dbus_interface

1338

714

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

1339

715

if_tag.appendChild(tag)

1340

# Add annotation tags for properties

1341

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

1342

annots = dict()

1343

for name, prop in self._get_all_dbus_things(

1344

"property"):

1345

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

1346

and prop._dbus_interface

1347

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

1348

annots.update(getattr(

1349

prop, "_dbus_annotations", {}))

1350

for name, value in annots.items():

1351

ann_tag = document.createElement(

1352

"annotation")

1353

ann_tag.setAttribute("name", name)

1354

ann_tag.setAttribute("value", value)

1355

tag.appendChild(ann_tag)

1356

716

# Add the names to the return values for the

1357

717

# "org.freedesktop.DBus.Properties" methods

1358

718

if (if_tag.getAttribute("name")

1373

733

except (AttributeError, xml.dom.DOMException,

1374

734

xml.parsers.expat.ExpatError) as error:

1375

735

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

1376

exc_info=error)

1377

return xmlstring

1378

1379

try:

1380

dbus.OBJECT_MANAGER_IFACE

1381

except AttributeError:

1382

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

1383

1384

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1385

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

1386

1387

Classes inheriting from this exposes the standard

1388

GetManagedObjects call and the InterfacesAdded and

1389

InterfacesRemoved signals on the standard

1390

"org.freedesktop.DBus.ObjectManager" interface.

1391

1392

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

1393

manually.

1394

"""

1395

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1396

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

1397

def GetManagedObjects(self):

1398

"""This function must be overridden"""

1399

raise NotImplementedError()

1400

1401

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1402

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

1403

def InterfacesAdded(self, object_path, interfaces_and_properties):

1404

pass

1405

1406

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

1407

def InterfacesRemoved(self, object_path, interfaces):

1408

pass

1409

1410

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1411

out_signature = "s",

1412

path_keyword = 'object_path',

1413

connection_keyword = 'connection')

1414

def Introspect(self, object_path, connection):

1415

"""Overloading of standard D-Bus method.

1416

1417

Override return argument name of GetManagedObjects to be

1418

"objpath_interfaces_and_properties"

1419

"""

1420

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1421

object_path,

1422

connection)

1423

try:

1424

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

1425

1426

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

1427

# Fix argument name for the GetManagedObjects method

1428

if (if_tag.getAttribute("name")

1429

== dbus.OBJECT_MANAGER_IFACE):

1430

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

1431

if (cn.getAttribute("name")

1432

== "GetManagedObjects"):

1433

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

1434

if (arg.getAttribute("direction")

1435

== "out"):

1436

arg.setAttribute(

1437

"name",

1438

"objpath_interfaces"

1439

"_and_properties")

1440

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

1441

document.unlink()

1442

except (AttributeError, xml.dom.DOMException,

1443

xml.parsers.expat.ExpatError) as error:

1444

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

1445

exc_info = error)

1446

return xmlstring

1447

1448

def datetime_to_dbus(dt, variant_level=0):

1449

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

1450

if dt is None:

1451

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

1452

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

1453

1454

1455

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1456

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

1457

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

1458

interface names according to the "alt_interface_names" mapping.

1459

Usage:

1460

1461

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

1462

"net.example.AlternateInterface"})

1463

class SampleDBusObject(dbus.service.Object):

1464

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

1465

def SampleDBusMethod():

1466

pass

1467

1468

The above "SampleDBusMethod" on "SampleDBusObject" will be

1469

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

1470

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

1471

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

1472

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

1473

1474

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

1475

(from DBusObjectWithProperties) and interfaces (from the

1476

dbus_interface_annotations decorator).

1477

"""

1478

1479

def wrapper(cls):

1480

for orig_interface_name, alt_interface_name in (

1481

alt_interface_names.items()):

1482

attr = {}

1483

interface_names = set()

1484

# Go though all attributes of the class

1485

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

1486

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

1487

# with the wrong interface name

1488

if (not hasattr(attribute, "_dbus_interface")

1489

or not attribute._dbus_interface.startswith(

1490

orig_interface_name)):

1491

continue

1492

# Create an alternate D-Bus interface name based on

1493

# the current name

1494

alt_interface = attribute._dbus_interface.replace(

1495

orig_interface_name, alt_interface_name)

1496

interface_names.add(alt_interface)

1497

# Is this a D-Bus signal?

1498

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

1499

if sys.version_info.major == 2:

1500

# Extract the original non-method undecorated

1501

# function by black magic

1502

nonmethod_func = (dict(

1503

zip(attribute.func_code.co_freevars,

1504

attribute.__closure__))

1505

["func"].cell_contents)

1506

else:

1507

nonmethod_func = attribute

1508

# Create a new, but exactly alike, function

1509

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

1510

# with the alternate D-Bus interface name

1511

if sys.version_info.major == 2:

1512

new_function = types.FunctionType(

1513

nonmethod_func.func_code,

1514

nonmethod_func.func_globals,

1515

nonmethod_func.func_name,

1516

nonmethod_func.func_defaults,

1517

nonmethod_func.func_closure)

1518

else:

1519

new_function = types.FunctionType(

1520

nonmethod_func.__code__,

1521

nonmethod_func.__globals__,

1522

nonmethod_func.__name__,

1523

nonmethod_func.__defaults__,

1524

nonmethod_func.__closure__)

1525

new_function = (dbus.service.signal(

1526

alt_interface,

1527

attribute._dbus_signature)(new_function))

1528

# Copy annotations, if any

1529

try:

1530

new_function._dbus_annotations = dict(

1531

attribute._dbus_annotations)

1532

except AttributeError:

1533

pass

1534

# Define a creator of a function to call both the

1535

# original and alternate functions, so both the

1536

# original and alternate signals gets sent when

1537

# the function is called

1538

def fixscope(func1, func2):

1539

"""This function is a scope container to pass

1540

func1 and func2 to the "call_both" function

1541

outside of its arguments"""

1542

1543

@functools.wraps(func2)

1544

def call_both(*args, **kwargs):

1545

"""This function will emit two D-Bus

1546

signals by calling func1 and func2"""

1547

func1(*args, **kwargs)

1548

func2(*args, **kwargs)

1549

# Make wrapper function look like a D-Bus signal

1550

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

1551

if name.startswith("_dbus_"):

1552

setattr(call_both, name, attr)

1553

1554

return call_both

1555

# Create the "call_both" function and add it to

1556

# the class

1557

attr[attrname] = fixscope(attribute, new_function)

1558

# Is this a D-Bus method?

1559

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

1560

# Create a new, but exactly alike, function

1561

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

1562

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

1563

# to the class.

1564

attr[attrname] = (

1565

dbus.service.method(

1566

alt_interface,

1567

attribute._dbus_in_signature,

1568

attribute._dbus_out_signature)

1569

(types.FunctionType(attribute.func_code,

1570

attribute.func_globals,

1571

attribute.func_name,

1572

attribute.func_defaults,

1573

attribute.func_closure)))

1574

# Copy annotations, if any

1575

try:

1576

attr[attrname]._dbus_annotations = dict(

1577

attribute._dbus_annotations)

1578

except AttributeError:

1579

pass

1580

# Is this a D-Bus property?

1581

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

1582

# Create a new, but exactly alike, function

1583

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

1584

# property with the alternate D-Bus interface

1585

# name. Add it to the class.

1586

attr[attrname] = (dbus_service_property(

1587

alt_interface, attribute._dbus_signature,

1588

attribute._dbus_access,

1589

attribute._dbus_get_args_options

1590

["byte_arrays"])

1591

(types.FunctionType(

1592

attribute.func_code,

1593

attribute.func_globals,

1594

attribute.func_name,

1595

attribute.func_defaults,

1596

attribute.func_closure)))

1597

# Copy annotations, if any

1598

try:

1599

attr[attrname]._dbus_annotations = dict(

1600

attribute._dbus_annotations)

1601

except AttributeError:

1602

pass

1603

# Is this a D-Bus interface?

1604

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

1605

# Create a new, but exactly alike, function

1606

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

1607

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

1608

# to the class.

1609

attr[attrname] = (

1610

dbus_interface_annotations(alt_interface)

1611

(types.FunctionType(attribute.func_code,

1612

attribute.func_globals,

1613

attribute.func_name,

1614

attribute.func_defaults,

1615

attribute.func_closure)))

1616

if deprecate:

1617

# Deprecate all alternate interfaces

1618

iname="_AlternateDBusNames_interface_annotation{}"

1619

for interface_name in interface_names:

1620

1621

@dbus_interface_annotations(interface_name)

1622

def func(self):

1623

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

1624

"true" }

1625

# Find an unused name

1626

for aname in (iname.format(i)

1627

for i in itertools.count()):

1628

if aname not in attr:

1629

attr[aname] = func

1630

break

1631

if interface_names:

1632

# Replace the class with a new subclass of it with

1633

# methods, signals, etc. as created above.

1634

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

1635

(cls, ), attr)

1636

return cls

1637

1638

return wrapper

1639

1640

1641

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

1642

"se.bsnet.fukt.Mandos"})

736

error)

737

return xmlstring

738

739

1643

740

class ClientDBus(Client, DBusObjectWithProperties):

1644

741

"""A Client class using D-Bus

1645

742

1649

746

"""

1650

747

1651

748

runtime_expansions = (Client.runtime_expansions

1652

+ ("dbus_object_path", ))

1653

1654

_interface = "se.recompile.Mandos.Client"

749

+ ("dbus_object_path",))

1655

750

1656

751

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

1657

752

1658

753

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

754

self._approvals_pending = 0

1659

755

self.bus = bus

1660

756

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

1661

757

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

1662

758

# the D-Bus

1663

client_object_name = str(self.name).translate(

759

client_object_name = unicode(self.name).translate(

1664

760

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

1665

761

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

1666

self.dbus_object_path = dbus.ObjectPath(

1667

"/clients/" + client_object_name)

762

self.dbus_object_path = (dbus.ObjectPath

763

("/clients/" + client_object_name))

1668

764

DBusObjectWithProperties.__init__(self, self.bus,

1669

765

self.dbus_object_path)

1670

1671

def notifychangeproperty(transform_func, dbus_name,

1672

type_func=lambda x: x,

1673

variant_level=1,

1674

invalidate_only=False,

1675

_interface=_interface):

1676

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

1677

its changes to DBus.

1678

1679

transform_fun: Function that takes a value and a variant_level

1680

and transforms it to a D-Bus type.

1681

dbus_name: D-Bus name of the variable

1682

type_func: Function that transform the value before sending it

1683

to the D-Bus. Default: no transform

1684

variant_level: D-Bus variant level. Default: 1

1685

"""

1686

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

1687

1688

def setter(self, value):

1689

if hasattr(self, "dbus_object_path"):

1690

if (not hasattr(self, attrname) or

1691

type_func(getattr(self, attrname, None))

1692

!= type_func(value)):

1693

if invalidate_only:

1694

self.PropertiesChanged(

1695

_interface, dbus.Dictionary(),

1696

dbus.Array((dbus_name, )))

1697

else:

1698

dbus_value = transform_func(

1699

type_func(value),

1700

variant_level = variant_level)

1701

self.PropertyChanged(dbus.String(dbus_name),

1702

dbus_value)

1703

self.PropertiesChanged(

1704

_interface,

1705

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

1706

dbus_value }),

1707

dbus.Array())

1708

setattr(self, attrname, value)

1709

1710

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

1711

1712

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1713

approvals_pending = notifychangeproperty(dbus.Boolean,

1714

"ApprovalPending",

1715

type_func = bool)

1716

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

1717

last_enabled = notifychangeproperty(datetime_to_dbus,

1718

"LastEnabled")

1719

checker = notifychangeproperty(

1720

dbus.Boolean, "CheckerRunning",

1721

type_func = lambda checker: checker is not None)

1722

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1723

"LastCheckedOK")

1724

last_checker_status = notifychangeproperty(dbus.Int16,

1725

"LastCheckerStatus")

1726

last_approval_request = notifychangeproperty(

1727

datetime_to_dbus, "LastApprovalRequest")

1728

approved_by_default = notifychangeproperty(dbus.Boolean,

1729

"ApprovedByDefault")

1730

approval_delay = notifychangeproperty(

1731

dbus.UInt64, "ApprovalDelay",

1732

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

1733

approval_duration = notifychangeproperty(

1734

dbus.UInt64, "ApprovalDuration",

1735

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

1736

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

1737

timeout = notifychangeproperty(

1738

dbus.UInt64, "Timeout",

1739

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

1740

extended_timeout = notifychangeproperty(

1741

dbus.UInt64, "ExtendedTimeout",

1742

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

1743

interval = notifychangeproperty(

1744

dbus.UInt64, "Interval",

1745

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

1746

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

1747

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

1748

invalidate_only=True)

1749

1750

del notifychangeproperty

766

767

def _get_approvals_pending(self):

768

return self._approvals_pending

769

def _set_approvals_pending(self, value):

770

old_value = self._approvals_pending

771

self._approvals_pending = value

772

bval = bool(value)

773

if (hasattr(self, "dbus_object_path")

774

and bval is not bool(old_value)):

775

dbus_bool = dbus.Boolean(bval, variant_level=1)

776

self.PropertyChanged(dbus.String("ApprovalPending"),

777

dbus_bool)

778

779

approvals_pending = property(_get_approvals_pending,

780

_set_approvals_pending)

781

del _get_approvals_pending, _set_approvals_pending

782

783

@staticmethod

784

def _datetime_to_dbus(dt, variant_level=0):

785

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

786

return dbus.String(dt.isoformat(),

787

variant_level=variant_level)

788

789

def enable(self):

790

oldstate = getattr(self, "enabled", False)

791

r = Client.enable(self)

792

if oldstate != self.enabled:

793

# Emit D-Bus signals

794

self.PropertyChanged(dbus.String("Enabled"),

795

dbus.Boolean(True, variant_level=1))

796

self.PropertyChanged(

797

dbus.String("LastEnabled"),

798

self._datetime_to_dbus(self.last_enabled,

799

variant_level=1))

800

return r

801

802

def disable(self, quiet = False):

803

oldstate = getattr(self, "enabled", False)

804

r = Client.disable(self, quiet=quiet)

805

if not quiet and oldstate != self.enabled:

806

# Emit D-Bus signal

807

self.PropertyChanged(dbus.String("Enabled"),

808

dbus.Boolean(False, variant_level=1))

809

return r

1751

810

1752

811

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

1753

812

try:

1758

817

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

1759

818

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

1760

819

1761

def checker_callback(self, source, condition,

1762

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

1763

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

1764

connection, command, *args,

1765

**kwargs)

1766

exitstatus = self.last_checker_status

1767

if exitstatus >= 0:

820

def checker_callback(self, pid, condition, command,

821

*args, **kwargs):

822

self.checker_callback_tag = None

823

self.checker = None

824

# Emit D-Bus signal

825

self.PropertyChanged(dbus.String("CheckerRunning"),

826

dbus.Boolean(False, variant_level=1))

827

if os.WIFEXITED(condition):

828

exitstatus = os.WEXITSTATUS(condition)

1768

829

# Emit D-Bus signal

1769

830

self.CheckerCompleted(dbus.Int16(exitstatus),

1770

# This is specific to GNU libC

1771

dbus.Int64(exitstatus << 8),

831

dbus.Int64(condition),

1772

832

dbus.String(command))

1773

833

else:

1774

834

# Emit D-Bus signal

1775

835

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

1776

dbus.Int64(

1777

# This is specific to GNU libC

1778

(exitstatus << 8)

1779

| self.last_checker_signal),

836

dbus.Int64(condition),

1780

837

dbus.String(command))

1781

return ret

838

839

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

840

*args, **kwargs)

841

842

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

843

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

844

# Emit D-Bus signal

845

self.PropertyChanged(

846

dbus.String("LastCheckedOK"),

847

(self._datetime_to_dbus(self.last_checked_ok,

848

variant_level=1)))

849

850

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

851

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

852

# Emit D-Bus signal

853

self.PropertyChanged(

854

dbus.String("LastApprovalRequest"),

855

(self._datetime_to_dbus(self.last_approval_request,

856

variant_level=1)))

857

return r

1782

858

1783

859

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

1784

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

860

old_checker = self.checker

861

if self.checker is not None:

862

old_checker_pid = self.checker.pid

863

else:

864

old_checker_pid = None

1785

865

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

1786

866

# Only if new checker process was started

1787

867

if (self.checker is not None

1788

868

and old_checker_pid != self.checker.pid):

1789

869

# Emit D-Bus signal

1790

870

self.CheckerStarted(self.current_checker_command)

871

self.PropertyChanged(

872

dbus.String("CheckerRunning"),

873

dbus.Boolean(True, variant_level=1))

1791

874

return r

1792

875

876

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

877

old_checker = getattr(self, "checker", None)

878

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

879

if (old_checker is not None

880

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

881

self.PropertyChanged(dbus.String("CheckerRunning"),

882

dbus.Boolean(False, variant_level=1))

883

return r

884

1793

885

def _reset_approved(self):

1794

self.approved = None

886

self._approved = None

1795

887

return False

1796

888

1797

889

def approve(self, value=True):

1798

self.approved = value

1799

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

1800

* 1000), self._reset_approved)

1801

890

self.send_changedstate()

891

self._approved = value

892

gobject.timeout_add(self._timedelta_to_milliseconds

893

(self.approval_duration),

894

self._reset_approved)

895

1802

896

1803

897

## D-Bus methods, signals & properties

1804

1805

## Interfaces

898

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

1806

899

1807

900

## Signals

1808

901

1819

912

pass

1820

913

1821

914

# PropertyChanged - signal

1822

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

1823

915

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

1824

916

def PropertyChanged(self, property, value):

1825

917

"D-Bus signal"

1859

951

self.checked_ok()

1860

952

1861

953

# Enable - method

1862

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

1863

954

@dbus.service.method(_interface)

1864

955

def Enable(self):

1865

956

"D-Bus method"

1866

957

self.enable()

1867

958

1868

959

# StartChecker - method

1869

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

1870

960

@dbus.service.method(_interface)

1871

961

def StartChecker(self):

1872

962

"D-Bus method"

1873

963

self.start_checker()

1874

964

1875

965

# Disable - method

1876

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

1877

966

@dbus.service.method(_interface)

1878

967

def Disable(self):

1879

968

"D-Bus method"

1880

969

self.disable()

1881

970

1882

971

# StopChecker - method

1883

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

1884

972

@dbus.service.method(_interface)

1885

973

def StopChecker(self):

1886

974

self.stop_checker()

1893

981

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

1894

982

1895

983

# ApprovedByDefault - property

1896

@dbus_service_property(_interface,

1897

signature="b",

984

@dbus_service_property(_interface, signature="b",

1898

985

access="readwrite")

1899

986

def ApprovedByDefault_dbus_property(self, value=None):

1900

987

if value is None: # get

1901

988

return dbus.Boolean(self.approved_by_default)

1902

989

self.approved_by_default = bool(value)

990

# Emit D-Bus signal

991

self.PropertyChanged(dbus.String("ApprovedByDefault"),

992

dbus.Boolean(value, variant_level=1))

1903

993

1904

994

# ApprovalDelay - property

1905

@dbus_service_property(_interface,

1906

signature="t",

995

@dbus_service_property(_interface, signature="t",

1907

996

access="readwrite")

1908

997

def ApprovalDelay_dbus_property(self, value=None):

1909

998

if value is None: # get

1910

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

1911

* 1000)

999

return dbus.UInt64(self.approval_delay_milliseconds())

1912

1000

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

1001

# Emit D-Bus signal

1002

self.PropertyChanged(dbus.String("ApprovalDelay"),

1003

dbus.UInt64(value, variant_level=1))

1913

1004

1914

1005

# ApprovalDuration - property

1915

@dbus_service_property(_interface,

1916

signature="t",

1006

@dbus_service_property(_interface, signature="t",

1917

1007

access="readwrite")

1918

1008

def ApprovalDuration_dbus_property(self, value=None):

1919

1009

if value is None: # get

1920

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

1921

* 1000)

1010

return dbus.UInt64(self._timedelta_to_milliseconds(

1011

self.approval_duration))

1922

1012

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

1013

# Emit D-Bus signal

1014

self.PropertyChanged(dbus.String("ApprovalDuration"),

1015

dbus.UInt64(value, variant_level=1))

1923

1016

1924

1017

# Name - property

1925

@dbus_annotations(

1926

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

1927

1018

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

1928

1019

def Name_dbus_property(self):

1929

1020

return dbus.String(self.name)

1930

1021

1931

1022

# Fingerprint - property

1932

@dbus_annotations(

1933

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

1934

1023

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

1935

1024

def Fingerprint_dbus_property(self):

1936

1025

return dbus.String(self.fingerprint)

1937

1026

1938

1027

# Host - property

1939

@dbus_service_property(_interface,

1940

signature="s",

1028

@dbus_service_property(_interface, signature="s",

1941

1029

access="readwrite")

1942

1030

def Host_dbus_property(self, value=None):

1943

1031

if value is None: # get

1944

1032

return dbus.String(self.host)

1945

self.host = str(value)

1033

self.host = value

1034

# Emit D-Bus signal

1035

self.PropertyChanged(dbus.String("Host"),

1036

dbus.String(value, variant_level=1))

1946

1037

1947

1038

# Created - property

1948

@dbus_annotations(

1949

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

1950

1039

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

1951

1040

def Created_dbus_property(self):

1952

return datetime_to_dbus(self.created)

1041

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

1953

1042

1954

1043

# LastEnabled - property

1955

1044

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

1956

1045

def LastEnabled_dbus_property(self):

1957

return datetime_to_dbus(self.last_enabled)

1046

if self.last_enabled is None:

1047

return dbus.String("")

1048

return dbus.String(self._datetime_to_dbus(self.last_enabled))

1958

1049

1959

1050

# Enabled - property

1960

@dbus_service_property(_interface,

1961

signature="b",

1051

@dbus_service_property(_interface, signature="b",

1962

1052

access="readwrite")

1963

1053

def Enabled_dbus_property(self, value=None):

1964

1054

if value is None: # get

1969

1059

self.disable()

1970

1060

1971

1061

# LastCheckedOK - property

1972

@dbus_service_property(_interface,

1973

signature="s",

1062

@dbus_service_property(_interface, signature="s",

1974

1063

access="readwrite")

1975

1064

def LastCheckedOK_dbus_property(self, value=None):

1976

1065

if value is not None:

1977

1066

self.checked_ok()

1978

1067

return

1979

return datetime_to_dbus(self.last_checked_ok)

1980

1981

# LastCheckerStatus - property

1982

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

1983

def LastCheckerStatus_dbus_property(self):

1984

return dbus.Int16(self.last_checker_status)

1985

1986

# Expires - property

1987

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

1988

def Expires_dbus_property(self):

1989

return datetime_to_dbus(self.expires)

1068

if self.last_checked_ok is None:

1069

return dbus.String("")

1070

return dbus.String(self._datetime_to_dbus(self

1071

.last_checked_ok))

1990

1072

1991

1073

# LastApprovalRequest - property

1992

1074

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

1993

1075

def LastApprovalRequest_dbus_property(self):

1994

return datetime_to_dbus(self.last_approval_request)

1076

if self.last_approval_request is None:

1077

return dbus.String("")

1078

return dbus.String(self.

1079

_datetime_to_dbus(self

1080

.last_approval_request))

1995

1081

1996

1082

# Timeout - property

1997

@dbus_service_property(_interface,

1998

signature="t",

1083

@dbus_service_property(_interface, signature="t",

1999

1084

access="readwrite")

2000

1085

def Timeout_dbus_property(self, value=None):

2001

1086

if value is None: # get

2002

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

2003

old_timeout = self.timeout

1087

return dbus.UInt64(self.timeout_milliseconds())

2004

1088

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

2005

# Reschedule disabling

2006

if self.enabled:

2007

now = datetime.datetime.utcnow()

2008

self.expires += self.timeout - old_timeout

2009

if self.expires <= now:

2010

# The timeout has passed

2011

self.disable()

2012

else:

2013

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

2014

is None):

2015

return

2016

gobject.source_remove(self.disable_initiator_tag)

2017

self.disable_initiator_tag = gobject.timeout_add(

2018

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

2019

self.disable)

2020

2021

# ExtendedTimeout - property

2022

@dbus_service_property(_interface,

2023

signature="t",

2024

access="readwrite")

2025

def ExtendedTimeout_dbus_property(self, value=None):

2026

if value is None: # get

2027

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

2028

* 1000)

2029

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

1089

# Emit D-Bus signal

1090

self.PropertyChanged(dbus.String("Timeout"),

1091

dbus.UInt64(value, variant_level=1))

1092

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

1093

return

1094

# Reschedule timeout

1095

gobject.source_remove(self.disable_initiator_tag)

1096

self.disable_initiator_tag = None

1097

time_to_die = (self.

1098

_timedelta_to_milliseconds((self

1099

.last_checked_ok

1100

+ self.timeout)

1101

- datetime.datetime

1102

.utcnow()))

1103

if time_to_die <= 0:

1104

# The timeout has passed

1105

self.disable()

1106

else:

1107

self.disable_initiator_tag = (gobject.timeout_add

1108

(time_to_die, self.disable))

2030

1109

2031

1110

# Interval - property

2032

@dbus_service_property(_interface,

2033

signature="t",

1111

@dbus_service_property(_interface, signature="t",

2034

1112

access="readwrite")

2035

1113

def Interval_dbus_property(self, value=None):

2036

1114

if value is None: # get

2037

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

1115

return dbus.UInt64(self.interval_milliseconds())

2038

1116

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

1117

# Emit D-Bus signal

1118

self.PropertyChanged(dbus.String("Interval"),

1119

dbus.UInt64(value, variant_level=1))

2039

1120

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

2040

1121

return

2041

if self.enabled:

2042

# Reschedule checker run

2043

gobject.source_remove(self.checker_initiator_tag)

2044

self.checker_initiator_tag = gobject.timeout_add(

2045

value, self.start_checker)

2046

self.start_checker() # Start one now, too

2047

1122

# Reschedule checker run

1123

gobject.source_remove(self.checker_initiator_tag)

1124

self.checker_initiator_tag = (gobject.timeout_add

1125

(value, self.start_checker))

1126

self.start_checker() # Start one now, too

1127

2048

1128

# Checker - property

2049

@dbus_service_property(_interface,

2050

signature="s",

1129

@dbus_service_property(_interface, signature="s",

2051

1130

access="readwrite")

2052

1131

def Checker_dbus_property(self, value=None):

2053

1132

if value is None: # get

2054

1133

return dbus.String(self.checker_command)

2055

self.checker_command = str(value)

1134

self.checker_command = value

1135

# Emit D-Bus signal

1136

self.PropertyChanged(dbus.String("Checker"),

1137

dbus.String(self.checker_command,

1138

variant_level=1))

2056

1139

2057

1140

# CheckerRunning - property

2058

@dbus_service_property(_interface,

2059

signature="b",

1141

@dbus_service_property(_interface, signature="b",

2060

1142

access="readwrite")

2061

1143

def CheckerRunning_dbus_property(self, value=None):

2062

1144

if value is None: # get

2067

1149

self.stop_checker()

2068

1150

2069

1151

# ObjectPath - property

2070

@dbus_annotations(

2071

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

2072

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

2073

1152

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

2074

1153

def ObjectPath_dbus_property(self):

2075

1154

return self.dbus_object_path # is already a dbus.ObjectPath

2076

1155

2077

1156

# Secret = property

2078

@dbus_annotations(

2079

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

2080

"invalidates"})

2081

@dbus_service_property(_interface,

2082

signature="ay",

2083

access="write",

2084

byte_arrays=True)

1157

@dbus_service_property(_interface, signature="ay",

1158

access="write", byte_arrays=True)

2085

1159

def Secret_dbus_property(self, value):

2086

self.secret = bytes(value)

1160

self.secret = str(value)

2087

1161

2088

1162

del _interface

2089

1163

2093

1167

self._pipe = child_pipe

2094

1168

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

2095

1169

if not self._pipe.recv():

2096

raise KeyError(fpr)

2097

1170

raise KeyError()

1171

2098

1172

def __getattribute__(self, name):

2099

if name == '_pipe':

1173

if(name == '_pipe'):

2100

1174

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

2101

1175

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

2102

1176

data = self._pipe.recv()

2103

1177

if data[0] == 'data':

2104

1178

return data[1]

2105

1179

if data[0] == 'function':

2106

2107

1180

def func(*args, **kwargs):

2108

1181

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

2109

1182

return self._pipe.recv()[1]

2110

2111

1183

return func

2112

1184

2113

1185

def __setattr__(self, name, value):

2114

if name == '_pipe':

1186

if(name == '_pipe'):

2115

1187

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

2116

1188

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

2117

1189

2125

1197

def handle(self):

2126

1198

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

2127

1199

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

2128

str(self.client_address))

1200

unicode(self.client_address))

2129

1201

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

2130

1202

self.server.child_pipe.fileno())

2131

2132

session = gnutls.ClientSession(self.request)

2133

1203

1204

session = (gnutls.connection

1205

.ClientSession(self.request,

1206

gnutls.connection

1207

.X509Credentials()))

1208

1209

# Note: gnutls.connection.X509Credentials is really a

1210

# generic GnuTLS certificate credentials object so long as

1211

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

1212

# here despite using OpenPGP certificates.

1213

2134

1214

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

2135

1215

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

2136

1216

# "+COMP-NULL", "+CTYPE-OPENPGP",

2139

1219

priority = self.server.gnutls_priority

2140

1220

if priority is None:

2141

1221

priority = "NORMAL"

2142

gnutls.priority_set_direct(session._c_object, priority,

2143

None)

2144

1222

(gnutls.library.functions

1223

.gnutls_priority_set_direct(session._c_object,

1224

priority, None))

1225

2145

1226

# Start communication using the Mandos protocol

2146

1227

# Get protocol number

2147

1228

line = self.request.makefile().readline()

2148

1229

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

2149

1230

try:

2150

1231

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

2151

raise RuntimeError(line)

1232

raise RuntimeError

2152

1233

except (ValueError, IndexError, RuntimeError) as error:

2153

1234

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

2154

1235

return

2155

1236

2156

1237

# Start GnuTLS connection

2157

1238

try:

2158

1239

session.handshake()

2159

except gnutls.Error as error:

1240

except gnutls.errors.GNUTLSError as error:

2160

1241

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

2161

1242

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

2162

1243

# established. Just abandon the request.

2163

1244

return

2164

1245

logger.debug("Handshake succeeded")

2165

1246

2166

1247

approval_required = False

2167

1248

try:

2168

1249

try:

2169

fpr = self.fingerprint(

2170

self.peer_certificate(session))

2171

except (TypeError, gnutls.Error) as error:

1250

fpr = self.fingerprint(self.peer_certificate

1251

(session))

1252

except (TypeError,

1253

gnutls.errors.GNUTLSError) as error:

2172

1254

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

2173

1255

return

2174

1256

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

2175

1257

2176

1258

try:

2177

1259

client = ProxyClient(child_pipe, fpr,

2178

1260

self.client_address)

2187

1269

while True:

2188

1270

if not client.enabled:

2189

1271

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

2190

client.name)

1272

client.name)

2191

1273

if self.server.use_dbus:

2192

1274

# Emit D-Bus signal

2193

client.Rejected("Disabled")

1275

client.Rejected("Disabled")

2194

1276

return

2195

1277

2196

if client.approved or not client.approval_delay:

1278

if client._approved or not client.approval_delay:

2197

1279

#We are approved or approval is disabled

2198

1280

break

2199

elif client.approved is None:

1281

elif client._approved is None:

2200

1282

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

2201

1283

client.name)

2202

1284

if self.server.use_dbus:

2203

1285

# Emit D-Bus signal

2204

1286

client.NeedApproval(

2205

client.approval_delay.total_seconds()

2206

* 1000, client.approved_by_default)

1287

client.approval_delay_milliseconds(),

1288

client.approved_by_default)

2207

1289

else:

2208

1290

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

2209

1291

client.name)

2213

1295

return

2214

1296

2215

1297

#wait until timeout or approved

1298

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

2216

1299

time = datetime.datetime.now()

2217

1300

client.changedstate.acquire()

2218

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

1301

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

2219

1302

client.changedstate.release()

2220

1303

time2 = datetime.datetime.now()

2221

1304

if (time2 - time) >= delay:

2232

1315

else:

2233

1316

delay -= time2 - time

2234

1317

2235

try:

2236

session.send(client.secret)

2237

except gnutls.Error as error:

2238

logger.warning("gnutls send failed",

2239

exc_info = error)

2240

return

2241

1318

sent_size = 0

1319

while sent_size < len(client.secret):

1320

try:

1321

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

1322

except gnutls.errors.GNUTLSError as error:

1323

logger.warning("gnutls send failed")

1324

return

1325

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

1326

sent, len(client.secret)

1327

- (sent_size + sent))

1328

sent_size += sent

1329

2242

1330

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

2243

# bump the timeout using extended_timeout

2244

client.bump_timeout(client.extended_timeout)

1331

# bump the timeout as if seen

1332

client.checked_ok()

2245

1333

if self.server.use_dbus:

2246

1334

# Emit D-Bus signal

2247

1335

client.GotSecret()

2251

1339

client.approvals_pending -= 1

2252

1340

try:

2253

1341

session.bye()

2254

except gnutls.Error as error:

2255

logger.warning("GnuTLS bye failed",

2256

exc_info=error)

1342

except gnutls.errors.GNUTLSError as error:

1343

logger.warning("GnuTLS bye failed")

2257

1344

2258

1345

@staticmethod

2259

1346

def peer_certificate(session):

2260

1347

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

2261

1348

# If not an OpenPGP certificate...

2262

if (gnutls.certificate_type_get(session._c_object)

2263

!= gnutls.CRT_OPENPGP):

2264

# ...return invalid data

2265

return b""

1349

if (gnutls.library.functions

1350

.gnutls_certificate_type_get(session._c_object)

1351

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1352

# ...do the normal thing

1353

return session.peer_certificate

2266

1354

list_size = ctypes.c_uint(1)

2267

cert_list = (gnutls.certificate_get_peers

1355

cert_list = (gnutls.library.functions

1356

.gnutls_certificate_get_peers

2268

1357

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

2269

1358

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

2270

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

1359

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

1360

" certificate")

2271

1361

if list_size.value == 0:

2272

1362

return None

2273

1363

cert = cert_list[0]

2277

1367

def fingerprint(openpgp):

2278

1368

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2279

1369

# New GnuTLS "datum" with the OpenPGP public key

2280

datum = gnutls.datum_t(

2281

ctypes.cast(ctypes.c_char_p(openpgp),

2282

ctypes.POINTER(ctypes.c_ubyte)),

2283

ctypes.c_uint(len(openpgp)))

1370

datum = (gnutls.library.types

1371

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

1372

ctypes.POINTER

1373

(ctypes.c_ubyte)),

1374

ctypes.c_uint(len(openpgp))))

2284

1375

# New empty GnuTLS certificate

2285

crt = gnutls.openpgp_crt_t()

2286

gnutls.openpgp_crt_init(ctypes.byref(crt))

1376

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1377

(gnutls.library.functions

1378

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2287

1379

# Import the OpenPGP public key into the certificate

2288

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

2289

gnutls.OPENPGP_FMT_RAW)

1380

(gnutls.library.functions

1381

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

1382

gnutls.library.constants

1383

.GNUTLS_OPENPGP_FMT_RAW))

2290

1384

# Verify the self signature in the key

2291

1385

crtverify = ctypes.c_uint()

2292

gnutls.openpgp_crt_verify_self(crt, 0,

2293

ctypes.byref(crtverify))

1386

(gnutls.library.functions

1387

.gnutls_openpgp_crt_verify_self(crt, 0,

1388

ctypes.byref(crtverify)))

2294

1389

if crtverify.value != 0:

2295

gnutls.openpgp_crt_deinit(crt)

2296

raise gnutls.CertificateSecurityError("Verify failed")

1390

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1391

raise (gnutls.errors.CertificateSecurityError

1392

("Verify failed"))

2297

1393

# New buffer for the fingerprint

2298

1394

buf = ctypes.create_string_buffer(20)

2299

1395

buf_len = ctypes.c_size_t()

2300

1396

# Get the fingerprint from the certificate into the buffer

2301

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

2302

ctypes.byref(buf_len))

1397

(gnutls.library.functions

1398

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

1399

ctypes.byref(buf_len)))

2303

1400

# Deinit the certificate

2304

gnutls.openpgp_crt_deinit(crt)

1401

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2305

1402

# Convert the buffer to a Python bytestring

2306

1403

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

2307

1404

# Convert the bytestring to hexadecimal notation

2308

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

1405

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

2309

1406

return hex_fpr

2310

1407

2311

1408

2312

1409

class MultiprocessingMixIn(object):

2313

1410

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

2314

2315

1411

def sub_process_main(self, request, address):

2316

1412

try:

2317

1413

self.finish_request(request, address)

2318

except Exception:

1414

except:

2319

1415

self.handle_error(request, address)

2320

1416

self.close_request(request)

2321

1417

2322

1418

def process_request(self, request, address):

2323

1419

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

2324

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

2325

args = (request, address))

2326

proc.start()

2327

return proc

2328

1420

multiprocessing.Process(target = self.sub_process_main,

1421

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

2329

1422

2330

1423

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2331

1424

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

2332

2333

1425

def process_request(self, request, client_address):

2334

1426

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

2335

1427

2336

1428

This function creates a new pipe in self.pipe

2337

1429

"""

2338

1430

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2339

2340

proc = MultiprocessingMixIn.process_request(self, request,

2341

client_address)

1431

1432

super(MultiprocessingMixInWithPipe,

1433

self).process_request(request, client_address)

2342

1434

self.child_pipe.close()

2343

self.add_pipe(parent_pipe, proc)

2344

2345

def add_pipe(self, parent_pipe, proc):

1435

self.add_pipe(parent_pipe)

1436

1437

def add_pipe(self, parent_pipe):

2346

1438

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

2347

raise NotImplementedError()

2348

1439

raise NotImplementedError

2349

1440

2350

1441

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2351

1442

socketserver.TCPServer, object):

2356

1447

interface: None or a network interface name (string)

2357

1448

use_ipv6: Boolean; to use IPv6 or not

2358

1449

"""

2359

2360

1450

def __init__(self, server_address, RequestHandlerClass,

2361

interface=None,

2362

use_ipv6=True,

2363

socketfd=None):

2364

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

2365

creating a new one with socket.socket().

2366

"""

1451

interface=None, use_ipv6=True):

2367

1452

self.interface = interface

2368

1453

if use_ipv6:

2369

1454

self.address_family = socket.AF_INET6

2370

if socketfd is not None:

2371

# Save the file descriptor

2372

self.socketfd = socketfd

2373

# Save the original socket.socket() function

2374

self.socket_socket = socket.socket

2375

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

2376

#

2377

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

2378

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

2379

# patching socket.socket.)

2380

#

2381

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

2382

@functools.wraps(socket.socket)

2383

def socket_wrapper(*args, **kwargs):

2384

# Restore original function so subsequent calls are

2385

# not affected.

2386

socket.socket = self.socket_socket

2387

del self.socket_socket

2388

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

2389

# saved file descriptor.

2390

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

2391

# Replace socket.socket() function with wrapper

2392

socket.socket = socket_wrapper

2393

# The socketserver.TCPServer.__init__ will call

2394

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

2395

# socket_wrapper(), if socketfd was set.

2396

1455

socketserver.TCPServer.__init__(self, server_address,

2397

1456

RequestHandlerClass)

2398

2399

1457

def server_bind(self):

2400

1458

"""This overrides the normal server_bind() function

2401

1459

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

2407

1465

self.interface)

2408

1466

else:

2409

1467

try:

2410

self.socket.setsockopt(

2411

socket.SOL_SOCKET, SO_BINDTODEVICE,

2412

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

1468

self.socket.setsockopt(socket.SOL_SOCKET,

1469

SO_BINDTODEVICE,

1470

str(self.interface

1471

+ '\0'))

2413

1472

except socket.error as error:

2414

if error.errno == errno.EPERM:

2415

logger.error("No permission to bind to"

2416

" interface %s", self.interface)

2417

elif error.errno == errno.ENOPROTOOPT:

1473

if error[0] == errno.EPERM:

1474

logger.error("No permission to"

1475

" bind to interface %s",

1476

self.interface)

1477

elif error[0] == errno.ENOPROTOOPT:

2418

1478

logger.error("SO_BINDTODEVICE not available;"

2419

1479

" cannot bind to interface %s",

2420

1480

self.interface)

2421

elif error.errno == errno.ENODEV:

2422

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

2423

" cannot bind", self.interface)

2424

1481

else:

2425

1482

raise

2426

1483

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

2429

1486

if self.address_family == socket.AF_INET6:

2430

1487

any_address = "::" # in6addr_any

2431

1488

else:

2432

any_address = "0.0.0.0" # INADDR_ANY

1489

any_address = socket.INADDR_ANY

2433

1490

self.server_address = (any_address,

2434

1491

self.server_address[1])

2435

1492

elif not self.server_address[1]:

2436

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

1493

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

1494

0)

2437

1495

# if self.interface:

2438

1496

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

2439

1497

# 0, # port

2453

1511

2454

1512

Assumes a gobject.MainLoop event loop.

2455

1513

"""

2456

2457

1514

def __init__(self, server_address, RequestHandlerClass,

2458

interface=None,

2459

use_ipv6=True,

2460

clients=None,

2461

gnutls_priority=None,

2462

use_dbus=True,

2463

socketfd=None):

1515

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

1516

gnutls_priority=None, use_dbus=True):

2464

1517

self.enabled = False

2465

1518

self.clients = clients

2466

1519

if self.clients is None:

2467

self.clients = {}

1520

self.clients = set()

2468

1521

self.use_dbus = use_dbus

2469

1522

self.gnutls_priority = gnutls_priority

2470

1523

IPv6_TCPServer.__init__(self, server_address,

2471

1524

RequestHandlerClass,

2472

1525

interface = interface,

2473

use_ipv6 = use_ipv6,

2474

socketfd = socketfd)

2475

1526

use_ipv6 = use_ipv6)

2476

1527

def server_activate(self):

2477

1528

if self.enabled:

2478

1529

return socketserver.TCPServer.server_activate(self)

2479

2480

1530

def enable(self):

2481

1531

self.enabled = True

2482

2483

def add_pipe(self, parent_pipe, proc):

1532

def add_pipe(self, parent_pipe):

2484

1533

# Call "handle_ipc" for both data and EOF events

2485

gobject.io_add_watch(

2486

parent_pipe.fileno(),

2487

gobject.IO_IN | gobject.IO_HUP,

2488

functools.partial(self.handle_ipc,

2489

parent_pipe = parent_pipe,

2490

proc = proc))

2491

2492

def handle_ipc(self, source, condition,

2493

parent_pipe=None,

2494

proc = None,

1534

gobject.io_add_watch(parent_pipe.fileno(),

1535

gobject.IO_IN | gobject.IO_HUP,

1536

functools.partial(self.handle_ipc,

1537

parent_pipe = parent_pipe))

1538

1539

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

2495

1540

client_object=None):

2496

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

2497

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

2498

# Wait for other process to exit

2499

proc.join()

1541

condition_names = {

1542

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

1543

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

1544

# blocking).

1545

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

1546

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

1547

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

1548

# broken, usually for pipes and

1549

# sockets).

1550

}

1551

conditions_string = ' | '.join(name

1552

for cond, name in

1553

condition_names.iteritems()

1554

if cond & condition)

1555

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

1556

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

2500

1557

return False

2501

1558

2502

1559

# Read a request from the child

2507

1564

fpr = request[1]

2508

1565

address = request[2]

2509

1566

2510

for c in self.clients.itervalues():

1567

for c in self.clients:

2511

1568

if c.fingerprint == fpr:

2512

1569

client = c

2513

1570

break

2516

1573

"dress: %s", fpr, address)

2517

1574

if self.use_dbus:

2518

1575

# Emit D-Bus signal

2519

mandos_dbus_service.ClientNotFound(fpr,

2520

address[0])

1576

mandos_dbus_service.ClientNotFound(fpr, address[0])

2521

1577

parent_pipe.send(False)

2522

1578

return False

2523

1579

2524

gobject.io_add_watch(

2525

parent_pipe.fileno(),

2526

gobject.IO_IN | gobject.IO_HUP,

2527

functools.partial(self.handle_ipc,

2528

parent_pipe = parent_pipe,

2529

proc = proc,

2530

client_object = client))

1580

gobject.io_add_watch(parent_pipe.fileno(),

1581

gobject.IO_IN | gobject.IO_HUP,

1582

functools.partial(self.handle_ipc,

1583

parent_pipe = parent_pipe,

1584

client_object = client))

2531

1585

parent_pipe.send(True)

2532

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

2533

# same fileno

1586

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

2534

1587

return False

2535

1588

if command == 'funcall':

2536

1589

funcname = request[1]

2537

1590

args = request[2]

2538

1591

kwargs = request[3]

2539

1592

2540

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

2541

funcname)(*args,

2542

**kwargs)))

2543

1593

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

1594

2544

1595

if command == 'getattr':

2545

1596

attrname = request[1]

2546

if isinstance(client_object.__getattribute__(attrname),

2547

collections.Callable):

2548

parent_pipe.send(('function', ))

1597

if callable(client_object.__getattribute__(attrname)):

1598

parent_pipe.send(('function',))

2549

1599

else:

2550

parent_pipe.send((

2551

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

1600

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

2552

1601

2553

1602

if command == 'setattr':

2554

1603

attrname = request[1]

2555

1604

value = request[2]

2556

1605

setattr(client_object, attrname, value)

2557

1606

2558

1607

return True

2559

1608

2560

1609

2561

def rfc3339_duration_to_delta(duration):

2562

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

2563

2564

>>> rfc3339_duration_to_delta("P7D")

2565

datetime.timedelta(7)

2566

>>> rfc3339_duration_to_delta("PT60S")

2567

datetime.timedelta(0, 60)

2568

>>> rfc3339_duration_to_delta("PT60M")

2569

datetime.timedelta(0, 3600)

2570

>>> rfc3339_duration_to_delta("PT24H")

2571

datetime.timedelta(1)

2572

>>> rfc3339_duration_to_delta("P1W")

2573

datetime.timedelta(7)

2574

>>> rfc3339_duration_to_delta("PT5M30S")

2575

datetime.timedelta(0, 330)

2576

>>> rfc3339_duration_to_delta("P1DT3M20S")

2577

datetime.timedelta(1, 200)

2578

"""

2579

2580

# Parsing an RFC 3339 duration with regular expressions is not

2581

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

2582

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

2583

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

2584

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

2585

# avoid excessive use of external libraries.

2586

2587

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

2588

Token = collections.namedtuple("Token", (

2589

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

2590

# a "group" containing digits

2591

"value", # datetime.timedelta or None

2592

"followers")) # Tokens valid after this token

2593

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

2594

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

2595

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

2596

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

2597

datetime.timedelta(seconds=1),

2598

frozenset((token_end, )))

2599

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

2600

datetime.timedelta(minutes=1),

2601

frozenset((token_second, token_end)))

2602

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

2603

datetime.timedelta(hours=1),

2604

frozenset((token_minute, token_end)))

2605

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

2606

None,

2607

frozenset((token_hour, token_minute,

2608

token_second)))

2609

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

2610

datetime.timedelta(days=1),

2611

frozenset((token_time, token_end)))

2612

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

2613

datetime.timedelta(weeks=4),

2614

frozenset((token_day, token_end)))

2615

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

2616

datetime.timedelta(weeks=52),

2617

frozenset((token_month, token_end)))

2618

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

2619

datetime.timedelta(weeks=1),

2620

frozenset((token_end, )))

2621

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

2622

frozenset((token_year, token_month,

2623

token_day, token_time,

2624

token_week)))

2625

# Define starting values

2626

value = datetime.timedelta() # Value so far

2627

found_token = None

2628

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

2629

s = duration # String left to parse

2630

# Loop until end token is found

2631

while found_token is not token_end:

2632

# Search for any currently valid tokens

2633

for token in followers:

2634

match = token.regexp.match(s)

2635

if match is not None:

2636

# Token found

2637

if token.value is not None:

2638

# Value found, parse digits

2639

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

2640

# Add to value so far

2641

value += factor * token.value

2642

# Strip token from string

2643

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

2644

# Go to found token

2645

found_token = token

2646

# Set valid next tokens

2647

followers = found_token.followers

2648

break

2649

else:

2650

# No currently valid tokens were found

2651

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

2652

.format(duration))

2653

# End token found

2654

return value

2655

2656

2657

1610

def string_to_delta(interval):

2658

1611

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

2659

1612

2670

1623

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

2671

1624

datetime.timedelta(0, 330)

2672

1625

"""

2673

2674

try:

2675

return rfc3339_duration_to_delta(interval)

2676

except ValueError:

2677

pass

2678

2679

1626

timevalue = datetime.timedelta(0)

2680

1627

for s in interval.split():

2681

1628

try:

2682

suffix = s[-1]

1629

suffix = unicode(s[-1])

2683

1630

value = int(s[:-1])

2684

1631

if suffix == "d":

2685

1632

delta = datetime.timedelta(value)

2692

1639

elif suffix == "w":

2693

1640

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

2694

1641

else:

2695

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

2696

except IndexError as e:

1642

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

1643

except (ValueError, IndexError) as e:

2697

1644

raise ValueError(*(e.args))

2698

1645

timevalue += delta

2699

1646

return timevalue

2700

1647

2701

1648

1649

def if_nametoindex(interface):

1650

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

1651

1652

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

1653

global if_nametoindex

1654

try:

1655

if_nametoindex = (ctypes.cdll.LoadLibrary

1656

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

1657

.if_nametoindex)

1658

except (OSError, AttributeError):

1659

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

1660

def if_nametoindex(interface):

1661

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

1662

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

1663

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

1664

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1665

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

1666

interface))

1667

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

1668

ifreq[16:20])[0]

1669

return interface_index

1670

return if_nametoindex(interface)

1671

1672

2702

1673

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

2703

1674

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

2704

1675

2712

1683

sys.exit()

2713

1684

if not noclose:

2714

1685

# Close all standard open file descriptors

2715

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

1686

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

2716

1687

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

2717

1688

raise OSError(errno.ENODEV,

2718

"{} not a character device"

2719

.format(os.devnull))

1689

"%s not a character device"

1690

% os.path.devnull)

2720

1691

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

2721

1692

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

2722

1693

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

2731

1702

2732

1703

parser = argparse.ArgumentParser()

2733

1704

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

2734

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

1705

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

2735

1706

help="show version number and exit")

2736

1707

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

2737

1708

help="Bind to interface IF")

2743

1714

help="Run self-test")

2744

1715

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

2745

1716

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

2746

" to terminal", default=None)

1717

" to terminal")

2747

1718

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

2748

1719

help="Debug level for stdout output")

2749

1720

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

2756

1727

" files")

2757

1728

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

2758

1729

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

2759

" system bus interface", default=None)

1730

" system bus interface")

2760

1731

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

2761

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

2762

default=None)

2763

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

2764

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

2765

" state", default=None)

2766

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

2767

help="Specify a file descriptor to a network"

2768

" socket to use instead of creating one")

2769

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

2770

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

2771

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

2772

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

2773

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

2774

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

2775

default=None)

2776

1732

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

2777

1733

options = parser.parse_args()

2778

1734

2779

1735

if options.check:

2780

1736

import doctest

2781

fail_count, test_count = doctest.testmod()

2782

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

1737

doctest.testmod()

1738

sys.exit()

2783

1739

2784

1740

# Default values for config file for server-global settings

2785

1741

server_defaults = { "interface": "",

2787

1743

"port": "",

2788

1744

"debug": "False",

2789

1745

"priority":

2790

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

2791

":+SIGN-DSA-SHA256",

1746

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

2792

1747

"servicename": "Mandos",

2793

1748

"use_dbus": "True",

2794

1749

"use_ipv6": "True",

2795

1750

"debuglevel": "",

2796

"restore": "True",

2797

"socket": "",

2798

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

2799

"foreground": "False",

2800

"zeroconf": "True",

2801

}

1751

}

2802

1752

2803

1753

# Parse config file for server-global settings

2804

1754

server_config = configparser.SafeConfigParser(server_defaults)

2805

1755

del server_defaults

2806

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

1756

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

1757

"mandos.conf"))

2807

1758

# Convert the SafeConfigParser object to a dict

2808

1759

server_settings = server_config.defaults()

2809

1760

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

2810

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

1761

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

2811

1762

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

2812

1763

option)

2813

1764

if server_settings["port"]:

2814

1765

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

2815

1766

"port")

2816

if server_settings["socket"]:

2817

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

2818

"socket")

2819

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

2820

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

2821

# happen with a supplied network socket.

2822

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

2823

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

2824

["socket"])

2825

1767

del server_config

2826

1768

2827

1769

# Override the settings from the config file with command line

2828

1770

# options, if set.

2829

1771

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

2830

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

2831

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

2832

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

1772

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

1773

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

2833

1774

value = getattr(options, option)

2834

1775

if value is not None:

2835

1776

server_settings[option] = value

2836

1777

del options

2837

1778

# Force all strings to be unicode

2838

1779

for option in server_settings.keys():

2839

if isinstance(server_settings[option], bytes):

2840

server_settings[option] = (server_settings[option]

2841

.decode("utf-8"))

2842

# Force all boolean options to be boolean

2843

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

2844

"foreground", "zeroconf"):

2845

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

2846

# Debug implies foreground

2847

if server_settings["debug"]:

2848

server_settings["foreground"] = True

1780

if type(server_settings[option]) is str:

1781

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

2849

1782

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

2850

1783

2851

1784

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

2852

1785

2853

if (not server_settings["zeroconf"]

2854

and not (server_settings["port"]

2855

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

2856

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

2857

2858

1786

# For convenience

2859

1787

debug = server_settings["debug"]

2860

1788

debuglevel = server_settings["debuglevel"]

2861

1789

use_dbus = server_settings["use_dbus"]

2862

1790

use_ipv6 = server_settings["use_ipv6"]

2863

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

2864

stored_state_file)

2865

foreground = server_settings["foreground"]

2866

zeroconf = server_settings["zeroconf"]

2867

2868

if debug:

2869

initlogger(debug, logging.DEBUG)

2870

else:

2871

if not debuglevel:

2872

initlogger(debug)

2873

else:

2874

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

2875

initlogger(debug, level)

2876

1791

2877

1792

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

2878

syslogger.setFormatter(

2879

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

2880

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

2881

server_settings["servicename"])))

1793

syslogger.setFormatter(logging.Formatter

1794

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

1795

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

1796

% server_settings["servicename"]))

2882

1797

2883

1798

# Parse config file with clients

2884

client_config = configparser.SafeConfigParser(Client

2885

.client_defaults)

1799

client_defaults = { "timeout": "1h",

1800

"interval": "5m",

1801

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

1802

"host": "",

1803

"approval_delay": "0s",

1804

"approval_duration": "1s",

1805

}

1806

client_config = configparser.SafeConfigParser(client_defaults)

2886

1807

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

2887

1808

"clients.conf"))

2888

1809

2889

1810

global mandos_dbus_service

2890

1811

mandos_dbus_service = None

2891

1812

2892

socketfd = None

2893

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

2894

socketfd = server_settings["socket"]

2895

tcp_server = MandosServer(

2896

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

2897

ClientHandler,

2898

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

2899

use_ipv6=use_ipv6,

2900

gnutls_priority=server_settings["priority"],

2901

use_dbus=use_dbus,

2902

socketfd=socketfd)

2903

if not foreground:

2904

pidfilename = "/run/mandos.pid"

2905

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

2906

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

2907

pidfile = None

1813

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

1814

server_settings["port"]),

1815

ClientHandler,

1816

interface=(server_settings["interface"]

1817

or None),

1818

use_ipv6=use_ipv6,

1819

gnutls_priority=

1820

server_settings["priority"],

1821

use_dbus=use_dbus)

1822

if not debug:

1823

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

2908

1824

try:

2909

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

2910

except IOError as e:

2911

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

2912

exc_info=e)

1825

pidfile = open(pidfilename, "w")

1826

except IOError:

1827

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

2913

1828

2914

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

1829

try:

1830

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

1831

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

1832

except KeyError:

2915

1833

try:

2916

uid = pwd.getpwnam(name).pw_uid

2917

gid = pwd.getpwnam(name).pw_gid

2918

break

1834

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

1835

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

2919

1836

except KeyError:

2920

continue

2921

else:

2922

uid = 65534

2923

gid = 65534

1837

try:

1838

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

1839

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

1840

except KeyError:

1841

uid = 65534

1842

gid = 65534

2924

1843

try:

2925

1844

os.setgid(gid)

2926

1845

os.setuid(uid)

2927

1846

except OSError as error:

2928

if error.errno != errno.EPERM:

2929

raise

1847

if error[0] != errno.EPERM:

1848

raise error

2930

1849

1850

if not debug and not debuglevel:

1851

syslogger.setLevel(logging.WARNING)

1852

console.setLevel(logging.WARNING)

1853

if debuglevel:

1854

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

1855

syslogger.setLevel(level)

1856

console.setLevel(level)

1857

2931

1858

if debug:

2932

1859

# Enable all possible GnuTLS debugging

2933

1860

2934

1861

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

2935

1862

# - GnuTLS manual

2936

gnutls.global_set_log_level(11)

1863

gnutls.library.functions.gnutls_global_set_log_level(11)

2937

1864

2938

@gnutls.log_func

1865

@gnutls.library.types.gnutls_log_func

2939

1866

def debug_gnutls(level, string):

2940

1867

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

2941

1868

2942

gnutls.global_set_log_function(debug_gnutls)

1869

(gnutls.library.functions

1870

.gnutls_global_set_log_function(debug_gnutls))

2943

1871

2944

1872

# Redirect stdin so all checkers get /dev/null

2945

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

1873

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

2946

1874

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

2947

1875

if null > 2:

2948

1876

os.close(null)

1877

else:

1878

# No console logging

1879

logger.removeHandler(console)

2949

1880

2950

1881

# Need to fork before connecting to D-Bus

2951

if not foreground:

1882

if not debug:

2952

1883

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

2953

1884

daemon()

2954

1885

2955

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

2956

# need to inform gobject that threads will be used.

2957

gobject.threads_init()

2958

2959

1886

global main_loop

2960

1887

# From the Avahi example code

2961

DBusGMainLoop(set_as_default=True)

1888

DBusGMainLoop(set_as_default=True )

2962

1889

main_loop = gobject.MainLoop()

2963

1890

bus = dbus.SystemBus()

2964

1891

# End of Avahi example code

2965

1892

if use_dbus:

2966

1893

try:

2967

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

2968

bus,

2969

do_not_queue=True)

2970

old_bus_name = dbus.service.BusName(

2971

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

2972

do_not_queue=True)

2973

except dbus.exceptions.DBusException as e:

2974

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

1894

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

1895

bus, do_not_queue=True)

1896

except dbus.exceptions.NameExistsException as e:

1897

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

2975

1898

use_dbus = False

2976

1899

server_settings["use_dbus"] = False

2977

1900

tcp_server.use_dbus = False

2978

if zeroconf:

2979

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2980

service = AvahiServiceToSyslog(

2981

name = server_settings["servicename"],

2982

servicetype = "_mandos._tcp",

2983

protocol = protocol,

2984

bus = bus)

2985

if server_settings["interface"]:

2986

service.interface = if_nametoindex(

2987

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

1901

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1902

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

1903

servicetype = "_mandos._tcp",

1904

protocol = protocol, bus = bus)

1905

if server_settings["interface"]:

1906

service.interface = (if_nametoindex

1907

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

2988

1908

2989

1909

global multiprocessing_manager

2990

1910

multiprocessing_manager = multiprocessing.Manager()

2992

1912

client_class = Client

2993

1913

if use_dbus:

2994

1914

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

2995

2996

client_settings = Client.config_parser(client_config)

2997

old_client_settings = {}

2998

clients_data = {}

2999

3000

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

3001

global wnull

3002

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

3003

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

3004

# mode

3005

if debug or not foreground:

3006

wnull.close()

3007

3008

# Get client data and settings from last running state.

3009

if server_settings["restore"]:

3010

try:

3011

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

3012

clients_data, old_client_settings = pickle.load(

3013

stored_state)

3014

os.remove(stored_state_path)

3015

except IOError as e:

3016

if e.errno == errno.ENOENT:

3017

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

3018

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

3019

else:

3020

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

3021

exc_info=e)

3022

raise

3023

except EOFError as e:

3024

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

3025

"EOFError:",

3026

exc_info=e)

3027

3028

with PGPEngine() as pgp:

3029

for client_name, client in clients_data.items():

3030

# Skip removed clients

3031

if client_name not in client_settings:

3032

continue

3033

3034

# Decide which value to use after restoring saved state.

3035

# We have three different values: Old config file,

3036

# new config file, and saved state.

3037

# New config value takes precedence if it differs from old

3038

# config value, otherwise use saved state.

3039

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

3040

try:

3041

# For each value in new config, check if it

3042

# differs from the old config value (Except for

3043

# the "secret" attribute)

3044

if (name != "secret"

3045

and (value !=

3046

old_client_settings[client_name][name])):

3047

client[name] = value

3048

except KeyError:

3049

pass

3050

3051

# Clients who has passed its expire date can still be

3052

# enabled if its last checker was successful. A Client

3053

# whose checker succeeded before we stored its state is

3054

# assumed to have successfully run all checkers during

3055

# downtime.

3056

if client["enabled"]:

3057

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

3058

if not client["last_checked_ok"]:

3059

logger.warning(

3060

"disabling client {} - Client never "

3061

"performed a successful checker".format(

3062

client_name))

3063

client["enabled"] = False

3064

elif client["last_checker_status"] != 0:

3065

logger.warning(

3066

"disabling client {} - Client last"

3067

" checker failed with error code"

3068

" {}".format(

3069

client_name,

3070

client["last_checker_status"]))

3071

client["enabled"] = False

3072

else:

3073

client["expires"] = (

3074

datetime.datetime.utcnow()

3075

+ client["timeout"])

3076

logger.debug("Last checker succeeded,"

3077

" keeping {} enabled".format(

3078

client_name))

1915

def client_config_items(config, section):

1916

special_settings = {

1917

"approved_by_default":

1918

lambda: config.getboolean(section,

1919

"approved_by_default"),

1920

}

1921

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

3079

1922

try:

3080

client["secret"] = pgp.decrypt(

3081

client["encrypted_secret"],

3082

client_settings[client_name]["secret"])

3083

except PGPError:

3084

# If decryption fails, we use secret from new settings

3085

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

3086

client_name))

3087

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

3088

["secret"])

3089

3090

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

3091

for client_name in (set(old_client_settings)

3092

- set(client_settings)):

3093

del clients_data[client_name]

3094

for client_name in (set(client_settings)

3095

- set(old_client_settings)):

3096

clients_data[client_name] = client_settings[client_name]

3097

3098

# Create all client objects

3099

for client_name, client in clients_data.items():

3100

tcp_server.clients[client_name] = client_class(

3101

name = client_name,

3102

settings = client,

3103

server_settings = server_settings)

3104

1923

yield (name, special_settings[name]())

1924

except KeyError:

1925

yield (name, value)

1926

1927

tcp_server.clients.update(set(

1928

client_class(name = section,

1929

config= dict(client_config_items(

1930

client_config, section)))

1931

for section in client_config.sections()))

3105

1932

if not tcp_server.clients:

3106

1933

logger.warning("No clients defined")

3107

3108

if not foreground:

3109

if pidfile is not None:

3110

pid = os.getpid()

3111

try:

3112

with pidfile:

3113

print(pid, file=pidfile)

3114

except IOError:

3115

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

3116

pidfilename, pid)

3117

del pidfile

1934

1935

if not debug:

1936

try:

1937

with pidfile:

1938

pid = os.getpid()

1939

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

1940

del pidfile

1941

except IOError:

1942

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

1943

pidfilename, pid)

1944

except NameError:

1945

# "pidfile" was never created

1946

pass

3118

1947

del pidfilename

3119

1948

1949

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

1950

3120

1951

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

3121

1952

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

3122

1953

3123

1954

if use_dbus:

3124

3125

@alternate_dbus_interfaces(

3126

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

3127

class MandosDBusService(DBusObjectWithObjectManager):

1955

class MandosDBusService(dbus.service.Object):

3128

1956

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

3129

3130

1957

def __init__(self):

3131

1958

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

3132

3133

_interface = "se.recompile.Mandos"

1959

_interface = "se.bsnet.fukt.Mandos"

3134

1960

3135

1961

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

3136

1962

def ClientAdded(self, objpath):

3142

1968

"D-Bus signal"

3143

1969

pass

3144

1970

3145

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

3146

"true"})

3147

1971

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

3148

1972

def ClientRemoved(self, objpath, name):

3149

1973

"D-Bus signal"

3150

1974

pass

3151

1975

3152

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

3153

"true"})

3154

1976

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

3155

1977

def GetAllClients(self):

3156

1978

"D-Bus method"

3157

return dbus.Array(c.dbus_object_path for c in

3158

tcp_server.clients.itervalues())

1979

return dbus.Array(c.dbus_object_path

1980

for c in tcp_server.clients)

3159

1981

3160

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

3161

"true"})

3162

1982

@dbus.service.method(_interface,

3163

1983

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

3164

1984

def GetAllClientsWithProperties(self):

3165

1985

"D-Bus method"

3166

1986

return dbus.Dictionary(

3167

{ c.dbus_object_path: c.GetAll(

3168

"se.recompile.Mandos.Client")

3169

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

1987

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

1988

for c in tcp_server.clients),

3170

1989

signature="oa{sv}")

3171

1990

3172

1991

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

3173

1992

def RemoveClient(self, object_path):

3174

1993

"D-Bus method"

3175

for c in tcp_server.clients.itervalues():

1994

for c in tcp_server.clients:

3176

1995

if c.dbus_object_path == object_path:

3177

del tcp_server.clients[c.name]

1996

tcp_server.clients.remove(c)

3178

1997

c.remove_from_connection()

3179

# Don't signal the disabling

1998

# Don't signal anything except ClientRemoved

3180

1999

c.disable(quiet=True)

3181

# Emit D-Bus signal for removal

3182

self.client_removed_signal(c)

2000

# Emit D-Bus signal

2001

self.ClientRemoved(object_path, c.name)

3183

2002

return

3184

2003

raise KeyError(object_path)

3185

2004

3186

2005

del _interface

3187

3188

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3189

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

3190

def GetManagedObjects(self):

3191

"""D-Bus method"""

3192

return dbus.Dictionary(

3193

{ client.dbus_object_path:

3194

dbus.Dictionary(

3195

{ interface: client.GetAll(interface)

3196

for interface in

3197

client._get_all_interface_names()})

3198

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

3199

3200

def client_added_signal(self, client):

3201

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

3202

if use_dbus:

3203

# New standard signal

3204

self.InterfacesAdded(

3205

client.dbus_object_path,

3206

dbus.Dictionary(

3207

{ interface: client.GetAll(interface)

3208

for interface in

3209

client._get_all_interface_names()}))

3210

# Old signal

3211

self.ClientAdded(client.dbus_object_path)

3212

3213

def client_removed_signal(self, client):

3214

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

3215

if use_dbus:

3216

# New standard signal

3217

self.InterfacesRemoved(

3218

client.dbus_object_path,

3219

client._get_all_interface_names())

3220

# Old signal

3221

self.ClientRemoved(client.dbus_object_path,

3222

client.name)

3223

2006

3224

2007

mandos_dbus_service = MandosDBusService()

3225

2008

3226

2009

def cleanup():

3227

2010

"Cleanup function; run on exit"

3228

if zeroconf:

3229

service.cleanup()

3230

3231

multiprocessing.active_children()

3232

wnull.close()

3233

if not (tcp_server.clients or client_settings):

3234

return

3235

3236

# Store client before exiting. Secrets are encrypted with key

3237

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

3238

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

3239

clients = {}

3240

with PGPEngine() as pgp:

3241

for client in tcp_server.clients.itervalues():

3242

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

3243

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

3244

key)

3245

client_dict = {}

3246

3247

# A list of attributes that can not be pickled

3248

# + secret.

3249

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

3250

"checker", "server_settings" }

3251

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

3252

.Object):

3253

exclude.add(name)

3254

3255

client_dict["encrypted_secret"] = (client

3256

.encrypted_secret)

3257

for attr in client.client_structure:

3258

if attr not in exclude:

3259

client_dict[attr] = getattr(client, attr)

3260

3261

clients[client.name] = client_dict

3262

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

3263

3264

try:

3265

with tempfile.NamedTemporaryFile(

3266

mode='wb',

3267

suffix=".pickle",

3268

prefix='clients-',

3269

dir=os.path.dirname(stored_state_path),

3270

delete=False) as stored_state:

3271

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

3272

tempname = stored_state.name

3273

os.rename(tempname, stored_state_path)

3274

except (IOError, OSError) as e:

3275

if not debug:

3276

try:

3277

os.remove(tempname)

3278

except NameError:

3279

pass

3280

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

3281

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

3282

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

3283

else:

3284

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

3285

exc_info=e)

3286

raise

3287

3288

# Delete all clients, and settings from config

2011

service.cleanup()

2012

3289

2013

while tcp_server.clients:

3290

name, client = tcp_server.clients.popitem()

2014

client = tcp_server.clients.pop()

3291

2015

if use_dbus:

3292

2016

client.remove_from_connection()

3293

# Don't signal the disabling

2017

client.disable_hook = None

2018

# Don't signal anything except ClientRemoved

3294

2019

client.disable(quiet=True)

3295

# Emit D-Bus signal for removal

3296

2020

if use_dbus:

3297

mandos_dbus_service.client_removed_signal(client)

3298

client_settings.clear()

2021

# Emit D-Bus signal

2022

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2023

client.name)

3299

2024

3300

2025

atexit.register(cleanup)

3301

2026

3302

for client in tcp_server.clients.itervalues():

2027

for client in tcp_server.clients:

3303

2028

if use_dbus:

3304

# Emit D-Bus signal for adding

3305

mandos_dbus_service.client_added_signal(client)

3306

# Need to initiate checking of clients

3307

if client.enabled:

3308

client.init_checker()

2029

# Emit D-Bus signal

2030

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2031

client.enable()

3309

2032

3310

2033

tcp_server.enable()

3311

2034

tcp_server.server_activate()

3312

2035

3313

2036

# Find out what port we got

3314

if zeroconf:

3315

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

2037

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

3316

2038

if use_ipv6:

3317

2039

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

3318

" flowinfo %d, scope_id %d",

3319

*tcp_server.socket.getsockname())

2040

" flowinfo %d, scope_id %d"

2041

% tcp_server.socket.getsockname())

3320

2042

else: # IPv4

3321

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

3322

*tcp_server.socket.getsockname())

2043

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

2044

% tcp_server.socket.getsockname())

3323

2045

3324

2046

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

3325

2047

3326

2048

try:

3327

if zeroconf:

3328

# From the Avahi example code

3329

try:

3330

service.activate()

3331

except dbus.exceptions.DBusException as error:

3332

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

3333

cleanup()

3334

sys.exit(1)

3335

# End of Avahi example code

2049

# From the Avahi example code

2050

try:

2051

service.activate()

2052

except dbus.exceptions.DBusException as error:

2053

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

2054

cleanup()

2055

sys.exit(1)

2056

# End of Avahi example code

3336

2057

3337

2058

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

3338

2059

lambda *args, **kwargs:

3342

2063

logger.debug("Starting main loop")

3343

2064

main_loop.run()

3344

2065

except AvahiError as error:

3345

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

2066

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

3346

2067

cleanup()

3347

2068

sys.exit(1)

3348

2069

except KeyboardInterrupt:

3353

2074

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

3354

2075

cleanup()

3355

2076

3356

3357

2077

if __name__ == '__main__':

3358

2078

main()