/mandos/trunk : revision 633

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

85

86

version = "1.4.1"

91

version = "1.6.1"

92

stored_state_file = "clients.pickle"

87

93

88

94

logger = logging.getLogger()

89

95

syslogger = (logging.handlers.SysLogHandler

90

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

97

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

99

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

103

except (OSError, AttributeError):

104

def if_nametoindex(interface):

105

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

106

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

107

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

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

113

return interface_index

114

115

116

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

117

"""init logger and add loglevel"""

118

119

syslogger.setFormatter(logging.Formatter

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

124

if debug:

125

console = logging.StreamHandler()

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

132

133

134

class PGPError(Exception):

135

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

136

pass

137

138

139

class PGPEngine(object):

140

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

141

def __init__(self):

142

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

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

149

def __enter__(self):

150

return self

151

152

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

153

self._cleanup()

154

return False

155

156

def __del__(self):

157

self._cleanup()

158

159

def _cleanup(self):

160

if self.tempdir is not None:

161

# Delete contents of tempdir

162

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

163

topdown = False):

164

for filename in files:

165

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

166

for dirname in dirs:

167

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

168

# Remove tempdir

169

os.rmdir(self.tempdir)

170

self.tempdir = None

171

172

def password_encode(self, password):

173

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

174

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

175

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

176

if len(encoded) > 2048:

177

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

178

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

179

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

180

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

181

return encoded

182

183

def encrypt(self, data, password):

184

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

187

passfile.write(passphrase)

188

passfile.flush()

189

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

190

'--passphrase-file',

191

passfile.name]

192

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

197

if proc.returncode != 0:

198

raise PGPError(err)

199

return ciphertext

200

201

def decrypt(self, data, password):

202

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

205

passfile.write(passphrase)

206

passfile.flush()

207

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

208

'--passphrase-file',

209

passfile.name]

210

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

216

if proc.returncode != 0:

217

raise PGPError(err)

218

return decrypted_plaintext

103

219

104

220

105

221

class AvahiError(Exception):

124

240

Used to optionally bind to the specified interface.

125

241

name: string; Example: 'Mandos'

126

242

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

127

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

243

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

128

244

port: integer; what port to announce

129

245

TXT: list of strings; TXT record for the service

130

246

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

136

252

server: D-Bus Server

137

253

bus: dbus.SystemBus()

138

254

"""

255

139

256

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

140

257

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

141

258

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

154

271

self.server = None

155

272

self.bus = bus

156

273

self.entry_group_state_changed_match = None

274

157

275

def rename(self):

158

276

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

159

277

if self.rename_count >= self.max_renames:

169

287

try:

170

288

self.add()

171

289

except dbus.exceptions.DBusException as error:

172

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

290

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

173

291

self.cleanup()

174

292

os._exit(1)

175

293

self.rename_count += 1

294

176

295

def remove(self):

177

296

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

178

297

if self.entry_group_state_changed_match is not None:

180

299

self.entry_group_state_changed_match = None

181

300

if self.group is not None:

182

301

self.group.Reset()

302

183

303

def add(self):

184

304

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

185

305

self.remove()

202

322

dbus.UInt16(self.port),

203

323

avahi.string_array_to_txt_array(self.TXT))

204

324

self.group.Commit()

325

205

326

def entry_group_state_changed(self, state, error):

206

327

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

207

328

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

214

335

elif state == avahi.ENTRY_GROUP_FAILURE:

215

336

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

216

337

unicode(error))

217

raise AvahiGroupError("State changed: %s"

218

% unicode(error))

338

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

339

.format(error))

340

219

341

def cleanup(self):

220

342

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

221

343

if self.group is not None:

222

344

try:

223

345

self.group.Free()

224

346

except (dbus.exceptions.UnknownMethodException,

225

dbus.exceptions.DBusException) as e:

347

dbus.exceptions.DBusException):

226

348

pass

227

349

self.group = None

228

350

self.remove()

351

229

352

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

230

353

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

231

354

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

250

373

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

251

374

else:

252

375

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

376

253

377

def activate(self):

254

378

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

255

379

if self.server is None:

262

386

self.server_state_changed)

263

387

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

264

388

389

265

390

class AvahiServiceToSyslog(AvahiService):

266

391

def rename(self):

267

392

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

268

393

ret = AvahiService.rename(self)

269

394

syslogger.setFormatter(logging.Formatter

270

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

271

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

272

% self.name))

395

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

396

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

397

.format(self.name)))

273

398

return ret

274

399

275

def _timedelta_to_milliseconds(td):

400

401

def timedelta_to_milliseconds(td):

276

402

"Convert a datetime.timedelta() to milliseconds"

277

403

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

278

404

+ (td.seconds * 1000)

279

405

+ (td.microseconds // 1000))

280

406

407

281

408

class Client(object):

282

409

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

283

410

284

411

Attributes:

285

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

412

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

286

413

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

287

414

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

288

415

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

295

422

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

296

423

checker_initiator_tag: a gobject event source tag, or None

297

424

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

425

client_structure: Object describing what attributes a client has

426

and is used for storing the client at exit

298

427

current_checker_command: string; current running checker_command

299

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

300

428

disable_initiator_tag: a gobject event source tag, or None

301

429

enabled: bool()

302

430

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

305

433

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

306

434

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

307

435

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

308

last_enabled: datetime.datetime(); (UTC)

436

last_checker_status: integer between 0 and 255 reflecting exit

437

status of last checker. -1 reflects crashed

438

checker, -2 means no checker completed yet.

439

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

309

440

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

310

441

D-Bus identifiers

311

442

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

312

443

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

313

444

until this client is disabled

314

extended_timeout: extra long timeout when password has been sent

445

extended_timeout: extra long timeout when secret has been sent

315

446

runtime_expansions: Allowed attributes for runtime expansion.

316

447

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

317

448

disabled, or None

449

server_settings: The server_settings dict from main()

318

450

"""

319

451

320

452

runtime_expansions = ("approval_delay", "approval_duration",

321

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

322

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

453

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

454

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

455

"last_approval_request", "last_checked_ok",

323

456

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

324

467

325

468

def timeout_milliseconds(self):

326

469

"Return the 'timeout' attribute in milliseconds"

327

return _timedelta_to_milliseconds(self.timeout)

470

return timedelta_to_milliseconds(self.timeout)

328

471

329

472

def extended_timeout_milliseconds(self):

330

473

"Return the 'extended_timeout' attribute in milliseconds"

331

return _timedelta_to_milliseconds(self.extended_timeout)

474

return timedelta_to_milliseconds(self.extended_timeout)

332

475

333

476

def interval_milliseconds(self):

334

477

"Return the 'interval' attribute in milliseconds"

335

return _timedelta_to_milliseconds(self.interval)

478

return timedelta_to_milliseconds(self.interval)

336

479

337

480

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."""

481

return timedelta_to_milliseconds(self.approval_delay)

482

483

@staticmethod

484

def config_parser(config):

485

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

486

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

487

with exceptions for any special settings as defined above.

488

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

489

value given the same arguments.

490

"""

491

settings = {}

492

for client_name in config.sections():

493

section = dict(config.items(client_name))

494

client = settings[client_name] = {}

495

496

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

497

# Reformat values from string types to Python types

498

client["approved_by_default"] = config.getboolean(

499

client_name, "approved_by_default")

500

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

501

"enabled")

502

503

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

504

.replace(" ", ""))

505

if "secret" in section:

506

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

507

elif "secfile" in section:

508

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

509

(section["secfile"])),

510

"rb") as secfile:

511

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

512

else:

513

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

514

.format(section))

515

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

516

client["extended_timeout"] = string_to_delta(

517

section["extended_timeout"])

518

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

519

client["approval_delay"] = string_to_delta(

520

section["approval_delay"])

521

client["approval_duration"] = string_to_delta(

522

section["approval_duration"])

523

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

524

client["last_approval_request"] = None

525

client["last_checked_ok"] = None

526

client["last_checker_status"] = -2

527

528

return settings

529

530

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

344

531

self.name = name

345

if config is None:

346

config = {}

532

if server_settings is None:

533

server_settings = {}

534

self.server_settings = server_settings

535

# adding all client settings

536

for setting, value in settings.iteritems():

537

setattr(self, setting, value)

538

539

if self.enabled:

540

if not hasattr(self, "last_enabled"):

541

self.last_enabled = datetime.datetime.utcnow()

542

if not hasattr(self, "expires"):

543

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

544

+ self.timeout)

545

else:

546

self.last_enabled = None

547

self.expires = None

548

347

549

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

348

550

# Uppercase and remove spaces from fingerprint for later

349

551

# comparison purposes with return value from the fingerprint()

350

552

# function

351

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

352

.replace(" ", ""))

353

553

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

554

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

555

datetime.datetime.utcnow())

556

557

# attributes specific for this server instance

375

558

self.checker = None

376

559

self.checker_initiator_tag = None

377

560

self.disable_initiator_tag = None

378

self.expires = None

379

561

self.checker_callback_tag = None

380

self.checker_command = config["checker"]

381

562

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)

563

self.approved = None

386

564

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

565

self.changedstate = (multiprocessing_manager

392

566

.Condition(multiprocessing_manager

393

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

570

if not attr.startswith("_")]

571

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

577

if not name.startswith("_"):

578

self.client_structure.append(name)

394

579

580

# Send notice to process children that client state has changed

395

581

def send_changedstate(self):

396

self.changedstate.acquire()

397

self.changedstate.notify_all()

398

self.changedstate.release()

582

with self.changedstate:

583

self.changedstate.notify_all()

399

584

400

585

def enable(self):

401

586

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

402

587

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

403

588

# Already enabled

404

589

return

590

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

591

self.enabled = True

592

self.last_enabled = datetime.datetime.utcnow()

593

self.init_checker()

405

594

self.send_changedstate()

595

596

def disable(self, quiet=True):

597

"""Disable this client."""

598

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

599

return False

600

if not quiet:

601

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

602

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

603

gobject.source_remove(self.disable_initiator_tag)

604

self.disable_initiator_tag = None

605

self.expires = None

606

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

607

gobject.source_remove(self.checker_initiator_tag)

608

self.checker_initiator_tag = None

609

self.stop_checker()

610

self.enabled = False

611

if not quiet:

612

self.send_changedstate()

613

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

614

return False

615

616

def __del__(self):

617

self.disable()

618

619

def init_checker(self):

406

620

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

407

621

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

408

624

self.checker_initiator_tag = (gobject.timeout_add

409

625

(self.interval_milliseconds(),

410

626

self.start_checker))

411

627

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

412

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

628

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

413

630

self.disable_initiator_tag = (gobject.timeout_add

414

631

(self.timeout_milliseconds(),

415

632

self.disable))

416

self.enabled = True

417

self.last_enabled = datetime.datetime.utcnow()

418

633

# Also start a new checker *right now*.

419

634

self.start_checker()

420

635

421

def disable(self, quiet=True):

422

"""Disable this client."""

423

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

424

return False

425

if not quiet:

426

self.send_changedstate()

427

if not quiet:

428

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

429

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

430

gobject.source_remove(self.disable_initiator_tag)

431

self.disable_initiator_tag = None

432

self.expires = None

433

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

434

gobject.source_remove(self.checker_initiator_tag)

435

self.checker_initiator_tag = None

436

self.stop_checker()

437

if self.disable_hook:

438

self.disable_hook(self)

439

self.enabled = False

440

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

441

return False

442

443

def __del__(self):

444

self.disable_hook = None

445

self.disable()

446

447

636

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

448

637

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

449

638

self.checker_callback_tag = None

450

639

self.checker = None

451

640

if os.WIFEXITED(condition):

452

exitstatus = os.WEXITSTATUS(condition)

453

if exitstatus == 0:

641

self.last_checker_status = os.WEXITSTATUS(condition)

642

if self.last_checker_status == 0:

454

643

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

455

644

vars(self))

456

645

self.checked_ok()

458

647

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

459

648

vars(self))

460

649

else:

650

self.last_checker_status = -1

461

651

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

462

652

vars(self))

463

653

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

"""

654

def checked_ok(self):

655

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

656

self.last_checked_ok = datetime.datetime.utcnow()

657

self.last_checker_status = 0

658

self.bump_timeout()

659

660

def bump_timeout(self, timeout=None):

661

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

470

662

if timeout is None:

471

663

timeout = self.timeout

472

self.last_checked_ok = datetime.datetime.utcnow()

473

664

if self.disable_initiator_tag is not None:

474

665

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

475

667

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

476

668

self.disable_initiator_tag = (gobject.timeout_add

477

(_timedelta_to_milliseconds

669

(timedelta_to_milliseconds

478

670

(timeout), self.disable))

479

671

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

480

672

487

679

If a checker already exists, leave it running and do

488

680

nothing."""

489

681

# 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

682

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

683

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

684

# would inevitably timeout, since no checker would get a

685

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

494

686

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

495

687

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

496

688

# should be.

510

702

self.current_checker_command)

511

703

# Start a new checker if needed

512

704

if self.checker is None:

705

# Escape attributes for the shell

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

513

710

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

711

command = self.checker_command % escaped_attrs

712

except TypeError as error:

713

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

714

self.checker_command, exc_info=error)

715

return True # Try again later

532

716

self.current_checker_command = command

533

717

try:

534

718

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

537

721

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

538

722

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

539

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

540

732

self.checker = subprocess.Popen(command,

541

733

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.

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

738

exc_info=error)

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

549

747

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

748

except OSError as error:

554

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

555

error)

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

556

758

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

557

759

return True

558

760

565

767

return

566

768

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

567

769

try:

568

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

770

self.checker.terminate()

569

771

#time.sleep(0.5)

570

772

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

571

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

773

# self.checker.kill()

572

774

except OSError as error:

573

775

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

574

776

raise

591

793

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

592

794

if byte_arrays and signature != "ay":

593

795

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

594

" signature %r" % signature)

796

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

595

797

def decorator(func):

596

798

func._dbus_is_property = True

597

799

func._dbus_interface = dbus_interface

605

807

return decorator

606

808

607

809

810

def dbus_interface_annotations(dbus_interface):

811

"""Decorator for marking functions returning interface annotations

812

813

Usage:

814

815

@dbus_interface_annotations("org.example.Interface")

816

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

817

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

818

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

819

"false"}

820

"""

821

def decorator(func):

822

func._dbus_is_interface = True

823

func._dbus_interface = dbus_interface

824

func._dbus_name = dbus_interface

825

return func

826

return decorator

827

828

829

def dbus_annotations(annotations):

830

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

831

Usage:

832

833

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

834

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

838

def Property_dbus_property(self):

839

return dbus.Boolean(False)

840

"""

841

def decorator(func):

842

func._dbus_annotations = annotations

843

return func

844

return decorator

845

846

608

847

class DBusPropertyException(dbus.exceptions.DBusException):

609

848

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

610

849

"""

633

872

"""

634

873

635

874

@staticmethod

636

def _is_dbus_property(obj):

637

return getattr(obj, "_dbus_is_property", False)

875

def _is_dbus_thing(thing):

876

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

877

878

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

879

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

880

"""

881

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

882

False)

638

883

639

def _get_all_dbus_properties(self):

884

def _get_all_dbus_things(self, thing):

640

885

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

641

886

"""

642

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

887

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

888

name),

889

athing.__get__(self))

643

890

for cls in self.__class__.__mro__

644

for name, prop in

645

inspect.getmembers(cls, self._is_dbus_property))

891

for name, athing in

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

646

894

647

895

def _get_dbus_property(self, interface_name, property_name):

648

896

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

650

898

"""

651

899

for cls in self.__class__.__mro__:

652

900

for name, value in (inspect.getmembers

653

(cls, self._is_dbus_property)):

901

(cls,

902

self._is_dbus_thing("property"))):

654

903

if (value._dbus_name == property_name

655

904

and value._dbus_interface == interface_name):

656

905

return value.__get__(self)

685

934

# signatures other than "ay".

686

935

if prop._dbus_signature != "ay":

687

936

raise ValueError

688

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

689

for byte in value))

937

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

938

for byte in value))

690

939

prop(value)

691

940

692

941

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

697

946

698

947

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

699

948

"""

700

all = {}

701

for name, prop in self._get_all_dbus_properties():

949

properties = {}

950

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

702

951

if (interface_name

703

952

and interface_name != prop._dbus_interface):

704

953

# Interface non-empty but did not match

708

957

continue

709

958

value = prop()

710

959

if not hasattr(value, "variant_level"):

711

all[name] = value

960

properties[name] = value

712

961

continue

713

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

714

value.variant_level+1)

715

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

962

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

963

value.variant_level+1)

964

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

716

965

717

966

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

718

967

out_signature="s",

719

968

path_keyword='object_path',

720

969

connection_keyword='connection')

721

970

def Introspect(self, object_path, connection):

722

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

971

"""Overloading of standard D-Bus method.

972

973

Inserts property tags and interface annotation tags.

723

974

"""

724

975

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

725

976

connection)

732

983

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

733

984

return e

734

985

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

986

# Add property tags

735

987

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

736

988

for name, prop

737

in self._get_all_dbus_properties()

989

in self._get_all_dbus_things("property")

738

990

if prop._dbus_interface

739

991

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

740

992

if_tag.appendChild(tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

if_tag.appendChild(ann_tag)

741

1024

# Add the names to the return values for the

742

1025

# "org.freedesktop.DBus.Properties" methods

743

1026

if (if_tag.getAttribute("name")

758

1041

except (AttributeError, xml.dom.DOMException,

759

1042

xml.parsers.expat.ExpatError) as error:

760

1043

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

761

error)

1044

exc_info=error)

762

1045

return xmlstring

763

1046

764

1047

765

def datetime_to_dbus (dt, variant_level=0):

1048

def datetime_to_dbus(dt, variant_level=0):

766

1049

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

767

1050

if dt is None:

768

1051

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

769

1052

return dbus.String(dt.isoformat(),

770

1053

variant_level=variant_level)

771

1054

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.

1055

1056

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1057

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

1058

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

1059

interface names according to the "alt_interface_names" mapping.

1060

Usage:

1061

1062

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

1063

"net.example.AlternateInterface"})

1064

class SampleDBusObject(dbus.service.Object):

1065

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

1066

def SampleDBusMethod():

1067

pass

1068

1069

The above "SampleDBusMethod" on "SampleDBusObject" will be

1070

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

1071

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

1072

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

1073

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

1074

1075

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

1076

(from DBusObjectWithProperties) and interfaces (from the

1077

dbus_interface_annotations decorator).

776

1078

"""

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

1079

def wrapper(cls):

1080

for orig_interface_name, alt_interface_name in (

1081

alt_interface_names.iteritems()):

1082

attr = {}

1083

interface_names = set()

1084

# Go though all attributes of the class

1085

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

784

1086

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

785

1087

# with the wrong interface name

786

1088

if (not hasattr(attribute, "_dbus_interface")

787

1089

or not attribute._dbus_interface

788

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

1090

.startswith(orig_interface_name)):

789

1091

continue

790

1092

# Create an alternate D-Bus interface name based on

791

1093

# the current name

792

1094

alt_interface = (attribute._dbus_interface

793

.replace("se.recompile.Mandos",

794

"se.bsnet.fukt.Mandos"))

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1097

interface_names.add(alt_interface)

795

1098

# Is this a D-Bus signal?

796

1099

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

797

# Extract the original non-method function by

798

# black magic

1100

# Extract the original non-method undecorated

1101

# function by black magic

799

1102

nonmethod_func = (dict(

800

1103

zip(attribute.func_code.co_freevars,

801

1104

attribute.__closure__))["func"]

812

1115

nonmethod_func.func_name,

813

1116

nonmethod_func.func_defaults,

814

1117

nonmethod_func.func_closure)))

1118

# Copy annotations, if any

1119

try:

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1122

except AttributeError:

1123

pass

815

1124

# 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

1125

# original and alternate functions, so both the

1126

# original and alternate signals gets sent when

1127

# the function is called

818

1128

def fixscope(func1, func2):

819

1129

"""This function is a scope container to pass

820

1130

func1 and func2 to the "call_both" function

827

1137

return call_both

828

1138

# Create the "call_both" function and add it to

829

1139

# the class

830

attr[attrname] = fixscope(attribute,

831

new_function)

1140

attr[attrname] = fixscope(attribute, new_function)

832

1141

# Is this a D-Bus method?

833

1142

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

834

1143

# Create a new, but exactly alike, function

845

1154

attribute.func_name,

846

1155

attribute.func_defaults,

847

1156

attribute.func_closure)))

1157

# Copy annotations, if any

1158

try:

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1161

except AttributeError:

1162

pass

848

1163

# Is this a D-Bus property?

849

1164

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

850

1165

# Create a new, but exactly alike, function

864

1179

attribute.func_name,

865

1180

attribute.func_defaults,

866

1181

attribute.func_closure)))

867

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

868

1182

# Copy annotations, if any

1183

try:

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1186

except AttributeError:

1187

pass

1188

# Is this a D-Bus interface?

1189

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

1190

# Create a new, but exactly alike, function

1191

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

1192

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

1193

# to the class.

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1202

if deprecate:

1203

# Deprecate all alternate interfaces

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1205

for interface_name in interface_names:

1206

@dbus_interface_annotations(interface_name)

1207

def func(self):

1208

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

1209

"true" }

1210

# Find an unused name

1211

for aname in (iname.format(i)

1212

for i in itertools.count()):

1213

if aname not in attr:

1214

attr[aname] = func

1215

break

1216

if interface_names:

1217

# Replace the class with a new subclass of it with

1218

# methods, signals, etc. as created above.

1219

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

1220

(cls,), attr)

1221

return cls

1222

return wrapper

1223

1224

1225

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

1226

"se.bsnet.fukt.Mandos"})

869

1227

class ClientDBus(Client, DBusObjectWithProperties):

870

1228

"""A Client class using D-Bus

871

1229

880

1238

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

881

1239

882

1240

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

883

self._approvals_pending = 0

884

1241

self.bus = bus

885

1242

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

886

1243

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

892

1249

("/clients/" + client_object_name))

893

1250

DBusObjectWithProperties.__init__(self, self.bus,

894

1251

self.dbus_object_path)

895

1252

896

1253

def notifychangeproperty(transform_func,

897

1254

dbus_name, type_func=lambda x: x,

898

1255

variant_level=1):

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

921

1278

922

1279

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

923

1280

924

925

1281

expires = notifychangeproperty(datetime_to_dbus, "Expires")

926

1282

approvals_pending = notifychangeproperty(dbus.Boolean,

927

1283

"ApprovalPending",

934

1290

checker is not None)

935

1291

last_checked_ok = notifychangeproperty(datetime_to_dbus,

936

1292

"LastCheckedOK")

1293

last_checker_status = notifychangeproperty(dbus.Int16,

1294

"LastCheckerStatus")

937

1295

last_approval_request = notifychangeproperty(

938

1296

datetime_to_dbus, "LastApprovalRequest")

939

1297

approved_by_default = notifychangeproperty(dbus.Boolean,

940

1298

"ApprovedByDefault")

941

approval_delay = notifychangeproperty(dbus.UInt16,

1299

approval_delay = notifychangeproperty(dbus.UInt64,

942

1300

"ApprovalDelay",

943

1301

type_func =

944

_timedelta_to_milliseconds)

1302

timedelta_to_milliseconds)

945

1303

approval_duration = notifychangeproperty(

946

dbus.UInt16, "ApprovalDuration",

947

type_func = _timedelta_to_milliseconds)

1304

dbus.UInt64, "ApprovalDuration",

1305

type_func = timedelta_to_milliseconds)

948

1306

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

949

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

1307

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

950

1308

type_func =

951

_timedelta_to_milliseconds)

1309

timedelta_to_milliseconds)

952

1310

extended_timeout = notifychangeproperty(

953

dbus.UInt16, "ExtendedTimeout",

954

type_func = _timedelta_to_milliseconds)

955

interval = notifychangeproperty(dbus.UInt16,

1311

dbus.UInt64, "ExtendedTimeout",

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

956

1314

"Interval",

957

1315

type_func =

958

_timedelta_to_milliseconds)

1316

timedelta_to_milliseconds)

959

1317

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

960

1318

961

1319

del notifychangeproperty

1003

1361

return r

1004

1362

1005

1363

def _reset_approved(self):

1006

self._approved = None

1364

self.approved = None

1007

1365

return False

1008

1366

1009

1367

def approve(self, value=True):

1010

self.send_changedstate()

1011

self._approved = value

1012

gobject.timeout_add(_timedelta_to_milliseconds

1368

self.approved = value

1369

gobject.timeout_add(timedelta_to_milliseconds

1013

1370

(self.approval_duration),

1014

1371

self._reset_approved)

1015

1372

self.send_changedstate()

1016

1373

1017

1374

## D-Bus methods, signals & properties

1018

1375

_interface = "se.recompile.Mandos.Client"

1019

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1020

1384

## Signals

1021

1385

1022

1386

# CheckerCompleted - signal

1121

1485

access="readwrite")

1122

1486

def ApprovalDuration_dbus_property(self, value=None):

1123

1487

if value is None: # get

1124

return dbus.UInt64(_timedelta_to_milliseconds(

1488

return dbus.UInt64(timedelta_to_milliseconds(

1125

1489

self.approval_duration))

1126

1490

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

1127

1491

1141

1505

def Host_dbus_property(self, value=None):

1142

1506

if value is None: # get

1143

1507

return dbus.String(self.host)

1144

self.host = value

1508

self.host = unicode(value)

1145

1509

1146

1510

# Created - property

1147

1511

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

1148

1512

def Created_dbus_property(self):

1149

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

1513

return datetime_to_dbus(self.created)

1150

1514

1151

1515

# LastEnabled - property

1152

1516

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

1173

1537

return

1174

1538

return datetime_to_dbus(self.last_checked_ok)

1175

1539

1540

# LastCheckerStatus - property

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

1543

def LastCheckerStatus_dbus_property(self):

1544

return dbus.Int16(self.last_checker_status)

1545

1176

1546

# Expires - property

1177

1547

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

1178

1548

def Expires_dbus_property(self):

1189

1559

def Timeout_dbus_property(self, value=None):

1190

1560

if value is None: # get

1191

1561

return dbus.UInt64(self.timeout_milliseconds())

1562

old_timeout = self.timeout

1192

1563

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

1564

# Reschedule disabling

1565

if self.enabled:

1566

now = datetime.datetime.utcnow()

1567

self.expires += self.timeout - old_timeout

1568

if self.expires <= now:

1569

# The timeout has passed

1570

self.disable()

1571

else:

1572

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

1573

is None):

1574

return

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1213

1580

1214

1581

# ExtendedTimeout - property

1215

1582

@dbus_service_property(_interface, signature="t",

1228

1595

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

1229

1596

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

1230

1597

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

1598

if self.enabled:

1599

# Reschedule checker run

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1236

1604

1237

1605

# Checker - property

1238

1606

@dbus_service_property(_interface, signature="s",

1240

1608

def Checker_dbus_property(self, value=None):

1241

1609

if value is None: # get

1242

1610

return dbus.String(self.checker_command)

1243

self.checker_command = value

1611

self.checker_command = unicode(value)

1244

1612

1245

1613

# CheckerRunning - property

1246

1614

@dbus_service_property(_interface, signature="b",

1275

1643

raise KeyError()

1276

1644

1277

1645

def __getattribute__(self, name):

1278

if(name == '_pipe'):

1646

if name == '_pipe':

1279

1647

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

1280

1648

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

1281

1649

data = self._pipe.recv()

1288

1656

return func

1289

1657

1290

1658

def __setattr__(self, name, value):

1291

if(name == '_pipe'):

1659

if name == '_pipe':

1292

1660

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

1293

1661

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

1294

1662

1295

class ClientDBusTransitional(ClientDBus):

1296

__metaclass__ = AlternateDBusNamesMetaclass

1297

1663

1298

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

1299

1665

"""A class to handle client connections.

1382

1748

client.Rejected("Disabled")

1383

1749

return

1384

1750

1385

if client._approved or not client.approval_delay:

1751

if client.approved or not client.approval_delay:

1386

1752

#We are approved or approval is disabled

1387

1753

break

1388

elif client._approved is None:

1754

elif client.approved is None:

1389

1755

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

1390

1756

client.name)

1391

1757

if self.server.use_dbus:

1404

1770

#wait until timeout or approved

1405

1771

time = datetime.datetime.now()

1406

1772

client.changedstate.acquire()

1407

(client.changedstate.wait

1408

(float(client._timedelta_to_milliseconds(delay)

1409

/ 1000)))

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

1410

1776

client.changedstate.release()

1411

1777

time2 = datetime.datetime.now()

1412

1778

if (time2 - time) >= delay:

1428

1794

try:

1429

1795

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

1430

1796

except gnutls.errors.GNUTLSError as error:

1431

logger.warning("gnutls send failed")

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1432

1799

return

1433

1800

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

1434

1801

sent, len(client.secret)

1437

1804

1438

1805

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

1439

1806

# bump the timeout using extended_timeout

1440

client.checked_ok(client.extended_timeout)

1807

client.bump_timeout(client.extended_timeout)

1441

1808

if self.server.use_dbus:

1442

1809

# Emit D-Bus signal

1443

1810

client.GotSecret()

1448

1815

try:

1449

1816

session.bye()

1450

1817

except gnutls.errors.GNUTLSError as error:

1451

logger.warning("GnuTLS bye failed")

1818

logger.warning("GnuTLS bye failed",

1819

exc_info=error)

1452

1820

1453

1821

@staticmethod

1454

1822

def peer_certificate(session):

1510

1878

# Convert the buffer to a Python bytestring

1511

1879

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

1512

1880

# Convert the bytestring to hexadecimal notation

1513

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

1881

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

1514

1882

return hex_fpr

1515

1883

1516

1884

1519

1887

def sub_process_main(self, request, address):

1520

1888

try:

1521

1889

self.finish_request(request, address)

1522

except:

1890

except Exception:

1523

1891

self.handle_error(request, address)

1524

1892

self.close_request(request)

1525

1893

1526

1894

def process_request(self, request, address):

1527

1895

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

1528

1896

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

1529

args = (request,

1530

address))

1897

args = (request, address))

1531

1898

proc.start()

1532

1899

return proc

1533

1900

1561

1928

use_ipv6: Boolean; to use IPv6 or not

1562

1929

"""

1563

1930

def __init__(self, server_address, RequestHandlerClass,

1564

interface=None, use_ipv6=True):

1931

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

1932

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

1933

creating a new one with socket.socket().

1934

"""

1565

1935

self.interface = interface

1566

1936

if use_ipv6:

1567

1937

self.address_family = socket.AF_INET6

1938

if socketfd is not None:

1939

# Save the file descriptor

1940

self.socketfd = socketfd

1941

# Save the original socket.socket() function

1942

self.socket_socket = socket.socket

1943

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

1944

#

1945

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

1946

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

1947

# patching socket.socket.)

1948

#

1949

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

1950

@functools.wraps(socket.socket)

1951

def socket_wrapper(*args, **kwargs):

1952

# Restore original function so subsequent calls are

1953

# not affected.

1954

socket.socket = self.socket_socket

1955

del self.socket_socket

1956

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

1957

# saved file descriptor.

1958

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

1959

# Replace socket.socket() function with wrapper

1960

socket.socket = socket_wrapper

1961

# The socketserver.TCPServer.__init__ will call

1962

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

1963

# socket_wrapper(), if socketfd was set.

1568

1964

socketserver.TCPServer.__init__(self, server_address,

1569

1965

RequestHandlerClass)

1966

1570

1967

def server_bind(self):

1571

1968

"""This overrides the normal server_bind() function

1572

1969

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

1580

1977

try:

1581

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1582

1979

SO_BINDTODEVICE,

1583

str(self.interface

1584

+ '\0'))

1980

str(self.interface + '\0'))

1585

1981

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:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1591

1986

logger.error("SO_BINDTODEVICE not available;"

1592

1987

" cannot bind to interface %s",

1593

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1594

1992

else:

1595

1993

raise

1596

1994

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

1599

1997

if self.address_family == socket.AF_INET6:

1600

1998

any_address = "::" # in6addr_any

1601

1999

else:

1602

any_address = socket.INADDR_ANY

2000

any_address = "0.0.0.0" # INADDR_ANY

1603

2001

self.server_address = (any_address,

1604

2002

self.server_address[1])

1605

2003

elif not self.server_address[1]:

1626

2024

"""

1627

2025

def __init__(self, server_address, RequestHandlerClass,

1628

2026

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

1629

gnutls_priority=None, use_dbus=True):

2027

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

1630

2028

self.enabled = False

1631

2029

self.clients = clients

1632

2030

if self.clients is None:

1633

self.clients = set()

2031

self.clients = {}

1634

2032

self.use_dbus = use_dbus

1635

2033

self.gnutls_priority = gnutls_priority

1636

2034

IPv6_TCPServer.__init__(self, server_address,

1637

2035

RequestHandlerClass,

1638

2036

interface = interface,

1639

use_ipv6 = use_ipv6)

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

1640

2039

def server_activate(self):

1641

2040

if self.enabled:

1642

2041

return socketserver.TCPServer.server_activate(self)

1655

2054

1656

2055

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

1657

2056

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

2057

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

1673

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

2058

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

1674

2059

# Wait for other process to exit

1675

2060

proc.join()

1676

2061

return False

1683

2068

fpr = request[1]

1684

2069

address = request[2]

1685

2070

1686

for c in self.clients:

2071

for c in self.clients.itervalues():

1687

2072

if c.fingerprint == fpr:

1688

2073

client = c

1689

2074

break

1734

2119

return True

1735

2120

1736

2121

2122

def rfc3339_duration_to_delta(duration):

2123

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

2124

2125

>>> rfc3339_duration_to_delta("P7D")

2126

datetime.timedelta(7)

2127

>>> rfc3339_duration_to_delta("PT60S")

2128

datetime.timedelta(0, 60)

2129

>>> rfc3339_duration_to_delta("PT60M")

2130

datetime.timedelta(0, 3600)

2131

>>> rfc3339_duration_to_delta("PT24H")

2132

datetime.timedelta(1)

2133

>>> rfc3339_duration_to_delta("P1W")

2134

datetime.timedelta(7)

2135

>>> rfc3339_duration_to_delta("PT5M30S")

2136

datetime.timedelta(0, 330)

2137

>>> rfc3339_duration_to_delta("P1DT3M20S")

2138

datetime.timedelta(1, 200)

2139

"""

2140

2141

# Parsing an RFC 3339 duration with regular expressions is not

2142

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

2143

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

2144

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

2145

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

2146

# avoid excessive use of external libraries.

2147

2148

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

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# this token

2158

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

2159

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

2160

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

2161

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

2162

datetime.timedelta(seconds=1),

2163

frozenset((token_end,)))

2164

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

2165

datetime.timedelta(minutes=1),

2166

frozenset((token_second, token_end)))

2167

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

2168

datetime.timedelta(hours=1),

2169

frozenset((token_minute, token_end)))

2170

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

2171

None,

2172

frozenset((token_hour, token_minute,

2173

token_second)))

2174

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

2175

datetime.timedelta(days=1),

2176

frozenset((token_time, token_end)))

2177

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

2178

datetime.timedelta(weeks=4),

2179

frozenset((token_day, token_end)))

2180

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

2181

datetime.timedelta(weeks=52),

2182

frozenset((token_month, token_end)))

2183

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

2184

datetime.timedelta(weeks=1),

2185

frozenset((token_end,)))

2186

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

2187

frozenset((token_year, token_month,

2188

token_day, token_time,

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2192

found_token = None

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2195

# Loop until end token is found

2196

while found_token is not token_end:

2197

# Search for any currently valid tokens

2198

for token in followers:

2199

match = token.regexp.match(s)

2200

if match is not None:

2201

# Token found

2202

if token.value is not None:

2203

# Value found, parse digits

2204

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

2205

# Add to value so far

2206

value += factor * token.value

2207

# Strip token from string

2208

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

2209

# Go to found token

2210

found_token = token

2211

# Set valid next tokens

2212

followers = found_token.followers

2213

break

2214

else:

2215

# No currently valid tokens were found

2216

raise ValueError("Invalid RFC 3339 duration")

2217

# End token found

2218

return value

2219

2220

1737

2221

def string_to_delta(interval):

1738

2222

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

1739

2223

1750

2234

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

1751

2235

datetime.timedelta(0, 330)

1752

2236

"""

2237

2238

try:

2239

return rfc3339_duration_to_delta(interval)

2240

except ValueError:

2241

pass

2242

1753

2243

timevalue = datetime.timedelta(0)

1754

2244

for s in interval.split():

1755

2245

try:

1766

2256

elif suffix == "w":

1767

2257

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

1768

2258

else:

1769

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

2259

raise ValueError("Unknown suffix {0!r}"

2260

.format(suffix))

1770

2261

except (ValueError, IndexError) as e:

1771

2262

raise ValueError(*(e.args))

1772

2263

timevalue += delta

1773

2264

return timevalue

1774

2265

1775

2266

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

2267

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

1801

2268

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

1802

2269

1810

2277

sys.exit()

1811

2278

if not noclose:

1812

2279

# Close all standard open file descriptors

1813

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

2280

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

1814

2281

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

1815

2282

raise OSError(errno.ENODEV,

1816

"%s not a character device"

1817

% os.path.devnull)

2283

"{0} not a character device"

2284

.format(os.devnull))

1818

2285

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

1819

2286

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

1820

2287

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

1829

2296

1830

2297

parser = argparse.ArgumentParser()

1831

2298

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

1832

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

2299

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

1833

2300

help="show version number and exit")

1834

2301

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

1835

2302

help="Bind to interface IF")

1841

2308

help="Run self-test")

1842

2309

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

1843

2310

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

1844

" to terminal")

2311

" to terminal", default=None)

1845

2312

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

1846

2313

help="Debug level for stdout output")

1847

2314

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

1854

2321

" files")

1855

2322

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

1856

2323

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

1857

" system bus interface")

2324

" system bus interface", default=None)

1858

2325

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

1859

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

2326

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

2327

default=None)

2328

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

2329

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

2330

" state", default=None)

2331

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

2332

help="Specify a file descriptor to a network"

2333

" socket to use instead of creating one")

2334

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

2335

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

2336

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

2337

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

2338

1860

2339

options = parser.parse_args()

1861

2340

1862

2341

if options.check:

1870

2349

"port": "",

1871

2350

"debug": "False",

1872

2351

"priority":

1873

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

2352

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

1874

2353

"servicename": "Mandos",

1875

2354

"use_dbus": "True",

1876

2355

"use_ipv6": "True",

1877

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

1878

2361

}

1879

2362

1880

2363

# Parse config file for server-global settings

1885

2368

# Convert the SafeConfigParser object to a dict

1886

2369

server_settings = server_config.defaults()

1887

2370

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

1888

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

2371

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

1889

2372

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

1890

2373

option)

1891

2374

if server_settings["port"]:

1892

2375

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

1893

2376

"port")

2377

if server_settings["socket"]:

2378

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

2379

"socket")

2380

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

2381

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

2382

# happen with a supplied network socket.

2383

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

2384

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

2385

["socket"])

1894

2386

del server_config

1895

2387

1896

2388

# Override the settings from the config file with command line

1897

2389

# options, if set.

1898

2390

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

1899

2391

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

1900

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

2392

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

2393

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

1901

2394

value = getattr(options, option)

1902

2395

if value is not None:

1903

2396

server_settings[option] = value

1906

2399

for option in server_settings.keys():

1907

2400

if type(server_settings[option]) is str:

1908

2401

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

2402

# Force all boolean options to be boolean

2403

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

2404

"foreground"):

2405

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

2406

# Debug implies foreground

2407

if server_settings["debug"]:

2408

server_settings["foreground"] = True

1909

2409

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

1910

2410

1911

2411

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

1915

2415

debuglevel = server_settings["debuglevel"]

1916

2416

use_dbus = server_settings["use_dbus"]

1917

2417

use_ipv6 = server_settings["use_ipv6"]

2418

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

2419

stored_state_file)

2420

foreground = server_settings["foreground"]

2421

2422

if debug:

2423

initlogger(debug, logging.DEBUG)

2424

else:

2425

if not debuglevel:

2426

initlogger(debug)

2427

else:

2428

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

2429

initlogger(debug, level)

1918

2430

1919

2431

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

1920

2432

syslogger.setFormatter(logging.Formatter

1921

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

1922

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

1923

% server_settings["servicename"]))

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

1924

2437

1925

2438

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

2439

client_config = configparser.SafeConfigParser(Client

2440

.client_defaults)

1935

2441

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

1936

2442

"clients.conf"))

1937

2443

1946

2452

use_ipv6=use_ipv6,

1947

2453

gnutls_priority=

1948

2454

server_settings["priority"],

1949

use_dbus=use_dbus)

1950

if not debug:

1951

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

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

or None))

2458

if not foreground:

2459

pidfilename = "/run/mandos.pid"

2460

pidfile = None

1952

2461

try:

1953

2462

pidfile = open(pidfilename, "w")

1954

except IOError:

1955

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

2463

except IOError as e:

2464

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

2465

exc_info=e)

1956

2466

1957

try:

1958

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

1959

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

1960

except KeyError:

2467

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

1961

2468

try:

1962

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

1963

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

2469

uid = pwd.getpwnam(name).pw_uid

2470

gid = pwd.getpwnam(name).pw_gid

2471

break

1964

2472

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

2473

continue

2474

else:

2475

uid = 65534

2476

gid = 65534

1971

2477

try:

1972

2478

os.setgid(gid)

1973

2479

os.setuid(uid)

1974

2480

except OSError as error:

1975

if error[0] != errno.EPERM:

2481

if error.errno != errno.EPERM:

1976

2482

raise error

1977

2483

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)

1983

1984

2484

if debug:

1985

logger.setLevel(logging.DEBUG)

1986

2485

# Enable all possible GnuTLS debugging

1987

2486

1988

2487

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

1997

2496

.gnutls_global_set_log_function(debug_gnutls))

1998

2497

1999

2498

# Redirect stdin so all checkers get /dev/null

2000

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

2499

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

2001

2500

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

2002

2501

if null > 2:

2003

2502

os.close(null)

2004

else:

2005

# No console logging

2006

logger.removeHandler(console)

2007

2503

2008

2504

# Need to fork before connecting to D-Bus

2009

if not debug:

2505

if not foreground:

2010

2506

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

2011

2507

daemon()

2012

2508

2509

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

2510

# need to inform gobject that threads will be used.

2511

gobject.threads_init()

2512

2013

2513

global main_loop

2014

2514

# From the Avahi example code

2015

DBusGMainLoop(set_as_default=True )

2515

DBusGMainLoop(set_as_default=True)

2016

2516

main_loop = gobject.MainLoop()

2017

2517

bus = dbus.SystemBus()

2018

2518

# End of Avahi example code

2024

2524

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

2025

2525

do_not_queue=True))

2026

2526

except dbus.exceptions.NameExistsException as e:

2027

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

2527

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

2028

2528

use_dbus = False

2029

2529

server_settings["use_dbus"] = False

2030

2530

tcp_server.use_dbus = False

2042

2542

2043

2543

client_class = Client

2044

2544

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

2545

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

2546

2547

client_settings = Client.config_parser(client_config)

2548

old_client_settings = {}

2549

clients_data = {}

2550

2551

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

2552

global wnull

2553

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

2554

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

2555

# mode

2556

if debug or not foreground:

2557

wnull.close()

2558

2559

# Get client data and settings from last running state.

2560

if server_settings["restore"]:

2561

try:

2562

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

2563

clients_data, old_client_settings = (pickle.load

2564

(stored_state))

2565

os.remove(stored_state_path)

2566

except IOError as e:

2567

if e.errno == errno.ENOENT:

2568

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

2569

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

2570

else:

2571

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

2572

exc_info=e)

2573

raise

2574

except EOFError as e:

2575

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

2576

"EOFError:", exc_info=e)

2577

2578

with PGPEngine() as pgp:

2579

for client_name, client in clients_data.iteritems():

2580

# Skip removed clients

2581

if client_name not in client_settings:

2582

continue

2583

2584

# Decide which value to use after restoring saved state.

2585

# We have three different values: Old config file,

2586

# new config file, and saved state.

2587

# New config value takes precedence if it differs from old

2588

# config value, otherwise use saved state.

2589

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

2590

try:

2591

# For each value in new config, check if it

2592

# differs from the old config value (Except for

2593

# the "secret" attribute)

2594

if (name != "secret" and

2595

value != old_client_settings[client_name]

2596

[name]):

2597

client[name] = value

2598

except KeyError:

2599

pass

2600

2601

# Clients who has passed its expire date can still be

2602

# enabled if its last checker was successful. Clients

2603

# whose checker succeeded before we stored its state is

2604

# assumed to have successfully run all checkers during

2605

# downtime.

2606

if client["enabled"]:

2607

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

2608

if not client["last_checked_ok"]:

2609

logger.warning(

2610

"disabling client {0} - Client never "

2611

"performed a successful checker"

2612

.format(client_name))

2613

client["enabled"] = False

2614

elif client["last_checker_status"] != 0:

2615

logger.warning(

2616

"disabling client {0} - Client "

2617

"last checker failed with error code {1}"

2618

.format(client_name,

2619

client["last_checker_status"]))

2620

client["enabled"] = False

2621

else:

2622

client["expires"] = (datetime.datetime

2623

.utcnow()

2624

+ client["timeout"])

2625

logger.debug("Last checker succeeded,"

2626

" keeping {0} enabled"

2627

.format(client_name))

2054

2628

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

2629

client["secret"] = (

2630

pgp.decrypt(client["encrypted_secret"],

2631

client_settings[client_name]

2632

["secret"]))

2633

except PGPError:

2634

# If decryption fails, we use secret from new settings

2635

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

2636

.format(client_name))

2637

client["secret"] = (

2638

client_settings[client_name]["secret"])

2639

2640

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

2641

for client_name in (set(old_client_settings)

2642

- set(client_settings)):

2643

del clients_data[client_name]

2644

for client_name in (set(client_settings)

2645

- set(old_client_settings)):

2646

clients_data[client_name] = client_settings[client_name]

2647

2648

# Create all client objects

2649

for client_name, client in clients_data.iteritems():

2650

tcp_server.clients[client_name] = client_class(

2651

name = client_name, settings = client,

2652

server_settings = server_settings)

2653

2064

2654

if not tcp_server.clients:

2065

2655

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

2656

2657

if not foreground:

2658

if pidfile is not None:

2659

try:

2660

with pidfile:

2661

pid = os.getpid()

2662

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

2663

except IOError:

2664

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

2665

pidfilename, pid)

2666

del pidfile

2079

2667

del pidfilename

2080

2081

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

2082

2668

2083

2669

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

2084

2670

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

2085

2671

2086

2672

if use_dbus:

2087

class MandosDBusService(dbus.service.Object):

2673

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

2674

"se.bsnet.fukt.Mandos"})

2675

class MandosDBusService(DBusObjectWithProperties):

2088

2676

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

2089

2677

def __init__(self):

2090

2678

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

2091

2679

_interface = "se.recompile.Mandos"

2092

2680

2681

@dbus_interface_annotations(_interface)

2682

def _foo(self):

2683

return { "org.freedesktop.DBus.Property"

2684

".EmitsChangedSignal":

2685

"false"}

2686

2093

2687

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

2094

2688

def ClientAdded(self, objpath):

2095

2689

"D-Bus signal"

2109

2703

def GetAllClients(self):

2110

2704

"D-Bus method"

2111

2705

return dbus.Array(c.dbus_object_path

2112

for c in tcp_server.clients)

2706

for c in

2707

tcp_server.clients.itervalues())

2113

2708

2114

2709

@dbus.service.method(_interface,

2115

2710

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

2117

2712

"D-Bus method"

2118

2713

return dbus.Dictionary(

2119

2714

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

2120

for c in tcp_server.clients),

2715

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

2121

2716

signature="oa{sv}")

2122

2717

2123

2718

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

2124

2719

def RemoveClient(self, object_path):

2125

2720

"D-Bus method"

2126

for c in tcp_server.clients:

2721

for c in tcp_server.clients.itervalues():

2127

2722

if c.dbus_object_path == object_path:

2128

tcp_server.clients.remove(c)

2723

del tcp_server.clients[c.name]

2129

2724

c.remove_from_connection()

2130

2725

# Don't signal anything except ClientRemoved

2131

2726

c.disable(quiet=True)

2136

2731

2137

2732

del _interface

2138

2733

2139

class MandosDBusServiceTransitional(MandosDBusService):

2140

__metaclass__ = AlternateDBusNamesMetaclass

2141

mandos_dbus_service = MandosDBusServiceTransitional()

2734

mandos_dbus_service = MandosDBusService()

2142

2735

2143

2736

def cleanup():

2144

2737

"Cleanup function; run on exit"

2145

2738

service.cleanup()

2146

2739

2147

2740

multiprocessing.active_children()

2741

wnull.close()

2742

if not (tcp_server.clients or client_settings):

2743

return

2744

2745

# Store client before exiting. Secrets are encrypted with key

2746

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

2747

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

2748

clients = {}

2749

with PGPEngine() as pgp:

2750

for client in tcp_server.clients.itervalues():

2751

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

2752

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

2753

key)

2754

client_dict = {}

2755

2756

# A list of attributes that can not be pickled

2757

# + secret.

2758

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

2759

"checker", "server_settings"))

2760

for name, typ in (inspect.getmembers

2761

(dbus.service.Object)):

2762

exclude.add(name)

2763

2764

client_dict["encrypted_secret"] = (client

2765

.encrypted_secret)

2766

for attr in client.client_structure:

2767

if attr not in exclude:

2768

client_dict[attr] = getattr(client, attr)

2769

2770

clients[client.name] = client_dict

2771

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

2772

2773

try:

2774

with (tempfile.NamedTemporaryFile

2775

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

2776

dir=os.path.dirname(stored_state_path),

2777

delete=False)) as stored_state:

2778

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

2779

tempname=stored_state.name

2780

os.rename(tempname, stored_state_path)

2781

except (IOError, OSError) as e:

2782

if not debug:

2783

try:

2784

os.remove(tempname)

2785

except NameError:

2786

pass

2787

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

2788

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

2789

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

2790

else:

2791

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

2792

exc_info=e)

2793

raise e

2794

2795

# Delete all clients, and settings from config

2148

2796

while tcp_server.clients:

2149

client = tcp_server.clients.pop()

2797

name, client = tcp_server.clients.popitem()

2150

2798

if use_dbus:

2151

2799

client.remove_from_connection()

2152

client.disable_hook = None

2153

2800

# Don't signal anything except ClientRemoved

2154

2801

client.disable(quiet=True)

2155

2802

if use_dbus:

2157

2804

mandos_dbus_service.ClientRemoved(client

2158

2805

.dbus_object_path,

2159

2806

client.name)

2807

client_settings.clear()

2160

2808

2161

2809

atexit.register(cleanup)

2162

2810

2163

for client in tcp_server.clients:

2811

for client in tcp_server.clients.itervalues():

2164

2812

if use_dbus:

2165

2813

# Emit D-Bus signal

2166

2814

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2167

client.enable()

2815

# Need to initiate checking of clients

2816

if client.enabled:

2817

client.init_checker()

2168

2818

2169

2819

tcp_server.enable()

2170

2820

tcp_server.server_activate()

2173

2823

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

2174

2824

if use_ipv6:

2175

2825

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

2176

" flowinfo %d, scope_id %d"

2177

% tcp_server.socket.getsockname())

2826

" flowinfo %d, scope_id %d",

2827

*tcp_server.socket.getsockname())

2178

2828

else: # IPv4

2179

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

2180

% tcp_server.socket.getsockname())

2829

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

2830

*tcp_server.socket.getsockname())

2181

2831

2182

2832

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

2183

2833

2186

2836

try:

2187

2837

service.activate()

2188

2838

except dbus.exceptions.DBusException as error:

2189

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

2839

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

2190

2840

cleanup()

2191

2841

sys.exit(1)

2192

2842

# End of Avahi example code

2199

2849

logger.debug("Starting main loop")

2200

2850

main_loop.run()

2201

2851

except AvahiError as error:

2202

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

2852

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

2203

2853

cleanup()

2204

2854

sys.exit(1)

2205

2855

except KeyboardInterrupt:

2210

2860

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

2211

2861

cleanup()

2212

2862

2213

2214

2863

if __name__ == '__main__':

2215

2864

main()