/mandos/release : revision 237.7.292

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

63

65

import cPickle as pickle

64

66

import multiprocessing

65

67

import types

68

import binascii

69

import tempfile

70

import itertools

71

import collections

66

72

67

73

import dbus

68

74

import dbus.service

82

88

except ImportError:

83

89

SO_BINDTODEVICE = None

84

90

91

if sys.version_info.major == 2:

92

str = unicode

85

93

86

version = "1.4.1"

94

version = "1.6.9"

95

stored_state_file = "clients.pickle"

87

96

88

97

logger = logging.getLogger()

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('%(asctime)s %(name)s'

99

' [%(process)d]:'

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

98

syslogger = None

99

100

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

104

except (OSError, AttributeError):

105

def if_nametoindex(interface):

106

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

107

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

108

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

109

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

110

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

111

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

112

return interface_index

113

114

115

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

116

"""init logger and add loglevel"""

117

118

global syslogger

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

123

syslogger.setFormatter(logging.Formatter

124

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

125

' %(message)s'))

126

logger.addHandler(syslogger)

127

128

if debug:

129

console = logging.StreamHandler()

130

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

131

' [%(process)d]:'

132

' %(levelname)s:'

133

' %(message)s'))

134

logger.addHandler(console)

135

logger.setLevel(level)

136

137

138

class PGPError(Exception):

139

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

140

pass

141

142

143

class PGPEngine(object):

144

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

145

def __init__(self):

146

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

147

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

149

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

153

def __enter__(self):

154

return self

155

156

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

157

self._cleanup()

158

return False

159

160

def __del__(self):

161

self._cleanup()

162

163

def _cleanup(self):

164

if self.tempdir is not None:

165

# Delete contents of tempdir

166

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

167

topdown = False):

168

for filename in files:

169

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

170

for dirname in dirs:

171

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

172

# Remove tempdir

173

os.rmdir(self.tempdir)

174

self.tempdir = None

175

176

def password_encode(self, password):

177

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

178

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

179

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

180

if len(encoded) > 2048:

181

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

182

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

183

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

184

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

185

return encoded

186

187

def encrypt(self, data, password):

188

passphrase = self.password_encode(password)

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

191

passfile.write(passphrase)

192

passfile.flush()

193

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

194

'--passphrase-file',

195

passfile.name]

196

+ self.gnupgargs,

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

201

if proc.returncode != 0:

202

raise PGPError(err)

203

return ciphertext

204

205

def decrypt(self, data, password):

206

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

209

passfile.write(passphrase)

210

passfile.flush()

211

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

212

'--passphrase-file',

213

passfile.name]

214

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

220

if proc.returncode != 0:

221

raise PGPError(err)

222

return decrypted_plaintext

103

223

104

224

105

225

class AvahiError(Exception):

106

226

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

107

227

self.value = value

108

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

109

def __unicode__(self):

110

return unicode(repr(self.value))

228

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

229

**kwargs)

111

230

112

231

class AvahiServiceError(AvahiError):

113

232

pass

124

243

Used to optionally bind to the specified interface.

125

244

name: string; Example: 'Mandos'

126

245

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

127

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

246

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

128

247

port: integer; what port to announce

129

248

TXT: list of strings; TXT record for the service

130

249

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

136

255

server: D-Bus Server

137

256

bus: dbus.SystemBus()

138

257

"""

258

139

259

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

140

260

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

141

261

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

154

274

self.server = None

155

275

self.bus = bus

156

276

self.entry_group_state_changed_match = None

157

def rename(self):

277

278

def rename(self, remove=True):

158

279

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

159

280

if self.rename_count >= self.max_renames:

160

281

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

161

282

" after %i retries, exiting.",

162

283

self.rename_count)

163

284

raise AvahiServiceError("Too many renames")

164

self.name = unicode(self.server

165

.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

287

self.rename_count += 1

166

288

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

167

289

self.name)

168

self.remove()

290

if remove:

291

self.remove()

169

292

try:

170

293

self.add()

171

294

except dbus.exceptions.DBusException as error:

172

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

173

self.cleanup()

174

os._exit(1)

175

self.rename_count += 1

295

if (error.get_dbus_name()

296

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

297

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

298

return self.rename(remove=False)

299

else:

300

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

301

self.cleanup()

302

os._exit(1)

303

176

304

def remove(self):

177

305

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

178

306

if self.entry_group_state_changed_match is not None:

180

308

self.entry_group_state_changed_match = None

181

309

if self.group is not None:

182

310

self.group.Reset()

311

183

312

def add(self):

184

313

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

185

314

self.remove()

202

331

dbus.UInt16(self.port),

203

332

avahi.string_array_to_txt_array(self.TXT))

204

333

self.group.Commit()

334

205

335

def entry_group_state_changed(self, state, error):

206

336

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

207

337

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

213

343

self.rename()

214

344

elif state == avahi.ENTRY_GROUP_FAILURE:

215

345

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

216

unicode(error))

217

raise AvahiGroupError("State changed: %s"

218

% unicode(error))

346

str(error))

347

raise AvahiGroupError("State changed: {!s}"

348

.format(error))

349

219

350

def cleanup(self):

220

351

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

221

352

if self.group is not None:

222

353

try:

223

354

self.group.Free()

224

355

except (dbus.exceptions.UnknownMethodException,

225

dbus.exceptions.DBusException) as e:

356

dbus.exceptions.DBusException):

226

357

pass

227

358

self.group = None

228

359

self.remove()

360

229

361

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

230

362

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

231

363

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

250

382

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

251

383

else:

252

384

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

385

253

386

def activate(self):

254

387

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

255

388

if self.server is None:

262

395

self.server_state_changed)

263

396

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

264

397

398

265

399

class AvahiServiceToSyslog(AvahiService):

266

def rename(self):

400

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

267

401

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

268

ret = AvahiService.rename(self)

402

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

269

403

syslogger.setFormatter(logging.Formatter

270

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

271

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

272

% self.name))

404

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

405

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

406

.format(self.name)))

273

407

return ret

274

408

275

def _timedelta_to_milliseconds(td):

276

"Convert a datetime.timedelta() to milliseconds"

277

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

278

+ (td.seconds * 1000)

279

+ (td.microseconds // 1000))

280

409

281

410

class Client(object):

282

411

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

283

412

284

413

Attributes:

285

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

414

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

286

415

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

287

416

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

288

417

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

295

424

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

296

425

checker_initiator_tag: a gobject event source tag, or None

297

426

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

427

client_structure: Object describing what attributes a client has

428

and is used for storing the client at exit

298

429

current_checker_command: string; current running checker_command

299

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

300

430

disable_initiator_tag: a gobject event source tag, or None

301

431

enabled: bool()

302

432

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

305

435

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

306

436

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

307

437

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

308

last_enabled: datetime.datetime(); (UTC)

438

last_checker_status: integer between 0 and 255 reflecting exit

439

status of last checker. -1 reflects crashed

440

checker, -2 means no checker completed yet.

441

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

309

442

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

310

443

D-Bus identifiers

311

444

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

312

445

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

313

446

until this client is disabled

314

extended_timeout: extra long timeout when password has been sent

447

extended_timeout: extra long timeout when secret has been sent

315

448

runtime_expansions: Allowed attributes for runtime expansion.

316

449

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

317

450

disabled, or None

451

server_settings: The server_settings dict from main()

318

452

"""

319

453

320

454

runtime_expansions = ("approval_delay", "approval_duration",

321

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

322

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

455

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

456

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

457

"last_approval_request", "last_checked_ok",

323

458

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

324

325

def timeout_milliseconds(self):

326

"Return the 'timeout' attribute in milliseconds"

327

return _timedelta_to_milliseconds(self.timeout)

328

329

def extended_timeout_milliseconds(self):

330

"Return the 'extended_timeout' attribute in milliseconds"

331

return _timedelta_to_milliseconds(self.extended_timeout)

332

333

def interval_milliseconds(self):

334

"Return the 'interval' attribute in milliseconds"

335

return _timedelta_to_milliseconds(self.interval)

336

337

def approval_delay_milliseconds(self):

338

return _timedelta_to_milliseconds(self.approval_delay)

339

340

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

341

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

342

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

343

attribute."""

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

@staticmethod

471

def config_parser(config):

472

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

473

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

474

with exceptions for any special settings as defined above.

475

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

476

value given the same arguments.

477

"""

478

settings = {}

479

for client_name in config.sections():

480

section = dict(config.items(client_name))

481

client = settings[client_name] = {}

482

483

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

484

# Reformat values from string types to Python types

485

client["approved_by_default"] = config.getboolean(

486

client_name, "approved_by_default")

487

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

488

"enabled")

