/mandos/release : revision 237.7.51

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

28

# along with this program. If not, see

29

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

30

#

31

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

31

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

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

37

import SocketServer as socketserver

43

38

import socket

44

39

import argparse

45

40

import datetime

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

import types

77

import binascii

78

import tempfile

79

import itertools

80

import collections

81

import codecs

82

65

83

66

import dbus

84

67

import dbus.service

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

68

import gobject

89

69

import avahi

90

70

from dbus.mainloop.glib import DBusGMainLoop

91

71

import ctypes

101

81

except ImportError:

102

82

SO_BINDTODEVICE = None

103

83

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

84

85

version = "1.3.1"

86

87

#logger = logging.getLogger('mandos')

88

logger = logging.Logger('mandos')

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

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

92

syslogger.setFormatter(logging.Formatter

93

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

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

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

99

' %(levelname)s:'

100

' %(message)s'))

101

logger.addHandler(console)

236

102

237

103

class AvahiError(Exception):

238

104

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

239

105

self.value = value

240

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

241

**kwargs)

242

106

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

107

def __unicode__(self):

108

return unicode(repr(self.value))

243

109

244

110

class AvahiServiceError(AvahiError):

245

111

pass

246

112

247

248

113

class AvahiGroupError(AvahiError):

249

114

pass

250

115

257

122

Used to optionally bind to the specified interface.

258

123

name: string; Example: 'Mandos'

259

124

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

260

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

125

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

261

126

port: integer; what port to announce

262

127

TXT: list of strings; TXT record for the service

263

128

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

269

134

server: D-Bus Server

270

135

bus: dbus.SystemBus()

271

136

"""

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

137

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

138

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

139

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

140

protocol = avahi.PROTO_UNSPEC, bus = None):

284

141

self.interface = interface

285

142

self.name = name

286

143

self.type = servicetype

295

152

self.server = None

296

153

self.bus = bus

297

154

self.entry_group_state_changed_match = None

298

299

def rename(self, remove=True):

155

def rename(self):

300

156

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

301

157

if self.rename_count >= self.max_renames:

302

158

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

303

159

" after %i retries, exiting.",

304

160

self.rename_count)

305

161

raise AvahiServiceError("Too many renames")

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

162

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

309

163

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

310

164

self.name)

311

if remove:

312

self.remove()

165

syslogger.setFormatter(logging.Formatter

166

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

167

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

168

% self.name))

169

self.remove()

313

170

try:

314

171

self.add()

315

172

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

173

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

174

self.cleanup()

175

os._exit(1)

176

self.rename_count += 1

325

177

def remove(self):

326

178

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

327

179

if self.entry_group_state_changed_match is not None:

329

181

self.entry_group_state_changed_match = None

330

182

if self.group is not None:

331

183

self.group.Reset()

332

333

184

def add(self):

334

185

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

335

186

self.remove()

340

191

avahi.DBUS_INTERFACE_ENTRY_GROUP)

341

192

self.entry_group_state_changed_match = (

342

193

self.group.connect_to_signal(

343

'StateChanged', self.entry_group_state_changed))

194

'StateChanged', self .entry_group_state_changed))

344

195

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

345

196

self.name, self.type)

346

197

self.group.AddService(

352

203

dbus.UInt16(self.port),

353

204

avahi.string_array_to_txt_array(self.TXT))

354

205

self.group.Commit()

355

356

206

def entry_group_state_changed(self, state, error):

357

207

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

358

208

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

364

214

self.rename()

365

215

elif state == avahi.ENTRY_GROUP_FAILURE:

366

216

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

367

str(error))

368

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

369

217

unicode(error))

218

raise AvahiGroupError("State changed: %s"

219

% unicode(error))

370

220

def cleanup(self):

371

221

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

372

222

if self.group is not None:

373

223

try:

374

224

self.group.Free()

375

225

except (dbus.exceptions.UnknownMethodException,

376

dbus.exceptions.DBusException):

226

dbus.exceptions.DBusException) as e:

377

227

pass

378

228

self.group = None

379

229

self.remove()

380

381

230

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

382

231

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

383

232

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

}

233

bad_states = { avahi.SERVER_INVALID:

234

"Zeroconf server invalid",

235

avahi.SERVER_REGISTERING: None,

236

avahi.SERVER_COLLISION:

237

"Zeroconf server name collision",

238

avahi.SERVER_FAILURE:

239

"Zeroconf server failure" }

390

240

if state in bad_states:

391

241

if bad_states[state] is not None:

392

242

if error is None:

395

245

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

396

246

self.cleanup()

397

247

elif state == avahi.SERVER_RUNNING:

398

try:

399

self.add()

400

except dbus.exceptions.DBusException as error:

401

if (error.get_dbus_name()

402

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

403

logger.info("Local Zeroconf service name"

404

" collision.")

405

return self.rename(remove=False)

406

else:

407

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

408

self.cleanup()

409

os._exit(1)

248

self.add()

410

249

else:

411

250

if error is None:

412

251

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

413

252

else:

414

253

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

415

416

254

def activate(self):

417

255

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

418

256

if self.server is None:

422

260

follow_name_owner_changes=True),

423

261

avahi.DBUS_INTERFACE_SERVER)

424

262

self.server.connect_to_signal("StateChanged",

425

self.server_state_changed)

263

self.server_state_changed)

426

264

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

427

265

428

266

429

class AvahiServiceToSyslog(AvahiService):

430

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

431

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

432

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

433

syslogger.setFormatter(logging.Formatter(

434

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

435

.format(self.name)))

436

return ret

437

438

def call_pipe(connection, # : multiprocessing.Connection

439

func, *args, **kwargs):

440

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

441

442

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

443

return value on the provided multiprocessing.Connection.

444

"""

445

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

446

connection.close()

447

267

def _timedelta_to_milliseconds(td):

268

"Convert a datetime.timedelta() to milliseconds"

269

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

270

+ (td.seconds * 1000)

271

+ (td.microseconds // 1000))

272

448

273

class Client(object):

449

274

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

450

275

451

276

Attributes:

452

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

277

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

453

278

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

454

279

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

455

280

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

462

287

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

463

288

checker_initiator_tag: a gobject event source tag, or None

464

289

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

465

client_structure: Object describing what attributes a client has

466

and is used for storing the client at exit

467

290

current_checker_command: string; current running checker_command

291

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

468

292

disable_initiator_tag: a gobject event source tag, or None

469

293

enabled: bool()

470

294

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

473

297

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

474

298

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

475

299

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

476

last_checker_status: integer between 0 and 255 reflecting exit

477

status of last checker. -1 reflects crashed

478

checker, -2 means no checker completed yet.

479

last_checker_signal: The signal which killed the last checker, if

480

last_checker_status is -1

481

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

300

last_enabled: datetime.datetime(); (UTC)

482

301

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

483

302

D-Bus identifiers

484

303

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

485

304

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

486

305

until this client is disabled

487

extended_timeout: extra long timeout when secret has been sent

306

extended_timeout: extra long timeout when password has been sent

488

307

runtime_expansions: Allowed attributes for runtime expansion.

489

308

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

490

309

disabled, or None

491

server_settings: The server_settings dict from main()

492

310

"""

493

311

494

312

runtime_expansions = ("approval_delay", "approval_duration",

495

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

496

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

497

"last_approval_request", "last_checked_ok",

313

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

314

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

498

315

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

499

client_defaults = {

500

"timeout": "PT5M",

501

"extended_timeout": "PT15M",

502

"interval": "PT2M",

503

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

504

"host": "",

505

"approval_delay": "PT0S",

506

"approval_duration": "PT1S",

507

"approved_by_default": "True",

508

"enabled": "True",

509

}

510

511

@staticmethod

512

def config_parser(config):

513

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

514

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

515

with exceptions for any special settings as defined above.

516

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

517

value given the same arguments.

518

"""

519

settings = {}

520

for client_name in config.sections():

521

section = dict(config.items(client_name))

522

client = settings[client_name] = {}

523

524

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

525

# Reformat values from string types to Python types

526

client["approved_by_default"] = config.getboolean(

527

client_name, "approved_by_default")

528

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

529

"enabled")

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

534

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

535

.replace(" ", ""))

536

if "secret" in section:

537

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

538

elif "secfile" in section:

539

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

540

(section["secfile"])),

541

"rb") as secfile:

542

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

543

else:

544

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

545

.format(section))

546

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

547

client["extended_timeout"] = string_to_delta(

548

section["extended_timeout"])

549

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

550

client["approval_delay"] = string_to_delta(

551

section["approval_delay"])

552

client["approval_duration"] = string_to_delta(

553

section["approval_duration"])

554

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

555

client["last_approval_request"] = None

556

client["last_checked_ok"] = None

557

client["last_checker_status"] = -2

558

559

return settings

560

561

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

316

317

def timeout_milliseconds(self):

318

"Return the 'timeout' attribute in milliseconds"

319

return _timedelta_to_milliseconds(self.timeout)

320

321

def extended_timeout_milliseconds(self):

322

"Return the 'extended_timeout' attribute in milliseconds"

323

return _timedelta_to_milliseconds(self.extended_timeout)

324

325

def interval_milliseconds(self):

326

"Return the 'interval' attribute in milliseconds"

327

return _timedelta_to_milliseconds(self.interval)

328

329

def approval_delay_milliseconds(self):

330

return _timedelta_to_milliseconds(self.approval_delay)

331

332

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

333

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

334

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

335

