/mandos/trunk : revision 505.3.10

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

37

import SocketServer as socketserver

43

38

import socket

44

39

import argparse

45

40

import datetime

50

45

import gnutls.library.functions

51

46

import gnutls.library.constants

52

47

import gnutls.library.types

53

try:

54

import ConfigParser as configparser

55

except ImportError:

56

import configparser

48

import ConfigParser as configparser

57

49

import sys

58

50

import re

59

51

import os

68

60

import struct

69

61

import fcntl

70

62

import functools

71

try:

72

import cPickle as pickle

73

except ImportError:

74

import pickle

63

import cPickle as pickle

75

64

import multiprocessing

76

65

import types

77

import binascii

78

import tempfile

79

import itertools

80

import collections

81

import codecs

82

66

83

67

import dbus

84

68

import dbus.service

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

69

import gobject

89

70

import avahi

90

71

from dbus.mainloop.glib import DBusGMainLoop

91

72

import ctypes

101

82

except ImportError:

102

83

SO_BINDTODEVICE = None

103

84

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

108

stored_state_file = "clients.pickle"

109

110

logger = logging.getLogger()

111

syslogger = None

112

113

try:

114

if_nametoindex = ctypes.cdll.LoadLibrary(

115

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

116

except (OSError, AttributeError):

117

118

def if_nametoindex(interface):

119

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

120

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

121

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

122

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

123

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

124

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

125

return interface_index

126

127

128

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

129

"""init logger and add loglevel"""

130

131

global syslogger

132

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

135

syslogger.setFormatter(logging.Formatter

136

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

137

' %(message)s'))

138

logger.addHandler(syslogger)

139

140

if debug:

141

console = logging.StreamHandler()

142

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

143

' [%(process)d]:'

144

' %(levelname)s:'

145

' %(message)s'))

146

logger.addHandler(console)

147

logger.setLevel(level)

148

149

150

class PGPError(Exception):

151

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

152

pass

153

154

155

class PGPEngine(object):

156

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

157

158

def __init__(self):

159

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

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

165

166

def __enter__(self):

167

return self

168

169

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

170

self._cleanup()

171

return False

172

173

def __del__(self):

174

self._cleanup()

175

176

def _cleanup(self):

177

if self.tempdir is not None:

178

# Delete contents of tempdir

179

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

180

topdown = False):

181

for filename in files:

182

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

183

for dirname in dirs:

184

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

185

# Remove tempdir

186

os.rmdir(self.tempdir)

187

self.tempdir = None

188

189

def password_encode(self, password):

190

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

191

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

192

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

193

if len(encoded) > 2048:

194

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

195

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

196

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

197

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

198

return encoded

199

200

def encrypt(self, data, password):

201

passphrase = self.password_encode(password)

202

with tempfile.NamedTemporaryFile(

203

dir=self.tempdir) as passfile:

204

passfile.write(passphrase)

205

passfile.flush()

206

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

207

'--passphrase-file',

208

passfile.name]

209

+ self.gnupgargs,

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

214

if proc.returncode != 0:

215

raise PGPError(err)

216

return ciphertext

217

218

def decrypt(self, data, password):

219

passphrase = self.password_encode(password)

220

with tempfile.NamedTemporaryFile(

221

dir = self.tempdir) as passfile:

222

passfile.write(passphrase)

223

passfile.flush()

224

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

225

'--passphrase-file',

226

passfile.name]

227

+ self.gnupgargs,

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

232

if proc.returncode != 0:

233

raise PGPError(err)

234

return decrypted_plaintext

235

85

86

version = "1.4.1"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

90

syslogger = (logging.handlers.SysLogHandler

91

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

236

103

237

104

class AvahiError(Exception):

238

105

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

239

106

self.value = value

240

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

241

**kwargs)

242

107

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

108

def __unicode__(self):

109

return unicode(repr(self.value))

243

110

244

111

class AvahiServiceError(AvahiError):

245

112

pass

246

113

247

248

114

class AvahiGroupError(AvahiError):

249

115

pass

250

116

257

123

Used to optionally bind to the specified interface.

258

124

name: string; Example: 'Mandos'

259

125

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

260

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

126

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

261

127

port: integer; what port to announce

262

128

TXT: list of strings; TXT record for the service

263

129

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

269

135

server: D-Bus Server

270

136

bus: dbus.SystemBus()

271

137

"""

272

273

def __init__(self,

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

138

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

139

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

140

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

141

protocol = avahi.PROTO_UNSPEC, bus = None):

284

142

self.interface = interface

285

143

self.name = name

286

144

self.type = servicetype

295

153

self.server = None

296

154

self.bus = bus

297

155

self.entry_group_state_changed_match = None

298

299

def rename(self, remove=True):

156

def rename(self):

300

157

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

301

158

if self.rename_count >= self.max_renames:

302

159

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

303

160

" after %i retries, exiting.",

304

161

self.rename_count)

305

162

raise AvahiServiceError("Too many renames")

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

163

self.name = unicode(self.server

164

.GetAlternativeServiceName(self.name))

309

165

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

310

166

self.name)

311

if remove:

312

self.remove()

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

self.remove()

313

172

try:

314

173

self.add()

315

174

except dbus.exceptions.DBusException as error:

316

if (error.get_dbus_name()

317

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

318

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

319

return self.rename(remove=False)

320

else:

321

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

322

self.cleanup()

323

os._exit(1)

324

175

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

176

self.cleanup()

177

os._exit(1)

178

self.rename_count += 1

325

179

def remove(self):

326

180

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

327

181

if self.entry_group_state_changed_match is not None:

329

183

self.entry_group_state_changed_match = None

330

184

if self.group is not None:

331

185

self.group.Reset()

332

333

186

def add(self):

334

187

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

335

188

self.remove()

340

193

avahi.DBUS_INTERFACE_ENTRY_GROUP)

341

194

self.entry_group_state_changed_match = (

342

195

self.group.connect_to_signal(

343

'StateChanged', self.entry_group_state_changed))

196

'StateChanged', self .entry_group_state_changed))

344

197

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

345

198

self.name, self.type)

346

199

self.group.AddService(

352

205

dbus.UInt16(self.port),

353

206

avahi.string_array_to_txt_array(self.TXT))

354

207

self.group.Commit()

355

356

208

def entry_group_state_changed(self, state, error):

357

209

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

358

210

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

364

216

self.rename()

365

217

elif state == avahi.ENTRY_GROUP_FAILURE:

366

218

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

367

str(error))

368

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

369

219

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

370

222

def cleanup(self):

371

223

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

372

224

if self.group is not None:

373

225

try:

374

226

self.group.Free()

375

227

except (dbus.exceptions.UnknownMethodException,

376

dbus.exceptions.DBusException):

228

dbus.exceptions.DBusException) as e:

377

229

pass

378

230

self.group = None

379

231

self.remove()

380

381

232

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

382

233

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

383

234

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

384

bad_states = {

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

386

avahi.SERVER_REGISTERING: None,

387

avahi.SERVER_COLLISION: "Zeroconf server name collision",

388

avahi.SERVER_FAILURE: "Zeroconf server failure",

389

}

235

bad_states = { avahi.SERVER_INVALID:

236

"Zeroconf server invalid",

237

avahi.SERVER_REGISTERING: None,

238

avahi.SERVER_COLLISION:

239

"Zeroconf server name collision",

240

avahi.SERVER_FAILURE:

241

"Zeroconf server failure" }

390

242

if state in bad_states:

391

243

if bad_states[state] is not None:

392

244

if error is None:

401

253

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

402

254

else:

403

255

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

404

405

256

def activate(self):

406

257

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

407

258

if self.server is None:

411

262

follow_name_owner_changes=True),

412

263

avahi.DBUS_INTERFACE_SERVER)

413

264

self.server.connect_to_signal("StateChanged",

414

self.server_state_changed)

265

self.server_state_changed)

415

266

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

416

267

417

268

418

class AvahiServiceToSyslog(AvahiService):

419

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

420

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

421

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

422

syslogger.setFormatter(logging.Formatter(

423

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

424

.format(self.name)))

425

return ret

426

427

def call_pipe(connection, # : multiprocessing.Connection

428

func, *args, **kwargs):

429

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

430

431

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

432

return value on the provided multiprocessing.Connection.

433

"""

434

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

435

connection.close()

436

269

def _timedelta_to_milliseconds(td):

270

"Convert a datetime.timedelta() to milliseconds"

271

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

272

+ (td.seconds * 1000)

273

+ (td.microseconds // 1000))

274

437

275

class Client(object):

438

276

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

439

277

440

278

Attributes:

441

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

279

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

442

280

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

443

281

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

444

282

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

451

289

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

452

290

checker_initiator_tag: a gobject event source tag, or None

453

291

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

454

client_structure: Object describing what attributes a client has

455

and is used for storing the client at exit

456

292

current_checker_command: string; current running checker_command

293

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

457

294

disable_initiator_tag: a gobject event source tag, or None

458

295

enabled: bool()

459

296

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

462

299

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

463

300

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

464

301

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

465

last_checker_status: integer between 0 and 255 reflecting exit

466

status of last checker. -1 reflects crashed

467

checker, -2 means no checker completed yet.

468

last_checker_signal: The signal which killed the last checker, if

469

last_checker_status is -1

470

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

302

last_enabled: datetime.datetime(); (UTC)

471

303

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

472

304

D-Bus identifiers

473

305

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

474

306

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

475

307

until this client is disabled

476

extended_timeout: extra long timeout when secret has been sent

308

extended_timeout: extra long timeout when password has been sent

477

309

runtime_expansions: Allowed attributes for runtime expansion.

478

310

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

479

311

disabled, or None

480

server_settings: The server_settings dict from main()

481

312

"""

482

313

483

314

runtime_expansions = ("approval_delay", "approval_duration",

484

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

485

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

486

"last_approval_request", "last_checked_ok",

315

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

316

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

487

317

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

488

client_defaults = {

489

"timeout": "PT5M",

490

"extended_timeout": "PT15M",

491

"interval": "PT2M",

492

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

493

"host": "",

494

"approval_delay": "PT0S",

495

"approval_duration": "PT1S",

496

"approved_by_default": "True",

497

"enabled": "True",

498

}

499

500

@staticmethod

501

def config_parser(config):

502

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

503

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

504

with exceptions for any special settings as defined above.

505

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

506

value given the same arguments.

507

"""

508

settings = {}

509

for client_name in config.sections():

510

section = dict(config.items(client_name))

511

client = settings[client_name] = {}

512

513

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

514

# Reformat values from string types to Python types

515

client["approved_by_default"] = config.getboolean(

516

client_name, "approved_by_default")

517

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

518

"enabled")

519

520

# Uppercase and remove spaces from fingerprint for later

521

# comparison purposes with return value from the

522

# fingerprint() function

523

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

524

.replace(" ", ""))

525

if "secret" in section:

526

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

527

elif "secfile" in section:

528

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

529

(section["secfile"])),

530

"rb") as secfile:

531

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

532

else:

533

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

534

.format(section))

535

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

536

client["extended_timeout"] = string_to_delta(

537

section["extended_timeout"])