489

490

# Uppercase and remove spaces from fingerprint for later

491

# comparison purposes with return value from the

492

# fingerprint() function

493

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

494

.replace(" ", ""))

495

if "secret" in section:

496

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

497

elif "secfile" in section:

498

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

499

(section["secfile"])),

500

"rb") as secfile:

501

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

502

else:

503

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

504

.format(section))

505

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

506

client["extended_timeout"] = string_to_delta(

507

section["extended_timeout"])

508

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

509

client["approval_delay"] = string_to_delta(

510

section["approval_delay"])

511

client["approval_duration"] = string_to_delta(

512

section["approval_duration"])

513

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

514

client["last_approval_request"] = None

515

client["last_checked_ok"] = None

516

client["last_checker_status"] = -2

517

518

return settings

519

520

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

344

521

self.name = name

345

if config is None:

346

config = {}

522

if server_settings is None:

523

server_settings = {}

524

self.server_settings = server_settings

525

# adding all client settings

526

for setting, value in settings.items():

527

setattr(self, setting, value)

528

529

if self.enabled:

530

if not hasattr(self, "last_enabled"):

531

self.last_enabled = datetime.datetime.utcnow()

532

if not hasattr(self, "expires"):

533

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

534

+ self.timeout)

535

else:

536

self.last_enabled = None

537

self.expires = None

538

347

539

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

348

# Uppercase and remove spaces from fingerprint for later

349

# comparison purposes with return value from the fingerprint()

350

# function

351

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

352

.replace(" ", ""))

353

540

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

354

if "secret" in config:

355

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

356

elif "secfile" in config:

357

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

358

(config["secfile"])),

359

"rb") as secfile:

360

self.secret = secfile.read()

361

else:

362

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

363

% self.name)

364

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

365

self.created = datetime.datetime.utcnow()

366

self.enabled = False

367

self.last_approval_request = None

368

self.last_enabled = None

369

self.last_checked_ok = None

370

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

371

self.extended_timeout = string_to_delta(config

372

["extended_timeout"])

373

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

374

self.disable_hook = disable_hook

541

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

542

datetime.datetime.utcnow())

543

544

# attributes specific for this server instance

375

545

self.checker = None

376

546

self.checker_initiator_tag = None

377

547

self.disable_initiator_tag = None

378

self.expires = None

379

548

self.checker_callback_tag = None

380

self.checker_command = config["checker"]

381

549

self.current_checker_command = None

382

self.last_connect = None

383

self._approved = None

384

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

385

True)

550

self.approved = None

386

551

self.approvals_pending = 0

387

self.approval_delay = string_to_delta(

388

config["approval_delay"])

389

self.approval_duration = string_to_delta(

390

config["approval_duration"])

391

552

self.changedstate = (multiprocessing_manager

392

553

.Condition(multiprocessing_manager

393

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

557

if not attr.startswith("_")]

558

self.client_structure.append("client_structure")

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

564

if not name.startswith("_"):

565

self.client_structure.append(name)

394

566

567

# Send notice to process children that client state has changed

395

568

def send_changedstate(self):

396

self.changedstate.acquire()

397

self.changedstate.notify_all()

398

self.changedstate.release()

569

with self.changedstate:

570

self.changedstate.notify_all()

399

571

400

572

def enable(self):

401

573

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

402

574

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

403

575

# Already enabled

404

576

return

405

self.send_changedstate()

406

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

407

# and every interval from then on.

408

self.checker_initiator_tag = (gobject.timeout_add

409

(self.interval_milliseconds(),

410

self.start_checker))

411

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

412

577

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

413

self.disable_initiator_tag = (gobject.timeout_add

414

(self.timeout_milliseconds(),

415

self.disable))

416

578

self.enabled = True

417

579

self.last_enabled = datetime.datetime.utcnow()

418

# Also start a new checker *right now*.

419

self.start_checker()

580

self.init_checker()

581

self.send_changedstate()

420

582

421

583

def disable(self, quiet=True):

422

584

"""Disable this client."""

423

585

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

424

586

return False

425

587

if not quiet:

426

self.send_changedstate()

427

if not quiet:

428

588

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

429

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

589

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

430

590

gobject.source_remove(self.disable_initiator_tag)

431

591

self.disable_initiator_tag = None

432

592

self.expires = None

433

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

593

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

434

594

gobject.source_remove(self.checker_initiator_tag)

435

595

self.checker_initiator_tag = None

436

596

self.stop_checker()

437

if self.disable_hook:

438

self.disable_hook(self)

439

597

self.enabled = False

598

if not quiet:

599

self.send_changedstate()

440

600

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

441

601

return False

442

602

443

603

def __del__(self):

444

self.disable_hook = None

445

604

self.disable()

446

605

606

def init_checker(self):

607

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

608

# and every interval from then on.

609

if self.checker_initiator_tag is not None:

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

615

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

616

if self.disable_initiator_tag is not None:

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

622

# Also start a new checker *right now*.

623

self.start_checker()

624

447

625

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

448

626

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

449

627

self.checker_callback_tag = None

450

628

self.checker = None

451

629

if os.WIFEXITED(condition):

452

exitstatus = os.WEXITSTATUS(condition)

453

if exitstatus == 0:

630

self.last_checker_status = os.WEXITSTATUS(condition)

631

if self.last_checker_status == 0:

454

632

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

455

633

vars(self))

456

634

self.checked_ok()

458

636

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

459

637

vars(self))

460

638

else:

639

self.last_checker_status = -1

461

640

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

462

641

vars(self))

463

642

464

def checked_ok(self, timeout=None):

465

"""Bump up the timeout for this client.

466

467

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

468

alive and well.

469

"""

643

def checked_ok(self):

644

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

645

self.last_checked_ok = datetime.datetime.utcnow()

646

self.last_checker_status = 0

647

self.bump_timeout()

648

649

def bump_timeout(self, timeout=None):

650

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

470

651

if timeout is None:

471

652

timeout = self.timeout

472

self.last_checked_ok = datetime.datetime.utcnow()

473

653

if self.disable_initiator_tag is not None:

474

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = None

475

656

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

476

657

self.disable_initiator_tag = (gobject.timeout_add

477

(_timedelta_to_milliseconds

478

(timeout), self.disable))

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

479

660

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

480

661

481

662

def need_approval(self):

487

668

If a checker already exists, leave it running and do

488

669

nothing."""

489

670

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

490

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

491

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

492

# client would inevitably timeout, since no checker would get

493

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

671

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

672

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

673

# would inevitably timeout, since no checker would get a

674

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

494

675

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

495

676

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

496

677

# should be.

498

679

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

499

680

try:

500

681

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

501

except (AttributeError, OSError) as error:

502

if (isinstance(error, OSError)

503

and error.errno != errno.ECHILD):

504

raise error

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

505

687

else:

506

688

if pid:

507

689

logger.warning("Checker was a zombie")

510

692

self.current_checker_command)

511

693

# Start a new checker if needed

512

694

if self.checker is None:

695

# Escape attributes for the shell

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

513

699

try:

514

# In case checker_command has exactly one % operator

515

command = self.checker_command % self.host

516

except TypeError:

517

# Escape attributes for the shell

518

escaped_attrs = dict(

519

(attr,

520

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

521

errors=

522

'replace')))

523

for attr in

524

self.runtime_expansions)

525

526

try:

527

command = self.checker_command % escaped_attrs

528

except TypeError as error:

529

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

530

' %s', self.checker_command, error)

531

return True # Try again later

700

command = self.checker_command % escaped_attrs

701

except TypeError as error:

702

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

532

705

self.current_checker_command = command

533

706

try:

534

707

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

537

710

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

538

711

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

539

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

540

721

self.checker = subprocess.Popen(command,

541

722

close_fds=True,

542

shell=True, cwd="/")

543

self.checker_callback_tag = (gobject.child_watch_add

544

(self.checker.pid,

545

self.checker_callback,

546

data=command))

547

# The checker may have completed before the gobject

548

# watch was added. Check for this.

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

549

736

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

550

if pid:

551

gobject.source_remove(self.checker_callback_tag)

552

self.checker_callback(pid, status, command)

553

737

except OSError as error:

554

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

555

error)

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

556

747

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

557

748

return True

558

749

565

756

return

566

757

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

567

758

try:

568

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

759

self.checker.terminate()

569

760

#time.sleep(0.5)

570

761

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

571

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

762

# self.checker.kill()

572

763

except OSError as error:

573

764

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

574

765

raise

591

782

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

592

783

if byte_arrays and signature != "ay":

593

784

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

594

" signature %r" % signature)

785

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

595

786

def decorator(func):

596

787

func._dbus_is_property = True

597

788

func._dbus_interface = dbus_interface

605

796

return decorator

606

797

607

798

799

def dbus_interface_annotations(dbus_interface):

800

"""Decorator for marking functions returning interface annotations

801

802

Usage:

803

804

@dbus_interface_annotations("org.example.Interface")

805

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

806

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

807

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

808

"false"}

809

"""

810

def decorator(func):

811

func._dbus_is_interface = True

812

func._dbus_interface = dbus_interface

813

func._dbus_name = dbus_interface

814

return func

815

return decorator

816

817

818

def dbus_annotations(annotations):

819

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

820

Usage:

821

822

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

823

"org.freedesktop.DBus.Property."

824

"EmitsChangedSignal": "false"})

825

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

826

access="r")

827

def Property_dbus_property(self):

828

return dbus.Boolean(False)

829

"""

830

def decorator(func):

831

func._dbus_annotations = annotations

832

return func

833

return decorator

834

835

608

836

class DBusPropertyException(dbus.exceptions.DBusException):

609

837

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

610

838

"""

611

def __unicode__(self):

612

return unicode(str(self))

613

839

pass

614

840

615

841

class DBusPropertyAccessException(DBusPropertyException):

616

842

"""A property's access permissions disallows an operation.

633

859

"""

634

860

635

861

@staticmethod

636

def _is_dbus_property(obj):

637

return getattr(obj, "_dbus_is_property", False)

862

def _is_dbus_thing(thing):

863

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

864

865

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

866

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

867

"""

868

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

869

False)

638

870

639

def _get_all_dbus_properties(self):

871

def _get_all_dbus_things(self, thing):

640

872

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

641

873

"""

642

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

874

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

875

name),

876

athing.__get__(self))

643

877

for cls in self.__class__.__mro__

644

for name, prop in

645

inspect.getmembers(cls, self._is_dbus_property))

878

for name, athing in

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

646

881

647

882

def _get_dbus_property(self, interface_name, property_name):

648

883

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

650

885

"""

651

886

for cls in self.__class__.__mro__:

652

887

for name, value in (inspect.getmembers

653

(cls, self._is_dbus_property)):

888

(cls,

889

self._is_dbus_thing("property"))):

654

890

if (value._dbus_name == property_name

655

891

and value._dbus_interface == interface_name):

656

892

return value.__get__(self)

684

920

# The byte_arrays option is not supported yet on

685

921

# signatures other than "ay".

686

922

if prop._dbus_signature != "ay":

687

raise ValueError

688

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

689

for byte in value))

923

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

924

"'ay' signature {!r}"

925

.format(prop._dbus_signature))

926

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

927

for byte in value))

690

928

prop(value)

691

929

692

930

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

697

935

698

936

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

699

937

"""

700

all = {}

701

for name, prop in self._get_all_dbus_properties():

938

properties = {}

939

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

702

940

if (interface_name

703

941

and interface_name != prop._dbus_interface):

704

942

# Interface non-empty but did not match

708

946

continue

709

947

value = prop()

710

948

if not hasattr(value, "variant_level"):

711

all[name] = value

949

properties[name] = value

712

950

continue

713

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

714

value.variant_level+1)

715

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

951

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

952

value.variant_level+1)

953

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

954

955

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

956

def PropertiesChanged(self, interface_name, changed_properties,

957

invalidated_properties):

958

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

959

standard.

960

"""

961

pass

716

962

717

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

718

964

out_signature="s",

719

965

path_keyword='object_path',

720

966

connection_keyword='connection')

721

967

def Introspect(self, object_path, connection):

722

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

968

"""Overloading of standard D-Bus method.

969

970

Inserts property tags and interface annotation tags.

723

971

"""

724

972

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

725

973

connection)

732

980

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

733

981

return e

734

982

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

983

# Add property tags

735

984

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

736

985

for name, prop

737

in self._get_all_dbus_properties()

986

in self._get_all_dbus_things("property")

738

987

if prop._dbus_interface

739

988

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

740

989

if_tag.appendChild(tag)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

741

1021

# Add the names to the return values for the

742

1022

# "org.freedesktop.DBus.Properties" methods

743

1023

if (if_tag.getAttribute("name")

758

1038

except (AttributeError, xml.dom.DOMException,

759

1039

xml.parsers.expat.ExpatError) as error:

760

1040

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

761

error)

1041

exc_info=error)

762

1042

return xmlstring

763

1043

764

1044

765

def datetime_to_dbus (dt, variant_level=0):

1045

def datetime_to_dbus(dt, variant_level=0):

766

1046

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

767

1047

if dt is None:

768

1048

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

769

1049

return dbus.String(dt.isoformat(),

770

1050

variant_level=variant_level)

771

1051

772

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

773

.__metaclass__):

774

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

775

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

1052

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1054

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

1055

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

1056

interface names according to the "alt_interface_names" mapping.

1057

Usage:

1058

1059

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

1060

"net.example.AlternateInterface"})

1061

class SampleDBusObject(dbus.service.Object):

1062

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

1063

def SampleDBusMethod():

1064

pass

1065

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1067

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

1068

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

1069

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

1070

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

1071

1072

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

1073

(from DBusObjectWithProperties) and interfaces (from the

1074

dbus_interface_annotations decorator).

776

1075

"""

777

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

778

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

779

# methods, signals, or properties in them

780

for base in (b for b in bases

781

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

782

# Go though all attributes of the base class

783

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

1076

def wrapper(cls):

1077

for orig_interface_name, alt_interface_name in (

1078

alt_interface_names.items()):

1079

attr = {}

1080

interface_names = set()

1081

# Go though all attributes of the class

1082

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

784

1083

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

785

1084

# with the wrong interface name

786

1085

if (not hasattr(attribute, "_dbus_interface")

787

1086

or not attribute._dbus_interface

788

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

1087

.startswith(orig_interface_name)):

789

1088

continue

790

1089

# Create an alternate D-Bus interface name based on

791

1090

# the current name

792

1091

alt_interface = (attribute._dbus_interface

793

.replace("se.recompile.Mandos",

794

"se.bsnet.fukt.Mandos"))

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1094

interface_names.add(alt_interface)

795

1095

# Is this a D-Bus signal?

796

1096

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

797

# Extract the original non-method function by

798

# black magic

1097

# Extract the original non-method undecorated

1098

# function by black magic

799

1099

nonmethod_func = (dict(

800

1100

zip(attribute.func_code.co_freevars,

801

1101

attribute.__closure__))["func"]

812

1112

nonmethod_func.func_name,

813

1113

nonmethod_func.func_defaults,

814

1114

nonmethod_func.func_closure)))

1115

# Copy annotations, if any

1116

try:

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1119

except AttributeError:

1120

pass

815

1121

# Define a creator of a function to call both the

816

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

817

# signals gets sent when the function is called

1122

# original and alternate functions, so both the

1123

# original and alternate signals gets sent when

1124

# the function is called

818

1125

def fixscope(func1, func2):

819

1126

"""This function is a scope container to pass

820

1127

func1 and func2 to the "call_both" function

827

1134

return call_both

828

1135

# Create the "call_both" function and add it to

829

1136

# the class

830

attr[attrname] = fixscope(attribute,

831

new_function)

1137

attr[attrname] = fixscope(attribute, new_function)

832

1138

# Is this a D-Bus method?

833

1139

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

834

1140

# Create a new, but exactly alike, function

845

1151

attribute.func_name,

846

1152

attribute.func_defaults,

847

1153

attribute.func_closure)))

1154

# Copy annotations, if any

1155

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1158

except AttributeError:

1159

pass

848

1160

# Is this a D-Bus property?

849

1161

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

850

1162

# Create a new, but exactly alike, function

864

1176

attribute.func_name,

865

1177

attribute.func_defaults,

866

1178

attribute.func_closure)))

867

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

868

1179

# Copy annotations, if any

1180

try:

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1183

except AttributeError:

1184

pass

1185

# Is this a D-Bus interface?

1186

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

1187

# Create a new, but exactly alike, function

1188

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

1189

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

1190

# to the class.

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1199

if deprecate:

1200

# Deprecate all alternate interfaces

1201

iname="_AlternateDBusNames_interface_annotation{}"

1202

for interface_name in interface_names:

1203

@dbus_interface_annotations(interface_name)

1204

def func(self):

1205

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

1206

"true" }

1207

# Find an unused name

1208

for aname in (iname.format(i)

1209

for i in itertools.count()):

1210

if aname not in attr:

1211

attr[aname] = func

1212

break

1213

if interface_names:

1214

# Replace the class with a new subclass of it with

1215

# methods, signals, etc. as created above.

1216

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

1217

(cls,), attr)

1218

return cls

1219

return wrapper

1220

1221

1222

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

1223

"se.bsnet.fukt.Mandos"})

869

1224

class ClientDBus(Client, DBusObjectWithProperties):

870

1225

"""A Client class using D-Bus

871

1226

877

1232

runtime_expansions = (Client.runtime_expansions

878

1233

+ ("dbus_object_path",))

879

1234

1235

_interface = "se.recompile.Mandos.Client"

1236

880

1237

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

881

1238

882

1239

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

883

self._approvals_pending = 0

884

1240

self.bus = bus

885

1241

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

886

1242

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

887

1243

# the D-Bus

888

client_object_name = unicode(self.name).translate(

1244

client_object_name = str(self.name).translate(

889

1245

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

890

1246

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

891

1247

self.dbus_object_path = (dbus.ObjectPath

892

1248

("/clients/" + client_object_name))

893

1249

DBusObjectWithProperties.__init__(self, self.bus,

894

1250

self.dbus_object_path)

895

1251

896

1252

def notifychangeproperty(transform_func,

897

1253

dbus_name, type_func=lambda x: x,

898

variant_level=1):

1254

variant_level=1, invalidate_only=False,

1255

_interface=_interface):

899

1256

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

900

1257

its changes to DBus.

901

1258

902

1259

transform_fun: Function that takes a value and a variant_level

903

1260

and transforms it to a D-Bus type.

904

1261

dbus_name: D-Bus name of the variable

906

1263

to the D-Bus. Default: no transform

907

1264

variant_level: D-Bus variant level. Default: 1

908

1265

"""

909

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

1266

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

910

1267

def setter(self, value):

911

1268

if hasattr(self, "dbus_object_path"):

912

1269

if (not hasattr(self, attrname) or

913

1270

type_func(getattr(self, attrname, None))

914

1271

!= type_func(value)):

915

dbus_value = transform_func(type_func(value),

916

variant_level

917

=variant_level)

918

self.PropertyChanged(dbus.String(dbus_name),

919

dbus_value)

1272

if invalidate_only:

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1277

else:

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

920

1287

setattr(self, attrname, value)

921

1288

922

1289

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

923

1290

924

925

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

926

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

927

1293

"ApprovalPending",

934

1300

checker is not None)

935

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

936

1302

"LastCheckedOK")

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1304

"LastCheckerStatus")

937

1305

last_approval_request = notifychangeproperty(

938

1306

datetime_to_dbus, "LastApprovalRequest")

939

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

940

1308

"ApprovedByDefault")

941

approval_delay = notifychangeproperty(dbus.UInt16,

1309

approval_delay = notifychangeproperty(dbus.UInt64,

942

1310

"ApprovalDelay",

943

1311

type_func =

944

_timedelta_to_milliseconds)

1312

lambda td: td.total_seconds()

1313

* 1000)

945

1314

approval_duration = notifychangeproperty(

946

dbus.UInt16, "ApprovalDuration",

947

type_func = _timedelta_to_milliseconds)

1315

dbus.UInt64, "ApprovalDuration",

1316

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

948

1317

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

949

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

950

type_func =

951

_timedelta_to_milliseconds)

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

952

1321

extended_timeout = notifychangeproperty(

953

dbus.UInt16, "ExtendedTimeout",

954

type_func = _timedelta_to_milliseconds)

955

interval = notifychangeproperty(dbus.UInt16,

1322

dbus.UInt64, "ExtendedTimeout",

1323

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

1324

interval = notifychangeproperty(dbus.UInt64,

956

1325

"Interval",

957

1326

type_func =

958

_timedelta_to_milliseconds)

1327

lambda td: td.total_seconds()

1328

* 1000)

959

1329

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

1330

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

1331

invalidate_only=True)

960

1332

961

1333

del notifychangeproperty

962

1334

989

1361

*args, **kwargs)

990

1362

991

1363

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

992

old_checker = self.checker

993

if self.checker is not None:

994

old_checker_pid = self.checker.pid

995

else:

996

old_checker_pid = None

1364

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

997

1365

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

998

1366

# Only if new checker process was started

999

1367

if (self.checker is not None

1003

1371

return r

1004

1372

1005

1373

def _reset_approved(self):

1006

self._approved = None

1374

self.approved = None

1007

1375

return False

1008

1376

1009

1377

def approve(self, value=True):

1378

self.approved = value

1379

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

1380

* 1000), self._reset_approved)

1010

1381

self.send_changedstate()

1011

self._approved = value

1012

gobject.timeout_add(_timedelta_to_milliseconds

1013

(self.approval_duration),

1014

self._reset_approved)

1015

1016

1382

1017

1383

## D-Bus methods, signals & properties

1018

_interface = "se.recompile.Mandos.Client"

1384

1385

## Interfaces

1019

1386

1020

1387

## Signals

1021

1388

1032

1399

pass

1033

1400

1034

1401

# PropertyChanged - signal

1402

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

1035

1403

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

1036

1404

def PropertyChanged(self, property, value):

1037

1405

"D-Bus signal"

1113

1481

access="readwrite")

1114

1482

def ApprovalDelay_dbus_property(self, value=None):

1115

1483

if value is None: # get

1116

return dbus.UInt64(self.approval_delay_milliseconds())

1484

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

1485

* 1000)

1117

1486

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

1118

1487

1119

1488

# ApprovalDuration - property

1121

1490

access="readwrite")

1122

1491

def ApprovalDuration_dbus_property(self, value=None):

1123

1492

if value is None: # get

1124

return dbus.UInt64(_timedelta_to_milliseconds(

1125

self.approval_duration))

1493

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

1494

* 1000)

1126

1495

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

1127

1496

1128

1497

# Name - property

1141

1510

def Host_dbus_property(self, value=None):

1142

1511

if value is None: # get

1143

1512

return dbus.String(self.host)

1144

self.host = value

1513

self.host = str(value)

1145

1514

1146

1515

# Created - property

1147

1516

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

1148

1517

def Created_dbus_property(self):

1149

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

1518

return datetime_to_dbus(self.created)

1150

1519

1151

1520

# LastEnabled - property

1152

1521

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

1173

1542

return

1174

1543

return datetime_to_dbus(self.last_checked_ok)

1175

1544

1545

# LastCheckerStatus - property

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

1548

def LastCheckerStatus_dbus_property(self):

1549

return dbus.Int16(self.last_checker_status)

1550

1176

1551

# Expires - property

1177

1552

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

1178

1553

def Expires_dbus_property(self):

1188

1563

access="readwrite")

1189

1564

def Timeout_dbus_property(self, value=None):

1190

1565

if value is None: # get

1191

return dbus.UInt64(self.timeout_milliseconds())

1566

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

1567

old_timeout = self.timeout

1192

1568

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

1193

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

1194

return

1195

# Reschedule timeout

1196

gobject.source_remove(self.disable_initiator_tag)

1197

self.disable_initiator_tag = None

1198

self.expires = None

1199

time_to_die = _timedelta_to_milliseconds((self

1200

.last_checked_ok

1201

+ self.timeout)

1202

- datetime.datetime

1203

.utcnow())

1204

if time_to_die <= 0:

1205

# The timeout has passed

1206

self.disable()

1207

else:

1208

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

1209

+ datetime.timedelta(milliseconds =

1210

time_to_die))

1211

self.disable_initiator_tag = (gobject.timeout_add

1212

(time_to_die, self.disable))

1569

# Reschedule disabling

1570

if self.enabled:

1571

now = datetime.datetime.utcnow()

1572

self.expires += self.timeout - old_timeout

1573

if self.expires <= now:

1574

# The timeout has passed

1575

self.disable()

1576

else:

1577

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

1578

is None):

1579

return

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

int((self.expires - now).total_seconds()

1584

* 1000), self.disable))

1213

1585

1214

1586

# ExtendedTimeout - property

1215

1587

@dbus_service_property(_interface, signature="t",

1216

1588

access="readwrite")

1217

1589

def ExtendedTimeout_dbus_property(self, value=None):

1218

1590

if value is None: # get

1219

return dbus.UInt64(self.extended_timeout_milliseconds())

1591

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

1592

* 1000)

1220

1593

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

1221

1594

1222

1595

# Interval - property

1224

1597

access="readwrite")

1225

1598

def Interval_dbus_property(self, value=None):

1226

1599

if value is None: # get

1227

return dbus.UInt64(self.interval_milliseconds())

1600

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

1228

1601

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

1229

1602

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

1230

1603

return

1231

# Reschedule checker run

1232

gobject.source_remove(self.checker_initiator_tag)

1233

self.checker_initiator_tag = (gobject.timeout_add

1234

(value, self.start_checker))

1235

self.start_checker() # Start one now, too

1604

if self.enabled:

1605

# Reschedule checker run

1606

gobject.source_remove(self.checker_initiator_tag)

1607

self.checker_initiator_tag = (gobject.timeout_add

1608

(value, self.start_checker))

1609

self.start_checker() # Start one now, too

1236

1610

1237

1611

# Checker - property

1238

1612

@dbus_service_property(_interface, signature="s",

1240

1614

def Checker_dbus_property(self, value=None):

1241

1615

if value is None: # get

1242

1616

return dbus.String(self.checker_command)

1243

self.checker_command = value

1617

self.checker_command = str(value)

1244

1618

1245

1619

# CheckerRunning - property

1246

1620

@dbus_service_property(_interface, signature="b",

1262

1636

@dbus_service_property(_interface, signature="ay",

1263

1637

access="write", byte_arrays=True)

1264

1638

def Secret_dbus_property(self, value):

1265

self.secret = str(value)

1639

self.secret = bytes(value)

1266

1640

1267

1641

del _interface

1268

1642

1275

1649

raise KeyError()

1276

1650

1277

1651

def __getattribute__(self, name):

1278

if(name == '_pipe'):

1652

if name == '_pipe':

1279

1653

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

1280

1654

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

1281

1655

data = self._pipe.recv()

1288

1662

return func

1289

1663

1290

1664

def __setattr__(self, name, value):

1291

if(name == '_pipe'):

1665

if name == '_pipe':

1292

1666

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

1293

1667

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

1294

1668

1295

class ClientDBusTransitional(ClientDBus):

1296

__metaclass__ = AlternateDBusNamesMetaclass

1297

1669

1298

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

1299

1671

"""A class to handle client connections.

1304

1676

def handle(self):

1305

1677

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

1306

1678

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

1307

unicode(self.client_address))

1679

str(self.client_address))

1308

1680

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

1309

1681

self.server.child_pipe.fileno())

1310

1682

1336

1708

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

1337

1709

try:

1338

1710

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

1339

raise RuntimeError

1711

raise RuntimeError(line)

1340

1712

except (ValueError, IndexError, RuntimeError) as error:

1341

1713

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

1342

1714

return

1382

1754

client.Rejected("Disabled")

1383

1755

return

1384

1756

1385

if client._approved or not client.approval_delay:

1757

if client.approved or not client.approval_delay:

1386

1758

#We are approved or approval is disabled

1387

1759

break

1388

elif client._approved is None:

1760

elif client.approved is None:

1389

1761

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

1390

1762

client.name)

1391

1763

if self.server.use_dbus:

1392

1764

# Emit D-Bus signal

1393

1765

client.NeedApproval(

1394

client.approval_delay_milliseconds(),

1395

client.approved_by_default)

1766

client.approval_delay.total_seconds()

1767

* 1000, client.approved_by_default)

1396

1768

else:

1397

1769

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

1398

1770

client.name)

1404

1776

#wait until timeout or approved

1405

1777

time = datetime.datetime.now()

1406

1778

client.changedstate.acquire()

1407

(client.changedstate.wait

1408

(float(client._timedelta_to_milliseconds(delay)

1409

/ 1000)))

1779

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

1410

1780

client.changedstate.release()

1411

1781

time2 = datetime.datetime.now()

1412

1782

if (time2 - time) >= delay:

1428

1798

try:

1429

1799

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

1430

1800

except gnutls.errors.GNUTLSError as error:

1431

logger.warning("gnutls send failed")

1801

logger.warning("gnutls send failed",

1802

exc_info=error)

1432

1803

return

1433

1804

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

1434

1805

sent, len(client.secret)

1437

1808

1438

1809

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

1439

1810

# bump the timeout using extended_timeout

1440

client.checked_ok(client.extended_timeout)

1811

client.bump_timeout(client.extended_timeout)

1441

1812

if self.server.use_dbus:

1442

1813

# Emit D-Bus signal

1443

1814

client.GotSecret()

1448

1819

try:

1449

1820

session.bye()

1450

1821

except gnutls.errors.GNUTLSError as error:

1451

logger.warning("GnuTLS bye failed")

1822

logger.warning("GnuTLS bye failed",

1823

exc_info=error)

1452

1824

1453

1825

@staticmethod

1454

1826

def peer_certificate(session):

1510

1882

# Convert the buffer to a Python bytestring

1511

1883

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

1512

1884

# Convert the bytestring to hexadecimal notation

1513

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

1885

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

1514

1886

return hex_fpr

1515

1887

1516

1888

1519

1891

def sub_process_main(self, request, address):

1520

1892

try:

1521

1893

self.finish_request(request, address)

1522

except:

1894

except Exception:

1523

1895

self.handle_error(request, address)

1524

1896

self.close_request(request)

1525

1897

1526

1898

def process_request(self, request, address):

1527

1899

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

1528

1900

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

1529

args = (request,

1530

address))

1901

args = (request, address))

1531

1902

proc.start()

1532

1903

return proc

1533

1904

1548

1919

1549

1920

def add_pipe(self, parent_pipe, proc):

1550

1921

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

1551

raise NotImplementedError

1922

raise NotImplementedError()

1552

1923

1553

1924

1554

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1561

1932

use_ipv6: Boolean; to use IPv6 or not

1562

1933

"""

1563

1934

def __init__(self, server_address, RequestHandlerClass,

1564

interface=None, use_ipv6=True):

1935

interface=None, use_ipv6=True, socketfd=None):

1936

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

1937

creating a new one with socket.socket().

1938

"""

1565

1939

self.interface = interface

1566

1940

if use_ipv6:

1567

1941

self.address_family = socket.AF_INET6

1942

if socketfd is not None:

1943

# Save the file descriptor

1944

self.socketfd = socketfd

1945

# Save the original socket.socket() function

1946

self.socket_socket = socket.socket

1947

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

1948

#

1949

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

1950

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

1951

# patching socket.socket.)

1952

#

1953

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

1954

@functools.wraps(socket.socket)

1955

def socket_wrapper(*args, **kwargs):

1956

# Restore original function so subsequent calls are

1957

# not affected.

1958

socket.socket = self.socket_socket

1959

del self.socket_socket

1960

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

1961

# saved file descriptor.

1962

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

1963

# Replace socket.socket() function with wrapper

1964

socket.socket = socket_wrapper

1965

# The socketserver.TCPServer.__init__ will call

1966

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

1967

# socket_wrapper(), if socketfd was set.

1568

1968

socketserver.TCPServer.__init__(self, server_address,

1569

1969

RequestHandlerClass)

1970

1570

1971

def server_bind(self):

1571

1972

"""This overrides the normal server_bind() function

1572

1973

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

1580

1981

try:

1581

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1582

1983

SO_BINDTODEVICE,

1583

str(self.interface

1584

+ '\0'))

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1585

1986

except socket.error as error:

1586

if error[0] == errno.EPERM:

1587

logger.error("No permission to"

1588

" bind to interface %s",

1589

self.interface)

1590

elif error[0] == errno.ENOPROTOOPT:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1591

1991

logger.error("SO_BINDTODEVICE not available;"

1592

1992

" cannot bind to interface %s",

1593

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1594

1997

else:

1595

1998

raise

1596

1999

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

1599

2002

if self.address_family == socket.AF_INET6:

1600

2003

any_address = "::" # in6addr_any

1601

2004

else:

1602

any_address = socket.INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

1603

2006

self.server_address = (any_address,

1604

2007

self.server_address[1])

1605

2008

elif not self.server_address[1]:

1626

2029

"""

1627

2030

def __init__(self, server_address, RequestHandlerClass,

1628

2031

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

1629

gnutls_priority=None, use_dbus=True):

2032

gnutls_priority=None, use_dbus=True, socketfd=None):

1630

2033

self.enabled = False

1631

2034

self.clients = clients

1632

2035

if self.clients is None:

1633

self.clients = set()

2036

self.clients = {}

1634

2037

self.use_dbus = use_dbus

1635

2038

self.gnutls_priority = gnutls_priority

1636

2039

IPv6_TCPServer.__init__(self, server_address,

1637

2040

RequestHandlerClass,

1638

2041

interface = interface,

1639

use_ipv6 = use_ipv6)

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

1640

2044

def server_activate(self):

1641

2045

if self.enabled:

1642

2046

return socketserver.TCPServer.server_activate(self)

1655

2059

1656

2060

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

1657

2061

proc = None, client_object=None):

1658

condition_names = {

1659

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

1660

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

1661

# blocking).

1662

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

1663

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

1664

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

1665

# broken, usually for pipes and

1666

# sockets).

1667

}

1668

conditions_string = ' | '.join(name

1669

for cond, name in

1670

condition_names.iteritems()

1671

if cond & condition)

1672

2062

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

1673

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

2063

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

1674

2064

# Wait for other process to exit

1675

2065

proc.join()

1676

2066

return False

1683

2073

fpr = request[1]

1684

2074

address = request[2]

1685

2075

1686

for c in self.clients:

2076

for c in self.clients.itervalues():

1687

2077

if c.fingerprint == fpr:

1688

2078

client = c

1689

2079

break

1734

2124

return True

1735

2125

1736

2126

2127

def rfc3339_duration_to_delta(duration):

2128

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

2129

2130

>>> rfc3339_duration_to_delta("P7D")

2131

datetime.timedelta(7)

2132

>>> rfc3339_duration_to_delta("PT60S")

2133

datetime.timedelta(0, 60)

2134

>>> rfc3339_duration_to_delta("PT60M")

2135

datetime.timedelta(0, 3600)

2136

>>> rfc3339_duration_to_delta("PT24H")

2137

datetime.timedelta(1)

2138

>>> rfc3339_duration_to_delta("P1W")

2139

datetime.timedelta(7)

2140

>>> rfc3339_duration_to_delta("PT5M30S")

2141

datetime.timedelta(0, 330)

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

datetime.timedelta(1, 200)

2144

"""

2145

2146

# Parsing an RFC 3339 duration with regular expressions is not

2147

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

2148

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

2149

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

2150

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

2151

# avoid excessive use of external libraries.

2152

2153

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

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2163

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

2164

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

2165

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

2166

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

2167

datetime.timedelta(seconds=1),

2168

frozenset((token_end,)))

2169

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

2170

datetime.timedelta(minutes=1),

2171

frozenset((token_second, token_end)))

2172

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

2173

datetime.timedelta(hours=1),

2174

frozenset((token_minute, token_end)))

2175

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

2176

None,

2177

frozenset((token_hour, token_minute,

2178

token_second)))

2179

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

2180

datetime.timedelta(days=1),

2181

frozenset((token_time, token_end)))

2182

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

2183

datetime.timedelta(weeks=4),

2184

frozenset((token_day, token_end)))

2185

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

2186

datetime.timedelta(weeks=52),

2187

frozenset((token_month, token_end)))

2188

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

2189

datetime.timedelta(weeks=1),

2190

frozenset((token_end,)))

2191

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

2192

frozenset((token_year, token_month,

2193

token_day, token_time,

2194

token_week)))

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2197

found_token = None

2198

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

2199

s = duration # String left to parse

2200

# Loop until end token is found

2201

while found_token is not token_end:

2202

# Search for any currently valid tokens

2203

for token in followers:

2204

match = token.regexp.match(s)

2205

if match is not None:

2206

# Token found

2207

if token.value is not None:

2208

# Value found, parse digits

2209

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

2210

# Add to value so far

2211

value += factor * token.value

2212

# Strip token from string

2213

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

2214

# Go to found token

2215

found_token = token

2216

# Set valid next tokens

2217

followers = found_token.followers

2218

break

2219

else:

2220

# No currently valid tokens were found

2221

raise ValueError("Invalid RFC 3339 duration")

2222

# End token found

2223

return value

2224

2225

1737

2226

def string_to_delta(interval):

1738

2227

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

1739

2228

1750

2239

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

1751

2240

datetime.timedelta(0, 330)

1752

2241

"""

2242

2243

try:

2244

return rfc3339_duration_to_delta(interval)

2245

except ValueError:

2246

pass

2247

1753

2248

timevalue = datetime.timedelta(0)

1754

2249

for s in interval.split():

1755

2250

try:

1756

suffix = unicode(s[-1])

2251

suffix = s[-1]

1757

2252

value = int(s[:-1])

1758

2253

if suffix == "d":

1759

2254

delta = datetime.timedelta(value)

1766

2261

elif suffix == "w":

1767

2262

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

1768

2263

else:

1769

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

1770

except (ValueError, IndexError) as e:

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2266

except IndexError as e:

1771

2267

raise ValueError(*(e.args))

1772

2268

timevalue += delta

1773

2269

return timevalue

1774

2270

1775

2271

1776

def if_nametoindex(interface):

1777

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

1778

1779

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

1780

global if_nametoindex

1781

try:

1782

if_nametoindex = (ctypes.cdll.LoadLibrary

1783

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

1784

.if_nametoindex)

1785

except (OSError, AttributeError):

1786

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

1787

def if_nametoindex(interface):

1788

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

1789

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

1790

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

1791

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1792

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

1793

interface))

1794

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

1795

ifreq[16:20])[0]

1796

return interface_index

1797

return if_nametoindex(interface)

1798

1799

1800

2272

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

1801

2273

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

1802

2274

1810

2282

sys.exit()

1811

2283

if not noclose:

1812

2284

# Close all standard open file descriptors

1813

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

2285

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

1814

2286

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

1815

raise OSError(errno.ENODEV,

1816

"%s not a character device"

1817

% os.path.devnull)

2287

raise OSError(errno.ENODEV, "{} not a character device"

2288

.format(os.devnull))

1818

2289

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

1819

2290

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

1820

2291

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

1829

2300

1830

2301

parser = argparse.ArgumentParser()

1831

2302

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

1832

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

2303

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

1833

2304

help="show version number and exit")

1834

2305

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

1835

2306

help="Bind to interface IF")

1841

2312

help="Run self-test")

1842

2313

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

1843

2314

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

1844

" to terminal")

2315

" to terminal", default=None)

1845

2316

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

1846

2317

help="Debug level for stdout output")

1847

2318

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

1854

2325

" files")

1855

2326

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

1856

2327

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

1857

" system bus interface")

2328

" system bus interface", default=None)

1858

2329

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

1859

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

2330

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

2331

default=None)

2332

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

2333

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

2334

" state", default=None)

2335

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

2336

help="Specify a file descriptor to a network"

2337

" socket to use instead of creating one")

2338

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

2339

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

2340

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

2341

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

2342

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

2343

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

2344

default=None)

2345

1860

2346

options = parser.parse_args()

1861

2347

1862

2348

if options.check:

1863

2349

import doctest

1864

doctest.testmod()

1865

sys.exit()

2350

fail_count, test_count = doctest.testmod()

2351

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

1866

2352

1867

2353

# Default values for config file for server-global settings

1868

2354

server_defaults = { "interface": "",

1870

2356

"port": "",

1871

2357

"debug": "False",

1872

2358

"priority":

1873

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

2359

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

2360

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

1874

2361

"servicename": "Mandos",

1875

2362

"use_dbus": "True",

1876

2363

"use_ipv6": "True",

1877

2364

"debuglevel": "",

2365

"restore": "True",

2366

"socket": "",

2367

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

2368

"foreground": "False",

2369

"zeroconf": "True",

1878

2370

}

1879

2371

1880

2372

# Parse config file for server-global settings

1885

2377

# Convert the SafeConfigParser object to a dict

1886

2378

server_settings = server_config.defaults()

1887

2379

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

1888

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

2380

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

1889

2381

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

1890

2382

option)

1891

2383

if server_settings["port"]:

1892

2384

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

1893

2385

"port")

2386

if server_settings["socket"]:

2387

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

2388

"socket")

2389

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

2390

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

2391

# happen with a supplied network socket.

2392

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

2393

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

2394

["socket"])

1894

2395

del server_config

1895

2396

1896

2397

# Override the settings from the config file with command line

1897

2398

# options, if set.

1898

2399

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

1899

2400

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

1900

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

2401

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

2402

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

1901

2403

value = getattr(options, option)

1902

2404

if value is not None:

1903

2405

server_settings[option] = value

1904

2406

del options

1905

2407

# Force all strings to be unicode

1906

2408

for option in server_settings.keys():

1907

if type(server_settings[option]) is str:

1908

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

2409

if isinstance(server_settings[option], bytes):

2410

server_settings[option] = (server_settings[option]

2411

.decode("utf-8"))

2412

# Force all boolean options to be boolean

2413

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

2414

"foreground", "zeroconf"):

2415

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

2416

# Debug implies foreground

2417

if server_settings["debug"]:

2418

server_settings["foreground"] = True

1909

2419

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

1910

2420

1911

2421

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

1912

2422

2423

if (not server_settings["zeroconf"] and

2424

not (server_settings["port"]

2425

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

2426

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

2427

" Zeroconf")

2428

1913

2429

# For convenience

1914

2430

debug = server_settings["debug"]

1915

2431

debuglevel = server_settings["debuglevel"]

1916

2432

use_dbus = server_settings["use_dbus"]

1917

2433

use_ipv6 = server_settings["use_ipv6"]

2434

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

2435

stored_state_file)

2436

foreground = server_settings["foreground"]

2437

zeroconf = server_settings["zeroconf"]

2438

2439

if debug:

2440

initlogger(debug, logging.DEBUG)

2441

else:

2442

if not debuglevel:

2443

initlogger(debug)

2444

else:

2445

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

2446

initlogger(debug, level)

1918

2447

1919

2448

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

1920

2449

syslogger.setFormatter(logging.Formatter

1921

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

1922

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

1923

% server_settings["servicename"]))

2450

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

2451

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

2452

.format(server_settings

2453

["servicename"])))

1924

2454

1925

2455

# Parse config file with clients

1926

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

1927

"extended_timeout": "15m",

1928

"interval": "2m",

1929

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

1930

"host": "",

1931

"approval_delay": "0s",

1932

"approval_duration": "1s",

1933

}

1934

client_config = configparser.SafeConfigParser(client_defaults)

2456

client_config = configparser.SafeConfigParser(Client

2457

.client_defaults)

1935

2458

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

1936

2459

"clients.conf"))

1937

2460

1938

2461

global mandos_dbus_service

1939

2462

mandos_dbus_service = None

1940

2463

2464

socketfd = None

2465

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

2466

socketfd = server_settings["socket"]

1941

2467

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

1942

2468

server_settings["port"]),

1943

2469

ClientHandler,

1946

2472

use_ipv6=use_ipv6,

1947

2473

gnutls_priority=

1948

2474

server_settings["priority"],

1949

use_dbus=use_dbus)

1950

if not debug:

1951

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

2475

use_dbus=use_dbus,

2476

socketfd=socketfd)

2477

if not foreground:

2478

pidfilename = "/run/mandos.pid"

2479

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

2480

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

2481

pidfile = None

1952

2482

try:

1953

2483

pidfile = open(pidfilename, "w")

1954

except IOError:

1955

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

2484

except IOError as e:

2485

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

2486

exc_info=e)

1956

2487

1957

try:

1958

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

1959

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

1960

except KeyError:

2488

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

1961

2489

try:

1962

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

1963

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

2490

uid = pwd.getpwnam(name).pw_uid

2491

gid = pwd.getpwnam(name).pw_gid

2492

break

1964

2493

except KeyError:

1965

try:

1966

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

1967

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

1968

except KeyError:

1969

uid = 65534

1970

gid = 65534

2494

continue

2495

else:

2496

uid = 65534

2497

gid = 65534

1971

2498

try:

1972

2499

os.setgid(gid)

1973

2500

os.setuid(uid)

1974

2501

except OSError as error:

1975

if error[0] != errno.EPERM:

1976

raise error

1977

1978

if not debug and not debuglevel:

1979

logger.setLevel(logging.WARNING)

1980

if debuglevel:

1981

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

1982

logger.setLevel(level)

2502

if error.errno != errno.EPERM:

2503

raise

1983

2504

1984

2505

if debug:

1985

logger.setLevel(logging.DEBUG)

1986

2506

# Enable all possible GnuTLS debugging

1987

2507

1988

2508

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

1997

2517

.gnutls_global_set_log_function(debug_gnutls))

1998

2518

1999

2519

# Redirect stdin so all checkers get /dev/null

2000

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

2520

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

2001

2521

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

2002

2522

if null > 2:

2003

2523

os.close(null)

2004

else:

2005

# No console logging

2006

logger.removeHandler(console)

2007

2524

2008

2525

# Need to fork before connecting to D-Bus

2009

if not debug:

2526

if not foreground:

2010

2527

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

2011

2528

daemon()

2012

2529

2530

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

2531

# need to inform gobject that threads will be used.

2532

gobject.threads_init()

2533

2013

2534

global main_loop

2014

2535

# From the Avahi example code

2015

DBusGMainLoop(set_as_default=True )

2536

DBusGMainLoop(set_as_default=True)

2016

2537

main_loop = gobject.MainLoop()

2017

2538

bus = dbus.SystemBus()

2018

2539

# End of Avahi example code

2024

2545

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

2025

2546

do_not_queue=True))

2026

2547

except dbus.exceptions.NameExistsException as e:

2027

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

2548

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

2028

2549

use_dbus = False

2029

2550

server_settings["use_dbus"] = False

2030

2551

tcp_server.use_dbus = False

2031

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2032

service = AvahiServiceToSyslog(name =

2033

server_settings["servicename"],

2034

servicetype = "_mandos._tcp",

2035

protocol = protocol, bus = bus)

2036

if server_settings["interface"]:

2037

service.interface = (if_nametoindex

2038

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

2552

if zeroconf:

2553

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2554

service = AvahiServiceToSyslog(name =

2555

server_settings["servicename"],

2556

servicetype = "_mandos._tcp",

2557

protocol = protocol, bus = bus)

2558

if server_settings["interface"]:

2559

service.interface = (if_nametoindex

2560

(server_settings["interface"]

2561

.encode("utf-8")))

2039

2562

2040

2563

global multiprocessing_manager

2041

2564

multiprocessing_manager = multiprocessing.Manager()

2042

2565

2043

2566

client_class = Client

2044

2567

if use_dbus:

2045

client_class = functools.partial(ClientDBusTransitional,

2046

bus = bus)

2047

def client_config_items(config, section):

2048

special_settings = {

2049

"approved_by_default":

2050

lambda: config.getboolean(section,

2051

"approved_by_default"),

2052

}

2053

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

2568

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

2569

2570

client_settings = Client.config_parser(client_config)

2571

old_client_settings = {}

2572

clients_data = {}

2573

2574

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

2575

global wnull

2576

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

2577

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

2578

# mode

2579

if debug or not foreground:

2580

wnull.close()

2581

2582

# Get client data and settings from last running state.

2583

if server_settings["restore"]:

2584

try:

2585

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

2586

clients_data, old_client_settings = (pickle.load

2587

(stored_state))

2588

os.remove(stored_state_path)

2589

except IOError as e:

2590

if e.errno == errno.ENOENT:

2591

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

2592

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

2593

else:

2594

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

2595

exc_info=e)

2596

raise

2597

except EOFError as e:

2598

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

2599

"EOFError:", exc_info=e)

2600

2601

with PGPEngine() as pgp:

2602

for client_name, client in clients_data.items():

2603

# Skip removed clients

2604

if client_name not in client_settings:

2605

continue

2606

2607

# Decide which value to use after restoring saved state.

2608

# We have three different values: Old config file,

2609

# new config file, and saved state.

2610

# New config value takes precedence if it differs from old

2611

# config value, otherwise use saved state.

2612

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

2613

try:

2614

# For each value in new config, check if it

2615

# differs from the old config value (Except for

2616

# the "secret" attribute)

2617

if (name != "secret" and

2618

value != old_client_settings[client_name]

2619

[name]):

2620

client[name] = value

2621

except KeyError:

2622

pass

2623

2624

# Clients who has passed its expire date can still be

2625

# enabled if its last checker was successful. Clients

2626

# whose checker succeeded before we stored its state is

2627

# assumed to have successfully run all checkers during

2628

# downtime.

2629

if client["enabled"]:

2630

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

2631

if not client["last_checked_ok"]:

2632

logger.warning(

2633

"disabling client {} - Client never "

2634

"performed a successful checker"

2635

.format(client_name))

2636

client["enabled"] = False

2637

elif client["last_checker_status"] != 0:

2638

logger.warning(

2639

"disabling client {} - Client last"

2640

" checker failed with error code {}"

2641

.format(client_name,

2642

client["last_checker_status"]))

2643

client["enabled"] = False

2644

else:

2645

client["expires"] = (datetime.datetime

2646

.utcnow()

2647

+ client["timeout"])

2648

logger.debug("Last checker succeeded,"

2649

" keeping {} enabled"

2650

.format(client_name))

2054

2651

try:

2055

yield (name, special_settings[name]())

2056

except KeyError:

2057

yield (name, value)

2058

2059

tcp_server.clients.update(set(

2060

client_class(name = section,

2061

config= dict(client_config_items(

2062

client_config, section)))

2063

for section in client_config.sections()))

2652

client["secret"] = (

2653

pgp.decrypt(client["encrypted_secret"],

2654

client_settings[client_name]

2655

["secret"]))

2656

except PGPError:

2657

# If decryption fails, we use secret from new settings

2658

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

2659

.format(client_name))

2660

client["secret"] = (

2661

client_settings[client_name]["secret"])

2662

2663

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

2664

for client_name in (set(old_client_settings)

2665

- set(client_settings)):

2666

del clients_data[client_name]

2667

for client_name in (set(client_settings)

2668

- set(old_client_settings)):

2669

clients_data[client_name] = client_settings[client_name]

2670

2671

# Create all client objects

2672

for client_name, client in clients_data.items():

2673

tcp_server.clients[client_name] = client_class(

2674

name = client_name, settings = client,

2675

server_settings = server_settings)

2676

2064

2677

if not tcp_server.clients:

2065

2678

logger.warning("No clients defined")

2066

2067

if not debug:

2068

try:

2069

with pidfile:

2070

pid = os.getpid()

2071

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

2072

del pidfile

2073

except IOError:

2074

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

2075

pidfilename, pid)

2076

except NameError:

2077

# "pidfile" was never created

2078

pass

2679

2680

if not foreground:

2681

if pidfile is not None:

2682

try:

2683

with pidfile:

2684

pid = os.getpid()

2685

pidfile.write("{}\n".format(pid).encode("utf-8"))

2686

except IOError:

2687

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

2688

pidfilename, pid)

2689

del pidfile

2079

2690

del pidfilename

2080

2081

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

2082

2691

2083

2692

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

2084

2693

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

2085

2694

2086

2695

if use_dbus:

2087

class MandosDBusService(dbus.service.Object):

2696

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

2697

"se.bsnet.fukt.Mandos"})

2698

class MandosDBusService(DBusObjectWithProperties):

2088

2699

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

2089

2700

def __init__(self):

2090

2701

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

2091

2702

_interface = "se.recompile.Mandos"

2092

2703

2704

@dbus_interface_annotations(_interface)

2705

def _foo(self):

2706

return { "org.freedesktop.DBus.Property"

2707

".EmitsChangedSignal":

2708

"false"}

2709

2093

2710

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

2094

2711

def ClientAdded(self, objpath):

2095

2712

"D-Bus signal"

2109

2726

def GetAllClients(self):

2110

2727

"D-Bus method"

2111

2728

return dbus.Array(c.dbus_object_path

2112

for c in tcp_server.clients)

2729

for c in

2730

tcp_server.clients.itervalues())

2113

2731

2114

2732

@dbus.service.method(_interface,

2115

2733

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

2116

2734

def GetAllClientsWithProperties(self):

2117

2735

"D-Bus method"

2118

2736

return dbus.Dictionary(

2119

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

2120

for c in tcp_server.clients),

2737

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

2738

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

2121

2739

signature="oa{sv}")

2122

2740

2123

2741

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

2124

2742

def RemoveClient(self, object_path):

2125

2743

"D-Bus method"

2126

for c in tcp_server.clients:

2744

for c in tcp_server.clients.itervalues():

2127

2745

if c.dbus_object_path == object_path:

2128

tcp_server.clients.remove(c)

2746

del tcp_server.clients[c.name]

2129

2747

c.remove_from_connection()

2130

2748

# Don't signal anything except ClientRemoved

2131

2749

c.disable(quiet=True)

2136

2754

2137

2755

del _interface

2138

2756

2139

class MandosDBusServiceTransitional(MandosDBusService):

2140

__metaclass__ = AlternateDBusNamesMetaclass

2141

mandos_dbus_service = MandosDBusServiceTransitional()

2757

mandos_dbus_service = MandosDBusService()

2142

2758

2143

2759

def cleanup():

2144

2760

"Cleanup function; run on exit"

2145

service.cleanup()

2761

if zeroconf:

2762

service.cleanup()

2146

2763

2147

2764

multiprocessing.active_children()

2765

wnull.close()

2766

if not (tcp_server.clients or client_settings):

2767

return

2768

2769

# Store client before exiting. Secrets are encrypted with key

2770

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

2771

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

2772

clients = {}

2773

with PGPEngine() as pgp:

2774

for client in tcp_server.clients.itervalues():

2775

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

2776

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

2777

key)

2778

client_dict = {}

2779

2780

# A list of attributes that can not be pickled

2781

# + secret.

2782

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

2783

"checker", "server_settings" }

2784

for name, typ in (inspect.getmembers

2785

(dbus.service.Object)):

2786

exclude.add(name)

2787

2788

client_dict["encrypted_secret"] = (client

2789

.encrypted_secret)

2790

for attr in client.client_structure:

2791

if attr not in exclude:

2792

client_dict[attr] = getattr(client, attr)

2793

2794

clients[client.name] = client_dict

2795

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

2796

2797

try:

2798

with (tempfile.NamedTemporaryFile

2799

(mode='wb', suffix=".pickle", prefix='clients-',

2800

dir=os.path.dirname(stored_state_path),

2801

delete=False)) as stored_state:

2802

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

2803

tempname=stored_state.name

2804

os.rename(tempname, stored_state_path)

2805

except (IOError, OSError) as e:

2806

if not debug:

2807

try:

2808

os.remove(tempname)

2809

except NameError:

2810

pass

2811

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

2812

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

2813

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

2814

else:

2815

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

2816

exc_info=e)

2817

raise

2818

2819

# Delete all clients, and settings from config

2148

2820

while tcp_server.clients:

2149

client = tcp_server.clients.pop()

2821

name, client = tcp_server.clients.popitem()

2150

2822

if use_dbus:

2151

2823

client.remove_from_connection()

2152

client.disable_hook = None

2153

2824

# Don't signal anything except ClientRemoved

2154

2825

client.disable(quiet=True)

2155

2826

if use_dbus:

2157

2828

mandos_dbus_service.ClientRemoved(client

2158

2829

.dbus_object_path,

2159

2830

client.name)

2831

client_settings.clear()

2160

2832

2161

2833

atexit.register(cleanup)

2162

2834

2163

for client in tcp_server.clients:

2835

for client in tcp_server.clients.itervalues():

2164

2836

if use_dbus:

2165

2837

# Emit D-Bus signal

2166

2838

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2167

client.enable()

2839

# Need to initiate checking of clients

2840

if client.enabled:

2841

client.init_checker()

2168

2842

2169

2843

tcp_server.enable()

2170

2844

tcp_server.server_activate()

2171

2845

2172

2846

# Find out what port we got

2173

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

2847

if zeroconf:

2848

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

2174

2849

if use_ipv6:

2175

2850

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

2176

" flowinfo %d, scope_id %d"

2177

% tcp_server.socket.getsockname())

2851

" flowinfo %d, scope_id %d",

2852

*tcp_server.socket.getsockname())

2178

2853

else: # IPv4

2179

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

2180

% tcp_server.socket.getsockname())

2854

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

2855

*tcp_server.socket.getsockname())

2181

2856

2182

2857

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

2183

2858

2184

2859

try:

2185

# From the Avahi example code

2186

try:

2187

service.activate()

2188

except dbus.exceptions.DBusException as error:

2189

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

2190

cleanup()

2191

sys.exit(1)

2192

# End of Avahi example code

2860

if zeroconf:

2861

# From the Avahi example code

2862

try:

2863

service.activate()

2864

except dbus.exceptions.DBusException as error:

2865

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

2866

cleanup()

2867

sys.exit(1)

2868

# End of Avahi example code

2193

2869

2194

2870

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

2195

2871

lambda *args, **kwargs:

2199

2875

logger.debug("Starting main loop")

2200

2876

main_loop.run()

2201

2877

except AvahiError as error:

2202

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

2878

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

2203

2879

cleanup()

2204

2880

sys.exit(1)

2205

2881

except KeyboardInterrupt:

2210

2886

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

2211

2887

cleanup()

2212

2888

2213

2214

2889

if __name__ == '__main__':

2215

2890

main()