/mandos/trunk : revision 561.1.1

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

try:

38

from future_builtins import *

39

except ImportError:

40

pass

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

37

import SocketServer as socketserver

46

38

import socket

47

39

import argparse

48

40

import datetime

49

41

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

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

54

49

import sys

55

50

import re

56

51

import os

65

60

import struct

66

61

import fcntl

67

62

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

63

import cPickle as pickle

72

64

import multiprocessing

73

65

import types

74

66

import binascii

75

67

import tempfile

76

68

import itertools

77

import collections

78

import codecs

79

69

80

70

import dbus

81

71

import dbus.service

82

from gi.repository import GLib

72

import gobject

73

import avahi

83

74

from dbus.mainloop.glib import DBusGMainLoop

84

75

import ctypes

85

76

import ctypes.util

86

77

import xml.dom.minidom

87

78

import inspect

79

import GnuPGInterface

88

80

89

81

try:

90

82

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

86

except ImportError:

95

87

SO_BINDTODEVICE = None

96

88

97

if sys.version_info.major == 2:

98

str = unicode

99

100

version = "1.7.5"

89

version = "1.5.3"

101

90

stored_state_file = "clients.pickle"

102

91

103

92

logger = logging.getLogger()

104

syslogger = None

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

105

96

106

97

try:

107

if_nametoindex = ctypes.cdll.LoadLibrary(

108

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

109

101

except (OSError, AttributeError):

110

111

102

def if_nametoindex(interface):

112

103

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

113

104

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

114

105

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

115

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

116

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

117

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

118

111

return interface_index

119

112

120

113

121

def copy_function(func):

122

"""Make a copy of a function"""

123

if sys.version_info.major == 2:

124

return types.FunctionType(func.func_code,

125

func.func_globals,

126

func.func_name,

127

func.func_defaults,

128

func.func_closure)

129

else:

130

return types.FunctionType(func.__code__,

131

func.__globals__,

132

func.__name__,

133

func.__defaults__,

134

func.__closure__)

135

136

137

114

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

138

115

"""init logger and add loglevel"""

139

116

140

global syslogger

141

syslogger = (logging.handlers.SysLogHandler(

142

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

143

address = "/dev/log"))

144

117

syslogger.setFormatter(logging.Formatter

145

118

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

146

119

' %(message)s'))

163

136

164

137

class PGPEngine(object):

165

138

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

166

167

139

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

168

141

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

169

self.gpg = "gpg"

170

try:

171

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

172

for line in output.splitlines():

173

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

174

if name == "gpg":

175

self.gpg = path

176

break

177

except OSError as e:

178

if e.errno != errno.ENOENT:

179

raise

180

self.gnupgargs = ['--batch',

181

'--homedir', self.tempdir,

182

'--force-mdc',

183

'--quiet',

184

'--no-use-agent']

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

self.gnupg.options.extra_args.extend(['--force-mdc',

146

'--quiet',

147

'--no-use-agent'])

185

148

186

149

def __enter__(self):

187

150

return self

188

151

189

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

152

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

190

153

self._cleanup()

191

154

return False

192

155

209

172

def password_encode(self, password):

210

173

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

211

174

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

212

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

213

if len(encoded) > 2048:

214

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

215

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

216

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

217

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

218

return encoded

175

return b"mandos" + binascii.hexlify(password)

219

176

220

177

def encrypt(self, data, password):

221

passphrase = self.password_encode(password)

222

with tempfile.NamedTemporaryFile(

223

dir=self.tempdir) as passfile:

224

passfile.write(passphrase)

225

passfile.flush()

226

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

227

'--passphrase-file',

228

passfile.name]

229

+ self.gnupgargs,

230

stdin = subprocess.PIPE,

231

stdout = subprocess.PIPE,

232

stderr = subprocess.PIPE)

233

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

234

if proc.returncode != 0:

235

raise PGPError(err)

178

self.gnupg.passphrase = self.password_encode(password)

179

with open(os.devnull, "w") as devnull:

180

try:

181

proc = self.gnupg.run(['--symmetric'],

182

create_fhs=['stdin', 'stdout'],

183

attach_fhs={'stderr': devnull})

184

with contextlib.closing(proc.handles['stdin']) as f:

185

f.write(data)

186

with contextlib.closing(proc.handles['stdout']) as f:

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

236

192

return ciphertext

237

193

238

194

def decrypt(self, data, password):

239

passphrase = self.password_encode(password)

240

with tempfile.NamedTemporaryFile(

241

dir = self.tempdir) as passfile:

242

passfile.write(passphrase)

243

passfile.flush()

244

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

245

'--passphrase-file',

246

passfile.name]

247

+ self.gnupgargs,

248

stdin = subprocess.PIPE,

249

stdout = subprocess.PIPE,

250

stderr = subprocess.PIPE)

251

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

252

if proc.returncode != 0:

253

raise PGPError(err)

195

self.gnupg.passphrase = self.password_encode(password)

196

with open(os.devnull, "w") as devnull:

197

try:

198

proc = self.gnupg.run(['--decrypt'],

199

create_fhs=['stdin', 'stdout'],

200

attach_fhs={'stderr': devnull})

201

with contextlib.closing(proc.handles['stdin']) as f:

202

f.write(data)

203

with contextlib.closing(proc.handles['stdout']) as f:

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

254

209

return decrypted_plaintext

255

210

256

# Pretend that we have an Avahi module

257

class Avahi(object):

258

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

259

It is instantiated once, and simulates having an Avahi module."""

260

IF_UNSPEC = -1 # avahi-common/address.h

261

PROTO_UNSPEC = -1 # avahi-common/address.h

262

PROTO_INET = 0 # avahi-common/address.h

263

PROTO_INET6 = 1 # avahi-common/address.h

264

DBUS_NAME = "org.freedesktop.Avahi"

265

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

266

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

267

DBUS_PATH_SERVER = "/"

268

def string_array_to_txt_array(self, t):

269

return dbus.Array((dbus.ByteArray(s.encode("utf-8"))

270

for s in t), signature="ay")

271

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

272

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

273

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

274

SERVER_INVALID = 0 # avahi-common/defs.h

275

SERVER_REGISTERING = 1 # avahi-common/defs.h

276

SERVER_RUNNING = 2 # avahi-common/defs.h

277

SERVER_COLLISION = 3 # avahi-common/defs.h

278

SERVER_FAILURE = 4 # avahi-common/defs.h

279

avahi = Avahi()

211

280

212

281

213

class AvahiError(Exception):

282

214

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

283

215

self.value = value

284

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

285

**kwargs)

286

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

287

219

288

220

class AvahiServiceError(AvahiError):

289

221

pass

290

222

291

292

223

class AvahiGroupError(AvahiError):

293

224

pass

294

225

301

232

Used to optionally bind to the specified interface.

302

233

name: string; Example: 'Mandos'

303

234

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

304

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

235

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

305

236

port: integer; what port to announce

306

237

TXT: list of strings; TXT record for the service

307

238

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

313

244

server: D-Bus Server

314

245

bus: dbus.SystemBus()

315

246

"""

316

317

def __init__(self,

318

interface = avahi.IF_UNSPEC,

319

name = None,

320

servicetype = None,

321

port = None,

322

TXT = None,

323

domain = "",

324

host = "",

325

max_renames = 32768,

326

protocol = avahi.PROTO_UNSPEC,

327

bus = None):

247

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

248

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

249

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

250

protocol = avahi.PROTO_UNSPEC, bus = None):

328

251

self.interface = interface

329

252

self.name = name

330

253

self.type = servicetype

339

262

self.server = None

340

263

self.bus = bus

341

264

self.entry_group_state_changed_match = None

342

343

def rename(self, remove=True):

265

def rename(self):

344

266

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

345

267

if self.rename_count >= self.max_renames:

346

268

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

347

269

" after %i retries, exiting.",

348

270

self.rename_count)

349

271

raise AvahiServiceError("Too many renames")

350

self.name = str(

351

self.server.GetAlternativeServiceName(self.name))

352

self.rename_count += 1

272

self.name = unicode(self.server

273

.GetAlternativeServiceName(self.name))

353

274

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

354

275

self.name)

355

if remove:

356

self.remove()

276

self.remove()

357

277

try:

358

278

self.add()

359

279

except dbus.exceptions.DBusException as error:

360

if (error.get_dbus_name()

361

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

362

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

363

return self.rename(remove=False)

364

else:

365

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

366

self.cleanup()

367

os._exit(1)

368

280

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

281

self.cleanup()

282

os._exit(1)

283

self.rename_count += 1

369

284

def remove(self):

370

285

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

371

286

if self.entry_group_state_changed_match is not None:

373

288

self.entry_group_state_changed_match = None

374

289

if self.group is not None:

375

290

self.group.Reset()

376

377

291

def add(self):

378

292

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

379

293

self.remove()

396

310

dbus.UInt16(self.port),

397

311

avahi.string_array_to_txt_array(self.TXT))

398

312

self.group.Commit()

399

400

313

def entry_group_state_changed(self, state, error):

401

314

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

402

315

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

408

321

self.rename()

409

322

elif state == avahi.ENTRY_GROUP_FAILURE:

410

323

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

411

str(error))

412

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

413

324

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

414

327

def cleanup(self):

415

328

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

416

329

if self.group is not None:

421

334

pass

422

335

self.group = None

423

336

self.remove()

424

425

337

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

426

338

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

427

339

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

428

bad_states = {

429

avahi.SERVER_INVALID: "Zeroconf server invalid",

430

avahi.SERVER_REGISTERING: None,

431

avahi.SERVER_COLLISION: "Zeroconf server name collision",

432

avahi.SERVER_FAILURE: "Zeroconf server failure",

433

}

340

bad_states = { avahi.SERVER_INVALID:

341

"Zeroconf server invalid",

342

avahi.SERVER_REGISTERING: None,

343

avahi.SERVER_COLLISION:

344

"Zeroconf server name collision",

345

avahi.SERVER_FAILURE:

346

"Zeroconf server failure" }

434

347

if state in bad_states:

435

348

if bad_states[state] is not None:

436

349

if error is None:

439

352

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

440

353

self.cleanup()

441

354

elif state == avahi.SERVER_RUNNING:

442

try:

443

self.add()

444

except dbus.exceptions.DBusException as error:

445

if (error.get_dbus_name()

446

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

447

logger.info("Local Zeroconf service name"

448

" collision.")

449

return self.rename(remove=False)

450

else:

451

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

452

self.cleanup()

453

os._exit(1)

355

self.add()

454

356

else:

455

357

if error is None:

456

358

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

457

359

else:

458

360

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

459

460

361

def activate(self):

461

362

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

462

363

if self.server is None:

466

367

follow_name_owner_changes=True),

467

368

avahi.DBUS_INTERFACE_SERVER)

468

369

self.server.connect_to_signal("StateChanged",

469

self.server_state_changed)

370

self.server_state_changed)

470

371

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

471

372

472

473

373

class AvahiServiceToSyslog(AvahiService):

474

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

374

def rename(self):

475

375

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

476

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

477

syslogger.setFormatter(logging.Formatter(

478

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

479

.format(self.name)))

376

ret = AvahiService.rename(self)

377

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

% self.name))

480

381

return ret

481

382

482

# Pretend that we have a GnuTLS module

483

class GnuTLS(object):

484

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

485

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

486

487

_library = ctypes.cdll.LoadLibrary(

488

ctypes.util.find_library("gnutls"))

489

_need_version = b"3.3.0"

490

def __init__(self):

491

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

492

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

493

# happens.

494

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

495

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

496

.format(self._need_version))

497

498

# Unless otherwise indicated, the constants and types below are

499

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

500

501

# Constants

502

E_SUCCESS = 0

503

E_INTERRUPTED = -52

504

E_AGAIN = -28

505

CRT_OPENPGP = 2

506

CLIENT = 2

507

SHUT_RDWR = 0

508

CRD_CERTIFICATE = 1

509

E_NO_CERTIFICATE_FOUND = -49

510

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

511

512

# Types

513

class session_int(ctypes.Structure):

514

_fields_ = []

515

session_t = ctypes.POINTER(session_int)

516

class certificate_credentials_st(ctypes.Structure):

517

_fields_ = []

518

certificate_credentials_t = ctypes.POINTER(

519

certificate_credentials_st)

520

certificate_type_t = ctypes.c_int

521

class datum_t(ctypes.Structure):

522

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

523

('size', ctypes.c_uint)]

524

class openpgp_crt_int(ctypes.Structure):

525

_fields_ = []

526

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

527

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

528

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

529

credentials_type_t = ctypes.c_int

530

transport_ptr_t = ctypes.c_void_p

531

close_request_t = ctypes.c_int

532

533

# Exceptions

534

class Error(Exception):

535

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

536

# exception might be raised from within GnuTLS.__init__,

537

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

538

# global variable has happened.

539

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

540

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

541

# code is passed, convert it to a string with

542

# gnutls.strerror()

543

self.code = code

544

if message is None and code is not None:

545

message = GnuTLS.strerror(code)

546

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

547

message, *args)

548

549

class CertificateSecurityError(Error):

550

pass

551

552

# Classes

553

class Credentials(object):

554

def __init__(self):

555

self._c_object = gnutls.certificate_credentials_t()

556

gnutls.certificate_allocate_credentials(

557

ctypes.byref(self._c_object))

558

self.type = gnutls.CRD_CERTIFICATE

559

560

def __del__(self):

561

gnutls.certificate_free_credentials(self._c_object)

562

563

class ClientSession(object):

564

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

565

self._c_object = gnutls.session_t()

566

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

567

gnutls.set_default_priority(self._c_object)

568

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

569

gnutls.handshake_set_private_extensions(self._c_object,

570

True)

571

self.socket = socket

572

if credentials is None:

573

credentials = gnutls.Credentials()

574

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

575

ctypes.cast(credentials._c_object,

576

ctypes.c_void_p))

577

self.credentials = credentials

578

579

def __del__(self):

580

gnutls.deinit(self._c_object)

581

582

def handshake(self):

583

return gnutls.handshake(self._c_object)

584

585

def send(self, data):

586

data = bytes(data)

587

data_len = len(data)

588

while data_len > 0:

589

data_len -= gnutls.record_send(self._c_object,

590

data[-data_len:],

591

data_len)

592

593

def bye(self):

594

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

595

596

# Error handling functions

597

def _error_code(result):

598

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

599

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

600

if result >= 0:

601

return result

602

if result == gnutls.E_NO_CERTIFICATE_FOUND:

603

raise gnutls.CertificateSecurityError(code = result)

604

raise gnutls.Error(code = result)

605

606

def _retry_on_error(result, func, arguments):

607

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

608

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

609

while result < 0:

610

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

611

return _error_code(result)

612

result = func(*arguments)

613

return result

614

615

# Unless otherwise indicated, the function declarations below are

616

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

617

618

# Functions

619

priority_set_direct = _library.gnutls_priority_set_direct

620

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

621

ctypes.POINTER(ctypes.c_char_p)]

622

priority_set_direct.restype = _error_code

623

624

init = _library.gnutls_init

625

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

626

init.restype = _error_code

627

628

set_default_priority = _library.gnutls_set_default_priority

629

set_default_priority.argtypes = [session_t]

630

set_default_priority.restype = _error_code

631

632

record_send = _library.gnutls_record_send

633

record_send.argtypes = [session_t, ctypes.c_void_p,

634

ctypes.c_size_t]

635

record_send.restype = ctypes.c_ssize_t

636

record_send.errcheck = _retry_on_error

637

638

certificate_allocate_credentials = (

639

_library.gnutls_certificate_allocate_credentials)

640

certificate_allocate_credentials.argtypes = [

641

ctypes.POINTER(certificate_credentials_t)]

642

certificate_allocate_credentials.restype = _error_code

643

644

certificate_free_credentials = (

645

_library.gnutls_certificate_free_credentials)

646

certificate_free_credentials.argtypes = [certificate_credentials_t]

647

certificate_free_credentials.restype = None

648

649

handshake_set_private_extensions = (

650

_library.gnutls_handshake_set_private_extensions)

651

handshake_set_private_extensions.argtypes = [session_t,

652

ctypes.c_int]

653

handshake_set_private_extensions.restype = None

654

655

credentials_set = _library.gnutls_credentials_set

656

credentials_set.argtypes = [session_t, credentials_type_t,

657

ctypes.c_void_p]

658

credentials_set.restype = _error_code

659

660

strerror = _library.gnutls_strerror

661

strerror.argtypes = [ctypes.c_int]

662

strerror.restype = ctypes.c_char_p

663

664

certificate_type_get = _library.gnutls_certificate_type_get

665

certificate_type_get.argtypes = [session_t]

666

certificate_type_get.restype = _error_code

667

668

certificate_get_peers = _library.gnutls_certificate_get_peers

669

certificate_get_peers.argtypes = [session_t,

670

ctypes.POINTER(ctypes.c_uint)]

671

certificate_get_peers.restype = ctypes.POINTER(datum_t)

672

673

global_set_log_level = _library.gnutls_global_set_log_level

674

global_set_log_level.argtypes = [ctypes.c_int]

675

global_set_log_level.restype = None

676

677

global_set_log_function = _library.gnutls_global_set_log_function

678

global_set_log_function.argtypes = [log_func]

679

global_set_log_function.restype = None

680

681

deinit = _library.gnutls_deinit

682

deinit.argtypes = [session_t]

683

deinit.restype = None

684

685

handshake = _library.gnutls_handshake

686

handshake.argtypes = [session_t]

687

handshake.restype = _error_code

688

handshake.errcheck = _retry_on_error

689

690

transport_set_ptr = _library.gnutls_transport_set_ptr

691

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

692

transport_set_ptr.restype = None

693

694

bye = _library.gnutls_bye

695

bye.argtypes = [session_t, close_request_t]

696

bye.restype = _error_code

697

bye.errcheck = _retry_on_error

698

699

check_version = _library.gnutls_check_version

700

check_version.argtypes = [ctypes.c_char_p]

701

check_version.restype = ctypes.c_char_p

702

703

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

704

705

openpgp_crt_init = _library.gnutls_openpgp_crt_init

706

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

707

openpgp_crt_init.restype = _error_code

708

709

openpgp_crt_import = _library.gnutls_openpgp_crt_import

710

openpgp_crt_import.argtypes = [openpgp_crt_t,

711

ctypes.POINTER(datum_t),

712

openpgp_crt_fmt_t]

713

openpgp_crt_import.restype = _error_code

714

715

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

716

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

717

ctypes.POINTER(ctypes.c_uint)]

718

openpgp_crt_verify_self.restype = _error_code

719

720

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

721

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

722

openpgp_crt_deinit.restype = None

723

724

openpgp_crt_get_fingerprint = (

725

_library.gnutls_openpgp_crt_get_fingerprint)

726

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

727

ctypes.c_void_p,

728

ctypes.POINTER(

729

ctypes.c_size_t)]

730

openpgp_crt_get_fingerprint.restype = _error_code

731

732

# Remove non-public functions

733

del _error_code, _retry_on_error

734

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

735

gnutls = GnuTLS()

736

737

def call_pipe(connection, # : multiprocessing.Connection

738

func, *args, **kwargs):

739

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

740

741

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

742

return value on the provided multiprocessing.Connection.

743

"""

744

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

745

connection.close()

746

383

def timedelta_to_milliseconds(td):

384

"Convert a datetime.timedelta() to milliseconds"

385

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

386

+ (td.seconds * 1000)

387

+ (td.microseconds // 1000))

388

747

389

class Client(object):

748

390

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

749

391

754

396

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

755

397

to see if the client lives.

756

398

'None' if no process is running.

757

checker_callback_tag: a GLib event source tag, or None

399

checker_callback_tag: a gobject event source tag, or None

758

400

checker_command: string; External command which is run to check

759

401

if client lives. %() expansions are done at

760

402

runtime with vars(self) as dict, so that for

761

403

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

762

checker_initiator_tag: a GLib event source tag, or None

404

checker_initiator_tag: a gobject event source tag, or None

763

405

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

764

406

client_structure: Object describing what attributes a client has

765

407

and is used for storing the client at exit

766

408

current_checker_command: string; current running checker_command

767

disable_initiator_tag: a GLib event source tag, or None

409

disable_initiator_tag: a gobject event source tag, or None

768

410

enabled: bool()

769

411

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

770

412

uniquely identify the client

775

417

last_checker_status: integer between 0 and 255 reflecting exit

776

418

status of last checker. -1 reflects crashed

777

419

checker, -2 means no checker completed yet.

778

last_checker_signal: The signal which killed the last checker, if

779

last_checker_status is -1

780

420

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

781

421

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

782

422

D-Bus identifiers

787

427

runtime_expansions: Allowed attributes for runtime expansion.

788

428

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

789

429

disabled, or None

790

server_settings: The server_settings dict from main()

791

430

"""

792

431

793

432

runtime_expansions = ("approval_delay", "approval_duration",

794

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

795

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

796

"last_approval_request", "last_checked_ok",

433

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

434

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

797

435

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

798

client_defaults = {

799

"timeout": "PT5M",

800

"extended_timeout": "PT15M",

801

"interval": "PT2M",

802

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

803

"host": "",

804

"approval_delay": "PT0S",

805

"approval_duration": "PT1S",

806

"approved_by_default": "True",

807

"enabled": "True",

808

}

809

436

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

437

"extended_timeout": "15m",

438

"interval": "2m",

439

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

440

"host": "",

441

"approval_delay": "0s",

442

"approval_duration": "1s",

443

"approved_by_default": "True",

444

"enabled": "True",

445

}

446

447

def timeout_milliseconds(self):

448

"Return the 'timeout' attribute in milliseconds"

449

return timedelta_to_milliseconds(self.timeout)

450

451

def extended_timeout_milliseconds(self):

452

"Return the 'extended_timeout' attribute in milliseconds"

453

return timedelta_to_milliseconds(self.extended_timeout)

454

455

def interval_milliseconds(self):

456

"Return the 'interval' attribute in milliseconds"

457

return timedelta_to_milliseconds(self.interval)

458

459

def approval_delay_milliseconds(self):

460

return timedelta_to_milliseconds(self.approval_delay)

461

810

462

@staticmethod

811

463

def config_parser(config):

812

464

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

827

479

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

828

480

"enabled")

829

481

830

# Uppercase and remove spaces from fingerprint for later

831

# comparison purposes with return value from the

832

# fingerprint() function

833

482

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

834

483

.replace(" ", ""))

835

484

if "secret" in section:

836

client["secret"] = codecs.decode(section["secret"]

837

.encode("utf-8"),

838

"base64")

485

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

839

486

elif "secfile" in section:

840

487

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

841

488

(section["secfile"])),

842

489

"rb") as secfile:

843

490

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

844

491

else:

845

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

846

.format(section))

492

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

493

% section)

847

494

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

848

495

client["extended_timeout"] = string_to_delta(

849

496

section["extended_timeout"])

858

505

client["last_checker_status"] = -2

859

506

860

507

return settings

861

862

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

508

509

510

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

511

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

512

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

513

attribute."""

863

514

self.name = name

864

if server_settings is None:

865

server_settings = {}

866

self.server_settings = server_settings

867

515

# adding all client settings

868

for setting, value in settings.items():

516

for setting, value in settings.iteritems():

869

517

setattr(self, setting, value)

870

518

871

519

if self.enabled:

877

525

else:

878

526

self.last_enabled = None

879

527

self.expires = None

880

528

881

529

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

530

# Uppercase and remove spaces from fingerprint for later

531

# comparison purposes with return value from the fingerprint()

532

# function

882

533

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

883

534

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

884

535

datetime.datetime.utcnow())

885

536

886

537

# attributes specific for this server instance

887

538

self.checker = None

888

539

self.checker_initiator_tag = None

891

542

self.current_checker_command = None

892

543

self.approved = None

893

544

self.approvals_pending = 0

894

self.changedstate = multiprocessing_manager.Condition(

895

multiprocessing_manager.Lock())

896

self.client_structure = [attr

897

for attr in self.__dict__.keys()

545

self.changedstate = (multiprocessing_manager

546

.Condition(multiprocessing_manager

547

.Lock()))

548

self.client_structure = [attr for attr in

549

self.__dict__.iterkeys()

898

550

if not attr.startswith("_")]

899

551

self.client_structure.append("client_structure")

900

552

901

for name, t in inspect.getmembers(

902

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

553

for name, t in inspect.getmembers(type(self),

554

lambda obj:

555

isinstance(obj,

556

property)):

903

557

if not name.startswith("_"):

904

558

self.client_structure.append(name)

905

559

913

567

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

914

568

# Already enabled

915

569

return

570

self.send_changedstate()

916

571

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

917

572

self.enabled = True

918

573

self.last_enabled = datetime.datetime.utcnow()

919

574

self.init_checker()

920

self.send_changedstate()

921

575

922

576

def disable(self, quiet=True):

923

577

"""Disable this client."""

924

578

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

925

579

return False

926

580

if not quiet:

581

self.send_changedstate()

582

if not quiet:

927

583

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

928

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

929

GLib.source_remove(self.disable_initiator_tag)

584

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

585

gobject.source_remove(self.disable_initiator_tag)

930

586

self.disable_initiator_tag = None

931

587

self.expires = None

932

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

933

GLib.source_remove(self.checker_initiator_tag)

588

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

589

gobject.source_remove(self.checker_initiator_tag)

934

590

self.checker_initiator_tag = None

935

591

self.stop_checker()

936

592

self.enabled = False

937

if not quiet:

938

self.send_changedstate()

939

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

593

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

940

594

return False

941

595

942

596

def __del__(self):

945

599

def init_checker(self):

946

600

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

947

601

# and every interval from then on.

948

if self.checker_initiator_tag is not None:

949

GLib.source_remove(self.checker_initiator_tag)

950

self.checker_initiator_tag = GLib.timeout_add(

951

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

952

self.start_checker)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

604

self.start_checker))

953

605

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

954

if self.disable_initiator_tag is not None:

955

GLib.source_remove(self.disable_initiator_tag)

956

self.disable_initiator_tag = GLib.timeout_add(

957

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

606

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

self.disable))

958

609

# Also start a new checker *right now*.

959

610

self.start_checker()

960

611

961

def checker_callback(self, source, condition, connection,

962

command):

612

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

963

613

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

964

614

self.checker_callback_tag = None

965

615

self.checker = None

966

# Read return code from connection (see call_pipe)

967

returncode = connection.recv()

968

connection.close()

969

970

if returncode >= 0:

971

self.last_checker_status = returncode

972

self.last_checker_signal = None

616

if os.WIFEXITED(condition):

617

self.last_checker_status = os.WEXITSTATUS(condition)

973

618

if self.last_checker_status == 0:

974

619

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

975

620

vars(self))

976

621

self.checked_ok()

977

622

else:

978

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

623

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

624

vars(self))

979

625

else:

980

626

self.last_checker_status = -1

981

self.last_checker_signal = -returncode

982

627

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

983

628

vars(self))

984

return False

985

629

986

630

def checked_ok(self):

987

631

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

988

632

self.last_checked_ok = datetime.datetime.utcnow()

989

633

self.last_checker_status = 0

990

self.last_checker_signal = None

991

634

self.bump_timeout()

992

635

993

636

def bump_timeout(self, timeout=None):

995

638

if timeout is None:

996

639

timeout = self.timeout

997

640

if self.disable_initiator_tag is not None:

998

GLib.source_remove(self.disable_initiator_tag)

999

self.disable_initiator_tag = None

641

gobject.source_remove(self.disable_initiator_tag)

1000

642

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

1001

self.disable_initiator_tag = GLib.timeout_add(

1002

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

643

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

1003

646

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

1004

647

1005

648

def need_approval(self):

1011

654

If a checker already exists, leave it running and do

1012

655

nothing."""

1013

656

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

1014

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

1015

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

1016

# would inevitably timeout, since no checker would get a

1017

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

657

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

658

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

659

# client would inevitably timeout, since no checker would get

660

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

1018

661

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

1019

662

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

1020

663

# should be.

1021

664

1022

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

1023

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

1024

self.checker.join()

1025

self.checker = None

665

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

666

try:

667

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

668

except (AttributeError, OSError) as error:

669

if (isinstance(error, OSError)

670

and error.errno != errno.ECHILD):

671

raise error

672

else:

673

if pid:

674

logger.warning("Checker was a zombie")

675

gobject.source_remove(self.checker_callback_tag)

676

self.checker_callback(pid, status,

677

self.current_checker_command)

1026

678

# Start a new checker if needed

1027

679

if self.checker is None:

1028

# Escape attributes for the shell

1029

escaped_attrs = {

1030

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

1031

for attr in self.runtime_expansions }

1032

680

try:

1033

command = self.checker_command % escaped_attrs

1034

except TypeError as error:

1035

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

1036

self.checker_command,

1037

exc_info=error)

1038

return True # Try again later

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

' %s', self.checker_command, error)

698

return True # Try again later

1039

699

self.current_checker_command = command

1040

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

1041

self.name)

1042

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

1043

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

1044

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

1045

# always replaced by /dev/null.)

1046

# The exception is when not debugging but nevertheless

1047

# running in the foreground; use the previously

1048

# created wnull.

1049

popen_args = { "close_fds": True,

1050

"shell": True,

1051

"cwd": "/" }

1052

if (not self.server_settings["debug"]

1053

and self.server_settings["foreground"]):

1054

popen_args.update({"stdout": wnull,

1055

"stderr": wnull })

1056

pipe = multiprocessing.Pipe(duplex = False)

1057

self.checker = multiprocessing.Process(

1058

target = call_pipe,

1059

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

1060

kwargs = popen_args)

1061

self.checker.start()

1062

self.checker_callback_tag = GLib.io_add_watch(

1063

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

1064

self.checker_callback, pipe[0], command)

1065

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

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

self.checker = subprocess.Popen(command,

708

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

720

except OSError as error:

721

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

722

error)

723

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

1066

724

return True

1067

725

1068

726

def stop_checker(self):

1069

727

"""Force the checker process, if any, to stop."""

1070

728

if self.checker_callback_tag:

1071

GLib.source_remove(self.checker_callback_tag)

729

gobject.source_remove(self.checker_callback_tag)

1072

730

self.checker_callback_tag = None

1073

731

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

1074

732

return

1075

733

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

1076

self.checker.terminate()

734

try:

735

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

736

#time.sleep(0.5)

737

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

738

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

739

except OSError as error:

740

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

741

raise

1077

742

self.checker = None

1078

743

1079

744

1080

def dbus_service_property(dbus_interface,

1081

signature="v",

1082

access="readwrite",

1083

byte_arrays=False):

745

def dbus_service_property(dbus_interface, signature="v",

746

access="readwrite", byte_arrays=False):

1084

747

"""Decorators for marking methods of a DBusObjectWithProperties to

1085

748

become properties on the D-Bus.

1086

749

1095

758

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

1096

759

if byte_arrays and signature != "ay":

1097

760

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

1098

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

1099

761

" signature %r" % signature)

1100

762

def decorator(func):

1101

763

func._dbus_is_property = True

1102

764

func._dbus_interface = dbus_interface

1107

769

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

1108

770

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1109

771

return func

1110

1111

772

return decorator

1112

773

1113

774

1114

775

def dbus_interface_annotations(dbus_interface):

1115

"""Decorator for marking functions returning interface annotations

776

"""Decorator for marking functions returning interface annotations.

1116

777

1117

778

Usage:

1118

779

1122

783

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

1123

784

"false"}

1124

785

"""

1125

1126

786

def decorator(func):

1127

787

func._dbus_is_interface = True

1128

788

func._dbus_interface = dbus_interface

1129

789

func._dbus_name = dbus_interface

1130

790

return func

1131

1132

791

return decorator

1133

792

1134

793

1136

795

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

1137

796

Usage:

1138

797

1139

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

1140

"org.freedesktop.DBus.Property."

1141

"EmitsChangedSignal": "false"})

1142

798

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

1143

799

access="r")

800

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

801

"org.freedesktop.DBus.Property."

802

"EmitsChangedSignal": "false"})

1144

803

def Property_dbus_property(self):

1145

804

return dbus.Boolean(False)

1146

1147

See also the DBusObjectWithAnnotations class.

1148

805

"""

1149

1150

806

def decorator(func):

1151

807

func._dbus_annotations = annotations

1152

808

return func

1153

1154

809

return decorator

1155

810

1156

811

1157

812

class DBusPropertyException(dbus.exceptions.DBusException):

1158

813

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

1159

814

"""

1160

pass

815

def __unicode__(self):

816

return unicode(str(self))

1161

817

1162

818

1163

819

class DBusPropertyAccessException(DBusPropertyException):

1172

828

pass

1173

829

1174

830

1175

class DBusObjectWithAnnotations(dbus.service.Object):

1176

"""A D-Bus object with annotations.

831

class DBusObjectWithProperties(dbus.service.Object):

832

"""A D-Bus object with properties.

1177

833

1178

Classes inheriting from this can use the dbus_annotations

1179

decorator to add annotations to methods or signals.

834

Classes inheriting from this can use the dbus_service_property

835

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

836

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

1180

837

"""

1181

838

1182

839

@staticmethod

1186

843

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

1187

844

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

1188

845

"""

1189

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

846

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

1190

847

False)

1191

848

1192

849

def _get_all_dbus_things(self, thing):

1193

850

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

1194

851

"""

1195

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

852

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

853

name),

1196

854

athing.__get__(self))

1197

855

for cls in self.__class__.__mro__

1198

856

for name, athing in

1199

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

1200

1201

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1202

out_signature = "s",

1203

path_keyword = 'object_path',

1204

connection_keyword = 'connection')

1205

def Introspect(self, object_path, connection):

1206

"""Overloading of standard D-Bus method.

1207

1208

Inserts annotation tags on methods and signals.

1209

"""

1210

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

1211

connection)

1212

try:

1213

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

1214

1215

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

1216

# Add annotation tags

1217

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

1218

for tag in if_tag.getElementsByTagName(typ):

1219

annots = dict()

1220

for name, prop in (self.

1221

_get_all_dbus_things(typ)):

1222

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

1223

and prop._dbus_interface

1224

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

1225

annots.update(getattr(

1226

prop, "_dbus_annotations", {}))

1227

for name, value in annots.items():

1228

ann_tag = document.createElement(

1229

"annotation")

1230

ann_tag.setAttribute("name", name)

1231

ann_tag.setAttribute("value", value)

1232

tag.appendChild(ann_tag)

1233

# Add interface annotation tags

1234

for annotation, value in dict(

1235

itertools.chain.from_iterable(

1236

annotations().items()

1237

for name, annotations

1238

in self._get_all_dbus_things("interface")

1239

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

1240

)).items():

1241

ann_tag = document.createElement("annotation")

1242

ann_tag.setAttribute("name", annotation)

1243

ann_tag.setAttribute("value", value)

1244

if_tag.appendChild(ann_tag)

1245

# Fix argument name for the Introspect method itself

1246

if (if_tag.getAttribute("name")

1247

== dbus.INTROSPECTABLE_IFACE):

1248

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

1249

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

1250

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

1251

if (arg.getAttribute("direction")

1252

== "out"):

1253

arg.setAttribute("name",

1254

"xml_data")

1255

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

1256

document.unlink()

1257

except (AttributeError, xml.dom.DOMException,

1258

xml.parsers.expat.ExpatError) as error:

1259

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

1260

exc_info=error)

1261

return xmlstring

1262

1263

1264

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1265

"""A D-Bus object with properties.

1266

1267

Classes inheriting from this can use the dbus_service_property

1268

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

1269

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

1270

"""

857

inspect.getmembers(cls,

858

self._is_dbus_thing(thing)))

1271

859

1272

860

def _get_dbus_property(self, interface_name, property_name):

1273

861

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

1274

862

property with the specified name and interface.

1275

863

"""

1276

for cls in self.__class__.__mro__:

1277

for name, value in inspect.getmembers(

1278

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

864

for cls in self.__class__.__mro__:

865

for name, value in (inspect.getmembers

866

(cls,

867

self._is_dbus_thing("property"))):

1279

868

if (value._dbus_name == property_name

1280

869

and value._dbus_interface == interface_name):

1281

870

return value.__get__(self)

1282

871

1283

872

# No such property

1284

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

1285

self.dbus_object_path, interface_name, property_name))

1286

1287

@classmethod

1288

def _get_all_interface_names(cls):

1289

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

1290

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

1291

"_dbus_interface", None)

1292

for x in (inspect.getmro(cls))

1293

for attr in dir(x))

1294

if name is not None)

1295

1296

@dbus.service.method(dbus.PROPERTIES_IFACE,

1297

in_signature="ss",

873

raise DBusPropertyNotFound(self.dbus_object_path + ":"

874

+ interface_name + "."

875

+ property_name)

876

877

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

1298

878

out_signature="v")

1299

879

def Get(self, interface_name, property_name):

1300

880

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

1318

898

# The byte_arrays option is not supported yet on

1319

899

# signatures other than "ay".

1320

900

if prop._dbus_signature != "ay":

1321

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

1322

"'ay' signature {!r}"

1323

.format(prop._dbus_signature))

901

raise ValueError

1324

902

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

1325

903

for byte in value))

1326

904

prop(value)

1327

905

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

in_signature="s",

906

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

1330

907

out_signature="a{sv}")

1331

908

def GetAll(self, interface_name):

1332

909

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

1347

924

if not hasattr(value, "variant_level"):

1348

925

properties[name] = value

1349

926

continue

1350

properties[name] = type(value)(

1351

value, variant_level = value.variant_level + 1)

927

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

928

value.variant_level+1)

1352

929

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

1353

930

1354

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

1355

def PropertiesChanged(self, interface_name, changed_properties,

1356

invalidated_properties):

1357

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

1358

standard.

1359

"""

1360

pass

1361

1362

931

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

932

out_signature="s",

1364

933

path_keyword='object_path',

1368

937

1369

938

Inserts property tags and interface annotation tags.

1370

939

"""

1371

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1372

object_path,

1373

connection)

940

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

941

connection)

1374

942

try:

1375

943

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

1376

1377

944

def make_tag(document, name, prop):

1378

945

e = document.createElement("property")

1379

946

e.setAttribute("name", name)

1380

947

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

1381

948

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

1382

949

return e

1383

1384

950

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

1385

951

# Add property tags

1386

952

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

1389

955

if prop._dbus_interface

1390

956

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

1391

957

if_tag.appendChild(tag)

1392

# Add annotation tags for properties

1393

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

1394

annots = dict()

1395

for name, prop in self._get_all_dbus_things(

1396

"property"):

1397

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

1398

and prop._dbus_interface

1399

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

1400

annots.update(getattr(

1401

prop, "_dbus_annotations", {}))

1402

for name, value in annots.items():

1403

ann_tag = document.createElement(

1404

"annotation")

1405

ann_tag.setAttribute("name", name)

1406

ann_tag.setAttribute("value", value)

1407

tag.appendChild(ann_tag)

958

# Add annotation tags

959

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

960

for tag in if_tag.getElementsByTagName(typ):

961

annots = dict()

962

for name, prop in (self.

963

_get_all_dbus_things(typ)):

964

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

965

and prop._dbus_interface

966

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

967

annots.update(getattr

968

(prop,

969

"_dbus_annotations",

970

{}))

971

for name, value in annots.iteritems():

972

ann_tag = document.createElement(

973

"annotation")

974

ann_tag.setAttribute("name", name)

975

ann_tag.setAttribute("value", value)

976

tag.appendChild(ann_tag)

977

# Add interface annotation tags

978

for annotation, value in dict(

979

itertools.chain(

980

*(annotations().iteritems()

981

for name, annotations in

982

self._get_all_dbus_things("interface")

983

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

984

))).iteritems():

985

ann_tag = document.createElement("annotation")

986

ann_tag.setAttribute("name", annotation)

987

ann_tag.setAttribute("value", value)

988

if_tag.appendChild(ann_tag)

1408

989

# Add the names to the return values for the

1409

990

# "org.freedesktop.DBus.Properties" methods

1410

991

if (if_tag.getAttribute("name")

1425

1006

except (AttributeError, xml.dom.DOMException,

1426

1007

xml.parsers.expat.ExpatError) as error:

1427

1008

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

1428

exc_info=error)

1429

return xmlstring

1430

1431

try:

1432

dbus.OBJECT_MANAGER_IFACE

1433

except AttributeError:

1434

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

1435

1436

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1437

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

1438

1439

Classes inheriting from this exposes the standard

1440

GetManagedObjects call and the InterfacesAdded and

1441

InterfacesRemoved signals on the standard

1442

"org.freedesktop.DBus.ObjectManager" interface.

1443

1444

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

1445

manually.

1446

"""

1447

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1448

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

1449

def GetManagedObjects(self):

1450

"""This function must be overridden"""

1451

raise NotImplementedError()

1452

1453

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1454

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

1455

def InterfacesAdded(self, object_path, interfaces_and_properties):

1456

pass

1457

1458

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

1459

def InterfacesRemoved(self, object_path, interfaces):

1460

pass

1461

1462

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1463

out_signature = "s",

1464

path_keyword = 'object_path',

1465

connection_keyword = 'connection')

1466

def Introspect(self, object_path, connection):

1467

"""Overloading of standard D-Bus method.

1468

1469

Override return argument name of GetManagedObjects to be

1470

"objpath_interfaces_and_properties"

1471

"""

1472

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1473

object_path,

1474

connection)

1475

try:

1476

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

1477

1478

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

1479

# Fix argument name for the GetManagedObjects method

1480

if (if_tag.getAttribute("name")

1481

== dbus.OBJECT_MANAGER_IFACE):

1482

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

1483

if (cn.getAttribute("name")

1484

== "GetManagedObjects"):

1485

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

1486

if (arg.getAttribute("direction")

1487

== "out"):

1488

arg.setAttribute(

1489

"name",

1490

"objpath_interfaces"

1491

"_and_properties")

1492

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

1493

document.unlink()

1494

except (AttributeError, xml.dom.DOMException,

1495

xml.parsers.expat.ExpatError) as error:

1496

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

1497

exc_info = error)

1498

return xmlstring

1499

1500

def datetime_to_dbus(dt, variant_level=0):

1009

error)

1010

return xmlstring

1011

1012

1013

def datetime_to_dbus (dt, variant_level=0):

1501

1014

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

1502

1015

if dt is None:

1503

1016

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

1504

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

1505

1506

1507

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1508

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

1509

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

1510

interface names according to the "alt_interface_names" mapping.

1511

Usage:

1512

1513

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

1514

"net.example.AlternateInterface"})

1515

class SampleDBusObject(dbus.service.Object):

1516

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

1517

def SampleDBusMethod():

1518

pass

1519

1520

The above "SampleDBusMethod" on "SampleDBusObject" will be

1521

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

1522

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

1523

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

1524

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

1525

1526

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

1527

(from DBusObjectWithProperties) and interfaces (from the

1528

dbus_interface_annotations decorator).

1017

return dbus.String(dt.isoformat(),

1018

variant_level=variant_level)

1019

1020

1021

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1022

.__metaclass__):

1023

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

1024

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

1529

1025

"""

1530

1531

def wrapper(cls):

1532

for orig_interface_name, alt_interface_name in (

1533

alt_interface_names.items()):

1534

attr = {}

1535

interface_names = set()

1536

# Go though all attributes of the class

1537

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

1026

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

1027

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

1028

# methods, signals, or properties in them

1029

old_interface_names = []

1030

for base in (b for b in bases

1031

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

1032

# Go though all attributes of the base class

1033

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

1538

1034

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

1539

1035

# with the wrong interface name

1540

1036

if (not hasattr(attribute, "_dbus_interface")

1541

or not attribute._dbus_interface.startswith(

1542

orig_interface_name)):

1037

or not attribute._dbus_interface

1038

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

1543

1039

continue

1544

1040

# Create an alternate D-Bus interface name based on

1545

1041

# the current name

1546

alt_interface = attribute._dbus_interface.replace(

1547

orig_interface_name, alt_interface_name)

1548

interface_names.add(alt_interface)

1042

alt_interface = (attribute._dbus_interface

1043

.replace("se.recompile.Mandos",

1044

"se.bsnet.fukt.Mandos"))

1045

if alt_interface != attribute._dbus_interface:

1046

old_interface_names.append(alt_interface)

1549

1047

# Is this a D-Bus signal?

1550

1048

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

1551

# Extract the original non-method undecorated

1552

# function by black magic

1553

if sys.version_info.major == 2:

1554

nonmethod_func = (dict(

1049

# Extract the original non-method function by

1050

# black magic

1051

nonmethod_func = (dict(

1555

1052

zip(attribute.func_code.co_freevars,

1556

attribute.__closure__))

1557

["func"].cell_contents)

1558

else:

1559

nonmethod_func = (dict(

1560

zip(attribute.__code__.co_freevars,

1561

attribute.__closure__))

1562

["func"].cell_contents)

1053

attribute.__closure__))["func"]

1054

.cell_contents)

1563

1055

# Create a new, but exactly alike, function

1564

1056

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

1565

1057

# with the alternate D-Bus interface name

1566

new_function = copy_function(nonmethod_func)

1567

new_function = (dbus.service.signal(

1568

alt_interface,

1569

attribute._dbus_signature)(new_function))

1058

new_function = (dbus.service.signal

1059

(alt_interface,

1060

attribute._dbus_signature)

1061

(types.FunctionType(

1062

nonmethod_func.func_code,

1063

nonmethod_func.func_globals,

1064

nonmethod_func.func_name,

1065

nonmethod_func.func_defaults,

1066

nonmethod_func.func_closure)))

1570

1067

# Copy annotations, if any

1571

1068

try:

1572

new_function._dbus_annotations = dict(

1573

attribute._dbus_annotations)

1069

new_function._dbus_annotations = (

1070

dict(attribute._dbus_annotations))

1574

1071

except AttributeError:

1575

1072

pass

1576

1073

# Define a creator of a function to call both the

1577

# original and alternate functions, so both the

1578

# original and alternate signals gets sent when

1579

# the function is called

1074

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

1075

# signals gets sent when the function is called

1580

1076

def fixscope(func1, func2):

1581

1077

"""This function is a scope container to pass

1582

1078

func1 and func2 to the "call_both" function

1583

1079

outside of its arguments"""

1584

1585

@functools.wraps(func2)

1586

1080

def call_both(*args, **kwargs):

1587

1081

"""This function will emit two D-Bus

1588

1082

signals by calling func1 and func2"""

1589

1083

func1(*args, **kwargs)

1590

1084

func2(*args, **kwargs)

1591

# Make wrapper function look like a D-Bus signal

1592

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

1593

if name.startswith("_dbus_"):

1594

setattr(call_both, name, attr)

1595

1596

1085

return call_both

1597

1086

# Create the "call_both" function and add it to

1598

1087

# the class

1599

attr[attrname] = fixscope(attribute, new_function)

1088

attr[attrname] = fixscope(attribute,

1089

new_function)

1600

1090

# Is this a D-Bus method?

1601

1091

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

1602

1092

# Create a new, but exactly alike, function

1603

1093

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

1604

1094

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

1605

1095

# to the class.

1606

attr[attrname] = (

1607

dbus.service.method(

1608

alt_interface,

1609

attribute._dbus_in_signature,

1610

attribute._dbus_out_signature)

1611

(copy_function(attribute)))

1096

attr[attrname] = (dbus.service.method

1097

(alt_interface,

1098

attribute._dbus_in_signature,

1099

attribute._dbus_out_signature)

1100

(types.FunctionType

1101

(attribute.func_code,

1102

attribute.func_globals,

1103

attribute.func_name,

1104

attribute.func_defaults,

1105

attribute.func_closure)))

1612

1106

# Copy annotations, if any

1613

1107

try:

1614

attr[attrname]._dbus_annotations = dict(

1615

attribute._dbus_annotations)

1108

attr[attrname]._dbus_annotations = (

1109

dict(attribute._dbus_annotations))

1616

1110

except AttributeError:

1617

1111

pass

1618

1112

# Is this a D-Bus property?

1621

1115

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

1622

1116

# property with the alternate D-Bus interface

1623

1117

# name. Add it to the class.

1624

attr[attrname] = (dbus_service_property(

1625

alt_interface, attribute._dbus_signature,

1626

attribute._dbus_access,

1627

attribute._dbus_get_args_options

1628

["byte_arrays"])

1629

(copy_function(attribute)))

1118

attr[attrname] = (dbus_service_property

1119

(alt_interface,

1120

attribute._dbus_signature,

1121

attribute._dbus_access,

1122

attribute

1123

._dbus_get_args_options

1124

["byte_arrays"])

1125

(types.FunctionType

1126

(attribute.func_code,

1127

attribute.func_globals,

1128

attribute.func_name,

1129

attribute.func_defaults,

1130

attribute.func_closure)))

1630

1131

# Copy annotations, if any

1631

1132

try:

1632

attr[attrname]._dbus_annotations = dict(

1633

attribute._dbus_annotations)

1133

attr[attrname]._dbus_annotations = (

1134

dict(attribute._dbus_annotations))

1634

1135

except AttributeError:

1635

1136

pass

1636

1137

# Is this a D-Bus interface?

1639

1140

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

1640

1141

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

1641

1142

# to the class.

1642

attr[attrname] = (

1643

dbus_interface_annotations(alt_interface)

1644

(copy_function(attribute)))

1645

if deprecate:

1646

# Deprecate all alternate interfaces

1647

iname="_AlternateDBusNames_interface_annotation{}"

1648

for interface_name in interface_names:

1649

1650

@dbus_interface_annotations(interface_name)

1651

def func(self):

1652

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

1653

"true" }

1654

# Find an unused name

1655

for aname in (iname.format(i)

1656

for i in itertools.count()):

1657

if aname not in attr:

1658

attr[aname] = func

1659

break

1660

if interface_names:

1661

# Replace the class with a new subclass of it with

1662

# methods, signals, etc. as created above.

1663

if sys.version_info.major == 2:

1664

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

1665

(cls, ), attr)

1666

else:

1667

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

1668

(cls, ), attr)

1669

return cls

1670

1671

return wrapper

1672

1673

1674

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

1675

"se.bsnet.fukt.Mandos"})

1143

attr[attrname] = (dbus_interface_annotations

1144

(alt_interface)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1151

# Deprecate all old interfaces

1152

basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1153

for old_interface_name in old_interface_names:

1154

@dbus_interface_annotations(old_interface_name)

1155

def func(self):

1156

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

1157

# Find an unused name

1158

for aname in (basename.format(i) for i in

1159

itertools.count()):

1160

if aname not in attr:

1161

attr[aname] = func

1162

break

1163

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

1164

1165

1676

1166

class ClientDBus(Client, DBusObjectWithProperties):

1677

1167

"""A Client class using D-Bus

1678

1168

1682

1172

"""

1683

1173

1684

1174

runtime_expansions = (Client.runtime_expansions

1685

+ ("dbus_object_path", ))

1686

1687

_interface = "se.recompile.Mandos.Client"

1175

+ ("dbus_object_path",))

1688

1176

1689

1177

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

1690

1178

1693

1181

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

1694

1182

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

1695

1183

# the D-Bus

1696

client_object_name = str(self.name).translate(

1184

client_object_name = unicode(self.name).translate(

1697

1185

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

1698

1186

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

1699

self.dbus_object_path = dbus.ObjectPath(

1700

"/clients/" + client_object_name)

1187

self.dbus_object_path = (dbus.ObjectPath

1188

("/clients/" + client_object_name))

1701

1189

DBusObjectWithProperties.__init__(self, self.bus,

1702

1190

self.dbus_object_path)

1703

1704

def notifychangeproperty(transform_func, dbus_name,

1705

type_func=lambda x: x,

1706

variant_level=1,

1707

invalidate_only=False,

1708

_interface=_interface):

1191

1192

def notifychangeproperty(transform_func,

1193

dbus_name, type_func=lambda x: x,

1194

variant_level=1):

1709

1195

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

1710

1196

its changes to DBus.

1711

1197

1716

1202

to the D-Bus. Default: no transform

1717

1203

variant_level: D-Bus variant level. Default: 1

1718

1204

"""

1719

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

1720

1205

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

1721

1206

def setter(self, value):

1722

1207

if hasattr(self, "dbus_object_path"):

1723

1208

if (not hasattr(self, attrname) or

1724

1209

type_func(getattr(self, attrname, None))

1725

1210

!= type_func(value)):

1726

if invalidate_only:

1727

self.PropertiesChanged(

1728

_interface, dbus.Dictionary(),

1729

dbus.Array((dbus_name, )))

1730

else:

1731

dbus_value = transform_func(

1732

type_func(value),

1733

variant_level = variant_level)

1734

self.PropertyChanged(dbus.String(dbus_name),

1735

dbus_value)

1736

self.PropertiesChanged(

1737

_interface,

1738

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

1739

dbus_value }),

1740

dbus.Array())

1211

dbus_value = transform_func(type_func(value),

1212

variant_level

1213

=variant_level)

1214

self.PropertyChanged(dbus.String(dbus_name),

1215

dbus_value)

1741

1216

setattr(self, attrname, value)

1742

1217

1743

1218

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

1744

1219

1220

1745

1221

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1746

1222

approvals_pending = notifychangeproperty(dbus.Boolean,

1747

1223

"ApprovalPending",

1749

1225

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

1750

1226

last_enabled = notifychangeproperty(datetime_to_dbus,

1751

1227

"LastEnabled")

1752

checker = notifychangeproperty(

1753

dbus.Boolean, "CheckerRunning",

1754

type_func = lambda checker: checker is not None)

1228

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

1229

type_func = lambda checker:

1230

checker is not None)

1755

1231

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1756

1232

"LastCheckedOK")

1757

1233

last_checker_status = notifychangeproperty(dbus.Int16,

1760

1236

datetime_to_dbus, "LastApprovalRequest")

1761

1237

approved_by_default = notifychangeproperty(dbus.Boolean,

1762

1238

"ApprovedByDefault")

1763

approval_delay = notifychangeproperty(

1764

dbus.UInt64, "ApprovalDelay",

1765

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

1239

approval_delay = notifychangeproperty(dbus.UInt64,

1240

"ApprovalDelay",

1241

type_func =

1242

timedelta_to_milliseconds)

1766

1243

approval_duration = notifychangeproperty(

1767

1244

dbus.UInt64, "ApprovalDuration",

1768

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

1245

type_func = timedelta_to_milliseconds)

1769

1246

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

1770

timeout = notifychangeproperty(

1771

dbus.UInt64, "Timeout",

1772

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

1247

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

1248

type_func =

1249

timedelta_to_milliseconds)

1773

1250

extended_timeout = notifychangeproperty(

1774

1251

dbus.UInt64, "ExtendedTimeout",

1775

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

1776

interval = notifychangeproperty(

1777

dbus.UInt64, "Interval",

1778

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

1252

type_func = timedelta_to_milliseconds)

1253

interval = notifychangeproperty(dbus.UInt64,

1254

"Interval",

1255

type_func =

1256

timedelta_to_milliseconds)

1779

1257

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

1780

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

1781

invalidate_only=True)

1782

1258

1783

1259

del notifychangeproperty

1784

1260

1791

1267

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

1792

1268

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

1793

1269

1794

def checker_callback(self, source, condition,

1795

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

1796

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

1797

connection, command, *args,

1798

**kwargs)

1799

exitstatus = self.last_checker_status

1800

if exitstatus >= 0:

1270

def checker_callback(self, pid, condition, command,

1271

*args, **kwargs):

1272

self.checker_callback_tag = None

1273

self.checker = None

1274

if os.WIFEXITED(condition):

1275

exitstatus = os.WEXITSTATUS(condition)

1801

1276

# Emit D-Bus signal

1802

1277

self.CheckerCompleted(dbus.Int16(exitstatus),

1803

# This is specific to GNU libC

1804

dbus.Int64(exitstatus << 8),

1278

dbus.Int64(condition),

1805

1279

dbus.String(command))

1806

1280

else:

1807

1281

# Emit D-Bus signal

1808

1282

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

1809

dbus.Int64(

1810

# This is specific to GNU libC

1811

(exitstatus << 8)

1812

| self.last_checker_signal),

1283

dbus.Int64(condition),

1813

1284

dbus.String(command))

1814

return ret

1285

1286

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

1287

*args, **kwargs)

1815

1288

1816

1289

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

1817

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

1290

old_checker = self.checker

1291

if self.checker is not None:

1292

old_checker_pid = self.checker.pid

1293

else:

1294

old_checker_pid = None

1818

1295

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

1819

1296

# Only if new checker process was started

1820

1297

if (self.checker is not None

1828

1305

return False

1829

1306

1830

1307

def approve(self, value=True):

1308

self.send_changedstate()

1831

1309

self.approved = value

1832

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

1833

* 1000), self._reset_approved)

1834

self.send_changedstate()

1310

gobject.timeout_add(timedelta_to_milliseconds

1311

(self.approval_duration),

1312

self._reset_approved)

1313

1835

1314

1836

1315

## D-Bus methods, signals & properties

1316

_interface = "se.recompile.Mandos.Client"

1837

1317

1838

1318

## Interfaces

1839

1319

1320

@dbus_interface_annotations(_interface)

1321

def _foo(self):

1322

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

1323

"false"}

1324

1840

1325

## Signals

1841

1326

1842

1327

# CheckerCompleted - signal

1852

1337

pass

1853

1338

1854

1339

# PropertyChanged - signal

1855

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

1856

1340

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

1857

1341

def PropertyChanged(self, property, value):

1858

1342

"D-Bus signal"

1892

1376

self.checked_ok()

1893

1377

1894

1378

# Enable - method

1895

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

1896

1379

@dbus.service.method(_interface)

1897

1380

def Enable(self):

1898

1381

"D-Bus method"

1899

1382

self.enable()

1900

1383

1901

1384

# StartChecker - method

1902

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

1903

1385

@dbus.service.method(_interface)

1904

1386

def StartChecker(self):

1905

1387

"D-Bus method"

1906

1388

self.start_checker()

1907

1389

1908

1390

# Disable - method

1909

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

1910

1391

@dbus.service.method(_interface)

1911

1392

def Disable(self):

1912

1393

"D-Bus method"

1913

1394

self.disable()

1914

1395

1915

1396

# StopChecker - method

1916

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

1917

1397

@dbus.service.method(_interface)

1918

1398

def StopChecker(self):

1919

1399

self.stop_checker()

1926

1406

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

1927

1407

1928

1408

# ApprovedByDefault - property

1929

@dbus_service_property(_interface,

1930

signature="b",

1409

@dbus_service_property(_interface, signature="b",

1931

1410

access="readwrite")

1932

1411

def ApprovedByDefault_dbus_property(self, value=None):

1933

1412

if value is None: # get

1935

1414

self.approved_by_default = bool(value)

1936

1415

1937

1416

# ApprovalDelay - property

1938

@dbus_service_property(_interface,

1939

signature="t",

1417

@dbus_service_property(_interface, signature="t",

1940

1418

access="readwrite")

1941

1419

def ApprovalDelay_dbus_property(self, value=None):

1942

1420

if value is None: # get

1943

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

1944

* 1000)

1421

return dbus.UInt64(self.approval_delay_milliseconds())

1945

1422

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

1946

1423

1947

1424

# ApprovalDuration - property

1948

@dbus_service_property(_interface,

1949

signature="t",

1425

@dbus_service_property(_interface, signature="t",

1950

1426

access="readwrite")

1951

1427

def ApprovalDuration_dbus_property(self, value=None):

1952

1428

if value is None: # get

1953

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

1954

* 1000)

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

1955

1431

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

1956

1432

1957

1433

# Name - property

1958

@dbus_annotations(

1959

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

1960

1434

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

1961

1435

def Name_dbus_property(self):

1962

1436

return dbus.String(self.name)

1963

1437

1964

1438

# Fingerprint - property

1965

@dbus_annotations(

1966

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

1967

1439

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

1968

1440

def Fingerprint_dbus_property(self):

1969

1441

return dbus.String(self.fingerprint)

1970

1442

1971

1443

# Host - property

1972

@dbus_service_property(_interface,

1973

signature="s",

1444

@dbus_service_property(_interface, signature="s",

1974

1445

access="readwrite")

1975

1446

def Host_dbus_property(self, value=None):

1976

1447

if value is None: # get

1977

1448

return dbus.String(self.host)

1978

self.host = str(value)

1449

self.host = unicode(value)

1979

1450

1980

1451

# Created - property

1981

@dbus_annotations(

1982

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

1983

1452

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

1984

1453

def Created_dbus_property(self):

1985

1454

return datetime_to_dbus(self.created)

1990

1459

return datetime_to_dbus(self.last_enabled)

1991

1460

1992

1461

# Enabled - property

1993

@dbus_service_property(_interface,

1994

signature="b",

1462

@dbus_service_property(_interface, signature="b",

1995

1463

access="readwrite")

1996

1464

def Enabled_dbus_property(self, value=None):

1997

1465

if value is None: # get

2002

1470

self.disable()

2003

1471

2004

1472

# LastCheckedOK - property

2005

@dbus_service_property(_interface,

2006

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2007

1474

access="readwrite")

2008

1475

def LastCheckedOK_dbus_property(self, value=None):

2009

1476

if value is not None:

2012

1479

return datetime_to_dbus(self.last_checked_ok)

2013

1480

2014

1481

# LastCheckerStatus - property

2015

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

1482

@dbus_service_property(_interface, signature="n",

1483

access="read")

2016

1484

def LastCheckerStatus_dbus_property(self):

2017

1485

return dbus.Int16(self.last_checker_status)

2018

1486

2027

1495

return datetime_to_dbus(self.last_approval_request)

2028

1496

2029

1497

# Timeout - property

2030

@dbus_service_property(_interface,

2031

signature="t",

1498

@dbus_service_property(_interface, signature="t",

2032

1499

access="readwrite")

2033

1500

def Timeout_dbus_property(self, value=None):

2034

1501

if value is None: # get

2035

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

2036

old_timeout = self.timeout

1502

return dbus.UInt64(self.timeout_milliseconds())

2037

1503

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

2038

# Reschedule disabling

1504

# Reschedule timeout

2039

1505

if self.enabled:

2040

1506

now = datetime.datetime.utcnow()

2041

self.expires += self.timeout - old_timeout

2042

if self.expires <= now:

1507

time_to_die = timedelta_to_milliseconds(

1508

(self.last_checked_ok + self.timeout) - now)

1509

if time_to_die <= 0:

2043

1510

# The timeout has passed

2044

1511

self.disable()

2045

1512

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

2046

1516

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

2047

1517

is None):

2048

1518

return

2049

GLib.source_remove(self.disable_initiator_tag)

2050

self.disable_initiator_tag = GLib.timeout_add(

2051

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

2052

self.disable)

1519

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

2053

1523

2054

1524

# ExtendedTimeout - property

2055

@dbus_service_property(_interface,

2056

signature="t",

1525

@dbus_service_property(_interface, signature="t",

2057

1526

access="readwrite")

2058

1527

def ExtendedTimeout_dbus_property(self, value=None):

2059

1528

if value is None: # get

2060

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

2061

* 1000)

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

2062

1530

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

2063

1531

2064

1532

# Interval - property

2065

@dbus_service_property(_interface,

2066

signature="t",

1533

@dbus_service_property(_interface, signature="t",

2067

1534

access="readwrite")

2068

1535

def Interval_dbus_property(self, value=None):

2069

1536

if value is None: # get

2070

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

1537

return dbus.UInt64(self.interval_milliseconds())

2071

1538

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

2072

1539

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

2073

1540

return

2074

1541

if self.enabled:

2075

1542

# Reschedule checker run

2076

GLib.source_remove(self.checker_initiator_tag)

2077

self.checker_initiator_tag = GLib.timeout_add(

2078

value, self.start_checker)

2079

self.start_checker() # Start one now, too

1543

gobject.source_remove(self.checker_initiator_tag)

1544

self.checker_initiator_tag = (gobject.timeout_add

1545

(value, self.start_checker))

1546

self.start_checker() # Start one now, too

2080

1547

2081

1548

# Checker - property

2082

@dbus_service_property(_interface,

2083

signature="s",

1549

@dbus_service_property(_interface, signature="s",

2084

1550

access="readwrite")

2085

1551

def Checker_dbus_property(self, value=None):

2086

1552

if value is None: # get

2087

1553

return dbus.String(self.checker_command)

2088

self.checker_command = str(value)

1554

self.checker_command = unicode(value)

2089

1555

2090

1556

# CheckerRunning - property

2091

@dbus_service_property(_interface,

2092

signature="b",

1557

@dbus_service_property(_interface, signature="b",

2093

1558

access="readwrite")

2094

1559

def CheckerRunning_dbus_property(self, value=None):

2095

1560

if value is None: # get

2100

1565

self.stop_checker()

2101

1566

2102

1567

# ObjectPath - property

2103

@dbus_annotations(

2104

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

2105

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

2106

1568

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

2107

1569

def ObjectPath_dbus_property(self):

2108

1570

return self.dbus_object_path # is already a dbus.ObjectPath

2109

1571

2110

1572

# Secret = property

2111

@dbus_annotations(

2112

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

2113

"invalidates"})

2114

@dbus_service_property(_interface,

2115

signature="ay",

2116

access="write",

2117

byte_arrays=True)

1573

@dbus_service_property(_interface, signature="ay",

1574

access="write", byte_arrays=True)

2118

1575

def Secret_dbus_property(self, value):

2119

self.secret = bytes(value)

1576

self.secret = str(value)

2120

1577

2121

1578

del _interface

2122

1579

2126

1583

self._pipe = child_pipe

2127

1584

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

2128

1585

if not self._pipe.recv():

2129

raise KeyError(fpr)

1586

raise KeyError()

2130

1587

2131

1588

def __getattribute__(self, name):

2132

1589

if name == '_pipe':

2136

1593

if data[0] == 'data':

2137

1594

return data[1]

2138

1595

if data[0] == 'function':

2139

2140

1596

def func(*args, **kwargs):

2141

1597

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

2142

1598

return self._pipe.recv()[1]

2143

2144

1599

return func

2145

1600

2146

1601

def __setattr__(self, name, value):

2149

1604

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

2150

1605

2151

1606

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

2152

1611

class ClientHandler(socketserver.BaseRequestHandler, object):

2153

1612

"""A class to handle client connections.

2154

1613

2158

1617

def handle(self):

2159

1618

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

2160

1619

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

2161

str(self.client_address))

1620

unicode(self.client_address))

2162

1621

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

2163

1622

self.server.child_pipe.fileno())

2164

1623

2165

session = gnutls.ClientSession(self.request)

1624

session = (gnutls.connection

1625

.ClientSession(self.request,

1626

gnutls.connection

1627

.X509Credentials()))

1628

1629

# Note: gnutls.connection.X509Credentials is really a

1630

# generic GnuTLS certificate credentials object so long as

1631

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

1632

# here despite using OpenPGP certificates.

2166

1633

2167

1634

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

2168

1635

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

2172

1639

priority = self.server.gnutls_priority

2173

1640

if priority is None:

2174

1641

priority = "NORMAL"

2175

gnutls.priority_set_direct(session._c_object, priority,

2176

None)

1642

(gnutls.library.functions

1643

.gnutls_priority_set_direct(session._c_object,

1644

priority, None))

2177

1645

2178

1646

# Start communication using the Mandos protocol

2179

1647

# Get protocol number

2181

1649

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

2182

1650

try:

2183

1651

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

2184

raise RuntimeError(line)

1652

raise RuntimeError

2185

1653

except (ValueError, IndexError, RuntimeError) as error:

2186

1654

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

2187

1655

return

2189

1657

# Start GnuTLS connection

2190

1658

try:

2191

1659

session.handshake()

2192

except gnutls.Error as error:

1660

except gnutls.errors.GNUTLSError as error:

2193

1661

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

2194

1662

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

2195

1663

# established. Just abandon the request.

2199

1667

approval_required = False

2200

1668

try:

2201

1669

try:

2202

fpr = self.fingerprint(

2203

self.peer_certificate(session))

2204

except (TypeError, gnutls.Error) as error:

1670

fpr = self.fingerprint(self.peer_certificate

1671

(session))

1672

except (TypeError,

1673

gnutls.errors.GNUTLSError) as error:

2205

1674

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

2206

1675

return

2207

1676

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

2220

1689

while True:

2221

1690

if not client.enabled:

2222

1691

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

2223

client.name)

1692

client.name)

2224

1693

if self.server.use_dbus:

2225

1694

# Emit D-Bus signal

2226

1695

client.Rejected("Disabled")

2235

1704

if self.server.use_dbus:

2236

1705

# Emit D-Bus signal

2237

1706

client.NeedApproval(

2238

client.approval_delay.total_seconds()

2239

* 1000, client.approved_by_default)

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

2240

1709

else:

2241

1710

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

2242

1711

client.name)

2248

1717

#wait until timeout or approved

2249

1718

time = datetime.datetime.now()

2250

1719

client.changedstate.acquire()

2251

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

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

2252

1723

client.changedstate.release()

2253

1724

time2 = datetime.datetime.now()

2254

1725

if (time2 - time) >= delay:

2265

1736

else:

2266

1737

delay -= time2 - time

2267

1738

2268

try:

2269

session.send(client.secret)

2270

except gnutls.Error as error:

2271

logger.warning("gnutls send failed",

2272

exc_info = error)

2273

return

1739

sent_size = 0

1740

while sent_size < len(client.secret):

1741

try:

1742

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

1743

except gnutls.errors.GNUTLSError as error:

1744

logger.warning("gnutls send failed")

1745

return

1746

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

1747

sent, len(client.secret)

1748

- (sent_size + sent))

1749

sent_size += sent

2274

1750

2275

1751

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

2276

1752

# bump the timeout using extended_timeout

2284

1760

client.approvals_pending -= 1

2285

1761

try:

2286

1762

session.bye()

2287

except gnutls.Error as error:

2288

logger.warning("GnuTLS bye failed",

2289

exc_info=error)

1763

except gnutls.errors.GNUTLSError as error:

1764

logger.warning("GnuTLS bye failed")

2290

1765

2291

1766

@staticmethod

2292

1767

def peer_certificate(session):

2293

1768

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

2294

1769

# If not an OpenPGP certificate...

2295

if (gnutls.certificate_type_get(session._c_object)

2296

!= gnutls.CRT_OPENPGP):

2297

# ...return invalid data

2298

return b""

1770

if (gnutls.library.functions

1771

.gnutls_certificate_type_get(session._c_object)

1772

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1773

# ...do the normal thing

1774

return session.peer_certificate

2299

1775

list_size = ctypes.c_uint(1)

2300

cert_list = (gnutls.certificate_get_peers

1776

cert_list = (gnutls.library.functions

1777

.gnutls_certificate_get_peers

2301

1778

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

2302

1779

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

2303

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

1780

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

1781

" certificate")

2304

1782

if list_size.value == 0:

2305

1783

return None

2306

1784

cert = cert_list[0]

2310

1788

def fingerprint(openpgp):

2311

1789

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2312

1790

# New GnuTLS "datum" with the OpenPGP public key

2313

datum = gnutls.datum_t(

2314

ctypes.cast(ctypes.c_char_p(openpgp),

2315

ctypes.POINTER(ctypes.c_ubyte)),

2316

ctypes.c_uint(len(openpgp)))

1791

datum = (gnutls.library.types

1792

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

1793

ctypes.POINTER

1794

(ctypes.c_ubyte)),

1795

ctypes.c_uint(len(openpgp))))

2317

1796

# New empty GnuTLS certificate

2318

crt = gnutls.openpgp_crt_t()

2319

gnutls.openpgp_crt_init(ctypes.byref(crt))

1797

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1798

(gnutls.library.functions

1799

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2320

1800

# Import the OpenPGP public key into the certificate

2321

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

2322

gnutls.OPENPGP_FMT_RAW)

1801

(gnutls.library.functions

1802

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

1803

gnutls.library.constants

1804

.GNUTLS_OPENPGP_FMT_RAW))

2323

1805

# Verify the self signature in the key

2324

1806

crtverify = ctypes.c_uint()

2325

gnutls.openpgp_crt_verify_self(crt, 0,

2326

ctypes.byref(crtverify))

1807

(gnutls.library.functions

1808

.gnutls_openpgp_crt_verify_self(crt, 0,

1809

ctypes.byref(crtverify)))

2327

1810

if crtverify.value != 0:

2328

gnutls.openpgp_crt_deinit(crt)

2329

raise gnutls.CertificateSecurityError("Verify failed")

1811

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1812

raise (gnutls.errors.CertificateSecurityError

1813

("Verify failed"))

2330

1814

# New buffer for the fingerprint

2331

1815

buf = ctypes.create_string_buffer(20)

2332

1816

buf_len = ctypes.c_size_t()

2333

1817

# Get the fingerprint from the certificate into the buffer

2334

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

2335

ctypes.byref(buf_len))

1818

(gnutls.library.functions

1819

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

1820

ctypes.byref(buf_len)))

2336

1821

# Deinit the certificate

2337

gnutls.openpgp_crt_deinit(crt)

1822

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2338

1823

# Convert the buffer to a Python bytestring

2339

1824

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

2340

1825

# Convert the bytestring to hexadecimal notation

2344

1829

2345

1830

class MultiprocessingMixIn(object):

2346

1831

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

2347

2348

1832

def sub_process_main(self, request, address):

2349

1833

try:

2350

1834

self.finish_request(request, address)

2355

1839

def process_request(self, request, address):

2356

1840

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

2357

1841

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

2358

args = (request, address))

1842

args = (request,

1843

address))

2359

1844

proc.start()

2360

1845

return proc

2361

1846

2362

1847

2363

1848

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2364

1849

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

2365

2366

1850

def process_request(self, request, client_address):

2367

1851

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

2368

1852

2377

1861

2378

1862

def add_pipe(self, parent_pipe, proc):

2379

1863

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

2380

raise NotImplementedError()

1864

raise NotImplementedError

2381

1865

2382

1866

2383

1867

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2389

1873

interface: None or a network interface name (string)

2390

1874

use_ipv6: Boolean; to use IPv6 or not

2391

1875

"""

2392

2393

1876

def __init__(self, server_address, RequestHandlerClass,

2394

interface=None,

2395

use_ipv6=True,

2396

socketfd=None):

2397

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

2398

creating a new one with socket.socket().

2399

"""

1877

interface=None, use_ipv6=True):

2400

1878

self.interface = interface

2401

1879

if use_ipv6:

2402

1880

self.address_family = socket.AF_INET6

2403

if socketfd is not None:

2404

# Save the file descriptor

2405

self.socketfd = socketfd

2406

# Save the original socket.socket() function

2407

self.socket_socket = socket.socket

2408

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

2409

#

2410

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

2411

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

2412

# patching socket.socket.)

2413

#

2414

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

2415

@functools.wraps(socket.socket)

2416

def socket_wrapper(*args, **kwargs):

2417

# Restore original function so subsequent calls are

2418

# not affected.

2419

socket.socket = self.socket_socket

2420

del self.socket_socket

2421

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

2422

# saved file descriptor.

2423

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

2424

# Replace socket.socket() function with wrapper

2425

socket.socket = socket_wrapper

2426

# The socketserver.TCPServer.__init__ will call

2427

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

2428

# socket_wrapper(), if socketfd was set.

2429

1881

socketserver.TCPServer.__init__(self, server_address,

2430

1882

RequestHandlerClass)

2431

2432

1883

def server_bind(self):

2433

1884

"""This overrides the normal server_bind() function

2434

1885

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

2440

1891

self.interface)

2441

1892

else:

2442

1893

try:

2443

self.socket.setsockopt(

2444

socket.SOL_SOCKET, SO_BINDTODEVICE,

2445

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

1894

self.socket.setsockopt(socket.SOL_SOCKET,

1895

SO_BINDTODEVICE,

1896

str(self.interface

1897

+ '\0'))

2446

1898

except socket.error as error:

2447

if error.errno == errno.EPERM:

2448

logger.error("No permission to bind to"

2449

" interface %s", self.interface)

2450

elif error.errno == errno.ENOPROTOOPT:

1899

if error[0] == errno.EPERM:

1900

logger.error("No permission to"

1901

" bind to interface %s",

1902

self.interface)

1903

elif error[0] == errno.ENOPROTOOPT:

2451

1904

logger.error("SO_BINDTODEVICE not available;"

2452

1905

" cannot bind to interface %s",

2453

1906

self.interface)

2454

elif error.errno == errno.ENODEV:

2455

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

2456

" cannot bind", self.interface)

2457

1907

else:

2458

1908

raise

2459

1909

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

2462

1912

if self.address_family == socket.AF_INET6:

2463

1913

any_address = "::" # in6addr_any

2464

1914

else:

2465

any_address = "0.0.0.0" # INADDR_ANY

1915

any_address = socket.INADDR_ANY

2466

1916

self.server_address = (any_address,

2467

1917

self.server_address[1])

2468

1918

elif not self.server_address[1]:

2469

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

1919

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

1920

0)

2470

1921

# if self.interface:

2471

1922

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

2472

1923

# 0, # port

2484

1935

gnutls_priority GnuTLS priority string

2485

1936

use_dbus: Boolean; to emit D-Bus signals or not

2486

1937

2487

Assumes a GLib.MainLoop event loop.

1938

Assumes a gobject.MainLoop event loop.

2488

1939

"""

2489

2490

1940

def __init__(self, server_address, RequestHandlerClass,

2491

interface=None,

2492

use_ipv6=True,

2493

clients=None,

2494

gnutls_priority=None,

2495

use_dbus=True,

2496

socketfd=None):

1941

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

1942

gnutls_priority=None, use_dbus=True):

2497

1943

self.enabled = False

2498

1944

self.clients = clients

2499

1945

if self.clients is None:

2503

1949

IPv6_TCPServer.__init__(self, server_address,

2504

1950

RequestHandlerClass,

2505

1951

interface = interface,

2506

use_ipv6 = use_ipv6,

2507

socketfd = socketfd)

2508

1952

use_ipv6 = use_ipv6)

2509

1953

def server_activate(self):

2510

1954

if self.enabled:

2511

1955

return socketserver.TCPServer.server_activate(self)

2515

1959

2516

1960

def add_pipe(self, parent_pipe, proc):

2517

1961

# Call "handle_ipc" for both data and EOF events

2518

GLib.io_add_watch(

2519

parent_pipe.fileno(),

2520

GLib.IO_IN | GLib.IO_HUP,

2521

functools.partial(self.handle_ipc,

2522

parent_pipe = parent_pipe,

2523

proc = proc))

1962

gobject.io_add_watch(parent_pipe.fileno(),

1963

gobject.IO_IN | gobject.IO_HUP,

1964

functools.partial(self.handle_ipc,

1965

parent_pipe =

1966

parent_pipe,

1967

proc = proc))

2524

1968

2525

def handle_ipc(self, source, condition,

2526

parent_pipe=None,

2527

proc = None,

2528

client_object=None):

1969

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

1970

proc = None, client_object=None):

1971

condition_names = {

1972

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

1973

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

1974

# blocking).

1975

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

1976

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

1977

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

1978

# broken, usually for pipes and

1979

# sockets).

1980

}

1981

conditions_string = ' | '.join(name

1982

for cond, name in

1983

condition_names.iteritems()

1984

if cond & condition)

2529

1985

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

2530

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

1986

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

2531

1987

# Wait for other process to exit

2532

1988

proc.join()

2533

1989

return False

2540

1996

fpr = request[1]

2541

1997

address = request[2]

2542

1998

2543

for c in self.clients.values():

1999

for c in self.clients.itervalues():

2544

2000

if c.fingerprint == fpr:

2545

2001

client = c

2546

2002

break

2554

2010

parent_pipe.send(False)

2555

2011

return False

2556

2012

2557

GLib.io_add_watch(

2558

parent_pipe.fileno(),

2559

GLib.IO_IN | GLib.IO_HUP,

2560

functools.partial(self.handle_ipc,

2561

parent_pipe = parent_pipe,

2562

proc = proc,

2563

client_object = client))

2013

gobject.io_add_watch(parent_pipe.fileno(),

2014

gobject.IO_IN | gobject.IO_HUP,

2015

functools.partial(self.handle_ipc,

2016

parent_pipe =

2017

parent_pipe,

2018

proc = proc,

2019

client_object =

2020

client))

2564

2021

parent_pipe.send(True)

2565

2022

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

2566

2023

# same fileno

2572

2029

2573

2030

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

2574

2031

funcname)(*args,

2575

**kwargs)))

2032

**kwargs)))

2576

2033

2577

2034

if command == 'getattr':

2578

2035

attrname = request[1]

2579

if isinstance(client_object.__getattribute__(attrname),

2580

collections.Callable):

2581

parent_pipe.send(('function', ))

2036

if callable(client_object.__getattribute__(attrname)):

2037

parent_pipe.send(('function',))

2582

2038

else:

2583

parent_pipe.send((

2584

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

2039

parent_pipe.send(('data', client_object

2040

.__getattribute__(attrname)))

2585

2041

2586

2042

if command == 'setattr':

2587

2043

attrname = request[1]

2591

2047

return True

2592

2048

2593

2049

2594

def rfc3339_duration_to_delta(duration):

2595

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

2596

2597

>>> rfc3339_duration_to_delta("P7D")

2598

datetime.timedelta(7)

2599

>>> rfc3339_duration_to_delta("PT60S")

2600

datetime.timedelta(0, 60)

2601

>>> rfc3339_duration_to_delta("PT60M")

2602

datetime.timedelta(0, 3600)

2603

>>> rfc3339_duration_to_delta("PT24H")

2604

datetime.timedelta(1)

2605

>>> rfc3339_duration_to_delta("P1W")

2606

datetime.timedelta(7)

2607

>>> rfc3339_duration_to_delta("PT5M30S")

2608

datetime.timedelta(0, 330)

2609

>>> rfc3339_duration_to_delta("P1DT3M20S")

2610

datetime.timedelta(1, 200)

2611

"""

2612

2613

# Parsing an RFC 3339 duration with regular expressions is not

2614

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

2615

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

2616

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

2617

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

2618

# avoid excessive use of external libraries.

2619

2620

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

2621

Token = collections.namedtuple("Token", (

2622

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

2623

# a "group" containing digits

2624

"value", # datetime.timedelta or None

2625

"followers")) # Tokens valid after this token

2626

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

2627

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

2628

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

2629

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

2630

datetime.timedelta(seconds=1),

2631

frozenset((token_end, )))

2632

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

2633

datetime.timedelta(minutes=1),

2634

frozenset((token_second, token_end)))

2635

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

2636

datetime.timedelta(hours=1),

2637

frozenset((token_minute, token_end)))

2638

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

2639

None,

2640

frozenset((token_hour, token_minute,

2641

token_second)))

2642

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

2643

datetime.timedelta(days=1),

2644

frozenset((token_time, token_end)))

2645

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

2646

datetime.timedelta(weeks=4),

2647

frozenset((token_day, token_end)))

2648

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

2649

datetime.timedelta(weeks=52),

2650

frozenset((token_month, token_end)))

2651

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

2652

datetime.timedelta(weeks=1),

2653

frozenset((token_end, )))

2654

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

2655

frozenset((token_year, token_month,

2656

token_day, token_time,

2657

token_week)))

2658

# Define starting values

2659

value = datetime.timedelta() # Value so far

2660

found_token = None

2661

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

2662

s = duration # String left to parse

2663

# Loop until end token is found

2664

while found_token is not token_end:

2665

# Search for any currently valid tokens

2666

for token in followers:

2667

match = token.regexp.match(s)

2668

if match is not None:

2669

# Token found

2670

if token.value is not None:

2671

# Value found, parse digits

2672

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

2673

# Add to value so far

2674

value += factor * token.value

2675

# Strip token from string

2676

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

2677

# Go to found token

2678

found_token = token

2679

# Set valid next tokens

2680

followers = found_token.followers

2681

break

2682

else:

2683

# No currently valid tokens were found

2684

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

2685

.format(duration))

2686

# End token found

2687

return value

2688

2689

2690

2050

def string_to_delta(interval):

2691

2051

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

2692

2052

2703

2063

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

2704

2064

datetime.timedelta(0, 330)

2705

2065

"""

2706

2707

try:

2708

return rfc3339_duration_to_delta(interval)

2709

except ValueError:

2710

pass

2711

2712

2066

timevalue = datetime.timedelta(0)

2713

2067

for s in interval.split():

2714

2068

try:

2715

suffix = s[-1]

2069

suffix = unicode(s[-1])

2716

2070

value = int(s[:-1])

2717

2071

if suffix == "d":

2718

2072

delta = datetime.timedelta(value)

2725

2079

elif suffix == "w":

2726

2080

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

2727

2081

else:

2728

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

2729

except IndexError as e:

2082

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

2083

except (ValueError, IndexError) as e:

2730

2084

raise ValueError(*(e.args))

2731

2085

timevalue += delta

2732

2086

return timevalue

2748

2102

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

2749

2103

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

2750

2104

raise OSError(errno.ENODEV,

2751

"{} not a character device"

2752

.format(os.devnull))

2105

"%s not a character device"

2106

% os.devnull)

2753

2107

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

2754

2108

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

2755

2109

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

2764

2118

2765

2119

parser = argparse.ArgumentParser()

2766

2120

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

2767

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

2121

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

2768

2122

help="show version number and exit")

2769

2123

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

2770

2124

help="Bind to interface IF")

2776

2130

help="Run self-test")

2777

2131

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

2778

2132

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

2779

" to terminal", default=None)

2133

" to terminal")

2780

2134

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

2781

2135

help="Debug level for stdout output")

2782

2136

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

2789

2143

" files")

2790

2144

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

2791

2145

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

2792

" system bus interface", default=None)

2146

" system bus interface")

2793

2147

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

2794

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

2795

default=None)

2148

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

2796

2149

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

2797

2150

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

2798

" state", default=None)

2799

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

2800

help="Specify a file descriptor to a network"

2801

" socket to use instead of creating one")

2151

" state")

2802

2152

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

2803

2153

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

2804

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

2805

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

2806

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

2807

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

2808

default=None)

2809

2154

2810

2155

options = parser.parse_args()

2811

2156

2812

2157

if options.check:

2813

2158

import doctest

2814

fail_count, test_count = doctest.testmod()

2815

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

2159

doctest.testmod()

2160

sys.exit()

2816

2161

2817

2162

# Default values for config file for server-global settings

2818

2163

server_defaults = { "interface": "",

2820

2165

"port": "",

2821

2166

"debug": "False",

2822

2167

"priority":

2823

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

2824

":+SIGN-DSA-SHA256",

2168

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

2825

2169

"servicename": "Mandos",

2826

2170

"use_dbus": "True",

2827

2171

"use_ipv6": "True",

2828

2172

"debuglevel": "",

2829

2173

"restore": "True",

2830

"socket": "",

2831

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

2832

"foreground": "False",

2833

"zeroconf": "True",

2834

}

2174

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

2175

}

2835

2176

2836

2177

# Parse config file for server-global settings

2837

2178

server_config = configparser.SafeConfigParser(server_defaults)

2838

2179

del server_defaults

2839

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

2180

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

2181

"mandos.conf"))

2840

2182

# Convert the SafeConfigParser object to a dict

2841

2183

server_settings = server_config.defaults()

2842

2184

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

2843

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

2185

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

2844

2186

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

2845

2187

option)

2846

2188

if server_settings["port"]:

2847

2189

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

2848

2190

"port")

2849

if server_settings["socket"]:

2850

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

2851

"socket")

2852

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

2853

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

2854

# happen with a supplied network socket.

2855

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

2856

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

2857

["socket"])

2858

2191

del server_config

2859

2192

2860

2193

# Override the settings from the config file with command line

2861

2194

# options, if set.

2862

2195

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

2863

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

2864

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

2865

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

2196

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

2197

"use_dbus", "use_ipv6", "debuglevel", "restore",

2198

"statedir"):

2866

2199

value = getattr(options, option)

2867

2200

if value is not None:

2868

2201

server_settings[option] = value

2869

2202

del options

2870

2203

# Force all strings to be unicode

2871

2204

for option in server_settings.keys():

2872

if isinstance(server_settings[option], bytes):

2873

server_settings[option] = (server_settings[option]

2874

.decode("utf-8"))

2875

# Force all boolean options to be boolean

2876

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

2877

"foreground", "zeroconf"):

2878

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

2879

# Debug implies foreground

2880

if server_settings["debug"]:

2881

server_settings["foreground"] = True

2205

if type(server_settings[option]) is str:

2206

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

2882

2207

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

2883

2208

2884

2209

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

2885

2210

2886

if (not server_settings["zeroconf"]

2887

and not (server_settings["port"]

2888

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

2889

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

2890

2891

2211

# For convenience

2892

2212

debug = server_settings["debug"]

2893

2213

debuglevel = server_settings["debuglevel"]

2895

2215

use_ipv6 = server_settings["use_ipv6"]

2896

2216

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

2897

2217

stored_state_file)

2898

foreground = server_settings["foreground"]

2899

zeroconf = server_settings["zeroconf"]

2900

2218

2901

2219

if debug:

2902

2220

initlogger(debug, logging.DEBUG)

2908

2226

initlogger(debug, level)

2909

2227

2910

2228

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

2911

syslogger.setFormatter(

2912

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

2913

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

2914

server_settings["servicename"])))

2229

syslogger.setFormatter(logging.Formatter

2230

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

2231

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

2232

% server_settings["servicename"]))

2915

2233

2916

2234

# Parse config file with clients

2917

2235

client_config = configparser.SafeConfigParser(Client

2922

2240

global mandos_dbus_service

2923

2241

mandos_dbus_service = None

2924

2242

2925

socketfd = None

2926

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

2927

socketfd = server_settings["socket"]

2928

tcp_server = MandosServer(

2929

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

2930

ClientHandler,

2931

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

2932

use_ipv6=use_ipv6,

2933

gnutls_priority=server_settings["priority"],

2934

use_dbus=use_dbus,

2935

socketfd=socketfd)

2936

if not foreground:

2937

pidfilename = "/run/mandos.pid"

2938

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

2939

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

2940

pidfile = None

2243

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

2244

server_settings["port"]),

2245

ClientHandler,

2246

interface=(server_settings["interface"]

2247

or None),

2248

use_ipv6=use_ipv6,

2249

gnutls_priority=

2250

server_settings["priority"],

2251

use_dbus=use_dbus)

2252

if not debug:

2253

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

2941

2254

try:

2942

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

2943

except IOError as e:

2944

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

2945

exc_info=e)

2255

pidfile = open(pidfilename, "w")

2256

except IOError:

2257

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

2946

2258

2947

for name, group in (("_mandos", "_mandos"),

2948

("mandos", "mandos"),

2949

("nobody", "nogroup")):

2259

try:

2260

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

2261

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

2262

except KeyError:

2950

2263

try:

2951

uid = pwd.getpwnam(name).pw_uid

2952

gid = pwd.getpwnam(group).pw_gid

2953

break

2264

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

2265

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

2954

2266

except KeyError:

2955

continue

2956

else:

2957

uid = 65534

2958

gid = 65534

2267

try:

2268

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

2269

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

2270

except KeyError:

2271

uid = 65534

2272

gid = 65534

2959

2273

try:

2960

2274

os.setgid(gid)

2961

2275

os.setuid(uid)

2962

if debug:

2963

logger.debug("Did setuid/setgid to {}:{}".format(uid,

2964

gid))

2965

2276

except OSError as error:

2966

logger.warning("Failed to setuid/setgid to {}:{}: {}"

2967

.format(uid, gid, os.strerror(error.errno)))

2968

if error.errno != errno.EPERM:

2969

raise

2277

if error[0] != errno.EPERM:

2278

raise error

2970

2279

2971

2280

if debug:

2972

2281

# Enable all possible GnuTLS debugging

2973

2282

2974

2283

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

2975

2284

# - GnuTLS manual

2976

gnutls.global_set_log_level(11)

2285

gnutls.library.functions.gnutls_global_set_log_level(11)

2977

2286

2978

@gnutls.log_func

2287

@gnutls.library.types.gnutls_log_func

2979

2288

def debug_gnutls(level, string):

2980

2289

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

2981

2290

2982

gnutls.global_set_log_function(debug_gnutls)

2291

(gnutls.library.functions

2292

.gnutls_global_set_log_function(debug_gnutls))

2983

2293

2984

2294

# Redirect stdin so all checkers get /dev/null

2985

2295

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

2988

2298

os.close(null)

2989

2299

2990

2300

# Need to fork before connecting to D-Bus

2991

if not foreground:

2301

if not debug:

2992

2302

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

2993

2303

daemon()

2994

2304

2995

# multiprocessing will use threads, so before we use GLib we need

2996

# to inform GLib that threads will be used.

2997

GLib.threads_init()

2305

gobject.threads_init()

2998

2306

2999

2307

global main_loop

3000

2308

# From the Avahi example code

3001

2309

DBusGMainLoop(set_as_default=True)

3002

main_loop = GLib.MainLoop()

2310

main_loop = gobject.MainLoop()

3003

2311

bus = dbus.SystemBus()

3004

2312

# End of Avahi example code

3005

2313

if use_dbus:

3006

2314

try:

3007

2315

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

3008

bus,

3009

do_not_queue=True)

3010

old_bus_name = dbus.service.BusName(

3011

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

3012

do_not_queue=True)

3013

except dbus.exceptions.DBusException as e:

3014

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

2316

bus, do_not_queue=True)

2317

old_bus_name = (dbus.service.BusName

2318

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

2319

do_not_queue=True))

2320

except dbus.exceptions.NameExistsException as e:

2321

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

3015

2322

use_dbus = False

3016

2323

server_settings["use_dbus"] = False

3017

2324

tcp_server.use_dbus = False

3018

if zeroconf:

3019

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3020

service = AvahiServiceToSyslog(

3021

name = server_settings["servicename"],

3022

servicetype = "_mandos._tcp",

3023

protocol = protocol,

3024

bus = bus)

3025

if server_settings["interface"]:

3026

service.interface = if_nametoindex(

3027

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

2325

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2326

service = AvahiServiceToSyslog(name =

2327

server_settings["servicename"],

2328

servicetype = "_mandos._tcp",

2329

protocol = protocol, bus = bus)

2330

if server_settings["interface"]:

2331

service.interface = (if_nametoindex

2332

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

3028

2333

3029

2334

global multiprocessing_manager

3030

2335

multiprocessing_manager = multiprocessing.Manager()

3031

2336

3032

2337

client_class = Client

3033

2338

if use_dbus:

3034

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

2339

client_class = functools.partial(ClientDBusTransitional,

2340

bus = bus)

3035

2341

3036

2342

client_settings = Client.config_parser(client_config)

3037

2343

old_client_settings = {}

3038

2344

clients_data = {}

3039

2345

3040

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

3041

global wnull

3042

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

3043

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

3044

# mode

3045

if debug or not foreground:

3046

wnull.close()

3047

3048

2346

# Get client data and settings from last running state.

3049

2347

if server_settings["restore"]:

3050

2348

try:

3051

2349

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

3052

if sys.version_info.major == 2:

3053

clients_data, old_client_settings = pickle.load(

3054

stored_state)

3055

else:

3056

bytes_clients_data, bytes_old_client_settings = (

3057

pickle.load(stored_state, encoding = "bytes"))

3058

### Fix bytes to strings

3059

## clients_data

3060

# .keys()

3061

clients_data = { (key.decode("utf-8")

3062

if isinstance(key, bytes)

3063

else key): value

3064

for key, value in

3065

bytes_clients_data.items() }

3066

del bytes_clients_data

3067

for key in clients_data:

3068

value = { (k.decode("utf-8")

3069

if isinstance(k, bytes) else k): v

3070

for k, v in

3071

clients_data[key].items() }

3072

clients_data[key] = value

3073

# .client_structure

3074

value["client_structure"] = [

3075

(s.decode("utf-8")

3076

if isinstance(s, bytes)

3077

else s) for s in

3078

value["client_structure"] ]

3079

# .name & .host

3080

for k in ("name", "host"):

3081

if isinstance(value[k], bytes):

3082

value[k] = value[k].decode("utf-8")

3083

## old_client_settings

3084

# .keys()

3085

old_client_settings = {

3086

(key.decode("utf-8")

3087

if isinstance(key, bytes)

3088

else key): value

3089

for key, value in

3090

bytes_old_client_settings.items() }

3091

del bytes_old_client_settings

3092

# .host

3093

for value in old_client_settings.values():

3094

if isinstance(value["host"], bytes):

3095

value["host"] = (value["host"]

3096

.decode("utf-8"))

2350

clients_data, old_client_settings = (pickle.load

2351

(stored_state))

3097

2352

os.remove(stored_state_path)

3098

2353

except IOError as e:

3099

if e.errno == errno.ENOENT:

3100

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

3101

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

3102

else:

3103

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

3104

exc_info=e)

2354

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

2355

.format(e))

2356

if e.errno != errno.ENOENT:

3105

2357

raise

3106

2358

except EOFError as e:

3107

2359

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

3108

"EOFError:",

3109

exc_info=e)

2360

"EOFError: {0}".format(e))

3110

2361

3111

2362

with PGPEngine() as pgp:

3112

for client_name, client in clients_data.items():

3113

# Skip removed clients

3114

if client_name not in client_settings:

3115

continue

3116

2363

for client_name, client in clients_data.iteritems():

3117

2364

# Decide which value to use after restoring saved state.

3118

2365

# We have three different values: Old config file,

3119

2366

# new config file, and saved state.

3124

2371

# For each value in new config, check if it

3125

2372

# differs from the old config value (Except for

3126

2373

# the "secret" attribute)

3127

if (name != "secret"

3128

and (value !=

3129

old_client_settings[client_name][name])):

2374

if (name != "secret" and

2375

value != old_client_settings[client_name]

2376

[name]):

3130

2377

client[name] = value

3131

2378

except KeyError:

3132

2379

pass

3133

2380

3134

2381

# Clients who has passed its expire date can still be

3135

# enabled if its last checker was successful. A Client

2382

# enabled if its last checker was successful. Clients

3136

2383

# whose checker succeeded before we stored its state is

3137

2384

# assumed to have successfully run all checkers during

3138

2385

# downtime.

3140

2387

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

3141

2388

if not client["last_checked_ok"]:

3142

2389

logger.warning(

3143

"disabling client {} - Client never "

3144

"performed a successful checker".format(

3145

client_name))

2390

"disabling client {0} - Client never "

2391

"performed a successful checker"

2392

.format(client_name))

3146

2393

client["enabled"] = False

3147

2394

elif client["last_checker_status"] != 0:

3148

2395

logger.warning(

3149

"disabling client {} - Client last"

3150

" checker failed with error code"

3151

" {}".format(

3152

client_name,

3153

client["last_checker_status"]))

2396

"disabling client {0} - Client "

2397

"last checker failed with error code {1}"

2398

.format(client_name,

2399

client["last_checker_status"]))

3154

2400

client["enabled"] = False

3155

2401

else:

3156

client["expires"] = (

3157

datetime.datetime.utcnow()

3158

+ client["timeout"])

2402

client["expires"] = (datetime.datetime

2403

.utcnow()

2404

+ client["timeout"])

3159

2405

logger.debug("Last checker succeeded,"

3160

" keeping {} enabled".format(

3161

client_name))

2406

" keeping {0} enabled"

2407

.format(client_name))

3162

2408

try:

3163

client["secret"] = pgp.decrypt(

3164

client["encrypted_secret"],

3165

client_settings[client_name]["secret"])

2409

client["secret"] = (

2410

pgp.decrypt(client["encrypted_secret"],

2411

client_settings[client_name]

2412

["secret"]))

3166

2413

except PGPError:

3167

2414

# If decryption fails, we use secret from new settings

3168

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

3169

client_name))

3170

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

3171

["secret"])

2415

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

2416

.format(client_name))

2417

client["secret"] = (

2418

client_settings[client_name]["secret"])

2419

3172

2420

3173

2421

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

3174

2422

for client_name in (set(old_client_settings)

3177

2425

for client_name in (set(client_settings)

3178

2426

- set(old_client_settings)):

3179

2427

clients_data[client_name] = client_settings[client_name]

3180

2428

3181

2429

# Create all client objects

3182

for client_name, client in clients_data.items():

2430

for client_name, client in clients_data.iteritems():

3183

2431

tcp_server.clients[client_name] = client_class(

3184

name = client_name,

3185

settings = client,

3186

server_settings = server_settings)

2432

name = client_name, settings = client)

3187

2433

3188

2434

if not tcp_server.clients:

3189

2435

logger.warning("No clients defined")

3190

3191

if not foreground:

3192

if pidfile is not None:

3193

pid = os.getpid()

3194

try:

3195

with pidfile:

3196

print(pid, file=pidfile)

3197

except IOError:

3198

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

3199

pidfilename, pid)

3200

del pidfile

2436

2437

if not debug:

2438

try:

2439

with pidfile:

2440

pid = os.getpid()

2441

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

2442

del pidfile

2443

except IOError:

2444

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

2445

pidfilename, pid)

2446

except NameError:

2447

# "pidfile" was never created

2448

pass

3201

2449

del pidfilename

2450

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

3202

2451

3203

for termsig in (signal.SIGHUP, signal.SIGTERM):

3204

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3205

lambda: main_loop.quit() and False)

2452

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

2453

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

3206

2454

3207

2455

if use_dbus:

3208

3209

@alternate_dbus_interfaces(

3210

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

3211

class MandosDBusService(DBusObjectWithObjectManager):

2456

class MandosDBusService(DBusObjectWithProperties):

3212

2457

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

3213

3214

2458

def __init__(self):

3215

2459

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

3216

3217

2460

_interface = "se.recompile.Mandos"

3218

2461

2462

@dbus_interface_annotations(_interface)

2463

def _foo(self):

2464

return { "org.freedesktop.DBus.Property"

2465

".EmitsChangedSignal":

2466

"false"}

2467

3219

2468

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

3220

2469

def ClientAdded(self, objpath):

3221

2470

"D-Bus signal"

3226

2475

"D-Bus signal"

3227

2476

pass

3228

2477

3229

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

3230

"true"})

3231

2478

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

3232

2479

def ClientRemoved(self, objpath, name):

3233

2480

"D-Bus signal"

3234

2481

pass

3235

2482

3236

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

3237

"true"})

3238

2483

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

3239

2484

def GetAllClients(self):

3240

2485

"D-Bus method"

3241

return dbus.Array(c.dbus_object_path for c in

3242

tcp_server.clients.values())

2486

return dbus.Array(c.dbus_object_path

2487

for c in

2488

tcp_server.clients.itervalues())

3243

2489

3244

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

3245

"true"})

3246

2490

@dbus.service.method(_interface,

3247

2491

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

3248

2492

def GetAllClientsWithProperties(self):

3249

2493

"D-Bus method"

3250

2494

return dbus.Dictionary(

3251

{ c.dbus_object_path: c.GetAll(

3252

"se.recompile.Mandos.Client")

3253

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

2495

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

2496

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

3254

2497

signature="oa{sv}")

3255

2498

3256

2499

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

3257

2500

def RemoveClient(self, object_path):

3258

2501

"D-Bus method"

3259

for c in tcp_server.clients.values():

2502

for c in tcp_server.clients.itervalues():

3260

2503

if c.dbus_object_path == object_path:

3261

2504

del tcp_server.clients[c.name]

3262

2505

c.remove_from_connection()

3263

# Don't signal the disabling

2506

# Don't signal anything except ClientRemoved

3264

2507

c.disable(quiet=True)

3265

# Emit D-Bus signal for removal

3266

self.client_removed_signal(c)

2508

# Emit D-Bus signal

2509

self.ClientRemoved(object_path, c.name)

3267

2510

return

3268

2511

raise KeyError(object_path)

3269

2512

3270

2513

del _interface

3271

3272

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3273

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

3274

def GetManagedObjects(self):

3275

"""D-Bus method"""

3276

return dbus.Dictionary(

3277

{ client.dbus_object_path:

3278

dbus.Dictionary(

3279

{ interface: client.GetAll(interface)

3280

for interface in

3281

client._get_all_interface_names()})

3282

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

3283

3284

def client_added_signal(self, client):

3285

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

3286

if use_dbus:

3287

# New standard signal

3288

self.InterfacesAdded(

3289

client.dbus_object_path,

3290

dbus.Dictionary(

3291

{ interface: client.GetAll(interface)

3292

for interface in

3293

client._get_all_interface_names()}))

3294

# Old signal

3295

self.ClientAdded(client.dbus_object_path)

3296

3297

def client_removed_signal(self, client):

3298

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

3299

if use_dbus:

3300

# New standard signal

3301

self.InterfacesRemoved(

3302

client.dbus_object_path,

3303

client._get_all_interface_names())

3304

# Old signal

3305

self.ClientRemoved(client.dbus_object_path,

3306

client.name)

3307

2514

3308

mandos_dbus_service = MandosDBusService()

2515

class MandosDBusServiceTransitional(MandosDBusService):

2516

__metaclass__ = AlternateDBusNamesMetaclass

2517

mandos_dbus_service = MandosDBusServiceTransitional()

3309

2518

3310

2519

def cleanup():

3311

2520

"Cleanup function; run on exit"

3312

if zeroconf:

3313

service.cleanup()

2521

service.cleanup()

3314

2522

3315

2523

multiprocessing.active_children()

3316

wnull.close()

3317

2524

if not (tcp_server.clients or client_settings):

3318

2525

return

3319

2526

3322

2529

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

3323

2530

clients = {}

3324

2531

with PGPEngine() as pgp:

3325

for client in tcp_server.clients.values():

2532

for client in tcp_server.clients.itervalues():

3326

2533

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

3327

2534

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

3328

2535

key)

3330

2537

3331

2538

# A list of attributes that can not be pickled

3332

2539

# + secret.

3333

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

3334

"checker", "server_settings" }

3335

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

3336

.Object):

2540

exclude = set(("bus", "changedstate", "secret",

2541

"checker"))

2542

for name, typ in (inspect.getmembers

2543

(dbus.service.Object)):

3337

2544

exclude.add(name)

3338

2545

3339

2546

client_dict["encrypted_secret"] = (client

3346

2553

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

3347

2554

3348

2555

try:

3349

with tempfile.NamedTemporaryFile(

3350

mode='wb',

3351

suffix=".pickle",

3352

prefix='clients-',

3353

dir=os.path.dirname(stored_state_path),

3354

delete=False) as stored_state:

3355

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

3356

protocol = 2)

3357

tempname = stored_state.name

2556

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2557

prefix="clients-",

2558

dir=os.path.dirname

2559

(stored_state_path))

2560

with os.fdopen(tempfd, "wb") as stored_state:

2561

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

3358

2562

os.rename(tempname, stored_state_path)

3359

2563

except (IOError, OSError) as e:

2564

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

2565

.format(e))

3360

2566

if not debug:

3361

2567

try:

3362

2568

os.remove(tempname)

3363

2569

except NameError:

3364

2570

pass

3365

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

3366

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

3367

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

3368

else:

3369

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

3370

exc_info=e)

3371

raise

2571

if e.errno not in set((errno.ENOENT, errno.EACCES,

2572

errno.EEXIST)):

2573

raise e

3372

2574

3373

2575

# Delete all clients, and settings from config

3374

2576

while tcp_server.clients:

3375

2577

name, client = tcp_server.clients.popitem()

3376

2578

if use_dbus:

3377

2579

client.remove_from_connection()

3378

# Don't signal the disabling

2580

# Don't signal anything except ClientRemoved

3379

2581

client.disable(quiet=True)

3380

# Emit D-Bus signal for removal

3381

2582

if use_dbus:

3382

mandos_dbus_service.client_removed_signal(client)

2583

# Emit D-Bus signal

2584

mandos_dbus_service.ClientRemoved(client

2585

.dbus_object_path,

2586

client.name)

3383

2587

client_settings.clear()

3384

2588

3385

2589

atexit.register(cleanup)

3386

2590

3387

for client in tcp_server.clients.values():

2591

for client in tcp_server.clients.itervalues():

3388

2592

if use_dbus:

3389

# Emit D-Bus signal for adding

3390

mandos_dbus_service.client_added_signal(client)

2593

# Emit D-Bus signal

2594

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3391

2595

# Need to initiate checking of clients

3392

2596

if client.enabled:

3393

2597

client.init_checker()

3396

2600

tcp_server.server_activate()

3397

2601

3398

2602

# Find out what port we got

3399

if zeroconf:

3400

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

2603

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

3401

2604

if use_ipv6:

3402

2605

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

3403

" flowinfo %d, scope_id %d",

3404

*tcp_server.socket.getsockname())

2606

" flowinfo %d, scope_id %d"

2607

% tcp_server.socket.getsockname())

3405

2608

else: # IPv4

3406

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

3407

*tcp_server.socket.getsockname())

2609

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

2610

% tcp_server.socket.getsockname())

3408

2611

3409

2612

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

3410

2613

3411

2614

try:

3412

if zeroconf:

3413

# From the Avahi example code

3414

try:

3415

service.activate()

3416

except dbus.exceptions.DBusException as error:

3417

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

3418

cleanup()

3419

sys.exit(1)

3420

# End of Avahi example code

2615

# From the Avahi example code

2616

try:

2617

service.activate()

2618

except dbus.exceptions.DBusException as error:

2619

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

2620

cleanup()

2621

sys.exit(1)

2622

# End of Avahi example code

3421

2623

3422

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

3423

lambda *args, **kwargs:

3424

(tcp_server.handle_request

3425

(*args[2:], **kwargs) or True))

2624

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

2625

lambda *args, **kwargs:

2626

(tcp_server.handle_request

2627

(*args[2:], **kwargs) or True))

3426

2628

3427

2629

logger.debug("Starting main loop")

3428

2630

main_loop.run()

3429

2631

except AvahiError as error:

3430

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

2632

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

3431

2633

cleanup()

3432

2634

sys.exit(1)

3433

2635

except KeyboardInterrupt:

3438

2640

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

3439

2641

cleanup()

3440

2642

3441

3442

2643

if __name__ == '__main__':

3443

2644

main()