attribute."""

562

336

self.name = name

563

if server_settings is None:

564

server_settings = {}

565

self.server_settings = server_settings

566

# adding all client settings

567

for setting, value in settings.items():

568

setattr(self, setting, value)

569

570

if self.enabled:

571

if not hasattr(self, "last_enabled"):

572

self.last_enabled = datetime.datetime.utcnow()

573

if not hasattr(self, "expires"):

574

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

575

+ self.timeout)

576

else:

577

self.last_enabled = None

578

self.expires = None

579

337

if config is None:

338

config = {}

580

339

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

340

# Uppercase and remove spaces from fingerprint for later

341

# comparison purposes with return value from the fingerprint()

342

# function

343

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

344

.replace(" ", ""))

581

345

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

582

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

583

datetime.datetime.utcnow())

584

585

# attributes specific for this server instance

346

if "secret" in config:

347

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

348

elif "secfile" in config:

349

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

350

(config["secfile"])),

351

"rb") as secfile:

352

self.secret = secfile.read()

353

else:

354

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

355

% self.name)

356

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

357

self.created = datetime.datetime.utcnow()

358

self.enabled = False

359

self.last_approval_request = None

360

self.last_enabled = None

361

self.last_checked_ok = None

362

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

363

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

364

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

365

self.disable_hook = disable_hook

586

366

self.checker = None

587

367

self.checker_initiator_tag = None

588

368

self.disable_initiator_tag = None

369

self.expires = None

589

370

self.checker_callback_tag = None

371

self.checker_command = config["checker"]

590

372

self.current_checker_command = None

591

self.approved = None

373

self.last_connect = None

374

self._approved = None

375

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

376

True)

592

377

self.approvals_pending = 0

593

self.changedstate = multiprocessing_manager.Condition(

594

multiprocessing_manager.Lock())

595

self.client_structure = [attr

596

for attr in self.__dict__.iterkeys()

597

if not attr.startswith("_")]

598

self.client_structure.append("client_structure")

599

600

for name, t in inspect.getmembers(

601

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

602

if not name.startswith("_"):

603

self.client_structure.append(name)

378

self.approval_delay = string_to_delta(

379

config["approval_delay"])

380

self.approval_duration = string_to_delta(

381

config["approval_duration"])

382

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

604

383

605

# Send notice to process children that client state has changed

606

384

def send_changedstate(self):

607

with self.changedstate:

608

self.changedstate.notify_all()

609

385

self.changedstate.acquire()

386

self.changedstate.notify_all()

387

self.changedstate.release()

388

610

389

def enable(self):

611

390

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

612

391

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

613

392

# Already enabled

614

393

return

394

self.send_changedstate()

395

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

396

# and every interval from then on.

397

self.checker_initiator_tag = (gobject.timeout_add

398

(self.interval_milliseconds(),

399

self.start_checker))

400

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

615

401

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

402

self.disable_initiator_tag = (gobject.timeout_add

403

(self.timeout_milliseconds(),

404

self.disable))

616

405

self.enabled = True

617

406

self.last_enabled = datetime.datetime.utcnow()

618

self.init_checker()

619

self.send_changedstate()

407

# Also start a new checker *right now*.

408

self.start_checker()

620

409

621

410

def disable(self, quiet=True):

622

411

"""Disable this client."""

623

412

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

624

413

return False

625

414

if not quiet:

415

self.send_changedstate()

416

if not quiet:

626

417

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

627

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

418

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

628

419

gobject.source_remove(self.disable_initiator_tag)

629

420

self.disable_initiator_tag = None

630

421

self.expires = None

631

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

422

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

632

423

gobject.source_remove(self.checker_initiator_tag)

633

424

self.checker_initiator_tag = None

634

425

self.stop_checker()

426

if self.disable_hook:

427

self.disable_hook(self)

635

428

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

638

429

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

639

430

return False

640

431

641

432

def __del__(self):

433

self.disable_hook = None

642

434

self.disable()

643

435

644

def init_checker(self):

645

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

646

# and every interval from then on.

647

if self.checker_initiator_tag is not None:

648

gobject.source_remove(self.checker_initiator_tag)

649

self.checker_initiator_tag = gobject.timeout_add(

650

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

651

self.start_checker)

652

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

653

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = gobject.timeout_add(

656

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

657

# Also start a new checker *right now*.

658

self.start_checker()

659

660

def checker_callback(self, source, condition, connection,

661

command):

436

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

662

437

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

663

438

self.checker_callback_tag = None

664

439

self.checker = None

665

# Read return code from connection (see call_pipe)

666

returncode = connection.recv()

667

connection.close()

668

669

if returncode >= 0:

670

self.last_checker_status = returncode

671

self.last_checker_signal = None

672

if self.last_checker_status == 0:

440

if os.WIFEXITED(condition):

441

exitstatus = os.WEXITSTATUS(condition)

442

if exitstatus == 0:

673

443

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

674

444

vars(self))

675

445

self.checked_ok()

676

446

else:

677

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

447

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

448

vars(self))

678

449

else:

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

681

450

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

682

451

vars(self))

683

return False

684

685

def checked_ok(self):

686

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

687

self.last_checked_ok = datetime.datetime.utcnow()

688

self.last_checker_status = 0

689

self.last_checker_signal = None

690

self.bump_timeout()

691

692

def bump_timeout(self, timeout=None):

693

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

452

453

def checked_ok(self, timeout=None):

454

"""Bump up the timeout for this client.

455

456

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

457

alive and well.

458

"""

694

459

if timeout is None:

695

460

timeout = self.timeout

696

if self.disable_initiator_tag is not None:

697

gobject.source_remove(self.disable_initiator_tag)

698

self.disable_initiator_tag = None

699

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

700

self.disable_initiator_tag = gobject.timeout_add(

701

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

702

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

461

self.last_checked_ok = datetime.datetime.utcnow()

462

gobject.source_remove(self.disable_initiator_tag)

463

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

464

self.disable_initiator_tag = (gobject.timeout_add

465

(_timedelta_to_milliseconds(timeout),

466

self.disable))

703

467

704

468

def need_approval(self):

705

469

self.last_approval_request = datetime.datetime.utcnow()

710

474

If a checker already exists, leave it running and do

711

475

nothing."""

712

476

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

713

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

714

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

715

# would inevitably timeout, since no checker would get a

716

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

477

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

478

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

479

# client would inevitably timeout, since no checker would get

480

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

717

481

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

718

482

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

719

483

# should be.

720

484

721

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

722

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

723

self.checker.join()

724

self.checker = None

485

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

486

try:

487

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

488

except (AttributeError, OSError) as error:

489

if (isinstance(error, OSError)

490

and error.errno != errno.ECHILD):

491

raise error

492

else:

493

if pid:

494

logger.warning("Checker was a zombie")

495

gobject.source_remove(self.checker_callback_tag)

496

self.checker_callback(pid, status,

497

self.current_checker_command)

725

498

# Start a new checker if needed

726

499

if self.checker is None:

727

# Escape attributes for the shell

728

escaped_attrs = {

729

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

730

for attr in self.runtime_expansions }

731

500

try:

732

command = self.checker_command % escaped_attrs

733

except TypeError as error:

734

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

735

self.checker_command,

736

exc_info=error)

737

return True # Try again later

501

# In case checker_command has exactly one % operator

502

command = self.checker_command % self.host

503

except TypeError:

504

# Escape attributes for the shell

505

escaped_attrs = dict(

506

(attr,

507

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

508

errors=

509

'replace')))

510

for attr in

511

self.runtime_expansions)

512

513

try:

514

command = self.checker_command % escaped_attrs

515

except TypeError as error:

516

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

517

' %s', self.checker_command, error)

518

return True # Try again later

738

519

self.current_checker_command = command

739

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

740

self.name)

741

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

742

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

743

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

744

# always replaced by /dev/null.)

745

# The exception is when not debugging but nevertheless

746

# running in the foreground; use the previously

747

# created wnull.

748

popen_args = { "close_fds": True,

749

"shell": True,

750

"cwd": "/" }

751

if (not self.server_settings["debug"]

752

and self.server_settings["foreground"]):

753

popen_args.update({"stdout": wnull,

754

"stderr": wnull })

755

pipe = multiprocessing.Pipe(duplex = False)

756

self.checker = multiprocessing.Process(

757

target = call_pipe,

758

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

759

kwargs = popen_args)

760

self.checker.start()

761

self.checker_callback_tag = gobject.io_add_watch(

762

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

763

self.checker_callback, pipe[0], command)

520

try:

521

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

522

command, self.name)

523

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

524

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

525

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

526

# always replaced by /dev/null.)

527

self.checker = subprocess.Popen(command,

528

close_fds=True,

529

shell=True, cwd="/")

530

self.checker_callback_tag = (gobject.child_watch_add

531

(self.checker.pid,

532

self.checker_callback,

533

data=command))

534

# The checker may have completed before the gobject

535

# watch was added. Check for this.

536

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

537

if pid:

538

gobject.source_remove(self.checker_callback_tag)

539

self.checker_callback(pid, status, command)

540

except OSError as error:

541

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

542

error)

764

543

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

765

544

return True

766

545

772

551

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

773

552

return

774

553

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

775

self.checker.terminate()

554

try:

555

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

556

#time.sleep(0.5)

557

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

558

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

559

except OSError as error:

560

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

561

raise

776

562

self.checker = None

777

563

778

564

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

565

def dbus_service_property(dbus_interface, signature="v",

566

access="readwrite", byte_arrays=False):

783

567

"""Decorators for marking methods of a DBusObjectWithProperties to

784

568

become properties on the D-Bus.

785

569

794

578

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

795

579

if byte_arrays and signature != "ay":

796

580

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

797

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

798

581

" signature %r" % signature)

799

582

def decorator(func):

800

583

func._dbus_is_property = True

801

584

func._dbus_interface = dbus_interface

806

589

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

807

590

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

808

591

return func

809

810

return decorator

811

812

813

def dbus_interface_annotations(dbus_interface):

814

"""Decorator for marking functions returning interface annotations

815

816

Usage:

817

818

@dbus_interface_annotations("org.example.Interface")

819

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

820

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

821

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

822

"false"}

823

"""

824

825

def decorator(func):

826

func._dbus_is_interface = True

827

func._dbus_interface = dbus_interface

828

func._dbus_name = dbus_interface

829

return func

830

831

return decorator

832

833

834

def dbus_annotations(annotations):

835

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

836

Usage:

837

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

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

842

access="r")

843

def Property_dbus_property(self):

844

return dbus.Boolean(False)

845

"""

846

847

def decorator(func):

848

func._dbus_annotations = annotations

849

return func

850

851

592

return decorator

852

593

853

594

854

595

class DBusPropertyException(dbus.exceptions.DBusException):

855

596

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

856

597

"""

857

pass

598

def __unicode__(self):

599

return unicode(str(self))

858

600

859

601

860

602

class DBusPropertyAccessException(DBusPropertyException):

878

620

"""

879

621

880

622

@staticmethod

881

def _is_dbus_thing(thing):

882

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

883

884

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

885

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

886

"""

887

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

888

False)

623

def _is_dbus_property(obj):

624

return getattr(obj, "_dbus_is_property", False)

889

625

890

def _get_all_dbus_things(self, thing):

626

def _get_all_dbus_properties(self):

891

627

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

892

628

"""

893

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

894

athing.__get__(self))

895

for cls in self.__class__.__mro__

896

for name, athing in

897

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

629

return ((prop._dbus_name, prop)

630

for name, prop in

631

inspect.getmembers(self, self._is_dbus_property))

898

632

899

633

def _get_dbus_property(self, interface_name, property_name):

900

634

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

901

635

property with the specified name and interface.

902

636

"""

903

for cls in self.__class__.__mro__:

904

for name, value in inspect.getmembers(

905

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

906

if (value._dbus_name == property_name

907

and value._dbus_interface == interface_name):

908

return value.__get__(self)

909

637

for name in (property_name,

638

property_name + "_dbus_property"):

639

prop = getattr(self, name, None)

640

if (prop is None

641

or not self._is_dbus_property(prop)

642

or prop._dbus_name != property_name

643

or (interface_name and prop._dbus_interface

644

and interface_name != prop._dbus_interface)):

645

continue

646

return prop

910

647

# No such property

911

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

912

self.dbus_object_path, interface_name, property_name))

648

raise DBusPropertyNotFound(self.dbus_object_path + ":"

649

+ interface_name + "."

650

+ property_name)

913

651

914

@dbus.service.method(dbus.PROPERTIES_IFACE,

915

in_signature="ss",

652

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

916

653

out_signature="v")

917

654

def Get(self, interface_name, property_name):

918

655

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

936

673

# The byte_arrays option is not supported yet on

937

674

# signatures other than "ay".

938

675

if prop._dbus_signature != "ay":

939

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

940

"'ay' signature {!r}"

941

.format(prop._dbus_signature))

942

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

943

for byte in value))

676

raise ValueError

677

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

678

for byte in value))

944

679

prop(value)

945

680

946

@dbus.service.method(dbus.PROPERTIES_IFACE,

947

in_signature="s",

681

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

948

682

out_signature="a{sv}")

949

683

def GetAll(self, interface_name):

950

684

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

952

686

953

687

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

954

688

"""

955

properties = {}

956

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

689

all = {}

690

for name, prop in self._get_all_dbus_properties():

957

691

if (interface_name

958

692

and interface_name != prop._dbus_interface):

959

693

# Interface non-empty but did not match

963

697

continue

964

698

value = prop()

965

699

if not hasattr(value, "variant_level"):

966

properties[name] = value

700

all[name] = value

967

701

continue

968

properties[name] = type(value)(

969

value, variant_level = value.variant_level + 1)

970

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

971

972

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

973

def PropertiesChanged(self, interface_name, changed_properties,

974

invalidated_properties):

975

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

976

standard.

977

"""

978

pass

702

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

703

value.variant_level+1)

704

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

979

705

980

706

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

981

707

out_signature="s",

982

708

path_keyword='object_path',

983

709

connection_keyword='connection')

984

710

def Introspect(self, object_path, connection):

985

"""Overloading of standard D-Bus method.

986

987

Inserts property tags and interface annotation tags.

711

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

988

712

"""

989

713

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

990

714

connection)

991

715

try:

992

716

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

993

994

717

def make_tag(document, name, prop):

995

718

e = document.createElement("property")

996

719

e.setAttribute("name", name)

997

720

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

998

721

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

999

722

return e

1000

1001

723

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

1002

# Add property tags

1003

724

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

1004

725

for name, prop

1005

in self._get_all_dbus_things("property")

726

in self._get_all_dbus_properties()

1006

727

if prop._dbus_interface

1007

728

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

1008

729

if_tag.appendChild(tag)

1009

# Add annotation tags

1010

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

1011

for tag in if_tag.getElementsByTagName(typ):

1012

annots = dict()

1013

for name, prop in (self.

1014

_get_all_dbus_things(typ)):

1015

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

1016

and prop._dbus_interface

1017

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

1018

annots.update(getattr(

1019

prop, "_dbus_annotations", {}))

1020

for name, value in annots.items():

1021

ann_tag = document.createElement(

1022

"annotation")

1023

ann_tag.setAttribute("name", name)

1024

ann_tag.setAttribute("value", value)

1025

tag.appendChild(ann_tag)

1026

# Add interface annotation tags

1027

for annotation, value in dict(

1028

itertools.chain.from_iterable(

1029

annotations().items()

1030

for name, annotations

1031

in self._get_all_dbus_things("interface")

1032

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

1033

)).items():

1034

ann_tag = document.createElement("annotation")

1035

ann_tag.setAttribute("name", annotation)

1036

ann_tag.setAttribute("value", value)

1037

if_tag.appendChild(ann_tag)

1038

730

# Add the names to the return values for the

1039

731

# "org.freedesktop.DBus.Properties" methods

1040

732

if (if_tag.getAttribute("name")

1055

747

except (AttributeError, xml.dom.DOMException,

1056

748

xml.parsers.expat.ExpatError) as error:

1057

749

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

1058

exc_info=error)

750

error)

1059

751

return xmlstring

1060

752

1061

753

1062

def datetime_to_dbus(dt, variant_level=0):

754

def datetime_to_dbus (dt, variant_level=0):

1063

755

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

1064

756

if dt is None:

1065

757

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

1066

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

1067

1068

1069

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1070

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

1071

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

1072

interface names according to the "alt_interface_names" mapping.

1073

Usage:

1074

1075

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

1076

"net.example.AlternateInterface"})

1077

class SampleDBusObject(dbus.service.Object):

1078

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

1079

def SampleDBusMethod():

1080

pass

1081

1082

The above "SampleDBusMethod" on "SampleDBusObject" will be

1083

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

1084

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

1085

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

1086

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

1087

1088

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

1089

(from DBusObjectWithProperties) and interfaces (from the

1090

dbus_interface_annotations decorator).

1091

"""

1092

1093

def wrapper(cls):

1094

for orig_interface_name, alt_interface_name in (

1095

alt_interface_names.items()):

1096

attr = {}

1097

interface_names = set()

1098

# Go though all attributes of the class

1099

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

1100

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

1101

# with the wrong interface name

1102

if (not hasattr(attribute, "_dbus_interface")

1103

or not attribute._dbus_interface.startswith(

1104

orig_interface_name)):

1105

continue

1106

# Create an alternate D-Bus interface name based on

1107

# the current name

1108

alt_interface = attribute._dbus_interface.replace(

1109

orig_interface_name, alt_interface_name)

1110

interface_names.add(alt_interface)

1111

# Is this a D-Bus signal?

1112

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

1113

if sys.version_info.major == 2:

1114

# Extract the original non-method undecorated

1115

# function by black magic

1116

nonmethod_func = (dict(

1117

zip(attribute.func_code.co_freevars,

1118

attribute.__closure__))

1119

["func"].cell_contents)

1120

else:

1121

nonmethod_func = attribute

1122

# Create a new, but exactly alike, function

1123

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

1124

# with the alternate D-Bus interface name

1125

if sys.version_info.major == 2:

1126

new_function = types.FunctionType(

1127

nonmethod_func.func_code,

1128

nonmethod_func.func_globals,

1129

nonmethod_func.func_name,

1130

nonmethod_func.func_defaults,

1131

nonmethod_func.func_closure)

1132

else:

1133

new_function = types.FunctionType(

1134

nonmethod_func.__code__,

1135

nonmethod_func.__globals__,

1136

nonmethod_func.__name__,

1137

nonmethod_func.__defaults__,

1138

nonmethod_func.__closure__)

1139

new_function = (dbus.service.signal(

1140

alt_interface,

1141

attribute._dbus_signature)(new_function))

1142

# Copy annotations, if any

1143

try:

1144

new_function._dbus_annotations = dict(

1145

attribute._dbus_annotations)

1146

except AttributeError:

1147

pass

1148

# Define a creator of a function to call both the

1149

# original and alternate functions, so both the

1150

# original and alternate signals gets sent when

1151

# the function is called

1152

def fixscope(func1, func2):

1153

"""This function is a scope container to pass

1154

func1 and func2 to the "call_both" function

1155

outside of its arguments"""

1156

1157

def call_both(*args, **kwargs):

1158

"""This function will emit two D-Bus

1159

signals by calling func1 and func2"""

1160

func1(*args, **kwargs)

1161

func2(*args, **kwargs)

1162

1163

return call_both

1164

# Create the "call_both" function and add it to

1165

# the class

1166

attr[attrname] = fixscope(attribute, new_function)

1167

# Is this a D-Bus method?

1168

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

1169

# Create a new, but exactly alike, function

1170

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

1171

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

1172

# to the class.

1173

attr[attrname] = (

1174

dbus.service.method(

1175

alt_interface,

1176

attribute._dbus_in_signature,

1177

attribute._dbus_out_signature)

1178

(types.FunctionType(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1183

# Copy annotations, if any

1184

try:

1185

attr[attrname]._dbus_annotations = dict(

1186

attribute._dbus_annotations)

1187

except AttributeError:

1188

pass

1189

# Is this a D-Bus property?

1190

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

1191

# Create a new, but exactly alike, function

1192

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

1193

# property with the alternate D-Bus interface

1194

# name. Add it to the class.

1195

attr[attrname] = (dbus_service_property(

1196

alt_interface, attribute._dbus_signature,

1197

attribute._dbus_access,

1198

attribute._dbus_get_args_options

1199

["byte_arrays"])

1200

(types.FunctionType(

1201

attribute.func_code,

1202

attribute.func_globals,

1203

attribute.func_name,

1204

attribute.func_defaults,

1205

attribute.func_closure)))

1206

# Copy annotations, if any

1207

try:

1208

attr[attrname]._dbus_annotations = dict(

1209

attribute._dbus_annotations)

1210

except AttributeError:

1211

pass

1212

# Is this a D-Bus interface?

1213

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

1214

# Create a new, but exactly alike, function

1215

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

1216

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

1217

# to the class.

1218

attr[attrname] = (

1219

dbus_interface_annotations(alt_interface)

1220

(types.FunctionType(attribute.func_code,

1221

attribute.func_globals,

1222

attribute.func_name,

1223

attribute.func_defaults,

1224

attribute.func_closure)))

1225

if deprecate:

1226

# Deprecate all alternate interfaces

1227

iname="_AlternateDBusNames_interface_annotation{}"

1228

for interface_name in interface_names:

1229

1230

@dbus_interface_annotations(interface_name)

1231

def func(self):

1232

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

1233

"true" }

1234

# Find an unused name

1235

for aname in (iname.format(i)

1236

for i in itertools.count()):

1237

if aname not in attr:

1238

attr[aname] = func

1239

break

1240

if interface_names:

1241

# Replace the class with a new subclass of it with

1242

# methods, signals, etc. as created above.

1243

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

1244

(cls, ), attr)

1245

return cls

1246

1247

return wrapper

1248

1249

1250

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

1251

"se.bsnet.fukt.Mandos"})

758

return dbus.String(dt.isoformat(),

759

variant_level=variant_level)

760

761

1252

762

class ClientDBus(Client, DBusObjectWithProperties):

1253

763

"""A Client class using D-Bus

1254

764

1258

768

"""

1259

769

1260

770

runtime_expansions = (Client.runtime_expansions

1261

+ ("dbus_object_path", ))

1262

1263

_interface = "se.recompile.Mandos.Client"

771

+ ("dbus_object_path",))

1264

772

1265

773

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

1266

774

1267

775

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

776

self._approvals_pending = 0

1268

777

self.bus = bus

1269

778

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

1270

779

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

1271

780

# the D-Bus

1272

client_object_name = str(self.name).translate(

781

client_object_name = unicode(self.name).translate(

1273

782

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

1274

783

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

1275

self.dbus_object_path = dbus.ObjectPath(

1276

"/clients/" + client_object_name)

784

self.dbus_object_path = (dbus.ObjectPath

785

("/clients/" + client_object_name))

1277

786

DBusObjectWithProperties.__init__(self, self.bus,

1278

787

self.dbus_object_path)

1279

1280

def notifychangeproperty(transform_func, dbus_name,

1281

type_func=lambda x: x,

1282

variant_level=1,

1283

invalidate_only=False,

1284

_interface=_interface):

1285

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

1286

its changes to DBus.

1287

788

1288

transform_fun: Function that takes a value and a variant_level

1289

and transforms it to a D-Bus type.

1290

dbus_name: D-Bus name of the variable

789

def notifychangeproperty(transform_func,

790

dbus_name, type_func=lambda x: x,

791

variant_level=1):

792

""" Modify a variable so that its a property that announce its

793

changes to DBus.

794

transform_fun: Function that takes a value and transform it to

795

DBus type.

796

dbus_name: DBus name of the variable

1291

797

type_func: Function that transform the value before sending it

1292

to the D-Bus. Default: no transform

1293

variant_level: D-Bus variant level. Default: 1

798

to DBus

799

variant_level: DBus variant level. default: 1

1294

800

"""

1295

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

1296

801

real_value = [None,]

1297

802

def setter(self, value):

803

old_value = real_value[0]

804

real_value[0] = value

1298

805

if hasattr(self, "dbus_object_path"):

1299

if (not hasattr(self, attrname) or

1300

type_func(getattr(self, attrname, None))

1301

!= type_func(value)):

1302

if invalidate_only:

1303

self.PropertiesChanged(

1304

_interface, dbus.Dictionary(),

1305

dbus.Array((dbus_name, )))

1306

else:

1307

dbus_value = transform_func(

1308

type_func(value),

1309

variant_level = variant_level)

1310

self.PropertyChanged(dbus.String(dbus_name),

1311

dbus_value)

1312

self.PropertiesChanged(

1313

_interface,

1314

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

1315

dbus_value }),

1316

dbus.Array())

1317

setattr(self, attrname, value)

806

if type_func(old_value) != type_func(real_value[0]):

807

dbus_value = transform_func(type_func(real_value[0]),

808

variant_level)

809

self.PropertyChanged(dbus.String(dbus_name),

810

dbus_value)

1318

811

1319

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

812

return property(lambda self: real_value[0], setter)

813

1320

814

1321

815

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1322

816

approvals_pending = notifychangeproperty(dbus.Boolean,

1325

819

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

1326

820

last_enabled = notifychangeproperty(datetime_to_dbus,

1327

821

"LastEnabled")

1328

checker = notifychangeproperty(

1329

dbus.Boolean, "CheckerRunning",

1330

type_func = lambda checker: checker is not None)

822

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

823

type_func = lambda checker: checker is not None)

1331

824

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1332

825

"LastCheckedOK")

1333

last_checker_status = notifychangeproperty(dbus.Int16,

1334

"LastCheckerStatus")

1335

last_approval_request = notifychangeproperty(

1336

datetime_to_dbus, "LastApprovalRequest")

826

last_approval_request = notifychangeproperty(datetime_to_dbus,

827

"LastApprovalRequest")

1337

828

approved_by_default = notifychangeproperty(dbus.Boolean,

1338

829

"ApprovedByDefault")

1339

approval_delay = notifychangeproperty(

1340

dbus.UInt64, "ApprovalDelay",

1341

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

1342

approval_duration = notifychangeproperty(

1343

dbus.UInt64, "ApprovalDuration",

1344

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

830

approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",

831

type_func = _timedelta_to_milliseconds)

832

approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",

833

type_func = _timedelta_to_milliseconds)

1345

834

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

1346

timeout = notifychangeproperty(

1347

dbus.UInt64, "Timeout",

1348

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

1349

extended_timeout = notifychangeproperty(

1350

dbus.UInt64, "ExtendedTimeout",

1351

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

1352

interval = notifychangeproperty(

1353

dbus.UInt64, "Interval",

1354

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

835

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

836

type_func = _timedelta_to_milliseconds)

837

extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",

838

type_func = _timedelta_to_milliseconds)

839

interval = notifychangeproperty(dbus.UInt16, "Interval",

840

type_func = _timedelta_to_milliseconds)

1355

841

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

1356

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

1357

invalidate_only=True)

1358

842

1359

843

del notifychangeproperty

1360

844

1367

851

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

1368

852

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

1369

853

1370

def checker_callback(self, source, condition,

1371

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

1372

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

1373

connection, command, *args,

1374

**kwargs)

1375

exitstatus = self.last_checker_status

1376

if exitstatus >= 0:

854

def checker_callback(self, pid, condition, command,

855

*args, **kwargs):

856

self.checker_callback_tag = None

857

self.checker = None

858

if os.WIFEXITED(condition):

859

exitstatus = os.WEXITSTATUS(condition)

1377

860

# Emit D-Bus signal

1378

861

self.CheckerCompleted(dbus.Int16(exitstatus),

1379

dbus.Int64(0),

862

dbus.Int64(condition),

1380

863

dbus.String(command))

1381

864

else:

1382

865

# Emit D-Bus signal

1383

866

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

1384

dbus.Int64(

1385

self.last_checker_signal),

867

dbus.Int64(condition),

1386

868

dbus.String(command))

1387

return ret

869

870

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

871

*args, **kwargs)

1388

872

1389

873

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

1390

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

874

old_checker = self.checker

875

if self.checker is not None:

876

old_checker_pid = self.checker.pid

877

else:

878

old_checker_pid = None

1391

879

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

1392

880

# Only if new checker process was started

1393

881

if (self.checker is not None

1397

885

return r

1398

886

1399

887

def _reset_approved(self):

1400

self.approved = None

888

self._approved = None

1401

889

return False

1402

890

1403

891

def approve(self, value=True):

1404

self.approved = value

1405

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

1406

* 1000), self._reset_approved)

1407

892

self.send_changedstate()

893

self._approved = value

894

gobject.timeout_add(_timedelta_to_milliseconds

895

(self.approval_duration),

896

self._reset_approved)

897

1408

898

1409

899

## D-Bus methods, signals & properties

1410

1411

## Interfaces

900

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

1412

901

1413

902

## Signals

1414

903

1425

914

pass

1426

915

1427

916

# PropertyChanged - signal

1428

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

1429

917

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

1430

918

def PropertyChanged(self, property, value):

1431

919

"D-Bus signal"

1495

983

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

1496

984

1497

985

# ApprovedByDefault - property

1498

@dbus_service_property(_interface,

1499

signature="b",

986

@dbus_service_property(_interface, signature="b",

1500

987

access="readwrite")

1501

988

def ApprovedByDefault_dbus_property(self, value=None):

1502

989

if value is None: # get

1504

991

self.approved_by_default = bool(value)

1505

992

1506

993

# ApprovalDelay - property

1507

@dbus_service_property(_interface,

1508

signature="t",

994

@dbus_service_property(_interface, signature="t",

1509

995

access="readwrite")

1510

996

def ApprovalDelay_dbus_property(self, value=None):

1511

997

if value is None: # get

1512

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

1513

* 1000)

998

return dbus.UInt64(self.approval_delay_milliseconds())

1514

999

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

1515

1000

1516

1001

# ApprovalDuration - property

1517

@dbus_service_property(_interface,

1518

signature="t",

1002

@dbus_service_property(_interface, signature="t",

1519

1003

access="readwrite")

1520

1004

def ApprovalDuration_dbus_property(self, value=None):

1521

1005

if value is None: # get

1522

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

1523

* 1000)

1006

return dbus.UInt64(_timedelta_to_milliseconds(

1007

self.approval_duration))

1524

1008

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

1525

1009

1526

1010

# Name - property

1534

1018

return dbus.String(self.fingerprint)

1535

1019

1536

1020

# Host - property

1537

@dbus_service_property(_interface,

1538

signature="s",

1021

@dbus_service_property(_interface, signature="s",

1539

1022

access="readwrite")

1540

1023

def Host_dbus_property(self, value=None):

1541

1024

if value is None: # get

1542

1025

return dbus.String(self.host)

1543

self.host = str(value)

1026

self.host = value

1544

1027

1545

1028

# Created - property

1546

1029

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

1547

1030

def Created_dbus_property(self):

1548

return datetime_to_dbus(self.created)

1031

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

1549

1032

1550

1033

# LastEnabled - property

1551

1034

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

1553

1036

return datetime_to_dbus(self.last_enabled)

1554

1037

1555

1038

# Enabled - property

1556

@dbus_service_property(_interface,

1557

signature="b",

1039

@dbus_service_property(_interface, signature="b",

1558

1040

access="readwrite")

1559

1041

def Enabled_dbus_property(self, value=None):

1560

1042

if value is None: # get

1565

1047

self.disable()

1566

1048

1567

1049

# LastCheckedOK - property

1568

@dbus_service_property(_interface,

1569

signature="s",

1050

@dbus_service_property(_interface, signature="s",

1570

1051

access="readwrite")

1571

1052

def LastCheckedOK_dbus_property(self, value=None):

1572

1053

if value is not None:

1574

1055

return

1575

1056

return datetime_to_dbus(self.last_checked_ok)

1576

1057

1577

# LastCheckerStatus - property

1578

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

1579

def LastCheckerStatus_dbus_property(self):

1580

return dbus.Int16(self.last_checker_status)

1581

1582

1058

# Expires - property

1583

1059

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

1584

1060

def Expires_dbus_property(self):

1590

1066

return datetime_to_dbus(self.last_approval_request)

1591

1067

1592

1068

# Timeout - property

1593

@dbus_service_property(_interface,

1594

signature="t",

1069

@dbus_service_property(_interface, signature="t",

1595

1070

access="readwrite")

1596

1071

def Timeout_dbus_property(self, value=None):

1597

1072

if value is None: # get

1598

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

1599

old_timeout = self.timeout

1073

return dbus.UInt64(self.timeout_milliseconds())

1600

1074

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

1601

# Reschedule disabling

1602

if self.enabled:

1603

now = datetime.datetime.utcnow()

1604

self.expires += self.timeout - old_timeout

1605

if self.expires <= now:

1606

# The timeout has passed

1607

self.disable()

1608

else:

1609

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

1610

is None):

1611

return

1612

gobject.source_remove(self.disable_initiator_tag)

1613

self.disable_initiator_tag = gobject.timeout_add(

1614

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

1615

self.disable)

1075

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

1076

return

1077

# Reschedule timeout

1078

gobject.source_remove(self.disable_initiator_tag)

1079

self.disable_initiator_tag = None

1080

self.expires = None

1081

time_to_die = (self.

1082

_timedelta_to_milliseconds((self

1083

.last_checked_ok

1084

+ self.timeout)

1085

- datetime.datetime

1086

.utcnow()))

1087

if time_to_die <= 0:

1088

# The timeout has passed

1089

self.disable()

1090

else:

1091

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

1092

+ datetime.timedelta(milliseconds = time_to_die))

1093

self.disable_initiator_tag = (gobject.timeout_add

1094

(time_to_die, self.disable))

1616

1095

1617

1096

# ExtendedTimeout - property

1618

@dbus_service_property(_interface,

1619

signature="t",

1097

@dbus_service_property(_interface, signature="t",

1620

1098

access="readwrite")

1621

1099

def ExtendedTimeout_dbus_property(self, value=None):

1622

1100

if value is None: # get

1623

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

1624

* 1000)

1101

return dbus.UInt64(self.extended_timeout_milliseconds())

1625

1102

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

1626

1103

1627

1104

# Interval - property

1628

@dbus_service_property(_interface,

1629

signature="t",

1105

@dbus_service_property(_interface, signature="t",

1630

1106

access="readwrite")

1631

1107

def Interval_dbus_property(self, value=None):

1632

1108

if value is None: # get

1633

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

1109

return dbus.UInt64(self.interval_milliseconds())

1634

1110

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

1635

1111

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

1636

1112

return

1637

if self.enabled:

1638

# Reschedule checker run

1639

gobject.source_remove(self.checker_initiator_tag)

1640

self.checker_initiator_tag = gobject.timeout_add(

1641

value, self.start_checker)

1642

self.start_checker() # Start one now, too

1113

# Reschedule checker run

1114

gobject.source_remove(self.checker_initiator_tag)

1115

self.checker_initiator_tag = (gobject.timeout_add

1116

(value, self.start_checker))

1117

self.start_checker() # Start one now, too

1643

1118

1644

1119

# Checker - property

1645

@dbus_service_property(_interface,

1646

signature="s",

1120

@dbus_service_property(_interface, signature="s",

1647

1121

access="readwrite")

1648

1122

def Checker_dbus_property(self, value=None):

1649

1123

if value is None: # get

1650

1124

return dbus.String(self.checker_command)

1651

self.checker_command = str(value)

1125

self.checker_command = value

1652

1126

1653

1127

# CheckerRunning - property

1654

@dbus_service_property(_interface,

1655

signature="b",

1128

@dbus_service_property(_interface, signature="b",

1656

1129

access="readwrite")

1657

1130

def CheckerRunning_dbus_property(self, value=None):

1658

1131

if value is None: # get

1668

1141

return self.dbus_object_path # is already a dbus.ObjectPath

1669

1142

1670

1143

# Secret = property

1671

@dbus_service_property(_interface,

1672

signature="ay",

1673

access="write",

1674

byte_arrays=True)

1144

@dbus_service_property(_interface, signature="ay",

1145

access="write", byte_arrays=True)

1675

1146

def Secret_dbus_property(self, value):

1676

self.secret = bytes(value)

1147

self.secret = str(value)

1677

1148

1678

1149

del _interface

1679

1150

1683

1154

self._pipe = child_pipe

1684

1155

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

1685

1156

if not self._pipe.recv():

1686

raise KeyError(fpr)

1157

raise KeyError()

1687

1158

1688

1159

def __getattribute__(self, name):

1689

if name == '_pipe':

1160

if(name == '_pipe'):

1690

1161

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

1691

1162

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

1692

1163

data = self._pipe.recv()

1693

1164

if data[0] == 'data':

1694

1165

return data[1]

1695

1166

if data[0] == 'function':

1696

1697

1167

def func(*args, **kwargs):

1698

1168

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

1699

1169

return self._pipe.recv()[1]

1700

1701

1170

return func

1702

1171

1703

1172

def __setattr__(self, name, value):

1704

if name == '_pipe':

1173

if(name == '_pipe'):

1705

1174

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

1706

1175

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

1707

1176

1715

1184

def handle(self):

1716

1185

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

1717

1186

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

1718

str(self.client_address))

1187

unicode(self.client_address))

1719

1188

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

1720

1189

self.server.child_pipe.fileno())

1721

1190

1722

session = gnutls.connection.ClientSession(

1723

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

1191

session = (gnutls.connection

1192

.ClientSession(self.request,

1193

gnutls.connection

1194

.X509Credentials()))

1724

1195

1725

1196

# Note: gnutls.connection.X509Credentials is really a

1726

1197

# generic GnuTLS certificate credentials object so long as

1735

1206

priority = self.server.gnutls_priority

1736

1207

if priority is None:

1737

1208

priority = "NORMAL"

1738

gnutls.library.functions.gnutls_priority_set_direct(

1739

session._c_object, priority, None)

1209

(gnutls.library.functions

1210

.gnutls_priority_set_direct(session._c_object,

1211

priority, None))

1740

1212

1741

1213

# Start communication using the Mandos protocol

1742

1214

# Get protocol number

1744

1216

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

1745

1217

try:

1746

1218

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

1747

raise RuntimeError(line)

1219

raise RuntimeError

1748

1220

except (ValueError, IndexError, RuntimeError) as error:

1749

1221

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

1750

1222

return

1762

1234

approval_required = False

1763

1235

try:

1764

1236

try:

1765

fpr = self.fingerprint(

1766

self.peer_certificate(session))

1237

fpr = self.fingerprint(self.peer_certificate

1238

(session))

1767

1239

except (TypeError,

1768

1240

gnutls.errors.GNUTLSError) as error:

1769

1241

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

1784

1256

while True:

1785

1257

if not client.enabled:

1786

1258

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

1787

client.name)

1259

client.name)

1788

1260

if self.server.use_dbus:

1789

1261

# Emit D-Bus signal

1790

client.Rejected("Disabled")

1262

client.Rejected("Disabled")

1791

1263

return

1792

1264

1793

if client.approved or not client.approval_delay:

1265

if client._approved or not client.approval_delay:

1794

1266

#We are approved or approval is disabled

1795

1267

break

1796

elif client.approved is None:

1268

elif client._approved is None:

1797

1269

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

1798

1270

client.name)

1799

1271

if self.server.use_dbus:

1800

1272

# Emit D-Bus signal

1801

1273

client.NeedApproval(

1802

client.approval_delay.total_seconds()

1803

* 1000, client.approved_by_default)

1274

client.approval_delay_milliseconds(),

1275

client.approved_by_default)

1804

1276

else:

1805

1277

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

1806

1278

client.name)

1810

1282

return

1811

1283

1812

1284

#wait until timeout or approved

1285

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

1813

1286

time = datetime.datetime.now()

1814

1287

client.changedstate.acquire()

1815

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

1288

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

1816

1289

client.changedstate.release()

1817

1290

time2 = datetime.datetime.now()

1818

1291

if (time2 - time) >= delay:

1834

1307

try:

1835

1308

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

1836

1309

except gnutls.errors.GNUTLSError as error:

1837

logger.warning("gnutls send failed",

1838

exc_info=error)

1310

logger.warning("gnutls send failed")

1839

1311

return

1840

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

1841

len(client.secret) - (sent_size

1842

+ sent))

1312

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

1313

sent, len(client.secret)

1314

- (sent_size + sent))

1843

1315

sent_size += sent

1844

1316

1845

1317

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

1846

# bump the timeout using extended_timeout

1847

client.bump_timeout(client.extended_timeout)

1318

# bump the timeout as if seen

1319

client.checked_ok(client.extended_timeout)

1848

1320

if self.server.use_dbus:

1849

1321

# Emit D-Bus signal

1850

1322

client.GotSecret()

1855

1327

try:

1856

1328

session.bye()

1857

1329

except gnutls.errors.GNUTLSError as error:

1858

logger.warning("GnuTLS bye failed",

1859

exc_info=error)

1330

logger.warning("GnuTLS bye failed")

1860

1331

1861

1332

@staticmethod

1862

1333

def peer_certificate(session):

1863

1334

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

1864

1335

# If not an OpenPGP certificate...

1865

if (gnutls.library.functions.gnutls_certificate_type_get(

1866

session._c_object)

1336

if (gnutls.library.functions

1337

.gnutls_certificate_type_get(session._c_object)

1867

1338

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1868

1339

# ...do the normal thing

1869

1340

return session.peer_certificate

1883

1354

def fingerprint(openpgp):

1884

1355

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1885

1356

# New GnuTLS "datum" with the OpenPGP public key

1886

datum = gnutls.library.types.gnutls_datum_t(

1887

ctypes.cast(ctypes.c_char_p(openpgp),

1888

ctypes.POINTER(ctypes.c_ubyte)),

1889

ctypes.c_uint(len(openpgp)))

1357

datum = (gnutls.library.types

1358

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

1359

ctypes.POINTER

1360

(ctypes.c_ubyte)),

1361

ctypes.c_uint(len(openpgp))))

1890

1362

# New empty GnuTLS certificate

1891

1363

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1892

gnutls.library.functions.gnutls_openpgp_crt_init(

1893

ctypes.byref(crt))

1364

(gnutls.library.functions

1365

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

1894

1366

# Import the OpenPGP public key into the certificate

1895

gnutls.library.functions.gnutls_openpgp_crt_import(

1896

crt, ctypes.byref(datum),

1897

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1367

(gnutls.library.functions

1368

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

1369

gnutls.library.constants

1370

.GNUTLS_OPENPGP_FMT_RAW))

1898

1371

# Verify the self signature in the key

1899

1372

crtverify = ctypes.c_uint()

1900

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1901

crt, 0, ctypes.byref(crtverify))

1373

(gnutls.library.functions

1374

.gnutls_openpgp_crt_verify_self(crt, 0,

1375

ctypes.byref(crtverify)))

1902

1376

if crtverify.value != 0:

1903

1377

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1904

raise gnutls.errors.CertificateSecurityError(

1905

"Verify failed")

1378

raise (gnutls.errors.CertificateSecurityError

1379

("Verify failed"))

1906

1380

# New buffer for the fingerprint

1907

1381

buf = ctypes.create_string_buffer(20)

1908

1382

buf_len = ctypes.c_size_t()

1909

1383

# Get the fingerprint from the certificate into the buffer

1910

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1911

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

1384

(gnutls.library.functions

1385

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

1386

ctypes.byref(buf_len)))

1912

1387

# Deinit the certificate

1913

1388

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1914

1389

# Convert the buffer to a Python bytestring

1915

1390

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

1916

1391

# Convert the bytestring to hexadecimal notation

1917

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

1392

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

1918

1393

return hex_fpr

1919

1394

1920

1395

1921

1396

class MultiprocessingMixIn(object):

1922

1397

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

1923

1924

1398

def sub_process_main(self, request, address):

1925

1399

try:

1926

1400

self.finish_request(request, address)

1927

except Exception:

1401

except:

1928

1402

self.handle_error(request, address)

1929

1403

self.close_request(request)

1930

1404

1931

1405

def process_request(self, request, address):

1932

1406

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

1933

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

1934

args = (request, address))

1935

proc.start()

1936

return proc

1407

multiprocessing.Process(target = self.sub_process_main,

1408

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

1937

1409

1938

1410

1939

1411

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1940

1412

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

1941

1942

1413

def process_request(self, request, client_address):

1943

1414

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

1944

1415

1946

1417

"""

1947

1418

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1948

1419

1949

proc = MultiprocessingMixIn.process_request(self, request,

1950

client_address)

1420

super(MultiprocessingMixInWithPipe,

1421

self).process_request(request, client_address)

1951

1422

self.child_pipe.close()

1952

self.add_pipe(parent_pipe, proc)

1423

self.add_pipe(parent_pipe)

1953

1424

1954

def add_pipe(self, parent_pipe, proc):

1425

def add_pipe(self, parent_pipe):

1955

1426

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

1956

raise NotImplementedError()

1427

raise NotImplementedError

1957

1428

1958

1429

1959

1430

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1965

1436

interface: None or a network interface name (string)

1966

1437

use_ipv6: Boolean; to use IPv6 or not

1967

1438

"""

1968

1969

1439

def __init__(self, server_address, RequestHandlerClass,

1970

interface=None,

1971

use_ipv6=True,

1972

socketfd=None):

1973

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

1974

creating a new one with socket.socket().

1975

"""

1440

interface=None, use_ipv6=True):

1976

1441

self.interface = interface

1977

1442

if use_ipv6:

1978

1443

self.address_family = socket.AF_INET6

1979

if socketfd is not None:

1980

# Save the file descriptor

1981

self.socketfd = socketfd

1982

# Save the original socket.socket() function

1983

self.socket_socket = socket.socket

1984

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

1985

#

1986

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

1987

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

1988

# patching socket.socket.)

1989

#

1990

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

1991

@functools.wraps(socket.socket)

1992

def socket_wrapper(*args, **kwargs):

1993

# Restore original function so subsequent calls are

1994

# not affected.

1995

socket.socket = self.socket_socket

1996

del self.socket_socket

1997

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

1998

# saved file descriptor.

1999

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

2000

# Replace socket.socket() function with wrapper

2001

socket.socket = socket_wrapper

2002

# The socketserver.TCPServer.__init__ will call

2003

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

2004

# socket_wrapper(), if socketfd was set.

2005

1444

socketserver.TCPServer.__init__(self, server_address,

2006

1445

RequestHandlerClass)

2007

2008

1446

def server_bind(self):

2009

1447

"""This overrides the normal server_bind() function

2010

1448

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

2016

1454

self.interface)

2017

1455

else:

2018

1456

try:

2019

self.socket.setsockopt(

2020

socket.SOL_SOCKET, SO_BINDTODEVICE,

2021

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

1457

self.socket.setsockopt(socket.SOL_SOCKET,

1458

SO_BINDTODEVICE,

1459

str(self.interface

1460

+ '\0'))

2022

1461

except socket.error as error:

2023

if error.errno == errno.EPERM:

2024

logger.error("No permission to bind to"

2025

" interface %s", self.interface)

2026

elif error.errno == errno.ENOPROTOOPT:

1462

if error[0] == errno.EPERM:

1463

logger.error("No permission to"

1464

" bind to interface %s",

1465

self.interface)

1466

elif error[0] == errno.ENOPROTOOPT:

2027

1467

logger.error("SO_BINDTODEVICE not available;"

2028

1468

" cannot bind to interface %s",

2029

1469

self.interface)

2030

elif error.errno == errno.ENODEV:

2031

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

2032

" cannot bind", self.interface)

2033

1470

else:

2034

1471

raise

2035

1472

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

2038

1475

if self.address_family == socket.AF_INET6:

2039

1476

any_address = "::" # in6addr_any

2040

1477

else:

2041

any_address = "0.0.0.0" # INADDR_ANY

1478

any_address = socket.INADDR_ANY

2042

1479

self.server_address = (any_address,

2043

1480

self.server_address[1])

2044

1481

elif not self.server_address[1]:

2045

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

1482

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

1483

0)

2046

1484

# if self.interface:

2047

1485

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

2048

1486

# 0, # port

2062

1500

2063

1501

Assumes a gobject.MainLoop event loop.

2064

1502

"""

2065

2066

1503

def __init__(self, server_address, RequestHandlerClass,

2067

interface=None,

2068

use_ipv6=True,

2069

clients=None,

2070

gnutls_priority=None,

2071

use_dbus=True,

2072

socketfd=None):

1504

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

1505

gnutls_priority=None, use_dbus=True):

2073

1506

self.enabled = False

2074

1507

self.clients = clients

2075

1508

if self.clients is None:

2076

self.clients = {}

1509

self.clients = set()

2077

1510

self.use_dbus = use_dbus

2078

1511

self.gnutls_priority = gnutls_priority

2079

1512

IPv6_TCPServer.__init__(self, server_address,

2080

1513

RequestHandlerClass,

2081

1514

interface = interface,

2082

use_ipv6 = use_ipv6,

2083

socketfd = socketfd)

2084

1515

use_ipv6 = use_ipv6)

2085

1516

def server_activate(self):

2086

1517

if self.enabled:

2087

1518

return socketserver.TCPServer.server_activate(self)

2088

2089

1519

def enable(self):

2090

1520

self.enabled = True

2091

2092

def add_pipe(self, parent_pipe, proc):

1521

def add_pipe(self, parent_pipe):

2093

1522

# Call "handle_ipc" for both data and EOF events

2094

gobject.io_add_watch(

2095

parent_pipe.fileno(),

2096

gobject.IO_IN | gobject.IO_HUP,

2097

functools.partial(self.handle_ipc,

2098

parent_pipe = parent_pipe,

2099

proc = proc))

2100

2101

def handle_ipc(self, source, condition,

2102

parent_pipe=None,

2103

proc = None,

1523

gobject.io_add_watch(parent_pipe.fileno(),

1524

gobject.IO_IN | gobject.IO_HUP,

1525

functools.partial(self.handle_ipc,

1526

parent_pipe = parent_pipe))

1527

1528

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

2104

1529

client_object=None):

2105

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

2106

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

2107

# Wait for other process to exit

2108

proc.join()

1530

condition_names = {

1531

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

1532

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

1533

# blocking).

1534

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

1535

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

1536

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

1537

# broken, usually for pipes and

1538

# sockets).

1539

}

1540

conditions_string = ' | '.join(name

1541

for cond, name in

1542

condition_names.iteritems()

1543

if cond & condition)

1544

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

1545

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

2109

1546

return False

2110

1547

2111

1548

# Read a request from the child

2116

1553

fpr = request[1]

2117

1554

address = request[2]

2118

1555

2119

for c in self.clients.itervalues():

1556

for c in self.clients:

2120

1557

if c.fingerprint == fpr:

2121

1558

client = c

2122

1559

break

2125

1562

"dress: %s", fpr, address)

2126

1563

if self.use_dbus:

2127

1564

# Emit D-Bus signal

2128

mandos_dbus_service.ClientNotFound(fpr,

2129

address[0])

1565

mandos_dbus_service.ClientNotFound(fpr, address[0])

2130

1566

parent_pipe.send(False)

2131

1567

return False

2132

1568

2133

gobject.io_add_watch(

2134

parent_pipe.fileno(),

2135

gobject.IO_IN | gobject.IO_HUP,

2136

functools.partial(self.handle_ipc,

2137

parent_pipe = parent_pipe,

2138

proc = proc,

2139

client_object = client))

1569

gobject.io_add_watch(parent_pipe.fileno(),

1570

gobject.IO_IN | gobject.IO_HUP,

1571

functools.partial(self.handle_ipc,

1572

parent_pipe = parent_pipe,

1573

client_object = client))

2140

1574

parent_pipe.send(True)

2141

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

2142

# same fileno

1575

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

2143

1576

return False

2144

1577

if command == 'funcall':

2145

1578

funcname = request[1]

2146

1579

args = request[2]

2147

1580

kwargs = request[3]

2148

1581

2149

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

2150

funcname)(*args,

2151

**kwargs)))

1582

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

2152

1583

2153

1584

if command == 'getattr':

2154

1585

attrname = request[1]

2155

if isinstance(client_object.__getattribute__(attrname),

2156

collections.Callable):

2157

parent_pipe.send(('function', ))

1586

if callable(client_object.__getattribute__(attrname)):

1587

parent_pipe.send(('function',))

2158

1588

else:

2159

parent_pipe.send((

2160

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

1589

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

2161

1590

2162

1591

if command == 'setattr':

2163

1592

attrname = request[1]

2167

1596

return True

2168

1597

2169

1598

2170

def rfc3339_duration_to_delta(duration):

2171

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

2172

2173

>>> rfc3339_duration_to_delta("P7D")

2174

datetime.timedelta(7)

2175

>>> rfc3339_duration_to_delta("PT60S")

2176

datetime.timedelta(0, 60)

2177

>>> rfc3339_duration_to_delta("PT60M")

2178

datetime.timedelta(0, 3600)

2179

>>> rfc3339_duration_to_delta("PT24H")

2180

datetime.timedelta(1)

2181

>>> rfc3339_duration_to_delta("P1W")

2182

datetime.timedelta(7)

2183

>>> rfc3339_duration_to_delta("PT5M30S")

2184

datetime.timedelta(0, 330)

2185

>>> rfc3339_duration_to_delta("P1DT3M20S")

2186

datetime.timedelta(1, 200)

2187

"""

2188

2189

# Parsing an RFC 3339 duration with regular expressions is not

2190

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

2191

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

2192

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

2193

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

2194

# avoid excessive use of external libraries.

2195

2196

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

2197

Token = collections.namedtuple("Token", (

2198

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

2199

# a "group" containing digits

2200

"value", # datetime.timedelta or None

2201

"followers")) # Tokens valid after this token

2202

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

2203

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

2204

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

2205

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

2206

datetime.timedelta(seconds=1),

2207

frozenset((token_end, )))

2208

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

2209

datetime.timedelta(minutes=1),

2210

frozenset((token_second, token_end)))

2211

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

2212

datetime.timedelta(hours=1),

2213

frozenset((token_minute, token_end)))

2214

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

2215

None,

2216

frozenset((token_hour, token_minute,

2217

token_second)))

2218

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

2219

datetime.timedelta(days=1),

2220

frozenset((token_time, token_end)))

2221

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

2222

datetime.timedelta(weeks=4),

2223

frozenset((token_day, token_end)))

2224

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

2225

datetime.timedelta(weeks=52),

2226

frozenset((token_month, token_end)))

2227

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

2228

datetime.timedelta(weeks=1),

2229

frozenset((token_end, )))

2230

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

2231

frozenset((token_year, token_month,

2232

token_day, token_time,

2233

token_week)))

2234

# Define starting values

2235

value = datetime.timedelta() # Value so far

2236

found_token = None

2237

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

2238

s = duration # String left to parse

2239

# Loop until end token is found

2240

while found_token is not token_end:

2241

# Search for any currently valid tokens

2242

for token in followers:

2243

match = token.regexp.match(s)

2244

if match is not None:

2245

# Token found

2246

if token.value is not None:

2247

# Value found, parse digits

2248

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

2249

# Add to value so far

2250

value += factor * token.value

2251

# Strip token from string

2252

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

2253

# Go to found token

2254

found_token = token

2255

# Set valid next tokens

2256

followers = found_token.followers

2257

break

2258

else:

2259

# No currently valid tokens were found

2260

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

2261

.format(duration))

2262

# End token found

2263

return value

2264

2265

2266

1599

def string_to_delta(interval):

2267

1600

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

2268

1601

2279

1612

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

2280

1613

datetime.timedelta(0, 330)

2281

1614

"""

2282

2283

try:

2284

return rfc3339_duration_to_delta(interval)

2285

except ValueError:

2286

pass

2287

2288

1615

timevalue = datetime.timedelta(0)

2289

1616

for s in interval.split():

2290

1617

try:

2291

suffix = s[-1]

1618

suffix = unicode(s[-1])

2292

1619

value = int(s[:-1])

2293

1620

if suffix == "d":

2294

1621

delta = datetime.timedelta(value)

2301

1628

elif suffix == "w":

2302

1629

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

2303

1630

else:

2304

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

2305

except IndexError as e:

1631

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

1632

except (ValueError, IndexError) as e:

2306

1633

raise ValueError(*(e.args))

2307

1634

timevalue += delta

2308

1635

return timevalue

2309

1636

2310

1637

1638

def if_nametoindex(interface):

1639

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

1640

1641

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

1642

global if_nametoindex

1643

try:

1644

if_nametoindex = (ctypes.cdll.LoadLibrary

1645

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

1646

.if_nametoindex)

1647

except (OSError, AttributeError):

1648

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

1649

def if_nametoindex(interface):

1650

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

1651

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

1652

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

1653

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1654

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

1655

interface))

1656

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

1657

ifreq[16:20])[0]

1658

return interface_index

1659

return if_nametoindex(interface)

1660

1661

2311

1662

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

2312

1663

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

2313

1664

2321

1672

sys.exit()

2322

1673

if not noclose:

2323

1674

# Close all standard open file descriptors

2324

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

1675

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

2325

1676

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

2326

1677

raise OSError(errno.ENODEV,

2327

"{} not a character device"

2328

.format(os.devnull))

1678

"%s not a character device"

1679

% os.path.devnull)

2329

1680

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

2330

1681

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

2331

1682

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

2340

1691

2341

1692

parser = argparse.ArgumentParser()

2342

1693

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

2343

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

1694

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

2344

1695

help="show version number and exit")

2345

1696

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

2346

1697

help="Bind to interface IF")

2352

1703

help="Run self-test")

2353

1704

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

2354

1705

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

2355

" to terminal", default=None)

1706

" to terminal")

2356

1707

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

2357

1708

help="Debug level for stdout output")

2358

1709

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

2365

1716

" files")

2366

1717

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

2367

1718

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

2368

" system bus interface", default=None)

1719

" system bus interface")

2369

1720

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

2370

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

2371

default=None)

2372

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

2373

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

2374

" state", default=None)

2375

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

2376

help="Specify a file descriptor to a network"

2377

" socket to use instead of creating one")

2378

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

2379

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

2380

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

2381

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

2382

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

2383

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

2384

default=None)

2385

1721

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

2386

1722

options = parser.parse_args()

2387

1723

2388

1724

if options.check:

2389

1725

import doctest

2390

fail_count, test_count = doctest.testmod()

2391

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

1726

doctest.testmod()

1727

sys.exit()

2392

1728

2393

1729

# Default values for config file for server-global settings

2394

1730

server_defaults = { "interface": "",

2396

1732

"port": "",

2397

1733

"debug": "False",

2398

1734

"priority":

2399

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

2400

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

1735

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

2401

1736

"servicename": "Mandos",

2402

1737

"use_dbus": "True",

2403

1738

"use_ipv6": "True",

2404

1739

"debuglevel": "",

2405

"restore": "True",

2406

"socket": "",

2407

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

2408

"foreground": "False",

2409

"zeroconf": "True",

2410

}

1740

}

2411

1741

2412

1742

# Parse config file for server-global settings

2413

1743

server_config = configparser.SafeConfigParser(server_defaults)

2414

1744

del server_defaults

2415

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

1745

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

1746

"mandos.conf"))

2416

1747

# Convert the SafeConfigParser object to a dict

2417

1748

server_settings = server_config.defaults()

2418

1749

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

2419

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

1750

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

2420

1751

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

2421

1752

option)

2422

1753

if server_settings["port"]:

2423

1754

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

2424

1755

"port")

2425

if server_settings["socket"]:

2426

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

2427

"socket")

2428

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

2429

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

2430

# happen with a supplied network socket.

2431

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

2432

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

2433

["socket"])

2434

1756

del server_config

2435

1757

2436

1758

# Override the settings from the config file with command line

2437

1759

# options, if set.

2438

1760

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

2439

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

2440

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

2441

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

1761

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

1762

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

2442

1763

value = getattr(options, option)

2443

1764

if value is not None:

2444

1765

server_settings[option] = value

2445

1766

del options

2446

1767

# Force all strings to be unicode

2447

1768

for option in server_settings.keys():

2448

if isinstance(server_settings[option], bytes):

2449

server_settings[option] = (server_settings[option]

2450

.decode("utf-8"))

2451

# Force all boolean options to be boolean

2452

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

2453

"foreground", "zeroconf"):

2454

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

2455

# Debug implies foreground

2456

if server_settings["debug"]:

2457

server_settings["foreground"] = True

1769

if type(server_settings[option]) is str:

1770

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

2458

1771

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

2459

1772

2460

1773

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

2461

1774

2462

if (not server_settings["zeroconf"]

2463

and not (server_settings["port"]

2464

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

2465

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

2466

2467

1775

# For convenience

2468

1776

debug = server_settings["debug"]

2469

1777

debuglevel = server_settings["debuglevel"]

2470

1778

use_dbus = server_settings["use_dbus"]

2471

1779

use_ipv6 = server_settings["use_ipv6"]

2472

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

2473

stored_state_file)

2474

foreground = server_settings["foreground"]

2475

zeroconf = server_settings["zeroconf"]

2476

2477

if debug:

2478

initlogger(debug, logging.DEBUG)

2479

else:

2480

if not debuglevel:

2481

initlogger(debug)

2482

else:

2483

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

2484

initlogger(debug, level)

2485

1780

2486

1781

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

2487

syslogger.setFormatter(

2488

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

2489

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

2490

server_settings["servicename"])))

1782

syslogger.setFormatter(logging.Formatter

1783

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

1784

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

1785

% server_settings["servicename"]))

2491

1786

2492

1787

# Parse config file with clients

2493

client_config = configparser.SafeConfigParser(Client

2494

.client_defaults)

1788

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

1789

"extended_timeout": "15m",

1790

"interval": "2m",

1791

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

1792

"host": "",

1793

"approval_delay": "0s",

1794

"approval_duration": "1s",

1795

}

1796

client_config = configparser.SafeConfigParser(client_defaults)

2495

1797

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

2496

1798

"clients.conf"))

2497

1799

2498

1800

global mandos_dbus_service

2499

1801

mandos_dbus_service = None

2500

1802

2501

socketfd = None

2502

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

2503

socketfd = server_settings["socket"]

2504

tcp_server = MandosServer(

2505

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

2506

ClientHandler,

2507

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

2508

use_ipv6=use_ipv6,

2509

gnutls_priority=server_settings["priority"],

2510

use_dbus=use_dbus,

2511

socketfd=socketfd)

2512

if not foreground:

2513

pidfilename = "/run/mandos.pid"

2514

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

2515

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

2516

pidfile = None

1803

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

1804

server_settings["port"]),

1805

ClientHandler,

1806

interface=(server_settings["interface"]

1807

or None),

1808

use_ipv6=use_ipv6,

1809

gnutls_priority=

1810

server_settings["priority"],

1811

use_dbus=use_dbus)

1812

if not debug:

1813

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

2517

1814

try:

2518

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

2519

except IOError as e:

2520

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

2521

exc_info=e)

1815

pidfile = open(pidfilename, "w")

1816

except IOError:

1817

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

2522

1818

2523

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

1819

try:

1820

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

1821

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

1822

except KeyError:

2524

1823

try:

2525

uid = pwd.getpwnam(name).pw_uid

2526

gid = pwd.getpwnam(name).pw_gid

2527

break

1824

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

1825

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

2528

1826

except KeyError:

2529

continue

2530

else:

2531

uid = 65534

2532

gid = 65534

1827

try:

1828

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

1829

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

1830

except KeyError:

1831

uid = 65534

1832

gid = 65534

2533

1833

try:

2534

1834

os.setgid(gid)

2535

1835

os.setuid(uid)

2536

1836

except OSError as error:

2537

if error.errno != errno.EPERM:

2538

raise

1837

if error[0] != errno.EPERM:

1838

raise error

1839

1840

if not debug and not debuglevel:

1841

syslogger.setLevel(logging.WARNING)

1842

console.setLevel(logging.WARNING)

1843

if debuglevel:

1844

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

1845

syslogger.setLevel(level)

1846

console.setLevel(level)

2539

1847

2540

1848

if debug:

2541

1849

# Enable all possible GnuTLS debugging

2548

1856

def debug_gnutls(level, string):

2549

1857

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

2550

1858

2551

gnutls.library.functions.gnutls_global_set_log_function(

2552

debug_gnutls)

1859

(gnutls.library.functions

1860

.gnutls_global_set_log_function(debug_gnutls))

2553

1861

2554

1862

# Redirect stdin so all checkers get /dev/null

2555

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

1863

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

2556

1864

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

2557

1865

if null > 2:

2558

1866

os.close(null)

1867

else:

1868

# No console logging

1869

logger.removeHandler(console)

2559

1870

2560

1871

# Need to fork before connecting to D-Bus

2561

if not foreground:

1872

if not debug:

2562

1873

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

2563

1874

daemon()

2564

1875

2565

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

2566

# need to inform gobject that threads will be used.

2567

gobject.threads_init()

2568

2569

1876

global main_loop

2570

1877

# From the Avahi example code

2571

DBusGMainLoop(set_as_default=True)

1878

DBusGMainLoop(set_as_default=True )

2572

1879

main_loop = gobject.MainLoop()

2573

1880

bus = dbus.SystemBus()

2574

1881

# End of Avahi example code

2575

1882

if use_dbus:

2576

1883

try:

2577

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

2578

bus,

2579

do_not_queue=True)

2580

old_bus_name = dbus.service.BusName(

2581

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

2582

do_not_queue=True)

2583

except dbus.exceptions.DBusException as e:

2584

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

1884

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

1885

bus, do_not_queue=True)

1886

except dbus.exceptions.NameExistsException as e:

1887

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

2585

1888

use_dbus = False

2586

1889

server_settings["use_dbus"] = False

2587

1890

tcp_server.use_dbus = False

2588

if zeroconf:

2589

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2590

service = AvahiServiceToSyslog(

2591

name = server_settings["servicename"],

2592

servicetype = "_mandos._tcp",

2593

protocol = protocol,

2594

bus = bus)

2595

if server_settings["interface"]:

2596

service.interface = if_nametoindex(

2597

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

1891

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1892

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

1893

servicetype = "_mandos._tcp",

1894

protocol = protocol, bus = bus)

1895

if server_settings["interface"]:

1896

service.interface = (if_nametoindex

1897

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

2598

1898

2599

1899

global multiprocessing_manager

2600

1900

multiprocessing_manager = multiprocessing.Manager()

2602

1902

client_class = Client

2603

1903

if use_dbus:

2604

1904

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

2605

2606

client_settings = Client.config_parser(client_config)

2607

old_client_settings = {}

2608

clients_data = {}

2609

2610

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

2611

global wnull

2612

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

2613

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

2614

# mode

2615

if debug or not foreground:

2616

wnull.close()

2617

2618

# Get client data and settings from last running state.

2619

if server_settings["restore"]:

2620

try:

2621

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

2622

clients_data, old_client_settings = pickle.load(

2623

stored_state)

2624

os.remove(stored_state_path)

2625

except IOError as e:

2626

if e.errno == errno.ENOENT:

2627

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

2628

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

2629

else:

2630

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

2631

exc_info=e)

2632

raise

2633

except EOFError as e:

2634

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

2635

"EOFError:",

2636

exc_info=e)

2637

2638

with PGPEngine() as pgp:

2639

for client_name, client in clients_data.items():

2640

# Skip removed clients

2641

if client_name not in client_settings:

2642

continue

2643

2644

# Decide which value to use after restoring saved state.

2645

# We have three different values: Old config file,

2646

# new config file, and saved state.

2647

# New config value takes precedence if it differs from old

2648

# config value, otherwise use saved state.

2649

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

2650

try:

2651

# For each value in new config, check if it

2652

# differs from the old config value (Except for

2653

# the "secret" attribute)

2654

if (name != "secret"

2655

and (value !=

2656

old_client_settings[client_name][name])):

2657

client[name] = value

2658

except KeyError:

2659

pass

2660

2661

# Clients who has passed its expire date can still be

2662

# enabled if its last checker was successful. A Client

2663

# whose checker succeeded before we stored its state is

2664

# assumed to have successfully run all checkers during

2665

# downtime.

2666

if client["enabled"]:

2667

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

2668

if not client["last_checked_ok"]:

2669

logger.warning(

2670

"disabling client {} - Client never "

2671

"performed a successful checker".format(

2672

client_name))

2673

client["enabled"] = False

2674

elif client["last_checker_status"] != 0:

2675

logger.warning(

2676

"disabling client {} - Client last"

2677

" checker failed with error code"

2678

" {}".format(

2679

client_name,

2680

client["last_checker_status"]))

2681

client["enabled"] = False

2682

else:

2683

client["expires"] = (

2684

datetime.datetime.utcnow()

2685

+ client["timeout"])

2686

logger.debug("Last checker succeeded,"

2687

" keeping {} enabled".format(

2688

client_name))

1905

def client_config_items(config, section):

1906

special_settings = {

1907

"approved_by_default":

1908

lambda: config.getboolean(section,

1909

"approved_by_default"),

1910

}

1911

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

2689

1912

try:

2690

client["secret"] = pgp.decrypt(

2691

client["encrypted_secret"],

2692

client_settings[client_name]["secret"])

2693

except PGPError:

2694

# If decryption fails, we use secret from new settings

2695

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

2696

client_name))

2697

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

2698

["secret"])

2699

2700

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

2701

for client_name in (set(old_client_settings)

2702

- set(client_settings)):

2703

del clients_data[client_name]

2704

for client_name in (set(client_settings)

2705

- set(old_client_settings)):

2706

clients_data[client_name] = client_settings[client_name]

2707

2708

# Create all client objects

2709

for client_name, client in clients_data.items():

2710

tcp_server.clients[client_name] = client_class(

2711

name = client_name,

2712

settings = client,

2713

server_settings = server_settings)

2714

1913

yield (name, special_settings[name]())

1914

except KeyError:

1915

yield (name, value)

1916

1917

tcp_server.clients.update(set(

1918

client_class(name = section,

1919

config= dict(client_config_items(

1920

client_config, section)))

1921

for section in client_config.sections()))

2715

1922

if not tcp_server.clients:

2716

1923

logger.warning("No clients defined")

2717

2718

if not foreground:

2719

if pidfile is not None:

2720

pid = os.getpid()

2721

try:

2722

with pidfile:

2723

print(pid, file=pidfile)

2724

except IOError:

2725

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

2726

pidfilename, pid)

2727

del pidfile

1924

1925

if not debug:

1926

try:

1927

with pidfile:

1928

pid = os.getpid()

1929

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

1930

del pidfile

1931

except IOError:

1932

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

1933

pidfilename, pid)

1934

except NameError:

1935

# "pidfile" was never created

1936

pass

2728

1937

del pidfilename

1938

1939

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

2729

1940

2730

1941

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

2731

1942

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

2732

1943

2733

1944

if use_dbus:

2734

2735

@alternate_dbus_interfaces(

2736

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

2737

class MandosDBusService(DBusObjectWithProperties):

1945

class MandosDBusService(dbus.service.Object):

2738

1946

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

2739

2740

1947

def __init__(self):

2741

1948

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

2742

2743

_interface = "se.recompile.Mandos"

2744

2745

@dbus_interface_annotations(_interface)

2746

def _foo(self):

2747

return {

2748

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

2749

"false" }

1949

_interface = "se.bsnet.fukt.Mandos"

2750

1950

2751

1951

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

2752

1952

def ClientAdded(self, objpath):

2766

1966

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

2767

1967

def GetAllClients(self):

2768

1968

"D-Bus method"

2769

return dbus.Array(c.dbus_object_path for c in

2770

tcp_server.clients.itervalues())

1969

return dbus.Array(c.dbus_object_path

1970

for c in tcp_server.clients)

2771

1971

2772

1972

@dbus.service.method(_interface,

2773

1973

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

2774

1974

def GetAllClientsWithProperties(self):

2775

1975

"D-Bus method"

2776

1976

return dbus.Dictionary(

2777

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

2778

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

1977

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

1978

for c in tcp_server.clients),

2779

1979

signature="oa{sv}")

2780

1980

2781

1981

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

2782

1982

def RemoveClient(self, object_path):

2783

1983

"D-Bus method"

2784

for c in tcp_server.clients.itervalues():

1984

for c in tcp_server.clients:

2785

1985

if c.dbus_object_path == object_path:

2786

del tcp_server.clients[c.name]

1986

tcp_server.clients.remove(c)

2787

1987

c.remove_from_connection()

2788

1988

# Don't signal anything except ClientRemoved

2789

1989

c.disable(quiet=True)

2798

1998

2799

1999

def cleanup():

2800

2000

"Cleanup function; run on exit"

2801

if zeroconf:

2802

service.cleanup()

2803

2804

multiprocessing.active_children()

2805

wnull.close()

2806

if not (tcp_server.clients or client_settings):

2807

return

2808

2809

# Store client before exiting. Secrets are encrypted with key

2810

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

2811

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

2812

clients = {}

2813

with PGPEngine() as pgp:

2814

for client in tcp_server.clients.itervalues():

2815

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

2816

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

2817

key)

2818

client_dict = {}

2819

2820

# A list of attributes that can not be pickled

2821

# + secret.

2822

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

2823

"checker", "server_settings" }

2824

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

2825

.Object):

2826

exclude.add(name)

2827

2828

client_dict["encrypted_secret"] = (client

2829

.encrypted_secret)

2830

for attr in client.client_structure:

2831

if attr not in exclude:

2832

client_dict[attr] = getattr(client, attr)

2833

2834

clients[client.name] = client_dict

2835

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

2836

2837

try:

2838

with tempfile.NamedTemporaryFile(

2839

mode='wb',

2840

suffix=".pickle",

2841

prefix='clients-',

2842

dir=os.path.dirname(stored_state_path),

2843

delete=False) as stored_state:

2844

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

2845

tempname = stored_state.name

2846

os.rename(tempname, stored_state_path)

2847

except (IOError, OSError) as e:

2848

if not debug:

2849

try:

2850

os.remove(tempname)

2851

except NameError:

2852

pass

2853

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

2854

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

2855

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

2856

else:

2857

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

2858

exc_info=e)

2859

raise

2860

2861

# Delete all clients, and settings from config

2001

service.cleanup()

2002

2862

2003

while tcp_server.clients:

2863

name, client = tcp_server.clients.popitem()

2004

client = tcp_server.clients.pop()

2864

2005

if use_dbus:

2865

2006

client.remove_from_connection()

2007

client.disable_hook = None

2866

2008

# Don't signal anything except ClientRemoved

2867

2009

client.disable(quiet=True)

2868

2010

if use_dbus:

2869

2011

# Emit D-Bus signal

2870

mandos_dbus_service.ClientRemoved(

2871

client.dbus_object_path, client.name)

2872

client_settings.clear()

2012

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2013

client.name)

2873

2014

2874

2015

atexit.register(cleanup)

2875

2016

2876

for client in tcp_server.clients.itervalues():

2017

for client in tcp_server.clients:

2877

2018

if use_dbus:

2878

2019

# Emit D-Bus signal

2879

2020

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2880

# Need to initiate checking of clients

2881

if client.enabled:

2882

client.init_checker()

2021

client.enable()

2883

2022

2884

2023

tcp_server.enable()

2885

2024

tcp_server.server_activate()

2886

2025

2887

2026

# Find out what port we got

2888

if zeroconf:

2889

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

2027

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

2890

2028

if use_ipv6:

2891

2029

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

2892

" flowinfo %d, scope_id %d",

2893

*tcp_server.socket.getsockname())

2030

" flowinfo %d, scope_id %d"

2031

% tcp_server.socket.getsockname())

2894

2032

else: # IPv4

2895

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

2896

*tcp_server.socket.getsockname())

2033

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

2034

% tcp_server.socket.getsockname())

2897

2035

2898

2036

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

2899

2037

2900

2038

try:

2901

if zeroconf:

2902

# From the Avahi example code

2903

try:

2904

service.activate()

2905

except dbus.exceptions.DBusException as error:

2906

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

2907

cleanup()

2908

sys.exit(1)

2909

# End of Avahi example code

2039

# From the Avahi example code

2040

try:

2041

service.activate()

2042

except dbus.exceptions.DBusException as error:

2043

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

2044

cleanup()

2045

sys.exit(1)

2046

# End of Avahi example code

2910

2047

2911

2048

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

2912

2049

lambda *args, **kwargs:

2916

2053

logger.debug("Starting main loop")

2917

2054

main_loop.run()

2918

2055

except AvahiError as error:

2919

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

2056

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

2920

2057

cleanup()

2921

2058

sys.exit(1)

2922

2059

except KeyboardInterrupt: