/mandos/release : revision 237.16.24

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

37

import SocketServer as socketserver

43

38

import socket

44

39

import argparse

45

40

import datetime

46

41

import errno

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

51

49

import sys

52

50

import re

53

51

import os

62

60

import struct

63

61

import fcntl

64

62

import functools

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

63

import cPickle as pickle

69

64

import multiprocessing

70

65

import types

71

import binascii

72

import tempfile

73

import itertools

74

import collections

75

import codecs

76

66

77

67

import dbus

78

68

import dbus.service

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

69

import gobject

83

70

import avahi

84

71

from dbus.mainloop.glib import DBusGMainLoop

85

72

import ctypes

95

82

except ImportError:

96

83

SO_BINDTODEVICE = None

97

84

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.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

85

86

version = "1.4.1"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

90

syslogger = (logging.handlers.SysLogHandler

91

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

230

103

231

104

class AvahiError(Exception):

232

105

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

233

106

self.value = value

234

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

235

**kwargs)

236

107

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

108

def __unicode__(self):

109

return unicode(repr(self.value))

237

110

238

111

class AvahiServiceError(AvahiError):

239

112

pass

240

113

241

242

114

class AvahiGroupError(AvahiError):

243

115

pass

244

116

251

123

Used to optionally bind to the specified interface.

252

124

name: string; Example: 'Mandos'

253

125

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

254

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

126

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

255

127

port: integer; what port to announce

256

128

TXT: list of strings; TXT record for the service

257

129

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

263

135

server: D-Bus Server

264

136

bus: dbus.SystemBus()

265

137

"""

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

138

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

139

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

140

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

141

protocol = avahi.PROTO_UNSPEC, bus = None):

278

142

self.interface = interface

279

143

self.name = name

280

144

self.type = servicetype

289

153

self.server = None

290

154

self.bus = bus

291

155

self.entry_group_state_changed_match = None

292

293

def rename(self, remove=True):

156

def rename(self):

294

157

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

295

158

if self.rename_count >= self.max_renames:

296

159

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

297

160

" after %i retries, exiting.",

298

161

self.rename_count)

299

162

raise AvahiServiceError("Too many renames")

300

self.name = str(

301

self.server.GetAlternativeServiceName(self.name))

302

self.rename_count += 1

163

self.name = unicode(self.server

164

.GetAlternativeServiceName(self.name))

303

165

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

304

166

self.name)

305

if remove:

306

self.remove()

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

self.remove()

307

172

try:

308

173

self.add()

309

174

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

175

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

176

self.cleanup()

177

os._exit(1)

178

self.rename_count += 1

319

179

def remove(self):

320

180

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

321

181

if self.entry_group_state_changed_match is not None:

323

183

self.entry_group_state_changed_match = None

324

184

if self.group is not None:

325

185

self.group.Reset()

326

327

186

def add(self):

328

187

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

329

188

self.remove()

334

193

avahi.DBUS_INTERFACE_ENTRY_GROUP)

335

194

self.entry_group_state_changed_match = (

336

195

self.group.connect_to_signal(

337

'StateChanged', self.entry_group_state_changed))

196

'StateChanged', self .entry_group_state_changed))

338

197

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

339

198

self.name, self.type)

340

199

self.group.AddService(

346

205

dbus.UInt16(self.port),

347

206

avahi.string_array_to_txt_array(self.TXT))

348

207

self.group.Commit()

349

350

208

def entry_group_state_changed(self, state, error):

351

209

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

352

210

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

358

216

self.rename()

359

217

elif state == avahi.ENTRY_GROUP_FAILURE:

360

218

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

361

str(error))

362

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

363

219

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

364

222

def cleanup(self):

365

223

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

366

224

if self.group is not None:

367

225

try:

368

226

self.group.Free()

369

227

except (dbus.exceptions.UnknownMethodException,

370

dbus.exceptions.DBusException):

228

dbus.exceptions.DBusException) as e:

371

229

pass

372

230

self.group = None

373

231

self.remove()

374

375

232

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

376

233

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

377

234

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

}

235

bad_states = { avahi.SERVER_INVALID:

236

"Zeroconf server invalid",

237

avahi.SERVER_REGISTERING: None,

238

avahi.SERVER_COLLISION:

239

"Zeroconf server name collision",

240

avahi.SERVER_FAILURE:

241

"Zeroconf server failure" }

384

242

if state in bad_states:

385

243

if bad_states[state] is not None:

386

244

if error is None:

389

247

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

390

248

self.cleanup()

391

249

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)

250

self.add()

404

251

else:

405

252

if error is None:

406

253

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

407

254

else:

408

255

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

409

410

256

def activate(self):

411

257

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

412

258

if self.server is None:

416

262

follow_name_owner_changes=True),

417

263

avahi.DBUS_INTERFACE_SERVER)

418

264

self.server.connect_to_signal("StateChanged",

419

self.server_state_changed)

265

self.server_state_changed)

420

266

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

421

267

422

268

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

269

def _timedelta_to_milliseconds(td):

270

"Convert a datetime.timedelta() to milliseconds"

271

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

272

+ (td.seconds * 1000)

273

+ (td.microseconds // 1000))

274

697

275

class Client(object):

698

276

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

699

277

700

278

Attributes:

701

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

279

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

702

280

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

703

281

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

704

282

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

711

289

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

712

290

checker_initiator_tag: a gobject event source tag, or None

713

291

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

292

current_checker_command: string; current running checker_command

293

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

717

294

disable_initiator_tag: a gobject event source tag, or None

718

295

enabled: bool()

719

296

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

722

299

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

723

300

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

724

301

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

302

last_enabled: datetime.datetime(); (UTC)

731

303

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

732

304

D-Bus identifiers

733

305

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

734

306

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

735

307

until this client is disabled

736

extended_timeout: extra long timeout when secret has been sent

308

extended_timeout: extra long timeout when password has been sent

737

309

runtime_expansions: Allowed attributes for runtime expansion.

738

310

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

739

311

disabled, or None

740

server_settings: The server_settings dict from main()

741

312

"""

742

313

743

314

runtime_expansions = ("approval_delay", "approval_duration",

744

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

745

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

746

"last_approval_request", "last_checked_ok",

315

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

316

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

747

317

"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

760

@staticmethod

761

def config_parser(config):

762

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

763

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

764

with exceptions for any special settings as defined above.

765

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

766

value given the same arguments.

767

"""

768

settings = {}

769

for client_name in config.sections():

770

section = dict(config.items(client_name))

771

client = settings[client_name] = {}

772

773

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

774

# Reformat values from string types to Python types

775

client["approved_by_default"] = config.getboolean(

776

client_name, "approved_by_default")

777

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

778

"enabled")

779

780

# Uppercase and remove spaces from fingerprint for later

781

# comparison purposes with return value from the

782

# fingerprint() function

783

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

784

.replace(" ", ""))

785

if "secret" in section:

786

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

787

elif "secfile" in section:

788

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

789

(section["secfile"])),

790

"rb") as secfile:

791

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

792

else:

793

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

794

.format(section))

795

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

796

client["extended_timeout"] = string_to_delta(

797

section["extended_timeout"])

798

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

799

client["approval_delay"] = string_to_delta(

800

section["approval_delay"])

801

client["approval_duration"] = string_to_delta(

802

section["approval_duration"])

803

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

804

client["last_approval_request"] = None

805

client["last_checked_ok"] = None

806

client["last_checker_status"] = -2

807

808

return settings

809

810

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

318

319

def timeout_milliseconds(self):

320

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

322

323

def extended_timeout_milliseconds(self):

324

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

326

327

def interval_milliseconds(self):

328

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

330

331

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

811

338

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

339

if config is None:

340

config = {}

829

341

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

342

# Uppercase and remove spaces from fingerprint for later

343

# comparison purposes with return value from the fingerprint()

344

# function

345

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

346

.replace(" ", ""))

830

347

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

831

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

832

datetime.datetime.utcnow())

833

834

# attributes specific for this server instance

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

835

369

self.checker = None

836

370

self.checker_initiator_tag = None

837

371

self.disable_initiator_tag = None

372

self.expires = None

838

373

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

839

375

self.current_checker_command = None

840

self.approved = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

841

380

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)

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

self.changedstate = (multiprocessing_manager

386

.Condition(multiprocessing_manager

387

.Lock()))

853

388

854

# Send notice to process children that client state has changed

855

389

def send_changedstate(self):

856

with self.changedstate:

857

self.changedstate.notify_all()

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

858

393

859

394

def enable(self):

860

395

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

861

396

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

862

397

# Already enabled

863

398

return

399

self.send_changedstate()

400

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

401

# and every interval from then on.

402

self.checker_initiator_tag = (gobject.timeout_add

403

(self.interval_milliseconds(),

404

self.start_checker))

405

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

864

406

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

865

410

self.enabled = True

866

411

self.last_enabled = datetime.datetime.utcnow()

867

self.init_checker()

868

self.send_changedstate()

412

# Also start a new checker *right now*.

413

self.start_checker()

869

414

870

415

def disable(self, quiet=True):

871

416

"""Disable this client."""

872

417

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

873

418

return False

874

419

if not quiet:

420

self.send_changedstate()

421

if not quiet:

875

422

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

876

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

423

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

877

424

gobject.source_remove(self.disable_initiator_tag)

878

425

self.disable_initiator_tag = None

879

426

self.expires = None

880

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

427

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

881

428

gobject.source_remove(self.checker_initiator_tag)

882

429

self.checker_initiator_tag = None

883

430

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

884

433

self.enabled = False

885

if not quiet:

886

self.send_changedstate()

887

434

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

888

435

return False

889

436

890

437

def __del__(self):

438

self.disable_hook = None

891

439

self.disable()

892

440

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

441

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

911

442

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

912

443

self.checker_callback_tag = None

913

444

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:

445

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

922

448

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

923

449

vars(self))

924

450

self.checked_ok()

925

451

else:

926

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

452

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

453

vars(self))

927

454

else:

928

self.last_checker_status = -1

929

self.last_checker_signal = -returncode

930

455

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

931

456

vars(self))

932

return False

933

934

def checked_ok(self):

935

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

936

self.last_checked_ok = datetime.datetime.utcnow()

937

self.last_checker_status = 0

938

self.last_checker_signal = None

939

self.bump_timeout()

940

941

def bump_timeout(self, timeout=None):

942

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

457

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

943

464

if timeout is None:

944

465

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

945

467

if self.disable_initiator_tag is not None:

946

468

gobject.source_remove(self.disable_initiator_tag)

947

self.disable_initiator_tag = None

948

469

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

949

self.disable_initiator_tag = gobject.timeout_add(

950

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

470

self.disable_initiator_tag = (gobject.timeout_add

471

(_timedelta_to_milliseconds

472

(timeout), self.disable))

951

473

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

952

474

953

475

def need_approval(self):

959

481

If a checker already exists, leave it running and do

960

482

nothing."""

961

483

# 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

484

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

485

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

486

# client would inevitably timeout, since no checker would get

487

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

966

488

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

967

489

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

968

490

# should be.

969

491

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

492

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

493

try:

494

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

495

except (AttributeError, OSError) as error:

496

if (isinstance(error, OSError)

497

and error.errno != errno.ECHILD):

498

raise error

499

else:

500

if pid:

501

logger.warning("Checker was a zombie")

502

gobject.source_remove(self.checker_callback_tag)

503

self.checker_callback(pid, status,

504

self.current_checker_command)

974

505

# Start a new checker if needed

975

506

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

507

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

508

# In case checker_command has exactly one % operator

509

command = self.checker_command % self.host

510

except TypeError:

511

# Escape attributes for the shell

512

escaped_attrs = dict(

513

(attr,

514

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

515

errors=

516

'replace')))

517

for attr in

518

self.runtime_expansions)

519

520

try:

521

command = self.checker_command % escaped_attrs

522

except TypeError as error:

523

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

524

' %s', self.checker_command, error)

525

return True # Try again later

987

526

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)

527

try:

528

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

529

command, self.name)

530

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

531

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

532

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

533

# always replaced by /dev/null.)

534

self.checker = subprocess.Popen(command,

535

close_fds=True,

536

shell=True, cwd="/")

537

self.checker_callback_tag = (gobject.child_watch_add

538

(self.checker.pid,

539

self.checker_callback,

540

data=command))

541

# The checker may have completed before the gobject

542

# watch was added. Check for this.

543

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

544

if pid:

545

gobject.source_remove(self.checker_callback_tag)

546

self.checker_callback(pid, status, command)

547

except OSError as error:

548

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

549

error)

1013

550

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

1014

551

return True

1015

552

1021

558

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

1022

559

return

1023

560

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

1024

self.checker.terminate()

561

try:

562

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

563

#time.sleep(0.5)

564

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

565

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

566

except OSError as error:

567

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

568

raise

1025

569

self.checker = None

1026

570

1027

571

1028

def dbus_service_property(dbus_interface,

1029

signature="v",

1030

access="readwrite",

1031

byte_arrays=False):

572

def dbus_service_property(dbus_interface, signature="v",

573

access="readwrite", byte_arrays=False):

1032

574

"""Decorators for marking methods of a DBusObjectWithProperties to

1033

575

become properties on the D-Bus.

1034

576

1043

585

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

1044

586

if byte_arrays and signature != "ay":

1045

587

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

1046

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

1047

588

" signature %r" % signature)

1048

589

def decorator(func):

1049

590

func._dbus_is_property = True

1050

591

func._dbus_interface = dbus_interface

1055

596

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

1056

597

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1057

598

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

599

return decorator

1103

600

1104

601

1105

602

class DBusPropertyException(dbus.exceptions.DBusException):

1106

603

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

1107

604

"""

1108

pass

605

def __unicode__(self):

606

return unicode(str(self))

1109

607

1110

608

1111

609

class DBusPropertyAccessException(DBusPropertyException):

1120

618

pass

1121

619

1122

620

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

621

class DBusObjectWithProperties(dbus.service.Object):

1213

622

"""A D-Bus object with properties.

1214

623

1215

624

Classes inheriting from this can use the dbus_service_property

1217

626

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

1218

627

"""

1219

628

629

@staticmethod

630

def _is_dbus_property(obj):

631

return getattr(obj, "_dbus_is_property", False)

632

633

def _get_all_dbus_properties(self):

634

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

635

"""

636

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

637

for cls in self.__class__.__mro__

638

for name, prop in

639

inspect.getmembers(cls, self._is_dbus_property))

640

1220

641

def _get_dbus_property(self, interface_name, property_name):

1221

642

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

1222

643

property with the specified name and interface.

1223

644

"""

1224

for cls in self.__class__.__mro__:

1225

for name, value in inspect.getmembers(

1226

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

645

for cls in self.__class__.__mro__:

646

for name, value in (inspect.getmembers

647

(cls, self._is_dbus_property)):

1227

648

if (value._dbus_name == property_name

1228

649

and value._dbus_interface == interface_name):

1229

650

return value.__get__(self)

1230

651

1231

652

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

653

raise DBusPropertyNotFound(self.dbus_object_path + ":"

654

+ interface_name + "."

655

+ property_name)

656

657

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

1246

658

out_signature="v")

1247

659

def Get(self, interface_name, property_name):

1248

660

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

1266

678

# The byte_arrays option is not supported yet on

1267

679

# signatures other than "ay".

1268

680

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

681

raise ValueError

682

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

683

for byte in value))

1274

684

prop(value)

1275

685

1276

@dbus.service.method(dbus.PROPERTIES_IFACE,

1277

in_signature="s",

686

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

1278

687

out_signature="a{sv}")

1279

688

def GetAll(self, interface_name):

1280

689

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

1282

691

1283

692

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

1284

693

"""

1285

properties = {}

1286

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

694

all = {}

695

for name, prop in self._get_all_dbus_properties():

1287

696

if (interface_name

1288

697

and interface_name != prop._dbus_interface):

1289

698

# Interface non-empty but did not match

1293

702

continue

1294

703

value = prop()

1295

704

if not hasattr(value, "variant_level"):

1296

properties[name] = value

705

all[name] = value

1297

706

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

707

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

708

value.variant_level+1)

709

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

1309

710

1310

711

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1311

712

out_signature="s",

1312

713

path_keyword='object_path',

1313

714

connection_keyword='connection')

1314

715

def Introspect(self, object_path, connection):

1315

"""Overloading of standard D-Bus method.

1316

1317

Inserts property tags and interface annotation tags.

716

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

1318

717

"""

1319

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1320

object_path,

1321

connection)

718

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

719

connection)

1322

720

try:

1323

721

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

1324

1325

722

def make_tag(document, name, prop):

1326

723

e = document.createElement("property")

1327

724

e.setAttribute("name", name)

1328

725

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

1329

726

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

1330

727

return e

1331

1332

728

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

1333

# Add property tags

1334

729

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

1335

730

for name, prop

1336

in self._get_all_dbus_things("property")

731

in self._get_all_dbus_properties()

1337

732

if prop._dbus_interface

1338

733

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

1339

734

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

735

# Add the names to the return values for the

1357

736

# "org.freedesktop.DBus.Properties" methods

1358

737

if (if_tag.getAttribute("name")

1373

752

except (AttributeError, xml.dom.DOMException,

1374

753

xml.parsers.expat.ExpatError) as error:

1375

754

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

755

error)

756

return xmlstring

757

758

759

def datetime_to_dbus (dt, variant_level=0):

1449

760

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

1450

761

if dt is None:

1451

762

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

763

return dbus.String(dt.isoformat(),

764

variant_level=variant_level)

765

766

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

767

.__metaclass__):

768

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

769

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

1477

770

"""

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

771

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

772

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

773

# methods, signals, or properties in them

774

for base in (b for b in bases

775

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

776

# Go though all attributes of the base class

777

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

1486

778

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

1487

779

# with the wrong interface name

1488

780

if (not hasattr(attribute, "_dbus_interface")

1489

or not attribute._dbus_interface.startswith(

1490

orig_interface_name)):

781

or not attribute._dbus_interface

782

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

1491

783

continue

1492

784

# Create an alternate D-Bus interface name based on

1493

785

# the current name

1494

alt_interface = attribute._dbus_interface.replace(

1495

orig_interface_name, alt_interface_name)

1496

interface_names.add(alt_interface)

786

alt_interface = (attribute._dbus_interface

787

.replace("se.recompile.Mandos",

788

"se.bsnet.fukt.Mandos"))

1497

789

# Is this a D-Bus signal?

1498

790

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(

791

# Extract the original non-method function by

792

# black magic

793

nonmethod_func = (dict(

1503

794

zip(attribute.func_code.co_freevars,

1504

attribute.__closure__))

1505

["func"].cell_contents)

1506

else:

1507

nonmethod_func = attribute

795

attribute.__closure__))["func"]

796

.cell_contents)

1508

797

# Create a new, but exactly alike, function

1509

798

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

1510

799

# 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

800

new_function = (dbus.service.signal

801

(alt_interface,

802

attribute._dbus_signature)

803

(types.FunctionType(

804

nonmethod_func.func_code,

805

nonmethod_func.func_globals,

806

nonmethod_func.func_name,

807

nonmethod_func.func_defaults,

808

nonmethod_func.func_closure)))

1534

809

# 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

810

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

811

# signals gets sent when the function is called

1538

812

def fixscope(func1, func2):

1539

813

"""This function is a scope container to pass

1540

814

func1 and func2 to the "call_both" function

1541

815

outside of its arguments"""

1542

1543

@functools.wraps(func2)

1544

816

def call_both(*args, **kwargs):

1545

817

"""This function will emit two D-Bus

1546

818

signals by calling func1 and func2"""

1547

819

func1(*args, **kwargs)

1548

820

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

821

return call_both

1555

822

# Create the "call_both" function and add it to

1556

823

# the class

1557

attr[attrname] = fixscope(attribute, new_function)

824

attr[attrname] = fixscope(attribute,

825

new_function)

1558

826

# Is this a D-Bus method?

1559

827

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

1560

828

# Create a new, but exactly alike, function

1561

829

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

1562

830

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

1563

831

# 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

832

attr[attrname] = (dbus.service.method

833

(alt_interface,

834

attribute._dbus_in_signature,

835

attribute._dbus_out_signature)

836

(types.FunctionType

837

(attribute.func_code,

838

attribute.func_globals,

839

attribute.func_name,

840

attribute.func_defaults,

841

attribute.func_closure)))

1580

842

# Is this a D-Bus property?

1581

843

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

1582

844

# Create a new, but exactly alike, function

1583

845

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

1584

846

# property with the alternate D-Bus interface

1585

847

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

848

attr[attrname] = (dbus_service_property

849

(alt_interface,

850

attribute._dbus_signature,

851

attribute._dbus_access,

852

attribute

853

._dbus_get_args_options

854

["byte_arrays"])

855

(types.FunctionType

856

(attribute.func_code,

857

attribute.func_globals,

858

attribute.func_name,

859

attribute.func_defaults,

860

attribute.func_closure)))

861

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

862

1643

863

class ClientDBus(Client, DBusObjectWithProperties):

1644

864

"""A Client class using D-Bus

1645

865

1649

869

"""

1650

870

1651

871

runtime_expansions = (Client.runtime_expansions

1652

+ ("dbus_object_path", ))

1653

1654

_interface = "se.recompile.Mandos.Client"

872

+ ("dbus_object_path",))

1655

873

1656

874

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

1657

875

1658

876

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

877

self._approvals_pending = 0

1659

878

self.bus = bus

1660

879

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

1661

880

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

1662

881

# the D-Bus

1663

client_object_name = str(self.name).translate(

882

client_object_name = unicode(self.name).translate(

1664

883

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

1665

884

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

1666

self.dbus_object_path = dbus.ObjectPath(

1667

"/clients/" + client_object_name)

885

self.dbus_object_path = (dbus.ObjectPath

886

("/clients/" + client_object_name))

1668

887

DBusObjectWithProperties.__init__(self, self.bus,

1669

888

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

889

890

def notifychangeproperty(transform_func,

891

dbus_name, type_func=lambda x: x,

892

variant_level=1):

1676

893

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

1677

894

its changes to DBus.

1678

895

1679

896

transform_fun: Function that takes a value and a variant_level

1680

897

and transforms it to a D-Bus type.

1681

898

dbus_name: D-Bus name of the variable

1683

900

to the D-Bus. Default: no transform

1684

901

variant_level: D-Bus variant level. Default: 1

1685

902

"""

1686

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

1687

903

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

1688

904

def setter(self, value):

1689

905

if hasattr(self, "dbus_object_path"):

1690

906

if (not hasattr(self, attrname) or

1691

907

type_func(getattr(self, attrname, None))

1692

908

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

909

dbus_value = transform_func(type_func(value),

910

variant_level

911

=variant_level)

912

self.PropertyChanged(dbus.String(dbus_name),

913

dbus_value)

1708

914

setattr(self, attrname, value)

1709

915

1710

916

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

1711

917

918

1712

919

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1713

920

approvals_pending = notifychangeproperty(dbus.Boolean,

1714

921

"ApprovalPending",

1716

923

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

1717

924

last_enabled = notifychangeproperty(datetime_to_dbus,

1718

925

"LastEnabled")

1719

checker = notifychangeproperty(

1720

dbus.Boolean, "CheckerRunning",

1721

type_func = lambda checker: checker is not None)

926

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

927

type_func = lambda checker:

928

checker is not None)

1722

929

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1723

930

"LastCheckedOK")

1724

last_checker_status = notifychangeproperty(dbus.Int16,

1725

"LastCheckerStatus")

1726

931

last_approval_request = notifychangeproperty(

1727

932

datetime_to_dbus, "LastApprovalRequest")

1728

933

approved_by_default = notifychangeproperty(dbus.Boolean,

1729

934

"ApprovedByDefault")

1730

approval_delay = notifychangeproperty(

1731

dbus.UInt64, "ApprovalDelay",

1732

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

935

approval_delay = notifychangeproperty(dbus.UInt16,

936

"ApprovalDelay",

937

type_func =

938

_timedelta_to_milliseconds)

1733

939

approval_duration = notifychangeproperty(

1734

dbus.UInt64, "ApprovalDuration",

1735

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

940

dbus.UInt16, "ApprovalDuration",

941

type_func = _timedelta_to_milliseconds)

1736

942

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

1737

timeout = notifychangeproperty(

1738

dbus.UInt64, "Timeout",

1739

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

943

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

944

type_func =

945

_timedelta_to_milliseconds)

1740

946

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)

947

dbus.UInt16, "ExtendedTimeout",

948

type_func = _timedelta_to_milliseconds)

949

interval = notifychangeproperty(dbus.UInt16,

950

"Interval",

951

type_func =

952

_timedelta_to_milliseconds)

1746

953

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

1747

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

1748

invalidate_only=True)

1749

954

1750

955

del notifychangeproperty

1751

956

1758

963

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

1759

964

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

1760

965

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:

966

def checker_callback(self, pid, condition, command,

967

*args, **kwargs):

968

self.checker_callback_tag = None

969

self.checker = None

970

if os.WIFEXITED(condition):

971

exitstatus = os.WEXITSTATUS(condition)

1768

972

# Emit D-Bus signal

1769

973

self.CheckerCompleted(dbus.Int16(exitstatus),

1770

# This is specific to GNU libC

1771

dbus.Int64(exitstatus << 8),

974

dbus.Int64(condition),

1772

975

dbus.String(command))

1773

976

else:

1774

977

# Emit D-Bus signal

1775

978

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

1776

dbus.Int64(

1777

# This is specific to GNU libC

1778

(exitstatus << 8)

1779

| self.last_checker_signal),

979

dbus.Int64(condition),

1780

980

dbus.String(command))

1781

return ret

981

982

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

983

*args, **kwargs)

1782

984

1783

985

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

1784

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

986

old_checker = self.checker

987

if self.checker is not None:

988

old_checker_pid = self.checker.pid

989

else:

990

old_checker_pid = None

1785

991

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

1786

992

# Only if new checker process was started

1787

993

if (self.checker is not None

1791

997

return r

1792

998

1793

999

def _reset_approved(self):

1794

self.approved = None

1000

self._approved = None

1795

1001

return False

1796

1002

1797

1003

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

1004

self.send_changedstate()

1005

self._approved = value

1006

gobject.timeout_add(_timedelta_to_milliseconds

1007

(self.approval_duration),

1008

self._reset_approved)

1009

1802

1010

1803

1011

## D-Bus methods, signals & properties

1804

1805

## Interfaces

1012

_interface = "se.recompile.Mandos.Client"

1806

1013

1807

1014

## Signals

1808

1015

1819

1026

pass

1820

1027

1821

1028

# PropertyChanged - signal

1822

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

1823

1029

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

1824

1030

def PropertyChanged(self, property, value):

1825

1031

"D-Bus signal"

1859

1065

self.checked_ok()

1860

1066

1861

1067

# Enable - method

1862

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

1863

1068

@dbus.service.method(_interface)

1864

1069

def Enable(self):

1865

1070

"D-Bus method"

1866

1071

self.enable()

1867

1072

1868

1073

# StartChecker - method

1869

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

1870

1074

@dbus.service.method(_interface)

1871

1075

def StartChecker(self):

1872

1076

"D-Bus method"

1873

1077

self.start_checker()

1874

1078

1875

1079

# Disable - method

1876

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

1877

1080

@dbus.service.method(_interface)

1878

1081

def Disable(self):

1879

1082

"D-Bus method"

1880

1083

self.disable()

1881

1084

1882

1085

# StopChecker - method

1883

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

1884

1086

@dbus.service.method(_interface)

1885

1087

def StopChecker(self):

1886

1088

self.stop_checker()

1893

1095

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

1894

1096

1895

1097

# ApprovedByDefault - property

1896

@dbus_service_property(_interface,

1897

signature="b",

1098

@dbus_service_property(_interface, signature="b",

1898

1099

access="readwrite")

1899

1100

def ApprovedByDefault_dbus_property(self, value=None):

1900

1101

if value is None: # get

1902

1103

self.approved_by_default = bool(value)

1903

1104

1904

1105

# ApprovalDelay - property

1905

@dbus_service_property(_interface,

1906

signature="t",

1106

@dbus_service_property(_interface, signature="t",

1907

1107

access="readwrite")

1908

1108

def ApprovalDelay_dbus_property(self, value=None):

1909

1109

if value is None: # get

1910

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

1911

* 1000)

1110

return dbus.UInt64(self.approval_delay_milliseconds())

1912

1111

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

1913

1112

1914

1113

# ApprovalDuration - property

1915

@dbus_service_property(_interface,

1916

signature="t",

1114

@dbus_service_property(_interface, signature="t",

1917

1115

access="readwrite")

1918

1116

def ApprovalDuration_dbus_property(self, value=None):

1919

1117

if value is None: # get

1920

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

1921

* 1000)

1118

return dbus.UInt64(_timedelta_to_milliseconds(

1119

self.approval_duration))

1922

1120

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

1923

1121

1924

1122

# Name - property

1925

@dbus_annotations(

1926

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

1927

1123

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

1928

1124

def Name_dbus_property(self):

1929

1125

return dbus.String(self.name)

1930

1126

1931

1127

# Fingerprint - property

1932

@dbus_annotations(

1933

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

1934

1128

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

1935

1129

def Fingerprint_dbus_property(self):

1936

1130

return dbus.String(self.fingerprint)

1937

1131

1938

1132

# Host - property

1939

@dbus_service_property(_interface,

1940

signature="s",

1133

@dbus_service_property(_interface, signature="s",

1941

1134

access="readwrite")

1942

1135

def Host_dbus_property(self, value=None):

1943

1136

if value is None: # get

1944

1137

return dbus.String(self.host)

1945

self.host = str(value)

1138

self.host = value

1946

1139

1947

1140

# Created - property

1948

@dbus_annotations(

1949

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

1950

1141

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

1951

1142

def Created_dbus_property(self):

1952

return datetime_to_dbus(self.created)

1143

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

1953

1144

1954

1145

# LastEnabled - property

1955

1146

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

1957

1148

return datetime_to_dbus(self.last_enabled)

1958

1149

1959

1150

# Enabled - property

1960

@dbus_service_property(_interface,

1961

signature="b",

1151

@dbus_service_property(_interface, signature="b",

1962

1152

access="readwrite")

1963

1153

def Enabled_dbus_property(self, value=None):

1964

1154

if value is None: # get

1969

1159

self.disable()

1970

1160

1971

1161

# LastCheckedOK - property

1972

@dbus_service_property(_interface,

1973

signature="s",

1162

@dbus_service_property(_interface, signature="s",

1974

1163

access="readwrite")

1975

1164

def LastCheckedOK_dbus_property(self, value=None):

1976

1165

if value is not None:

1978

1167

return

1979

1168

return datetime_to_dbus(self.last_checked_ok)

1980

1169

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

1170

# Expires - property

1987

1171

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

1988

1172

def Expires_dbus_property(self):

1994

1178

return datetime_to_dbus(self.last_approval_request)

1995

1179

1996

1180

# Timeout - property

1997

@dbus_service_property(_interface,

1998

signature="t",

1181

@dbus_service_property(_interface, signature="t",

1999

1182

access="readwrite")

2000

1183

def Timeout_dbus_property(self, value=None):

2001

1184

if value is None: # get

2002

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

2003

old_timeout = self.timeout

1185

return dbus.UInt64(self.timeout_milliseconds())

2004

1186

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)

1187

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

1188

return

1189

# Reschedule timeout

1190

gobject.source_remove(self.disable_initiator_tag)

1191

self.disable_initiator_tag = None

1192

self.expires = None

1193

time_to_die = _timedelta_to_milliseconds((self

1194

.last_checked_ok

1195

+ self.timeout)

1196

- datetime.datetime

1197

.utcnow())

1198

if time_to_die <= 0:

1199

# The timeout has passed

1200

self.disable()

1201

else:

1202

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

1203

+ datetime.timedelta(milliseconds =

1204

time_to_die))

1205

self.disable_initiator_tag = (gobject.timeout_add

1206

(time_to_die, self.disable))

2020

1207

2021

1208

# ExtendedTimeout - property

2022

@dbus_service_property(_interface,

2023

signature="t",

1209

@dbus_service_property(_interface, signature="t",

2024

1210

access="readwrite")

2025

1211

def ExtendedTimeout_dbus_property(self, value=None):

2026

1212

if value is None: # get

2027

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

2028

* 1000)

1213

return dbus.UInt64(self.extended_timeout_milliseconds())

2029

1214

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

2030

1215

2031

1216

# Interval - property

2032

@dbus_service_property(_interface,

2033

signature="t",

1217

@dbus_service_property(_interface, signature="t",

2034

1218

access="readwrite")

2035

1219

def Interval_dbus_property(self, value=None):

2036

1220

if value is None: # get

2037

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

1221

return dbus.UInt64(self.interval_milliseconds())

2038

1222

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

2039

1223

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

2040

1224

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

1225

# Reschedule checker run

1226

gobject.source_remove(self.checker_initiator_tag)

1227

self.checker_initiator_tag = (gobject.timeout_add

1228

(value, self.start_checker))

1229

self.start_checker() # Start one now, too

2047

1230

2048

1231

# Checker - property

2049

@dbus_service_property(_interface,

2050

signature="s",

1232

@dbus_service_property(_interface, signature="s",

2051

1233

access="readwrite")

2052

1234

def Checker_dbus_property(self, value=None):

2053

1235

if value is None: # get

2054

1236

return dbus.String(self.checker_command)

2055

self.checker_command = str(value)

1237

self.checker_command = value

2056

1238

2057

1239

# CheckerRunning - property

2058

@dbus_service_property(_interface,

2059

signature="b",

1240

@dbus_service_property(_interface, signature="b",

2060

1241

access="readwrite")

2061

1242

def CheckerRunning_dbus_property(self, value=None):

2062

1243

if value is None: # get

2067

1248

self.stop_checker()

2068

1249

2069

1250

# ObjectPath - property

2070

@dbus_annotations(

2071

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

2072

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

2073

1251

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

2074

1252

def ObjectPath_dbus_property(self):

2075

1253

return self.dbus_object_path # is already a dbus.ObjectPath

2076

1254

2077

1255

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

1256

@dbus_service_property(_interface, signature="ay",

1257

access="write", byte_arrays=True)

2085

1258

def Secret_dbus_property(self, value):

2086

self.secret = bytes(value)

1259

self.secret = str(value)

2087

1260

2088

1261

del _interface

2089

1262

2093

1266

self._pipe = child_pipe

2094

1267

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

2095

1268

if not self._pipe.recv():

2096

raise KeyError(fpr)

1269

raise KeyError()

2097

1270

2098

1271

def __getattribute__(self, name):

2099

if name == '_pipe':

1272

if(name == '_pipe'):

2100

1273

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

2101

1274

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

2102

1275

data = self._pipe.recv()

2103

1276

if data[0] == 'data':

2104

1277

return data[1]

2105

1278

if data[0] == 'function':

2106

2107

1279

def func(*args, **kwargs):

2108

1280

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

2109

1281

return self._pipe.recv()[1]

2110

2111

1282

return func

2112

1283

2113

1284

def __setattr__(self, name, value):

2114

if name == '_pipe':

1285

if(name == '_pipe'):

2115

1286

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

2116

1287

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

2117

1288

1289

class ClientDBusTransitional(ClientDBus):

1290

__metaclass__ = AlternateDBusNamesMetaclass

2118

1291

2119

1292

class ClientHandler(socketserver.BaseRequestHandler, object):

2120

1293

"""A class to handle client connections.

2125

1298

def handle(self):

2126

1299

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

2127

1300

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

2128

str(self.client_address))

1301

unicode(self.client_address))

2129

1302

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

2130

1303

self.server.child_pipe.fileno())

2131

1304

2132

session = gnutls.ClientSession(self.request)

1305

session = (gnutls.connection

1306

.ClientSession(self.request,

1307

gnutls.connection

1308

.X509Credentials()))

1309

1310

# Note: gnutls.connection.X509Credentials is really a

1311

# generic GnuTLS certificate credentials object so long as

1312

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

1313

# here despite using OpenPGP certificates.

2133

1314

2134

1315

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

2135

1316

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

2139

1320

priority = self.server.gnutls_priority

2140

1321

if priority is None:

2141

1322

priority = "NORMAL"

2142

gnutls.priority_set_direct(session._c_object, priority,

2143

None)

1323

(gnutls.library.functions

1324

.gnutls_priority_set_direct(session._c_object,

1325

priority, None))

2144

1326

2145

1327

# Start communication using the Mandos protocol

2146

1328

# Get protocol number

2148

1330

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

2149

1331

try:

2150

1332

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

2151

raise RuntimeError(line)

1333

raise RuntimeError

2152

1334

except (ValueError, IndexError, RuntimeError) as error:

2153

1335

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

2154

1336

return

2156

1338

# Start GnuTLS connection

2157

1339

try:

2158

1340

session.handshake()

2159

except gnutls.Error as error:

1341

except gnutls.errors.GNUTLSError as error:

2160

1342

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

2161

1343

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

2162

1344

# established. Just abandon the request.

2166

1348

approval_required = False

2167

1349

try:

2168

1350

try:

2169

fpr = self.fingerprint(

2170

self.peer_certificate(session))

2171

except (TypeError, gnutls.Error) as error:

1351

fpr = self.fingerprint(self.peer_certificate

1352

(session))

1353

except (TypeError,

1354

gnutls.errors.GNUTLSError) as error:

2172

1355

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

2173

1356

return

2174

1357

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

2187

1370

while True:

2188

1371

if not client.enabled:

2189

1372

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

2190

client.name)

1373

client.name)

2191

1374

if self.server.use_dbus:

2192

1375

# Emit D-Bus signal

2193

1376

client.Rejected("Disabled")

2194

1377

return

2195

1378

2196

if client.approved or not client.approval_delay:

1379

if client._approved or not client.approval_delay:

2197

1380

#We are approved or approval is disabled

2198

1381

break

2199

elif client.approved is None:

1382

elif client._approved is None:

2200

1383

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

2201

1384

client.name)

2202

1385

if self.server.use_dbus:

2203

1386

# Emit D-Bus signal

2204

1387

client.NeedApproval(

2205

client.approval_delay.total_seconds()

2206

* 1000, client.approved_by_default)

1388

client.approval_delay_milliseconds(),

1389

client.approved_by_default)

2207

1390

else:

2208

1391

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

2209

1392

client.name)

2215

1398

#wait until timeout or approved

2216

1399

time = datetime.datetime.now()

2217

1400

client.changedstate.acquire()

2218

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

1401

(client.changedstate.wait

1402

(float(client._timedelta_to_milliseconds(delay)

1403

/ 1000)))

2219

1404

client.changedstate.release()

2220

1405

time2 = datetime.datetime.now()

2221

1406

if (time2 - time) >= delay:

2232

1417

else:

2233

1418

delay -= time2 - time

2234

1419

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

1420

sent_size = 0

1421

while sent_size < len(client.secret):

1422

try:

1423

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

1424

except gnutls.errors.GNUTLSError as error:

1425

logger.warning("gnutls send failed")

1426

return

1427

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

1428

sent, len(client.secret)

1429

- (sent_size + sent))

1430

sent_size += sent

2241

1431

2242

1432

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

2243

1433

# bump the timeout using extended_timeout

2244

client.bump_timeout(client.extended_timeout)

1434

client.checked_ok(client.extended_timeout)

2245

1435

if self.server.use_dbus:

2246

1436

# Emit D-Bus signal

2247

1437

client.GotSecret()

2251

1441

client.approvals_pending -= 1

2252

1442

try:

2253

1443

session.bye()

2254

except gnutls.Error as error:

2255

logger.warning("GnuTLS bye failed",

2256

exc_info=error)

1444

except gnutls.errors.GNUTLSError as error:

1445

logger.warning("GnuTLS bye failed")

2257

1446

2258

1447

@staticmethod

2259

1448

def peer_certificate(session):

2260

1449

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

2261

1450

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

1451

if (gnutls.library.functions

1452

.gnutls_certificate_type_get(session._c_object)

1453

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1454

# ...do the normal thing

1455

return session.peer_certificate

2266

1456

list_size = ctypes.c_uint(1)

2267

cert_list = (gnutls.certificate_get_peers

1457

cert_list = (gnutls.library.functions

1458

.gnutls_certificate_get_peers

2268

1459

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

2269

1460

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

2270

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

1461

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

1462

" certificate")

2271

1463

if list_size.value == 0:

2272

1464

return None

2273

1465

cert = cert_list[0]

2277

1469

def fingerprint(openpgp):

2278

1470

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2279

1471

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

1472

datum = (gnutls.library.types

1473

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

1474

ctypes.POINTER

1475

(ctypes.c_ubyte)),

1476

ctypes.c_uint(len(openpgp))))

2284

1477

# New empty GnuTLS certificate

2285

crt = gnutls.openpgp_crt_t()

2286

gnutls.openpgp_crt_init(ctypes.byref(crt))

1478

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1479

(gnutls.library.functions

1480

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2287

1481

# Import the OpenPGP public key into the certificate

2288

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

2289

gnutls.OPENPGP_FMT_RAW)

1482

(gnutls.library.functions

1483

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

1484

gnutls.library.constants

1485

.GNUTLS_OPENPGP_FMT_RAW))

2290

1486

# Verify the self signature in the key

2291

1487

crtverify = ctypes.c_uint()

2292

gnutls.openpgp_crt_verify_self(crt, 0,

2293

ctypes.byref(crtverify))

1488

(gnutls.library.functions

1489

.gnutls_openpgp_crt_verify_self(crt, 0,

1490

ctypes.byref(crtverify)))

2294

1491

if crtverify.value != 0:

2295

gnutls.openpgp_crt_deinit(crt)

2296

raise gnutls.CertificateSecurityError("Verify failed")

1492

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1493

raise (gnutls.errors.CertificateSecurityError

1494

("Verify failed"))

2297

1495

# New buffer for the fingerprint

2298

1496

buf = ctypes.create_string_buffer(20)

2299

1497

buf_len = ctypes.c_size_t()

2300

1498

# Get the fingerprint from the certificate into the buffer

2301

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

2302

ctypes.byref(buf_len))

1499

(gnutls.library.functions

1500

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

1501

ctypes.byref(buf_len)))

2303

1502

# Deinit the certificate

2304

gnutls.openpgp_crt_deinit(crt)

1503

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2305

1504

# Convert the buffer to a Python bytestring

2306

1505

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

2307

1506

# Convert the bytestring to hexadecimal notation

2308

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

1507

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

2309

1508

return hex_fpr

2310

1509

2311

1510

2312

1511

class MultiprocessingMixIn(object):

2313

1512

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

2314

2315

1513

def sub_process_main(self, request, address):

2316

1514

try:

2317

1515

self.finish_request(request, address)

2318

except Exception:

1516

except:

2319

1517

self.handle_error(request, address)

2320

1518

self.close_request(request)

2321

1519

2322

1520

def process_request(self, request, address):

2323

1521

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

2324

1522

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

2325

args = (request, address))

1523

args = (request,

1524

address))

2326

1525

proc.start()

2327

1526

return proc

2328

1527

2329

1528

2330

1529

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2331

1530

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

2332

2333

1531

def process_request(self, request, client_address):

2334

1532

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

2335

1533

2344

1542

2345

1543

def add_pipe(self, parent_pipe, proc):

2346

1544

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

2347

raise NotImplementedError()

1545

raise NotImplementedError

2348

1546

2349

1547

2350

1548

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2356

1554

interface: None or a network interface name (string)

2357

1555

use_ipv6: Boolean; to use IPv6 or not

2358

1556

"""

2359

2360

1557

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

"""

1558

interface=None, use_ipv6=True):

2367

1559

self.interface = interface

2368

1560

if use_ipv6:

2369

1561

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

1562

socketserver.TCPServer.__init__(self, server_address,

2397

1563

RequestHandlerClass)

2398

2399

1564

def server_bind(self):

2400

1565

"""This overrides the normal server_bind() function

2401

1566

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

2407

1572

self.interface)

2408

1573

else:

2409

1574

try:

2410

self.socket.setsockopt(

2411

socket.SOL_SOCKET, SO_BINDTODEVICE,

2412

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

1575

self.socket.setsockopt(socket.SOL_SOCKET,

1576

SO_BINDTODEVICE,

1577

str(self.interface

1578

+ '\0'))

2413

1579

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:

1580

if error[0] == errno.EPERM:

1581

logger.error("No permission to"

1582

" bind to interface %s",

1583

self.interface)

1584

elif error[0] == errno.ENOPROTOOPT:

2418

1585

logger.error("SO_BINDTODEVICE not available;"

2419

1586

" cannot bind to interface %s",

2420

1587

self.interface)

2421

elif error.errno == errno.ENODEV:

2422

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

2423

" cannot bind", self.interface)

2424

1588

else:

2425

1589

raise

2426

1590

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

2429

1593

if self.address_family == socket.AF_INET6:

2430

1594

any_address = "::" # in6addr_any

2431

1595

else:

2432

any_address = "0.0.0.0" # INADDR_ANY

1596

any_address = socket.INADDR_ANY

2433

1597

self.server_address = (any_address,

2434

1598

self.server_address[1])

2435

1599

elif not self.server_address[1]:

2436

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

1600

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

1601

0)

2437

1602

# if self.interface:

2438

1603

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

2439

1604

# 0, # port

2453

1618

2454

1619

Assumes a gobject.MainLoop event loop.

2455

1620

"""

2456

2457

1621

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

1622

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

1623

gnutls_priority=None, use_dbus=True):

2464

1624

self.enabled = False

2465

1625

self.clients = clients

2466

1626

if self.clients is None:

2467

self.clients = {}

1627

self.clients = set()

2468

1628

self.use_dbus = use_dbus

2469

1629

self.gnutls_priority = gnutls_priority

2470

1630

IPv6_TCPServer.__init__(self, server_address,

2471

1631

RequestHandlerClass,

2472

1632

interface = interface,

2473

use_ipv6 = use_ipv6,

2474

socketfd = socketfd)

2475

1633

use_ipv6 = use_ipv6)

2476

1634

def server_activate(self):

2477

1635

if self.enabled:

2478

1636

return socketserver.TCPServer.server_activate(self)

2482

1640

2483

1641

def add_pipe(self, parent_pipe, proc):

2484

1642

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

1643

gobject.io_add_watch(parent_pipe.fileno(),

1644

gobject.IO_IN | gobject.IO_HUP,

1645

functools.partial(self.handle_ipc,

1646

parent_pipe =

1647

parent_pipe,

1648

proc = proc))

2491

1649

2492

def handle_ipc(self, source, condition,

2493

parent_pipe=None,

2494

proc = None,

2495

client_object=None):

1650

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

1651

proc = None, client_object=None):

1652

condition_names = {

1653

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

1654

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

1655

# blocking).

1656

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

1657

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

1658

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

1659

# broken, usually for pipes and

1660

# sockets).

1661

}

1662

conditions_string = ' | '.join(name

1663

for cond, name in

1664

condition_names.iteritems()

1665

if cond & condition)

2496

1666

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

2497

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

1667

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

2498

1668

# Wait for other process to exit

2499

1669

proc.join()

2500

1670

return False

2507

1677

fpr = request[1]

2508

1678

address = request[2]

2509

1679

2510

for c in self.clients.itervalues():

1680

for c in self.clients:

2511

1681

if c.fingerprint == fpr:

2512

1682

client = c

2513

1683

break

2521

1691

parent_pipe.send(False)

2522

1692

return False

2523

1693

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

1694

gobject.io_add_watch(parent_pipe.fileno(),

1695

gobject.IO_IN | gobject.IO_HUP,

1696

functools.partial(self.handle_ipc,

1697

parent_pipe =

1698

parent_pipe,

1699

proc = proc,

1700

client_object =

1701

client))

2531

1702

parent_pipe.send(True)

2532

1703

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

2533

1704

# same fileno

2539

1710

2540

1711

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

2541

1712

funcname)(*args,

2542

**kwargs)))

1713

**kwargs)))

2543

1714

2544

1715

if command == 'getattr':

2545

1716

attrname = request[1]

2546

if isinstance(client_object.__getattribute__(attrname),

2547

collections.Callable):

2548

parent_pipe.send(('function', ))

1717

if callable(client_object.__getattribute__(attrname)):

1718

parent_pipe.send(('function',))

2549

1719

else:

2550

parent_pipe.send((

2551

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

1720

parent_pipe.send(('data', client_object

1721

.__getattribute__(attrname)))

2552

1722

2553

1723

if command == 'setattr':

2554

1724

attrname = request[1]

2558

1728

return True

2559

1729

2560

1730

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

1731

def string_to_delta(interval):

2658

1732

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

2659

1733

2670

1744

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

2671

1745

datetime.timedelta(0, 330)

2672

1746

"""

2673

2674

try:

2675

return rfc3339_duration_to_delta(interval)

2676

except ValueError:

2677

pass

2678

2679

1747

timevalue = datetime.timedelta(0)

2680

1748

for s in interval.split():

2681

1749

try:

2682

suffix = s[-1]

1750

suffix = unicode(s[-1])

2683

1751

value = int(s[:-1])

2684

1752

if suffix == "d":

2685

1753

delta = datetime.timedelta(value)

2692

1760

elif suffix == "w":

2693

1761

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

2694

1762

else:

2695

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

2696

except IndexError as e:

1763

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

1764

except (ValueError, IndexError) as e:

2697

1765

raise ValueError(*(e.args))

2698

1766

timevalue += delta

2699

1767

return timevalue

2700

1768

2701

1769

1770

def if_nametoindex(interface):

1771

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

1772

1773

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

1774

global if_nametoindex

1775

try:

1776

if_nametoindex = (ctypes.cdll.LoadLibrary

1777

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

1778

.if_nametoindex)

1779

except (OSError, AttributeError):

1780

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

1781

def if_nametoindex(interface):

1782

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

1783

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

1784

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

1785

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1786

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

1787

interface))

1788

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

1789

ifreq[16:20])[0]

1790

return interface_index

1791

return if_nametoindex(interface)

1792

1793

2702

1794

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

2703

1795

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

2704

1796

2712

1804

sys.exit()

2713

1805

if not noclose:

2714

1806

# Close all standard open file descriptors

2715

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

1807

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

2716

1808

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

2717

1809

raise OSError(errno.ENODEV,

2718

"{} not a character device"

2719

.format(os.devnull))

1810

"%s not a character device"

1811

% os.path.devnull)

2720

1812

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

2721

1813

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

2722

1814

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

2731

1823

2732

1824

parser = argparse.ArgumentParser()

2733

1825

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

2734

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

1826

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

2735

1827

help="show version number and exit")

2736

1828

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

2737

1829

help="Bind to interface IF")

2743

1835

help="Run self-test")

2744

1836

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

2745

1837

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

2746

" to terminal", default=None)

1838

" to terminal")

2747

1839

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

2748

1840

help="Debug level for stdout output")

2749

1841

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

2756

1848

" files")

2757

1849

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

2758

1850

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

2759

" system bus interface", default=None)

1851

" system bus interface")

2760

1852

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

1853

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

2777

1854

options = parser.parse_args()

2778

1855

2779

1856

if options.check:

2780

1857

import doctest

2781

fail_count, test_count = doctest.testmod()

2782

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

1858

doctest.testmod()

1859

sys.exit()

2783

1860

2784

1861

# Default values for config file for server-global settings

2785

1862

server_defaults = { "interface": "",

2787

1864

"port": "",

2788

1865

"debug": "False",

2789

1866

"priority":

2790

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

2791

":+SIGN-DSA-SHA256",

1867

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

2792

1868

"servicename": "Mandos",

2793

1869

"use_dbus": "True",

2794

1870

"use_ipv6": "True",

2795

1871

"debuglevel": "",

2796

"restore": "True",

2797

"socket": "",

2798

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

2799

"foreground": "False",

2800

"zeroconf": "True",

2801

}

1872

}

2802

1873

2803

1874

# Parse config file for server-global settings

2804

1875

server_config = configparser.SafeConfigParser(server_defaults)

2805

1876

del server_defaults

2806

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

1877

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

1878

"mandos.conf"))

2807

1879

# Convert the SafeConfigParser object to a dict

2808

1880

server_settings = server_config.defaults()

2809

1881

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

2810

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

1882

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

2811

1883

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

2812

1884

option)

2813

1885

if server_settings["port"]:

2814

1886

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

2815

1887

"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

1888

del server_config

2826

1889

2827

1890

# Override the settings from the config file with command line

2828

1891

# options, if set.

2829

1892

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

2830

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

2831

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

2832

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

1893

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

1894

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

2833

1895

value = getattr(options, option)

2834

1896

if value is not None:

2835

1897

server_settings[option] = value

2836

1898

del options

2837

1899

# Force all strings to be unicode

2838

1900

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

1901

if type(server_settings[option]) is str:

1902

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

2849

1903

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

2850

1904

2851

1905

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

2852

1906

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

1907

# For convenience

2859

1908

debug = server_settings["debug"]

2860

1909

debuglevel = server_settings["debuglevel"]

2861

1910

use_dbus = server_settings["use_dbus"]

2862

1911

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

1912

2877

1913

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

2878

syslogger.setFormatter(

2879

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

2880

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

2881

server_settings["servicename"])))

1914

syslogger.setFormatter(logging.Formatter

1915

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

1916

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

1917

% server_settings["servicename"]))

2882

1918

2883

1919

# Parse config file with clients

2884

client_config = configparser.SafeConfigParser(Client

2885

.client_defaults)

1920

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

1921

"extended_timeout": "15m",

1922

"interval": "2m",

1923

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

1924

"host": "",

1925

"approval_delay": "0s",

1926

"approval_duration": "1s",

1927

}

1928

client_config = configparser.SafeConfigParser(client_defaults)

2886

1929

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

2887

1930

"clients.conf"))

2888

1931

2889

1932

global mandos_dbus_service

2890

1933

mandos_dbus_service = None

2891

1934

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

1935

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

1936

server_settings["port"]),

1937

ClientHandler,

1938

interface=(server_settings["interface"]

1939

or None),

1940

use_ipv6=use_ipv6,

1941

gnutls_priority=

1942

server_settings["priority"],

1943

use_dbus=use_dbus)

1944

if not debug:

1945

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

2908

1946

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)

1947

pidfile = open(pidfilename, "w")

1948

except IOError:

1949

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

2913

1950

2914

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

1951

try:

1952

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

1953

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

1954

except KeyError:

2915

1955

try:

2916

uid = pwd.getpwnam(name).pw_uid

2917

gid = pwd.getpwnam(name).pw_gid

2918

break

1956

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

1957

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

2919

1958

except KeyError:

2920

continue

2921

else:

2922

uid = 65534

2923

gid = 65534

1959

try:

1960

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

1961

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

1962

except KeyError:

1963

uid = 65534

1964

gid = 65534

2924

1965

try:

2925

1966

os.setgid(gid)

2926

1967

os.setuid(uid)

2927

1968

except OSError as error:

2928

if error.errno != errno.EPERM:

2929

raise

1969

if error[0] != errno.EPERM:

1970

raise error

1971

1972

if not debug and not debuglevel:

1973

syslogger.setLevel(logging.WARNING)

1974

console.setLevel(logging.WARNING)

1975

if debuglevel:

1976

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

1977

syslogger.setLevel(level)

1978

console.setLevel(level)

2930

1979

2931

1980

if debug:

2932

1981

# Enable all possible GnuTLS debugging

2933

1982

2934

1983

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

2935

1984

# - GnuTLS manual

2936

gnutls.global_set_log_level(11)

1985

gnutls.library.functions.gnutls_global_set_log_level(11)

2937

1986

2938

@gnutls.log_func

1987

@gnutls.library.types.gnutls_log_func

2939

1988

def debug_gnutls(level, string):

2940

1989

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

2941

1990

2942

gnutls.global_set_log_function(debug_gnutls)

1991

(gnutls.library.functions

1992

.gnutls_global_set_log_function(debug_gnutls))

2943

1993

2944

1994

# Redirect stdin so all checkers get /dev/null

2945

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

1995

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

2946

1996

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

2947

1997

if null > 2:

2948

1998

os.close(null)

1999

else:

2000

# No console logging

2001

logger.removeHandler(console)

2949

2002

2950

2003

# Need to fork before connecting to D-Bus

2951

if not foreground:

2004

if not debug:

2952

2005

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

2953

2006

daemon()

2954

2007

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

2008

global main_loop

2960

2009

# From the Avahi example code

2961

DBusGMainLoop(set_as_default=True)

2010

DBusGMainLoop(set_as_default=True )

2962

2011

main_loop = gobject.MainLoop()

2963

2012

bus = dbus.SystemBus()

2964

2013

# End of Avahi example code

2965

2014

if use_dbus:

2966

2015

try:

2967

2016

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)

2017

bus, do_not_queue=True)

2018

old_bus_name = (dbus.service.BusName

2019

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

2020

do_not_queue=True))

2021

except dbus.exceptions.NameExistsException as e:

2022

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

2975

2023

use_dbus = False

2976

2024

server_settings["use_dbus"] = False

2977

2025

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

2026

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2027

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

2028

servicetype = "_mandos._tcp",

2029

protocol = protocol, bus = bus)

2030

if server_settings["interface"]:

2031

service.interface = (if_nametoindex

2032

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

2988

2033

2989

2034

global multiprocessing_manager

2990

2035

multiprocessing_manager = multiprocessing.Manager()

2991

2036

2992

2037

client_class = Client

2993

2038

if use_dbus:

2994

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

2995

2996

client_settings = Client.config_parser(client_config)

2997

old_client_settings = {}

2998

clients_data = {}

2999

3000

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

3001

global wnull

3002

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

3003

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

3004

# mode

3005

if debug or not foreground:

3006

wnull.close()

3007

3008

# Get client data and settings from last running state.

3009

if server_settings["restore"]:

3010

try:

3011

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

3012

clients_data, old_client_settings = pickle.load(

3013

stored_state)

3014

os.remove(stored_state_path)

3015

except IOError as e:

3016

if e.errno == errno.ENOENT:

3017

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

3018

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

3019

else:

3020

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

3021

exc_info=e)

3022

raise

3023

except EOFError as e:

3024

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

3025

"EOFError:",

3026

exc_info=e)

3027

3028

with PGPEngine() as pgp:

3029

for client_name, client in clients_data.items():

3030

# Skip removed clients

3031

if client_name not in client_settings:

3032

continue

3033

3034

# Decide which value to use after restoring saved state.

3035

# We have three different values: Old config file,

3036

# new config file, and saved state.

3037

# New config value takes precedence if it differs from old

3038

# config value, otherwise use saved state.

3039

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

3040

try:

3041

# For each value in new config, check if it

3042

# differs from the old config value (Except for

3043

# the "secret" attribute)

3044

if (name != "secret"

3045

and (value !=

3046

old_client_settings[client_name][name])):

3047

client[name] = value

3048

except KeyError:

3049

pass

3050

3051

# Clients who has passed its expire date can still be

3052

# enabled if its last checker was successful. A Client

3053

# whose checker succeeded before we stored its state is

3054

# assumed to have successfully run all checkers during

3055

# downtime.

3056

if client["enabled"]:

3057

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

3058

if not client["last_checked_ok"]:

3059

logger.warning(

3060

"disabling client {} - Client never "

3061

"performed a successful checker".format(

3062

client_name))

3063

client["enabled"] = False

3064

elif client["last_checker_status"] != 0:

3065

logger.warning(

3066

"disabling client {} - Client last"

3067

" checker failed with error code"

3068

" {}".format(

3069

client_name,

3070

client["last_checker_status"]))

3071

client["enabled"] = False

3072

else:

3073

client["expires"] = (

3074

datetime.datetime.utcnow()

3075

+ client["timeout"])

3076

logger.debug("Last checker succeeded,"

3077

" keeping {} enabled".format(

3078

client_name))

2039

client_class = functools.partial(ClientDBusTransitional,

2040

bus = bus)

2041

def client_config_items(config, section):

2042

special_settings = {

2043

"approved_by_default":

2044

lambda: config.getboolean(section,

2045

"approved_by_default"),

2046

}

2047

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

3079

2048

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

2049

yield (name, special_settings[name]())

2050

except KeyError:

2051

yield (name, value)

2052

2053

tcp_server.clients.update(set(

2054

client_class(name = section,

2055

config= dict(client_config_items(

2056

client_config, section)))

2057

for section in client_config.sections()))

3105

2058

if not tcp_server.clients:

3106

2059

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

2060

2061

if not debug:

2062

try:

2063

with pidfile:

2064

pid = os.getpid()

2065

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

2066

del pidfile

2067

except IOError:

2068

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

2069

pidfilename, pid)

2070

except NameError:

2071

# "pidfile" was never created

2072

pass

3118

2073

del pidfilename

2074

2075

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

3119

2076

3120

2077

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

3121

2078

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

3122

2079

3123

2080

if use_dbus:

3124

3125

@alternate_dbus_interfaces(

3126

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

3127

class MandosDBusService(DBusObjectWithObjectManager):

2081

class MandosDBusService(dbus.service.Object):

3128

2082

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

3129

3130

2083

def __init__(self):

3131

2084

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

3132

3133

2085

_interface = "se.recompile.Mandos"

3134

2086

3135

2087

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

3142

2094

"D-Bus signal"

3143

2095

pass

3144

2096

3145

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

3146

"true"})

3147

2097

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

3148

2098

def ClientRemoved(self, objpath, name):

3149

2099

"D-Bus signal"

3150

2100

pass

3151

2101

3152

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

3153

"true"})

3154

2102

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

3155

2103

def GetAllClients(self):

3156

2104

"D-Bus method"

3157

return dbus.Array(c.dbus_object_path for c in

3158

tcp_server.clients.itervalues())

2105

return dbus.Array(c.dbus_object_path

2106

for c in tcp_server.clients)

3159

2107

3160

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

3161

"true"})

3162

2108

@dbus.service.method(_interface,

3163

2109

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

3164

2110

def GetAllClientsWithProperties(self):

3165

2111

"D-Bus method"

3166

2112

return dbus.Dictionary(

3167

{ c.dbus_object_path: c.GetAll(

3168

"se.recompile.Mandos.Client")

3169

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

2113

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

2114

for c in tcp_server.clients),

3170

2115

signature="oa{sv}")

3171

2116

3172

2117

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

3173

2118

def RemoveClient(self, object_path):

3174

2119

"D-Bus method"

3175

for c in tcp_server.clients.itervalues():

2120

for c in tcp_server.clients:

3176

2121

if c.dbus_object_path == object_path:

3177

del tcp_server.clients[c.name]

2122

tcp_server.clients.remove(c)

3178

2123

c.remove_from_connection()

3179

# Don't signal the disabling

2124

# Don't signal anything except ClientRemoved

3180

2125

c.disable(quiet=True)

3181

# Emit D-Bus signal for removal

3182

self.client_removed_signal(c)

2126

# Emit D-Bus signal

2127

self.ClientRemoved(object_path, c.name)

3183

2128

return

3184

2129

raise KeyError(object_path)

3185

2130

3186

2131

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

2132

3224

mandos_dbus_service = MandosDBusService()

2133

class MandosDBusServiceTransitional(MandosDBusService):

2134

__metaclass__ = AlternateDBusNamesMetaclass

2135

mandos_dbus_service = MandosDBusServiceTransitional()

3225

2136

3226

2137

def cleanup():

3227

2138

"Cleanup function; run on exit"

3228

if zeroconf:

3229

service.cleanup()

2139

service.cleanup()

3230

2140

3231

2141

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

3289

2142

while tcp_server.clients:

3290

name, client = tcp_server.clients.popitem()

2143

client = tcp_server.clients.pop()

3291

2144

if use_dbus:

3292

2145

client.remove_from_connection()

3293

# Don't signal the disabling

2146

client.disable_hook = None

2147

# Don't signal anything except ClientRemoved

3294

2148

client.disable(quiet=True)

3295

# Emit D-Bus signal for removal

3296

2149

if use_dbus:

3297

mandos_dbus_service.client_removed_signal(client)

3298

client_settings.clear()

2150

# Emit D-Bus signal

2151

mandos_dbus_service.ClientRemoved(client

2152

.dbus_object_path,

2153

client.name)

3299

2154

3300

2155

atexit.register(cleanup)

3301

2156

3302

for client in tcp_server.clients.itervalues():

2157

for client in tcp_server.clients:

3303

2158

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

2159

# Emit D-Bus signal

2160

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2161

client.enable()

3309

2162

3310

2163

tcp_server.enable()

3311

2164

tcp_server.server_activate()

3312

2165

3313

2166

# Find out what port we got

3314

if zeroconf:

3315

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

2167

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

3316

2168

if use_ipv6:

3317

2169

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

3318

" flowinfo %d, scope_id %d",

3319

*tcp_server.socket.getsockname())

2170

" flowinfo %d, scope_id %d"

2171

% tcp_server.socket.getsockname())

3320

2172

else: # IPv4

3321

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

3322

*tcp_server.socket.getsockname())

2173

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

2174

% tcp_server.socket.getsockname())

3323

2175

3324

2176

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

3325

2177

3326

2178

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

2179

# From the Avahi example code

2180

try:

2181

service.activate()

2182

except dbus.exceptions.DBusException as error:

2183

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

2184

cleanup()

2185

sys.exit(1)

2186

# End of Avahi example code

3336

2187

3337

2188

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

3338

2189

lambda *args, **kwargs:

3342

2193

logger.debug("Starting main loop")

3343

2194

main_loop.run()

3344

2195

except AvahiError as error:

3345

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

2196

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

3346

2197

cleanup()

3347

2198

sys.exit(1)

3348

2199

except KeyboardInterrupt: