/mandos/trunk : revision 237.4.37

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"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

91

version = "1.6.2"

92

stored_state_file = "clients.pickle"

93

94

logger = logging.getLogger()

90

95

syslogger = (logging.handlers.SysLogHandler

91

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

97

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

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

219

103

220

104

221

class AvahiError(Exception):

105

222

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

123

240

Used to optionally bind to the specified interface.

124

241

name: string; Example: 'Mandos'

125

242

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

126

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

243

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

127

244

port: integer; what port to announce

128

245

TXT: list of strings; TXT record for the service

129

246

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

135

252

server: D-Bus Server

136

253

bus: dbus.SystemBus()

137

254

"""

255

138

256

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

139

257

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

140

258

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

153

271

self.server = None

154

272

self.bus = bus

155

273

self.entry_group_state_changed_match = None

274

156

275

def rename(self):

157

276

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

158

277

if self.rename_count >= self.max_renames:

164

283

.GetAlternativeServiceName(self.name))

165

284

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

166

285

self.name)

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

286

self.remove()

172

287

try:

173

288

self.add()

174

289

except dbus.exceptions.DBusException as error:

175

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

290

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

176

291

self.cleanup()

177

292

os._exit(1)

178

293

self.rename_count += 1

294

179

295

def remove(self):

180

296

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

181

297

if self.entry_group_state_changed_match is not None:

183

299

self.entry_group_state_changed_match = None

184

300

if self.group is not None:

185

301

self.group.Reset()

302

186

303

def add(self):

187

304

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

188

305

self.remove()

193

310

avahi.DBUS_INTERFACE_ENTRY_GROUP)

194

311

self.entry_group_state_changed_match = (

195

312

self.group.connect_to_signal(

196

'StateChanged', self .entry_group_state_changed))

313

'StateChanged', self.entry_group_state_changed))

197

314

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

198

315

self.name, self.type)

199

316

self.group.AddService(

205

322

dbus.UInt16(self.port),

206

323

avahi.string_array_to_txt_array(self.TXT))

207

324

self.group.Commit()

325

208

326

def entry_group_state_changed(self, state, error):

209

327

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

210

328

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

217

335

elif state == avahi.ENTRY_GROUP_FAILURE:

218

336

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

219

337

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

338

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

339

.format(error))

340

222

341

def cleanup(self):

223

342

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

224

343

if self.group is not None:

225

344

try:

226

345

self.group.Free()

227

346

except (dbus.exceptions.UnknownMethodException,

228

dbus.exceptions.DBusException) as e:

347

dbus.exceptions.DBusException):

229

348

pass

230

349

self.group = None

231

350

self.remove()

351

232

352

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

233

353

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

234

354

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

253

373

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

254

374

else:

255

375

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

376

256

377

def activate(self):

257

378

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

258

379

if self.server is None:

266

387

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

267

388

268

389

269

def _timedelta_to_milliseconds(td):

390

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

392

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

398

return ret

399

400

401

def timedelta_to_milliseconds(td):

270

402

"Convert a datetime.timedelta() to milliseconds"

271

403

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

272

404

+ (td.seconds * 1000)

273

405

+ (td.microseconds // 1000))

274

406

407

275

408

class Client(object):

276

409

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

277

410

278

411

Attributes:

279

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

412

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

280

413

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

281

414

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

282

415

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

289

422

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

290

423

checker_initiator_tag: a gobject event source tag, or None

291

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

292

427

current_checker_command: string; current running checker_command

293

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

294

428

disable_initiator_tag: a gobject event source tag, or None

295

429

enabled: bool()

296

430

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

299

433

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

300

434

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

301

435

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

302

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

303

440

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

304

441

D-Bus identifiers

305

442

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

306

443

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

307

444

until this client is disabled

308

extended_timeout: extra long timeout when password has been sent

445

extended_timeout: extra long timeout when secret has been sent

309

446

runtime_expansions: Allowed attributes for runtime expansion.

310

447

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

311

448

disabled, or None

449

server_settings: The server_settings dict from main()

312

450

"""

313

451

314

452

runtime_expansions = ("approval_delay", "approval_duration",

315

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

316

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

453

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

454

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

455

"last_approval_request", "last_checked_ok",

317

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

}

318

467

319

468

def timeout_milliseconds(self):

320

469

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

470

return timedelta_to_milliseconds(self.timeout)

322

471

323

472

def extended_timeout_milliseconds(self):

324

473

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

474

return timedelta_to_milliseconds(self.extended_timeout)

326

475

327

476

def interval_milliseconds(self):

328

477

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

478

return timedelta_to_milliseconds(self.interval)

330

479

331

480

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

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

338

531

self.name = name

339

if config is None:

340

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

341

549

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

342

550

# Uppercase and remove spaces from fingerprint for later

343

551

# comparison purposes with return value from the fingerprint()

344

552

# function

345

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

346

.replace(" ", ""))

347

553

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

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

554

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

555

datetime.datetime.utcnow())

556

557

# attributes specific for this server instance

369

558

self.checker = None

370

559

self.checker_initiator_tag = None

371

560

self.disable_initiator_tag = None

372

self.expires = None

373

561

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

375

562

self.current_checker_command = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

563

self.approved = None

380

564

self.approvals_pending = 0

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

565

self.changedstate = (multiprocessing_manager

386

566

.Condition(multiprocessing_manager

387

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)

388

579

580

# Send notice to process children that client state has changed

389

581

def send_changedstate(self):

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

582

with self.changedstate:

583

self.changedstate.notify_all()

393

584

394

585

def enable(self):

395

586

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

396

587

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

397

588

# Already enabled

398

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

399

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

400

620

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

401

621

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

402

624

self.checker_initiator_tag = (gobject.timeout_add

403

625

(self.interval_milliseconds(),

404

626

self.start_checker))

405

627

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

406

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

628

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

407

630

self.disable_initiator_tag = (gobject.timeout_add

408

631

(self.timeout_milliseconds(),

409

632

self.disable))

410

self.enabled = True

411

self.last_enabled = datetime.datetime.utcnow()

412

633

# Also start a new checker *right now*.

413

634

self.start_checker()

414

635

415

def disable(self, quiet=True):

416

"""Disable this client."""

417

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

418

return False

419

if not quiet:

420

self.send_changedstate()

421

if not quiet:

422

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

423

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

424

gobject.source_remove(self.disable_initiator_tag)

425

self.disable_initiator_tag = None

426

self.expires = None

427

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

428

gobject.source_remove(self.checker_initiator_tag)

429

self.checker_initiator_tag = None

430

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

433

self.enabled = False

434

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

435

return False

436

437

def __del__(self):

438

self.disable_hook = None

439

self.disable()

440

441

636

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

442

637

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

443

638

self.checker_callback_tag = None

444

639

self.checker = None

445

640

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

641

self.last_checker_status = os.WEXITSTATUS(condition)

642

if self.last_checker_status == 0:

448

643

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

449

644

vars(self))

450

645

self.checked_ok()

452

647

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

453

648

vars(self))

454

649

else:

650

self.last_checker_status = -1

455

651

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

456

652

vars(self))

457

653

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

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

464

662

if timeout is None:

465

663

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

467

664

if self.disable_initiator_tag is not None:

468

665

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

469

667

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

470

668

self.disable_initiator_tag = (gobject.timeout_add

471

(_timedelta_to_milliseconds

669

(timedelta_to_milliseconds

472

670

(timeout), self.disable))

473

671

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

474

672

481

679

If a checker already exists, leave it running and do

482

680

nothing."""

483

681

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

484

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

485

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

486

# client would inevitably timeout, since no checker would get

487

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

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

488

686

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

489

687

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

490

688

# should be.

504

702

self.current_checker_command)

505

703

# Start a new checker if needed

506

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)

507

710

try:

508

# In case checker_command has exactly one % operator

509

command = self.checker_command % self.host

510

except TypeError:

511

# Escape attributes for the shell

512

escaped_attrs = dict(

513

(attr,

514

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

515

errors=

516

'replace')))

517

for attr in

518

self.runtime_expansions)

519

520

try:

521

command = self.checker_command % escaped_attrs

522

except TypeError as error:

523

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

524

' %s', self.checker_command, error)

525

return True # Try again later

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

526

716

self.current_checker_command = command

527

717

try:

528

718

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

531

721

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

532

722

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

533

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

534

732

self.checker = subprocess.Popen(command,

535

733

close_fds=True,

536

shell=True, cwd="/")

537

self.checker_callback_tag = (gobject.child_watch_add

538

(self.checker.pid,

539

self.checker_callback,

540

data=command))

541

# The checker may have completed before the gobject

542

# watch was added. Check for this.

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:

543

747

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

544

if pid:

545

gobject.source_remove(self.checker_callback_tag)

546

self.checker_callback(pid, status, command)

547

748

except OSError as error:

548

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

549

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)

550

758

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

551

759

return True

552

760

559

767

return

560

768

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

561

769

try:

562

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

770

self.checker.terminate()

563

771

#time.sleep(0.5)

564

772

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

565

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

773

# self.checker.kill()

566

774

except OSError as error:

567

775

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

568

776

raise

585

793

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

586

794

if byte_arrays and signature != "ay":

587

795

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

588

" signature %r" % signature)

796

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

589

797

def decorator(func):

590

798

func._dbus_is_property = True

591

799

func._dbus_interface = dbus_interface

599

807

return decorator

600

808

601

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

602

847

class DBusPropertyException(dbus.exceptions.DBusException):

603

848

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

604

849

"""

627

872

"""

628

873

629

874

@staticmethod

630

def _is_dbus_property(obj):

631

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)

632

883

633

def _get_all_dbus_properties(self):

884

def _get_all_dbus_things(self, thing):

634

885

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

635

886

"""

636

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

887

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

888

name),

889

athing.__get__(self))

637

890

for cls in self.__class__.__mro__

638

for name, prop in

639

inspect.getmembers(cls, self._is_dbus_property))

891

for name, athing in

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

640

894

641

895

def _get_dbus_property(self, interface_name, property_name):

642

896

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

644

898

"""

645

899

for cls in self.__class__.__mro__:

646

900

for name, value in (inspect.getmembers

647

(cls, self._is_dbus_property)):

901

(cls,

902

self._is_dbus_thing("property"))):

648

903

if (value._dbus_name == property_name

649

904

and value._dbus_interface == interface_name):

650

905

return value.__get__(self)

679

934

# signatures other than "ay".

680

935

if prop._dbus_signature != "ay":

681

936

raise ValueError

682

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

683

for byte in value))

937

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

938

for byte in value))

684

939

prop(value)

685

940

686

941

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

691

946

692

947

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

693

948

"""

694

all = {}

695

for name, prop in self._get_all_dbus_properties():

949

properties = {}

950

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

696

951

if (interface_name

697

952

and interface_name != prop._dbus_interface):

698

953

# Interface non-empty but did not match

702

957

continue

703

958

value = prop()

704

959

if not hasattr(value, "variant_level"):

705

all[name] = value

960

properties[name] = value

706

961

continue

707

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

708

value.variant_level+1)

709

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

710

965

711

966

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

712

967

out_signature="s",

713

968

path_keyword='object_path',

714

969

connection_keyword='connection')

715

970

def Introspect(self, object_path, connection):

716

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

717

974

"""

718

975

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

719

976

connection)

726

983

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

727

984

return e

728

985

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

986

# Add property tags

729

987

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

730

988

for name, prop

731

in self._get_all_dbus_properties()

989

in self._get_all_dbus_things("property")

732

990

if prop._dbus_interface

733

991

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

734

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)

735

1024

# Add the names to the return values for the

736

1025

# "org.freedesktop.DBus.Properties" methods

737

1026

if (if_tag.getAttribute("name")

752

1041

except (AttributeError, xml.dom.DOMException,

753

1042

xml.parsers.expat.ExpatError) as error:

754

1043

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

755

error)

1044

exc_info=error)

756

1045

return xmlstring

757

1046

758

1047

759

def datetime_to_dbus (dt, variant_level=0):

1048

def datetime_to_dbus(dt, variant_level=0):

760

1049

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

761

1050

if dt is None:

762

1051

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

763

1052

return dbus.String(dt.isoformat(),

764

1053

variant_level=variant_level)

765

1054

766

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

767

.__metaclass__):

768

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

769

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

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

770

1078

"""

771

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

772

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

773

# methods, signals, or properties in them

774

for base in (b for b in bases

775

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

776

# Go though all attributes of the base class

777

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

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

778

1086

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

779

1087

# with the wrong interface name

780

1088

if (not hasattr(attribute, "_dbus_interface")

781

1089

or not attribute._dbus_interface

782

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

1090

.startswith(orig_interface_name)):

783

1091

continue

784

1092

# Create an alternate D-Bus interface name based on

785

1093

# the current name

786

1094

alt_interface = (attribute._dbus_interface

787

.replace("se.recompile.Mandos",

788

"se.bsnet.fukt.Mandos"))

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1097

interface_names.add(alt_interface)

789

1098

# Is this a D-Bus signal?

790

1099

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

791

# Extract the original non-method function by

792

# black magic

1100

# Extract the original non-method undecorated

1101

# function by black magic

793

1102

nonmethod_func = (dict(

794

1103

zip(attribute.func_code.co_freevars,

795

1104

attribute.__closure__))["func"]

806

1115

nonmethod_func.func_name,

807

1116

nonmethod_func.func_defaults,

808

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

809

1124

# Define a creator of a function to call both the

810

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

811

# 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

812

1128

def fixscope(func1, func2):

813

1129

"""This function is a scope container to pass

814

1130

func1 and func2 to the "call_both" function

821

1137

return call_both

822

1138

# Create the "call_both" function and add it to

823

1139

# the class

824

attr[attrname] = fixscope(attribute,

825

new_function)

1140

attr[attrname] = fixscope(attribute, new_function)

826

1141

# Is this a D-Bus method?

827

1142

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

828

1143

# Create a new, but exactly alike, function

839

1154

attribute.func_name,

840

1155

attribute.func_defaults,

841

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

842

1163

# Is this a D-Bus property?

843

1164

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

844

1165

# Create a new, but exactly alike, function

858

1179

attribute.func_name,

859

1180

attribute.func_defaults,

860

1181

attribute.func_closure)))

861

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

862

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

863

1227

class ClientDBus(Client, DBusObjectWithProperties):

864

1228

"""A Client class using D-Bus

865

1229

874

1238

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

875

1239

876

1240

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

877

self._approvals_pending = 0

878

1241

self.bus = bus

879

1242

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

880

1243

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

886

1249

("/clients/" + client_object_name))

887

1250

DBusObjectWithProperties.__init__(self, self.bus,

888

1251

self.dbus_object_path)

889

1252

890

1253

def notifychangeproperty(transform_func,

891

1254

dbus_name, type_func=lambda x: x,

892

1255

variant_level=1):

893

1256

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

894

1257

its changes to DBus.

895

1258

896

1259

transform_fun: Function that takes a value and a variant_level

897

1260

and transforms it to a D-Bus type.

898

1261

dbus_name: D-Bus name of the variable

915

1278

916

1279

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

917

1280

918

919

1281

expires = notifychangeproperty(datetime_to_dbus, "Expires")

920

1282

approvals_pending = notifychangeproperty(dbus.Boolean,

921

1283

"ApprovalPending",

928

1290

checker is not None)

929

1291

last_checked_ok = notifychangeproperty(datetime_to_dbus,

930

1292

"LastCheckedOK")

1293

last_checker_status = notifychangeproperty(dbus.Int16,

1294

"LastCheckerStatus")

931

1295

last_approval_request = notifychangeproperty(

932

1296

datetime_to_dbus, "LastApprovalRequest")

933

1297

approved_by_default = notifychangeproperty(dbus.Boolean,

934

1298

"ApprovedByDefault")

935

approval_delay = notifychangeproperty(dbus.UInt16,

1299

approval_delay = notifychangeproperty(dbus.UInt64,

936

1300

"ApprovalDelay",

937

1301

type_func =

938

_timedelta_to_milliseconds)

1302

timedelta_to_milliseconds)

939

1303

approval_duration = notifychangeproperty(

940

dbus.UInt16, "ApprovalDuration",

941

type_func = _timedelta_to_milliseconds)

1304

dbus.UInt64, "ApprovalDuration",

1305

type_func = timedelta_to_milliseconds)

942

1306

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

943

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

1307

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

944

1308

type_func =

945

_timedelta_to_milliseconds)

1309

timedelta_to_milliseconds)

946

1310

extended_timeout = notifychangeproperty(

947

dbus.UInt16, "ExtendedTimeout",

948

type_func = _timedelta_to_milliseconds)

949

interval = notifychangeproperty(dbus.UInt16,

1311

dbus.UInt64, "ExtendedTimeout",

1312

type_func = timedelta_to_milliseconds)

1313

interval = notifychangeproperty(dbus.UInt64,

950

1314

"Interval",

951

1315

type_func =

952

_timedelta_to_milliseconds)

1316

timedelta_to_milliseconds)

953

1317

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

954

1318

955

1319

del notifychangeproperty

997

1361

return r

998

1362

999

1363

def _reset_approved(self):

1000

self._approved = None

1364

self.approved = None

1001

1365

return False

1002

1366

1003

1367

def approve(self, value=True):

1004

self.send_changedstate()

1005

self._approved = value

1006

gobject.timeout_add(_timedelta_to_milliseconds

1368

self.approved = value

1369

gobject.timeout_add(timedelta_to_milliseconds

1007

1370

(self.approval_duration),

1008

1371

self._reset_approved)

1009

1372

self.send_changedstate()

1010

1373

1011

1374

## D-Bus methods, signals & properties

1012

1375

_interface = "se.recompile.Mandos.Client"

1013

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1014

1384

## Signals

1015

1385

1016

1386

# CheckerCompleted - signal

1115

1485

access="readwrite")

1116

1486

def ApprovalDuration_dbus_property(self, value=None):

1117

1487

if value is None: # get

1118

return dbus.UInt64(_timedelta_to_milliseconds(

1488

return dbus.UInt64(timedelta_to_milliseconds(

1119

1489

self.approval_duration))

1120

1490

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

1121

1491

1135

1505

def Host_dbus_property(self, value=None):

1136

1506

if value is None: # get

1137

1507

return dbus.String(self.host)

1138

self.host = value

1508

self.host = unicode(value)

1139

1509

1140

1510

# Created - property

1141

1511

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

1142

1512

def Created_dbus_property(self):

1143

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

1513

return datetime_to_dbus(self.created)

1144

1514

1145

1515

# LastEnabled - property

1146

1516

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

1167

1537

return

1168

1538

return datetime_to_dbus(self.last_checked_ok)

1169

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

1170

1546

# Expires - property

1171

1547

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

1172

1548

def Expires_dbus_property(self):

1183

1559

def Timeout_dbus_property(self, value=None):

1184

1560

if value is None: # get

1185

1561

return dbus.UInt64(self.timeout_milliseconds())

1562

old_timeout = self.timeout

1186

1563

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

1187

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

1188

return

1189

# Reschedule timeout

1190

gobject.source_remove(self.disable_initiator_tag)

1191

self.disable_initiator_tag = None

1192

self.expires = None

1193

time_to_die = _timedelta_to_milliseconds((self

1194

.last_checked_ok

1195

+ self.timeout)

1196

- datetime.datetime

1197

.utcnow())

1198

if time_to_die <= 0:

1199

# The timeout has passed

1200

self.disable()

1201

else:

1202

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

1203

+ datetime.timedelta(milliseconds =

1204

time_to_die))

1205

self.disable_initiator_tag = (gobject.timeout_add

1206

(time_to_die, self.disable))

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

1207

1580

1208

1581

# ExtendedTimeout - property

1209

1582

@dbus_service_property(_interface, signature="t",

1222

1595

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

1223

1596

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

1224

1597

return

1225

# Reschedule checker run

1226

gobject.source_remove(self.checker_initiator_tag)

1227

self.checker_initiator_tag = (gobject.timeout_add

1228

(value, self.start_checker))

1229

self.start_checker() # Start one now, too

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

1230

1604

1231

1605

# Checker - property

1232

1606

@dbus_service_property(_interface, signature="s",

1234

1608

def Checker_dbus_property(self, value=None):

1235

1609

if value is None: # get

1236

1610

return dbus.String(self.checker_command)

1237

self.checker_command = value

1611

self.checker_command = unicode(value)

1238

1612

1239

1613

# CheckerRunning - property

1240

1614

@dbus_service_property(_interface, signature="b",

1269

1643

raise KeyError()

1270

1644

1271

1645

def __getattribute__(self, name):

1272

if(name == '_pipe'):

1646

if name == '_pipe':

1273

1647

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

1274

1648

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

1275

1649

data = self._pipe.recv()

1282

1656

return func

1283

1657

1284

1658

def __setattr__(self, name, value):

1285

if(name == '_pipe'):

1659

if name == '_pipe':

1286

1660

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

1287

1661

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

1288

1662

1289

class ClientDBusTransitional(ClientDBus):

1290

__metaclass__ = AlternateDBusNamesMetaclass

1291

1663

1292

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

1293

1665

"""A class to handle client connections.

1376

1748

client.Rejected("Disabled")

1377

1749

return

1378

1750

1379

if client._approved or not client.approval_delay:

1751

if client.approved or not client.approval_delay:

1380

1752

#We are approved or approval is disabled

1381

1753

break

1382

elif client._approved is None:

1754

elif client.approved is None:

1383

1755

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

1384

1756

client.name)

1385

1757

if self.server.use_dbus:

1398

1770

#wait until timeout or approved

1399

1771

time = datetime.datetime.now()

1400

1772

client.changedstate.acquire()

1401

(client.changedstate.wait

1402

(float(client._timedelta_to_milliseconds(delay)

1403

/ 1000)))

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

1404

1776

client.changedstate.release()

1405

1777

time2 = datetime.datetime.now()

1406

1778

if (time2 - time) >= delay:

1422

1794

try:

1423

1795

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

1424

1796

except gnutls.errors.GNUTLSError as error:

1425

logger.warning("gnutls send failed")

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1426

1799

return

1427

1800

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

1428

1801

sent, len(client.secret)

1431

1804

1432

1805

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

1433

1806

# bump the timeout using extended_timeout

1434

client.checked_ok(client.extended_timeout)

1807

client.bump_timeout(client.extended_timeout)

1435

1808

if self.server.use_dbus:

1436

1809

# Emit D-Bus signal

1437

1810

client.GotSecret()

1442

1815

try:

1443

1816

session.bye()

1444

1817

except gnutls.errors.GNUTLSError as error:

1445

logger.warning("GnuTLS bye failed")

1818

logger.warning("GnuTLS bye failed",

1819

exc_info=error)

1446

1820

1447

1821

@staticmethod

1448

1822

def peer_certificate(session):

1504

1878

# Convert the buffer to a Python bytestring

1505

1879

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

1506

1880

# Convert the bytestring to hexadecimal notation

1507

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

1881

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

1508

1882

return hex_fpr

1509

1883

1510

1884

1513

1887

def sub_process_main(self, request, address):

1514

1888

try:

1515

1889

self.finish_request(request, address)

1516

except:

1890

except Exception:

1517

1891

self.handle_error(request, address)

1518

1892

self.close_request(request)

1519

1893

1520

1894

def process_request(self, request, address):

1521

1895

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

1522

1896

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

1523

args = (request,

1524

address))

1897

args = (request, address))

1525

1898

proc.start()

1526

1899

return proc

1527

1900

1555

1928

use_ipv6: Boolean; to use IPv6 or not

1556

1929

"""

1557

1930

def __init__(self, server_address, RequestHandlerClass,

1558

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

"""

1559

1935

self.interface = interface

1560

1936

if use_ipv6:

1561

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.

1562

1964

socketserver.TCPServer.__init__(self, server_address,

1563

1965

RequestHandlerClass)

1966

1564

1967

def server_bind(self):

1565

1968

"""This overrides the normal server_bind() function

1566

1969

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

1574

1977

try:

1575

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1576

1979

SO_BINDTODEVICE,

1577

str(self.interface

1578

+ '\0'))

1980

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

1579

1981

except socket.error as error:

1580

if error[0] == errno.EPERM:

1581

logger.error("No permission to"

1582

" bind to interface %s",

1583

self.interface)

1584

elif error[0] == errno.ENOPROTOOPT:

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:

1585

1986

logger.error("SO_BINDTODEVICE not available;"

1586

1987

" cannot bind to interface %s",

1587

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1588

1992

else:

1589

1993

raise

1590

1994

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

1593

1997

if self.address_family == socket.AF_INET6:

1594

1998

any_address = "::" # in6addr_any

1595

1999

else:

1596

any_address = socket.INADDR_ANY

2000

any_address = "0.0.0.0" # INADDR_ANY

1597

2001

self.server_address = (any_address,

1598

2002

self.server_address[1])

1599

2003

elif not self.server_address[1]:

1620

2024

"""

1621

2025

def __init__(self, server_address, RequestHandlerClass,

1622

2026

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

1623

gnutls_priority=None, use_dbus=True):

2027

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

1624

2028

self.enabled = False

1625

2029

self.clients = clients

1626

2030

if self.clients is None:

1627

self.clients = set()

2031

self.clients = {}

1628

2032

self.use_dbus = use_dbus

1629

2033

self.gnutls_priority = gnutls_priority

1630

2034

IPv6_TCPServer.__init__(self, server_address,

1631

2035

RequestHandlerClass,

1632

2036

interface = interface,

1633

use_ipv6 = use_ipv6)

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

1634

2039

def server_activate(self):

1635

2040

if self.enabled:

1636

2041

return socketserver.TCPServer.server_activate(self)

1649

2054

1650

2055

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

1651

2056

proc = None, client_object=None):

1652

condition_names = {

1653

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

1654

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

1655

# blocking).

1656

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

1657

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

1658

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

1659

# broken, usually for pipes and

1660

# sockets).

1661

}

1662

conditions_string = ' | '.join(name

1663

for cond, name in

1664

condition_names.iteritems()

1665

if cond & condition)

1666

2057

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

1667

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

2058

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

1668

2059

# Wait for other process to exit

1669

2060

proc.join()

1670

2061

return False

1677

2068

fpr = request[1]

1678

2069

address = request[2]

1679

2070

1680

for c in self.clients:

2071

for c in self.clients.itervalues():

1681

2072

if c.fingerprint == fpr:

1682

2073

client = c

1683

2074

break

1728

2119

return True

1729

2120

1730

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

1731

2221

def string_to_delta(interval):

1732

2222

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

1733

2223

1744

2234

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

1745

2235

datetime.timedelta(0, 330)

1746

2236

"""

2237

2238

try:

2239

return rfc3339_duration_to_delta(interval)

2240

except ValueError:

2241

pass

2242

1747

2243

timevalue = datetime.timedelta(0)

1748

2244

for s in interval.split():

1749

2245

try:

1760

2256

elif suffix == "w":

1761

2257

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

1762

2258

else:

1763

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

2259

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

2260

.format(suffix))

1764

2261

except (ValueError, IndexError) as e:

1765

2262

raise ValueError(*(e.args))

1766

2263

timevalue += delta

1767

2264

return timevalue

1768

2265

1769

2266

1770

def if_nametoindex(interface):

1771

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

1772

1773

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

1774

global if_nametoindex

1775

try:

1776

if_nametoindex = (ctypes.cdll.LoadLibrary

1777

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

1778

.if_nametoindex)

1779

except (OSError, AttributeError):

1780

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

1781

def if_nametoindex(interface):

1782

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

1783

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

1784

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

1785

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1786

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

1787

interface))

1788

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

1789

ifreq[16:20])[0]

1790

return interface_index

1791

return if_nametoindex(interface)

1792

1793

1794

2267

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

1795

2268

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

1796

2269

1804

2277

sys.exit()

1805

2278

if not noclose:

1806

2279

# Close all standard open file descriptors

1807

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

2280

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

1808

2281

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

1809

2282

raise OSError(errno.ENODEV,

1810

"%s not a character device"

1811

% os.path.devnull)

2283

"{0} not a character device"

2284

.format(os.devnull))

1812

2285

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

1813

2286

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

1814

2287

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

1823

2296

1824

2297

parser = argparse.ArgumentParser()

1825

2298

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

1826

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

2299

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

1827

2300

help="show version number and exit")

1828

2301

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

1829

2302

help="Bind to interface IF")

1835

2308

help="Run self-test")

1836

2309

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

1837

2310

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

1838

" to terminal")

2311

" to terminal", default=None)

1839

2312

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

1840

2313

help="Debug level for stdout output")

1841

2314

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

1848

2321

" files")

1849

2322

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

1850

2323

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

1851

" system bus interface")

2324

" system bus interface", default=None)

1852

2325

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

1853

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

1854

2339

options = parser.parse_args()

1855

2340

1856

2341

if options.check:

1864

2349

"port": "",

1865

2350

"debug": "False",

1866

2351

"priority":

1867

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

2352

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

1868

2353

"servicename": "Mandos",

1869

2354

"use_dbus": "True",

1870

2355

"use_ipv6": "True",

1871

2356

"debuglevel": "",

2357

"restore": "True",

2358

"socket": "",

2359

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

2360

"foreground": "False",

1872

2361

}

1873

2362

1874

2363

# Parse config file for server-global settings

1879

2368

# Convert the SafeConfigParser object to a dict

1880

2369

server_settings = server_config.defaults()

1881

2370

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

1882

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

2371

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

1883

2372

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

1884

2373

option)

1885

2374

if server_settings["port"]:

1886

2375

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

1887

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

1888

2386

del server_config

1889

2387

1890

2388

# Override the settings from the config file with command line

1891

2389

# options, if set.

1892

2390

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

1893

2391

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

1894

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

2392

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

2393

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

1895

2394

value = getattr(options, option)

1896

2395

if value is not None:

1897

2396

server_settings[option] = value

1900

2399

for option in server_settings.keys():

1901

2400

if type(server_settings[option]) is str:

1902

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

1903

2409

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

1904

2410

1905

2411

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

1909

2415

debuglevel = server_settings["debuglevel"]

1910

2416

use_dbus = server_settings["use_dbus"]

1911

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)

1912

2430

1913

2431

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

1914

2432

syslogger.setFormatter(logging.Formatter

1915

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

1916

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

1917

% server_settings["servicename"]))

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

1918

2437

1919

2438

# Parse config file with clients

1920

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

1921

"extended_timeout": "15m",

1922

"interval": "2m",

1923

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

1924

"host": "",

1925

"approval_delay": "0s",

1926

"approval_duration": "1s",

1927

}

1928

client_config = configparser.SafeConfigParser(client_defaults)

2439

client_config = configparser.SafeConfigParser(Client

2440

.client_defaults)

1929

2441

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

1930

2442

"clients.conf"))

1931

2443

1940

2452

use_ipv6=use_ipv6,

1941

2453

gnutls_priority=

1942

2454

server_settings["priority"],

1943

use_dbus=use_dbus)

1944

if not debug:

1945

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

1946

2461

try:

1947

2462

pidfile = open(pidfilename, "w")

1948

except IOError:

1949

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)

1950

2466

1951

try:

1952

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

1953

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

1954

except KeyError:

2467

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

1955

2468

try:

1956

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

1957

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

2469

uid = pwd.getpwnam(name).pw_uid

2470

gid = pwd.getpwnam(name).pw_gid

2471

break

1958

2472

except KeyError:

1959

try:

1960

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

1961

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

1962

except KeyError:

1963

uid = 65534

1964

gid = 65534

2473

continue

2474

else:

2475

uid = 65534

2476

gid = 65534

1965

2477

try:

1966

2478

os.setgid(gid)

1967

2479

os.setuid(uid)

1968

2480

except OSError as error:

1969

if error[0] != errno.EPERM:

2481

if error.errno != errno.EPERM:

1970

2482

raise error

1971

2483

1972

if not debug and not debuglevel:

1973

syslogger.setLevel(logging.WARNING)

1974

console.setLevel(logging.WARNING)

1975

if debuglevel:

1976

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

1977

syslogger.setLevel(level)

1978

console.setLevel(level)

1979

1980

2484

if debug:

1981

2485

# Enable all possible GnuTLS debugging

1982

2486

1992

2496

.gnutls_global_set_log_function(debug_gnutls))

1993

2497

1994

2498

# Redirect stdin so all checkers get /dev/null

1995

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

2499

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

1996

2500

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

1997

2501

if null > 2:

1998

2502

os.close(null)

1999

else:

2000

# No console logging

2001

logger.removeHandler(console)

2002

2503

2003

2504

# Need to fork before connecting to D-Bus

2004

if not debug:

2505

if not foreground:

2005

2506

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

2006

2507

daemon()

2007

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

2008

2513

global main_loop

2009

2514

# From the Avahi example code

2010

DBusGMainLoop(set_as_default=True )

2515

DBusGMainLoop(set_as_default=True)

2011

2516

main_loop = gobject.MainLoop()

2012

2517

bus = dbus.SystemBus()

2013

2518

# End of Avahi example code

2019

2524

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

2020

2525

do_not_queue=True))

2021

2526

except dbus.exceptions.NameExistsException as e:

2022

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

2527

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

2023

2528

use_dbus = False

2024

2529

server_settings["use_dbus"] = False

2025

2530

tcp_server.use_dbus = False

2026

2531

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2027

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

2028

servicetype = "_mandos._tcp",

2029

protocol = protocol, bus = bus)

2532

service = AvahiServiceToSyslog(name =

2533

server_settings["servicename"],

2534

servicetype = "_mandos._tcp",

2535

protocol = protocol, bus = bus)

2030

2536

if server_settings["interface"]:

2031

2537

service.interface = (if_nametoindex

2032

2538

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

2036

2542

2037

2543

client_class = Client

2038

2544

if use_dbus:

2039

client_class = functools.partial(ClientDBusTransitional,

2040

bus = bus)

2041

def client_config_items(config, section):

2042

special_settings = {

2043

"approved_by_default":

2044

lambda: config.getboolean(section,

2045

"approved_by_default"),

2046

}

2047

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

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

2048

2628

try:

2049

yield (name, special_settings[name]())

2050

except KeyError:

2051

yield (name, value)

2052

2053

tcp_server.clients.update(set(

2054

client_class(name = section,

2055

config= dict(client_config_items(

2056

client_config, section)))

2057

for section in client_config.sections()))

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

2058

2654

if not tcp_server.clients:

2059

2655

logger.warning("No clients defined")

2060

2061

if not debug:

2062

try:

2063

with pidfile:

2064

pid = os.getpid()

2065

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

2066

del pidfile

2067

except IOError:

2068

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

2069

pidfilename, pid)

2070

except NameError:

2071

# "pidfile" was never created

2072

pass

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

2073

2667

del pidfilename

2074

2075

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

2076

2668

2077

2669

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

2078

2670

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

2079

2671

2080

2672

if use_dbus:

2081

class MandosDBusService(dbus.service.Object):

2673

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

2674

"se.bsnet.fukt.Mandos"})

2675

class MandosDBusService(DBusObjectWithProperties):

2082

2676

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

2083

2677

def __init__(self):

2084

2678

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

2085

2679

_interface = "se.recompile.Mandos"

2086

2680

2681

@dbus_interface_annotations(_interface)

2682

def _foo(self):

2683

return { "org.freedesktop.DBus.Property"

2684

".EmitsChangedSignal":

2685

"false"}

2686

2087

2687

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

2088

2688

def ClientAdded(self, objpath):

2089

2689

"D-Bus signal"

2103

2703

def GetAllClients(self):

2104

2704

"D-Bus method"

2105

2705

return dbus.Array(c.dbus_object_path

2106

for c in tcp_server.clients)

2706

for c in

2707

tcp_server.clients.itervalues())

2107

2708

2108

2709

@dbus.service.method(_interface,

2109

2710

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

2111

2712

"D-Bus method"

2112

2713

return dbus.Dictionary(

2113

2714

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

2114

for c in tcp_server.clients),

2715

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

2115

2716

signature="oa{sv}")

2116

2717

2117

2718

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

2118

2719

def RemoveClient(self, object_path):

2119

2720

"D-Bus method"

2120

for c in tcp_server.clients:

2721

for c in tcp_server.clients.itervalues():

2121

2722

if c.dbus_object_path == object_path:

2122

tcp_server.clients.remove(c)

2723

del tcp_server.clients[c.name]

2123

2724

c.remove_from_connection()

2124

2725

# Don't signal anything except ClientRemoved

2125

2726

c.disable(quiet=True)

2130

2731

2131

2732

del _interface

2132

2733

2133

class MandosDBusServiceTransitional(MandosDBusService):

2134

__metaclass__ = AlternateDBusNamesMetaclass

2135

mandos_dbus_service = MandosDBusServiceTransitional()

2734

mandos_dbus_service = MandosDBusService()

2136

2735

2137

2736

def cleanup():

2138

2737

"Cleanup function; run on exit"

2139

2738

service.cleanup()

2140

2739

2141

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

2142

2796

while tcp_server.clients:

2143

client = tcp_server.clients.pop()

2797

name, client = tcp_server.clients.popitem()

2144

2798

if use_dbus:

2145

2799

client.remove_from_connection()

2146

client.disable_hook = None

2147

2800

# Don't signal anything except ClientRemoved

2148

2801

client.disable(quiet=True)

2149

2802

if use_dbus:

2151

2804

mandos_dbus_service.ClientRemoved(client

2152

2805

.dbus_object_path,

2153

2806

client.name)

2807

client_settings.clear()

2154

2808

2155

2809

atexit.register(cleanup)

2156

2810

2157

for client in tcp_server.clients:

2811

for client in tcp_server.clients.itervalues():

2158

2812

if use_dbus:

2159

2813

# Emit D-Bus signal

2160

2814

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2161

client.enable()

2815

# Need to initiate checking of clients

2816

if client.enabled:

2817

client.init_checker()

2162

2818

2163

2819

tcp_server.enable()

2164

2820

tcp_server.server_activate()

2167

2823

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

2168

2824

if use_ipv6:

2169

2825

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

2170

" flowinfo %d, scope_id %d"

2171

% tcp_server.socket.getsockname())

2826

" flowinfo %d, scope_id %d",

2827

*tcp_server.socket.getsockname())

2172

2828

else: # IPv4

2173

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

2174

% tcp_server.socket.getsockname())

2829

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

2830

*tcp_server.socket.getsockname())

2175

2831

2176

2832

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

2177

2833

2180

2836

try:

2181

2837

service.activate()

2182

2838

except dbus.exceptions.DBusException as error:

2183

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

2839

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

2184

2840

cleanup()

2185

2841

sys.exit(1)

2186

2842

# End of Avahi example code

2193

2849

logger.debug("Starting main loop")

2194

2850

main_loop.run()

2195

2851

except AvahiError as error:

2196

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

2852

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

2197

2853

cleanup()

2198

2854

sys.exit(1)

2199

2855

except KeyboardInterrupt:

2204

2860

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

2205

2861

cleanup()

2206

2862

2207

2208

2863

if __name__ == '__main__':

2209

2864

main()