/mandos/trunk : revision 237.4.28

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

import itertools

77

import collections

78

import codecs

79

68

80

69

import dbus

81

70

import dbus.service

82

from gi.repository import GLib

71

import gobject

72

import avahi

83

73

from dbus.mainloop.glib import DBusGMainLoop

84

74

import ctypes

85

75

import ctypes.util

86

76

import xml.dom.minidom

87

77

import inspect

78

import GnuPGInterface

88

79

89

# Try to find the value of SO_BINDTODEVICE:

90

80

try:

91

# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and

92

# newer, and it is also the most natural place for it:

93

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

82

except AttributeError:

95

83

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

84

from IN import SO_BINDTODEVICE

99

85

except ImportError:

100

# In Python 2.7 it seems to have been removed entirely.

101

# Try running the C preprocessor:

102

try:

103

cc = subprocess.Popen(["cc", "--language=c", "-E",

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]

109

SO_BINDTODEVICE = int(stdout.splitlines()[-1])

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.8"

86

SO_BINDTODEVICE = None

87

88

version = "1.5.3"

118

89

stored_state_file = "clients.pickle"

119

90

120

91

logger = logging.getLogger()

121

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

122

95

123

96

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

126

100

except (OSError, AttributeError):

127

128

101

def if_nametoindex(interface):

129

102

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

130

103

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

131

104

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

132

105

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

133

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

134

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

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

135

110

return interface_index

136

111

137

112

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

154

113

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

155

114

"""init logger and add loglevel"""

156

115

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

160

address = "/dev/log"))

161

116

syslogger.setFormatter(logging.Formatter

162

117

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

163

118

' %(message)s'))

180

135

181

136

class PGPEngine(object):

182

137

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

183

184

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

185

140

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

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

'--force-mdc',

200

'--quiet']

201

# Only GPG version 1 has the --no-use-agent option.

202

if self.gpg == "gpg" or self.gpg.endswith("/gpg"):

203

self.gnupgargs.append("--no-use-agent")

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

204

147

205

148

def __enter__(self):

206

149

return self

207

150

208

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

151

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

209

152

self._cleanup()

210

153

return False

211

154

228

171

def password_encode(self, password):

229

172

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

230

173

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

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

174

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

238

175

239

176

def encrypt(self, data, password):

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin = subprocess.PIPE,

250

stdout = subprocess.PIPE,

251

stderr = subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

raise PGPError(err)

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

255

191

return ciphertext

256

192

257

193

def decrypt(self, data, password):

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir = self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin = subprocess.PIPE,

268

stdout = subprocess.PIPE,

269

stderr = subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

raise PGPError(err)

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

273

208

return decrypted_plaintext

274

209

275

# Pretend that we have an Avahi module

276

class Avahi(object):

277

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

278

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

279

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

280

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

281

PROTO_INET = 0 # avahi-common/address.h

282

PROTO_INET6 = 1 # avahi-common/address.h

283

DBUS_NAME = "org.freedesktop.Avahi"

284

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

285

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

286

DBUS_PATH_SERVER = "/"

287

def string_array_to_txt_array(self, t):

288

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

289

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

290

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

291

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

292

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

293

SERVER_INVALID = 0 # avahi-common/defs.h

294

SERVER_REGISTERING = 1 # avahi-common/defs.h

295

SERVER_RUNNING = 2 # avahi-common/defs.h

296

SERVER_COLLISION = 3 # avahi-common/defs.h

297

SERVER_FAILURE = 4 # avahi-common/defs.h

298

avahi = Avahi()

210

299

211

300

212

class AvahiError(Exception):

301

213

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

302

214

self.value = value

303

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

304

**kwargs)

305

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

306

218

307

219

class AvahiServiceError(AvahiError):

308

220

pass

309

221

310

311

222

class AvahiGroupError(AvahiError):

312

223

pass

313

224

320

231

Used to optionally bind to the specified interface.

321

232

name: string; Example: 'Mandos'

322

233

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

323

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

234

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

324

235

port: integer; what port to announce

325

236

TXT: list of strings; TXT record for the service

326

237

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

332

243

server: D-Bus Server

333

244

bus: dbus.SystemBus()

334

245

"""

335

336

def __init__(self,

337

interface = avahi.IF_UNSPEC,

338

name = None,

339

servicetype = None,

340

port = None,

341

TXT = None,

342

domain = "",

343

host = "",

344

max_renames = 32768,

345

protocol = avahi.PROTO_UNSPEC,

346

bus = None):

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

347

250

self.interface = interface

348

251

self.name = name

349

252

self.type = servicetype

358

261

self.server = None

359

262

self.bus = bus

360

263

self.entry_group_state_changed_match = None

361

362

def rename(self, remove=True):

264

def rename(self):

363

265

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

364

266

if self.rename_count >= self.max_renames:

365

267

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

366

268

" after %i retries, exiting.",

367

269

self.rename_count)

368

270

raise AvahiServiceError("Too many renames")

369

self.name = str(

370

self.server.GetAlternativeServiceName(self.name))

371

self.rename_count += 1

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

372

273

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

373

274

self.name)

374

if remove:

375

self.remove()

275

self.remove()

376

276

try:

377

277

self.add()

378

278

except dbus.exceptions.DBusException as error:

379

if (error.get_dbus_name()

380

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

381

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

382

return self.rename(remove=False)

383

else:

384

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

385

self.cleanup()

386

os._exit(1)

387

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

388

283

def remove(self):

389

284

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

390

285

if self.entry_group_state_changed_match is not None:

392

287

self.entry_group_state_changed_match = None

393

288

if self.group is not None:

394

289

self.group.Reset()

395

396

290

def add(self):

397

291

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

398

292

self.remove()

415

309

dbus.UInt16(self.port),

416

310

avahi.string_array_to_txt_array(self.TXT))

417

311

self.group.Commit()

418

419

312

def entry_group_state_changed(self, state, error):

420

313

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

421

314

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

427

320

self.rename()

428

321

elif state == avahi.ENTRY_GROUP_FAILURE:

429

322

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

430

str(error))

431

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

432

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

433

326

def cleanup(self):

434

327

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

435

328

if self.group is not None:

440

333

pass

441

334

self.group = None

442

335

self.remove()

443

444

336

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

445

337

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

446

338

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

447

bad_states = {

448

avahi.SERVER_INVALID: "Zeroconf server invalid",

449

avahi.SERVER_REGISTERING: None,

450

avahi.SERVER_COLLISION: "Zeroconf server name collision",

451

avahi.SERVER_FAILURE: "Zeroconf server failure",

452

}

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

453

346

if state in bad_states:

454

347

if bad_states[state] is not None:

455

348

if error is None:

458

351

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

459

352

self.cleanup()

460

353

elif state == avahi.SERVER_RUNNING:

461

try:

462

self.add()

463

except dbus.exceptions.DBusException as error:

464

if (error.get_dbus_name()

465

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

466

logger.info("Local Zeroconf service name"

467

" collision.")

468

return self.rename(remove=False)

469

else:

470

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

471

self.cleanup()

472

os._exit(1)

354

self.add()

473

355

else:

474

356

if error is None:

475

357

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

476

358

else:

477

359

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

478

479

360

def activate(self):

480

361

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

481

362

if self.server is None:

485

366

follow_name_owner_changes=True),

486

367

avahi.DBUS_INTERFACE_SERVER)

487

368

self.server.connect_to_signal("StateChanged",

488

self.server_state_changed)

369

self.server_state_changed)

489

370

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

490

371

491

492

372

class AvahiServiceToSyslog(AvahiService):

493

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

373

def rename(self):

494

374

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

495

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

496

syslogger.setFormatter(logging.Formatter(

497

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

498

.format(self.name)))

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

499

380

return ret

500

381

501

# Pretend that we have a GnuTLS module

502

class GnuTLS(object):

503

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

504

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

505

506

_library = ctypes.cdll.LoadLibrary(

507

ctypes.util.find_library("gnutls"))

508

_need_version = b"3.3.0"

509

def __init__(self):

510

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

511

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

512

# happens.

513

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

514

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

515

.format(self._need_version))

516

517

# Unless otherwise indicated, the constants and types below are

518

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

519

520

# Constants

521

E_SUCCESS = 0

522

E_INTERRUPTED = -52

523

E_AGAIN = -28

524

CRT_OPENPGP = 2

525

CLIENT = 2

526

SHUT_RDWR = 0

527

CRD_CERTIFICATE = 1

528

E_NO_CERTIFICATE_FOUND = -49

529

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

530

531

# Types

532

class session_int(ctypes.Structure):

533

_fields_ = []

534

session_t = ctypes.POINTER(session_int)

535

class certificate_credentials_st(ctypes.Structure):

536

_fields_ = []

537

certificate_credentials_t = ctypes.POINTER(

538

certificate_credentials_st)

539

certificate_type_t = ctypes.c_int

540

class datum_t(ctypes.Structure):

541

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

542

('size', ctypes.c_uint)]

543

class openpgp_crt_int(ctypes.Structure):

544

_fields_ = []

545

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

546

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

547

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

548

credentials_type_t = ctypes.c_int

549

transport_ptr_t = ctypes.c_void_p

550

close_request_t = ctypes.c_int

551

552

# Exceptions

553

class Error(Exception):

554

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

555

# exception might be raised from within GnuTLS.__init__,

556

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

557

# global variable has happened.

558

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

559

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

560

# code is passed, convert it to a string with

561

# gnutls.strerror()

562

self.code = code

563

if message is None and code is not None:

564

message = GnuTLS.strerror(code)

565

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

566

message, *args)

567

568

class CertificateSecurityError(Error):

569

pass

570

571

# Classes

572

class Credentials(object):

573

def __init__(self):

574

self._c_object = gnutls.certificate_credentials_t()

575

gnutls.certificate_allocate_credentials(

576

ctypes.byref(self._c_object))

577

self.type = gnutls.CRD_CERTIFICATE

578

579

def __del__(self):

580

gnutls.certificate_free_credentials(self._c_object)

581

582

class ClientSession(object):

583

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

584

self._c_object = gnutls.session_t()

585

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

586

gnutls.set_default_priority(self._c_object)

587

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

588

gnutls.handshake_set_private_extensions(self._c_object,

589

True)

590

self.socket = socket

591

if credentials is None:

592

credentials = gnutls.Credentials()

593

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

594

ctypes.cast(credentials._c_object,

595

ctypes.c_void_p))

596

self.credentials = credentials

597

598

def __del__(self):

599

gnutls.deinit(self._c_object)

600

601

def handshake(self):

602

return gnutls.handshake(self._c_object)

603

604

def send(self, data):

605

data = bytes(data)

606

data_len = len(data)

607

while data_len > 0:

608

data_len -= gnutls.record_send(self._c_object,

609

data[-data_len:],

610

data_len)

611

612

def bye(self):

613

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

614

615

# Error handling functions

616

def _error_code(result):

617

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

618

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

619

if result >= 0:

620

return result

621

if result == gnutls.E_NO_CERTIFICATE_FOUND:

622

raise gnutls.CertificateSecurityError(code = result)

623

raise gnutls.Error(code = result)

624

625

def _retry_on_error(result, func, arguments):

626

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

627

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

628

while result < 0:

629

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

630

return _error_code(result)

631

result = func(*arguments)

632

return result

633

634

# Unless otherwise indicated, the function declarations below are

635

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

636

637

# Functions

638

priority_set_direct = _library.gnutls_priority_set_direct

639

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

640

ctypes.POINTER(ctypes.c_char_p)]

641

priority_set_direct.restype = _error_code

642

643

init = _library.gnutls_init

644

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

645

init.restype = _error_code

646

647

set_default_priority = _library.gnutls_set_default_priority

648

set_default_priority.argtypes = [session_t]

649

set_default_priority.restype = _error_code

650

651

record_send = _library.gnutls_record_send

652

record_send.argtypes = [session_t, ctypes.c_void_p,

653

ctypes.c_size_t]

654

record_send.restype = ctypes.c_ssize_t

655

record_send.errcheck = _retry_on_error

656

657

certificate_allocate_credentials = (

658

_library.gnutls_certificate_allocate_credentials)

659

certificate_allocate_credentials.argtypes = [

660

ctypes.POINTER(certificate_credentials_t)]

661

certificate_allocate_credentials.restype = _error_code

662

663

certificate_free_credentials = (

664

_library.gnutls_certificate_free_credentials)

665

certificate_free_credentials.argtypes = [certificate_credentials_t]

666

certificate_free_credentials.restype = None

667

668

handshake_set_private_extensions = (

669

_library.gnutls_handshake_set_private_extensions)

670

handshake_set_private_extensions.argtypes = [session_t,

671

ctypes.c_int]

672

handshake_set_private_extensions.restype = None

673

674

credentials_set = _library.gnutls_credentials_set

675

credentials_set.argtypes = [session_t, credentials_type_t,

676

ctypes.c_void_p]

677

credentials_set.restype = _error_code

678

679

strerror = _library.gnutls_strerror

680

strerror.argtypes = [ctypes.c_int]

681

strerror.restype = ctypes.c_char_p

682

683

certificate_type_get = _library.gnutls_certificate_type_get

684

certificate_type_get.argtypes = [session_t]

685

certificate_type_get.restype = _error_code

686

687

certificate_get_peers = _library.gnutls_certificate_get_peers

688

certificate_get_peers.argtypes = [session_t,

689

ctypes.POINTER(ctypes.c_uint)]

690

certificate_get_peers.restype = ctypes.POINTER(datum_t)

691

692

global_set_log_level = _library.gnutls_global_set_log_level

693

global_set_log_level.argtypes = [ctypes.c_int]

694

global_set_log_level.restype = None

695

696

global_set_log_function = _library.gnutls_global_set_log_function

697

global_set_log_function.argtypes = [log_func]

698

global_set_log_function.restype = None

699

700

deinit = _library.gnutls_deinit

701

deinit.argtypes = [session_t]

702

deinit.restype = None

703

704

handshake = _library.gnutls_handshake

705

handshake.argtypes = [session_t]

706

handshake.restype = _error_code

707

handshake.errcheck = _retry_on_error

708

709

transport_set_ptr = _library.gnutls_transport_set_ptr

710

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

711

transport_set_ptr.restype = None

712

713

bye = _library.gnutls_bye

714

bye.argtypes = [session_t, close_request_t]

715

bye.restype = _error_code

716

bye.errcheck = _retry_on_error

717

718

check_version = _library.gnutls_check_version

719

check_version.argtypes = [ctypes.c_char_p]

720

check_version.restype = ctypes.c_char_p

721

722

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

723

724

openpgp_crt_init = _library.gnutls_openpgp_crt_init

725

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

726

openpgp_crt_init.restype = _error_code

727

728

openpgp_crt_import = _library.gnutls_openpgp_crt_import

729

openpgp_crt_import.argtypes = [openpgp_crt_t,

730

ctypes.POINTER(datum_t),

731

openpgp_crt_fmt_t]

732

openpgp_crt_import.restype = _error_code

733

734

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

735

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

736

ctypes.POINTER(ctypes.c_uint)]

737

openpgp_crt_verify_self.restype = _error_code

738

739

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

740

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

741

openpgp_crt_deinit.restype = None

742

743

openpgp_crt_get_fingerprint = (

744

_library.gnutls_openpgp_crt_get_fingerprint)

745

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

746

ctypes.c_void_p,

747

ctypes.POINTER(

748

ctypes.c_size_t)]

749

openpgp_crt_get_fingerprint.restype = _error_code

750

751

# Remove non-public functions

752

del _error_code, _retry_on_error

753

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

754

gnutls = GnuTLS()

755

756

def call_pipe(connection, # : multiprocessing.Connection

757

func, *args, **kwargs):

758

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

759

760

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

761

return value on the provided multiprocessing.Connection.

762

"""

763

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

764

connection.close()

765

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

766

388

class Client(object):

767

389

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

768

390

773

395

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

774

396

to see if the client lives.

775

397

'None' if no process is running.

776

checker_callback_tag: a GLib event source tag, or None

398

checker_callback_tag: a gobject event source tag, or None

777

399

checker_command: string; External command which is run to check

778

400

if client lives. %() expansions are done at

779

401

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

780

402

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

781

checker_initiator_tag: a GLib event source tag, or None

403

checker_initiator_tag: a gobject event source tag, or None

782

404

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

783

405

client_structure: Object describing what attributes a client has

784

406

and is used for storing the client at exit

785

407

current_checker_command: string; current running checker_command

786

disable_initiator_tag: a GLib event source tag, or None

408

disable_initiator_tag: a gobject event source tag, or None

787

409

enabled: bool()

788

410

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

789

411

uniquely identify the client

794

416

last_checker_status: integer between 0 and 255 reflecting exit

795

417

status of last checker. -1 reflects crashed

796

418

checker, -2 means no checker completed yet.

797

last_checker_signal: The signal which killed the last checker, if

798

last_checker_status is -1

799

419

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

800

420

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

801

421

D-Bus identifiers

806

426

runtime_expansions: Allowed attributes for runtime expansion.

807

427

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

808

428

disabled, or None

809

server_settings: The server_settings dict from main()

810

429

"""

811

430

812

431

runtime_expansions = ("approval_delay", "approval_duration",

813

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

814

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

815

"last_approval_request", "last_checked_ok",

432

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

433

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

816

434

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

817

client_defaults = {

818

"timeout": "PT5M",

819

"extended_timeout": "PT15M",

820

"interval": "PT2M",

821

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

822

"host": "",

823

"approval_delay": "PT0S",

824

"approval_duration": "PT1S",

825

"approved_by_default": "True",

826

"enabled": "True",

827

}

828

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

460

829

461

@staticmethod

830

462

def config_parser(config):

831

463

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

846

478

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

847

479

"enabled")

848

480

849

# Uppercase and remove spaces from fingerprint for later

850

# comparison purposes with return value from the

851

# fingerprint() function

852

481

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

853

482

.replace(" ", ""))

854

483

if "secret" in section:

855

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

856

.encode("utf-8"),

857

"base64")

484

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

858

485

elif "secfile" in section:

859

486

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

860

487

(section["secfile"])),

861

488

"rb") as secfile:

862

489

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

863

490

else:

864

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

865

.format(section))

491

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

492

% section)

866

493

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

867

494

client["extended_timeout"] = string_to_delta(

868

495

section["extended_timeout"])

877

504

client["last_checker_status"] = -2

878

505

879

506

return settings

880

881

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

507

508

509

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

510

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

511

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

512

attribute."""

882

513

self.name = name

883

if server_settings is None:

884

server_settings = {}

885

self.server_settings = server_settings

886

514

# adding all client settings

887

for setting, value in settings.items():

515

for setting, value in settings.iteritems():

888

516

setattr(self, setting, value)

889

517

890

518

if self.enabled:

896

524

else:

897

525

self.last_enabled = None

898

526

self.expires = None

899

527

900

528

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

901

532

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

902

533

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

903

534

datetime.datetime.utcnow())

904

535

905

536

# attributes specific for this server instance

906

537

self.checker = None

907

538

self.checker_initiator_tag = None

910

541

self.current_checker_command = None

911

542

self.approved = None

912

543

self.approvals_pending = 0

913

self.changedstate = multiprocessing_manager.Condition(

914

multiprocessing_manager.Lock())

915

self.client_structure = [attr

916

for attr in self.__dict__.keys()

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

917

549

if not attr.startswith("_")]

918

550

self.client_structure.append("client_structure")

919

551

920

for name, t in inspect.getmembers(

921

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

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

922

556

if not name.startswith("_"):

923

557

self.client_structure.append(name)

924

558

932

566

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

933

567

# Already enabled

934

568

return

569

self.send_changedstate()

935

570

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

936

571

self.enabled = True

937

572

self.last_enabled = datetime.datetime.utcnow()

938

573

self.init_checker()

939

self.send_changedstate()

940

574

941

575

def disable(self, quiet=True):

942

576

"""Disable this client."""

943

577

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

944

578

return False

945

579

if not quiet:

580

self.send_changedstate()

581

if not quiet:

946

582

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

947

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

948

GLib.source_remove(self.disable_initiator_tag)

583

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

584

gobject.source_remove(self.disable_initiator_tag)

949

585

self.disable_initiator_tag = None

950

586

self.expires = None

951

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

952

GLib.source_remove(self.checker_initiator_tag)

587

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

588

gobject.source_remove(self.checker_initiator_tag)

953

589

self.checker_initiator_tag = None

954

590

self.stop_checker()

955

591

self.enabled = False

956

if not quiet:

957

self.send_changedstate()

958

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

592

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

959

593

return False

960

594

961

595

def __del__(self):

964

598

def init_checker(self):

965

599

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

966

600

# and every interval from then on.

967

if self.checker_initiator_tag is not None:

968

GLib.source_remove(self.checker_initiator_tag)

969

self.checker_initiator_tag = GLib.timeout_add(

970

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

971

self.start_checker)

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

972

604

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

973

if self.disable_initiator_tag is not None:

974

GLib.source_remove(self.disable_initiator_tag)

975

self.disable_initiator_tag = GLib.timeout_add(

976

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

977

608

# Also start a new checker *right now*.

978

609

self.start_checker()

979

610

980

def checker_callback(self, source, condition, connection,

981

command):

611

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

982

612

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

983

613

self.checker_callback_tag = None

984

614

self.checker = None

985

# Read return code from connection (see call_pipe)

986

returncode = connection.recv()

987

connection.close()

988

989

if returncode >= 0:

990

self.last_checker_status = returncode

991

self.last_checker_signal = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

992

617

if self.last_checker_status == 0:

993

618

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

994

619

vars(self))

995

620

self.checked_ok()

996

621

else:

997

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

622

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

623

vars(self))

998

624

else:

999

625

self.last_checker_status = -1

1000

self.last_checker_signal = -returncode

1001

626

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

1002

627

vars(self))

1003

return False

1004

628

1005

629

def checked_ok(self):

1006

630

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

1007

631

self.last_checked_ok = datetime.datetime.utcnow()

1008

632

self.last_checker_status = 0

1009

self.last_checker_signal = None

1010

633

self.bump_timeout()

1011

634

1012

635

def bump_timeout(self, timeout=None):

1014

637

if timeout is None:

1015

638

timeout = self.timeout

1016

639

if self.disable_initiator_tag is not None:

1017

GLib.source_remove(self.disable_initiator_tag)

1018

self.disable_initiator_tag = None

640

gobject.source_remove(self.disable_initiator_tag)

1019

641

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

1020

self.disable_initiator_tag = GLib.timeout_add(

1021

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

642

self.disable_initiator_tag = (gobject.timeout_add

643

(timedelta_to_milliseconds

644

(timeout), self.disable))

1022

645

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

1023

646

1024

647

def need_approval(self):

1030

653

If a checker already exists, leave it running and do

1031

654

nothing."""

1032

655

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

1033

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

1034

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

1035

# would inevitably timeout, since no checker would get a

1036

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

656

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

657

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

658

# client would inevitably timeout, since no checker would get

659

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

1037

660

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

1038

661

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

1039

662

# should be.

1040

663

1041

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

1042

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

1043

self.checker.join()

1044

self.checker = None

664

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

665

try:

666

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

667

except (AttributeError, OSError) as error:

668

if (isinstance(error, OSError)

669

and error.errno != errno.ECHILD):

670

raise error

671

else:

672

if pid:

673

logger.warning("Checker was a zombie")

674

gobject.source_remove(self.checker_callback_tag)

675

self.checker_callback(pid, status,

676

self.current_checker_command)

1045

677

# Start a new checker if needed

1046

678

if self.checker is None:

1047

# Escape attributes for the shell

1048

escaped_attrs = {

1049

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

1050

for attr in self.runtime_expansions }

1051

679

try:

1052

command = self.checker_command % escaped_attrs

1053

except TypeError as error:

1054

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

1055

self.checker_command,

1056

exc_info=error)

1057

return True # Try again later

680

# In case checker_command has exactly one % operator

681

command = self.checker_command % self.host

682

except TypeError:

683

# Escape attributes for the shell

684

escaped_attrs = dict(

685

(attr,

686

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

687

errors=

688

'replace')))

689

for attr in

690

self.runtime_expansions)

691

692

try:

693

command = self.checker_command % escaped_attrs

694

except TypeError as error:

695

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

696

' %s', self.checker_command, error)

697

return True # Try again later

1058

698

self.current_checker_command = command

1059

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

1060

self.name)

1061

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

1062

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

1063

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

1064

# always replaced by /dev/null.)

1065

# The exception is when not debugging but nevertheless

1066

# running in the foreground; use the previously

1067

# created wnull.

1068

popen_args = { "close_fds": True,

1069

"shell": True,

1070

"cwd": "/" }

1071

if (not self.server_settings["debug"]

1072

and self.server_settings["foreground"]):

1073

popen_args.update({"stdout": wnull,

1074

"stderr": wnull })

1075

pipe = multiprocessing.Pipe(duplex = False)

1076

self.checker = multiprocessing.Process(

1077

target = call_pipe,

1078

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

1079

kwargs = popen_args)

1080

self.checker.start()

1081

self.checker_callback_tag = GLib.io_add_watch(

1082

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

1083

self.checker_callback, pipe[0], command)

1084

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

699

try:

700

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

701

command, self.name)

702

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

703

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

704

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

705

# always replaced by /dev/null.)

706

self.checker = subprocess.Popen(command,

707

close_fds=True,

708

shell=True, cwd="/")

709

self.checker_callback_tag = (gobject.child_watch_add

710

(self.checker.pid,

711

self.checker_callback,

712

data=command))

713

# The checker may have completed before the gobject

714

# watch was added. Check for this.

715

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

716

if pid:

717

gobject.source_remove(self.checker_callback_tag)

718

self.checker_callback(pid, status, command)

719

except OSError as error:

720

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

721

error)

722

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

1085

723

return True

1086

724

1087

725

def stop_checker(self):

1088

726

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

1089

727

if self.checker_callback_tag:

1090

GLib.source_remove(self.checker_callback_tag)

728

gobject.source_remove(self.checker_callback_tag)

1091

729

self.checker_callback_tag = None

1092

730

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

1093

731

return

1094

732

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

1095

self.checker.terminate()

733

try:

734

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

735

#time.sleep(0.5)

736

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

737

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

738

except OSError as error:

739

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

740

raise

1096

741

self.checker = None

1097

742

1098

743

1099

def dbus_service_property(dbus_interface,

1100

signature="v",

1101

access="readwrite",

1102

byte_arrays=False):

744

def dbus_service_property(dbus_interface, signature="v",

745

access="readwrite", byte_arrays=False):

1103

746

"""Decorators for marking methods of a DBusObjectWithProperties to

1104

747

become properties on the D-Bus.

1105

748

1114

757

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

1115

758

if byte_arrays and signature != "ay":

1116

759

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

1117

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

1118

760

" signature %r" % signature)

1119

761

def decorator(func):

1120

762

func._dbus_is_property = True

1121

763

func._dbus_interface = dbus_interface

1126

768

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

1127

769

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1128

770

return func

1129

1130

return decorator

1131

1132

1133

def dbus_interface_annotations(dbus_interface):

1134

"""Decorator for marking functions returning interface annotations

1135

1136

Usage:

1137

1138

@dbus_interface_annotations("org.example.Interface")

1139

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

1140

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

1141

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

1142

"false"}

1143

"""

1144

1145

def decorator(func):

1146

func._dbus_is_interface = True

1147

func._dbus_interface = dbus_interface

1148

func._dbus_name = dbus_interface

1149

return func

1150

1151

return decorator

1152

1153

1154

def dbus_annotations(annotations):

1155

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

1156

Usage:

1157

1158

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

1159

"org.freedesktop.DBus.Property."

1160

"EmitsChangedSignal": "false"})

1161

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

1162

access="r")

1163

def Property_dbus_property(self):

1164

return dbus.Boolean(False)

1165

1166

See also the DBusObjectWithAnnotations class.

1167

"""

1168

1169

def decorator(func):

1170

func._dbus_annotations = annotations

1171

return func

1172

1173

771

return decorator

1174

772

1175

773

1176

774

class DBusPropertyException(dbus.exceptions.DBusException):

1177

775

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

1178

776

"""

1179

pass

777

def __unicode__(self):

778

return unicode(str(self))

1180

779

1181

780

1182

781

class DBusPropertyAccessException(DBusPropertyException):

1191

790

pass

1192

791

1193

792

1194

class DBusObjectWithAnnotations(dbus.service.Object):

1195

"""A D-Bus object with annotations.

1196

1197

Classes inheriting from this can use the dbus_annotations

1198

decorator to add annotations to methods or signals.

1199

"""

1200

1201

@staticmethod

1202

def _is_dbus_thing(thing):

1203

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

1204

1205

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

1206

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

1207

"""

1208

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

1209

False)

1210

1211

def _get_all_dbus_things(self, thing):

1212

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

1213

"""

1214

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

1215

athing.__get__(self))

1216

for cls in self.__class__.__mro__

1217

for name, athing in

1218

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

1219

1220

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1221

out_signature = "s",

1222

path_keyword = 'object_path',

1223

connection_keyword = 'connection')

1224

def Introspect(self, object_path, connection):

1225

"""Overloading of standard D-Bus method.

1226

1227

Inserts annotation tags on methods and signals.

1228

"""

1229

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

1230

connection)

1231

try:

1232

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

1233

1234

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

1235

# Add annotation tags

1236

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

1237

for tag in if_tag.getElementsByTagName(typ):

1238

annots = dict()

1239

for name, prop in (self.

1240

_get_all_dbus_things(typ)):

1241

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

1242

and prop._dbus_interface

1243

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

1244

annots.update(getattr(

1245

prop, "_dbus_annotations", {}))

1246

for name, value in annots.items():

1247

ann_tag = document.createElement(

1248

"annotation")

1249

ann_tag.setAttribute("name", name)

1250

ann_tag.setAttribute("value", value)

1251

tag.appendChild(ann_tag)

1252

# Add interface annotation tags

1253

for annotation, value in dict(

1254

itertools.chain.from_iterable(

1255

annotations().items()

1256

for name, annotations

1257

in self._get_all_dbus_things("interface")

1258

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

1259

)).items():

1260

ann_tag = document.createElement("annotation")

1261

ann_tag.setAttribute("name", annotation)

1262

ann_tag.setAttribute("value", value)

1263

if_tag.appendChild(ann_tag)

1264

# Fix argument name for the Introspect method itself

1265

if (if_tag.getAttribute("name")

1266

== dbus.INTROSPECTABLE_IFACE):

1267

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

1268

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

1269

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

1270

if (arg.getAttribute("direction")

1271

== "out"):

1272

arg.setAttribute("name",

1273

"xml_data")

1274

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

1275

document.unlink()

1276

except (AttributeError, xml.dom.DOMException,

1277

xml.parsers.expat.ExpatError) as error:

1278

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

1279

exc_info=error)

1280

return xmlstring

1281

1282

1283

class DBusObjectWithProperties(DBusObjectWithAnnotations):

793

class DBusObjectWithProperties(dbus.service.Object):

1284

794

"""A D-Bus object with properties.

1285

795

1286

796

Classes inheriting from this can use the dbus_service_property

1288

798

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

1289

799

"""

1290

800

801

@staticmethod

802

def _is_dbus_property(obj):

803

return getattr(obj, "_dbus_is_property", False)

804

805

def _get_all_dbus_properties(self):

806

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

807

"""

808

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

809

for cls in self.__class__.__mro__

810

for name, prop in

811

inspect.getmembers(cls, self._is_dbus_property))

812

1291

813

def _get_dbus_property(self, interface_name, property_name):

1292

814

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

1293

815

property with the specified name and interface.

1294

816

"""

1295

for cls in self.__class__.__mro__:

1296

for name, value in inspect.getmembers(

1297

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

817

for cls in self.__class__.__mro__:

818

for name, value in (inspect.getmembers

819

(cls, self._is_dbus_property)):

1298

820

if (value._dbus_name == property_name

1299

821

and value._dbus_interface == interface_name):

1300

822

return value.__get__(self)

1301

823

1302

824

# No such property

1303

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

1304

self.dbus_object_path, interface_name, property_name))

1305

1306

@classmethod

1307

def _get_all_interface_names(cls):

1308

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

1309

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

1310

"_dbus_interface", None)

1311

for x in (inspect.getmro(cls))

1312

for attr in dir(x))

1313

if name is not None)

1314

1315

@dbus.service.method(dbus.PROPERTIES_IFACE,

1316

in_signature="ss",

825

raise DBusPropertyNotFound(self.dbus_object_path + ":"

826

+ interface_name + "."

827

+ property_name)

828

829

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

1317

830

out_signature="v")

1318

831

def Get(self, interface_name, property_name):

1319

832

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

1337

850

# The byte_arrays option is not supported yet on

1338

851

# signatures other than "ay".

1339

852

if prop._dbus_signature != "ay":

1340

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

1341

"'ay' signature {!r}"

1342

.format(prop._dbus_signature))

853

raise ValueError

1343

854

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

1344

855

for byte in value))

1345

856

prop(value)

1346

857

1347

@dbus.service.method(dbus.PROPERTIES_IFACE,

1348

in_signature="s",

858

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

1349

859

out_signature="a{sv}")

1350

860

def GetAll(self, interface_name):

1351

861

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

1354

864

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

1355

865

"""

1356

866

properties = {}

1357

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

867

for name, prop in self._get_all_dbus_properties():

1358

868

if (interface_name

1359

869

and interface_name != prop._dbus_interface):

1360

870

# Interface non-empty but did not match

1366

876

if not hasattr(value, "variant_level"):

1367

877

properties[name] = value

1368

878

continue

1369

properties[name] = type(value)(

1370

value, variant_level = value.variant_level + 1)

879

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

880

value.variant_level+1)

1371

881

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

1372

882

1373

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

1374

def PropertiesChanged(self, interface_name, changed_properties,

1375

invalidated_properties):

1376

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

1377

standard.

1378

"""

1379

pass

1380

1381

883

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1382

884

out_signature="s",

1383

885

path_keyword='object_path',

1384

886

connection_keyword='connection')

1385

887

def Introspect(self, object_path, connection):

1386

"""Overloading of standard D-Bus method.

1387

1388

Inserts property tags and interface annotation tags.

888

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

1389

889

"""

1390

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1391

object_path,

1392

connection)

890

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

891

connection)

1393

892

try:

1394

893

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

1395

1396

894

def make_tag(document, name, prop):

1397

895

e = document.createElement("property")

1398

896

e.setAttribute("name", name)

1399

897

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

1400

898

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

1401

899

return e

1402

1403

900

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

1404

# Add property tags

1405

901

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

1406

902

for name, prop

1407

in self._get_all_dbus_things("property")

903

in self._get_all_dbus_properties()

1408

904

if prop._dbus_interface

1409

905

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

1410

906

if_tag.appendChild(tag)

1411

# Add annotation tags for properties

1412

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

1413

annots = dict()

1414

for name, prop in self._get_all_dbus_things(

1415

"property"):

1416

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

1417

and prop._dbus_interface

1418

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

1419

annots.update(getattr(

1420

prop, "_dbus_annotations", {}))

1421

for name, value in annots.items():

1422

ann_tag = document.createElement(

1423

"annotation")

1424

ann_tag.setAttribute("name", name)

1425

ann_tag.setAttribute("value", value)

1426

tag.appendChild(ann_tag)

1427

907

# Add the names to the return values for the

1428

908

# "org.freedesktop.DBus.Properties" methods

1429

909

if (if_tag.getAttribute("name")

1444

924

except (AttributeError, xml.dom.DOMException,

1445

925

xml.parsers.expat.ExpatError) as error:

1446

926

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

1447

exc_info=error)

1448

return xmlstring

1449

1450

try:

1451

dbus.OBJECT_MANAGER_IFACE

1452

except AttributeError:

1453

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

1454

1455

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1456

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

1457

1458

Classes inheriting from this exposes the standard

1459

GetManagedObjects call and the InterfacesAdded and

1460

InterfacesRemoved signals on the standard

1461

"org.freedesktop.DBus.ObjectManager" interface.

1462

1463

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

1464

manually.

1465

"""

1466

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1467

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

1468

def GetManagedObjects(self):

1469

"""This function must be overridden"""

1470

raise NotImplementedError()

1471

1472

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1473

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

1474

def InterfacesAdded(self, object_path, interfaces_and_properties):

1475

pass

1476

1477

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

1478

def InterfacesRemoved(self, object_path, interfaces):

1479

pass

1480

1481

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1482

out_signature = "s",

1483

path_keyword = 'object_path',

1484

connection_keyword = 'connection')

1485

def Introspect(self, object_path, connection):

1486

"""Overloading of standard D-Bus method.

1487

1488

Override return argument name of GetManagedObjects to be

1489

"objpath_interfaces_and_properties"

1490

"""

1491

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1492

object_path,

1493

connection)

1494

try:

1495

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

1496

1497

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

1498

# Fix argument name for the GetManagedObjects method

1499

if (if_tag.getAttribute("name")

1500

== dbus.OBJECT_MANAGER_IFACE):

1501

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

1502

if (cn.getAttribute("name")

1503

== "GetManagedObjects"):

1504

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

1505

if (arg.getAttribute("direction")

1506

== "out"):

1507

arg.setAttribute(

1508

"name",

1509

"objpath_interfaces"

1510

"_and_properties")

1511

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

1512

document.unlink()

1513

except (AttributeError, xml.dom.DOMException,

1514

xml.parsers.expat.ExpatError) as error:

1515

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

1516

exc_info = error)

1517

return xmlstring

1518

1519

def datetime_to_dbus(dt, variant_level=0):

927

error)

928

return xmlstring

929

930

931

def datetime_to_dbus (dt, variant_level=0):

1520

932

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

1521

933

if dt is None:

1522

934

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

1523

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

1524

1525

1526

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1527

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

1528

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

1529

interface names according to the "alt_interface_names" mapping.

1530

Usage:

1531

1532

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

1533

"net.example.AlternateInterface"})

1534

class SampleDBusObject(dbus.service.Object):

1535

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

1536

def SampleDBusMethod():

1537

pass

1538

1539

The above "SampleDBusMethod" on "SampleDBusObject" will be

1540

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

1541

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

1542

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

1543

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

1544

1545

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

1546

(from DBusObjectWithProperties) and interfaces (from the

1547

dbus_interface_annotations decorator).

935

return dbus.String(dt.isoformat(),

936

variant_level=variant_level)

937

938

939

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

940

.__metaclass__):

941

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

942

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

1548

943

"""

1549

1550

def wrapper(cls):

1551

for orig_interface_name, alt_interface_name in (

1552

alt_interface_names.items()):

1553

attr = {}

1554

interface_names = set()

1555

# Go though all attributes of the class

1556

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

944

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

945

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

946

# methods, signals, or properties in them

947

for base in (b for b in bases

948

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

949

# Go though all attributes of the base class

950

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

1557

951

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

1558

952

# with the wrong interface name

1559

953

if (not hasattr(attribute, "_dbus_interface")

1560

or not attribute._dbus_interface.startswith(

1561

orig_interface_name)):

954

or not attribute._dbus_interface

955

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

1562

956

continue

1563

957

# Create an alternate D-Bus interface name based on

1564

958

# the current name

1565

alt_interface = attribute._dbus_interface.replace(

1566

orig_interface_name, alt_interface_name)

1567

interface_names.add(alt_interface)

959

alt_interface = (attribute._dbus_interface

960

.replace("se.recompile.Mandos",

961

"se.bsnet.fukt.Mandos"))

1568

962

# Is this a D-Bus signal?

1569

963

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

1570

# Extract the original non-method undecorated

1571

# function by black magic

1572

if sys.version_info.major == 2:

1573

nonmethod_func = (dict(

964

# Extract the original non-method function by

965

# black magic

966

nonmethod_func = (dict(

1574

967

zip(attribute.func_code.co_freevars,

1575

attribute.__closure__))

1576

["func"].cell_contents)

1577

else:

1578

nonmethod_func = (dict(

1579

zip(attribute.__code__.co_freevars,

1580

attribute.__closure__))

1581

["func"].cell_contents)

968

attribute.__closure__))["func"]

969

.cell_contents)

1582

970

# Create a new, but exactly alike, function

1583

971

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

1584

972

# with the alternate D-Bus interface name

1585

new_function = copy_function(nonmethod_func)

1586

new_function = (dbus.service.signal(

1587

alt_interface,

1588

attribute._dbus_signature)(new_function))

1589

# Copy annotations, if any

1590

try:

1591

new_function._dbus_annotations = dict(

1592

attribute._dbus_annotations)

1593

except AttributeError:

1594

pass

973

new_function = (dbus.service.signal

974

(alt_interface,

975

attribute._dbus_signature)

976

(types.FunctionType(

977

nonmethod_func.func_code,

978

nonmethod_func.func_globals,

979

nonmethod_func.func_name,

980

nonmethod_func.func_defaults,

981

nonmethod_func.func_closure)))

1595

982

# Define a creator of a function to call both the

1596

# original and alternate functions, so both the

1597

# original and alternate signals gets sent when

1598

# the function is called

983

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

984

# signals gets sent when the function is called

1599

985

def fixscope(func1, func2):

1600

986

"""This function is a scope container to pass

1601

987

func1 and func2 to the "call_both" function

1602

988

outside of its arguments"""

1603

1604

@functools.wraps(func2)

1605

989

def call_both(*args, **kwargs):

1606

990

"""This function will emit two D-Bus

1607

991

signals by calling func1 and func2"""

1608

992

func1(*args, **kwargs)

1609

993

func2(*args, **kwargs)

1610

# Make wrapper function look like a D-Bus signal

1611

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

1612

if name.startswith("_dbus_"):

1613

setattr(call_both, name, attr)

1614

1615

994

return call_both

1616

995

# Create the "call_both" function and add it to

1617

996

# the class

1618

attr[attrname] = fixscope(attribute, new_function)

997

attr[attrname] = fixscope(attribute,

998

new_function)

1619

999

# Is this a D-Bus method?

1620

1000

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

1621

1001

# Create a new, but exactly alike, function

1622

1002

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

1623

1003

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

1624

1004

# to the class.

1625

attr[attrname] = (

1626

dbus.service.method(

1627

alt_interface,

1628

attribute._dbus_in_signature,

1629

attribute._dbus_out_signature)

1630

(copy_function(attribute)))

1631

# Copy annotations, if any

1632

try:

1633

attr[attrname]._dbus_annotations = dict(

1634

attribute._dbus_annotations)

1635

except AttributeError:

1636

pass

1005

attr[attrname] = (dbus.service.method

1006

(alt_interface,

1007

attribute._dbus_in_signature,

1008

attribute._dbus_out_signature)

1009

(types.FunctionType

1010

(attribute.func_code,

1011

attribute.func_globals,

1012

attribute.func_name,

1013

attribute.func_defaults,

1014

attribute.func_closure)))

1637

1015

# Is this a D-Bus property?

1638

1016

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

1639

1017

# Create a new, but exactly alike, function

1640

1018

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

1641

1019

# property with the alternate D-Bus interface

1642

1020

# name. Add it to the class.

1643

attr[attrname] = (dbus_service_property(

1644

alt_interface, attribute._dbus_signature,

1645

attribute._dbus_access,

1646

attribute._dbus_get_args_options

1647

["byte_arrays"])

1648

(copy_function(attribute)))

1649

# Copy annotations, if any

1650

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1653

except AttributeError:

1654

pass

1655

# Is this a D-Bus interface?

1656

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

1657

# Create a new, but exactly alike, function

1658

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

1659

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

1660

# to the class.

1661

attr[attrname] = (

1662

dbus_interface_annotations(alt_interface)

1663

(copy_function(attribute)))

1664

if deprecate:

1665

# Deprecate all alternate interfaces

1666

iname="_AlternateDBusNames_interface_annotation{}"

1667

for interface_name in interface_names:

1668

1669

@dbus_interface_annotations(interface_name)

1670

def func(self):

1671

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

1672

"true" }

1673

# Find an unused name

1674

for aname in (iname.format(i)

1675

for i in itertools.count()):

1676

if aname not in attr:

1677

attr[aname] = func

1678

break

1679

if interface_names:

1680

# Replace the class with a new subclass of it with

1681

# methods, signals, etc. as created above.

1682

if sys.version_info.major == 2:

1683

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

1684

(cls, ), attr)

1685

else:

1686

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

1687

(cls, ), attr)

1688

return cls

1689

1690

return wrapper

1691

1692

1693

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

1694

"se.bsnet.fukt.Mandos"})

1021

attr[attrname] = (dbus_service_property

1022

(alt_interface,

1023

attribute._dbus_signature,

1024

attribute._dbus_access,

1025

attribute

1026

._dbus_get_args_options

1027

["byte_arrays"])

1028

(types.FunctionType

1029

(attribute.func_code,

1030

attribute.func_globals,

1031

attribute.func_name,

1032

attribute.func_defaults,

1033

attribute.func_closure)))

1034

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

1035

1036

1695

1037

class ClientDBus(Client, DBusObjectWithProperties):

1696

1038

"""A Client class using D-Bus

1697

1039

1701

1043

"""

1702

1044

1703

1045

runtime_expansions = (Client.runtime_expansions

1704

+ ("dbus_object_path", ))

1705

1706

_interface = "se.recompile.Mandos.Client"

1046

+ ("dbus_object_path",))

1707

1047

1708

1048

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

1709

1049

1712

1052

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

1713

1053

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

1714

1054

# the D-Bus

1715

client_object_name = str(self.name).translate(

1055

client_object_name = unicode(self.name).translate(

1716

1056

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

1717

1057

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

1718

self.dbus_object_path = dbus.ObjectPath(

1719

"/clients/" + client_object_name)

1058

self.dbus_object_path = (dbus.ObjectPath

1059

("/clients/" + client_object_name))

1720

1060

DBusObjectWithProperties.__init__(self, self.bus,

1721

1061

self.dbus_object_path)

1722

1723

def notifychangeproperty(transform_func, dbus_name,

1724

type_func=lambda x: x,

1725

variant_level=1,

1726

invalidate_only=False,

1727

_interface=_interface):

1062

1063

def notifychangeproperty(transform_func,

1064

dbus_name, type_func=lambda x: x,

1065

variant_level=1):

1728

1066

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

1729

1067

its changes to DBus.

1730

1068

1735

1073

to the D-Bus. Default: no transform

1736

1074

variant_level: D-Bus variant level. Default: 1

1737

1075

"""

1738

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

1739

1076

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

1740

1077

def setter(self, value):

1741

1078

if hasattr(self, "dbus_object_path"):

1742

1079

if (not hasattr(self, attrname) or

1743

1080

type_func(getattr(self, attrname, None))

1744

1081

!= type_func(value)):

1745

if invalidate_only:

1746

self.PropertiesChanged(

1747

_interface, dbus.Dictionary(),

1748

dbus.Array((dbus_name, )))

1749

else:

1750

dbus_value = transform_func(

1751

type_func(value),

1752

variant_level = variant_level)

1753

self.PropertyChanged(dbus.String(dbus_name),

1754

dbus_value)

1755

self.PropertiesChanged(

1756

_interface,

1757

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

1758

dbus_value }),

1759

dbus.Array())

1082

dbus_value = transform_func(type_func(value),

1083

variant_level

1084

=variant_level)

1085

self.PropertyChanged(dbus.String(dbus_name),

1086

dbus_value)

1760

1087

setattr(self, attrname, value)

1761

1088

1762

1089

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

1763

1090

1091

1764

1092

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1765

1093

approvals_pending = notifychangeproperty(dbus.Boolean,

1766

1094

"ApprovalPending",

1768

1096

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

1769

1097

last_enabled = notifychangeproperty(datetime_to_dbus,

1770

1098

"LastEnabled")

1771

checker = notifychangeproperty(

1772

dbus.Boolean, "CheckerRunning",

1773

type_func = lambda checker: checker is not None)

1099

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

1100

type_func = lambda checker:

1101

checker is not None)

1774

1102

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1775

1103

"LastCheckedOK")

1776

1104

last_checker_status = notifychangeproperty(dbus.Int16,

1779

1107

datetime_to_dbus, "LastApprovalRequest")

1780

1108

approved_by_default = notifychangeproperty(dbus.Boolean,

1781

1109

"ApprovedByDefault")

1782

approval_delay = notifychangeproperty(

1783

dbus.UInt64, "ApprovalDelay",

1784

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

1110

approval_delay = notifychangeproperty(dbus.UInt64,

1111

"ApprovalDelay",

1112

type_func =

1113

timedelta_to_milliseconds)

1785

1114

approval_duration = notifychangeproperty(

1786

1115

dbus.UInt64, "ApprovalDuration",

1787

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

1116

type_func = timedelta_to_milliseconds)

1788

1117

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

1789

timeout = notifychangeproperty(

1790

dbus.UInt64, "Timeout",

1791

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

1118

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

1119

type_func =

1120

timedelta_to_milliseconds)

1792

1121

extended_timeout = notifychangeproperty(

1793

1122

dbus.UInt64, "ExtendedTimeout",

1794

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

1795

interval = notifychangeproperty(

1796

dbus.UInt64, "Interval",

1797

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

1123

type_func = timedelta_to_milliseconds)

1124

interval = notifychangeproperty(dbus.UInt64,

1125

"Interval",

1126

type_func =

1127

timedelta_to_milliseconds)

1798

1128

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

1799

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

1800

invalidate_only=True)

1801

1129

1802

1130

del notifychangeproperty

1803

1131

1810

1138

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

1811

1139

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

1812

1140

1813

def checker_callback(self, source, condition,

1814

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

1815

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

1816

connection, command, *args,

1817

**kwargs)

1818

exitstatus = self.last_checker_status

1819

if exitstatus >= 0:

1141

def checker_callback(self, pid, condition, command,

1142

*args, **kwargs):

1143

self.checker_callback_tag = None

1144

self.checker = None

1145

if os.WIFEXITED(condition):

1146

exitstatus = os.WEXITSTATUS(condition)

1820

1147

# Emit D-Bus signal

1821

1148

self.CheckerCompleted(dbus.Int16(exitstatus),

1822

# This is specific to GNU libC

1823

dbus.Int64(exitstatus << 8),

1149

dbus.Int64(condition),

1824

1150

dbus.String(command))

1825

1151

else:

1826

1152

# Emit D-Bus signal

1827

1153

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

1828

dbus.Int64(

1829

# This is specific to GNU libC

1830

(exitstatus << 8)

1831

| self.last_checker_signal),

1154

dbus.Int64(condition),

1832

1155

dbus.String(command))

1833

return ret

1156

1157

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

1158

*args, **kwargs)

1834

1159

1835

1160

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

1836

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

1161

old_checker = self.checker

1162

if self.checker is not None:

1163

old_checker_pid = self.checker.pid

1164

else:

1165

old_checker_pid = None

1837

1166

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

1838

1167

# Only if new checker process was started

1839

1168

if (self.checker is not None

1847

1176

return False

1848

1177

1849

1178

def approve(self, value=True):

1179

self.send_changedstate()

1850

1180

self.approved = value

1851

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

1852

* 1000), self._reset_approved)

1853

self.send_changedstate()

1181

gobject.timeout_add(timedelta_to_milliseconds

1182

(self.approval_duration),

1183

self._reset_approved)

1184

1854

1185

1855

1186

## D-Bus methods, signals & properties

1856

1857

## Interfaces

1187

_interface = "se.recompile.Mandos.Client"

1858

1188

1859

1189

## Signals

1860

1190

1871

1201

pass

1872

1202

1873

1203

# PropertyChanged - signal

1874

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

1875

1204

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

1876

1205

def PropertyChanged(self, property, value):

1877

1206

"D-Bus signal"

1911

1240

self.checked_ok()

1912

1241

1913

1242

# Enable - method

1914

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

1915

1243

@dbus.service.method(_interface)

1916

1244

def Enable(self):

1917

1245

"D-Bus method"

1918

1246

self.enable()

1919

1247

1920

1248

# StartChecker - method

1921

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

1922

1249

@dbus.service.method(_interface)

1923

1250

def StartChecker(self):

1924

1251

"D-Bus method"

1925

1252

self.start_checker()

1926

1253

1927

1254

# Disable - method

1928

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

1929

1255

@dbus.service.method(_interface)

1930

1256

def Disable(self):

1931

1257

"D-Bus method"

1932

1258

self.disable()

1933

1259

1934

1260

# StopChecker - method

1935

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

1936

1261

@dbus.service.method(_interface)

1937

1262

def StopChecker(self):

1938

1263

self.stop_checker()

1945

1270

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

1946

1271

1947

1272

# ApprovedByDefault - property

1948

@dbus_service_property(_interface,

1949

signature="b",

1273

@dbus_service_property(_interface, signature="b",

1950

1274

access="readwrite")

1951

1275

def ApprovedByDefault_dbus_property(self, value=None):

1952

1276

if value is None: # get

1954

1278

self.approved_by_default = bool(value)

1955

1279

1956

1280

# ApprovalDelay - property

1957

@dbus_service_property(_interface,

1958

signature="t",

1281

@dbus_service_property(_interface, signature="t",

1959

1282

access="readwrite")

1960

1283

def ApprovalDelay_dbus_property(self, value=None):

1961

1284

if value is None: # get

1962

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

1963

* 1000)

1285

return dbus.UInt64(self.approval_delay_milliseconds())

1964

1286

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

1965

1287

1966

1288

# ApprovalDuration - property

1967

@dbus_service_property(_interface,

1968

signature="t",

1289

@dbus_service_property(_interface, signature="t",

1969

1290

access="readwrite")

1970

1291

def ApprovalDuration_dbus_property(self, value=None):

1971

1292

if value is None: # get

1972

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

1973

* 1000)

1293

return dbus.UInt64(timedelta_to_milliseconds(

1294

self.approval_duration))

1974

1295

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

1975

1296

1976

1297

# Name - property

1977

@dbus_annotations(

1978

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

1979

1298

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

1980

1299

def Name_dbus_property(self):

1981

1300

return dbus.String(self.name)

1982

1301

1983

1302

# Fingerprint - property

1984

@dbus_annotations(

1985

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

1986

1303

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

1987

1304

def Fingerprint_dbus_property(self):

1988

1305

return dbus.String(self.fingerprint)

1989

1306

1990

1307

# Host - property

1991

@dbus_service_property(_interface,

1992

signature="s",

1308

@dbus_service_property(_interface, signature="s",

1993

1309

access="readwrite")

1994

1310

def Host_dbus_property(self, value=None):

1995

1311

if value is None: # get

1996

1312

return dbus.String(self.host)

1997

self.host = str(value)

1313

self.host = unicode(value)

1998

1314

1999

1315

# Created - property

2000

@dbus_annotations(

2001

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

2002

1316

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

2003

1317

def Created_dbus_property(self):

2004

1318

return datetime_to_dbus(self.created)

2009

1323

return datetime_to_dbus(self.last_enabled)

2010

1324

2011

1325

# Enabled - property

2012

@dbus_service_property(_interface,

2013

signature="b",

1326

@dbus_service_property(_interface, signature="b",

2014

1327

access="readwrite")

2015

1328

def Enabled_dbus_property(self, value=None):

2016

1329

if value is None: # get

2021

1334

self.disable()

2022

1335

2023

1336

# LastCheckedOK - property

2024

@dbus_service_property(_interface,

2025

signature="s",

1337

@dbus_service_property(_interface, signature="s",

2026

1338

access="readwrite")

2027

1339

def LastCheckedOK_dbus_property(self, value=None):

2028

1340

if value is not None:

2031

1343

return datetime_to_dbus(self.last_checked_ok)

2032

1344

2033

1345

# LastCheckerStatus - property

2034

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

1346

@dbus_service_property(_interface, signature="n",

1347

access="read")

2035

1348

def LastCheckerStatus_dbus_property(self):

2036

1349

return dbus.Int16(self.last_checker_status)

2037

1350

2046

1359

return datetime_to_dbus(self.last_approval_request)

2047

1360

2048

1361

# Timeout - property

2049

@dbus_service_property(_interface,

2050

signature="t",

1362

@dbus_service_property(_interface, signature="t",

2051

1363

access="readwrite")

2052

1364

def Timeout_dbus_property(self, value=None):

2053

1365

if value is None: # get

2054

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

2055

old_timeout = self.timeout

1366

return dbus.UInt64(self.timeout_milliseconds())

2056

1367

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

2057

# Reschedule disabling

1368

# Reschedule timeout

2058

1369

if self.enabled:

2059

1370

now = datetime.datetime.utcnow()

2060

self.expires += self.timeout - old_timeout

2061

if self.expires <= now:

1371

time_to_die = timedelta_to_milliseconds(

1372

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

1373

if time_to_die <= 0:

2062

1374

# The timeout has passed

2063

1375

self.disable()

2064

1376

else:

1377

self.expires = (now +

1378

datetime.timedelta(milliseconds =

1379

time_to_die))

2065

1380

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

2066

1381

is None):

2067

1382

return

2068

GLib.source_remove(self.disable_initiator_tag)

2069

self.disable_initiator_tag = GLib.timeout_add(

2070

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

2071

self.disable)

1383

gobject.source_remove(self.disable_initiator_tag)

1384

self.disable_initiator_tag = (gobject.timeout_add

1385

(time_to_die,

1386

self.disable))

2072

1387

2073

1388

# ExtendedTimeout - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1389

@dbus_service_property(_interface, signature="t",

2076

1390

access="readwrite")

2077

1391

def ExtendedTimeout_dbus_property(self, value=None):

2078

1392

if value is None: # get

2079

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

2080

* 1000)

1393

return dbus.UInt64(self.extended_timeout_milliseconds())

2081

1394

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

2082

1395

2083

1396

# Interval - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1397

@dbus_service_property(_interface, signature="t",

2086

1398

access="readwrite")

2087

1399

def Interval_dbus_property(self, value=None):

2088

1400

if value is None: # get

2089

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

1401

return dbus.UInt64(self.interval_milliseconds())

2090

1402

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

2091

1403

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

2092

1404

return

2093

1405

if self.enabled:

2094

1406

# Reschedule checker run

2095

GLib.source_remove(self.checker_initiator_tag)

2096

self.checker_initiator_tag = GLib.timeout_add(

2097

value, self.start_checker)

2098

self.start_checker() # Start one now, too

1407

gobject.source_remove(self.checker_initiator_tag)

1408

self.checker_initiator_tag = (gobject.timeout_add

1409

(value, self.start_checker))

1410

self.start_checker() # Start one now, too

2099

1411

2100

1412

# Checker - property

2101

@dbus_service_property(_interface,

2102

signature="s",

1413

@dbus_service_property(_interface, signature="s",

2103

1414

access="readwrite")

2104

1415

def Checker_dbus_property(self, value=None):

2105

1416

if value is None: # get

2106

1417

return dbus.String(self.checker_command)

2107

self.checker_command = str(value)

1418

self.checker_command = unicode(value)

2108

1419

2109

1420

# CheckerRunning - property

2110

@dbus_service_property(_interface,

2111

signature="b",

1421

@dbus_service_property(_interface, signature="b",

2112

1422

access="readwrite")

2113

1423

def CheckerRunning_dbus_property(self, value=None):

2114

1424

if value is None: # get

2119

1429

self.stop_checker()

2120

1430

2121

1431

# ObjectPath - property

2122

@dbus_annotations(

2123

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

2124

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

2125

1432

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

2126

1433

def ObjectPath_dbus_property(self):

2127

1434

return self.dbus_object_path # is already a dbus.ObjectPath

2128

1435

2129

1436

# Secret = property

2130

@dbus_annotations(

2131

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

2132

"invalidates"})

2133

@dbus_service_property(_interface,

2134

signature="ay",

2135

access="write",

2136

byte_arrays=True)

1437

@dbus_service_property(_interface, signature="ay",

1438

access="write", byte_arrays=True)

2137

1439

def Secret_dbus_property(self, value):

2138

self.secret = bytes(value)

1440

self.secret = str(value)

2139

1441

2140

1442

del _interface

2141

1443

2145

1447

self._pipe = child_pipe

2146

1448

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

2147

1449

if not self._pipe.recv():

2148

raise KeyError(fpr)

1450

raise KeyError()

2149

1451

2150

1452

def __getattribute__(self, name):

2151

1453

if name == '_pipe':

2155

1457

if data[0] == 'data':

2156

1458

return data[1]

2157

1459

if data[0] == 'function':

2158

2159

1460

def func(*args, **kwargs):

2160

1461

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

2161

1462

return self._pipe.recv()[1]

2162

2163

1463

return func

2164

1464

2165

1465

def __setattr__(self, name, value):

2168

1468

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

2169

1469

2170

1470

1471

class ClientDBusTransitional(ClientDBus):

1472

__metaclass__ = AlternateDBusNamesMetaclass

1473

1474

2171

1475

class ClientHandler(socketserver.BaseRequestHandler, object):

2172

1476

"""A class to handle client connections.

2173

1477

2177

1481

def handle(self):

2178

1482

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

2179

1483

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

2180

str(self.client_address))

1484

unicode(self.client_address))

2181

1485

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

2182

1486

self.server.child_pipe.fileno())

2183

1487

2184

session = gnutls.ClientSession(self.request)

1488

session = (gnutls.connection

1489

.ClientSession(self.request,

1490

gnutls.connection

1491

.X509Credentials()))

1492

1493

# Note: gnutls.connection.X509Credentials is really a

1494

# generic GnuTLS certificate credentials object so long as

1495

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

1496

# here despite using OpenPGP certificates.

2185

1497

2186

1498

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

2187

1499

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

2191

1503

priority = self.server.gnutls_priority

2192

1504

if priority is None:

2193

1505

priority = "NORMAL"

2194

gnutls.priority_set_direct(session._c_object,

2195

priority.encode("utf-8"),

2196

None)

1506

(gnutls.library.functions

1507

.gnutls_priority_set_direct(session._c_object,

1508

priority, None))

2197

1509

2198

1510

# Start communication using the Mandos protocol

2199

1511

# Get protocol number

2201

1513

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

2202

1514

try:

2203

1515

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

2204

raise RuntimeError(line)

1516

raise RuntimeError

2205

1517

except (ValueError, IndexError, RuntimeError) as error:

2206

1518

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

2207

1519

return

2209

1521

# Start GnuTLS connection

2210

1522

try:

2211

1523

session.handshake()

2212

except gnutls.Error as error:

1524

except gnutls.errors.GNUTLSError as error:

2213

1525

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

2214

1526

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

2215

1527

# established. Just abandon the request.

2219

1531

approval_required = False

2220

1532

try:

2221

1533

try:

2222

fpr = self.fingerprint(

2223

self.peer_certificate(session))

2224

except (TypeError, gnutls.Error) as error:

1534

fpr = self.fingerprint(self.peer_certificate

1535

(session))

1536

except (TypeError,

1537

gnutls.errors.GNUTLSError) as error:

2225

1538

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

2226

1539

return

2227

1540

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

2240

1553

while True:

2241

1554

if not client.enabled:

2242

1555

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

2243

client.name)

1556

client.name)

2244

1557

if self.server.use_dbus:

2245

1558

# Emit D-Bus signal

2246

1559

client.Rejected("Disabled")

2255

1568

if self.server.use_dbus:

2256

1569

# Emit D-Bus signal

2257

1570

client.NeedApproval(

2258

client.approval_delay.total_seconds()

2259

* 1000, client.approved_by_default)

1571

client.approval_delay_milliseconds(),

1572

client.approved_by_default)

2260

1573

else:

2261

1574

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

2262

1575

client.name)

2268

1581

#wait until timeout or approved

2269

1582

time = datetime.datetime.now()

2270

1583

client.changedstate.acquire()

2271

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

1584

(client.changedstate.wait

1585

(float(client.timedelta_to_milliseconds(delay)

1586

/ 1000)))

2272

1587

client.changedstate.release()

2273

1588

time2 = datetime.datetime.now()

2274

1589

if (time2 - time) >= delay:

2285

1600

else:

2286

1601

delay -= time2 - time

2287

1602

2288

try:

2289

session.send(client.secret)

2290

except gnutls.Error as error:

2291

logger.warning("gnutls send failed",

2292

exc_info = error)

2293

return

1603

sent_size = 0

1604

while sent_size < len(client.secret):

1605

try:

1606

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

1607

except gnutls.errors.GNUTLSError as error:

1608

logger.warning("gnutls send failed")

1609

return

1610

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

1611

sent, len(client.secret)

1612

- (sent_size + sent))

1613

sent_size += sent

2294

1614

2295

1615

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

2296

1616

# bump the timeout using extended_timeout

2304

1624

client.approvals_pending -= 1

2305

1625

try:

2306

1626

session.bye()

2307

except gnutls.Error as error:

2308

logger.warning("GnuTLS bye failed",

2309

exc_info=error)

1627

except gnutls.errors.GNUTLSError as error:

1628

logger.warning("GnuTLS bye failed")

2310

1629

2311

1630

@staticmethod

2312

1631

def peer_certificate(session):

2313

1632

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

2314

1633

# If not an OpenPGP certificate...

2315

if (gnutls.certificate_type_get(session._c_object)

2316

!= gnutls.CRT_OPENPGP):

2317

# ...return invalid data

2318

return b""

1634

if (gnutls.library.functions

1635

.gnutls_certificate_type_get(session._c_object)

1636

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1637

# ...do the normal thing

1638

return session.peer_certificate

2319

1639

list_size = ctypes.c_uint(1)

2320

cert_list = (gnutls.certificate_get_peers

1640

cert_list = (gnutls.library.functions

1641

.gnutls_certificate_get_peers

2321

1642

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

2322

1643

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

2323

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

1644

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

1645

" certificate")

2324

1646

if list_size.value == 0:

2325

1647

return None

2326

1648

cert = cert_list[0]

2330

1652

def fingerprint(openpgp):

2331

1653

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2332

1654

# New GnuTLS "datum" with the OpenPGP public key

2333

datum = gnutls.datum_t(

2334

ctypes.cast(ctypes.c_char_p(openpgp),

2335

ctypes.POINTER(ctypes.c_ubyte)),

2336

ctypes.c_uint(len(openpgp)))

1655

datum = (gnutls.library.types

1656

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

1657

ctypes.POINTER

1658

(ctypes.c_ubyte)),

1659

ctypes.c_uint(len(openpgp))))

2337

1660

# New empty GnuTLS certificate

2338

crt = gnutls.openpgp_crt_t()

2339

gnutls.openpgp_crt_init(ctypes.byref(crt))

1661

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2340

1664

# Import the OpenPGP public key into the certificate

2341

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

2342

gnutls.OPENPGP_FMT_RAW)

1665

(gnutls.library.functions

1666

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

1667

gnutls.library.constants

1668

.GNUTLS_OPENPGP_FMT_RAW))

2343

1669

# Verify the self signature in the key

2344

1670

crtverify = ctypes.c_uint()

2345

gnutls.openpgp_crt_verify_self(crt, 0,

2346

ctypes.byref(crtverify))

1671

(gnutls.library.functions

1672

.gnutls_openpgp_crt_verify_self(crt, 0,

1673

ctypes.byref(crtverify)))

2347

1674

if crtverify.value != 0:

2348

gnutls.openpgp_crt_deinit(crt)

2349

raise gnutls.CertificateSecurityError("Verify failed")

1675

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1676

raise (gnutls.errors.CertificateSecurityError

1677

("Verify failed"))

2350

1678

# New buffer for the fingerprint

2351

1679

buf = ctypes.create_string_buffer(20)

2352

1680

buf_len = ctypes.c_size_t()

2353

1681

# Get the fingerprint from the certificate into the buffer

2354

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

2355

ctypes.byref(buf_len))

1682

(gnutls.library.functions

1683

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

1684

ctypes.byref(buf_len)))

2356

1685

# Deinit the certificate

2357

gnutls.openpgp_crt_deinit(crt)

1686

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2358

1687

# Convert the buffer to a Python bytestring

2359

1688

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

2360

1689

# Convert the bytestring to hexadecimal notation

2364

1693

2365

1694

class MultiprocessingMixIn(object):

2366

1695

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

2367

2368

1696

def sub_process_main(self, request, address):

2369

1697

try:

2370

1698

self.finish_request(request, address)

2375

1703

def process_request(self, request, address):

2376

1704

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

2377

1705

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

2378

args = (request, address))

1706

args = (request,

1707

address))

2379

1708

proc.start()

2380

1709

return proc

2381

1710

2382

1711

2383

1712

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2384

1713

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

2385

2386

1714

def process_request(self, request, client_address):

2387

1715

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

2388

1716

2397

1725

2398

1726

def add_pipe(self, parent_pipe, proc):

2399

1727

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

2400

raise NotImplementedError()

1728

raise NotImplementedError

2401

1729

2402

1730

2403

1731

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2409

1737

interface: None or a network interface name (string)

2410

1738

use_ipv6: Boolean; to use IPv6 or not

2411

1739

"""

2412

2413

1740

def __init__(self, server_address, RequestHandlerClass,

2414

interface=None,

2415

use_ipv6=True,

2416

socketfd=None):

2417

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

2418

creating a new one with socket.socket().

2419

"""

1741

interface=None, use_ipv6=True):

2420

1742

self.interface = interface

2421

1743

if use_ipv6:

2422

1744

self.address_family = socket.AF_INET6

2423

if socketfd is not None:

2424

# Save the file descriptor

2425

self.socketfd = socketfd

2426

# Save the original socket.socket() function

2427

self.socket_socket = socket.socket

2428

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

2429

#

2430

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

2431

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

2432

# patching socket.socket.)

2433

#

2434

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

2435

@functools.wraps(socket.socket)

2436

def socket_wrapper(*args, **kwargs):

2437

# Restore original function so subsequent calls are

2438

# not affected.

2439

socket.socket = self.socket_socket

2440

del self.socket_socket

2441

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

2442

# saved file descriptor.

2443

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

2444

# Replace socket.socket() function with wrapper

2445

socket.socket = socket_wrapper

2446

# The socketserver.TCPServer.__init__ will call

2447

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

2448

# socket_wrapper(), if socketfd was set.

2449

1745

socketserver.TCPServer.__init__(self, server_address,

2450

1746

RequestHandlerClass)

2451

2452

1747

def server_bind(self):

2453

1748

"""This overrides the normal server_bind() function

2454

1749

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

2455

1750

bind to an address or port if they were not specified."""

2456

1751

if self.interface is not None:

2457

1752

if SO_BINDTODEVICE is None:

2458

# Fall back to a hard-coded value which seems to be

2459

# common enough.

2460

logger.warning("SO_BINDTODEVICE not found, trying 25")

2461

SO_BINDTODEVICE = 25

2462

try:

2463

self.socket.setsockopt(

2464

socket.SOL_SOCKET, SO_BINDTODEVICE,

2465

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

2466

except socket.error as error:

2467

if error.errno == errno.EPERM:

2468

logger.error("No permission to bind to"

2469

" interface %s", self.interface)

2470

elif error.errno == errno.ENOPROTOOPT:

2471

logger.error("SO_BINDTODEVICE not available;"

2472

" cannot bind to interface %s",

2473

self.interface)

2474

elif error.errno == errno.ENODEV:

2475

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

2476

" cannot bind", self.interface)

2477

else:

2478

raise

1753

logger.error("SO_BINDTODEVICE does not exist;"

1754

" cannot bind to interface %s",

1755

self.interface)

1756

else:

1757

try:

1758

self.socket.setsockopt(socket.SOL_SOCKET,

1759

SO_BINDTODEVICE,

1760

str(self.interface

1761

+ '\0'))

1762

except socket.error as error:

1763

if error[0] == errno.EPERM:

1764

logger.error("No permission to"

1765

" bind to interface %s",

1766

self.interface)

1767

elif error[0] == errno.ENOPROTOOPT:

1768

logger.error("SO_BINDTODEVICE not available;"

1769

" cannot bind to interface %s",

1770

self.interface)

1771

else:

1772

raise

2479

1773

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

2480

1774

if self.server_address[0] or self.server_address[1]:

2481

1775

if not self.server_address[0]:

2482

1776

if self.address_family == socket.AF_INET6:

2483

1777

any_address = "::" # in6addr_any

2484

1778

else:

2485

any_address = "0.0.0.0" # INADDR_ANY

1779

any_address = socket.INADDR_ANY

2486

1780

self.server_address = (any_address,

2487

1781

self.server_address[1])

2488

1782

elif not self.server_address[1]:

2489

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

1783

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

1784

0)

2490

1785

# if self.interface:

2491

1786

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

2492

1787

# 0, # port

2504

1799

gnutls_priority GnuTLS priority string

2505

1800

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

2506

1801

2507

Assumes a GLib.MainLoop event loop.

1802

Assumes a gobject.MainLoop event loop.

2508

1803

"""

2509

2510

1804

def __init__(self, server_address, RequestHandlerClass,

2511

interface=None,

2512

use_ipv6=True,

2513

clients=None,

2514

gnutls_priority=None,

2515

use_dbus=True,

2516

socketfd=None):

1805

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

1806

gnutls_priority=None, use_dbus=True):

2517

1807

self.enabled = False

2518

1808

self.clients = clients

2519

1809

if self.clients is None:

2523

1813

IPv6_TCPServer.__init__(self, server_address,

2524

1814

RequestHandlerClass,

2525

1815

interface = interface,

2526

use_ipv6 = use_ipv6,

2527

socketfd = socketfd)

2528

1816

use_ipv6 = use_ipv6)

2529

1817

def server_activate(self):

2530

1818

if self.enabled:

2531

1819

return socketserver.TCPServer.server_activate(self)

2535

1823

2536

1824

def add_pipe(self, parent_pipe, proc):

2537

1825

# Call "handle_ipc" for both data and EOF events

2538

GLib.io_add_watch(

2539

parent_pipe.fileno(),

2540

GLib.IO_IN | GLib.IO_HUP,

2541

functools.partial(self.handle_ipc,

2542

parent_pipe = parent_pipe,

2543

proc = proc))

1826

gobject.io_add_watch(parent_pipe.fileno(),

1827

gobject.IO_IN | gobject.IO_HUP,

1828

functools.partial(self.handle_ipc,

1829

parent_pipe =

1830

parent_pipe,

1831

proc = proc))

2544

1832

2545

def handle_ipc(self, source, condition,

2546

parent_pipe=None,

2547

proc = None,

2548

client_object=None):

1833

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

1834

proc = None, client_object=None):

1835

condition_names = {

1836

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

1837

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

1838

# blocking).

1839

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

1840

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

1841

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

1842

# broken, usually for pipes and

1843

# sockets).

1844

}

1845

conditions_string = ' | '.join(name

1846

for cond, name in

1847

condition_names.iteritems()

1848

if cond & condition)

2549

1849

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

2550

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

1850

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

2551

1851

# Wait for other process to exit

2552

1852

proc.join()

2553

1853

return False

2560

1860

fpr = request[1]

2561

1861

address = request[2]

2562

1862

2563

for c in self.clients.values():

1863

for c in self.clients.itervalues():

2564

1864

if c.fingerprint == fpr:

2565

1865

client = c

2566

1866

break

2574

1874

parent_pipe.send(False)

2575

1875

return False

2576

1876

2577

GLib.io_add_watch(

2578

parent_pipe.fileno(),

2579

GLib.IO_IN | GLib.IO_HUP,

2580

functools.partial(self.handle_ipc,

2581

parent_pipe = parent_pipe,

2582

proc = proc,

2583

client_object = client))

1877

gobject.io_add_watch(parent_pipe.fileno(),

1878

gobject.IO_IN | gobject.IO_HUP,

1879

functools.partial(self.handle_ipc,

1880

parent_pipe =

1881

parent_pipe,

1882

proc = proc,

1883

client_object =

1884

client))

2584

1885

parent_pipe.send(True)

2585

1886

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

2586

1887

# same fileno

2592

1893

2593

1894

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

2594

1895

funcname)(*args,

2595

**kwargs)))

1896

**kwargs)))

2596

1897

2597

1898

if command == 'getattr':

2598

1899

attrname = request[1]

2599

if isinstance(client_object.__getattribute__(attrname),

2600

collections.Callable):

2601

parent_pipe.send(('function', ))

1900

if callable(client_object.__getattribute__(attrname)):

1901

parent_pipe.send(('function',))

2602

1902

else:

2603

parent_pipe.send((

2604

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

1903

parent_pipe.send(('data', client_object

1904

.__getattribute__(attrname)))

2605

1905

2606

1906

if command == 'setattr':

2607

1907

attrname = request[1]

2611

1911

return True

2612

1912

2613

1913

2614

def rfc3339_duration_to_delta(duration):

2615

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

2616

2617

>>> rfc3339_duration_to_delta("P7D")

2618

datetime.timedelta(7)

2619

>>> rfc3339_duration_to_delta("PT60S")

2620

datetime.timedelta(0, 60)

2621

>>> rfc3339_duration_to_delta("PT60M")

2622

datetime.timedelta(0, 3600)

2623

>>> rfc3339_duration_to_delta("PT24H")

2624

datetime.timedelta(1)

2625

>>> rfc3339_duration_to_delta("P1W")

2626

datetime.timedelta(7)

2627

>>> rfc3339_duration_to_delta("PT5M30S")

2628

datetime.timedelta(0, 330)

2629

>>> rfc3339_duration_to_delta("P1DT3M20S")

2630

datetime.timedelta(1, 200)

2631

"""

2632

2633

# Parsing an RFC 3339 duration with regular expressions is not

2634

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

2635

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

2636

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

2637

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

2638

# avoid excessive use of external libraries.

2639

2640

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

2641

Token = collections.namedtuple("Token", (

2642

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

2643

# a "group" containing digits

2644

"value", # datetime.timedelta or None

2645

"followers")) # Tokens valid after this token

2646

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

2647

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

2648

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

2649

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

2650

datetime.timedelta(seconds=1),

2651

frozenset((token_end, )))

2652

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

2653

datetime.timedelta(minutes=1),

2654

frozenset((token_second, token_end)))

2655

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

2656

datetime.timedelta(hours=1),

2657

frozenset((token_minute, token_end)))

2658

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

2659

None,

2660

frozenset((token_hour, token_minute,

2661

token_second)))

2662

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

2663

datetime.timedelta(days=1),

2664

frozenset((token_time, token_end)))

2665

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

2666

datetime.timedelta(weeks=4),

2667

frozenset((token_day, token_end)))

2668

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

2669

datetime.timedelta(weeks=52),

2670

frozenset((token_month, token_end)))

2671

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

2672

datetime.timedelta(weeks=1),

2673

frozenset((token_end, )))

2674

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

2675

frozenset((token_year, token_month,

2676

token_day, token_time,

2677

token_week)))

2678

# Define starting values

2679

value = datetime.timedelta() # Value so far

2680

found_token = None

2681

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

2682

s = duration # String left to parse

2683

# Loop until end token is found

2684

while found_token is not token_end:

2685

# Search for any currently valid tokens

2686

for token in followers:

2687

match = token.regexp.match(s)

2688

if match is not None:

2689

# Token found

2690

if token.value is not None:

2691

# Value found, parse digits

2692

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

2693

# Add to value so far

2694

value += factor * token.value

2695

# Strip token from string

2696

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

2697

# Go to found token

2698

found_token = token

2699

# Set valid next tokens

2700

followers = found_token.followers

2701

break

2702

else:

2703

# No currently valid tokens were found

2704

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

2705

.format(duration))

2706

# End token found

2707

return value

2708

2709

2710

1914

def string_to_delta(interval):

2711

1915

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

2712

1916

2723

1927

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

2724

1928

datetime.timedelta(0, 330)

2725

1929

"""

2726

2727

try:

2728

return rfc3339_duration_to_delta(interval)

2729

except ValueError:

2730

pass

2731

2732

1930

timevalue = datetime.timedelta(0)

2733

1931

for s in interval.split():

2734

1932

try:

2735

suffix = s[-1]

1933

suffix = unicode(s[-1])

2736

1934

value = int(s[:-1])

2737

1935

if suffix == "d":

2738

1936

delta = datetime.timedelta(value)

2745

1943

elif suffix == "w":

2746

1944

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

2747

1945

else:

2748

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

2749

except IndexError as e:

1946

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

1947

except (ValueError, IndexError) as e:

2750

1948

raise ValueError(*(e.args))

2751

1949

timevalue += delta

2752

1950

return timevalue

2765

1963

sys.exit()

2766

1964

if not noclose:

2767

1965

# Close all standard open file descriptors

2768

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

1966

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

2769

1967

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

2770

1968

raise OSError(errno.ENODEV,

2771

"{} not a character device"

2772

.format(os.devnull))

1969

"%s not a character device"

1970

% os.path.devnull)

2773

1971

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

2774

1972

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

2775

1973

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

2784

1982

2785

1983

parser = argparse.ArgumentParser()

2786

1984

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

2787

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

1985

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

2788

1986

help="show version number and exit")

2789

1987

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

2790

1988

help="Bind to interface IF")

2796

1994

help="Run self-test")

2797

1995

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

2798

1996

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

2799

" to terminal", default=None)

1997

" to terminal")

2800

1998

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

2801

1999

help="Debug level for stdout output")

2802

2000

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

2809

2007

" files")

2810

2008

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

2811

2009

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

2812

" system bus interface", default=None)

2010

" system bus interface")

2813

2011

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

2814

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

2815

default=None)

2012

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

2816

2013

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

2817

2014

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

2818

" state", default=None)

2819

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

2820

help="Specify a file descriptor to a network"

2821

" socket to use instead of creating one")

2015

" state")

2822

2016

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

2823

2017

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

2824

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

2825

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

2826

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

2827

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

2828

default=None)

2829

2018

2830

2019

options = parser.parse_args()

2831

2020

2832

2021

if options.check:

2833

2022

import doctest

2834

fail_count, test_count = doctest.testmod()

2835

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

2023

doctest.testmod()

2024

sys.exit()

2836

2025

2837

2026

# Default values for config file for server-global settings

2838

2027

server_defaults = { "interface": "",

2840

2029

"port": "",

2841

2030

"debug": "False",

2842

2031

"priority":

2843

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

2844

":+SIGN-DSA-SHA256",

2032

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

2845

2033

"servicename": "Mandos",

2846

2034

"use_dbus": "True",

2847

2035

"use_ipv6": "True",

2848

2036

"debuglevel": "",

2849

2037

"restore": "True",

2850

"socket": "",

2851

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

2852

"foreground": "False",

2853

"zeroconf": "True",

2854

}

2038

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

2039

}

2855

2040

2856

2041

# Parse config file for server-global settings

2857

2042

server_config = configparser.SafeConfigParser(server_defaults)

2858

2043

del server_defaults

2859

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

2044

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

2045

"mandos.conf"))

2860

2046

# Convert the SafeConfigParser object to a dict

2861

2047

server_settings = server_config.defaults()

2862

2048

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

2863

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

2049

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

2864

2050

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

2865

2051

option)

2866

2052

if server_settings["port"]:

2867

2053

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

2868

2054

"port")

2869

if server_settings["socket"]:

2870

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

2871

"socket")

2872

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

2873

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

2874

# happen with a supplied network socket.

2875

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

2876

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

2877

["socket"])

2878

2055

del server_config

2879

2056

2880

2057

# Override the settings from the config file with command line

2881

2058

# options, if set.

2882

2059

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

2883

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

2884

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

2885

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

2060

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

2061

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

2062

"statedir"):

2886

2063

value = getattr(options, option)

2887

2064

if value is not None:

2888

2065

server_settings[option] = value

2889

2066

del options

2890

2067

# Force all strings to be unicode

2891

2068

for option in server_settings.keys():

2892

if isinstance(server_settings[option], bytes):

2893

server_settings[option] = (server_settings[option]

2894

.decode("utf-8"))

2895

# Force all boolean options to be boolean

2896

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

2897

"foreground", "zeroconf"):

2898

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

2899

# Debug implies foreground

2900

if server_settings["debug"]:

2901

server_settings["foreground"] = True

2069

if type(server_settings[option]) is str:

2070

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

2902

2071

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

2903

2072

2904

2073

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

2905

2074

2906

if (not server_settings["zeroconf"]

2907

and not (server_settings["port"]

2908

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

2909

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

2910

2911

2075

# For convenience

2912

2076

debug = server_settings["debug"]

2913

2077

debuglevel = server_settings["debuglevel"]

2915

2079

use_ipv6 = server_settings["use_ipv6"]

2916

2080

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

2917

2081

stored_state_file)

2918

foreground = server_settings["foreground"]

2919

zeroconf = server_settings["zeroconf"]

2920

2082

2921

2083

if debug:

2922

2084

initlogger(debug, logging.DEBUG)

2928

2090

initlogger(debug, level)

2929

2091

2930

2092

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

2931

syslogger.setFormatter(

2932

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

2933

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

2934

server_settings["servicename"])))

2093

syslogger.setFormatter(logging.Formatter

2094

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

2095

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

2096

% server_settings["servicename"]))

2935

2097

2936

2098

# Parse config file with clients

2937

2099

client_config = configparser.SafeConfigParser(Client

2942

2104

global mandos_dbus_service

2943

2105

mandos_dbus_service = None

2944

2106

2945

socketfd = None

2946

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

2947

socketfd = server_settings["socket"]

2948

tcp_server = MandosServer(

2949

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

2950

ClientHandler,

2951

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

2952

use_ipv6=use_ipv6,

2953

gnutls_priority=server_settings["priority"],

2954

use_dbus=use_dbus,

2955

socketfd=socketfd)

2956

if not foreground:

2957

pidfilename = "/run/mandos.pid"

2958

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

2959

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

2960

pidfile = None

2107

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

2108

server_settings["port"]),

2109

ClientHandler,

2110

interface=(server_settings["interface"]

2111

or None),

2112

use_ipv6=use_ipv6,

2113

gnutls_priority=

2114

server_settings["priority"],

2115

use_dbus=use_dbus)

2116

if not debug:

2117

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

2961

2118

try:

2962

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

2963

except IOError as e:

2964

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

2965

exc_info=e)

2119

pidfile = open(pidfilename, "w")

2120

except IOError:

2121

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

2966

2122

2967

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

2968

("mandos", "mandos"),

2969

("nobody", "nogroup")):

2123

try:

2124

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

2125

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

2126

except KeyError:

2970

2127

try:

2971

uid = pwd.getpwnam(name).pw_uid

2972

gid = pwd.getpwnam(group).pw_gid

2973

break

2128

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

2129

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

2974

2130

except KeyError:

2975

continue

2976

else:

2977

uid = 65534

2978

gid = 65534

2131

try:

2132

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

2133

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

2134

except KeyError:

2135

uid = 65534

2136

gid = 65534

2979

2137

try:

2980

2138

os.setgid(gid)

2981

2139

os.setuid(uid)

2982

if debug:

2983

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

2984

gid))

2985

2140

except OSError as error:

2986

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

2987

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

2988

if error.errno != errno.EPERM:

2989

raise

2141

if error[0] != errno.EPERM:

2142

raise error

2990

2143

2991

2144

if debug:

2992

2145

# Enable all possible GnuTLS debugging

2993

2146

2994

2147

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

2995

2148

# - GnuTLS manual

2996

gnutls.global_set_log_level(11)

2149

gnutls.library.functions.gnutls_global_set_log_level(11)

2997

2150

2998

@gnutls.log_func

2151

@gnutls.library.types.gnutls_log_func

2999

2152

def debug_gnutls(level, string):

3000

2153

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

3001

2154

3002

gnutls.global_set_log_function(debug_gnutls)

2155

(gnutls.library.functions

2156

.gnutls_global_set_log_function(debug_gnutls))

3003

2157

3004

2158

# Redirect stdin so all checkers get /dev/null

3005

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

2159

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

3006

2160

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

3007

2161

if null > 2:

3008

2162

os.close(null)

3009

2163

3010

2164

# Need to fork before connecting to D-Bus

3011

if not foreground:

2165

if not debug:

3012

2166

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

3013

2167

daemon()

3014

2168

3015

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

3016

# to inform GLib that threads will be used.

3017

GLib.threads_init()

2169

gobject.threads_init()

3018

2170

3019

2171

global main_loop

3020

2172

# From the Avahi example code

3021

DBusGMainLoop(set_as_default=True)

3022

main_loop = GLib.MainLoop()

2173

DBusGMainLoop(set_as_default=True )

2174

main_loop = gobject.MainLoop()

3023

2175

bus = dbus.SystemBus()

3024

2176

# End of Avahi example code

3025

2177

if use_dbus:

3026

2178

try:

3027

2179

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

3028

bus,

3029

do_not_queue=True)

3030

old_bus_name = dbus.service.BusName(

3031

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

3032

do_not_queue=True)

3033

except dbus.exceptions.DBusException as e:

3034

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

2180

bus, do_not_queue=True)

2181

old_bus_name = (dbus.service.BusName

2182

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

2183

do_not_queue=True))

2184

except dbus.exceptions.NameExistsException as e:

2185

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

3035

2186

use_dbus = False

3036

2187

server_settings["use_dbus"] = False

3037

2188

tcp_server.use_dbus = False

3038

if zeroconf:

3039

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3040

service = AvahiServiceToSyslog(

3041

name = server_settings["servicename"],

3042

servicetype = "_mandos._tcp",

3043

protocol = protocol,

3044

bus = bus)

3045

if server_settings["interface"]:

3046

service.interface = if_nametoindex(

3047

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

2189

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2190

service = AvahiServiceToSyslog(name =

2191

server_settings["servicename"],

2192

servicetype = "_mandos._tcp",

2193

protocol = protocol, bus = bus)

2194

if server_settings["interface"]:

2195

service.interface = (if_nametoindex

2196

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

3048

2197

3049

2198

global multiprocessing_manager

3050

2199

multiprocessing_manager = multiprocessing.Manager()

3051

2200

3052

2201

client_class = Client

3053

2202

if use_dbus:

3054

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

2203

client_class = functools.partial(ClientDBusTransitional,

2204

bus = bus)

3055

2205

3056

2206

client_settings = Client.config_parser(client_config)

3057

2207

old_client_settings = {}

3058

2208

clients_data = {}

3059

2209

3060

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

3061

global wnull

3062

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

3063

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

3064

# mode

3065

if debug or not foreground:

3066

wnull.close()

3067

3068

2210

# Get client data and settings from last running state.

3069

2211

if server_settings["restore"]:

3070

2212

try:

3071

2213

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

3072

if sys.version_info.major == 2:

3073

clients_data, old_client_settings = pickle.load(

3074

stored_state)

3075

else:

3076

bytes_clients_data, bytes_old_client_settings = (

3077

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

3078

### Fix bytes to strings

3079

## clients_data

3080

# .keys()

3081

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

3082

if isinstance(key, bytes)

3083

else key): value

3084

for key, value in

3085

bytes_clients_data.items() }

3086

del bytes_clients_data

3087

for key in clients_data:

3088

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

3089

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

3090

for k, v in

3091

clients_data[key].items() }

3092

clients_data[key] = value

3093

# .client_structure

3094

value["client_structure"] = [

3095

(s.decode("utf-8")

3096

if isinstance(s, bytes)

3097

else s) for s in

3098

value["client_structure"] ]

3099

# .name & .host

3100

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

3101

if isinstance(value[k], bytes):

3102

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

3103

## old_client_settings

3104

# .keys()

3105

old_client_settings = {

3106

(key.decode("utf-8")

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_old_client_settings.items() }

3111

del bytes_old_client_settings

3112

# .host

3113

for value in old_client_settings.values():

3114

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

3115

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

3116

.decode("utf-8"))

2214

clients_data, old_client_settings = (pickle.load

2215

(stored_state))

3117

2216

os.remove(stored_state_path)

3118

2217

except IOError as e:

3119

if e.errno == errno.ENOENT:

3120

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

3121

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

3122

else:

3123

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

3124

exc_info=e)

2218

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

2219

.format(e))

2220

if e.errno != errno.ENOENT:

3125

2221

raise

3126

2222

except EOFError as e:

3127

2223

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

3128

"EOFError:",

3129

exc_info=e)

2224

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

3130

2225

3131

2226

with PGPEngine() as pgp:

3132

for client_name, client in clients_data.items():

3133

# Skip removed clients

3134

if client_name not in client_settings:

3135

continue

3136

2227

for client_name, client in clients_data.iteritems():

3137

2228

# Decide which value to use after restoring saved state.

3138

2229

# We have three different values: Old config file,

3139

2230

# new config file, and saved state.

3144

2235

# For each value in new config, check if it

3145

2236

# differs from the old config value (Except for

3146

2237

# the "secret" attribute)

3147

if (name != "secret"

3148

and (value !=

3149

old_client_settings[client_name][name])):

2238

if (name != "secret" and

2239

value != old_client_settings[client_name]

2240

[name]):

3150

2241

client[name] = value

3151

2242

except KeyError:

3152

2243

pass

3153

2244

3154

2245

# Clients who has passed its expire date can still be

3155

# enabled if its last checker was successful. A Client

2246

# enabled if its last checker was successful. Clients

3156

2247

# whose checker succeeded before we stored its state is

3157

2248

# assumed to have successfully run all checkers during

3158

2249

# downtime.

3160

2251

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

3161

2252

if not client["last_checked_ok"]:

3162

2253

logger.warning(

3163

"disabling client {} - Client never "

3164

"performed a successful checker".format(

3165

client_name))

2254

"disabling client {0} - Client never "

2255

"performed a successful checker"

2256

.format(client_name))

3166

2257

client["enabled"] = False

3167

2258

elif client["last_checker_status"] != 0:

3168

2259

logger.warning(

3169

"disabling client {} - Client last"

3170

" checker failed with error code"

3171

" {}".format(

3172

client_name,

3173

client["last_checker_status"]))

2260

"disabling client {0} - Client "

2261

"last checker failed with error code {1}"

2262

.format(client_name,

2263

client["last_checker_status"]))

3174

2264

client["enabled"] = False

3175

2265

else:

3176

client["expires"] = (

3177

datetime.datetime.utcnow()

3178

+ client["timeout"])

2266

client["expires"] = (datetime.datetime

2267

.utcnow()

2268

+ client["timeout"])

3179

2269

logger.debug("Last checker succeeded,"

3180

" keeping {} enabled".format(

3181

client_name))

2270

" keeping {0} enabled"

2271

.format(client_name))

3182

2272

try:

3183

client["secret"] = pgp.decrypt(

3184

client["encrypted_secret"],

3185

client_settings[client_name]["secret"])

2273

client["secret"] = (

2274

pgp.decrypt(client["encrypted_secret"],

2275

client_settings[client_name]

2276

["secret"]))

3186

2277

except PGPError:

3187

2278

# If decryption fails, we use secret from new settings

3188

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

3189

client_name))

3190

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

3191

["secret"])

2279

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

2280

.format(client_name))

2281

client["secret"] = (

2282

client_settings[client_name]["secret"])

2283

3192

2284

3193

2285

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

3194

2286

for client_name in (set(old_client_settings)

3197

2289

for client_name in (set(client_settings)

3198

2290

- set(old_client_settings)):

3199

2291

clients_data[client_name] = client_settings[client_name]

3200

2292

3201

2293

# Create all client objects

3202

for client_name, client in clients_data.items():

2294

for client_name, client in clients_data.iteritems():

3203

2295

tcp_server.clients[client_name] = client_class(

3204

name = client_name,

3205

settings = client,

3206

server_settings = server_settings)

2296

name = client_name, settings = client)

3207

2297

3208

2298

if not tcp_server.clients:

3209

2299

logger.warning("No clients defined")

3210

3211

if not foreground:

3212

if pidfile is not None:

3213

pid = os.getpid()

3214

try:

3215

with pidfile:

3216

print(pid, file=pidfile)

3217

except IOError:

3218

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

3219

pidfilename, pid)

3220

del pidfile

2300

2301

if not debug:

2302

try:

2303

with pidfile:

2304

pid = os.getpid()

2305

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

2306

del pidfile

2307

except IOError:

2308

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

2309

pidfilename, pid)

2310

except NameError:

2311

# "pidfile" was never created

2312

pass

3221

2313

del pidfilename

2314

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

3222

2315

3223

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

3224

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3225

lambda: main_loop.quit() and False)

2316

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

2317

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

3226

2318

3227

2319

if use_dbus:

3228

3229

@alternate_dbus_interfaces(

3230

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

3231

class MandosDBusService(DBusObjectWithObjectManager):

2320

class MandosDBusService(dbus.service.Object):

3232

2321

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

3233

3234

2322

def __init__(self):

3235

2323

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

3236

3237

2324

_interface = "se.recompile.Mandos"

3238

2325

3239

2326

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

3246

2333

"D-Bus signal"

3247

2334

pass

3248

2335

3249

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

3250

"true"})

3251

2336

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

3252

2337

def ClientRemoved(self, objpath, name):

3253

2338

"D-Bus signal"

3254

2339

pass

3255

2340

3256

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

3257

"true"})

3258

2341

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

3259

2342

def GetAllClients(self):

3260

2343

"D-Bus method"

3261

return dbus.Array(c.dbus_object_path for c in

3262

tcp_server.clients.values())

2344

return dbus.Array(c.dbus_object_path

2345

for c in

2346

tcp_server.clients.itervalues())

3263

2347

3264

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

3265

"true"})

3266

2348

@dbus.service.method(_interface,

3267

2349

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

3268

2350

def GetAllClientsWithProperties(self):

3269

2351

"D-Bus method"

3270

2352

return dbus.Dictionary(

3271

{ c.dbus_object_path: c.GetAll(

3272

"se.recompile.Mandos.Client")

3273

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

2353

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

2354

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

3274

2355

signature="oa{sv}")

3275

2356

3276

2357

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

3277

2358

def RemoveClient(self, object_path):

3278

2359

"D-Bus method"

3279

for c in tcp_server.clients.values():

2360

for c in tcp_server.clients.itervalues():

3280

2361

if c.dbus_object_path == object_path:

3281

2362

del tcp_server.clients[c.name]

3282

2363

c.remove_from_connection()

3283

# Don't signal the disabling

2364

# Don't signal anything except ClientRemoved

3284

2365

c.disable(quiet=True)

3285

# Emit D-Bus signal for removal

3286

self.client_removed_signal(c)

2366

# Emit D-Bus signal

2367

self.ClientRemoved(object_path, c.name)

3287

2368

return

3288

2369

raise KeyError(object_path)

3289

2370

3290

2371

del _interface

3291

3292

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3293

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

3294

def GetManagedObjects(self):

3295

"""D-Bus method"""

3296

return dbus.Dictionary(

3297

{ client.dbus_object_path:

3298

dbus.Dictionary(

3299

{ interface: client.GetAll(interface)

3300

for interface in

3301

client._get_all_interface_names()})

3302

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

3303

3304

def client_added_signal(self, client):

3305

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

3306

if use_dbus:

3307

# New standard signal

3308

self.InterfacesAdded(

3309

client.dbus_object_path,

3310

dbus.Dictionary(

3311

{ interface: client.GetAll(interface)

3312

for interface in

3313

client._get_all_interface_names()}))

3314

# Old signal

3315

self.ClientAdded(client.dbus_object_path)

3316

3317

def client_removed_signal(self, client):

3318

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

3319

if use_dbus:

3320

# New standard signal

3321

self.InterfacesRemoved(

3322

client.dbus_object_path,

3323

client._get_all_interface_names())

3324

# Old signal

3325

self.ClientRemoved(client.dbus_object_path,

3326

client.name)

3327

2372

3328

mandos_dbus_service = MandosDBusService()

2373

class MandosDBusServiceTransitional(MandosDBusService):

2374

__metaclass__ = AlternateDBusNamesMetaclass

2375

mandos_dbus_service = MandosDBusServiceTransitional()

3329

2376

3330

# Save modules to variables to exempt the modules from being

3331

# unloaded before the function registered with atexit() is run.

3332

mp = multiprocessing

3333

wn = wnull

3334

2377

def cleanup():

3335

2378

"Cleanup function; run on exit"

3336

if zeroconf:

3337

service.cleanup()

2379

service.cleanup()

3338

2380

3339

mp.active_children()

3340

wn.close()

2381

multiprocessing.active_children()

3341

2382

if not (tcp_server.clients or client_settings):

3342

2383

return

3343

2384

3346

2387

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

3347

2388

clients = {}

3348

2389

with PGPEngine() as pgp:

3349

for client in tcp_server.clients.values():

2390

for client in tcp_server.clients.itervalues():

3350

2391

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

3351

2392

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

3352

2393

key)

3354

2395

3355

2396

# A list of attributes that can not be pickled

3356

2397

# + secret.

3357

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

3358

"checker", "server_settings" }

3359

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

3360

.Object):

2398

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

2399

"checker"))

2400

for name, typ in (inspect.getmembers

2401

(dbus.service.Object)):

3361

2402

exclude.add(name)

3362

2403

3363

2404

client_dict["encrypted_secret"] = (client

3370

2411

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

3371

2412

3372

2413

try:

3373

with tempfile.NamedTemporaryFile(

3374

mode='wb',

3375

suffix=".pickle",

3376

prefix='clients-',

3377

dir=os.path.dirname(stored_state_path),

3378

delete=False) as stored_state:

3379

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

3380

protocol = 2)

3381

tempname = stored_state.name

2414

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

2415

prefix="clients-",

2416

dir=os.path.dirname

2417

(stored_state_path))

2418

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

2419

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

3382

2420

os.rename(tempname, stored_state_path)

3383

2421

except (IOError, OSError) as e:

2422

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

2423

.format(e))

3384

2424

if not debug:

3385

2425

try:

3386

2426

os.remove(tempname)

3387

2427

except NameError:

3388

2428

pass

3389

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

3390

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

3391

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

3392

else:

3393

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

3394

exc_info=e)

3395

raise

2429

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

2430

errno.EEXIST)):

2431

raise e

3396

2432

3397

2433

# Delete all clients, and settings from config

3398

2434

while tcp_server.clients:

3399

2435

name, client = tcp_server.clients.popitem()

3400

2436

if use_dbus:

3401

2437

client.remove_from_connection()

3402

# Don't signal the disabling

2438

# Don't signal anything except ClientRemoved

3403

2439

client.disable(quiet=True)

3404

# Emit D-Bus signal for removal

3405

2440

if use_dbus:

3406

mandos_dbus_service.client_removed_signal(client)

2441

# Emit D-Bus signal

2442

mandos_dbus_service.ClientRemoved(client

2443

.dbus_object_path,

2444

client.name)

3407

2445

client_settings.clear()

3408

2446

3409

2447

atexit.register(cleanup)

3410

2448

3411

for client in tcp_server.clients.values():

2449

for client in tcp_server.clients.itervalues():

3412

2450

if use_dbus:

3413

# Emit D-Bus signal for adding

3414

mandos_dbus_service.client_added_signal(client)

2451

# Emit D-Bus signal

2452

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3415

2453

# Need to initiate checking of clients

3416

2454

if client.enabled:

3417

2455

client.init_checker()

3420

2458

tcp_server.server_activate()

3421

2459

3422

2460

# Find out what port we got

3423

if zeroconf:

3424

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

2461

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

3425

2462

if use_ipv6:

3426

2463

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

3427

" flowinfo %d, scope_id %d",

3428

*tcp_server.socket.getsockname())

2464

" flowinfo %d, scope_id %d"

2465

% tcp_server.socket.getsockname())

3429

2466

else: # IPv4

3430

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

3431

*tcp_server.socket.getsockname())

2467

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

2468

% tcp_server.socket.getsockname())

3432

2469

3433

2470

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

3434

2471

3435

2472

try:

3436

if zeroconf:

3437

# From the Avahi example code

3438

try:

3439

service.activate()

3440

except dbus.exceptions.DBusException as error:

3441

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

3442

cleanup()

3443

sys.exit(1)

3444

# End of Avahi example code

2473

# From the Avahi example code

2474

try:

2475

service.activate()

2476

except dbus.exceptions.DBusException as error:

2477

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

2478

cleanup()

2479

sys.exit(1)

2480

# End of Avahi example code

3445

2481

3446

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

3447

lambda *args, **kwargs:

3448

(tcp_server.handle_request

3449

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

2482

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

2483

lambda *args, **kwargs:

2484

(tcp_server.handle_request

2485

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

3450

2486

3451

2487

logger.debug("Starting main loop")

3452

2488

main_loop.run()

3453

2489

except AvahiError as error:

3454

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

2490

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

3455

2491

cleanup()

3456

2492

sys.exit(1)

3457

2493

except KeyboardInterrupt:

3462

2498

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

3463

2499

cleanup()

3464

2500

3465

3466

2501

if __name__ == '__main__':

3467

2502

main()