538

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

539

client["approval_delay"] = string_to_delta(

540

section["approval_delay"])

541

client["approval_duration"] = string_to_delta(

542

section["approval_duration"])

543

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

544

client["last_approval_request"] = None

545

client["last_checked_ok"] = None

546

client["last_checker_status"] = -2

547

548

return settings

549

550

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

318

319

def timeout_milliseconds(self):

320

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

322

323

def extended_timeout_milliseconds(self):

324

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

326

327

def interval_milliseconds(self):

328

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

330

331

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

551

338

self.name = name

552

if server_settings is None:

553

server_settings = {}

554

self.server_settings = server_settings

555

# adding all client settings

556

for setting, value in settings.items():

557

setattr(self, setting, value)

558

559

if self.enabled:

560

if not hasattr(self, "last_enabled"):

561

self.last_enabled = datetime.datetime.utcnow()

562

if not hasattr(self, "expires"):

563

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

564

+ self.timeout)

565

else:

566

self.last_enabled = None

567

self.expires = None

568

339

if config is None:

340

config = {}

569

341

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

342

# Uppercase and remove spaces from fingerprint for later

343

# comparison purposes with return value from the fingerprint()

344

# function

345

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

346

.replace(" ", ""))

570

347

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

571

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

572

datetime.datetime.utcnow())

573

574

# attributes specific for this server instance

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

575

369

self.checker = None

576

370

self.checker_initiator_tag = None

577

371

self.disable_initiator_tag = None

372

self.expires = None

578

373

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

579

375

self.current_checker_command = None

580

self.approved = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

581

380

self.approvals_pending = 0

582

self.changedstate = multiprocessing_manager.Condition(

583

multiprocessing_manager.Lock())

584

self.client_structure = [attr

585

for attr in self.__dict__.iterkeys()

586

if not attr.startswith("_")]

587

self.client_structure.append("client_structure")

588

589

for name, t in inspect.getmembers(

590

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

591

if not name.startswith("_"):

592

self.client_structure.append(name)

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

self.changedstate = (multiprocessing_manager

386

.Condition(multiprocessing_manager

387

.Lock()))

593

388

594

# Send notice to process children that client state has changed

595

389

def send_changedstate(self):

596

with self.changedstate:

597

self.changedstate.notify_all()

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

598

393

599

394

def enable(self):

600

395

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

601

396

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

602

397

# Already enabled

603

398

return

399

self.send_changedstate()

400

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

401

# and every interval from then on.

402

self.checker_initiator_tag = (gobject.timeout_add

403

(self.interval_milliseconds(),

404

self.start_checker))

405

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

604

406

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

605

410

self.enabled = True

606

411

self.last_enabled = datetime.datetime.utcnow()

607

self.init_checker()

608

self.send_changedstate()

412

# Also start a new checker *right now*.

413

self.start_checker()

609

414

610

415

def disable(self, quiet=True):

611

416

"""Disable this client."""

612

417

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

613

418

return False

614

419

if not quiet:

420

self.send_changedstate()

421

if not quiet:

615

422

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

616

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

423

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

617

424

gobject.source_remove(self.disable_initiator_tag)

618

425

self.disable_initiator_tag = None

619

426

self.expires = None

620

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

427

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

621

428

gobject.source_remove(self.checker_initiator_tag)

622

429

self.checker_initiator_tag = None

623

430

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

624

433

self.enabled = False

625

if not quiet:

626

self.send_changedstate()

627

434

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

628

435

return False

629

436

630

437

def __del__(self):

438

self.disable_hook = None

631

439

self.disable()

632

440

633

def init_checker(self):

634

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

635

# and every interval from then on.

636

if self.checker_initiator_tag is not None:

637

gobject.source_remove(self.checker_initiator_tag)

638

self.checker_initiator_tag = gobject.timeout_add(

639

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

640

self.start_checker)

641

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

642

if self.disable_initiator_tag is not None:

643

gobject.source_remove(self.disable_initiator_tag)

644

self.disable_initiator_tag = gobject.timeout_add(

645

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

646

# Also start a new checker *right now*.

647

self.start_checker()

648

649

def checker_callback(self, source, condition, connection,

650

command):

441

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

651

442

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

652

443

self.checker_callback_tag = None

653

444

self.checker = None

654

# Read return code from connection (see call_pipe)

655

returncode = connection.recv()

656

connection.close()

657

658

if returncode >= 0:

659

self.last_checker_status = returncode

660

self.last_checker_signal = None

661

if self.last_checker_status == 0:

445

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

662

448

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

663

449

vars(self))

664

450

self.checked_ok()

665

451

else:

666

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

452

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

453

vars(self))

667

454

else:

668

self.last_checker_status = -1

669

self.last_checker_signal = -returncode

670

455

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

671

456

vars(self))

672

return False

673

674

def checked_ok(self):

675

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

676

self.last_checked_ok = datetime.datetime.utcnow()

677

self.last_checker_status = 0

678

self.last_checker_signal = None

679

self.bump_timeout()

680

681

def bump_timeout(self, timeout=None):

682

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

457

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

683

464

if timeout is None:

684

465

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

685

467

if self.disable_initiator_tag is not None:

686

468

gobject.source_remove(self.disable_initiator_tag)

687

self.disable_initiator_tag = None

688

469

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

689

self.disable_initiator_tag = gobject.timeout_add(

690

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

470

self.disable_initiator_tag = (gobject.timeout_add

471

(_timedelta_to_milliseconds

472

(timeout), self.disable))

691

473

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

692

474

693

475

def need_approval(self):

699

481

If a checker already exists, leave it running and do

700

482

nothing."""

701

483

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

702

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

703

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

704

# would inevitably timeout, since no checker would get a

705

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

484

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

485

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

486

# client would inevitably timeout, since no checker would get

487

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

706

488

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

707

489

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

708

490

# should be.

709

491

710

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

711

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

712

self.checker.join()

713

self.checker = None

492

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

493

try:

494

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

495

except (AttributeError, OSError) as error:

496

if (isinstance(error, OSError)

497

and error.errno != errno.ECHILD):

498

raise error

499

else:

500

if pid:

501

logger.warning("Checker was a zombie")

502

gobject.source_remove(self.checker_callback_tag)

503

self.checker_callback(pid, status,

504

self.current_checker_command)

714

505

# Start a new checker if needed

715

506

if self.checker is None:

716

# Escape attributes for the shell

717

escaped_attrs = {

718

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

719

for attr in self.runtime_expansions }

720

507

try:

721

command = self.checker_command % escaped_attrs

722

except TypeError as error:

723

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

724

self.checker_command,

725

exc_info=error)

726

return True # Try again later

508

# In case checker_command has exactly one % operator

509

command = self.checker_command % self.host

510

except TypeError:

511

# Escape attributes for the shell

512

escaped_attrs = dict(

513

(attr,

514

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

515

errors=

516

'replace')))

517

for attr in

518

self.runtime_expansions)

519

520

try:

521

command = self.checker_command % escaped_attrs

522

except TypeError as error:

523

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

524

' %s', self.checker_command, error)

525

return True # Try again later

727

526

self.current_checker_command = command

728

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

729

self.name)

730

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

731

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

732

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

733

# always replaced by /dev/null.)

734

# The exception is when not debugging but nevertheless

735

# running in the foreground; use the previously

736

# created wnull.

737

popen_args = { "close_fds": True,

738

"shell": True,

739

"cwd": "/" }

740

if (not self.server_settings["debug"]

741

and self.server_settings["foreground"]):

742

popen_args.update({"stdout": wnull,

743

"stderr": wnull })

744

pipe = multiprocessing.Pipe(duplex = False)

745

self.checker = multiprocessing.Process(

746

target = call_pipe,

747

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

748

kwargs = popen_args)

749

self.checker.start()

750

self.checker_callback_tag = gobject.io_add_watch(

751

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

752

self.checker_callback, pipe[0], command)

527

try:

528

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

529

command, self.name)

530

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

531

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

532

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

533

# always replaced by /dev/null.)

534

self.checker = subprocess.Popen(command,

535

close_fds=True,

536

shell=True, cwd="/")

537

self.checker_callback_tag = (gobject.child_watch_add

538

(self.checker.pid,

539

self.checker_callback,

540

data=command))

541

# The checker may have completed before the gobject

542

# watch was added. Check for this.

543

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

544

if pid:

545

gobject.source_remove(self.checker_callback_tag)

546

self.checker_callback(pid, status, command)

547

except OSError as error:

548

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

549

error)

753

550

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

754

551

return True

755

552

761

558

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

762

559

return

763

560

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

764

self.checker.terminate()

561

try:

562

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

563

#time.sleep(0.5)

564

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

565

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

566

except OSError as error:

567

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

568

raise

765

569

self.checker = None

766

570

767

571

768

def dbus_service_property(dbus_interface,

769

signature="v",

770

access="readwrite",

771

byte_arrays=False):

572

def dbus_service_property(dbus_interface, signature="v",

573

access="readwrite", byte_arrays=False):

772

574

"""Decorators for marking methods of a DBusObjectWithProperties to

773

575

become properties on the D-Bus.

774

576

783

585

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

784

586

if byte_arrays and signature != "ay":

785

587

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

786

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

787

588

" signature %r" % signature)

788

589

def decorator(func):

789

590

func._dbus_is_property = True

790

591

func._dbus_interface = dbus_interface

795

596

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

796

597

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

797

598

return func

798

799

return decorator

800

801

802

def dbus_interface_annotations(dbus_interface):

803

"""Decorator for marking functions returning interface annotations

804

805

Usage:

806

807

@dbus_interface_annotations("org.example.Interface")

808

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

809

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

810

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

811

"false"}

812

"""

813

814

def decorator(func):

815

func._dbus_is_interface = True

816

func._dbus_interface = dbus_interface

817

func._dbus_name = dbus_interface

818

return func

819

820

return decorator

821

822

823

def dbus_annotations(annotations):

824

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

825

Usage:

826

827

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

828

"org.freedesktop.DBus.Property."

829

"EmitsChangedSignal": "false"})

830

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

831

access="r")

832

def Property_dbus_property(self):

833

return dbus.Boolean(False)

834

"""

835

836

def decorator(func):

837

func._dbus_annotations = annotations

838

return func

839

840

599

return decorator

841

600

842

601

843

602

class DBusPropertyException(dbus.exceptions.DBusException):

844

603

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

845

604

"""

846

pass

605

def __unicode__(self):

606

return unicode(str(self))

847

607

848

608

849

609

class DBusPropertyAccessException(DBusPropertyException):

867

627

"""

868

628

869

629

@staticmethod

870

def _is_dbus_thing(thing):

871

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

872

873

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

874

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

875

"""

876

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

877

False)

630

def _is_dbus_property(obj):

631

return getattr(obj, "_dbus_is_property", False)

878

632

879

def _get_all_dbus_things(self, thing):

633

def _get_all_dbus_properties(self):

880

634

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

881

635

"""

882

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

883

athing.__get__(self))

636

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

884

637

for cls in self.__class__.__mro__

885

for name, athing in

886

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

638

for name, prop in

639

inspect.getmembers(cls, self._is_dbus_property))

887

640

888

641

def _get_dbus_property(self, interface_name, property_name):

889

642

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

890

643

property with the specified name and interface.

891

644

"""

892

for cls in self.__class__.__mro__:

893

for name, value in inspect.getmembers(

894

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

645

for cls in self.__class__.__mro__:

646

for name, value in (inspect.getmembers

647

(cls, self._is_dbus_property)):

895

648

if (value._dbus_name == property_name

896

649

and value._dbus_interface == interface_name):

897

650

return value.__get__(self)

898

651

899

652

# No such property

900

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

901

self.dbus_object_path, interface_name, property_name))

653

raise DBusPropertyNotFound(self.dbus_object_path + ":"

654

+ interface_name + "."

655

+ property_name)

902

656

903

@dbus.service.method(dbus.PROPERTIES_IFACE,

904

in_signature="ss",

657

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

905

658

out_signature="v")

906

659

def Get(self, interface_name, property_name):

907

660

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

925

678

# The byte_arrays option is not supported yet on

926

679

# signatures other than "ay".

927

680

if prop._dbus_signature != "ay":

928

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

929

"'ay' signature {!r}"

930

.format(prop._dbus_signature))

931

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

932

for byte in value))

681

raise ValueError

682

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

683

for byte in value))

933

684

prop(value)

934

685

935

@dbus.service.method(dbus.PROPERTIES_IFACE,

936

in_signature="s",

686

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

937

687

out_signature="a{sv}")

938

688

def GetAll(self, interface_name):

939

689

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

941

691

942

692

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

943

693

"""

944

properties = {}

945

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

694

all = {}

695

for name, prop in self._get_all_dbus_properties():

946

696

if (interface_name

947

697

and interface_name != prop._dbus_interface):

948

698

# Interface non-empty but did not match

952

702

continue

953

703

value = prop()

954

704

if not hasattr(value, "variant_level"):

955

properties[name] = value

705

all[name] = value

956

706

continue

957

properties[name] = type(value)(

958

value, variant_level = value.variant_level + 1)

959

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

960

961

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

962

def PropertiesChanged(self, interface_name, changed_properties,

963

invalidated_properties):

964

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

965

standard.

966

"""

967

pass

707

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

708

value.variant_level+1)

709

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

968

710

969

711

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

970

712

out_signature="s",

971

713

path_keyword='object_path',

972

714

connection_keyword='connection')

973

715

def Introspect(self, object_path, connection):

974

"""Overloading of standard D-Bus method.

975

976

Inserts property tags and interface annotation tags.

716

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

977

717

"""

978

718

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

979

719

connection)

980

720

try:

981

721

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

982

983

722

def make_tag(document, name, prop):

984

723

e = document.createElement("property")

985

724

e.setAttribute("name", name)

986

725

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

987

726

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

988

727

return e

989

990

728

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

991

# Add property tags

992

729

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

993

730

for name, prop

994

in self._get_all_dbus_things("property")

731

in self._get_all_dbus_properties()

995

732

if prop._dbus_interface

996

733

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

997

734

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr(

1008

prop, "_dbus_annotations", {}))

1009

for name, value in annots.items():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().items()

1019

for name, annotations

1020

in self._get_all_dbus_things("interface")

1021

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

1022

)).items():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1027

735

# Add the names to the return values for the

1028

736

# "org.freedesktop.DBus.Properties" methods

1029

737

if (if_tag.getAttribute("name")

1044

752

except (AttributeError, xml.dom.DOMException,

1045

753

xml.parsers.expat.ExpatError) as error:

1046

754

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

1047

exc_info=error)

755

error)

1048

756

return xmlstring

1049

757

1050

758

1051

def datetime_to_dbus(dt, variant_level=0):

759

def datetime_to_dbus (dt, variant_level=0):

1052

760

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

1053

761

if dt is None:

1054

762

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

1055

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

1056

1057

1058

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1059

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

1060

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

1061

interface names according to the "alt_interface_names" mapping.

1062

Usage:

1063

1064

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

1065

"net.example.AlternateInterface"})

1066

class SampleDBusObject(dbus.service.Object):

1067

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

1068

def SampleDBusMethod():

1069

pass

1070

1071

The above "SampleDBusMethod" on "SampleDBusObject" will be

1072

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

1073

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

1074

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

1075

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

1076

1077

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

1078

(from DBusObjectWithProperties) and interfaces (from the

1079

dbus_interface_annotations decorator).

763

return dbus.String(dt.isoformat(),

764

variant_level=variant_level)

765

766

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

767

.__metaclass__):

768

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

769

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

1080

770

"""

1081

1082

def wrapper(cls):

1083

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.items()):

1085

attr = {}

1086

interface_names = set()

1087

# Go though all attributes of the class

1088

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

771

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

772

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

773

# methods, signals, or properties in them

774

for base in (b for b in bases

775

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

776

# Go though all attributes of the base class

777

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

1089

778

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

1090

779

# with the wrong interface name

1091

780

if (not hasattr(attribute, "_dbus_interface")

1092

or not attribute._dbus_interface.startswith(

1093

orig_interface_name)):

781

or not attribute._dbus_interface

782

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

1094

783

continue

1095

784

# Create an alternate D-Bus interface name based on

1096

785

# the current name

1097

alt_interface = attribute._dbus_interface.replace(

1098

orig_interface_name, alt_interface_name)

1099

interface_names.add(alt_interface)

786

alt_interface = (attribute._dbus_interface

787

.replace("se.recompile.Mandos",

788

"se.bsnet.fukt.Mandos"))

1100

789

# Is this a D-Bus signal?

1101

790

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

1102

if sys.version_info.major == 2:

1103

# Extract the original non-method undecorated

1104

# function by black magic

1105

nonmethod_func = (dict(

791

# Extract the original non-method function by

792

# black magic

793

nonmethod_func = (dict(

1106

794

zip(attribute.func_code.co_freevars,

1107

attribute.__closure__))

1108

["func"].cell_contents)

1109

else:

1110

nonmethod_func = attribute

795

attribute.__closure__))["func"]

796

.cell_contents)

1111

797

# Create a new, but exactly alike, function

1112

798

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

1113

799

# with the alternate D-Bus interface name

1114

if sys.version_info.major == 2:

1115

new_function = types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)

1121

else:

1122

new_function = types.FunctionType(

1123

nonmethod_func.__code__,

1124

nonmethod_func.__globals__,

1125

nonmethod_func.__name__,

1126

nonmethod_func.__defaults__,

1127

nonmethod_func.__closure__)

1128

new_function = (dbus.service.signal(

1129

alt_interface,

1130

attribute._dbus_signature)(new_function))

1131

# Copy annotations, if any

1132

try:

1133

new_function._dbus_annotations = dict(

1134

attribute._dbus_annotations)

1135

except AttributeError:

1136

pass

800

new_function = (dbus.service.signal

801

(alt_interface,

802

attribute._dbus_signature)

803

(types.FunctionType(

804

nonmethod_func.func_code,

805

nonmethod_func.func_globals,

806

nonmethod_func.func_name,

807

nonmethod_func.func_defaults,

808

nonmethod_func.func_closure)))

1137

809

# Define a creator of a function to call both the

1138

# original and alternate functions, so both the

1139

# original and alternate signals gets sent when

1140

# the function is called

810

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

811

# signals gets sent when the function is called

1141

812

def fixscope(func1, func2):

1142

813

"""This function is a scope container to pass

1143

814

func1 and func2 to the "call_both" function

1144

815

outside of its arguments"""

1145

1146

816

def call_both(*args, **kwargs):

1147

817

"""This function will emit two D-Bus

1148

818

signals by calling func1 and func2"""

1149

819

func1(*args, **kwargs)

1150

820

func2(*args, **kwargs)

1151

1152

821

return call_both

1153

822

# Create the "call_both" function and add it to

1154

823

# the class

1155

attr[attrname] = fixscope(attribute, new_function)

824

attr[attrname] = fixscope(attribute,

825

new_function)

1156

826

# Is this a D-Bus method?

1157

827

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

1158

828

# Create a new, but exactly alike, function

1159

829

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

1160

830

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

1161

831

# to the class.

1162

attr[attrname] = (

1163

dbus.service.method(

1164

alt_interface,

1165

attribute._dbus_in_signature,

1166

attribute._dbus_out_signature)

1167

(types.FunctionType(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1172

# Copy annotations, if any

1173

try:

1174

attr[attrname]._dbus_annotations = dict(

1175

attribute._dbus_annotations)

1176

except AttributeError:

1177

pass

832

attr[attrname] = (dbus.service.method

833

(alt_interface,

834

attribute._dbus_in_signature,

835

attribute._dbus_out_signature)

836

(types.FunctionType

837

(attribute.func_code,

838

attribute.func_globals,

839

attribute.func_name,

840

attribute.func_defaults,

841

attribute.func_closure)))

1178

842

# Is this a D-Bus property?

1179

843

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

1180

844

# Create a new, but exactly alike, function

1181

845

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

1182

846

# property with the alternate D-Bus interface

1183

847

# name. Add it to the class.

1184

attr[attrname] = (dbus_service_property(

1185

alt_interface, attribute._dbus_signature,

1186

attribute._dbus_access,

1187

attribute._dbus_get_args_options

1188

["byte_arrays"])

1189

(types.FunctionType(

1190

attribute.func_code,

1191

attribute.func_globals,

1192

attribute.func_name,

1193

attribute.func_defaults,

1194

attribute.func_closure)))

1195

# Copy annotations, if any

1196

try:

1197

attr[attrname]._dbus_annotations = dict(

1198

attribute._dbus_annotations)

1199

except AttributeError:

1200

pass

1201

# Is this a D-Bus interface?

1202

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

1203

# Create a new, but exactly alike, function

1204

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

1205

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

1206

# to the class.

1207

attr[attrname] = (

1208

dbus_interface_annotations(alt_interface)

1209

(types.FunctionType(attribute.func_code,

1210

attribute.func_globals,

1211

attribute.func_name,

1212

attribute.func_defaults,

1213

attribute.func_closure)))

1214

if deprecate:

1215

# Deprecate all alternate interfaces

1216

iname="_AlternateDBusNames_interface_annotation{}"

1217

for interface_name in interface_names:

1218

1219

@dbus_interface_annotations(interface_name)

1220

def func(self):

1221

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

1222

"true" }

1223

# Find an unused name

1224

for aname in (iname.format(i)

1225

for i in itertools.count()):

1226

if aname not in attr:

1227

attr[aname] = func

1228

break

1229

if interface_names:

1230

# Replace the class with a new subclass of it with

1231

# methods, signals, etc. as created above.

1232

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

1233

(cls, ), attr)

1234

return cls

1235

1236

return wrapper

1237

1238

1239

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

1240

"se.bsnet.fukt.Mandos"})

848

attr[attrname] = (dbus_service_property

849

(alt_interface,

850

attribute._dbus_signature,

851

attribute._dbus_access,

852

attribute

853

._dbus_get_args_options

854

["byte_arrays"])

855

(types.FunctionType

856

(attribute.func_code,

857

attribute.func_globals,

858

attribute.func_name,

859

attribute.func_defaults,

860

attribute.func_closure)))

861

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

862

1241

863

class ClientDBus(Client, DBusObjectWithProperties):

1242

864

"""A Client class using D-Bus

1243

865

1247

869

"""

1248

870

1249

871

runtime_expansions = (Client.runtime_expansions

1250

+ ("dbus_object_path", ))

1251

1252

_interface = "se.recompile.Mandos.Client"

872

+ ("dbus_object_path",))

1253

873

1254

874

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

1255

875

1256

876

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

877

self._approvals_pending = 0

1257

878

self.bus = bus

1258

879

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

1259

880

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

1260

881

# the D-Bus

1261

client_object_name = str(self.name).translate(

882

client_object_name = unicode(self.name).translate(

1262

883

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

1263

884

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

1264

self.dbus_object_path = dbus.ObjectPath(

1265

"/clients/" + client_object_name)

885

self.dbus_object_path = (dbus.ObjectPath

886

("/clients/" + client_object_name))

1266

887

DBusObjectWithProperties.__init__(self, self.bus,

1267

888

self.dbus_object_path)

1268

1269

def notifychangeproperty(transform_func, dbus_name,

1270

type_func=lambda x: x,

1271

variant_level=1,

1272

invalidate_only=False,

1273

_interface=_interface):

889

890

def notifychangeproperty(transform_func,

891

dbus_name, type_func=lambda x: x,

892

variant_level=1):

1274

893

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

1275

894

its changes to DBus.

1276

895

1277

896

transform_fun: Function that takes a value and a variant_level

1278

897

and transforms it to a D-Bus type.

1279

898

dbus_name: D-Bus name of the variable

1281

900

to the D-Bus. Default: no transform

1282

901

variant_level: D-Bus variant level. Default: 1

1283

902

"""

1284

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

1285

903

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

1286

904

def setter(self, value):

1287

905

if hasattr(self, "dbus_object_path"):

1288

906

if (not hasattr(self, attrname) or

1289

907

type_func(getattr(self, attrname, None))

1290

908

!= type_func(value)):

1291

if invalidate_only:

1292

self.PropertiesChanged(

1293

_interface, dbus.Dictionary(),

1294

dbus.Array((dbus_name, )))

1295

else:

1296

dbus_value = transform_func(

1297

type_func(value),

1298

variant_level = variant_level)

1299

self.PropertyChanged(dbus.String(dbus_name),

1300

dbus_value)

1301

self.PropertiesChanged(

1302

_interface,

1303

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

1304

dbus_value }),

1305

dbus.Array())

909

dbus_value = transform_func(type_func(value),

910

variant_level

911

=variant_level)

912

self.PropertyChanged(dbus.String(dbus_name),

913

dbus_value)

1306

914

setattr(self, attrname, value)

1307

915

1308

916

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

1309

917

918

1310

919

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1311

920

approvals_pending = notifychangeproperty(dbus.Boolean,

1312

921

"ApprovalPending",

1314

923

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

1315

924

last_enabled = notifychangeproperty(datetime_to_dbus,

1316

925

"LastEnabled")

1317

checker = notifychangeproperty(

1318

dbus.Boolean, "CheckerRunning",

1319

type_func = lambda checker: checker is not None)

926

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

927

type_func = lambda checker:

928

checker is not None)

1320

929

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1321

930

"LastCheckedOK")

1322

last_checker_status = notifychangeproperty(dbus.Int16,

1323

"LastCheckerStatus")

1324

931

last_approval_request = notifychangeproperty(

1325

932

datetime_to_dbus, "LastApprovalRequest")

1326

933

approved_by_default = notifychangeproperty(dbus.Boolean,

1327

934

"ApprovedByDefault")

1328

approval_delay = notifychangeproperty(

1329

dbus.UInt64, "ApprovalDelay",

1330

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

935

approval_delay = notifychangeproperty(dbus.UInt16,

936

"ApprovalDelay",

937

type_func =

938

_timedelta_to_milliseconds)

1331

939

approval_duration = notifychangeproperty(

1332

dbus.UInt64, "ApprovalDuration",

1333

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

940

dbus.UInt16, "ApprovalDuration",

941

type_func = _timedelta_to_milliseconds)

1334

942

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

1335

timeout = notifychangeproperty(

1336

dbus.UInt64, "Timeout",

1337

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

943

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

944

type_func =

945

_timedelta_to_milliseconds)

1338

946

extended_timeout = notifychangeproperty(

1339

dbus.UInt64, "ExtendedTimeout",

1340

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

1341

interval = notifychangeproperty(

1342

dbus.UInt64, "Interval",

1343

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

947

dbus.UInt16, "ExtendedTimeout",

948

type_func = _timedelta_to_milliseconds)

949

interval = notifychangeproperty(dbus.UInt16,

950

"Interval",

951

type_func =

952

_timedelta_to_milliseconds)

1344

953

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

1345

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

1346

invalidate_only=True)

1347

954

1348

955

del notifychangeproperty

1349

956

1356

963

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

1357

964

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

1358

965

1359

def checker_callback(self, source, condition,

1360

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

1361

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

1362

connection, command, *args,

1363

**kwargs)

1364

exitstatus = self.last_checker_status

1365

if exitstatus >= 0:

966

def checker_callback(self, pid, condition, command,

967

*args, **kwargs):

968

self.checker_callback_tag = None

969

self.checker = None

970

if os.WIFEXITED(condition):

971

exitstatus = os.WEXITSTATUS(condition)

1366

972

# Emit D-Bus signal

1367

973

self.CheckerCompleted(dbus.Int16(exitstatus),

1368

dbus.Int64(0),

974

dbus.Int64(condition),

1369

975

dbus.String(command))

1370

976

else:

1371

977

# Emit D-Bus signal

1372

978

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

1373

dbus.Int64(

1374

self.last_checker_signal),

979

dbus.Int64(condition),

1375

980

dbus.String(command))

1376

return ret

981

982

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

983

*args, **kwargs)

1377

984

1378

985

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

1379

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

986

old_checker = self.checker

987

if self.checker is not None:

988

old_checker_pid = self.checker.pid

989

else:

990

old_checker_pid = None

1380

991

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

1381

992

# Only if new checker process was started

1382

993

if (self.checker is not None

1386

997

return r

1387

998

1388

999

def _reset_approved(self):

1389

self.approved = None

1000

self._approved = None

1390

1001

return False

1391

1002

1392

1003

def approve(self, value=True):

1393

self.approved = value

1394

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

1395

* 1000), self._reset_approved)

1396

1004

self.send_changedstate()

1005

self._approved = value

1006

gobject.timeout_add(_timedelta_to_milliseconds

1007

(self.approval_duration),

1008

self._reset_approved)

1009

1397

1010

1398

1011

## D-Bus methods, signals & properties

1399

1400

## Interfaces

1012

_interface = "se.recompile.Mandos.Client"

1401

1013

1402

1014

## Signals

1403

1015

1414

1026

pass

1415

1027

1416

1028

# PropertyChanged - signal

1417

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

1418

1029

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

1419

1030

def PropertyChanged(self, property, value):

1420

1031

"D-Bus signal"

1484

1095

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

1485

1096

1486

1097

# ApprovedByDefault - property

1487

@dbus_service_property(_interface,

1488

signature="b",

1098

@dbus_service_property(_interface, signature="b",

1489

1099

access="readwrite")

1490

1100

def ApprovedByDefault_dbus_property(self, value=None):

1491

1101

if value is None: # get

1493

1103

self.approved_by_default = bool(value)

1494

1104

1495

1105

# ApprovalDelay - property

1496

@dbus_service_property(_interface,

1497

signature="t",

1106

@dbus_service_property(_interface, signature="t",

1498

1107

access="readwrite")

1499

1108

def ApprovalDelay_dbus_property(self, value=None):

1500

1109

if value is None: # get

1501

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

1502

* 1000)

1110

return dbus.UInt64(self.approval_delay_milliseconds())

1503

1111

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

1504

1112

1505

1113

# ApprovalDuration - property

1506

@dbus_service_property(_interface,

1507

signature="t",

1114

@dbus_service_property(_interface, signature="t",

1508

1115

access="readwrite")

1509

1116

def ApprovalDuration_dbus_property(self, value=None):

1510

1117

if value is None: # get

1511

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

1512

* 1000)

1118

return dbus.UInt64(_timedelta_to_milliseconds(

1119

self.approval_duration))

1513

1120

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

1514

1121

1515

1122

# Name - property

1523

1130

return dbus.String(self.fingerprint)

1524

1131

1525

1132

# Host - property

1526

@dbus_service_property(_interface,

1527

signature="s",

1133

@dbus_service_property(_interface, signature="s",

1528

1134

access="readwrite")

1529

1135

def Host_dbus_property(self, value=None):

1530

1136

if value is None: # get

1531

1137

return dbus.String(self.host)

1532

self.host = str(value)

1138

self.host = value

1533

1139

1534

1140

# Created - property

1535

1141

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

1536

1142

def Created_dbus_property(self):

1537

return datetime_to_dbus(self.created)

1143

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

1538

1144

1539

1145

# LastEnabled - property

1540

1146

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

1542

1148

return datetime_to_dbus(self.last_enabled)

1543

1149

1544

1150

# Enabled - property

1545

@dbus_service_property(_interface,

1546

signature="b",

1151

@dbus_service_property(_interface, signature="b",

1547

1152

access="readwrite")

1548

1153

def Enabled_dbus_property(self, value=None):

1549

1154

if value is None: # get

1554

1159

self.disable()

1555

1160

1556

1161

# LastCheckedOK - property

1557

@dbus_service_property(_interface,

1558

signature="s",

1162

@dbus_service_property(_interface, signature="s",

1559

1163

access="readwrite")

1560

1164

def LastCheckedOK_dbus_property(self, value=None):

1561

1165

if value is not None:

1563

1167

return

1564

1168

return datetime_to_dbus(self.last_checked_ok)

1565

1169

1566

# LastCheckerStatus - property

1567

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

1568

def LastCheckerStatus_dbus_property(self):

1569

return dbus.Int16(self.last_checker_status)

1570

1571

1170

# Expires - property

1572

1171

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

1573

1172

def Expires_dbus_property(self):

1579

1178

return datetime_to_dbus(self.last_approval_request)

1580

1179

1581

1180

# Timeout - property

1582

@dbus_service_property(_interface,

1583

signature="t",

1181

@dbus_service_property(_interface, signature="t",

1584

1182

access="readwrite")

1585

1183

def Timeout_dbus_property(self, value=None):

1586

1184

if value is None: # get

1587

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

1588

old_timeout = self.timeout

1185

return dbus.UInt64(self.timeout_milliseconds())

1589

1186

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

1590

# Reschedule disabling

1591

if self.enabled:

1592

now = datetime.datetime.utcnow()

1593

self.expires += self.timeout - old_timeout

1594

if self.expires <= now:

1595

# The timeout has passed

1596

self.disable()

1597

else:

1598

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

1599

is None):

1600

return

1601

gobject.source_remove(self.disable_initiator_tag)

1602

self.disable_initiator_tag = gobject.timeout_add(

1603

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

1604

self.disable)

1187

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

1188

return

1189

# Reschedule timeout

1190

gobject.source_remove(self.disable_initiator_tag)

1191

self.disable_initiator_tag = None

1192

self.expires = None

1193

time_to_die = _timedelta_to_milliseconds((self

1194

.last_checked_ok

1195

+ self.timeout)

1196

- datetime.datetime

1197

.utcnow())

1198

if time_to_die <= 0:

1199

# The timeout has passed

1200

self.disable()

1201

else:

1202

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

1203

+ datetime.timedelta(milliseconds =

1204

time_to_die))

1205

self.disable_initiator_tag = (gobject.timeout_add

1206

(time_to_die, self.disable))

1605

1207

1606

1208

# ExtendedTimeout - property

1607

@dbus_service_property(_interface,

1608

signature="t",

1209

@dbus_service_property(_interface, signature="t",

1609

1210

access="readwrite")

1610

1211

def ExtendedTimeout_dbus_property(self, value=None):

1611

1212

if value is None: # get

1612

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

1613

* 1000)

1213

return dbus.UInt64(self.extended_timeout_milliseconds())

1614

1214

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

1615

1215

1616

1216

# Interval - property

1617

@dbus_service_property(_interface,

1618

signature="t",

1217

@dbus_service_property(_interface, signature="t",

1619

1218

access="readwrite")

1620

1219

def Interval_dbus_property(self, value=None):

1621

1220

if value is None: # get

1622

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

1221

return dbus.UInt64(self.interval_milliseconds())

1623

1222

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

1624

1223

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

1625

1224

return

1626

if self.enabled:

1627

# Reschedule checker run

1628

gobject.source_remove(self.checker_initiator_tag)

1629

self.checker_initiator_tag = gobject.timeout_add(

1630

value, self.start_checker)

1631

self.start_checker() # Start one now, too

1225

# Reschedule checker run

1226

gobject.source_remove(self.checker_initiator_tag)

1227

self.checker_initiator_tag = (gobject.timeout_add

1228

(value, self.start_checker))

1229

self.start_checker() # Start one now, too

1632

1230

1633

1231

# Checker - property

1634

@dbus_service_property(_interface,

1635

signature="s",

1232

@dbus_service_property(_interface, signature="s",

1636

1233

access="readwrite")

1637

1234

def Checker_dbus_property(self, value=None):

1638

1235

if value is None: # get

1639

1236

return dbus.String(self.checker_command)

1640

self.checker_command = str(value)

1237

self.checker_command = value

1641

1238

1642

1239

# CheckerRunning - property

1643

@dbus_service_property(_interface,

1644

signature="b",

1240

@dbus_service_property(_interface, signature="b",

1645

1241

access="readwrite")

1646

1242

def CheckerRunning_dbus_property(self, value=None):

1647

1243

if value is None: # get

1657

1253

return self.dbus_object_path # is already a dbus.ObjectPath

1658

1254

1659

1255

# Secret = property

1660

@dbus_service_property(_interface,

1661

signature="ay",

1662

access="write",

1663

byte_arrays=True)

1256

@dbus_service_property(_interface, signature="ay",

1257

access="write", byte_arrays=True)

1664

1258

def Secret_dbus_property(self, value):

1665

self.secret = bytes(value)

1259

self.secret = str(value)

1666

1260

1667

1261

del _interface

1668

1262

1672

1266

self._pipe = child_pipe

1673

1267

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

1674

1268

if not self._pipe.recv():

1675

raise KeyError(fpr)

1269

raise KeyError()

1676

1270

1677

1271

def __getattribute__(self, name):

1678

if name == '_pipe':

1272

if(name == '_pipe'):

1679

1273

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

1680

1274

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

1681

1275

data = self._pipe.recv()

1682

1276

if data[0] == 'data':

1683

1277

return data[1]

1684

1278

if data[0] == 'function':

1685

1686

1279

def func(*args, **kwargs):

1687

1280

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

1688

1281

return self._pipe.recv()[1]

1689

1690

1282

return func

1691

1283

1692

1284

def __setattr__(self, name, value):

1693

if name == '_pipe':

1285

if(name == '_pipe'):

1694

1286

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

1695

1287

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

1696

1288

1289

class ClientDBusTransitional(ClientDBus):

1290

__metaclass__ = AlternateDBusNamesMetaclass

1697

1291

1698

1292

class ClientHandler(socketserver.BaseRequestHandler, object):

1699

1293

"""A class to handle client connections.

1704

1298

def handle(self):

1705

1299

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

1706

1300

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

1707

str(self.client_address))

1301

unicode(self.client_address))

1708

1302

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

1709

1303

self.server.child_pipe.fileno())

1710

1304

1711

session = gnutls.connection.ClientSession(

1712

self.request, gnutls.connection .X509Credentials())

1305

session = (gnutls.connection

1306

.ClientSession(self.request,

1307

gnutls.connection

1308

.X509Credentials()))

1713

1309

1714

1310

# Note: gnutls.connection.X509Credentials is really a

1715

1311

# generic GnuTLS certificate credentials object so long as

1724

1320

priority = self.server.gnutls_priority

1725

1321

if priority is None:

1726

1322

priority = "NORMAL"

1727

gnutls.library.functions.gnutls_priority_set_direct(

1728

session._c_object, priority, None)

1323

(gnutls.library.functions

1324

.gnutls_priority_set_direct(session._c_object,

1325

priority, None))

1729

1326

1730

1327

# Start communication using the Mandos protocol

1731

1328

# Get protocol number

1733

1330

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

1734

1331

try:

1735

1332

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

1736

raise RuntimeError(line)

1333

raise RuntimeError

1737

1334

except (ValueError, IndexError, RuntimeError) as error:

1738

1335

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

1739

1336

return

1751

1348

approval_required = False

1752

1349

try:

1753

1350

try:

1754

fpr = self.fingerprint(

1755

self.peer_certificate(session))

1351

fpr = self.fingerprint(self.peer_certificate

1352

(session))

1756

1353

except (TypeError,

1757

1354

gnutls.errors.GNUTLSError) as error:

1758

1355

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

1773

1370

while True:

1774

1371

if not client.enabled:

1775

1372

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

1776

client.name)

1373

client.name)

1777

1374

if self.server.use_dbus:

1778

1375

# Emit D-Bus signal

1779

1376

client.Rejected("Disabled")

1780

1377

return

1781

1378

1782

if client.approved or not client.approval_delay:

1379

if client._approved or not client.approval_delay:

1783

1380

#We are approved or approval is disabled

1784

1381

break

1785

elif client.approved is None:

1382

elif client._approved is None:

1786

1383

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

1787

1384

client.name)

1788

1385

if self.server.use_dbus:

1789

1386

# Emit D-Bus signal

1790

1387

client.NeedApproval(

1791

client.approval_delay.total_seconds()

1792

* 1000, client.approved_by_default)

1388

client.approval_delay_milliseconds(),

1389

client.approved_by_default)

1793

1390

else:

1794

1391

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

1795

1392

client.name)

1801

1398

#wait until timeout or approved

1802

1399

time = datetime.datetime.now()

1803

1400

client.changedstate.acquire()

1804

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

1401

(client.changedstate.wait

1402

(float(client._timedelta_to_milliseconds(delay)

1403

/ 1000)))

1805

1404

client.changedstate.release()

1806

1405

time2 = datetime.datetime.now()

1807

1406

if (time2 - time) >= delay:

1823

1422

try:

1824

1423

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

1825

1424

except gnutls.errors.GNUTLSError as error:

1826

logger.warning("gnutls send failed",

1827

exc_info=error)

1425

logger.warning("gnutls send failed")

1828

1426

return

1829

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

1830

len(client.secret) - (sent_size

1831

+ sent))

1427

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

1428

sent, len(client.secret)

1429

- (sent_size + sent))

1832

1430

sent_size += sent

1833

1431

1834

1432

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

1835

1433

# bump the timeout using extended_timeout

1836

client.bump_timeout(client.extended_timeout)

1434

client.checked_ok(client.extended_timeout)

1837

1435

if self.server.use_dbus:

1838

1436

# Emit D-Bus signal

1839

1437

client.GotSecret()

1844

1442

try:

1845

1443

session.bye()

1846

1444

except gnutls.errors.GNUTLSError as error:

1847

logger.warning("GnuTLS bye failed",

1848

exc_info=error)

1445

logger.warning("GnuTLS bye failed")

1849

1446

1850

1447

@staticmethod

1851

1448

def peer_certificate(session):

1852

1449

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

1853

1450

# If not an OpenPGP certificate...

1854

if (gnutls.library.functions.gnutls_certificate_type_get(

1855

session._c_object)

1451

if (gnutls.library.functions

1452

.gnutls_certificate_type_get(session._c_object)

1856

1453

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1857

1454

# ...do the normal thing

1858

1455

return session.peer_certificate

1872

1469

def fingerprint(openpgp):

1873

1470

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1874

1471

# New GnuTLS "datum" with the OpenPGP public key

1875

datum = gnutls.library.types.gnutls_datum_t(

1876

ctypes.cast(ctypes.c_char_p(openpgp),

1877

ctypes.POINTER(ctypes.c_ubyte)),

1878

ctypes.c_uint(len(openpgp)))

1472

datum = (gnutls.library.types

1473

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

1474

ctypes.POINTER

1475

(ctypes.c_ubyte)),

1476

ctypes.c_uint(len(openpgp))))

1879

1477

# New empty GnuTLS certificate

1880

1478

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1881

gnutls.library.functions.gnutls_openpgp_crt_init(

1882

ctypes.byref(crt))

1479

(gnutls.library.functions

1480

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

1883

1481

# Import the OpenPGP public key into the certificate

1884

gnutls.library.functions.gnutls_openpgp_crt_import(

1885

crt, ctypes.byref(datum),

1886

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1482

(gnutls.library.functions

1483

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

1484

gnutls.library.constants

1485

.GNUTLS_OPENPGP_FMT_RAW))

1887

1486

# Verify the self signature in the key

1888

1487

crtverify = ctypes.c_uint()

1889

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1890

crt, 0, ctypes.byref(crtverify))

1488

(gnutls.library.functions

1489

.gnutls_openpgp_crt_verify_self(crt, 0,

1490

ctypes.byref(crtverify)))

1891

1491

if crtverify.value != 0:

1892

1492

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1893

raise gnutls.errors.CertificateSecurityError(

1894

"Verify failed")

1493

raise (gnutls.errors.CertificateSecurityError

1494

("Verify failed"))

1895

1495

# New buffer for the fingerprint

1896

1496

buf = ctypes.create_string_buffer(20)

1897

1497

buf_len = ctypes.c_size_t()

1898

1498

# Get the fingerprint from the certificate into the buffer

1899

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1900

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

1499

(gnutls.library.functions

1500

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

1501

ctypes.byref(buf_len)))

1901

1502

# Deinit the certificate

1902

1503

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1903

1504

# Convert the buffer to a Python bytestring

1904

1505

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

1905

1506

# Convert the bytestring to hexadecimal notation

1906

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

1507

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

1907

1508

return hex_fpr

1908

1509

1909

1510

1910

1511

class MultiprocessingMixIn(object):

1911

1512

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

1912

1913

1513

def sub_process_main(self, request, address):

1914

1514

try:

1915

1515

self.finish_request(request, address)

1916

except Exception:

1516

except:

1917

1517

self.handle_error(request, address)

1918

1518

self.close_request(request)

1919

1519

1920

1520

def process_request(self, request, address):

1921

1521

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

1922

1522

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

1923

args = (request, address))

1523

args = (request,

1524

address))

1924

1525

proc.start()

1925

1526

return proc

1926

1527

1927

1528

1928

1529

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1929

1530

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

1930

1931

1531

def process_request(self, request, client_address):

1932

1532

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

1933

1533

1942

1542

1943

1543

def add_pipe(self, parent_pipe, proc):

1944

1544

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

1945

raise NotImplementedError()

1545

raise NotImplementedError

1946

1546

1947

1547

1948

1548

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1954

1554

interface: None or a network interface name (string)

1955

1555

use_ipv6: Boolean; to use IPv6 or not

1956

1556

"""

1957

1958

1557

def __init__(self, server_address, RequestHandlerClass,

1959

interface=None,

1960

use_ipv6=True,

1961

socketfd=None):

1962

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

1963

creating a new one with socket.socket().

1964

"""

1558

interface=None, use_ipv6=True):

1965

1559

self.interface = interface

1966

1560

if use_ipv6:

1967

1561

self.address_family = socket.AF_INET6

1968

if socketfd is not None:

1969

# Save the file descriptor

1970

self.socketfd = socketfd

1971

# Save the original socket.socket() function

1972

self.socket_socket = socket.socket

1973

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

1974

#

1975

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

1976

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

1977

# patching socket.socket.)

1978

#

1979

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

1980

@functools.wraps(socket.socket)

1981

def socket_wrapper(*args, **kwargs):

1982

# Restore original function so subsequent calls are

1983

# not affected.

1984

socket.socket = self.socket_socket

1985

del self.socket_socket

1986

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

1987

# saved file descriptor.

1988

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

1989

# Replace socket.socket() function with wrapper

1990

socket.socket = socket_wrapper

1991

# The socketserver.TCPServer.__init__ will call

1992

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

1993

# socket_wrapper(), if socketfd was set.

1994

1562

socketserver.TCPServer.__init__(self, server_address,

1995

1563

RequestHandlerClass)

1996

1997

1564

def server_bind(self):

1998

1565

"""This overrides the normal server_bind() function

1999

1566

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

2005

1572

self.interface)

2006

1573

else:

2007

1574

try:

2008

self.socket.setsockopt(

2009

socket.SOL_SOCKET, SO_BINDTODEVICE,

2010

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

1575

self.socket.setsockopt(socket.SOL_SOCKET,

1576

SO_BINDTODEVICE,

1577

str(self.interface

1578

+ '\0'))

2011

1579

except socket.error as error:

2012

if error.errno == errno.EPERM:

2013

logger.error("No permission to bind to"

2014

" interface %s", self.interface)

2015

elif error.errno == errno.ENOPROTOOPT:

1580

if error[0] == errno.EPERM:

1581

logger.error("No permission to"

1582

" bind to interface %s",

1583

self.interface)

1584

elif error[0] == errno.ENOPROTOOPT:

2016

1585

logger.error("SO_BINDTODEVICE not available;"

2017

1586

" cannot bind to interface %s",

2018

1587

self.interface)

2019

elif error.errno == errno.ENODEV:

2020

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

2021

" cannot bind", self.interface)

2022

1588

else:

2023

1589

raise

2024

1590

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

2027

1593

if self.address_family == socket.AF_INET6:

2028

1594

any_address = "::" # in6addr_any

2029

1595

else:

2030

any_address = "0.0.0.0" # INADDR_ANY

1596

any_address = socket.INADDR_ANY

2031

1597

self.server_address = (any_address,

2032

1598

self.server_address[1])

2033

1599

elif not self.server_address[1]:

2034

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

1600

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

1601

0)

2035

1602

# if self.interface:

2036

1603

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

2037

1604

# 0, # port

2051

1618

2052

1619

Assumes a gobject.MainLoop event loop.

2053

1620

"""

2054

2055

1621

def __init__(self, server_address, RequestHandlerClass,

2056

interface=None,

2057

use_ipv6=True,

2058

clients=None,

2059

gnutls_priority=None,

2060

use_dbus=True,

2061

socketfd=None):

1622

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

1623

gnutls_priority=None, use_dbus=True):

2062

1624

self.enabled = False

2063

1625

self.clients = clients

2064

1626

if self.clients is None:

2065

self.clients = {}

1627

self.clients = set()

2066

1628

self.use_dbus = use_dbus

2067

1629

self.gnutls_priority = gnutls_priority

2068

1630

IPv6_TCPServer.__init__(self, server_address,

2069

1631

RequestHandlerClass,

2070

1632

interface = interface,

2071

use_ipv6 = use_ipv6,

2072

socketfd = socketfd)

2073

1633

use_ipv6 = use_ipv6)

2074

1634

def server_activate(self):

2075

1635

if self.enabled:

2076

1636

return socketserver.TCPServer.server_activate(self)

2080

1640

2081

1641

def add_pipe(self, parent_pipe, proc):

2082

1642

# Call "handle_ipc" for both data and EOF events

2083

gobject.io_add_watch(

2084

parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2086

functools.partial(self.handle_ipc,

2087

parent_pipe = parent_pipe,

2088

proc = proc))

1643

gobject.io_add_watch(parent_pipe.fileno(),

1644

gobject.IO_IN | gobject.IO_HUP,

1645

functools.partial(self.handle_ipc,

1646

parent_pipe =

1647

parent_pipe,

1648

proc = proc))

2089

1649

2090

def handle_ipc(self, source, condition,

2091

parent_pipe=None,

2092

proc = None,

2093

client_object=None):

1650

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

1651

proc = None, client_object=None):

1652

condition_names = {

1653

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

1654

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

1655

# blocking).

1656

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

1657

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

1658

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

1659

# broken, usually for pipes and

1660

# sockets).

1661

}

1662

conditions_string = ' | '.join(name

1663

for cond, name in

1664

condition_names.iteritems()

1665

if cond & condition)

2094

1666

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

2095

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

1667

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

2096

1668

# Wait for other process to exit

2097

1669

proc.join()

2098

1670

return False

2105

1677

fpr = request[1]

2106

1678

address = request[2]

2107

1679

2108

for c in self.clients.itervalues():

1680

for c in self.clients:

2109

1681

if c.fingerprint == fpr:

2110

1682

client = c

2111

1683

break

2119

1691

parent_pipe.send(False)

2120

1692

return False

2121

1693

2122

gobject.io_add_watch(

2123

parent_pipe.fileno(),

2124

gobject.IO_IN | gobject.IO_HUP,

2125

functools.partial(self.handle_ipc,

2126

parent_pipe = parent_pipe,

2127

proc = proc,

2128

client_object = client))

1694

gobject.io_add_watch(parent_pipe.fileno(),

1695

gobject.IO_IN | gobject.IO_HUP,

1696

functools.partial(self.handle_ipc,

1697

parent_pipe =

1698

parent_pipe,

1699

proc = proc,

1700

client_object =

1701

client))

2129

1702

parent_pipe.send(True)

2130

1703

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

2131

1704

# same fileno

2137

1710

2138

1711

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

2139

1712

funcname)(*args,

2140

**kwargs)))

1713

**kwargs)))

2141

1714

2142

1715

if command == 'getattr':

2143

1716

attrname = request[1]

2144

if isinstance(client_object.__getattribute__(attrname),

2145

collections.Callable):

2146

parent_pipe.send(('function', ))

1717

if callable(client_object.__getattribute__(attrname)):

1718

parent_pipe.send(('function',))

2147

1719

else:

2148

parent_pipe.send((

2149

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

1720

parent_pipe.send(('data', client_object

1721

.__getattribute__(attrname)))

2150

1722

2151

1723

if command == 'setattr':

2152

1724

attrname = request[1]

2156

1728

return True

2157

1729

2158

1730

2159

def rfc3339_duration_to_delta(duration):

2160

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

2161

2162

>>> rfc3339_duration_to_delta("P7D")

2163

datetime.timedelta(7)

2164

>>> rfc3339_duration_to_delta("PT60S")

2165

datetime.timedelta(0, 60)

2166

>>> rfc3339_duration_to_delta("PT60M")

2167

datetime.timedelta(0, 3600)

2168

>>> rfc3339_duration_to_delta("PT24H")

2169

datetime.timedelta(1)

2170

>>> rfc3339_duration_to_delta("P1W")

2171

datetime.timedelta(7)

2172

>>> rfc3339_duration_to_delta("PT5M30S")

2173

datetime.timedelta(0, 330)

2174

>>> rfc3339_duration_to_delta("P1DT3M20S")

2175

datetime.timedelta(1, 200)

2176

"""

2177

2178

# Parsing an RFC 3339 duration with regular expressions is not

2179

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

2180

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

2181

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

2182

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

2183

# avoid excessive use of external libraries.

2184

2185

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

2186

Token = collections.namedtuple("Token", (

2187

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

2188

# a "group" containing digits

2189

"value", # datetime.timedelta or None

2190

"followers")) # Tokens valid after this token

2191

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

2192

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

2193

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

2194

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

2195

datetime.timedelta(seconds=1),

2196

frozenset((token_end, )))

2197

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

2198

datetime.timedelta(minutes=1),

2199

frozenset((token_second, token_end)))

2200

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

2201

datetime.timedelta(hours=1),

2202

frozenset((token_minute, token_end)))

2203

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

2204

None,

2205

frozenset((token_hour, token_minute,

2206

token_second)))

2207

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

2208

datetime.timedelta(days=1),

2209

frozenset((token_time, token_end)))

2210

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

2211

datetime.timedelta(weeks=4),

2212

frozenset((token_day, token_end)))

2213

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

2214

datetime.timedelta(weeks=52),

2215

frozenset((token_month, token_end)))

2216

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

2217

datetime.timedelta(weeks=1),

2218

frozenset((token_end, )))

2219

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

2220

frozenset((token_year, token_month,

2221

token_day, token_time,

2222

token_week)))

2223

# Define starting values

2224

value = datetime.timedelta() # Value so far

2225

found_token = None

2226

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

2227

s = duration # String left to parse

2228

# Loop until end token is found

2229

while found_token is not token_end:

2230

# Search for any currently valid tokens

2231

for token in followers:

2232

match = token.regexp.match(s)

2233

if match is not None:

2234

# Token found

2235

if token.value is not None:

2236

# Value found, parse digits

2237

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

2238

# Add to value so far

2239

value += factor * token.value

2240

# Strip token from string

2241

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

2242

# Go to found token

2243

found_token = token

2244

# Set valid next tokens

2245

followers = found_token.followers

2246

break

2247

else:

2248

# No currently valid tokens were found

2249

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

2250

.format(duration))

2251

# End token found

2252

return value

2253

2254

2255

1731

def string_to_delta(interval):

2256

1732

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

2257

1733

2268

1744

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

2269

1745

datetime.timedelta(0, 330)

2270

1746

"""

2271

2272

try:

2273

return rfc3339_duration_to_delta(interval)

2274

except ValueError:

2275

pass

2276

2277

1747

timevalue = datetime.timedelta(0)

2278

1748

for s in interval.split():

2279

1749

try:

2280

suffix = s[-1]

1750

suffix = unicode(s[-1])

2281

1751

value = int(s[:-1])

2282

1752

if suffix == "d":

2283

1753

delta = datetime.timedelta(value)

2290

1760

elif suffix == "w":

2291

1761

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

2292

1762

else:

2293

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

2294

except IndexError as e:

1763

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

1764

except (ValueError, IndexError) as e:

2295

1765

raise ValueError(*(e.args))

2296

1766

timevalue += delta

2297

1767

return timevalue

2298

1768

2299

1769

1770

def if_nametoindex(interface):

1771

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

1772

1773

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

1774

global if_nametoindex

1775

try:

1776

if_nametoindex = (ctypes.cdll.LoadLibrary

1777

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

1778

.if_nametoindex)

1779

except (OSError, AttributeError):

1780

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

1781

def if_nametoindex(interface):

1782

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

1783

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

1784

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

1785

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1786

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

1787

interface))

1788

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

1789

ifreq[16:20])[0]

1790

return interface_index

1791

return if_nametoindex(interface)

1792

1793

2300

1794

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

2301

1795

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

2302

1796

2310

1804

sys.exit()

2311

1805

if not noclose:

2312

1806

# Close all standard open file descriptors

2313

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

1807

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

2314

1808

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

2315

1809

raise OSError(errno.ENODEV,

2316

"{} not a character device"

2317

.format(os.devnull))

1810

"%s not a character device"

1811

% os.path.devnull)

2318

1812

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

2319

1813

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

2320

1814

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

2329

1823

2330

1824

parser = argparse.ArgumentParser()

2331

1825

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

2332

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

1826

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

2333

1827

help="show version number and exit")

2334

1828

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

2335

1829

help="Bind to interface IF")

2341

1835

help="Run self-test")

2342

1836

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

2343

1837

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

2344

" to terminal", default=None)

1838

" to terminal")

2345

1839

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

2346

1840

help="Debug level for stdout output")

2347

1841

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

2354

1848

" files")

2355

1849

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

2356

1850

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

2357

" system bus interface", default=None)

1851

" system bus interface")

2358

1852

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

2359

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

2360

default=None)

2361

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

2362

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

2363

" state", default=None)

2364

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

2365

help="Specify a file descriptor to a network"

2366

" socket to use instead of creating one")

2367

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

2368

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

2369

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

2370

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

2371

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

2372

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

2373

default=None)

2374

1853

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

2375

1854

options = parser.parse_args()

2376

1855

2377

1856

if options.check:

2378

1857

import doctest

2379

fail_count, test_count = doctest.testmod()

2380

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

1858

doctest.testmod()

1859

sys.exit()

2381

1860

2382

1861

# Default values for config file for server-global settings

2383

1862

server_defaults = { "interface": "",

2385

1864

"port": "",

2386

1865

"debug": "False",

2387

1866

"priority":

2388

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

2389

":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

1867

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

2390

1868

"servicename": "Mandos",

2391

1869

"use_dbus": "True",

2392

1870

"use_ipv6": "True",

2393

1871

"debuglevel": "",

2394

"restore": "True",

2395

"socket": "",

2396

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

2397

"foreground": "False",

2398

"zeroconf": "True",

2399

}

1872

}

2400

1873

2401

1874

# Parse config file for server-global settings

2402

1875

server_config = configparser.SafeConfigParser(server_defaults)

2403

1876

del server_defaults

2404

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

1877

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

1878

"mandos.conf"))

2405

1879

# Convert the SafeConfigParser object to a dict

2406

1880

server_settings = server_config.defaults()

2407

1881

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

2408

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

1882

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

2409

1883

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

2410

1884

option)

2411

1885

if server_settings["port"]:

2412

1886

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

2413

1887

"port")

2414

if server_settings["socket"]:

2415

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

2416

"socket")

2417

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

2418

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

2419

# happen with a supplied network socket.

2420

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

2421

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

2422

["socket"])

2423

1888

del server_config

2424

1889

2425

1890

# Override the settings from the config file with command line

2426

1891

# options, if set.

2427

1892

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

2428

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

2429

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

2430

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

1893

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

1894

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

2431

1895

value = getattr(options, option)

2432

1896

if value is not None:

2433

1897

server_settings[option] = value

2434

1898

del options

2435

1899

# Force all strings to be unicode

2436

1900

for option in server_settings.keys():

2437

if isinstance(server_settings[option], bytes):

2438

server_settings[option] = (server_settings[option]

2439

.decode("utf-8"))

2440

# Force all boolean options to be boolean

2441

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

2442

"foreground", "zeroconf"):

2443

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

2444

# Debug implies foreground

2445

if server_settings["debug"]:

2446

server_settings["foreground"] = True

1901

if type(server_settings[option]) is str:

1902

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

2447

1903

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

2448

1904

2449

1905

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

2450

1906

2451

if (not server_settings["zeroconf"]

2452

and not (server_settings["port"]

2453

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

2454

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

2455

2456

1907

# For convenience

2457

1908

debug = server_settings["debug"]

2458

1909

debuglevel = server_settings["debuglevel"]

2459

1910

use_dbus = server_settings["use_dbus"]

2460

1911

use_ipv6 = server_settings["use_ipv6"]

2461

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

2462

stored_state_file)

2463

foreground = server_settings["foreground"]

2464

zeroconf = server_settings["zeroconf"]

2465

2466

if debug:

2467

initlogger(debug, logging.DEBUG)

2468

else:

2469

if not debuglevel:

2470

initlogger(debug)

2471

else:

2472

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

2473

initlogger(debug, level)

2474

1912

2475

1913

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

2476

syslogger.setFormatter(

2477

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

2478

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

2479

server_settings["servicename"])))

1914

syslogger.setFormatter(logging.Formatter

1915

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

1916

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

1917

% server_settings["servicename"]))

2480

1918

2481

1919

# Parse config file with clients

2482

client_config = configparser.SafeConfigParser(Client

2483

.client_defaults)

1920

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

1921

"extended_timeout": "15m",

1922

"interval": "2m",

1923

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

1924

"host": "",

1925

"approval_delay": "0s",

1926

"approval_duration": "1s",

1927

}

1928

client_config = configparser.SafeConfigParser(client_defaults)

2484

1929

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

2485

1930

"clients.conf"))

2486

1931

2487

1932

global mandos_dbus_service

2488

1933

mandos_dbus_service = None

2489

1934

2490

socketfd = None

2491

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

2492

socketfd = server_settings["socket"]

2493

tcp_server = MandosServer(

2494

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

2495

ClientHandler,

2496

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

2497

use_ipv6=use_ipv6,

2498

gnutls_priority=server_settings["priority"],

2499

use_dbus=use_dbus,

2500

socketfd=socketfd)

2501

if not foreground:

2502

pidfilename = "/run/mandos.pid"

2503

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

2504

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

2505

pidfile = None

1935

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

1936

server_settings["port"]),

1937

ClientHandler,

1938

interface=(server_settings["interface"]

1939

or None),

1940

use_ipv6=use_ipv6,

1941

gnutls_priority=

1942

server_settings["priority"],

1943

use_dbus=use_dbus)

1944

if not debug:

1945

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

2506

1946

try:

2507

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

2508

except IOError as e:

2509

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

2510

exc_info=e)

1947

pidfile = open(pidfilename, "w")

1948

except IOError:

1949

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

2511

1950

2512

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

1951

try:

1952

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

1953

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

1954

except KeyError:

2513

1955

try:

2514

uid = pwd.getpwnam(name).pw_uid

2515

gid = pwd.getpwnam(name).pw_gid

2516

break

1956

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

1957

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

2517

1958

except KeyError:

2518

continue

2519

else:

2520

uid = 65534

2521

gid = 65534

1959

try:

1960

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

1961

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

1962

except KeyError:

1963

uid = 65534

1964

gid = 65534

2522

1965

try:

2523

1966

os.setgid(gid)

2524

1967

os.setuid(uid)

2525

1968

except OSError as error:

2526

if error.errno != errno.EPERM:

2527

raise

1969

if error[0] != errno.EPERM:

1970

raise error

1971

1972

if not debug and not debuglevel:

1973

syslogger.setLevel(logging.WARNING)

1974

console.setLevel(logging.WARNING)

1975

if debuglevel:

1976

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

1977

syslogger.setLevel(level)

1978

console.setLevel(level)

2528

1979

2529

1980

if debug:

2530

1981

# Enable all possible GnuTLS debugging

2537

1988

def debug_gnutls(level, string):

2538

1989

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

2539

1990

2540

gnutls.library.functions.gnutls_global_set_log_function(

2541

debug_gnutls)

1991

(gnutls.library.functions

1992

.gnutls_global_set_log_function(debug_gnutls))

2542

1993

2543

1994

# Redirect stdin so all checkers get /dev/null

2544

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

1995

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

2545

1996

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

2546

1997

if null > 2:

2547

1998

os.close(null)

1999

else:

2000

# No console logging

2001

logger.removeHandler(console)

2548

2002

2549

2003

# Need to fork before connecting to D-Bus

2550

if not foreground:

2004

if not debug:

2551

2005

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

2552

2006

daemon()

2553

2007

2554

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

2555

# need to inform gobject that threads will be used.

2556

gobject.threads_init()

2557

2558

2008

global main_loop

2559

2009

# From the Avahi example code

2560

DBusGMainLoop(set_as_default=True)

2010

DBusGMainLoop(set_as_default=True )

2561

2011

main_loop = gobject.MainLoop()

2562

2012

bus = dbus.SystemBus()

2563

2013

# End of Avahi example code

2564

2014

if use_dbus:

2565

2015

try:

2566

2016

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

2567

bus,

2568

do_not_queue=True)

2569

old_bus_name = dbus.service.BusName(

2570

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

2571

do_not_queue=True)

2572

except dbus.exceptions.DBusException as e:

2573

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

2017

bus, do_not_queue=True)

2018

old_bus_name = (dbus.service.BusName

2019

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

2020

do_not_queue=True))

2021

except dbus.exceptions.NameExistsException as e:

2022

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

2574

2023

use_dbus = False

2575

2024

server_settings["use_dbus"] = False

2576

2025

tcp_server.use_dbus = False

2577

if zeroconf:

2578

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2579

service = AvahiServiceToSyslog(

2580

name = server_settings["servicename"],

2581

servicetype = "_mandos._tcp",

2582

protocol = protocol,

2583

bus = bus)

2584

if server_settings["interface"]:

2585

service.interface = if_nametoindex(

2586

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

2026

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2027

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

2028

servicetype = "_mandos._tcp",

2029

protocol = protocol, bus = bus)

2030

if server_settings["interface"]:

2031

service.interface = (if_nametoindex

2032

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

2587

2033

2588

2034

global multiprocessing_manager

2589

2035

multiprocessing_manager = multiprocessing.Manager()

2590

2036

2591

2037

client_class = Client

2592

2038

if use_dbus:

2593

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

2594

2595

client_settings = Client.config_parser(client_config)

2596

old_client_settings = {}

2597

clients_data = {}

2598

2599

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

2600

global wnull

2601

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

2602

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

2603

# mode

2604

if debug or not foreground:

2605

wnull.close()

2606

2607

# Get client data and settings from last running state.

2608

if server_settings["restore"]:

2609

try:

2610

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

2611

clients_data, old_client_settings = pickle.load(

2612

stored_state)

2613

os.remove(stored_state_path)

2614

except IOError as e:

2615

if e.errno == errno.ENOENT:

2616

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

2617

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

2618

else:

2619

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

2620

exc_info=e)

2621

raise

2622

except EOFError as e:

2623

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

2624

"EOFError:",

2625

exc_info=e)

2626

2627

with PGPEngine() as pgp:

2628

for client_name, client in clients_data.items():

2629

# Skip removed clients

2630

if client_name not in client_settings:

2631

continue

2632

2633

# Decide which value to use after restoring saved state.

2634

# We have three different values: Old config file,

2635

# new config file, and saved state.

2636

# New config value takes precedence if it differs from old

2637

# config value, otherwise use saved state.

2638

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

2639

try:

2640

# For each value in new config, check if it

2641

# differs from the old config value (Except for

2642

# the "secret" attribute)

2643

if (name != "secret"

2644

and (value !=

2645

old_client_settings[client_name][name])):

2646

client[name] = value

2647

except KeyError:

2648

pass

2649

2650

# Clients who has passed its expire date can still be

2651

# enabled if its last checker was successful. A Client

2652

# whose checker succeeded before we stored its state is

2653

# assumed to have successfully run all checkers during

2654

# downtime.

2655

if client["enabled"]:

2656

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

2657

if not client["last_checked_ok"]:

2658

logger.warning(

2659

"disabling client {} - Client never "

2660

"performed a successful checker".format(

2661

client_name))

2662

client["enabled"] = False

2663

elif client["last_checker_status"] != 0:

2664

logger.warning(

2665

"disabling client {} - Client last"

2666

" checker failed with error code"

2667

" {}".format(

2668

client_name,

2669

client["last_checker_status"]))

2670

client["enabled"] = False

2671

else:

2672

client["expires"] = (

2673

datetime.datetime.utcnow()

2674

+ client["timeout"])

2675

logger.debug("Last checker succeeded,"

2676

" keeping {} enabled".format(

2677

client_name))

2039

client_class = functools.partial(ClientDBusTransitional,

2040

bus = bus)

2041

def client_config_items(config, section):

2042

special_settings = {

2043

"approved_by_default":

2044

lambda: config.getboolean(section,

2045

"approved_by_default"),

2046

}

2047

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

2678

2048

try:

2679

client["secret"] = pgp.decrypt(

2680

client["encrypted_secret"],

2681

client_settings[client_name]["secret"])

2682

except PGPError:

2683

# If decryption fails, we use secret from new settings

2684

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

2685

client_name))

2686

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

2687

["secret"])

2688

2689

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

2690

for client_name in (set(old_client_settings)

2691

- set(client_settings)):

2692

del clients_data[client_name]

2693

for client_name in (set(client_settings)

2694

- set(old_client_settings)):

2695

clients_data[client_name] = client_settings[client_name]

2696

2697

# Create all client objects

2698

for client_name, client in clients_data.items():

2699

tcp_server.clients[client_name] = client_class(

2700

name = client_name,

2701

settings = client,

2702

server_settings = server_settings)

2703

2049

yield (name, special_settings[name]())

2050

except KeyError:

2051

yield (name, value)

2052

2053

tcp_server.clients.update(set(

2054

client_class(name = section,

2055

config= dict(client_config_items(

2056

client_config, section)))

2057

for section in client_config.sections()))

2704

2058

if not tcp_server.clients:

2705

2059

logger.warning("No clients defined")

2706

2707

if not foreground:

2708

if pidfile is not None:

2709

pid = os.getpid()

2710

try:

2711

with pidfile:

2712

print(pid, file=pidfile)

2713

except IOError:

2714

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

2715

pidfilename, pid)

2716

del pidfile

2060

2061

if not debug:

2062

try:

2063

with pidfile:

2064

pid = os.getpid()

2065

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

2066

del pidfile

2067

except IOError:

2068

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

2069

pidfilename, pid)

2070

except NameError:

2071

# "pidfile" was never created

2072

pass

2717

2073

del pidfilename

2074

2075

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

2718

2076

2719

2077

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

2720

2078

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

2721

2079

2722

2080

if use_dbus:

2723

2724

@alternate_dbus_interfaces(

2725

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

2726

class MandosDBusService(DBusObjectWithProperties):

2081

class MandosDBusService(dbus.service.Object):

2727

2082

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

2728

2729

2083

def __init__(self):

2730

2084

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

2731

2732

2085

_interface = "se.recompile.Mandos"

2733

2086

2734

@dbus_interface_annotations(_interface)

2735

def _foo(self):

2736

return {

2737

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

2738

"false" }

2739

2740

2087

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

2741

2088

def ClientAdded(self, objpath):

2742

2089

"D-Bus signal"

2755

2102

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

2756

2103

def GetAllClients(self):

2757

2104

"D-Bus method"

2758

return dbus.Array(c.dbus_object_path for c in

2759

tcp_server.clients.itervalues())

2105

return dbus.Array(c.dbus_object_path

2106

for c in tcp_server.clients)

2760

2107

2761

2108

@dbus.service.method(_interface,

2762

2109

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

2763

2110

def GetAllClientsWithProperties(self):

2764

2111

"D-Bus method"

2765

2112

return dbus.Dictionary(

2766

{ c.dbus_object_path: c.GetAll("")

2767

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

2113

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

2114

for c in tcp_server.clients),

2768

2115

signature="oa{sv}")

2769

2116

2770

2117

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

2771

2118

def RemoveClient(self, object_path):

2772

2119

"D-Bus method"

2773

for c in tcp_server.clients.itervalues():

2120

for c in tcp_server.clients:

2774

2121

if c.dbus_object_path == object_path:

2775

del tcp_server.clients[c.name]

2122

tcp_server.clients.remove(c)

2776

2123

c.remove_from_connection()

2777

2124

# Don't signal anything except ClientRemoved

2778

2125

c.disable(quiet=True)

2783

2130

2784

2131

del _interface

2785

2132

2786

mandos_dbus_service = MandosDBusService()

2133

class MandosDBusServiceTransitional(MandosDBusService):

2134

__metaclass__ = AlternateDBusNamesMetaclass

2135

mandos_dbus_service = MandosDBusServiceTransitional()

2787

2136

2788

2137

def cleanup():

2789

2138

"Cleanup function; run on exit"

2790

if zeroconf:

2791

service.cleanup()

2139

service.cleanup()

2792

2140

2793

2141

multiprocessing.active_children()

2794

wnull.close()

2795

if not (tcp_server.clients or client_settings):

2796

return

2797

2798

# Store client before exiting. Secrets are encrypted with key

2799

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

2800

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

2801

clients = {}

2802

with PGPEngine() as pgp:

2803

for client in tcp_server.clients.itervalues():

2804

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

2805

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

2806

key)

2807

client_dict = {}

2808

2809

# A list of attributes that can not be pickled

2810

# + secret.

2811

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

2812

"checker", "server_settings" }

2813

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

2814

.Object):

2815

exclude.add(name)

2816

2817

client_dict["encrypted_secret"] = (client

2818

.encrypted_secret)

2819

for attr in client.client_structure:

2820

if attr not in exclude:

2821

client_dict[attr] = getattr(client, attr)

2822

2823

clients[client.name] = client_dict

2824

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

2825

2826

try:

2827

with tempfile.NamedTemporaryFile(

2828

mode='wb',

2829

suffix=".pickle",

2830

prefix='clients-',

2831

dir=os.path.dirname(stored_state_path),

2832

delete=False) as stored_state:

2833

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

2834

tempname = stored_state.name

2835

os.rename(tempname, stored_state_path)

2836

except (IOError, OSError) as e:

2837

if not debug:

2838

try:

2839

os.remove(tempname)

2840

except NameError:

2841

pass

2842

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

2843

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

2844

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

2845

else:

2846

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

2847

exc_info=e)

2848

raise

2849

2850

# Delete all clients, and settings from config

2851

2142

while tcp_server.clients:

2852

name, client = tcp_server.clients.popitem()

2143

client = tcp_server.clients.pop()

2853

2144

if use_dbus:

2854

2145

client.remove_from_connection()

2146

client.disable_hook = None

2855

2147

# Don't signal anything except ClientRemoved

2856

2148

client.disable(quiet=True)

2857

2149

if use_dbus:

2858

2150

# Emit D-Bus signal

2859

mandos_dbus_service.ClientRemoved(

2860

client.dbus_object_path, client.name)

2861

client_settings.clear()

2151

mandos_dbus_service.ClientRemoved(client

2152

.dbus_object_path,

2153

client.name)

2862

2154

2863

2155

atexit.register(cleanup)

2864

2156

2865

for client in tcp_server.clients.itervalues():

2157

for client in tcp_server.clients:

2866

2158

if use_dbus:

2867

2159

# Emit D-Bus signal

2868

2160

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2869

# Need to initiate checking of clients

2870

if client.enabled:

2871

client.init_checker()

2161

client.enable()

2872

2162

2873

2163

tcp_server.enable()

2874

2164

tcp_server.server_activate()

2875

2165

2876

2166

# Find out what port we got

2877

if zeroconf:

2878

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

2167

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

2879

2168

if use_ipv6:

2880

2169

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

2881

" flowinfo %d, scope_id %d",

2882

*tcp_server.socket.getsockname())

2170

" flowinfo %d, scope_id %d"

2171

% tcp_server.socket.getsockname())

2883

2172

else: # IPv4

2884

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

2885

*tcp_server.socket.getsockname())

2173

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

2174

% tcp_server.socket.getsockname())

2886

2175

2887

2176

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

2888

2177

2889

2178

try:

2890

if zeroconf:

2891

# From the Avahi example code

2892

try:

2893

service.activate()

2894

except dbus.exceptions.DBusException as error:

2895

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

2896

cleanup()

2897

sys.exit(1)

2898

# End of Avahi example code

2179

# From the Avahi example code

2180

try:

2181

service.activate()

2182

except dbus.exceptions.DBusException as error:

2183

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

2184

cleanup()

2185

sys.exit(1)

2186

# End of Avahi example code

2899

2187

2900

2188

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

2901

2189

lambda *args, **kwargs:

2905

2193

logger.debug("Starting main loop")

2906

2194

main_loop.run()

2907

2195

except AvahiError as error:

2908

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

2196

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

2909

2197

cleanup()

2910

2198

sys.exit(1)

2911

2199

except KeyboardInterrupt: