/mandos/release : revision 237.7.332

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

38

43

import socket

39

44

import argparse

40

45

import datetime

45

50

import gnutls.library.functions

46

51

import gnutls.library.constants

47

52

import gnutls.library.types

48

import ConfigParser as configparser

53

try:

54

import ConfigParser as configparser

55

except ImportError:

56

import configparser

49

57

import sys

50

58

import re

51

59

import os

60

68

import struct

61

69

import fcntl

62

70

import functools

63

import cPickle as pickle

71

try:

72

import cPickle as pickle

73

except ImportError:

74

import pickle

64

75

import multiprocessing

65

76

import types

66

77

import binascii

67

78

import tempfile

79

import itertools

80

import collections

81

import codecs

68

82

69

83

import dbus

70

84

import dbus.service

71

import gobject

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

72

89

import avahi

73

90

from dbus.mainloop.glib import DBusGMainLoop

74

91

import ctypes

75

92

import ctypes.util

76

93

import xml.dom.minidom

77

94

import inspect

78

import GnuPGInterface

79

95

80

96

try:

81

97

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

101

except ImportError:

86

102

SO_BINDTODEVICE = None

87

103

88

version = "1.4.1"

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

89

108

stored_state_file = "clients.pickle"

90

109

91

110

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

111

syslogger = None

95

112

96

113

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

114

if_nametoindex = ctypes.cdll.LoadLibrary(

115

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

100

116

except (OSError, AttributeError):

117

101

118

def if_nametoindex(interface):

102

119

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

103

120

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

104

121

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

105

122

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

123

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

124

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

110

125

return interface_index

111

126

112

127

113

128

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

114

129

"""init logger and add loglevel"""

115

130

131

global syslogger

132

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

116

135

syslogger.setFormatter(logging.Formatter

117

136

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

118

137

' %(message)s'))

135

154

136

155

class PGPEngine(object):

137

156

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

157

138

158

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

159

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

self.gnupg.options.extra_args.extend(['--force-mdc',

145

'--quiet'])

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

146

165

147

166

def __enter__(self):

148

167

return self

149

168

150

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

169

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

151

170

self._cleanup()

152

171

return False

153

172

170

189

def password_encode(self, password):

171

190

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

172

191

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

173

return b"mandos" + binascii.hexlify(password)

192

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

193

if len(encoded) > 2048:

194

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

195

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

196

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

197

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

198

return encoded

174

199

175

200

def encrypt(self, data, password):

176

self.gnupg.passphrase = self.password_encode(password)

177

with open(os.devnull) as devnull:

178

try:

179

proc = self.gnupg.run(['--symmetric'],

180

create_fhs=['stdin', 'stdout'],

181

attach_fhs={'stderr': devnull})

182

with contextlib.closing(proc.handles['stdin']) as f:

183

f.write(data)

184

with contextlib.closing(proc.handles['stdout']) as f:

185

ciphertext = f.read()

186

proc.wait()

187

except IOError as e:

188

raise PGPError(e)

189

self.gnupg.passphrase = None

201

passphrase = self.password_encode(password)

202

with tempfile.NamedTemporaryFile(

203

dir=self.tempdir) as passfile:

204

passfile.write(passphrase)

205

passfile.flush()

206

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

207

'--passphrase-file',

208

passfile.name]

209

+ self.gnupgargs,

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

214

if proc.returncode != 0:

215

raise PGPError(err)

190

216

return ciphertext

191

217

192

218

def decrypt(self, data, password):

193

self.gnupg.passphrase = self.password_encode(password)

194

with open(os.devnull) as devnull:

195

try:

196

proc = self.gnupg.run(['--decrypt'],

197

create_fhs=['stdin', 'stdout'],

198

attach_fhs={'stderr': devnull})

199

with contextlib.closing(proc.handles['stdin'] ) as f:

200

f.write(data)

201

with contextlib.closing(proc.handles['stdout']) as f:

202

decrypted_plaintext = f.read()

203

proc.wait()

204

except IOError as e:

205

raise PGPError(e)

206

self.gnupg.passphrase = None

219

passphrase = self.password_encode(password)

220

with tempfile.NamedTemporaryFile(

221

dir = self.tempdir) as passfile:

222

passfile.write(passphrase)

223

passfile.flush()

224

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

225

'--passphrase-file',

226

passfile.name]

227

+ self.gnupgargs,

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

232

if proc.returncode != 0:

233

raise PGPError(err)

207

234

return decrypted_plaintext

208

235

209

236

210

211

237

class AvahiError(Exception):

212

238

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

213

239

self.value = value

214

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

215

def __unicode__(self):

216

return unicode(repr(self.value))

240

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

241

**kwargs)

242

217

243

218

244

class AvahiServiceError(AvahiError):

219

245

pass

220

246

247

221

248

class AvahiGroupError(AvahiError):

222

249

pass

223

250

230

257

Used to optionally bind to the specified interface.

231

258

name: string; Example: 'Mandos'

232

259

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

233

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

260

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

234

261

port: integer; what port to announce

235

262

TXT: list of strings; TXT record for the service

236

263

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

242

269

server: D-Bus Server

243

270

bus: dbus.SystemBus()

244

271

"""

245

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

246

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

247

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

248

protocol = avahi.PROTO_UNSPEC, bus = None):

272

273

def __init__(self,

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

249

284

self.interface = interface

250

285

self.name = name

251

286

self.type = servicetype

260

295

self.server = None

261

296

self.bus = bus

262

297

self.entry_group_state_changed_match = None

263

def rename(self):

298

299

def rename(self, remove=True):

264

300

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

265

301

if self.rename_count >= self.max_renames:

266

302

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

267

303

" after %i retries, exiting.",

268

304

self.rename_count)

269

305

raise AvahiServiceError("Too many renames")

270

self.name = unicode(self.server

271

.GetAlternativeServiceName(self.name))

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

272

309

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

273

310

self.name)

274

self.remove()

311

if remove:

312

self.remove()

275

313

try:

276

314

self.add()

277

315

except dbus.exceptions.DBusException as error:

278

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

279

self.cleanup()

280

os._exit(1)

281

self.rename_count += 1

316

if (error.get_dbus_name()

317

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

318

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

319

return self.rename(remove=False)

320

else:

321

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

322

self.cleanup()

323

os._exit(1)

324

282

325

def remove(self):

283

326

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

284

327

if self.entry_group_state_changed_match is not None:

286

329

self.entry_group_state_changed_match = None

287

330

if self.group is not None:

288

331

self.group.Reset()

332

289

333

def add(self):

290

334

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

291

335

self.remove()

308

352

dbus.UInt16(self.port),

309

353

avahi.string_array_to_txt_array(self.TXT))

310

354

self.group.Commit()

355

311

356

def entry_group_state_changed(self, state, error):

312

357

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

313

358

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

319

364

self.rename()

320

365

elif state == avahi.ENTRY_GROUP_FAILURE:

321

366

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

322

unicode(error))

323

raise AvahiGroupError("State changed: %s"

324

% unicode(error))

367

str(error))

368

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

369

325

370

def cleanup(self):

326

371

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

327

372

if self.group is not None:

332

377

pass

333

378

self.group = None

334

379

self.remove()

380

335

381

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

336

382

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

337

383

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

338

bad_states = { avahi.SERVER_INVALID:

339

"Zeroconf server invalid",

340

avahi.SERVER_REGISTERING: None,

341

avahi.SERVER_COLLISION:

342

"Zeroconf server name collision",

343

avahi.SERVER_FAILURE:

344

"Zeroconf server failure" }

384

bad_states = {

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

386

avahi.SERVER_REGISTERING: None,

387

avahi.SERVER_COLLISION: "Zeroconf server name collision",

388

avahi.SERVER_FAILURE: "Zeroconf server failure",

389

}

345

390

if state in bad_states:

346

391

if bad_states[state] is not None:

347

392

if error is None:

350

395

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

351

396

self.cleanup()

352

397

elif state == avahi.SERVER_RUNNING:

353

self.add()

398

try:

399

self.add()

400

except dbus.exceptions.DBusException as error:

401

if (error.get_dbus_name()

402

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

403

logger.info("Local Zeroconf service name"

404

" collision.")

405

return self.rename(remove=False)

406

else:

407

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

408

self.cleanup()

409

os._exit(1)

354

410

else:

355

411

if error is None:

356

412

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

357

413

else:

358

414

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

415

359

416

def activate(self):

360

417

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

361

418

if self.server is None:

365

422

follow_name_owner_changes=True),

366

423

avahi.DBUS_INTERFACE_SERVER)

367

424

self.server.connect_to_signal("StateChanged",

368

self.server_state_changed)

425

self.server_state_changed)

369

426

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

370

427

428

371

429

class AvahiServiceToSyslog(AvahiService):

372

def rename(self):

430

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

373

431

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

374

ret = AvahiService.rename(self)

375

syslogger.setFormatter(logging.Formatter

376

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

377

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

378

% self.name))

432

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

433

syslogger.setFormatter(logging.Formatter(

434

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

435

.format(self.name)))

379

436

return ret

380

437

381

def timedelta_to_milliseconds(td):

382

"Convert a datetime.timedelta() to milliseconds"

383

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

384

+ (td.seconds * 1000)

385

+ (td.microseconds // 1000))

386

438

def call_pipe(connection, # : multiprocessing.Connection

439

func, *args, **kwargs):

440

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

441

442

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

443

return value on the provided multiprocessing.Connection.

444

"""

445

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

446

connection.close()

447

387

448

class Client(object):

388

449

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

389

450

414

475

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

415

476

last_checker_status: integer between 0 and 255 reflecting exit

416

477

status of last checker. -1 reflects crashed

417

checker, or None.

478

checker, -2 means no checker completed yet.

479

last_checker_signal: The signal which killed the last checker, if

480

last_checker_status is -1

418

481

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

419

482

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

420

483

D-Bus identifiers

421

484

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

422

485

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

423

486

until this client is disabled

424

extended_timeout: extra long timeout when password has been sent

487

extended_timeout: extra long timeout when secret has been sent

425

488

runtime_expansions: Allowed attributes for runtime expansion.

426

489

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

427

490

disabled, or None

491

server_settings: The server_settings dict from main()

428

492

"""

429

493

430

494

runtime_expansions = ("approval_delay", "approval_duration",

431

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

432

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

495

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

496

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

497

"last_approval_request", "last_checked_ok",

433

498

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

434

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

435

"extended_timeout": "15m",

436

"interval": "2m",

437

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

438

"host": "",

439

"approval_delay": "0s",

440

"approval_duration": "1s",

441

"approved_by_default": "True",

442

"enabled": "True",

443

}

444

445

def timeout_milliseconds(self):

446

"Return the 'timeout' attribute in milliseconds"

447

return timedelta_to_milliseconds(self.timeout)

448

449

def extended_timeout_milliseconds(self):

450

"Return the 'extended_timeout' attribute in milliseconds"

451

return timedelta_to_milliseconds(self.extended_timeout)

452

453

def interval_milliseconds(self):

454

"Return the 'interval' attribute in milliseconds"

455

return timedelta_to_milliseconds(self.interval)

456

457

def approval_delay_milliseconds(self):

458

return timedelta_to_milliseconds(self.approval_delay)

459

499

client_defaults = {

500

"timeout": "PT5M",

501

"extended_timeout": "PT15M",

502

"interval": "PT2M",

503

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

504

"host": "",

505

"approval_delay": "PT0S",

506

"approval_duration": "PT1S",

507

"approved_by_default": "True",

508

"enabled": "True",

509

}

510

460

511

@staticmethod

461

512

def config_parser(config):

462

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

513

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

463

514

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

464

with exceptions for any special settings as defined above"""

515

with exceptions for any special settings as defined above.

516

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

517

value given the same arguments.

518

"""

465

519

settings = {}

466

520

for client_name in config.sections():

467

521

section = dict(config.items(client_name))

471

525

# Reformat values from string types to Python types

472

526

client["approved_by_default"] = config.getboolean(

473

527

client_name, "approved_by_default")

474

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

528

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

529

"enabled")

475

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

476

534

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

477

535

.replace(" ", ""))

478

536

if "secret" in section:

483

541

"rb") as secfile:

484

542

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

485

543

else:

486

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

487

% section)

544

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

545

.format(section))

488

546

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

489

547

client["extended_timeout"] = string_to_delta(

490

548

section["extended_timeout"])

496

554

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

497

555

client["last_approval_request"] = None

498

556

client["last_checked_ok"] = None

499

client["last_checker_status"] = None

500

if client["enabled"]:

501

client["last_enabled"] = datetime.datetime.utcnow()

502

client["expires"] = (datetime.datetime.utcnow()

503

+ client["timeout"])

504

else:

505

client["last_enabled"] = None

506

client["expires"] = None

507

557

client["last_checker_status"] = -2

558

508

559

return settings

509

510

511

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

512

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

513

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

514

attribute."""

560

561

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

515

562

self.name = name

563

if server_settings is None:

564

server_settings = {}

565

self.server_settings = server_settings

516

566

# adding all client settings

517

for setting, value in settings.iteritems():

567

for setting, value in settings.items():

518

568

setattr(self, setting, value)

519

569

570

if self.enabled:

571

if not hasattr(self, "last_enabled"):

572

self.last_enabled = datetime.datetime.utcnow()

573

if not hasattr(self, "expires"):

574

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

575

+ self.timeout)

576

else:

577

self.last_enabled = None

578

self.expires = None

579

520

580

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

521

# Uppercase and remove spaces from fingerprint for later

522

# comparison purposes with return value from the fingerprint()

523

# function

524

581

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

525

self.created = settings.get("created", datetime.datetime.utcnow())

526

582

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

583

datetime.datetime.utcnow())

584

527

585

# attributes specific for this server instance

528

586

self.checker = None

529

587

self.checker_initiator_tag = None

532

590

self.current_checker_command = None

533

591

self.approved = None

534

592

self.approvals_pending = 0

535

self.changedstate = (multiprocessing_manager

536

.Condition(multiprocessing_manager

537

.Lock()))

538

self.client_structure = [attr for attr in

539

self.__dict__.iterkeys()

593

self.changedstate = multiprocessing_manager.Condition(

594

multiprocessing_manager.Lock())

595

self.client_structure = [attr

596

for attr in self.__dict__.iterkeys()

540

597

if not attr.startswith("_")]

541

598

self.client_structure.append("client_structure")

542

599

543

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

544

lambda obj:

545

isinstance(obj,

546

property)):

600

for name, t in inspect.getmembers(

601

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

547

602

if not name.startswith("_"):

548

603

self.client_structure.append(name)

549

604

557

612

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

558

613

# Already enabled

559

614

return

560

self.send_changedstate()

561

615

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

562

616

self.enabled = True

563

617

self.last_enabled = datetime.datetime.utcnow()

564

618

self.init_checker()

619

self.send_changedstate()

565

620

566

621

def disable(self, quiet=True):

567

622

"""Disable this client."""

568

623

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

569

624

return False

570

625

if not quiet:

571

self.send_changedstate()

572

if not quiet:

573

626

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

574

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

627

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

575

628

gobject.source_remove(self.disable_initiator_tag)

576

629

self.disable_initiator_tag = None

577

630

self.expires = None

578

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

631

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

579

632

gobject.source_remove(self.checker_initiator_tag)

580

633

self.checker_initiator_tag = None

581

634

self.stop_checker()

582

635

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

583

638

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

584

639

return False

585

640

589

644

def init_checker(self):

590

645

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

591

646

# and every interval from then on.

592

self.checker_initiator_tag = (gobject.timeout_add

593

(self.interval_milliseconds(),

594

self.start_checker))

647

if self.checker_initiator_tag is not None:

648

gobject.source_remove(self.checker_initiator_tag)

649

self.checker_initiator_tag = gobject.timeout_add(

650

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

651

self.start_checker)

595

652

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

596

self.disable_initiator_tag = (gobject.timeout_add

597

(self.timeout_milliseconds(),

598

self.disable))

653

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = gobject.timeout_add(

656

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

599

657

# Also start a new checker *right now*.

600

658

self.start_checker()

601

659

602

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

660

def checker_callback(self, source, condition, connection,

661

command):

603

662

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

604

663

self.checker_callback_tag = None

605

664

self.checker = None

606

if os.WIFEXITED(condition):

607

self.last_checker_status = os.WEXITSTATUS(condition)

665

# Read return code from connection (see call_pipe)

666

returncode = connection.recv()

667

connection.close()

668

669

if returncode >= 0:

670

self.last_checker_status = returncode

671

self.last_checker_signal = None

608

672

if self.last_checker_status == 0:

609

673

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

610

674

vars(self))

611

675

self.checked_ok()

612

676

else:

613

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

614

vars(self))

677

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

615

678

else:

616

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

617

681

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

618

682

vars(self))

619

620

def checked_ok(self, timeout=None):

621

"""Bump up the timeout for this client.

622

623

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

624

alive and well.

625

"""

683

return False

684

685

def checked_ok(self):

686

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

687

self.last_checked_ok = datetime.datetime.utcnow()

688

self.last_checker_status = 0

689

self.last_checker_signal = None

690

self.bump_timeout()

691

692

def bump_timeout(self, timeout=None):

693

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

626

694

if timeout is None:

627

695

timeout = self.timeout

628

self.last_checked_ok = datetime.datetime.utcnow()

629

696

if self.disable_initiator_tag is not None:

630

697

gobject.source_remove(self.disable_initiator_tag)

698

self.disable_initiator_tag = None

631

699

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

632

self.disable_initiator_tag = (gobject.timeout_add

633

(timedelta_to_milliseconds

634

(timeout), self.disable))

700

self.disable_initiator_tag = gobject.timeout_add(

701

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

635

702

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

636

703

637

704

def need_approval(self):

643

710

If a checker already exists, leave it running and do

644

711

nothing."""

645

712

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

646

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

647

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

648

# client would inevitably timeout, since no checker would get

649

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

713

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

714

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

715

# would inevitably timeout, since no checker would get a

716

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

650

717

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

651

718

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

652

719

# should be.

653

720

654

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

655

try:

656

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

657

except (AttributeError, OSError) as error:

658

if (isinstance(error, OSError)

659

and error.errno != errno.ECHILD):

660

raise error

661

else:

662

if pid:

663

logger.warning("Checker was a zombie")

664

gobject.source_remove(self.checker_callback_tag)

665

self.checker_callback(pid, status,

666

self.current_checker_command)

721

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

722

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

723

self.checker.join()

724

self.checker = None

667

725

# Start a new checker if needed

668

726

if self.checker is None:

727

# Escape attributes for the shell

728

escaped_attrs = {

729

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

730

for attr in self.runtime_expansions }

669

731

try:

670

# In case checker_command has exactly one % operator

671

command = self.checker_command % self.host

672

except TypeError:

673

# Escape attributes for the shell

674

escaped_attrs = dict(

675

(attr,

676

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

677

errors=

678

'replace')))

679

for attr in

680

self.runtime_expansions)

681

682

try:

683

command = self.checker_command % escaped_attrs

684

except TypeError as error:

685

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

686

' %s', self.checker_command, error)

687

return True # Try again later

732

command = self.checker_command % escaped_attrs

733

except TypeError as error:

734

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

735

self.checker_command,

736

exc_info=error)

737

return True # Try again later

688

738

self.current_checker_command = command

689

try:

690

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

691

command, self.name)

692

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

693

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

694

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

695

# always replaced by /dev/null.)

696

self.checker = subprocess.Popen(command,

697

close_fds=True,

698

shell=True, cwd="/")

699

self.checker_callback_tag = (gobject.child_watch_add

700

(self.checker.pid,

701

self.checker_callback,

702

data=command))

703

# The checker may have completed before the gobject

704

# watch was added. Check for this.

705

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

706

if pid:

707

gobject.source_remove(self.checker_callback_tag)

708

self.checker_callback(pid, status, command)

709

except OSError as error:

710

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

711

error)

739

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

740

self.name)

741

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

742

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

743

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

744

# always replaced by /dev/null.)

745

# The exception is when not debugging but nevertheless

746

# running in the foreground; use the previously

747

# created wnull.

748

popen_args = { "close_fds": True,

749

"shell": True,

750

"cwd": "/" }

751

if (not self.server_settings["debug"]

752

and self.server_settings["foreground"]):

753

popen_args.update({"stdout": wnull,

754

"stderr": wnull })

755

pipe = multiprocessing.Pipe(duplex = False)

756

self.checker = multiprocessing.Process(

757

target = call_pipe,

758

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

759

kwargs = popen_args)

760

self.checker.start()

761

self.checker_callback_tag = gobject.io_add_watch(

762

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

763

self.checker_callback, pipe[0], command)

712

764

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

713

765

return True

714

766

720

772

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

721

773

return

722

774

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

723

try:

724

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

725

#time.sleep(0.5)

726

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

727

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

728

except OSError as error:

729

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

730

raise

775

self.checker.terminate()

731

776

self.checker = None

732

777

733

778

734

def dbus_service_property(dbus_interface, signature="v",

735

access="readwrite", byte_arrays=False):

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

736

783

"""Decorators for marking methods of a DBusObjectWithProperties to

737

784

become properties on the D-Bus.

738

785

747

794

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

748

795

if byte_arrays and signature != "ay":

749

796

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

750

" signature %r" % signature)

797

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

798

751

799

def decorator(func):

752

800

func._dbus_is_property = True

753

801

func._dbus_interface = dbus_interface

758

806

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

759

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

760

808

return func

809

810

return decorator

811

812

813

def dbus_interface_annotations(dbus_interface):

814

"""Decorator for marking functions returning interface annotations

815

816

Usage:

817

818

@dbus_interface_annotations("org.example.Interface")

819

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

820

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

821

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

822

"false"}

823

"""

824

825

def decorator(func):

826

func._dbus_is_interface = True

827

func._dbus_interface = dbus_interface

828

func._dbus_name = dbus_interface

829

return func

830

831

return decorator

832

833

834

def dbus_annotations(annotations):

835

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

836

Usage:

837

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

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

842

access="r")

843

def Property_dbus_property(self):

844

return dbus.Boolean(False)

845

846

See also the DBusObjectWithAnnotations class.

847

"""

848

849

def decorator(func):

850

func._dbus_annotations = annotations

851

return func

852

761

853

return decorator

762

854

763

855

764

856

class DBusPropertyException(dbus.exceptions.DBusException):

765

857

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

766

858

"""

767

def __unicode__(self):

768

return unicode(str(self))

859

pass

769

860

770

861

771

862

class DBusPropertyAccessException(DBusPropertyException):

780

871

pass

781

872

782

873

783

class DBusObjectWithProperties(dbus.service.Object):

874

class DBusObjectWithAnnotations(dbus.service.Object):

875

"""A D-Bus object with annotations.

876

877

Classes inheriting from this can use the dbus_annotations

878

decorator to add annotations to methods or signals.

879

"""

880

881

@staticmethod

882

def _is_dbus_thing(thing):

883

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

884

885

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

886

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

887

"""

888

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

889

False)

890

891

def _get_all_dbus_things(self, thing):

892

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

893

"""

894

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

895

athing.__get__(self))

896

for cls in self.__class__.__mro__

897

for name, athing in

898

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

899

900

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

901

out_signature = "s",

902

path_keyword = 'object_path',

903

connection_keyword = 'connection')

904

def Introspect(self, object_path, connection):

905

"""Overloading of standard D-Bus method.

906

907

Inserts annotation tags on methods and signals.

908

"""

909

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

910

connection)

911

try:

912

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

913

914

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

915

# Add annotation tags

916

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

917

for tag in if_tag.getElementsByTagName(typ):

918

annots = dict()

919

for name, prop in (self.

920

_get_all_dbus_things(typ)):

921

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

922

and prop._dbus_interface

923

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

924

annots.update(getattr(

925

prop, "_dbus_annotations", {}))

926

for name, value in annots.items():

927

ann_tag = document.createElement(

928

"annotation")

929

ann_tag.setAttribute("name", name)

930

ann_tag.setAttribute("value", value)

931

tag.appendChild(ann_tag)

932

# Add interface annotation tags

933

for annotation, value in dict(

934

itertools.chain.from_iterable(

935

annotations().items()

936

for name, annotations

937

in self._get_all_dbus_things("interface")

938

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

939

)).items():

940

ann_tag = document.createElement("annotation")

941

ann_tag.setAttribute("name", annotation)

942

ann_tag.setAttribute("value", value)

943

if_tag.appendChild(ann_tag)

944

# Fix argument name for the Introspect method itself

945

if (if_tag.getAttribute("name")

946

== dbus.INTROSPECTABLE_IFACE):

947

for cn in if_tag.getElementsByTagName("method"):

948

if cn.getAttribute("name") == "Introspect":

949

for arg in cn.getElementsByTagName("arg"):

950

if (arg.getAttribute("direction")

951

== "out"):

952

arg.setAttribute("name",

953

"xml_data")

954

xmlstring = document.toxml("utf-8")

955

document.unlink()

956

except (AttributeError, xml.dom.DOMException,

957

xml.parsers.expat.ExpatError) as error:

958

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

959

exc_info=error)

960

return xmlstring

961

962

963

class DBusObjectWithProperties(DBusObjectWithAnnotations):

784

964

"""A D-Bus object with properties.

785

965

786

966

Classes inheriting from this can use the dbus_service_property

788

968

standard Get(), Set(), and GetAll() methods on the D-Bus.

789

969

"""

790

970

791

@staticmethod

792

def _is_dbus_property(obj):

793

return getattr(obj, "_dbus_is_property", False)

794

795

def _get_all_dbus_properties(self):

796

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

797

"""

798

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

799

for cls in self.__class__.__mro__

800

for name, prop in

801

inspect.getmembers(cls, self._is_dbus_property))

802

803

971

def _get_dbus_property(self, interface_name, property_name):

804

972

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

805

973

property with the specified name and interface.

806

974

"""

807

for cls in self.__class__.__mro__:

808

for name, value in (inspect.getmembers

809

(cls, self._is_dbus_property)):

975

for cls in self.__class__.__mro__:

976

for name, value in inspect.getmembers(

977

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

810

978

if (value._dbus_name == property_name

811

979

and value._dbus_interface == interface_name):

812

980

return value.__get__(self)

813

981

814

982

# No such property

815

raise DBusPropertyNotFound(self.dbus_object_path + ":"

816

+ interface_name + "."

817

+ property_name)

983

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

984

self.dbus_object_path, interface_name, property_name))

818

985

819

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

986

@dbus.service.method(dbus.PROPERTIES_IFACE,

987

in_signature="ss",

820

988

out_signature="v")

821

989

def Get(self, interface_name, property_name):

822

990

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

840

1008

# The byte_arrays option is not supported yet on

841

1009

# signatures other than "ay".

842

1010

if prop._dbus_signature != "ay":

843

raise ValueError

844

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

845

for byte in value))

1011

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

1012

"'ay' signature {!r}"

1013

.format(prop._dbus_signature))

1014

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

1015

for byte in value))

846

1016

prop(value)

847

1017

848

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

1018

@dbus.service.method(dbus.PROPERTIES_IFACE,

1019

in_signature="s",

849

1020

out_signature="a{sv}")

850

1021

def GetAll(self, interface_name):

851

1022

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

854

1025

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

855

1026

"""

856

1027

properties = {}

857

for name, prop in self._get_all_dbus_properties():

1028

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

858

1029

if (interface_name

859

1030

and interface_name != prop._dbus_interface):

860

1031

# Interface non-empty but did not match

866

1037

if not hasattr(value, "variant_level"):

867

1038

properties[name] = value

868

1039

continue

869

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

870

value.variant_level+1)

1040

properties[name] = type(value)(

1041

value, variant_level = value.variant_level + 1)

871

1042

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

872

1043

1044

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

1045

def PropertiesChanged(self, interface_name, changed_properties,

1046

invalidated_properties):

1047

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

1048

standard.

1049

"""

1050

pass

1051

873

1052

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

874

1053

out_signature="s",

875

1054

path_keyword='object_path',

876

1055

connection_keyword='connection')

877

1056

def Introspect(self, object_path, connection):

878

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

1057

"""Overloading of standard D-Bus method.

1058

1059

Inserts property tags and interface annotation tags.

879

1060

"""

880

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

881

connection)

1061

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1062

object_path,

1063

connection)

882

1064

try:

883

1065

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

1066

884

1067

def make_tag(document, name, prop):

885

1068

e = document.createElement("property")

886

1069

e.setAttribute("name", name)

887

1070

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

888

1071

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

889

1072

return e

1073

890

1074

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

1075

# Add property tags

891

1076

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

892

1077

for name, prop

893

in self._get_all_dbus_properties()

1078

in self._get_all_dbus_things("property")

894

1079

if prop._dbus_interface

895

1080

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

896

1081

if_tag.appendChild(tag)

1082

# Add annotation tags for properties

1083

for tag in if_tag.getElementsByTagName("property"):

1084

annots = dict()

1085

for name, prop in self._get_all_dbus_things(

1086

"property"):

1087

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

1088

and prop._dbus_interface

1089

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

1090

annots.update(getattr(

1091

prop, "_dbus_annotations", {}))

1092

for name, value in annots.items():

1093

ann_tag = document.createElement(

1094

"annotation")

1095

ann_tag.setAttribute("name", name)

1096

ann_tag.setAttribute("value", value)

1097

tag.appendChild(ann_tag)

897

1098

# Add the names to the return values for the

898

1099

# "org.freedesktop.DBus.Properties" methods

899

1100

if (if_tag.getAttribute("name")

914

1115

except (AttributeError, xml.dom.DOMException,

915

1116

xml.parsers.expat.ExpatError) as error:

916

1117

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

917

error)

1118

exc_info=error)

918

1119

return xmlstring

919

1120

920

1121

921

def datetime_to_dbus (dt, variant_level=0):

1122

def datetime_to_dbus(dt, variant_level=0):

922

1123

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

923

1124

if dt is None:

924

1125

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

925

return dbus.String(dt.isoformat(),

926

variant_level=variant_level)

927

928

929

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

930

.__metaclass__):

931

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

932

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

1126

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

1127

1128

1129

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1130

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

1131

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

1132

interface names according to the "alt_interface_names" mapping.

1133

Usage:

1134

1135

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

1136

"net.example.AlternateInterface"})

1137

class SampleDBusObject(dbus.service.Object):

1138

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

1139

def SampleDBusMethod():

1140

pass

1141

1142

The above "SampleDBusMethod" on "SampleDBusObject" will be

1143

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

1144

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

1145

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

1146

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

1147

1148

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

1149

(from DBusObjectWithProperties) and interfaces (from the

1150

dbus_interface_annotations decorator).

933

1151

"""

934

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

935

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

936

# methods, signals, or properties in them

937

for base in (b for b in bases

938

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

939

# Go though all attributes of the base class

940

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

1152

1153

def wrapper(cls):

1154

for orig_interface_name, alt_interface_name in (

1155

alt_interface_names.items()):

1156

attr = {}

1157

interface_names = set()

1158

# Go though all attributes of the class

1159

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

941

1160

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

942

1161

# with the wrong interface name

943

1162

if (not hasattr(attribute, "_dbus_interface")

944

or not attribute._dbus_interface

945

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

1163

or not attribute._dbus_interface.startswith(

1164

orig_interface_name)):

946

1165

continue

947

1166

# Create an alternate D-Bus interface name based on

948

1167

# the current name

949

alt_interface = (attribute._dbus_interface

950

.replace("se.recompile.Mandos",

951

"se.bsnet.fukt.Mandos"))

1168

alt_interface = attribute._dbus_interface.replace(

1169

orig_interface_name, alt_interface_name)

1170

interface_names.add(alt_interface)

952

1171

# Is this a D-Bus signal?

953

1172

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

954

# Extract the original non-method function by

955

# black magic

956

nonmethod_func = (dict(

1173

if sys.version_info.major == 2:

1174

# Extract the original non-method undecorated

1175

# function by black magic

1176

nonmethod_func = (dict(

957

1177

zip(attribute.func_code.co_freevars,

958

attribute.__closure__))["func"]

959

.cell_contents)

1178

attribute.__closure__))

1179

["func"].cell_contents)

1180

else:

1181

nonmethod_func = attribute

960

1182

# Create a new, but exactly alike, function

961

1183

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

962

1184

# with the alternate D-Bus interface name

963

new_function = (dbus.service.signal

964

(alt_interface,

965

attribute._dbus_signature)

966

(types.FunctionType(

967

nonmethod_func.func_code,

968

nonmethod_func.func_globals,

969

nonmethod_func.func_name,

970

nonmethod_func.func_defaults,

971

nonmethod_func.func_closure)))

1185

if sys.version_info.major == 2:

1186

new_function = types.FunctionType(

1187

nonmethod_func.func_code,

1188

nonmethod_func.func_globals,

1189

nonmethod_func.func_name,

1190

nonmethod_func.func_defaults,

1191

nonmethod_func.func_closure)

1192

else:

1193

new_function = types.FunctionType(

1194

nonmethod_func.__code__,

1195

nonmethod_func.__globals__,

1196

nonmethod_func.__name__,

1197

nonmethod_func.__defaults__,

1198

nonmethod_func.__closure__)

1199

new_function = (dbus.service.signal(

1200

alt_interface,

1201

attribute._dbus_signature)(new_function))

1202

# Copy annotations, if any

1203

try:

1204

new_function._dbus_annotations = dict(

1205

attribute._dbus_annotations)

1206

except AttributeError:

1207

pass

972

1208

# Define a creator of a function to call both the

973

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

974

# signals gets sent when the function is called

1209

# original and alternate functions, so both the

1210

# original and alternate signals gets sent when

1211

# the function is called

975

1212

def fixscope(func1, func2):

976

1213

"""This function is a scope container to pass

977

1214

func1 and func2 to the "call_both" function

978

1215

outside of its arguments"""

1216

979

1217

def call_both(*args, **kwargs):

980

1218

"""This function will emit two D-Bus

981

1219

signals by calling func1 and func2"""

982

1220

func1(*args, **kwargs)

983

1221

func2(*args, **kwargs)

1222

984

1223

return call_both

985

1224

# Create the "call_both" function and add it to

986

1225

# the class

987

attr[attrname] = fixscope(attribute,

988

new_function)

1226

attr[attrname] = fixscope(attribute, new_function)

989

1227

# Is this a D-Bus method?

990

1228

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

991

1229

# Create a new, but exactly alike, function

992

1230

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

993

1231

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

994

1232

# to the class.

995

attr[attrname] = (dbus.service.method

996

(alt_interface,

997

attribute._dbus_in_signature,

998

attribute._dbus_out_signature)

999

(types.FunctionType

1000

(attribute.func_code,

1001

attribute.func_globals,

1002

attribute.func_name,

1003

attribute.func_defaults,

1004

attribute.func_closure)))

1233

attr[attrname] = (

1234

dbus.service.method(

1235

alt_interface,

1236

attribute._dbus_in_signature,

1237

attribute._dbus_out_signature)

1238

(types.FunctionType(attribute.func_code,

1239

attribute.func_globals,

1240

attribute.func_name,

1241

attribute.func_defaults,

1242

attribute.func_closure)))

1243

# Copy annotations, if any

1244

try:

1245

attr[attrname]._dbus_annotations = dict(

1246

attribute._dbus_annotations)

1247

except AttributeError:

1248

pass

1005

1249

# Is this a D-Bus property?

1006

1250

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

1007

1251

# Create a new, but exactly alike, function

1008

1252

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

1009

1253

# property with the alternate D-Bus interface

1010

1254

# name. Add it to the class.

1011

attr[attrname] = (dbus_service_property

1012

(alt_interface,

1013

attribute._dbus_signature,

1014

attribute._dbus_access,

1015

attribute

1016

._dbus_get_args_options

1017

["byte_arrays"])

1018

(types.FunctionType

1019

(attribute.func_code,

1020

attribute.func_globals,

1021

attribute.func_name,

1022

attribute.func_defaults,

1023

attribute.func_closure)))

1024

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

1025

1026

1255

attr[attrname] = (dbus_service_property(

1256

alt_interface, attribute._dbus_signature,

1257

attribute._dbus_access,

1258

attribute._dbus_get_args_options

1259

["byte_arrays"])

1260

(types.FunctionType(

1261

attribute.func_code,

1262

attribute.func_globals,

1263

attribute.func_name,

1264

attribute.func_defaults,

1265

attribute.func_closure)))

1266

# Copy annotations, if any

1267

try:

1268

attr[attrname]._dbus_annotations = dict(

1269

attribute._dbus_annotations)

1270

except AttributeError:

1271

pass

1272

# Is this a D-Bus interface?

1273

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

1274

# Create a new, but exactly alike, function

1275

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

1276

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

1277

# to the class.

1278

attr[attrname] = (

1279

dbus_interface_annotations(alt_interface)

1280

(types.FunctionType(attribute.func_code,

1281

attribute.func_globals,

1282

attribute.func_name,

1283

attribute.func_defaults,

1284

attribute.func_closure)))

1285

if deprecate:

1286

# Deprecate all alternate interfaces

1287

iname="_AlternateDBusNames_interface_annotation{}"

1288

for interface_name in interface_names:

1289

1290

@dbus_interface_annotations(interface_name)

1291

def func(self):

1292

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

1293

"true" }

1294

# Find an unused name

1295

for aname in (iname.format(i)

1296

for i in itertools.count()):

1297

if aname not in attr:

1298

attr[aname] = func

1299

break

1300

if interface_names:

1301

# Replace the class with a new subclass of it with

1302

# methods, signals, etc. as created above.

1303

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

1304

(cls, ), attr)

1305

return cls

1306

1307

return wrapper

1308

1309

1310

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

1311

"se.bsnet.fukt.Mandos"})

1027

1312

class ClientDBus(Client, DBusObjectWithProperties):

1028

1313

"""A Client class using D-Bus

1029

1314

1033

1318

"""

1034

1319

1035

1320

runtime_expansions = (Client.runtime_expansions

1036

+ ("dbus_object_path",))

1321

+ ("dbus_object_path", ))

1322

1323

_interface = "se.recompile.Mandos.Client"

1037

1324

1038

1325

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

1039

1326

1040

1327

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

1041

1328

self.bus = bus

1042

1329

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

1043

self._approvals_pending = 0

1044

1045

self._approvals_pending = 0

1046

1330

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

1047

1331

# the D-Bus

1048

client_object_name = unicode(self.name).translate(

1332

client_object_name = str(self.name).translate(

1049

1333

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

1050

1334

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

1051

self.dbus_object_path = (dbus.ObjectPath

1052

("/clients/" + client_object_name))

1335

self.dbus_object_path = dbus.ObjectPath(

1336

"/clients/" + client_object_name)

1053

1337

DBusObjectWithProperties.__init__(self, self.bus,

1054

1338

self.dbus_object_path)

1055

1056

def notifychangeproperty(transform_func,

1057

dbus_name, type_func=lambda x: x,

1058

variant_level=1):

1339

1340

def notifychangeproperty(transform_func, dbus_name,

1341

type_func=lambda x: x,

1342

variant_level=1,

1343

invalidate_only=False,

1344

_interface=_interface):

1059

1345

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

1060

1346

its changes to DBus.

1061

1347

1066

1352

to the D-Bus. Default: no transform

1067

1353

variant_level: D-Bus variant level. Default: 1

1068

1354

"""

1069

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

1355

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

1356

1070

1357

def setter(self, value):

1071

1358

if hasattr(self, "dbus_object_path"):

1072

1359

if (not hasattr(self, attrname) or

1073

1360

type_func(getattr(self, attrname, None))

1074

1361

!= type_func(value)):

1075

dbus_value = transform_func(type_func(value),

1076

variant_level

1077

=variant_level)

1078

self.PropertyChanged(dbus.String(dbus_name),

1079

dbus_value)

1362

if invalidate_only:

1363

self.PropertiesChanged(

1364

_interface, dbus.Dictionary(),

1365

dbus.Array((dbus_name, )))

1366

else:

1367

dbus_value = transform_func(

1368

type_func(value),

1369

variant_level = variant_level)

1370

self.PropertyChanged(dbus.String(dbus_name),

1371

dbus_value)

1372

self.PropertiesChanged(

1373

_interface,

1374

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

1375

dbus_value }),

1376

dbus.Array())

1080

1377

setattr(self, attrname, value)

1081

1378

1082

1379

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

1083

1380

1084

1085

1381

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1086

1382

approvals_pending = notifychangeproperty(dbus.Boolean,

1087

1383

"ApprovalPending",

1089

1385

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

1090

1386

last_enabled = notifychangeproperty(datetime_to_dbus,

1091

1387

"LastEnabled")

1092

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

1093

type_func = lambda checker:

1094

checker is not None)

1388

checker = notifychangeproperty(

1389

dbus.Boolean, "CheckerRunning",

1390

type_func = lambda checker: checker is not None)

1095

1391

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1096

1392

"LastCheckedOK")

1393

last_checker_status = notifychangeproperty(dbus.Int16,

1394

"LastCheckerStatus")

1097

1395

last_approval_request = notifychangeproperty(

1098

1396

datetime_to_dbus, "LastApprovalRequest")

1099

1397

approved_by_default = notifychangeproperty(dbus.Boolean,

1100

1398

"ApprovedByDefault")

1101

approval_delay = notifychangeproperty(dbus.UInt64,

1102

"ApprovalDelay",

1103

type_func =

1104

timedelta_to_milliseconds)

1399

approval_delay = notifychangeproperty(

1400

dbus.UInt64, "ApprovalDelay",

1401

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

1105

1402

approval_duration = notifychangeproperty(

1106

1403

dbus.UInt64, "ApprovalDuration",

1107

type_func = timedelta_to_milliseconds)

1404

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

1108

1405

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

1109

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

1110

type_func =

1111

timedelta_to_milliseconds)

1406

timeout = notifychangeproperty(

1407

dbus.UInt64, "Timeout",

1408

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

1112

1409

extended_timeout = notifychangeproperty(

1113

1410

dbus.UInt64, "ExtendedTimeout",

1114

type_func = timedelta_to_milliseconds)

1115

interval = notifychangeproperty(dbus.UInt64,

1116

"Interval",

1117

type_func =

1118

timedelta_to_milliseconds)

1411

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

1412

interval = notifychangeproperty(

1413

dbus.UInt64, "Interval",

1414

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

1119

1415

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

1416

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

1417

invalidate_only=True)

1120

1418

1121

1419

del notifychangeproperty

1122

1420

1129

1427

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

1130

1428

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

1131

1429

1132

def checker_callback(self, pid, condition, command,

1133

*args, **kwargs):

1134

self.checker_callback_tag = None

1135

self.checker = None

1136

if os.WIFEXITED(condition):

1137

exitstatus = os.WEXITSTATUS(condition)

1430

def checker_callback(self, source, condition,

1431

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

1432

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

1433

connection, command, *args,

1434

**kwargs)

1435

exitstatus = self.last_checker_status

1436

if exitstatus >= 0:

1138

1437

# Emit D-Bus signal

1139

1438

self.CheckerCompleted(dbus.Int16(exitstatus),

1140

dbus.Int64(condition),

1439

# This is specific to GNU libC

1440

dbus.Int64(exitstatus << 8),

1141

1441

dbus.String(command))

1142

1442

else:

1143

1443

# Emit D-Bus signal

1144

1444

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

1145

dbus.Int64(condition),

1445

dbus.Int64(

1446

# This is specific to GNU libC

1447

(exitstatus << 8)

1448

| self.last_checker_signal),

1146

1449

dbus.String(command))

1147

1148

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

1149

*args, **kwargs)

1450

return ret

1150

1451

1151

1452

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

1152

old_checker = self.checker

1153

if self.checker is not None:

1154

old_checker_pid = self.checker.pid

1155

else:

1156

old_checker_pid = None

1453

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

1157

1454

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

1158

1455

# Only if new checker process was started

1159

1456

if (self.checker is not None

1167

1464

return False

1168

1465

1169

1466

def approve(self, value=True):

1170

self.send_changedstate()

1171

1467

self.approved = value

1172

gobject.timeout_add(timedelta_to_milliseconds

1173

(self.approval_duration),

1174

self._reset_approved)

1175

1468

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

1469

* 1000), self._reset_approved)

1470

self.send_changedstate()

1176

1471

1177

1472

## D-Bus methods, signals & properties

1178

_interface = "se.recompile.Mandos.Client"

1473

1474

## Interfaces

1179

1475

1180

1476

## Signals

1181

1477

1192

1488

pass

1193

1489

1194

1490

# PropertyChanged - signal

1491

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

1195

1492

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

1196

1493

def PropertyChanged(self, property, value):

1197

1494

"D-Bus signal"

1218

1515

"D-Bus signal"

1219

1516

return self.need_approval()

1220

1517

1221

# NeRwequest - signal

1222

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

1223

def NewRequest(self, ip):

1224

"""D-Bus signal

1225

Is sent after a client request a password.

1226

"""

1227

pass

1228

1229

1518

## Methods

1230

1519

1231

1520

# Approve - method

1239

1528

self.checked_ok()

1240

1529

1241

1530

# Enable - method

1531

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

1242

1532

@dbus.service.method(_interface)

1243

1533

def Enable(self):

1244

1534

"D-Bus method"

1245

1535

self.enable()

1246

1536

1247

1537

# StartChecker - method

1538

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

1248

1539

@dbus.service.method(_interface)

1249

1540

def StartChecker(self):

1250

1541

"D-Bus method"

1251

1542

self.start_checker()

1252

1543

1253

1544

# Disable - method

1545

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

1254

1546

@dbus.service.method(_interface)

1255

1547

def Disable(self):

1256

1548

"D-Bus method"

1257

1549

self.disable()

1258

1550

1259

1551

# StopChecker - method

1552

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

1260

1553

@dbus.service.method(_interface)

1261

1554

def StopChecker(self):

1262

1555

self.stop_checker()

1269

1562

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

1270

1563

1271

1564

# ApprovedByDefault - property

1272

@dbus_service_property(_interface, signature="b",

1565

@dbus_service_property(_interface,

1566

signature="b",

1273

1567

access="readwrite")

1274

1568

def ApprovedByDefault_dbus_property(self, value=None):

1275

1569

if value is None: # get

1277

1571

self.approved_by_default = bool(value)

1278

1572

1279

1573

# ApprovalDelay - property

1280

@dbus_service_property(_interface, signature="t",

1574

@dbus_service_property(_interface,

1575

signature="t",

1281

1576

access="readwrite")

1282

1577

def ApprovalDelay_dbus_property(self, value=None):

1283

1578

if value is None: # get

1284

return dbus.UInt64(self.approval_delay_milliseconds())

1579

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

1580

* 1000)

1285

1581

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

1286

1582

1287

1583

# ApprovalDuration - property

1288

@dbus_service_property(_interface, signature="t",

1584

@dbus_service_property(_interface,

1585

signature="t",

1289

1586

access="readwrite")

1290

1587

def ApprovalDuration_dbus_property(self, value=None):

1291

1588

if value is None: # get

1292

return dbus.UInt64(timedelta_to_milliseconds(

1293

self.approval_duration))

1589

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

1590

* 1000)

1294

1591

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

1295

1592

1296

1593

# Name - property

1594

@dbus_annotations(

1595

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1297

1596

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

1298

1597

def Name_dbus_property(self):

1299

1598

return dbus.String(self.name)

1300

1599

1301

1600

# Fingerprint - property

1601

@dbus_annotations(

1602

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1302

1603

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

1303

1604

def Fingerprint_dbus_property(self):

1304

1605

return dbus.String(self.fingerprint)

1305

1606

1306

1607

# Host - property

1307

@dbus_service_property(_interface, signature="s",

1608

@dbus_service_property(_interface,

1609

signature="s",

1308

1610

access="readwrite")

1309

1611

def Host_dbus_property(self, value=None):

1310

1612

if value is None: # get

1311

1613

return dbus.String(self.host)

1312

self.host = unicode(value)

1614

self.host = str(value)

1313

1615

1314

1616

# Created - property

1617

@dbus_annotations(

1618

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1315

1619

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

1316

1620

def Created_dbus_property(self):

1317

1621

return datetime_to_dbus(self.created)

1322

1626

return datetime_to_dbus(self.last_enabled)

1323

1627

1324

1628

# Enabled - property

1325

@dbus_service_property(_interface, signature="b",

1629

@dbus_service_property(_interface,

1630

signature="b",

1326

1631

access="readwrite")

1327

1632

def Enabled_dbus_property(self, value=None):

1328

1633

if value is None: # get

1333

1638

self.disable()

1334

1639

1335

1640

# LastCheckedOK - property

1336

@dbus_service_property(_interface, signature="s",

1641

@dbus_service_property(_interface,

1642

signature="s",

1337

1643

access="readwrite")

1338

1644

def LastCheckedOK_dbus_property(self, value=None):

1339

1645

if value is not None:

1341

1647

return

1342

1648

return datetime_to_dbus(self.last_checked_ok)

1343

1649

1650

# LastCheckerStatus - property

1651

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

1652

def LastCheckerStatus_dbus_property(self):

1653

return dbus.Int16(self.last_checker_status)

1654

1344

1655

# Expires - property

1345

1656

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

1346

1657

def Expires_dbus_property(self):

1352

1663

return datetime_to_dbus(self.last_approval_request)

1353

1664

1354

1665

# Timeout - property

1355

@dbus_service_property(_interface, signature="t",

1666

@dbus_service_property(_interface,

1667

signature="t",

1356

1668

access="readwrite")

1357

1669

def Timeout_dbus_property(self, value=None):

1358

1670

if value is None: # get

1359

return dbus.UInt64(self.timeout_milliseconds())

1671

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

1672

old_timeout = self.timeout

1360

1673

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

1361

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

1362

return

1363

# Reschedule timeout

1364

gobject.source_remove(self.disable_initiator_tag)

1365

self.disable_initiator_tag = None

1366

self.expires = None

1367

time_to_die = timedelta_to_milliseconds((self

1368

.last_checked_ok

1369

+ self.timeout)

1370

- datetime.datetime

1371

.utcnow())

1372

if time_to_die <= 0:

1373

# The timeout has passed

1374

self.disable()

1375

else:

1376

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

1377

+ datetime.timedelta(milliseconds =

1378

time_to_die))

1379

self.disable_initiator_tag = (gobject.timeout_add

1380

(time_to_die, self.disable))

1674

# Reschedule disabling

1675

if self.enabled:

1676

now = datetime.datetime.utcnow()

1677

self.expires += self.timeout - old_timeout

1678

if self.expires <= now:

1679

# The timeout has passed

1680

self.disable()

1681

else:

1682

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

1683

is None):

1684

return

1685

gobject.source_remove(self.disable_initiator_tag)

1686

self.disable_initiator_tag = gobject.timeout_add(

1687

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

1688

self.disable)

1381

1689

1382

1690

# ExtendedTimeout - property

1383

@dbus_service_property(_interface, signature="t",

1691

@dbus_service_property(_interface,

1692

signature="t",

1384

1693

access="readwrite")

1385

1694

def ExtendedTimeout_dbus_property(self, value=None):

1386

1695

if value is None: # get

1387

return dbus.UInt64(self.extended_timeout_milliseconds())

1696

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

1697

* 1000)

1388

1698

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

1389

1699

1390

1700

# Interval - property

1391

@dbus_service_property(_interface, signature="t",

1701

@dbus_service_property(_interface,

1702

signature="t",

1392

1703

access="readwrite")

1393

1704

def Interval_dbus_property(self, value=None):

1394

1705

if value is None: # get

1395

return dbus.UInt64(self.interval_milliseconds())

1706

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

1396

1707

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

1397

1708

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

1398

1709

return

1399

1710

if self.enabled:

1400

1711

# Reschedule checker run

1401

1712

gobject.source_remove(self.checker_initiator_tag)

1402

self.checker_initiator_tag = (gobject.timeout_add

1403

(value, self.start_checker))

1404

self.start_checker() # Start one now, too

1713

self.checker_initiator_tag = gobject.timeout_add(

1714

value, self.start_checker)

1715

self.start_checker() # Start one now, too

1405

1716

1406

1717

# Checker - property

1407

@dbus_service_property(_interface, signature="s",

1718

@dbus_service_property(_interface,

1719

signature="s",

1408

1720

access="readwrite")

1409

1721

def Checker_dbus_property(self, value=None):

1410

1722

if value is None: # get

1411

1723

return dbus.String(self.checker_command)

1412

self.checker_command = unicode(value)

1724

self.checker_command = str(value)

1413

1725

1414

1726

# CheckerRunning - property

1415

@dbus_service_property(_interface, signature="b",

1727

@dbus_service_property(_interface,

1728

signature="b",

1416

1729

access="readwrite")

1417

1730

def CheckerRunning_dbus_property(self, value=None):

1418

1731

if value is None: # get

1423

1736

self.stop_checker()

1424

1737

1425

1738

# ObjectPath - property

1739

@dbus_annotations(

1740

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",

1741

"org.freedesktop.DBus.Deprecated": "true"})

1426

1742

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

1427

1743

def ObjectPath_dbus_property(self):

1428

1744

return self.dbus_object_path # is already a dbus.ObjectPath

1429

1745

1430

1746

# Secret = property

1431

@dbus_service_property(_interface, signature="ay",

1432

access="write", byte_arrays=True)

1747

@dbus_annotations(

1748

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

1749

"invalidates"})

1750

@dbus_service_property(_interface,

1751

signature="ay",

1752

access="write",

1753

byte_arrays=True)

1433

1754

def Secret_dbus_property(self, value):

1434

self.secret = str(value)

1755

self.secret = bytes(value)

1435

1756

1436

1757

del _interface

1437

1758

1441

1762

self._pipe = child_pipe

1442

1763

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

1443

1764

if not self._pipe.recv():

1444

raise KeyError()

1765

raise KeyError(fpr)

1445

1766

1446

1767

def __getattribute__(self, name):

1447

1768

if name == '_pipe':

1451

1772

if data[0] == 'data':

1452

1773

return data[1]

1453

1774

if data[0] == 'function':

1775

1454

1776

def func(*args, **kwargs):

1455

1777

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

1456

1778

return self._pipe.recv()[1]

1779

1457

1780

return func

1458

1781

1459

1782

def __setattr__(self, name, value):

1462

1785

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

1463

1786

1464

1787

1465

class ClientDBusTransitional(ClientDBus):

1466

__metaclass__ = AlternateDBusNamesMetaclass

1467

1468

1469

1788

class ClientHandler(socketserver.BaseRequestHandler, object):

1470

1789

"""A class to handle client connections.

1471

1790

1475

1794

def handle(self):

1476

1795

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

1477

1796

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

1478

unicode(self.client_address))

1797

str(self.client_address))

1479

1798

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

1480

1799

self.server.child_pipe.fileno())

1481

1800

1482

session = (gnutls.connection

1483

.ClientSession(self.request,

1484

gnutls.connection

1485

.X509Credentials()))

1801

session = gnutls.connection.ClientSession(

1802

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

1486

1803

1487

1804

# Note: gnutls.connection.X509Credentials is really a

1488

1805

# generic GnuTLS certificate credentials object so long as

1497

1814

priority = self.server.gnutls_priority

1498

1815

if priority is None:

1499

1816

priority = "NORMAL"

1500

(gnutls.library.functions

1501

.gnutls_priority_set_direct(session._c_object,

1502

priority, None))

1817

gnutls.library.functions.gnutls_priority_set_direct(

1818

session._c_object, priority, None)

1503

1819

1504

1820

# Start communication using the Mandos protocol

1505

1821

# Get protocol number

1507

1823

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

1508

1824

try:

1509

1825

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

1510

raise RuntimeError

1826

raise RuntimeError(line)

1511

1827

except (ValueError, IndexError, RuntimeError) as error:

1512

1828

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

1513

1829

return

1525

1841

approval_required = False

1526

1842

try:

1527

1843

try:

1528

fpr = self.fingerprint(self.peer_certificate

1529

(session))

1844

fpr = self.fingerprint(

1845

self.peer_certificate(session))

1530

1846

except (TypeError,

1531

1847

gnutls.errors.GNUTLSError) as error:

1532

1848

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

1539

1855

except KeyError:

1540

1856

return

1541

1857

1542

if self.server.use_dbus:

1543

# Emit D-Bus signal

1544

client.NewRequest(str(self.client_address))

1545

1546

1858

if client.approval_delay:

1547

1859

delay = client.approval_delay

1548

1860

client.approvals_pending += 1

1551

1863

while True:

1552

1864

if not client.enabled:

1553

1865

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

1554

client.name)

1866

client.name)

1555

1867

if self.server.use_dbus:

1556

1868

# Emit D-Bus signal

1557

1869

client.Rejected("Disabled")

1566

1878

if self.server.use_dbus:

1567

1879

# Emit D-Bus signal

1568

1880

client.NeedApproval(

1569

client.approval_delay_milliseconds(),

1570

client.approved_by_default)

1881

client.approval_delay.total_seconds()

1882

* 1000, client.approved_by_default)

1571

1883

else:

1572

1884

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

1573

1885

client.name)

1579

1891

#wait until timeout or approved

1580

1892

time = datetime.datetime.now()

1581

1893

client.changedstate.acquire()

1582

(client.changedstate.wait

1583

(float(client.timedelta_to_milliseconds(delay)

1584

/ 1000)))

1894

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

1585

1895

client.changedstate.release()

1586

1896

time2 = datetime.datetime.now()

1587

1897

if (time2 - time) >= delay:

1603

1913

try:

1604

1914

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

1605

1915

except gnutls.errors.GNUTLSError as error:

1606

logger.warning("gnutls send failed")

1916

logger.warning("gnutls send failed",

1917

exc_info=error)

1607

1918

return

1608

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

1609

sent, len(client.secret)

1610

- (sent_size + sent))

1919

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

1920

len(client.secret) - (sent_size

1921

+ sent))

1611

1922

sent_size += sent

1612

1923

1613

1924

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

1614

1925

# bump the timeout using extended_timeout

1615

client.checked_ok(client.extended_timeout)

1926

client.bump_timeout(client.extended_timeout)

1616

1927

if self.server.use_dbus:

1617

1928

# Emit D-Bus signal

1618

1929

client.GotSecret()

1623

1934

try:

1624

1935

session.bye()

1625

1936

except gnutls.errors.GNUTLSError as error:

1626

logger.warning("GnuTLS bye failed")

1937

logger.warning("GnuTLS bye failed",

1938

exc_info=error)

1627

1939

1628

1940

@staticmethod

1629

1941

def peer_certificate(session):

1630

1942

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

1631

1943

# If not an OpenPGP certificate...

1632

if (gnutls.library.functions

1633

.gnutls_certificate_type_get(session._c_object)

1944

if (gnutls.library.functions.gnutls_certificate_type_get(

1945

session._c_object)

1634

1946

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1635

1947

# ...do the normal thing

1636

1948

return session.peer_certificate

1650

1962

def fingerprint(openpgp):

1651

1963

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1652

1964

# New GnuTLS "datum" with the OpenPGP public key

1653

datum = (gnutls.library.types

1654

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

1655

ctypes.POINTER

1656

(ctypes.c_ubyte)),

1657

ctypes.c_uint(len(openpgp))))

1965

datum = gnutls.library.types.gnutls_datum_t(

1966

ctypes.cast(ctypes.c_char_p(openpgp),

1967

ctypes.POINTER(ctypes.c_ubyte)),

1968

ctypes.c_uint(len(openpgp)))

1658

1969

# New empty GnuTLS certificate

1659

1970

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1660

(gnutls.library.functions

1661

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

1971

gnutls.library.functions.gnutls_openpgp_crt_init(

1972

ctypes.byref(crt))

1662

1973

# Import the OpenPGP public key into the certificate

1663

(gnutls.library.functions

1664

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

1665

gnutls.library.constants

1666

.GNUTLS_OPENPGP_FMT_RAW))

1974

gnutls.library.functions.gnutls_openpgp_crt_import(

1975

crt, ctypes.byref(datum),

1976

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1667

1977

# Verify the self signature in the key

1668

1978

crtverify = ctypes.c_uint()

1669

(gnutls.library.functions

1670

.gnutls_openpgp_crt_verify_self(crt, 0,

1671

ctypes.byref(crtverify)))

1979

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1980

crt, 0, ctypes.byref(crtverify))

1672

1981

if crtverify.value != 0:

1673

1982

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1674

raise (gnutls.errors.CertificateSecurityError

1675

("Verify failed"))

1983

raise gnutls.errors.CertificateSecurityError(

1984

"Verify failed")

1676

1985

# New buffer for the fingerprint

1677

1986

buf = ctypes.create_string_buffer(20)

1678

1987

buf_len = ctypes.c_size_t()

1679

1988

# Get the fingerprint from the certificate into the buffer

1680

(gnutls.library.functions

1681

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

1682

ctypes.byref(buf_len)))

1989

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1990

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

1683

1991

# Deinit the certificate

1684

1992

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1685

1993

# Convert the buffer to a Python bytestring

1691

1999

1692

2000

class MultiprocessingMixIn(object):

1693

2001

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

2002

1694

2003

def sub_process_main(self, request, address):

1695

2004

try:

1696

2005

self.finish_request(request, address)

1701

2010

def process_request(self, request, address):

1702

2011

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

1703

2012

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

1704

args = (request,

1705

address))

2013

args = (request, address))

1706

2014

proc.start()

1707

2015

return proc

1708

2016

1709

2017

1710

2018

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1711

2019

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

2020

1712

2021

def process_request(self, request, client_address):

1713

2022

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

1714

2023

1723

2032

1724

2033

def add_pipe(self, parent_pipe, proc):

1725

2034

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

1726

raise NotImplementedError

2035

raise NotImplementedError()

1727

2036

1728

2037

1729

2038

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1735

2044

interface: None or a network interface name (string)

1736

2045

use_ipv6: Boolean; to use IPv6 or not

1737

2046

"""

2047

1738

2048

def __init__(self, server_address, RequestHandlerClass,

1739

interface=None, use_ipv6=True):

2049

interface=None,

2050

use_ipv6=True,

2051

socketfd=None):

2052

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

2053

creating a new one with socket.socket().

2054

"""

1740

2055

self.interface = interface

1741

2056

if use_ipv6:

1742

2057

self.address_family = socket.AF_INET6

2058

if socketfd is not None:

2059

# Save the file descriptor

2060

self.socketfd = socketfd

2061

# Save the original socket.socket() function

2062

self.socket_socket = socket.socket

2063

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

2064

#

2065

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

2066

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

2067

# patching socket.socket.)

2068

#

2069

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

2070

@functools.wraps(socket.socket)

2071

def socket_wrapper(*args, **kwargs):

2072

# Restore original function so subsequent calls are

2073

# not affected.

2074

socket.socket = self.socket_socket

2075

del self.socket_socket

2076

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

2077

# saved file descriptor.

2078

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

2079

# Replace socket.socket() function with wrapper

2080

socket.socket = socket_wrapper

2081

# The socketserver.TCPServer.__init__ will call

2082

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

2083

# socket_wrapper(), if socketfd was set.

1743

2084

socketserver.TCPServer.__init__(self, server_address,

1744

2085

RequestHandlerClass)

2086

1745

2087

def server_bind(self):

1746

2088

"""This overrides the normal server_bind() function

1747

2089

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

1753

2095

self.interface)

1754

2096

else:

1755

2097

try:

1756

self.socket.setsockopt(socket.SOL_SOCKET,

1757

SO_BINDTODEVICE,

1758

str(self.interface

1759

+ '\0'))

2098

self.socket.setsockopt(

2099

socket.SOL_SOCKET, SO_BINDTODEVICE,

2100

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

1760

2101

except socket.error as error:

1761

if error[0] == errno.EPERM:

1762

logger.error("No permission to"

1763

" bind to interface %s",

1764

self.interface)

1765

elif error[0] == errno.ENOPROTOOPT:

2102

if error.errno == errno.EPERM:

2103

logger.error("No permission to bind to"

2104

" interface %s", self.interface)

2105

elif error.errno == errno.ENOPROTOOPT:

1766

2106

logger.error("SO_BINDTODEVICE not available;"

1767

2107

" cannot bind to interface %s",

1768

2108

self.interface)

2109

elif error.errno == errno.ENODEV:

2110

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

2111

" cannot bind", self.interface)

1769

2112

else:

1770

2113

raise

1771

2114

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

1774

2117

if self.address_family == socket.AF_INET6:

1775

2118

any_address = "::" # in6addr_any

1776

2119

else:

1777

any_address = socket.INADDR_ANY

2120

any_address = "0.0.0.0" # INADDR_ANY

1778

2121

self.server_address = (any_address,

1779

2122

self.server_address[1])

1780

2123

elif not self.server_address[1]:

1781

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

1782

0)

2124

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

1783

2125

# if self.interface:

1784

2126

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

1785

2127

# 0, # port

1799

2141

1800

2142

Assumes a gobject.MainLoop event loop.

1801

2143

"""

2144

1802

2145

def __init__(self, server_address, RequestHandlerClass,

1803

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

1804

gnutls_priority=None, use_dbus=True):

2146

interface=None,

2147

use_ipv6=True,

2148

clients=None,

2149

gnutls_priority=None,

2150

use_dbus=True,

2151

socketfd=None):

1805

2152

self.enabled = False

1806

2153

self.clients = clients

1807

2154

if self.clients is None:

1811

2158

IPv6_TCPServer.__init__(self, server_address,

1812

2159

RequestHandlerClass,

1813

2160

interface = interface,

1814

use_ipv6 = use_ipv6)

2161

use_ipv6 = use_ipv6,

2162

socketfd = socketfd)

2163

1815

2164

def server_activate(self):

1816

2165

if self.enabled:

1817

2166

return socketserver.TCPServer.server_activate(self)

1821

2170

1822

2171

def add_pipe(self, parent_pipe, proc):

1823

2172

# Call "handle_ipc" for both data and EOF events

1824

gobject.io_add_watch(parent_pipe.fileno(),

1825

gobject.IO_IN | gobject.IO_HUP,

1826

functools.partial(self.handle_ipc,

1827

parent_pipe =

1828

parent_pipe,

1829

proc = proc))

2173

gobject.io_add_watch(

2174

parent_pipe.fileno(),

2175

gobject.IO_IN | gobject.IO_HUP,

2176

functools.partial(self.handle_ipc,

2177

parent_pipe = parent_pipe,

2178

proc = proc))

1830

2179

1831

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

1832

proc = None, client_object=None):

1833

condition_names = {

1834

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

1835

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

1836

# blocking).

1837

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

1838

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

1839

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

1840

# broken, usually for pipes and

1841

# sockets).

1842

}

1843

conditions_string = ' | '.join(name

1844

for cond, name in

1845

condition_names.iteritems()

1846

if cond & condition)

2180

def handle_ipc(self, source, condition,

2181

parent_pipe=None,

2182

proc = None,

2183

client_object=None):

1847

2184

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

1848

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

2185

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

1849

2186

# Wait for other process to exit

1850

2187

proc.join()

1851

2188

return False

1872

2209

parent_pipe.send(False)

1873

2210

return False

1874

2211

1875

gobject.io_add_watch(parent_pipe.fileno(),

1876

gobject.IO_IN | gobject.IO_HUP,

1877

functools.partial(self.handle_ipc,

1878

parent_pipe =

1879

parent_pipe,

1880

proc = proc,

1881

client_object =

1882

client))

2212

gobject.io_add_watch(

2213

parent_pipe.fileno(),

2214

gobject.IO_IN | gobject.IO_HUP,

2215

functools.partial(self.handle_ipc,

2216

parent_pipe = parent_pipe,

2217

proc = proc,

2218

client_object = client))

1883

2219

parent_pipe.send(True)

1884

2220

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

1885

2221

# same fileno

1891

2227

1892

2228

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

1893

2229

funcname)(*args,

1894

**kwargs)))

2230

**kwargs)))

1895

2231

1896

2232

if command == 'getattr':

1897

2233

attrname = request[1]

1898

if callable(client_object.__getattribute__(attrname)):

1899

parent_pipe.send(('function',))

2234

if isinstance(client_object.__getattribute__(attrname),

2235

collections.Callable):

2236

parent_pipe.send(('function', ))

1900

2237

else:

1901

parent_pipe.send(('data', client_object

1902

.__getattribute__(attrname)))

2238

parent_pipe.send((

2239

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

1903

2240

1904

2241

if command == 'setattr':

1905

2242

attrname = request[1]

1909

2246

return True

1910

2247

1911

2248

2249

def rfc3339_duration_to_delta(duration):

2250

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

2251

2252

>>> rfc3339_duration_to_delta("P7D")

2253

datetime.timedelta(7)

2254

>>> rfc3339_duration_to_delta("PT60S")

2255

datetime.timedelta(0, 60)

2256

>>> rfc3339_duration_to_delta("PT60M")

2257

datetime.timedelta(0, 3600)

2258

>>> rfc3339_duration_to_delta("PT24H")

2259

datetime.timedelta(1)

2260

>>> rfc3339_duration_to_delta("P1W")

2261

datetime.timedelta(7)

2262

>>> rfc3339_duration_to_delta("PT5M30S")

2263

datetime.timedelta(0, 330)

2264

>>> rfc3339_duration_to_delta("P1DT3M20S")

2265

datetime.timedelta(1, 200)

2266

"""

2267

2268

# Parsing an RFC 3339 duration with regular expressions is not

2269

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

2270

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

2271

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

2272

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

2273

# avoid excessive use of external libraries.

2274

2275

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

2276

Token = collections.namedtuple("Token", (

2277

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

2278

# a "group" containing digits

2279

"value", # datetime.timedelta or None

2280

"followers")) # Tokens valid after this token

2281

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

2282

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

2283

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

2284

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

2285

datetime.timedelta(seconds=1),

2286

frozenset((token_end, )))

2287

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

2288

datetime.timedelta(minutes=1),

2289

frozenset((token_second, token_end)))

2290

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

2291

datetime.timedelta(hours=1),

2292

frozenset((token_minute, token_end)))

2293

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

2294

None,

2295

frozenset((token_hour, token_minute,

2296

token_second)))

2297

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

2298

datetime.timedelta(days=1),

2299

frozenset((token_time, token_end)))

2300

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

2301

datetime.timedelta(weeks=4),

2302

frozenset((token_day, token_end)))

2303

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

2304

datetime.timedelta(weeks=52),

2305

frozenset((token_month, token_end)))

2306

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

2307

datetime.timedelta(weeks=1),

2308

frozenset((token_end, )))

2309

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

2310

frozenset((token_year, token_month,

2311

token_day, token_time,

2312

token_week)))

2313

# Define starting values

2314

value = datetime.timedelta() # Value so far

2315

found_token = None

2316

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

2317

s = duration # String left to parse

2318

# Loop until end token is found

2319

while found_token is not token_end:

2320

# Search for any currently valid tokens

2321

for token in followers:

2322

match = token.regexp.match(s)

2323

if match is not None:

2324

# Token found

2325

if token.value is not None:

2326

# Value found, parse digits

2327

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

2328

# Add to value so far

2329

value += factor * token.value

2330

# Strip token from string

2331

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

2332

# Go to found token

2333

found_token = token

2334

# Set valid next tokens

2335

followers = found_token.followers

2336

break

2337

else:

2338

# No currently valid tokens were found

2339

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

2340

.format(duration))

2341

# End token found

2342

return value

2343

2344

1912

2345

def string_to_delta(interval):

1913

2346

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

1914

2347

1925

2358

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

1926

2359

datetime.timedelta(0, 330)

1927

2360

"""

2361

2362

try:

2363

return rfc3339_duration_to_delta(interval)

2364

except ValueError:

2365

pass

2366

1928

2367

timevalue = datetime.timedelta(0)

1929

2368

for s in interval.split():

1930

2369

try:

1931

suffix = unicode(s[-1])

2370

suffix = s[-1]

1932

2371

value = int(s[:-1])

1933

2372

if suffix == "d":

1934

2373

delta = datetime.timedelta(value)

1941

2380

elif suffix == "w":

1942

2381

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

1943

2382

else:

1944

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

1945

except (ValueError, IndexError) as e:

2383

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

2384

except IndexError as e:

1946

2385

raise ValueError(*(e.args))

1947

2386

timevalue += delta

1948

2387

return timevalue

1961

2400

sys.exit()

1962

2401

if not noclose:

1963

2402

# Close all standard open file descriptors

1964

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

2403

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

1965

2404

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

1966

2405

raise OSError(errno.ENODEV,

1967

"%s not a character device"

1968

% os.path.devnull)

2406

"{} not a character device"

2407

.format(os.devnull))

1969

2408

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

1970

2409

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

1971

2410

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

1980

2419

1981

2420

parser = argparse.ArgumentParser()

1982

2421

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

1983

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

2422

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

1984

2423

help="show version number and exit")

1985

2424

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

1986

2425

help="Bind to interface IF")

1992

2431

help="Run self-test")

1993

2432

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

1994

2433

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

1995

" to terminal")

2434

" to terminal", default=None)

1996

2435

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

1997

2436

help="Debug level for stdout output")

1998

2437

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

2005

2444

" files")

2006

2445

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

2007

2446

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

2008

" system bus interface")

2447

" system bus interface", default=None)

2009

2448

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

2010

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

2449

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

2450

default=None)

2011

2451

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

2012

2452

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

2013

" state")

2453

" state", default=None)

2454

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

2455

help="Specify a file descriptor to a network"

2456

" socket to use instead of creating one")

2014

2457

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

2015

2458

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

2459

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

2460

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

2461

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

2462

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

2463

default=None)

2016

2464

2017

2465

options = parser.parse_args()

2018

2466

2019

2467

if options.check:

2020

2468

import doctest

2021

doctest.testmod()

2022

sys.exit()

2469

fail_count, test_count = doctest.testmod()

2470

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

2023

2471

2024

2472

# Default values for config file for server-global settings

2025

2473

server_defaults = { "interface": "",

2027

2475

"port": "",

2028

2476

"debug": "False",

2029

2477

"priority":

2030

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

2478

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

2479

":+SIGN-DSA-SHA256",

2031

2480

"servicename": "Mandos",

2032

2481

"use_dbus": "True",

2033

2482

"use_ipv6": "True",

2034

2483

"debuglevel": "",

2035

2484

"restore": "True",

2036

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

2037

}

2485

"socket": "",

2486

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

2487

"foreground": "False",

2488

"zeroconf": "True",

2489

}

2038

2490

2039

2491

# Parse config file for server-global settings

2040

2492

server_config = configparser.SafeConfigParser(server_defaults)

2041

2493

del server_defaults

2042

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

2043

"mandos.conf"))

2494

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

2044

2495

# Convert the SafeConfigParser object to a dict

2045

2496

server_settings = server_config.defaults()

2046

2497

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

2047

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

2498

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

2048

2499

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

2049

2500

option)

2050

2501

if server_settings["port"]:

2051

2502

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

2052

2503

"port")

2504

if server_settings["socket"]:

2505

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

2506

"socket")

2507

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

2508

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

2509

# happen with a supplied network socket.

2510

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

2511

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

2512

["socket"])

2053

2513

del server_config

2054

2514

2055

2515

# Override the settings from the config file with command line

2056

2516

# options, if set.

2057

2517

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

2058

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

2059

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

2060

"statedir"):

2518

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

2519

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

2520

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

2061

2521

value = getattr(options, option)

2062

2522

if value is not None:

2063

2523

server_settings[option] = value

2064

2524

del options

2065

2525

# Force all strings to be unicode

2066

2526

for option in server_settings.keys():

2067

if type(server_settings[option]) is str:

2068

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

2527

if isinstance(server_settings[option], bytes):

2528

server_settings[option] = (server_settings[option]

2529

.decode("utf-8"))

2530

# Force all boolean options to be boolean

2531

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

2532

"foreground", "zeroconf"):

2533

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

2534

# Debug implies foreground

2535

if server_settings["debug"]:

2536

server_settings["foreground"] = True

2069

2537

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

2070

2538

2071

2539

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

2072

2540

2541

if (not server_settings["zeroconf"]

2542

and not (server_settings["port"]

2543

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

2544

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

2545

2073

2546

# For convenience

2074

2547

debug = server_settings["debug"]

2075

2548

debuglevel = server_settings["debuglevel"]

2077

2550

use_ipv6 = server_settings["use_ipv6"]

2078

2551

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

2079

2552

stored_state_file)

2553

foreground = server_settings["foreground"]

2554

zeroconf = server_settings["zeroconf"]

2080

2555

2081

2556

if debug:

2082

2557

initlogger(debug, logging.DEBUG)

2088

2563

initlogger(debug, level)

2089

2564

2090

2565

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

2091

syslogger.setFormatter(logging.Formatter

2092

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

2093

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

2094

% server_settings["servicename"]))

2566

syslogger.setFormatter(

2567

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

2568

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

2569

server_settings["servicename"])))

2095

2570

2096

2571

# Parse config file with clients

2097

client_config = configparser.SafeConfigParser(Client.client_defaults)

2572

client_config = configparser.SafeConfigParser(Client

2573

.client_defaults)

2098

2574

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

2099

2575

"clients.conf"))

2100

2576

2101

2577

global mandos_dbus_service

2102

2578

mandos_dbus_service = None

2103

2579

2104

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

2105

server_settings["port"]),

2106

ClientHandler,

2107

interface=(server_settings["interface"]

2108

or None),

2109

use_ipv6=use_ipv6,

2110

gnutls_priority=

2111

server_settings["priority"],

2112

use_dbus=use_dbus)

2113

if not debug:

2114

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

2580

socketfd = None

2581

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

2582

socketfd = server_settings["socket"]

2583

tcp_server = MandosServer(

2584

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

2585

ClientHandler,

2586

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

2587

use_ipv6=use_ipv6,

2588

gnutls_priority=server_settings["priority"],

2589

use_dbus=use_dbus,

2590

socketfd=socketfd)

2591

if not foreground:

2592

pidfilename = "/run/mandos.pid"

2593

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

2594

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

2595

pidfile = None

2115

2596

try:

2116

pidfile = open(pidfilename, "w")

2117

except IOError:

2118

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

2597

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

2598

except IOError as e:

2599

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

2600

exc_info=e)

2119

2601

2120

try:

2121

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

2122

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

2123

except KeyError:

2602

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

2124

2603

try:

2125

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

2126

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

2604

uid = pwd.getpwnam(name).pw_uid

2605

gid = pwd.getpwnam(name).pw_gid

2606

break

2127

2607

except KeyError:

2128

try:

2129

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

2130

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

2131

except KeyError:

2132

uid = 65534

2133

gid = 65534

2608

continue

2609

else:

2610

uid = 65534

2611

gid = 65534

2134

2612

try:

2135

2613

os.setgid(gid)

2136

2614

os.setuid(uid)

2137

2615

except OSError as error:

2138

if error[0] != errno.EPERM:

2139

raise error

2616

if error.errno != errno.EPERM:

2617

raise

2140

2618

2141

2619

if debug:

2142

2620

# Enable all possible GnuTLS debugging

2149

2627

def debug_gnutls(level, string):

2150

2628

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

2151

2629

2152

(gnutls.library.functions

2153

.gnutls_global_set_log_function(debug_gnutls))

2630

gnutls.library.functions.gnutls_global_set_log_function(

2631

debug_gnutls)

2154

2632

2155

2633

# Redirect stdin so all checkers get /dev/null

2156

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

2634

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

2157

2635

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

2158

2636

if null > 2:

2159

2637

os.close(null)

2160

2638

2161

2639

# Need to fork before connecting to D-Bus

2162

if not debug:

2640

if not foreground:

2163

2641

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

2164

2642

daemon()

2165

2643

2644

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

2645

# need to inform gobject that threads will be used.

2166

2646

gobject.threads_init()

2167

2647

2168

2648

global main_loop

2169

2649

# From the Avahi example code

2170

DBusGMainLoop(set_as_default=True )

2650

DBusGMainLoop(set_as_default=True)

2171

2651

main_loop = gobject.MainLoop()

2172

2652

bus = dbus.SystemBus()

2173

2653

# End of Avahi example code

2174

2654

if use_dbus:

2175

2655

try:

2176

2656

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

2177

bus, do_not_queue=True)

2178

old_bus_name = (dbus.service.BusName

2179

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

2180

do_not_queue=True))

2181

except dbus.exceptions.NameExistsException as e:

2182

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

2657

bus,

2658

do_not_queue=True)

2659

old_bus_name = dbus.service.BusName(

2660

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

2661

do_not_queue=True)

2662

except dbus.exceptions.DBusException as e:

2663

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

2183

2664

use_dbus = False

2184

2665

server_settings["use_dbus"] = False

2185

2666

tcp_server.use_dbus = False

2186

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2187

service = AvahiServiceToSyslog(name =

2188

server_settings["servicename"],

2189

servicetype = "_mandos._tcp",

2190

protocol = protocol, bus = bus)

2191

if server_settings["interface"]:

2192

service.interface = (if_nametoindex

2193

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

2667

if zeroconf:

2668

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2669

service = AvahiServiceToSyslog(

2670

name = server_settings["servicename"],

2671

servicetype = "_mandos._tcp",

2672

protocol = protocol,

2673

bus = bus)

2674

if server_settings["interface"]:

2675

service.interface = if_nametoindex(

2676

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

2194

2677

2195

2678

global multiprocessing_manager

2196

2679

multiprocessing_manager = multiprocessing.Manager()

2197

2680

2198

2681

client_class = Client

2199

2682

if use_dbus:

2200

client_class = functools.partial(ClientDBusTransitional,

2201

bus = bus)

2683

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

2202

2684

2203

2685

client_settings = Client.config_parser(client_config)

2204

2686

old_client_settings = {}

2205

2687

clients_data = {}

2206

2688

2689

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

2690

global wnull

2691

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

2692

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

2693

# mode

2694

if debug or not foreground:

2695

wnull.close()

2696

2207

2697

# Get client data and settings from last running state.

2208

2698

if server_settings["restore"]:

2209

2699

try:

2210

2700

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

2211

clients_data, old_client_settings = (pickle.load

2212

(stored_state))

2701

clients_data, old_client_settings = pickle.load(

2702

stored_state)

2213

2703

os.remove(stored_state_path)

2214

2704

except IOError as e:

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

2705

if e.errno == errno.ENOENT:

2706

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

2707

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

2708

else:

2709

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

2710

exc_info=e)

2218

2711

raise

2219

2712

except EOFError as e:

2220

2713

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

2221

"EOFError: {0}".format(e))

2714

"EOFError:",

2715

exc_info=e)

2222

2716

2223

2717

with PGPEngine() as pgp:

2224

for client_name, client in clients_data.iteritems():

2718

for client_name, client in clients_data.items():

2719

# Skip removed clients

2720

if client_name not in client_settings:

2721

continue

2722

2225

2723

# Decide which value to use after restoring saved state.

2226

2724

# We have three different values: Old config file,

2227

2725

# new config file, and saved state.

2232

2730

# For each value in new config, check if it

2233

2731

# differs from the old config value (Except for

2234

2732

# the "secret" attribute)

2235

if (name != "secret" and

2236

value != old_client_settings[client_name]

2237

[name]):

2733

if (name != "secret"

2734

and (value !=

2735

old_client_settings[client_name][name])):

2238

2736

client[name] = value

2239

2737

except KeyError:

2240

2738

pass

2241

2739

2242

2740

# Clients who has passed its expire date can still be

2243

# enabled if its last checker was successful. Clients

2244

# whose checker failed before we stored its state is

2245

# assumed to have failed all checkers during downtime.

2741

# enabled if its last checker was successful. A Client

2742

# whose checker succeeded before we stored its state is

2743

# assumed to have successfully run all checkers during

2744

# downtime.

2246

2745

if client["enabled"]:

2247

2746

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

2248

2747

if not client["last_checked_ok"]:

2249

2748

logger.warning(

2250

"disabling client {0} - Client never "

2251

"performed a successfull checker"

2252

.format(client["name"]))

2749

"disabling client {} - Client never "

2750

"performed a successful checker".format(

2751

client_name))

2253

2752

client["enabled"] = False

2254

2753

elif client["last_checker_status"] != 0:

2255

2754

logger.warning(

2256

"disabling client {0} - Client "

2257

"last checker failed with error code {1}"

2258

.format(client["name"],

2259

client["last_checker_status"]))

2755

"disabling client {} - Client last"

2756

" checker failed with error code"

2757

" {}".format(

2758

client_name,

2759

client["last_checker_status"]))

2260

2760

client["enabled"] = False

2261

2761

else:

2262

client["expires"] = (datetime.datetime

2263

.utcnow()

2264

+ client["timeout"])

2265

2762

client["expires"] = (

2763

datetime.datetime.utcnow()

2764

+ client["timeout"])

2765

logger.debug("Last checker succeeded,"

2766

" keeping {} enabled".format(

2767

client_name))

2266

2768

try:

2267

client["secret"] = (

2268

pgp.decrypt(client["encrypted_secret"],

2269

client_settings[client_name]

2270

["secret"]))

2769

client["secret"] = pgp.decrypt(

2770

client["encrypted_secret"],

2771

client_settings[client_name]["secret"])

2271

2772

except PGPError:

2272

2773

# If decryption fails, we use secret from new settings

2273

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

2274

.format(client_name))

2275

client["secret"] = (

2276

client_settings[client_name]["secret"])

2277

2774

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

2775

client_name))

2776

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

2777

["secret"])

2278

2778

2279

2779

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

2280

for client_name in set(old_client_settings) - set(client_settings):

2780

for client_name in (set(old_client_settings)

2781

- set(client_settings)):

2281

2782

del clients_data[client_name]

2282

for client_name in set(client_settings) - set(old_client_settings):

2783

for client_name in (set(client_settings)

2784

- set(old_client_settings)):

2283

2785

clients_data[client_name] = client_settings[client_name]

2284

2285

# Create clients all clients

2286

for client_name, client in clients_data.iteritems():

2786

2787

# Create all client objects

2788

for client_name, client in clients_data.items():

2287

2789

tcp_server.clients[client_name] = client_class(

2288

name = client_name, settings = client)

2790

name = client_name,

2791

settings = client,

2792

server_settings = server_settings)

2289

2793

2290

2794

if not tcp_server.clients:

2291

2795

logger.warning("No clients defined")

2292

2293

if not debug:

2294

try:

2295

with pidfile:

2296

pid = os.getpid()

2297

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

2298

del pidfile

2299

except IOError:

2300

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

2301

pidfilename, pid)

2302

except NameError:

2303

# "pidfile" was never created

2304

pass

2796

2797

if not foreground:

2798

if pidfile is not None:

2799

pid = os.getpid()

2800

try:

2801

with pidfile:

2802

print(pid, file=pidfile)

2803

except IOError:

2804

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

2805

pidfilename, pid)

2806

del pidfile

2305

2807

del pidfilename

2306

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

2307

2808

2308

2809

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

2309

2810

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

2310

2811

2311

2812

if use_dbus:

2312

class MandosDBusService(dbus.service.Object):

2813

2814

@alternate_dbus_interfaces(

2815

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

2816

class MandosDBusService(DBusObjectWithAnnotations):

2313

2817

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

2818

2314

2819

def __init__(self):

2315

2820

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

2821

2316

2822

_interface = "se.recompile.Mandos"

2317

2823

2318

2824

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

2333

2839

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

2334

2840

def GetAllClients(self):

2335

2841

"D-Bus method"

2336

return dbus.Array(c.dbus_object_path

2337

for c in

2842

return dbus.Array(c.dbus_object_path for c in

2338

2843

tcp_server.clients.itervalues())

2339

2844

2340

2845

@dbus.service.method(_interface,

2342

2847

def GetAllClientsWithProperties(self):

2343

2848

"D-Bus method"

2344

2849

return dbus.Dictionary(

2345

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

2346

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

2850

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

2851

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

2347

2852

signature="oa{sv}")

2348

2853

2349

2854

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

2362

2867

2363

2868

del _interface

2364

2869

2365

class MandosDBusServiceTransitional(MandosDBusService):

2366

__metaclass__ = AlternateDBusNamesMetaclass

2367

mandos_dbus_service = MandosDBusServiceTransitional()

2870

mandos_dbus_service = MandosDBusService()

2368

2871

2369

2872

def cleanup():

2370

2873

"Cleanup function; run on exit"

2371

service.cleanup()

2874

if zeroconf:

2875

service.cleanup()

2372

2876

2373

2877

multiprocessing.active_children()

2878

wnull.close()

2374

2879

if not (tcp_server.clients or client_settings):

2375

2880

return

2376

2881

2387

2892

2388

2893

# A list of attributes that can not be pickled

2389

2894

# + secret.

2390

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

2391

"checker"))

2392

for name, typ in (inspect.getmembers

2393

(dbus.service.Object)):

2895

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

2896

"checker", "server_settings" }

2897

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

2898

.Object):

2394

2899

exclude.add(name)

2395

2900

2396

2901

client_dict["encrypted_secret"] = (client

2403

2908

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

2404

2909

2405

2910

try:

2406

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2407

prefix="clients-",

2408

dir=os.path.dirname

2409

(stored_state_path))

2410

with os.fdopen(tempfd, "wb") as stored_state:

2911

with tempfile.NamedTemporaryFile(

2912

mode='wb',

2913

suffix=".pickle",

2914

prefix='clients-',

2915

dir=os.path.dirname(stored_state_path),

2916

delete=False) as stored_state:

2411

2917

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

2918

tempname = stored_state.name

2412

2919

os.rename(tempname, stored_state_path)

2413

2920

except (IOError, OSError) as e:

2414

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

2415

.format(e))

2416

2921

if not debug:

2417

2922

try:

2418

2923

os.remove(tempname)

2419

2924

except NameError:

2420

2925

pass

2421

if e.errno not in set((errno.ENOENT, errno.EACCES,

2422

errno.EEXIST)):

2423

raise e

2926

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

2927

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

2928

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

2929

else:

2930

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

2931

exc_info=e)

2932

raise

2424

2933

2425

2934

# Delete all clients, and settings from config

2426

2935

while tcp_server.clients:

2431

2940

client.disable(quiet=True)

2432

2941

if use_dbus:

2433

2942

# Emit D-Bus signal

2434

mandos_dbus_service.ClientRemoved(client

2435

.dbus_object_path,

2436

client.name)

2943

mandos_dbus_service.ClientRemoved(

2944

client.dbus_object_path, client.name)

2437

2945

client_settings.clear()

2438

2946

2439

2947

atexit.register(cleanup)

2450

2958

tcp_server.server_activate()

2451

2959

2452

2960

# Find out what port we got

2453

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

2961

if zeroconf:

2962

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

2454

2963

if use_ipv6:

2455

2964

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

2456

" flowinfo %d, scope_id %d"

2457

% tcp_server.socket.getsockname())

2965

" flowinfo %d, scope_id %d",

2966

*tcp_server.socket.getsockname())

2458

2967

else: # IPv4

2459

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

2460

% tcp_server.socket.getsockname())

2968

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

2969

*tcp_server.socket.getsockname())

2461

2970

2462

2971

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

2463

2972

2464

2973

try:

2465

# From the Avahi example code

2466

try:

2467

service.activate()

2468

except dbus.exceptions.DBusException as error:

2469

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

2470

cleanup()

2471

sys.exit(1)

2472

# End of Avahi example code

2974

if zeroconf:

2975

# From the Avahi example code

2976

try:

2977

service.activate()

2978

except dbus.exceptions.DBusException as error:

2979

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

2980

cleanup()

2981

sys.exit(1)

2982

# End of Avahi example code

2473

2983

2474

2984

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

2475

2985

lambda *args, **kwargs:

2479

2989

logger.debug("Starting main loop")

2480

2990

main_loop.run()

2481

2991

except AvahiError as error:

2482

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

2992

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

2483

2993

cleanup()

2484

2994

sys.exit(1)

2485

2995

except KeyboardInterrupt:

2490

3000

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

2491

3001

cleanup()

2492

3002

3003

2493

3004

if __name__ == '__main__':

2494

3005

main()