/mandos/release : revision 237.7.402

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

try:

38

from future_builtins import *

39

except ImportError:

40

pass

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

38

46

import socket

39

47

import argparse

40

48

import datetime

41

49

import errno

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

49

54

import sys

50

55

import re

51

56

import os

60

65

import struct

61

66

import fcntl

62

67

import functools

63

import cPickle as pickle

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

64

72

import multiprocessing

65

73

import types

66

74

import binascii

67

75

import tempfile

76

import itertools

77

import collections

78

import codecs

68

79

69

80

import dbus

70

81

import dbus.service

71

import gobject

72

import avahi

82

from gi.repository import GLib

73

83

from dbus.mainloop.glib import DBusGMainLoop

74

84

import ctypes

75

85

import ctypes.util

76

86

import xml.dom.minidom

77

87

import inspect

78

import GnuPGInterface

79

88

89

# Try to find the value of SO_BINDTODEVICE:

80

90

try:

91

# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and

92

# newer, and it is also the most natural place for it:

81

93

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

82

94

except AttributeError:

83

95

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

84

98

from IN import SO_BINDTODEVICE

85

99

except ImportError:

86

SO_BINDTODEVICE = None

87

88

version = "1.5.2"

100

# In Python 2.7 it seems to have been removed entirely.

101

# Try running the C preprocessor:

102

try:

103

cc = subprocess.Popen(["cc", "--language=c", "-E",

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]

109

SO_BINDTODEVICE = int(stdout.splitlines()[-1])

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.7"

89

118

stored_state_file = "clients.pickle"

90

119

91

120

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

121

syslogger = None

95

122

96

123

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

100

126

except (OSError, AttributeError):

127

101

128

def if_nametoindex(interface):

102

129

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

103

130

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

104

131

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

105

132

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

133

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

134

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

110

135

return interface_index

111

136

112

137

138

def copy_function(func):

139

"""Make a copy of a function"""

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

113

154

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

114

155

"""init logger and add loglevel"""

115

156

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

160

address = "/dev/log"))

116

161

syslogger.setFormatter(logging.Formatter

117

162

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

118

163

' %(message)s'))

135

180

136

181

class PGPEngine(object):

137

182

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

183

138

184

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

185

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',

146

'--no-use-agent'])

186

self.gpg = "gpg"

187

try:

188

output = subprocess.check_output(["gpgconf"])

189

for line in output.splitlines():

190

name, text, path = line.split(b":")

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

'--force-mdc',

200

'--quiet']

201

# Only GPG version 1 has the --no-use-agent option.

202

if self.gpg == "gpg" or self.gpg.endswith("/gpg"):

203

self.gnupgargs.append("--no-use-agent")

147

204

148

205

def __enter__(self):

149

206

return self

150

207

151

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

208

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

152

209

self._cleanup()

153

210

return False

154

211

171

228

def password_encode(self, password):

172

229

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

173

230

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

174

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

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

175

238

176

239

def encrypt(self, data, password):

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin = subprocess.PIPE,

250

stdout = subprocess.PIPE,

251

stderr = subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

raise PGPError(err)

191

255

return ciphertext

192

256

193

257

def decrypt(self, data, password):

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir = self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin = subprocess.PIPE,

268

stdout = subprocess.PIPE,

269

stderr = subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

raise PGPError(err)

208

273

return decrypted_plaintext

209

274

210

275

# Pretend that we have an Avahi module

276

class Avahi(object):

277

"""This isn't so much a class as it is a module-like namespace.

278

It is instantiated once, and simulates having an Avahi module."""

279

IF_UNSPEC = -1 # avahi-common/address.h

280

PROTO_UNSPEC = -1 # avahi-common/address.h

281

PROTO_INET = 0 # avahi-common/address.h

282

PROTO_INET6 = 1 # avahi-common/address.h

283

DBUS_NAME = "org.freedesktop.Avahi"

284

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

285

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

286

DBUS_PATH_SERVER = "/"

287

def string_array_to_txt_array(self, t):

288

return dbus.Array((dbus.ByteArray(s.encode("utf-8"))

289

for s in t), signature="ay")

290

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

291

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

292

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

293

SERVER_INVALID = 0 # avahi-common/defs.h

294

SERVER_REGISTERING = 1 # avahi-common/defs.h

295

SERVER_RUNNING = 2 # avahi-common/defs.h

296

SERVER_COLLISION = 3 # avahi-common/defs.h

297

SERVER_FAILURE = 4 # avahi-common/defs.h

298

avahi = Avahi()

211

299

212

300

class AvahiError(Exception):

213

301

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

214

302

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

303

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

304

**kwargs)

305

218

306

219

307

class AvahiServiceError(AvahiError):

220

308

pass

221

309

310

222

311

class AvahiGroupError(AvahiError):

223

312

pass

224

313

231

320

Used to optionally bind to the specified interface.

232

321

name: string; Example: 'Mandos'

233

322

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

234

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

323

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

235

324

port: integer; what port to announce

236

325

TXT: list of strings; TXT record for the service

237

326

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

243

332

server: D-Bus Server

244

333

bus: dbus.SystemBus()

245

334

"""

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

335

336

def __init__(self,

337

interface = avahi.IF_UNSPEC,

338

name = None,

339

servicetype = None,

340

port = None,

341

TXT = None,

342

domain = "",

343

host = "",

344

max_renames = 32768,

345

protocol = avahi.PROTO_UNSPEC,

346

bus = None):

250

347

self.interface = interface

251

348

self.name = name

252

349

self.type = servicetype

261

358

self.server = None

262

359

self.bus = bus

263

360

self.entry_group_state_changed_match = None

264

def rename(self):

361

362

def rename(self, remove=True):

265

363

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

266

364

if self.rename_count >= self.max_renames:

267

365

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

268

366

" after %i retries, exiting.",

269

367

self.rename_count)

270

368

raise AvahiServiceError("Too many renames")

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

369

self.name = str(

370

self.server.GetAlternativeServiceName(self.name))

371

self.rename_count += 1

273

372

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

274

373

self.name)

275

self.remove()

374

if remove:

375

self.remove()

276

376

try:

277

377

self.add()

278

378

except dbus.exceptions.DBusException as error:

279

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

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

379

if (error.get_dbus_name()

380

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

381

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

382

return self.rename(remove=False)

383

else:

384

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

385

self.cleanup()

386

os._exit(1)

387

283

388

def remove(self):

284

389

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

285

390

if self.entry_group_state_changed_match is not None:

287

392

self.entry_group_state_changed_match = None

288

393

if self.group is not None:

289

394

self.group.Reset()

395

290

396

def add(self):

291

397

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

292

398

self.remove()

309

415

dbus.UInt16(self.port),

310

416

avahi.string_array_to_txt_array(self.TXT))

311

417

self.group.Commit()

418

312

419

def entry_group_state_changed(self, state, error):

313

420

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

314

421

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

320

427

self.rename()

321

428

elif state == avahi.ENTRY_GROUP_FAILURE:

322

429

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

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

430

str(error))

431

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

432

326

433

def cleanup(self):

327

434

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

328

435

if self.group is not None:

333

440

pass

334

441

self.group = None

335

442

self.remove()

443

336

444

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

337

445

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

338

446

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

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

447

bad_states = {

448

avahi.SERVER_INVALID: "Zeroconf server invalid",

449

avahi.SERVER_REGISTERING: None,

450

avahi.SERVER_COLLISION: "Zeroconf server name collision",

451

avahi.SERVER_FAILURE: "Zeroconf server failure",

452

}

346

453

if state in bad_states:

347

454

if bad_states[state] is not None:

348

455

if error is None:

351

458

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

352

459

self.cleanup()

353

460

elif state == avahi.SERVER_RUNNING:

354

self.add()

461

try:

462

self.add()

463

except dbus.exceptions.DBusException as error:

464

if (error.get_dbus_name()

465

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

466

logger.info("Local Zeroconf service name"

467

" collision.")

468

return self.rename(remove=False)

469

else:

470

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

471

self.cleanup()

472

os._exit(1)

355

473

else:

356

474

if error is None:

357

475

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

358

476

else:

359

477

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

478

360

479

def activate(self):

361

480

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

362

481

if self.server is None:

366

485

follow_name_owner_changes=True),

367

486

avahi.DBUS_INTERFACE_SERVER)

368

487

self.server.connect_to_signal("StateChanged",

369

self.server_state_changed)

488

self.server_state_changed)

370

489

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

371

490

491

372

492

class AvahiServiceToSyslog(AvahiService):

373

def rename(self):

493

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

374

494

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

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

495

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

496

syslogger.setFormatter(logging.Formatter(

497

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

498

.format(self.name)))

380

499

return ret

381

500

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

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

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

501

# Pretend that we have a GnuTLS module

502

class GnuTLS(object):

503

"""This isn't so much a class as it is a module-like namespace.

504

It is instantiated once, and simulates having a GnuTLS module."""

505

506

_library = ctypes.cdll.LoadLibrary(

507

ctypes.util.find_library("gnutls"))

508

_need_version = b"3.3.0"

509

def __init__(self):

510

# Need to use class name "GnuTLS" here, since this method is

511

# called before the assignment to the "gnutls" global variable

512

# happens.

513

if GnuTLS.check_version(self._need_version) is None:

514

raise GnuTLS.Error("Needs GnuTLS {} or later"

515

.format(self._need_version))

516

517

# Unless otherwise indicated, the constants and types below are

518

# all from the gnutls/gnutls.h C header file.

519

520

# Constants

521

E_SUCCESS = 0

522

E_INTERRUPTED = -52

523

E_AGAIN = -28

524

CRT_OPENPGP = 2

525

CLIENT = 2

526

SHUT_RDWR = 0

527

CRD_CERTIFICATE = 1

528

E_NO_CERTIFICATE_FOUND = -49

529

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

530

531

# Types

532

class session_int(ctypes.Structure):

533

_fields_ = []

534

session_t = ctypes.POINTER(session_int)

535

class certificate_credentials_st(ctypes.Structure):

536

_fields_ = []

537

certificate_credentials_t = ctypes.POINTER(

538

certificate_credentials_st)

539

certificate_type_t = ctypes.c_int

540

class datum_t(ctypes.Structure):

541

_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),

542

('size', ctypes.c_uint)]

543

class openpgp_crt_int(ctypes.Structure):

544

_fields_ = []

545

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

546

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

547

log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)

548

credentials_type_t = ctypes.c_int

549

transport_ptr_t = ctypes.c_void_p

550

close_request_t = ctypes.c_int

551

552

# Exceptions

553

class Error(Exception):

554

# We need to use the class name "GnuTLS" here, since this

555

# exception might be raised from within GnuTLS.__init__,

556

# which is called before the assignment to the "gnutls"

557

# global variable has happened.

558

def __init__(self, message = None, code = None, args=()):

559

# Default usage is by a message string, but if a return

560

# code is passed, convert it to a string with

561

# gnutls.strerror()

562

self.code = code

563

if message is None and code is not None:

564

message = GnuTLS.strerror(code)

565

return super(GnuTLS.Error, self).__init__(

566

message, *args)

567

568

class CertificateSecurityError(Error):

569

pass

570

571

# Classes

572

class Credentials(object):

573

def __init__(self):

574

self._c_object = gnutls.certificate_credentials_t()

575

gnutls.certificate_allocate_credentials(

576

ctypes.byref(self._c_object))

577

self.type = gnutls.CRD_CERTIFICATE

578

579

def __del__(self):

580

gnutls.certificate_free_credentials(self._c_object)

581

582

class ClientSession(object):

583

def __init__(self, socket, credentials = None):

584

self._c_object = gnutls.session_t()

585

gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)

586

gnutls.set_default_priority(self._c_object)

587

gnutls.transport_set_ptr(self._c_object, socket.fileno())

588

gnutls.handshake_set_private_extensions(self._c_object,

589

True)

590

self.socket = socket

591

if credentials is None:

592

credentials = gnutls.Credentials()

593

gnutls.credentials_set(self._c_object, credentials.type,

594

ctypes.cast(credentials._c_object,

595

ctypes.c_void_p))

596

self.credentials = credentials

597

598

def __del__(self):

599

gnutls.deinit(self._c_object)

600

601

def handshake(self):

602

return gnutls.handshake(self._c_object)

603

604

def send(self, data):

605

data = bytes(data)

606

data_len = len(data)

607

while data_len > 0:

608

data_len -= gnutls.record_send(self._c_object,

609

data[-data_len:],

610

data_len)

611

612

def bye(self):

613

return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)

614

615

# Error handling functions

616

def _error_code(result):

617

"""A function to raise exceptions on errors, suitable

618

for the 'restype' attribute on ctypes functions"""

619

if result >= 0:

620

return result

621

if result == gnutls.E_NO_CERTIFICATE_FOUND:

622

raise gnutls.CertificateSecurityError(code = result)

623

raise gnutls.Error(code = result)

624

625

def _retry_on_error(result, func, arguments):

626

"""A function to retry on some errors, suitable

627

for the 'errcheck' attribute on ctypes functions"""

628

while result < 0:

629

if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):

630

return _error_code(result)

631

result = func(*arguments)

632

return result

633

634

# Unless otherwise indicated, the function declarations below are

635

# all from the gnutls/gnutls.h C header file.

636

637

# Functions

638

priority_set_direct = _library.gnutls_priority_set_direct

639

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

640

ctypes.POINTER(ctypes.c_char_p)]

641

priority_set_direct.restype = _error_code

642

643

init = _library.gnutls_init

644

init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]

645

init.restype = _error_code

646

647

set_default_priority = _library.gnutls_set_default_priority

648

set_default_priority.argtypes = [session_t]

649

set_default_priority.restype = _error_code

650

651

record_send = _library.gnutls_record_send

652

record_send.argtypes = [session_t, ctypes.c_void_p,

653

ctypes.c_size_t]

654

record_send.restype = ctypes.c_ssize_t

655

record_send.errcheck = _retry_on_error

656

657

certificate_allocate_credentials = (

658

_library.gnutls_certificate_allocate_credentials)

659

certificate_allocate_credentials.argtypes = [

660

ctypes.POINTER(certificate_credentials_t)]

661

certificate_allocate_credentials.restype = _error_code

662

663

certificate_free_credentials = (

664

_library.gnutls_certificate_free_credentials)

665

certificate_free_credentials.argtypes = [certificate_credentials_t]

666

certificate_free_credentials.restype = None

667

668

handshake_set_private_extensions = (

669

_library.gnutls_handshake_set_private_extensions)

670

handshake_set_private_extensions.argtypes = [session_t,

671

ctypes.c_int]

672

handshake_set_private_extensions.restype = None

673

674

credentials_set = _library.gnutls_credentials_set

675

credentials_set.argtypes = [session_t, credentials_type_t,

676

ctypes.c_void_p]

677

credentials_set.restype = _error_code

678

679

strerror = _library.gnutls_strerror

680

strerror.argtypes = [ctypes.c_int]

681

strerror.restype = ctypes.c_char_p

682

683

certificate_type_get = _library.gnutls_certificate_type_get

684

certificate_type_get.argtypes = [session_t]

685

certificate_type_get.restype = _error_code

686

687

certificate_get_peers = _library.gnutls_certificate_get_peers

688

certificate_get_peers.argtypes = [session_t,

689

ctypes.POINTER(ctypes.c_uint)]

690

certificate_get_peers.restype = ctypes.POINTER(datum_t)

691

692

global_set_log_level = _library.gnutls_global_set_log_level

693

global_set_log_level.argtypes = [ctypes.c_int]

694

global_set_log_level.restype = None

695

696

global_set_log_function = _library.gnutls_global_set_log_function

697

global_set_log_function.argtypes = [log_func]

698

global_set_log_function.restype = None

699

700

deinit = _library.gnutls_deinit

701

deinit.argtypes = [session_t]

702

deinit.restype = None

703

704

handshake = _library.gnutls_handshake

705

handshake.argtypes = [session_t]

706

handshake.restype = _error_code

707

handshake.errcheck = _retry_on_error

708

709

transport_set_ptr = _library.gnutls_transport_set_ptr

710

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

711

transport_set_ptr.restype = None

712

713

bye = _library.gnutls_bye

714

bye.argtypes = [session_t, close_request_t]

715

bye.restype = _error_code

716

bye.errcheck = _retry_on_error

717

718

check_version = _library.gnutls_check_version

719

check_version.argtypes = [ctypes.c_char_p]

720

check_version.restype = ctypes.c_char_p

721

722

# All the function declarations below are from gnutls/openpgp.h

723

724

openpgp_crt_init = _library.gnutls_openpgp_crt_init

725

openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]

726

openpgp_crt_init.restype = _error_code

727

728

openpgp_crt_import = _library.gnutls_openpgp_crt_import

729

openpgp_crt_import.argtypes = [openpgp_crt_t,

730

ctypes.POINTER(datum_t),

731

openpgp_crt_fmt_t]

732

openpgp_crt_import.restype = _error_code

733

734

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

735

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

736

ctypes.POINTER(ctypes.c_uint)]

737

openpgp_crt_verify_self.restype = _error_code

738

739

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

740

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

741

openpgp_crt_deinit.restype = None

742

743

openpgp_crt_get_fingerprint = (

744

_library.gnutls_openpgp_crt_get_fingerprint)

745

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

746

ctypes.c_void_p,

747

ctypes.POINTER(

748

ctypes.c_size_t)]

749

openpgp_crt_get_fingerprint.restype = _error_code

750

751

# Remove non-public functions

752

del _error_code, _retry_on_error

753

# Create the global "gnutls" object, simulating a module

754

gnutls = GnuTLS()

755

756

def call_pipe(connection, # : multiprocessing.Connection

757

func, *args, **kwargs):

758

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

759

760

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

761

return value on the provided multiprocessing.Connection.

762

"""

763

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

764

connection.close()

765

388

766

class Client(object):

389

767

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

390

768

395

773

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

396

774

to see if the client lives.

397

775

'None' if no process is running.

398

checker_callback_tag: a gobject event source tag, or None

776

checker_callback_tag: a GLib event source tag, or None

399

777

checker_command: string; External command which is run to check

400

778

if client lives. %() expansions are done at

401

779

runtime with vars(self) as dict, so that for

402

780

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

403

checker_initiator_tag: a gobject event source tag, or None

781

checker_initiator_tag: a GLib event source tag, or None

404

782

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

405

783

client_structure: Object describing what attributes a client has

406

784

and is used for storing the client at exit

407

785

current_checker_command: string; current running checker_command

408

disable_initiator_tag: a gobject event source tag, or None

786

disable_initiator_tag: a GLib event source tag, or None

409

787

enabled: bool()

410

788

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

411

789

uniquely identify the client

415

793

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

416

794

last_checker_status: integer between 0 and 255 reflecting exit

417

795

status of last checker. -1 reflects crashed

418

checker, or None.

796

checker, -2 means no checker completed yet.

797

last_checker_signal: The signal which killed the last checker, if

798

last_checker_status is -1

419

799

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

420

800

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

421

801

D-Bus identifiers

426

806

runtime_expansions: Allowed attributes for runtime expansion.

427

807

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

428

808

disabled, or None

809

server_settings: The server_settings dict from main()

429

810

"""

430

811

431

812

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

813

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

814

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

815

"last_approval_request", "last_checked_ok",

434

816

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

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

460

817

client_defaults = {

818

"timeout": "PT5M",

819

"extended_timeout": "PT15M",

820

"interval": "PT2M",

821

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

822

"host": "",

823

"approval_delay": "PT0S",

824

"approval_duration": "PT1S",

825

"approved_by_default": "True",

826

"enabled": "True",

827

}

828

461

829

@staticmethod

462

830

def config_parser(config):

463

831

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

478

846

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

479

847

"enabled")

480

848

849

# Uppercase and remove spaces from fingerprint for later

850

# comparison purposes with return value from the

851

# fingerprint() function

481

852

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

482

853

.replace(" ", ""))

483

854

if "secret" in section:

484

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

855

client["secret"] = codecs.decode(section["secret"]

856

.encode("utf-8"),

857

"base64")

485

858

elif "secfile" in section:

486

859

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

487

860

(section["secfile"])),

488

861

"rb") as secfile:

489

862

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

490

863

else:

491

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

492

% section)

864

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

865

.format(section))

493

866

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

494

867

client["extended_timeout"] = string_to_delta(

495

868

section["extended_timeout"])

501

874

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

502

875

client["last_approval_request"] = None

503

876

client["last_checked_ok"] = None

504

client["last_checker_status"] = None

877

client["last_checker_status"] = -2

505

878

506

879

return settings

507

508

509

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

510

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

511

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

512

attribute."""

880

881

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

513

882

self.name = name

883

if server_settings is None:

884

server_settings = {}

885

self.server_settings = server_settings

514

886

# adding all client settings

515

for setting, value in settings.iteritems():

887

for setting, value in settings.items():

516

888

setattr(self, setting, value)

517

889

518

890

if self.enabled:

524

896

else:

525

897

self.last_enabled = None

526

898

self.expires = None

527

899

528

900

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

532

901

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

533

902

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

534

903

datetime.datetime.utcnow())

535

904

536

905

# attributes specific for this server instance

537

906

self.checker = None

538

907

self.checker_initiator_tag = None

541

910

self.current_checker_command = None

542

911

self.approved = None

543

912

self.approvals_pending = 0

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

913

self.changedstate = multiprocessing_manager.Condition(

914

multiprocessing_manager.Lock())

915

self.client_structure = [attr

916

for attr in self.__dict__.keys()

549

917

if not attr.startswith("_")]

550

918

self.client_structure.append("client_structure")

551

919

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

920

for name, t in inspect.getmembers(

921

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

556

922

if not name.startswith("_"):

557

923

self.client_structure.append(name)

558

924

566

932

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

567

933

# Already enabled

568

934

return

569

self.send_changedstate()

570

935

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

571

936

self.enabled = True

572

937

self.last_enabled = datetime.datetime.utcnow()

573

938

self.init_checker()

939

self.send_changedstate()

574

940

575

941

def disable(self, quiet=True):

576

942

"""Disable this client."""

577

943

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

578

944

return False

579

945

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

946

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

583

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

584

gobject.source_remove(self.disable_initiator_tag)

947

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

948

GLib.source_remove(self.disable_initiator_tag)

585

949

self.disable_initiator_tag = None

586

950

self.expires = None

587

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

588

gobject.source_remove(self.checker_initiator_tag)

951

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

952

GLib.source_remove(self.checker_initiator_tag)

589

953

self.checker_initiator_tag = None

590

954

self.stop_checker()

591

955

self.enabled = False

592

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

956

if not quiet:

957

self.send_changedstate()

958

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

593

959

return False

594

960

595

961

def __del__(self):

598

964

def init_checker(self):

599

965

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

600

966

# and every interval from then on.

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

967

if self.checker_initiator_tag is not None:

968

GLib.source_remove(self.checker_initiator_tag)

969

self.checker_initiator_tag = GLib.timeout_add(

970

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

971

self.start_checker)

604

972

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

973

if self.disable_initiator_tag is not None:

974

GLib.source_remove(self.disable_initiator_tag)

975

self.disable_initiator_tag = GLib.timeout_add(

976

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

608

977

# Also start a new checker *right now*.

609

978

self.start_checker()

610

979

611

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

980

def checker_callback(self, source, condition, connection,

981

command):

612

982

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

613

983

self.checker_callback_tag = None

614

984

self.checker = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

985

# Read return code from connection (see call_pipe)

986

returncode = connection.recv()

987

connection.close()

988

989

if returncode >= 0:

990

self.last_checker_status = returncode

991

self.last_checker_signal = None

617

992

if self.last_checker_status == 0:

618

993

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

619

994

vars(self))

620

995

self.checked_ok()

621

996

else:

622

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

623

vars(self))

997

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

624

998

else:

625

999

self.last_checker_status = -1

1000

self.last_checker_signal = -returncode

626

1001

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

627

1002

vars(self))

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

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

633

alive and well.

634

"""

1003

return False

1004

1005

def checked_ok(self):

1006

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

1007

self.last_checked_ok = datetime.datetime.utcnow()

1008

self.last_checker_status = 0

1009

self.last_checker_signal = None

1010

self.bump_timeout()

1011

1012

def bump_timeout(self, timeout=None):

1013

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

635

1014

if timeout is None:

636

1015

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

638

1016

if self.disable_initiator_tag is not None:

639

gobject.source_remove(self.disable_initiator_tag)

1017

GLib.source_remove(self.disable_initiator_tag)

1018

self.disable_initiator_tag = None

640

1019

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1020

self.disable_initiator_tag = GLib.timeout_add(

1021

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

644

1022

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

645

1023

646

1024

def need_approval(self):

652

1030

If a checker already exists, leave it running and do

653

1031

nothing."""

654

1032

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

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

1033

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

1034

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

1035

# would inevitably timeout, since no checker would get a

1036

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

659

1037

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

660

1038

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

661

1039

# should be.

662

1040

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

self.current_checker_command)

1041

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

1042

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

1043

self.checker.join()

1044

self.checker = None

676

1045

# Start a new checker if needed

677

1046

if self.checker is None:

1047

# Escape attributes for the shell

1048

escaped_attrs = {

1049

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

1050

for attr in self.runtime_expansions }

678

1051

try:

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

1052

command = self.checker_command % escaped_attrs

1053

except TypeError as error:

1054

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

1055

self.checker_command,

1056

exc_info=error)

1057

return True # Try again later

697

1058

self.current_checker_command = command

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

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

720

error)

721

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

1059

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

1060

self.name)

1061

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

1062

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

1063

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

1064

# always replaced by /dev/null.)

1065

# The exception is when not debugging but nevertheless

1066

# running in the foreground; use the previously

1067

# created wnull.

1068

popen_args = { "close_fds": True,

1069

"shell": True,

1070

"cwd": "/" }

1071

if (not self.server_settings["debug"]

1072

and self.server_settings["foreground"]):

1073

popen_args.update({"stdout": wnull,

1074

"stderr": wnull })

1075

pipe = multiprocessing.Pipe(duplex = False)

1076

self.checker = multiprocessing.Process(

1077

target = call_pipe,

1078

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

1079

kwargs = popen_args)

1080

self.checker.start()

1081

self.checker_callback_tag = GLib.io_add_watch(

1082

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

1083

self.checker_callback, pipe[0], command)

1084

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

722

1085

return True

723

1086

724

1087

def stop_checker(self):

725

1088

"""Force the checker process, if any, to stop."""

726

1089

if self.checker_callback_tag:

727

gobject.source_remove(self.checker_callback_tag)

1090

GLib.source_remove(self.checker_callback_tag)

728

1091

self.checker_callback_tag = None

729

1092

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

730

1093

return

731

1094

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

732

try:

733

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

734

#time.sleep(0.5)

735

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

736

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

737

except OSError as error:

738

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

739

raise

1095

self.checker.terminate()

740

1096

self.checker = None

741

1097

742

1098

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1099

def dbus_service_property(dbus_interface,

1100

signature="v",

1101

access="readwrite",

1102

byte_arrays=False):

745

1103

"""Decorators for marking methods of a DBusObjectWithProperties to

746

1104

become properties on the D-Bus.

747

1105

756

1114

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

757

1115

if byte_arrays and signature != "ay":

758

1116

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

759

" signature %r" % signature)

1117

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

1118

760

1119

def decorator(func):

761

1120

func._dbus_is_property = True

762

1121

func._dbus_interface = dbus_interface

767

1126

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

768

1127

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

1128

return func

1129

1130

return decorator

1131

1132

1133

def dbus_interface_annotations(dbus_interface):

1134

"""Decorator for marking functions returning interface annotations

1135

1136

Usage:

1137

1138

@dbus_interface_annotations("org.example.Interface")

1139

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

1140

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

1141

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

1142

"false"}

1143

"""

1144

1145

def decorator(func):

1146

func._dbus_is_interface = True

1147

func._dbus_interface = dbus_interface

1148

func._dbus_name = dbus_interface

1149

return func

1150

1151

return decorator

1152

1153

1154

def dbus_annotations(annotations):

1155

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

1156

Usage:

1157

1158

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

1159

"org.freedesktop.DBus.Property."

1160

"EmitsChangedSignal": "false"})

1161

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

1162

access="r")

1163

def Property_dbus_property(self):

1164

return dbus.Boolean(False)

1165

1166

See also the DBusObjectWithAnnotations class.

1167

"""

1168

1169

def decorator(func):

1170

func._dbus_annotations = annotations

1171

return func

1172

770

1173

return decorator

771

1174

772

1175

773

1176

class DBusPropertyException(dbus.exceptions.DBusException):

774

1177

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

775

1178

"""

776

def __unicode__(self):

777

return unicode(str(self))

1179

pass

778

1180

779

1181

780

1182

class DBusPropertyAccessException(DBusPropertyException):

789

1191

pass

790

1192

791

1193

792

class DBusObjectWithProperties(dbus.service.Object):

1194

class DBusObjectWithAnnotations(dbus.service.Object):

1195

"""A D-Bus object with annotations.

1196

1197

Classes inheriting from this can use the dbus_annotations

1198

decorator to add annotations to methods or signals.

1199

"""

1200

1201

@staticmethod

1202

def _is_dbus_thing(thing):

1203

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

1204

1205

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

1206

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

1207

"""

1208

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

1209

False)

1210

1211

def _get_all_dbus_things(self, thing):

1212

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

1213

"""

1214

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

1215

athing.__get__(self))

1216

for cls in self.__class__.__mro__

1217

for name, athing in

1218

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

1219

1220

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1221

out_signature = "s",

1222

path_keyword = 'object_path',

1223

connection_keyword = 'connection')

1224

def Introspect(self, object_path, connection):

1225

"""Overloading of standard D-Bus method.

1226

1227

Inserts annotation tags on methods and signals.

1228

"""

1229

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

1230

connection)

1231

try:

1232

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

1233

1234

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

1235

# Add annotation tags

1236

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

1237

for tag in if_tag.getElementsByTagName(typ):

1238

annots = dict()

1239

for name, prop in (self.

1240

_get_all_dbus_things(typ)):

1241

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

1242

and prop._dbus_interface

1243

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

1244

annots.update(getattr(

1245

prop, "_dbus_annotations", {}))

1246

for name, value in annots.items():

1247

ann_tag = document.createElement(

1248

"annotation")

1249

ann_tag.setAttribute("name", name)

1250

ann_tag.setAttribute("value", value)

1251

tag.appendChild(ann_tag)

1252

# Add interface annotation tags

1253

for annotation, value in dict(

1254

itertools.chain.from_iterable(

1255

annotations().items()

1256

for name, annotations

1257

in self._get_all_dbus_things("interface")

1258

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

1259

)).items():

1260

ann_tag = document.createElement("annotation")

1261

ann_tag.setAttribute("name", annotation)

1262

ann_tag.setAttribute("value", value)

1263

if_tag.appendChild(ann_tag)

1264

# Fix argument name for the Introspect method itself

1265

if (if_tag.getAttribute("name")

1266

== dbus.INTROSPECTABLE_IFACE):

1267

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

1268

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

1269

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

1270

if (arg.getAttribute("direction")

1271

== "out"):

1272

arg.setAttribute("name",

1273

"xml_data")

1274

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

1275

document.unlink()

1276

except (AttributeError, xml.dom.DOMException,

1277

xml.parsers.expat.ExpatError) as error:

1278

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

1279

exc_info=error)

1280

return xmlstring

1281

1282

1283

class DBusObjectWithProperties(DBusObjectWithAnnotations):

793

1284

"""A D-Bus object with properties.

794

1285

795

1286

Classes inheriting from this can use the dbus_service_property

797

1288

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

798

1289

"""

799

1290

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

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

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

812

1291

def _get_dbus_property(self, interface_name, property_name):

813

1292

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

814

1293

property with the specified name and interface.

815

1294

"""

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1295

for cls in self.__class__.__mro__:

1296

for name, value in inspect.getmembers(

1297

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

819

1298

if (value._dbus_name == property_name

820

1299

and value._dbus_interface == interface_name):

821

1300

return value.__get__(self)

822

1301

823

1302

# No such property

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

1303

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

1304

self.dbus_object_path, interface_name, property_name))

1305

1306

@classmethod

1307

def _get_all_interface_names(cls):

1308

"""Get a sequence of all interfaces supported by an object"""

1309

return (name for name in set(getattr(getattr(x, attr),

1310

"_dbus_interface", None)

1311

for x in (inspect.getmro(cls))

1312

for attr in dir(x))

1313

if name is not None)

1314

1315

@dbus.service.method(dbus.PROPERTIES_IFACE,

1316

in_signature="ss",

829

1317

out_signature="v")

830

1318

def Get(self, interface_name, property_name):

831

1319

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

849

1337

# The byte_arrays option is not supported yet on

850

1338

# signatures other than "ay".

851

1339

if prop._dbus_signature != "ay":

852

raise ValueError

1340

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

1341

"'ay' signature {!r}"

1342

.format(prop._dbus_signature))

853

1343

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

854

1344

for byte in value))

855

1345

prop(value)

856

1346

857

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

1347

@dbus.service.method(dbus.PROPERTIES_IFACE,

1348

in_signature="s",

858

1349

out_signature="a{sv}")

859

1350

def GetAll(self, interface_name):

860

1351

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

863

1354

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

864

1355

"""

865

1356

properties = {}

866

for name, prop in self._get_all_dbus_properties():

1357

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

867

1358

if (interface_name

868

1359

and interface_name != prop._dbus_interface):

869

1360

# Interface non-empty but did not match

875

1366

if not hasattr(value, "variant_level"):

876

1367

properties[name] = value

877

1368

continue

878

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

879

value.variant_level+1)

1369

properties[name] = type(value)(

1370

value, variant_level = value.variant_level + 1)

880

1371

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

881

1372

1373

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

1374

def PropertiesChanged(self, interface_name, changed_properties,

1375

invalidated_properties):

1376

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

1377

standard.

1378

"""

1379

pass

1380

882

1381

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

883

1382

out_signature="s",

884

1383

path_keyword='object_path',

885

1384

connection_keyword='connection')

886

1385

def Introspect(self, object_path, connection):

887

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

1386

"""Overloading of standard D-Bus method.

1387

1388

Inserts property tags and interface annotation tags.

888

1389

"""

889

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

890

connection)

1390

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1391

object_path,

1392

connection)

891

1393

try:

892

1394

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

1395

893

1396

def make_tag(document, name, prop):

894

1397

e = document.createElement("property")

895

1398

e.setAttribute("name", name)

896

1399

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

897

1400

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

898

1401

return e

1402

899

1403

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

1404

# Add property tags

900

1405

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

901

1406

for name, prop

902

in self._get_all_dbus_properties()

1407

in self._get_all_dbus_things("property")

903

1408

if prop._dbus_interface

904

1409

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

905

1410

if_tag.appendChild(tag)

1411

# Add annotation tags for properties

1412

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

1413

annots = dict()

1414

for name, prop in self._get_all_dbus_things(

1415

"property"):

1416

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

1417

and prop._dbus_interface

1418

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

1419

annots.update(getattr(

1420

prop, "_dbus_annotations", {}))

1421

for name, value in annots.items():

1422

ann_tag = document.createElement(

1423

"annotation")

1424

ann_tag.setAttribute("name", name)

1425

ann_tag.setAttribute("value", value)

1426

tag.appendChild(ann_tag)

906

1427

# Add the names to the return values for the

907

1428

# "org.freedesktop.DBus.Properties" methods

908

1429

if (if_tag.getAttribute("name")

923

1444

except (AttributeError, xml.dom.DOMException,

924

1445

xml.parsers.expat.ExpatError) as error:

925

1446

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

926

error)

927

return xmlstring

928

929

930

def datetime_to_dbus (dt, variant_level=0):

1447

exc_info=error)

1448

return xmlstring

1449

1450

try:

1451

dbus.OBJECT_MANAGER_IFACE

1452

except AttributeError:

1453

dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"

1454

1455

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1456

"""A D-Bus object with an ObjectManager.

1457

1458

Classes inheriting from this exposes the standard

1459

GetManagedObjects call and the InterfacesAdded and

1460

InterfacesRemoved signals on the standard

1461

"org.freedesktop.DBus.ObjectManager" interface.

1462

1463

Note: No signals are sent automatically; they must be sent

1464

manually.

1465

"""

1466

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1467

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

1468

def GetManagedObjects(self):

1469

"""This function must be overridden"""

1470

raise NotImplementedError()

1471

1472

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1473

signature = "oa{sa{sv}}")

1474

def InterfacesAdded(self, object_path, interfaces_and_properties):

1475

pass

1476

1477

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")

1478

def InterfacesRemoved(self, object_path, interfaces):

1479

pass

1480

1481

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1482

out_signature = "s",

1483

path_keyword = 'object_path',

1484

connection_keyword = 'connection')

1485

def Introspect(self, object_path, connection):

1486

"""Overloading of standard D-Bus method.

1487

1488

Override return argument name of GetManagedObjects to be

1489

"objpath_interfaces_and_properties"

1490

"""

1491

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1492

object_path,

1493

connection)

1494

try:

1495

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

1496

1497

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

1498

# Fix argument name for the GetManagedObjects method

1499

if (if_tag.getAttribute("name")

1500

== dbus.OBJECT_MANAGER_IFACE):

1501

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

1502

if (cn.getAttribute("name")

1503

== "GetManagedObjects"):

1504

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

1505

if (arg.getAttribute("direction")

1506

== "out"):

1507

arg.setAttribute(

1508

"name",

1509

"objpath_interfaces"

1510

"_and_properties")

1511

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

1512

document.unlink()

1513

except (AttributeError, xml.dom.DOMException,

1514

xml.parsers.expat.ExpatError) as error:

1515

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

1516

exc_info = error)

1517

return xmlstring

1518

1519

def datetime_to_dbus(dt, variant_level=0):

931

1520

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

932

1521

if dt is None:

933

1522

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

1523

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

1524

1525

1526

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1527

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

1528

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

1529

interface names according to the "alt_interface_names" mapping.

1530

Usage:

1531

1532

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

1533

"net.example.AlternateInterface"})

1534

class SampleDBusObject(dbus.service.Object):

1535

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

1536

def SampleDBusMethod():

1537

pass

1538

1539

The above "SampleDBusMethod" on "SampleDBusObject" will be

1540

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

1541

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

1542

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

1543

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

1544

1545

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

1546

(from DBusObjectWithProperties) and interfaces (from the

1547

dbus_interface_annotations decorator).

942

1548

"""

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

1549

1550

def wrapper(cls):

1551

for orig_interface_name, alt_interface_name in (

1552

alt_interface_names.items()):

1553

attr = {}

1554

interface_names = set()

1555

# Go though all attributes of the class

1556

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

950

1557

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

951

1558

# with the wrong interface name

952

1559

if (not hasattr(attribute, "_dbus_interface")

953

or not attribute._dbus_interface

954

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

1560

or not attribute._dbus_interface.startswith(

1561

orig_interface_name)):

955

1562

continue

956

1563

# Create an alternate D-Bus interface name based on

957

1564

# the current name

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1565

alt_interface = attribute._dbus_interface.replace(

1566

orig_interface_name, alt_interface_name)

1567

interface_names.add(alt_interface)

961

1568

# Is this a D-Bus signal?

962

1569

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

963

# Extract the original non-method function by

964

# black magic

965

nonmethod_func = (dict(

1570

# Extract the original non-method undecorated

1571

# function by black magic

1572

if sys.version_info.major == 2:

1573

nonmethod_func = (dict(

966

1574

zip(attribute.func_code.co_freevars,

967

attribute.__closure__))["func"]

968

.cell_contents)

1575

attribute.__closure__))

1576

["func"].cell_contents)

1577

else:

1578

nonmethod_func = (dict(

1579

zip(attribute.__code__.co_freevars,

1580

attribute.__closure__))

1581

["func"].cell_contents)

969

1582

# Create a new, but exactly alike, function

970

1583

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

971

1584

# with the alternate D-Bus interface name

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

nonmethod_func.func_closure)))

1585

new_function = copy_function(nonmethod_func)

1586

new_function = (dbus.service.signal(

1587

alt_interface,

1588

attribute._dbus_signature)(new_function))

1589

# Copy annotations, if any

1590

try:

1591

new_function._dbus_annotations = dict(

1592

attribute._dbus_annotations)

1593

except AttributeError:

1594

pass

981

1595

# Define a creator of a function to call both the

982

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

983

# signals gets sent when the function is called

1596

# original and alternate functions, so both the

1597

# original and alternate signals gets sent when

1598

# the function is called

984

1599

def fixscope(func1, func2):

985

1600

"""This function is a scope container to pass

986

1601

func1 and func2 to the "call_both" function

987

1602

outside of its arguments"""

1603

1604

@functools.wraps(func2)

988

1605

def call_both(*args, **kwargs):

989

1606

"""This function will emit two D-Bus

990

1607

signals by calling func1 and func2"""

991

1608

func1(*args, **kwargs)

992

1609

func2(*args, **kwargs)

1610

# Make wrapper function look like a D-Bus signal

1611

for name, attr in inspect.getmembers(func2):

1612

if name.startswith("_dbus_"):

1613

setattr(call_both, name, attr)

1614

993

1615

return call_both

994

1616

# Create the "call_both" function and add it to

995

1617

# the class

996

attr[attrname] = fixscope(attribute,

997

new_function)

1618

attr[attrname] = fixscope(attribute, new_function)

998

1619

# Is this a D-Bus method?

999

1620

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

1000

1621

# Create a new, but exactly alike, function

1001

1622

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

1002

1623

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

1003

1624

# to the class.

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

attribute.func_closure)))

1625

attr[attrname] = (

1626

dbus.service.method(

1627

alt_interface,

1628

attribute._dbus_in_signature,

1629

attribute._dbus_out_signature)

1630

(copy_function(attribute)))

1631

# Copy annotations, if any

1632

try:

1633

attr[attrname]._dbus_annotations = dict(

1634

attribute._dbus_annotations)

1635

except AttributeError:

1636

pass

1014

1637

# Is this a D-Bus property?

1015

1638

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

1016

1639

# Create a new, but exactly alike, function

1017

1640

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

1018

1641

# property with the alternate D-Bus interface

1019

1642

# name. Add it to the class.

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

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

1034

1035

1643

attr[attrname] = (dbus_service_property(

1644

alt_interface, attribute._dbus_signature,

1645

attribute._dbus_access,

1646

attribute._dbus_get_args_options

1647

["byte_arrays"])

1648

(copy_function(attribute)))

1649

# Copy annotations, if any

1650

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1653

except AttributeError:

1654

pass

1655

# Is this a D-Bus interface?

1656

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

1657

# Create a new, but exactly alike, function

1658

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

1659

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

1660

# to the class.

1661

attr[attrname] = (

1662

dbus_interface_annotations(alt_interface)

1663

(copy_function(attribute)))

1664

if deprecate:

1665

# Deprecate all alternate interfaces

1666

iname="_AlternateDBusNames_interface_annotation{}"

1667

for interface_name in interface_names:

1668

1669

@dbus_interface_annotations(interface_name)

1670

def func(self):

1671

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

1672

"true" }

1673

# Find an unused name

1674

for aname in (iname.format(i)

1675

for i in itertools.count()):

1676

if aname not in attr:

1677

attr[aname] = func

1678

break

1679

if interface_names:

1680

# Replace the class with a new subclass of it with

1681

# methods, signals, etc. as created above.

1682

if sys.version_info.major == 2:

1683

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

1684

(cls, ), attr)

1685

else:

1686

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

1687

(cls, ), attr)

1688

return cls

1689

1690

return wrapper

1691

1692

1693

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

1694

"se.bsnet.fukt.Mandos"})

1036

1695

class ClientDBus(Client, DBusObjectWithProperties):

1037

1696

"""A Client class using D-Bus

1038

1697

1042

1701

"""

1043

1702

1044

1703

runtime_expansions = (Client.runtime_expansions

1045

+ ("dbus_object_path",))

1704

+ ("dbus_object_path", ))

1705

1706

_interface = "se.recompile.Mandos.Client"

1046

1707

1047

1708

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

1048

1709

1051

1712

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

1052

1713

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

1053

1714

# the D-Bus

1054

client_object_name = unicode(self.name).translate(

1715

client_object_name = str(self.name).translate(

1055

1716

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

1056

1717

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

1057

self.dbus_object_path = (dbus.ObjectPath

1058

("/clients/" + client_object_name))

1718

self.dbus_object_path = dbus.ObjectPath(

1719

"/clients/" + client_object_name)

1059

1720

DBusObjectWithProperties.__init__(self, self.bus,

1060

1721

self.dbus_object_path)

1061

1062

def notifychangeproperty(transform_func,

1063

dbus_name, type_func=lambda x: x,

1064

variant_level=1):

1722

1723

def notifychangeproperty(transform_func, dbus_name,

1724

type_func=lambda x: x,

1725

variant_level=1,

1726

invalidate_only=False,

1727

_interface=_interface):

1065

1728

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

1066

1729

its changes to DBus.

1067

1730

1072

1735

to the D-Bus. Default: no transform

1073

1736

variant_level: D-Bus variant level. Default: 1

1074

1737

"""

1075

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

1738

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

1739

1076

1740

def setter(self, value):

1077

1741

if hasattr(self, "dbus_object_path"):

1078

1742

if (not hasattr(self, attrname) or

1079

1743

type_func(getattr(self, attrname, None))

1080

1744

!= type_func(value)):

1081

dbus_value = transform_func(type_func(value),

1082

variant_level

1083

=variant_level)

1084

self.PropertyChanged(dbus.String(dbus_name),

1085

dbus_value)

1745

if invalidate_only:

1746

self.PropertiesChanged(

1747

_interface, dbus.Dictionary(),

1748

dbus.Array((dbus_name, )))

1749

else:

1750

dbus_value = transform_func(

1751

type_func(value),

1752

variant_level = variant_level)

1753

self.PropertyChanged(dbus.String(dbus_name),

1754

dbus_value)

1755

self.PropertiesChanged(

1756

_interface,

1757

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

1758

dbus_value }),

1759

dbus.Array())

1086

1760

setattr(self, attrname, value)

1087

1761

1088

1762

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

1089

1763

1090

1091

1764

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1092

1765

approvals_pending = notifychangeproperty(dbus.Boolean,

1093

1766

"ApprovalPending",

1095

1768

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

1096

1769

last_enabled = notifychangeproperty(datetime_to_dbus,

1097

1770

"LastEnabled")

1098

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

1099

type_func = lambda checker:

1100

checker is not None)

1771

checker = notifychangeproperty(

1772

dbus.Boolean, "CheckerRunning",

1773

type_func = lambda checker: checker is not None)

1101

1774

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1102

1775

"LastCheckedOK")

1776

last_checker_status = notifychangeproperty(dbus.Int16,

1777

"LastCheckerStatus")

1103

1778

last_approval_request = notifychangeproperty(

1104

1779

datetime_to_dbus, "LastApprovalRequest")

1105

1780

approved_by_default = notifychangeproperty(dbus.Boolean,

1106

1781

"ApprovedByDefault")

1107

approval_delay = notifychangeproperty(dbus.UInt64,

1108

"ApprovalDelay",

1109

type_func =

1110

timedelta_to_milliseconds)

1782

approval_delay = notifychangeproperty(

1783

dbus.UInt64, "ApprovalDelay",

1784

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

1111

1785

approval_duration = notifychangeproperty(

1112

1786

dbus.UInt64, "ApprovalDuration",

1113

type_func = timedelta_to_milliseconds)

1787

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

1114

1788

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

1115

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

1116

type_func =

1117

timedelta_to_milliseconds)

1789

timeout = notifychangeproperty(

1790

dbus.UInt64, "Timeout",

1791

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

1118

1792

extended_timeout = notifychangeproperty(

1119

1793

dbus.UInt64, "ExtendedTimeout",

1120

type_func = timedelta_to_milliseconds)

1121

interval = notifychangeproperty(dbus.UInt64,

1122

"Interval",

1123

type_func =

1124

timedelta_to_milliseconds)

1794

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

1795

interval = notifychangeproperty(

1796

dbus.UInt64, "Interval",

1797

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

1125

1798

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

1799

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

1800

invalidate_only=True)

1126

1801

1127

1802

del notifychangeproperty

1128

1803

1135

1810

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

1136

1811

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

1137

1812

1138

def checker_callback(self, pid, condition, command,

1139

*args, **kwargs):

1140

self.checker_callback_tag = None

1141

self.checker = None

1142

if os.WIFEXITED(condition):

1143

exitstatus = os.WEXITSTATUS(condition)

1813

def checker_callback(self, source, condition,

1814

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

1815

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

1816

connection, command, *args,

1817

**kwargs)

1818

exitstatus = self.last_checker_status

1819

if exitstatus >= 0:

1144

1820

# Emit D-Bus signal

1145

1821

self.CheckerCompleted(dbus.Int16(exitstatus),

1146

dbus.Int64(condition),

1822

# This is specific to GNU libC

1823

dbus.Int64(exitstatus << 8),

1147

1824

dbus.String(command))

1148

1825

else:

1149

1826

# Emit D-Bus signal

1150

1827

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

1151

dbus.Int64(condition),

1828

dbus.Int64(

1829

# This is specific to GNU libC

1830

(exitstatus << 8)

1831

| self.last_checker_signal),

1152

1832

dbus.String(command))

1153

1154

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

1155

*args, **kwargs)

1833

return ret

1156

1834

1157

1835

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

1158

old_checker = self.checker

1159

if self.checker is not None:

1160

old_checker_pid = self.checker.pid

1161

else:

1162

old_checker_pid = None

1836

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

1163

1837

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

1164

1838

# Only if new checker process was started

1165

1839

if (self.checker is not None

1173

1847

return False

1174

1848

1175

1849

def approve(self, value=True):

1176

self.send_changedstate()

1177

1850

self.approved = value

1178

gobject.timeout_add(timedelta_to_milliseconds

1179

(self.approval_duration),

1180

self._reset_approved)

1181

1851

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

1852

* 1000), self._reset_approved)

1853

self.send_changedstate()

1182

1854

1183

1855

## D-Bus methods, signals & properties

1184

_interface = "se.recompile.Mandos.Client"

1856

1857

## Interfaces

1185

1858

1186

1859

## Signals

1187

1860

1198

1871

pass

1199

1872

1200

1873

# PropertyChanged - signal

1874

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

1201

1875

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

1202

1876

def PropertyChanged(self, property, value):

1203

1877

"D-Bus signal"

1237

1911

self.checked_ok()

1238

1912

1239

1913

# Enable - method

1914

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

1240

1915

@dbus.service.method(_interface)

1241

1916

def Enable(self):

1242

1917

"D-Bus method"

1243

1918

self.enable()

1244

1919

1245

1920

# StartChecker - method

1921

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

1246

1922

@dbus.service.method(_interface)

1247

1923

def StartChecker(self):

1248

1924

"D-Bus method"

1249

1925

self.start_checker()

1250

1926

1251

1927

# Disable - method

1928

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

1252

1929

@dbus.service.method(_interface)

1253

1930

def Disable(self):

1254

1931

"D-Bus method"

1255

1932

self.disable()

1256

1933

1257

1934

# StopChecker - method

1935

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

1258

1936

@dbus.service.method(_interface)

1259

1937

def StopChecker(self):

1260

1938

self.stop_checker()

1267

1945

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

1268

1946

1269

1947

# ApprovedByDefault - property

1270

@dbus_service_property(_interface, signature="b",

1948

@dbus_service_property(_interface,

1949

signature="b",

1271

1950

access="readwrite")

1272

1951

def ApprovedByDefault_dbus_property(self, value=None):

1273

1952

if value is None: # get

1275

1954

self.approved_by_default = bool(value)

1276

1955

1277

1956

# ApprovalDelay - property

1278

@dbus_service_property(_interface, signature="t",

1957

@dbus_service_property(_interface,

1958

signature="t",

1279

1959

access="readwrite")

1280

1960

def ApprovalDelay_dbus_property(self, value=None):

1281

1961

if value is None: # get

1282

return dbus.UInt64(self.approval_delay_milliseconds())

1962

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

1963

* 1000)

1283

1964

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

1284

1965

1285

1966

# ApprovalDuration - property

1286

@dbus_service_property(_interface, signature="t",

1967

@dbus_service_property(_interface,

1968

signature="t",

1287

1969

access="readwrite")

1288

1970

def ApprovalDuration_dbus_property(self, value=None):

1289

1971

if value is None: # get

1290

return dbus.UInt64(timedelta_to_milliseconds(

1291

self.approval_duration))

1972

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

1973

* 1000)

1292

1974

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

1293

1975

1294

1976

# Name - property

1977

@dbus_annotations(

1978

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

1295

1979

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

1296

1980

def Name_dbus_property(self):

1297

1981

return dbus.String(self.name)

1298

1982

1299

1983

# Fingerprint - property

1984

@dbus_annotations(

1985

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

1300

1986

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

1301

1987

def Fingerprint_dbus_property(self):

1302

1988

return dbus.String(self.fingerprint)

1303

1989

1304

1990

# Host - property

1305

@dbus_service_property(_interface, signature="s",

1991

@dbus_service_property(_interface,

1992

signature="s",

1306

1993

access="readwrite")

1307

1994

def Host_dbus_property(self, value=None):

1308

1995

if value is None: # get

1309

1996

return dbus.String(self.host)

1310

self.host = unicode(value)

1997

self.host = str(value)

1311

1998

1312

1999

# Created - property

2000

@dbus_annotations(

2001

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

1313

2002

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

1314

2003

def Created_dbus_property(self):

1315

2004

return datetime_to_dbus(self.created)

1320

2009

return datetime_to_dbus(self.last_enabled)

1321

2010

1322

2011

# Enabled - property

1323

@dbus_service_property(_interface, signature="b",

2012

@dbus_service_property(_interface,

2013

signature="b",

1324

2014

access="readwrite")

1325

2015

def Enabled_dbus_property(self, value=None):

1326

2016

if value is None: # get

1331

2021

self.disable()

1332

2022

1333

2023

# LastCheckedOK - property

1334

@dbus_service_property(_interface, signature="s",

2024

@dbus_service_property(_interface,

2025

signature="s",

1335

2026

access="readwrite")

1336

2027

def LastCheckedOK_dbus_property(self, value=None):

1337

2028

if value is not None:

1339

2030

return

1340

2031

return datetime_to_dbus(self.last_checked_ok)

1341

2032

2033

# LastCheckerStatus - property

2034

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

2035

def LastCheckerStatus_dbus_property(self):

2036

return dbus.Int16(self.last_checker_status)

2037

1342

2038

# Expires - property

1343

2039

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

1344

2040

def Expires_dbus_property(self):

1350

2046

return datetime_to_dbus(self.last_approval_request)

1351

2047

1352

2048

# Timeout - property

1353

@dbus_service_property(_interface, signature="t",

2049

@dbus_service_property(_interface,

2050

signature="t",

1354

2051

access="readwrite")

1355

2052

def Timeout_dbus_property(self, value=None):

1356

2053

if value is None: # get

1357

return dbus.UInt64(self.timeout_milliseconds())

2054

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

2055

old_timeout = self.timeout

1358

2056

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

1359

# Reschedule timeout

2057

# Reschedule disabling

1360

2058

if self.enabled:

1361

2059

now = datetime.datetime.utcnow()

1362

time_to_die = timedelta_to_milliseconds(

1363

(self.last_checked_ok + self.timeout) - now)

1364

if time_to_die <= 0:

2060

self.expires += self.timeout - old_timeout

2061

if self.expires <= now:

1365

2062

# The timeout has passed

1366

2063

self.disable()

1367

2064

else:

1368

self.expires = (now +

1369

datetime.timedelta(milliseconds =

1370

time_to_die))

1371

2065

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

1372

2066

is None):

1373

2067

return

1374

gobject.source_remove(self.disable_initiator_tag)

1375

self.disable_initiator_tag = (gobject.timeout_add

1376

(time_to_die,

1377

self.disable))

2068

GLib.source_remove(self.disable_initiator_tag)

2069

self.disable_initiator_tag = GLib.timeout_add(

2070

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

2071

self.disable)

1378

2072

1379

2073

# ExtendedTimeout - property

1380

@dbus_service_property(_interface, signature="t",

2074

@dbus_service_property(_interface,

2075

signature="t",

1381

2076

access="readwrite")

1382

2077

def ExtendedTimeout_dbus_property(self, value=None):

1383

2078

if value is None: # get

1384

return dbus.UInt64(self.extended_timeout_milliseconds())

2079

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

2080

* 1000)

1385

2081

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

1386

2082

1387

2083

# Interval - property

1388

@dbus_service_property(_interface, signature="t",

2084

@dbus_service_property(_interface,

2085

signature="t",

1389

2086

access="readwrite")

1390

2087

def Interval_dbus_property(self, value=None):

1391

2088

if value is None: # get

1392

return dbus.UInt64(self.interval_milliseconds())

2089

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

1393

2090

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

1394

2091

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

1395

2092

return

1396

2093

if self.enabled:

1397

2094

# Reschedule checker run

1398

gobject.source_remove(self.checker_initiator_tag)

1399

self.checker_initiator_tag = (gobject.timeout_add

1400

(value, self.start_checker))

1401

self.start_checker() # Start one now, too

2095

GLib.source_remove(self.checker_initiator_tag)

2096

self.checker_initiator_tag = GLib.timeout_add(

2097

value, self.start_checker)

2098

self.start_checker() # Start one now, too

1402

2099

1403

2100

# Checker - property

1404

@dbus_service_property(_interface, signature="s",

2101

@dbus_service_property(_interface,

2102

signature="s",

1405

2103

access="readwrite")

1406

2104

def Checker_dbus_property(self, value=None):

1407

2105

if value is None: # get

1408

2106

return dbus.String(self.checker_command)

1409

self.checker_command = unicode(value)

2107

self.checker_command = str(value)

1410

2108

1411

2109

# CheckerRunning - property

1412

@dbus_service_property(_interface, signature="b",

2110

@dbus_service_property(_interface,

2111

signature="b",

1413

2112

access="readwrite")

1414

2113

def CheckerRunning_dbus_property(self, value=None):

1415

2114

if value is None: # get

1420

2119

self.stop_checker()

1421

2120

1422

2121

# ObjectPath - property

2122

@dbus_annotations(

2123

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

2124

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

1423

2125

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

1424

2126

def ObjectPath_dbus_property(self):

1425

2127

return self.dbus_object_path # is already a dbus.ObjectPath

1426

2128

1427

2129

# Secret = property

1428

@dbus_service_property(_interface, signature="ay",

1429

access="write", byte_arrays=True)

2130

@dbus_annotations(

2131

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

2132

"invalidates"})

2133

@dbus_service_property(_interface,

2134

signature="ay",

2135

access="write",

2136

byte_arrays=True)

1430

2137

def Secret_dbus_property(self, value):

1431

self.secret = str(value)

2138

self.secret = bytes(value)

1432

2139

1433

2140

del _interface

1434

2141

1438

2145

self._pipe = child_pipe

1439

2146

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

1440

2147

if not self._pipe.recv():

1441

raise KeyError()

2148

raise KeyError(fpr)

1442

2149

1443

2150

def __getattribute__(self, name):

1444

2151

if name == '_pipe':

1448

2155

if data[0] == 'data':

1449

2156

return data[1]

1450

2157

if data[0] == 'function':

2158

1451

2159

def func(*args, **kwargs):

1452

2160

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

1453

2161

return self._pipe.recv()[1]

2162

1454

2163

return func

1455

2164

1456

2165

def __setattr__(self, name, value):

1459

2168

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

1460

2169

1461

2170

1462

class ClientDBusTransitional(ClientDBus):

1463

__metaclass__ = AlternateDBusNamesMetaclass

1464

1465

1466

2171

class ClientHandler(socketserver.BaseRequestHandler, object):

1467

2172

"""A class to handle client connections.

1468

2173

1472

2177

def handle(self):

1473

2178

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

1474

2179

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

1475

unicode(self.client_address))

2180

str(self.client_address))

1476

2181

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

1477

2182

self.server.child_pipe.fileno())

1478

2183

1479

session = (gnutls.connection

1480

.ClientSession(self.request,

1481

gnutls.connection

1482

.X509Credentials()))

1483

1484

# Note: gnutls.connection.X509Credentials is really a

1485

# generic GnuTLS certificate credentials object so long as

1486

# no X.509 keys are added to it. Therefore, we can use it

1487

# here despite using OpenPGP certificates.

2184

session = gnutls.ClientSession(self.request)

1488

2185

1489

2186

#priority = ':'.join(("NONE", "+VERS-TLS1.1",

1490

2187

# "+AES-256-CBC", "+SHA1",

1494

2191

priority = self.server.gnutls_priority

1495

2192

if priority is None:

1496

2193

priority = "NORMAL"

1497

(gnutls.library.functions

1498

.gnutls_priority_set_direct(session._c_object,

1499

priority, None))

2194

gnutls.priority_set_direct(session._c_object,

2195

priority.encode("utf-8"),

2196

None)

1500

2197

1501

2198

# Start communication using the Mandos protocol

1502

2199

# Get protocol number

1504

2201

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

1505

2202

try:

1506

2203

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

1507

raise RuntimeError

2204

raise RuntimeError(line)

1508

2205

except (ValueError, IndexError, RuntimeError) as error:

1509

2206

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

1510

2207

return

1512

2209

# Start GnuTLS connection

1513

2210

try:

1514

2211

session.handshake()

1515

except gnutls.errors.GNUTLSError as error:

2212

except gnutls.Error as error:

1516

2213

logger.warning("Handshake failed: %s", error)

1517

2214

# Do not run session.bye() here: the session is not

1518

2215

# established. Just abandon the request.

1522

2219

approval_required = False

1523

2220

try:

1524

2221

try:

1525

fpr = self.fingerprint(self.peer_certificate

1526

(session))

1527

except (TypeError,

1528

gnutls.errors.GNUTLSError) as error:

2222

fpr = self.fingerprint(

2223

self.peer_certificate(session))

2224

except (TypeError, gnutls.Error) as error:

1529

2225

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

1530

2226

return

1531

2227

logger.debug("Fingerprint: %s", fpr)

1544

2240

while True:

1545

2241

if not client.enabled:

1546

2242

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

1547

client.name)

2243

client.name)

1548

2244

if self.server.use_dbus:

1549

2245

# Emit D-Bus signal

1550

2246

client.Rejected("Disabled")

1559

2255

if self.server.use_dbus:

1560

2256

# Emit D-Bus signal

1561

2257

client.NeedApproval(

1562

client.approval_delay_milliseconds(),

1563

client.approved_by_default)

2258

client.approval_delay.total_seconds()

2259

* 1000, client.approved_by_default)

1564

2260

else:

1565

2261

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

1566

2262

client.name)

1572

2268

#wait until timeout or approved

1573

2269

time = datetime.datetime.now()

1574

2270

client.changedstate.acquire()

1575

(client.changedstate.wait

1576

(float(client.timedelta_to_milliseconds(delay)

1577

/ 1000)))

2271

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

1578

2272

client.changedstate.release()

1579

2273

time2 = datetime.datetime.now()

1580

2274

if (time2 - time) >= delay:

1591

2285

else:

1592

2286

delay -= time2 - time

1593

2287

1594

sent_size = 0

1595

while sent_size < len(client.secret):

1596

try:

1597

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

1598

except gnutls.errors.GNUTLSError as error:

1599

logger.warning("gnutls send failed")

1600

return

1601

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

1602

sent, len(client.secret)

1603

- (sent_size + sent))

1604

sent_size += sent

2288

try:

2289

session.send(client.secret)

2290

except gnutls.Error as error:

2291

logger.warning("gnutls send failed",

2292

exc_info = error)

2293

return

1605

2294

1606

2295

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

1607

2296

# bump the timeout using extended_timeout

1608

client.checked_ok(client.extended_timeout)

2297

client.bump_timeout(client.extended_timeout)

1609

2298

if self.server.use_dbus:

1610

2299

# Emit D-Bus signal

1611

2300

client.GotSecret()

1615

2304

client.approvals_pending -= 1

1616

2305

try:

1617

2306

session.bye()

1618

except gnutls.errors.GNUTLSError as error:

1619

logger.warning("GnuTLS bye failed")

2307

except gnutls.Error as error:

2308

logger.warning("GnuTLS bye failed",

2309

exc_info=error)

1620

2310

1621

2311

@staticmethod

1622

2312

def peer_certificate(session):

1623

2313

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

1624

2314

# If not an OpenPGP certificate...

1625

if (gnutls.library.functions

1626

.gnutls_certificate_type_get(session._c_object)

1627

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1628

# ...do the normal thing

1629

return session.peer_certificate

2315

if (gnutls.certificate_type_get(session._c_object)

2316

!= gnutls.CRT_OPENPGP):

2317

# ...return invalid data

2318

return b""

1630

2319

list_size = ctypes.c_uint(1)

1631

cert_list = (gnutls.library.functions

1632

.gnutls_certificate_get_peers

2320

cert_list = (gnutls.certificate_get_peers

1633

2321

(session._c_object, ctypes.byref(list_size)))

1634

2322

if not bool(cert_list) and list_size.value != 0:

1635

raise gnutls.errors.GNUTLSError("error getting peer"

1636

" certificate")

2323

raise gnutls.Error("error getting peer certificate")

1637

2324

if list_size.value == 0:

1638

2325

return None

1639

2326

cert = cert_list[0]

1643

2330

def fingerprint(openpgp):

1644

2331

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1645

2332

# New GnuTLS "datum" with the OpenPGP public key

1646

datum = (gnutls.library.types

1647

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

1648

ctypes.POINTER

1649

(ctypes.c_ubyte)),

1650

ctypes.c_uint(len(openpgp))))

2333

datum = gnutls.datum_t(

2334

ctypes.cast(ctypes.c_char_p(openpgp),

2335

ctypes.POINTER(ctypes.c_ubyte)),

2336

ctypes.c_uint(len(openpgp)))

1651

2337

# New empty GnuTLS certificate

1652

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1653

(gnutls.library.functions

1654

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2338

crt = gnutls.openpgp_crt_t()

2339

gnutls.openpgp_crt_init(ctypes.byref(crt))

1655

2340

# Import the OpenPGP public key into the certificate

1656

(gnutls.library.functions

1657

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

1658

gnutls.library.constants

1659

.GNUTLS_OPENPGP_FMT_RAW))

2341

gnutls.openpgp_crt_import(crt, ctypes.byref(datum),

2342

gnutls.OPENPGP_FMT_RAW)

1660

2343

# Verify the self signature in the key

1661

2344

crtverify = ctypes.c_uint()

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_verify_self(crt, 0,

1664

ctypes.byref(crtverify)))

2345

gnutls.openpgp_crt_verify_self(crt, 0,

2346

ctypes.byref(crtverify))

1665

2347

if crtverify.value != 0:

1666

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1667

raise (gnutls.errors.CertificateSecurityError

1668

("Verify failed"))

2348

gnutls.openpgp_crt_deinit(crt)

2349

raise gnutls.CertificateSecurityError("Verify failed")

1669

2350

# New buffer for the fingerprint

1670

2351

buf = ctypes.create_string_buffer(20)

1671

2352

buf_len = ctypes.c_size_t()

1672

2353

# Get the fingerprint from the certificate into the buffer

1673

(gnutls.library.functions

1674

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

1675

ctypes.byref(buf_len)))

2354

gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),

2355

ctypes.byref(buf_len))

1676

2356

# Deinit the certificate

1677

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2357

gnutls.openpgp_crt_deinit(crt)

1678

2358

# Convert the buffer to a Python bytestring

1679

2359

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

1680

2360

# Convert the bytestring to hexadecimal notation

1684

2364

1685

2365

class MultiprocessingMixIn(object):

1686

2366

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

2367

1687

2368

def sub_process_main(self, request, address):

1688

2369

try:

1689

2370

self.finish_request(request, address)

1694

2375

def process_request(self, request, address):

1695

2376

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

1696

2377

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

1697

args = (request,

1698

address))

2378

args = (request, address))

1699

2379

proc.start()

1700

2380

return proc

1701

2381

1702

2382

1703

2383

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1704

2384

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

2385

1705

2386

def process_request(self, request, client_address):

1706

2387

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

1707

2388

1716

2397

1717

2398

def add_pipe(self, parent_pipe, proc):

1718

2399

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

1719

raise NotImplementedError

2400

raise NotImplementedError()

1720

2401

1721

2402

1722

2403

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1728

2409

interface: None or a network interface name (string)

1729

2410

use_ipv6: Boolean; to use IPv6 or not

1730

2411

"""

2412

1731

2413

def __init__(self, server_address, RequestHandlerClass,

1732

interface=None, use_ipv6=True):

2414

interface=None,

2415

use_ipv6=True,

2416

socketfd=None):

2417

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

2418

creating a new one with socket.socket().

2419

"""

1733

2420

self.interface = interface

1734

2421

if use_ipv6:

1735

2422

self.address_family = socket.AF_INET6

2423

if socketfd is not None:

2424

# Save the file descriptor

2425

self.socketfd = socketfd

2426

# Save the original socket.socket() function

2427

self.socket_socket = socket.socket

2428

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

2429

#

2430

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

2431

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

2432

# patching socket.socket.)

2433

#

2434

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

2435

@functools.wraps(socket.socket)

2436

def socket_wrapper(*args, **kwargs):

2437

# Restore original function so subsequent calls are

2438

# not affected.

2439

socket.socket = self.socket_socket

2440

del self.socket_socket

2441

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

2442

# saved file descriptor.

2443

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

2444

# Replace socket.socket() function with wrapper

2445

socket.socket = socket_wrapper

2446

# The socketserver.TCPServer.__init__ will call

2447

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

2448

# socket_wrapper(), if socketfd was set.

1736

2449

socketserver.TCPServer.__init__(self, server_address,

1737

2450

RequestHandlerClass)

2451

1738

2452

def server_bind(self):

1739

2453

"""This overrides the normal server_bind() function

1740

2454

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

1741

2455

bind to an address or port if they were not specified."""

1742

2456

if self.interface is not None:

1743

2457

if SO_BINDTODEVICE is None:

1744

logger.error("SO_BINDTODEVICE does not exist;"

1745

" cannot bind to interface %s",

1746

self.interface)

1747

else:

1748

try:

1749

self.socket.setsockopt(socket.SOL_SOCKET,

1750

SO_BINDTODEVICE,

1751

str(self.interface

1752

+ '\0'))

1753

except socket.error as error:

1754

if error[0] == errno.EPERM:

1755

logger.error("No permission to"

1756

" bind to interface %s",

1757

self.interface)

1758

elif error[0] == errno.ENOPROTOOPT:

1759

logger.error("SO_BINDTODEVICE not available;"

1760

" cannot bind to interface %s",

1761

self.interface)

1762

else:

1763

raise

2458

# Fall back to a hard-coded value which seems to be

2459

# common enough.

2460

logger.warning("SO_BINDTODEVICE not found, trying 25")

2461

SO_BINDTODEVICE = 25

2462

try:

2463

self.socket.setsockopt(

2464

socket.SOL_SOCKET, SO_BINDTODEVICE,

2465

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

2466

except socket.error as error:

2467

if error.errno == errno.EPERM:

2468

logger.error("No permission to bind to"

2469

" interface %s", self.interface)

2470

elif error.errno == errno.ENOPROTOOPT:

2471

logger.error("SO_BINDTODEVICE not available;"

2472

" cannot bind to interface %s",

2473

self.interface)

2474

elif error.errno == errno.ENODEV:

2475

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

2476

" cannot bind", self.interface)

2477

else:

2478

raise

1764

2479

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

1765

2480

if self.server_address[0] or self.server_address[1]:

1766

2481

if not self.server_address[0]:

1767

2482

if self.address_family == socket.AF_INET6:

1768

2483

any_address = "::" # in6addr_any

1769

2484

else:

1770

any_address = socket.INADDR_ANY

2485

any_address = "0.0.0.0" # INADDR_ANY

1771

2486

self.server_address = (any_address,

1772

2487

self.server_address[1])

1773

2488

elif not self.server_address[1]:

1774

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

1775

0)

2489

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

1776

2490

# if self.interface:

1777

2491

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

1778

2492

# 0, # port

1790

2504

gnutls_priority GnuTLS priority string

1791

2505

use_dbus: Boolean; to emit D-Bus signals or not

1792

2506

1793

Assumes a gobject.MainLoop event loop.

2507

Assumes a GLib.MainLoop event loop.

1794

2508

"""

2509

1795

2510

def __init__(self, server_address, RequestHandlerClass,

1796

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

1797

gnutls_priority=None, use_dbus=True):

2511

interface=None,

2512

use_ipv6=True,

2513

clients=None,

2514

gnutls_priority=None,

2515

use_dbus=True,

2516

socketfd=None):

1798

2517

self.enabled = False

1799

2518

self.clients = clients

1800

2519

if self.clients is None:

1804

2523

IPv6_TCPServer.__init__(self, server_address,

1805

2524

RequestHandlerClass,

1806

2525

interface = interface,

1807

use_ipv6 = use_ipv6)

2526

use_ipv6 = use_ipv6,

2527

socketfd = socketfd)

2528

1808

2529

def server_activate(self):

1809

2530

if self.enabled:

1810

2531

return socketserver.TCPServer.server_activate(self)

1814

2535

1815

2536

def add_pipe(self, parent_pipe, proc):

1816

2537

# Call "handle_ipc" for both data and EOF events

1817

gobject.io_add_watch(parent_pipe.fileno(),

1818

gobject.IO_IN | gobject.IO_HUP,

1819

functools.partial(self.handle_ipc,

1820

parent_pipe =

1821

parent_pipe,

1822

proc = proc))

2538

GLib.io_add_watch(

2539

parent_pipe.fileno(),

2540

GLib.IO_IN | GLib.IO_HUP,

2541

functools.partial(self.handle_ipc,

2542

parent_pipe = parent_pipe,

2543

proc = proc))

1823

2544

1824

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

1825

proc = None, client_object=None):

1826

condition_names = {

1827

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

1828

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

1829

# blocking).

1830

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

1831

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

1832

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

1833

# broken, usually for pipes and

1834

# sockets).

1835

}

1836

conditions_string = ' | '.join(name

1837

for cond, name in

1838

condition_names.iteritems()

1839

if cond & condition)

2545

def handle_ipc(self, source, condition,

2546

parent_pipe=None,

2547

proc = None,

2548

client_object=None):

1840

2549

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

1841

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

2550

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

1842

2551

# Wait for other process to exit

1843

2552

proc.join()

1844

2553

return False

1851

2560

fpr = request[1]

1852

2561

address = request[2]

1853

2562

1854

for c in self.clients.itervalues():

2563

for c in self.clients.values():

1855

2564

if c.fingerprint == fpr:

1856

2565

client = c

1857

2566

break

1865

2574

parent_pipe.send(False)

1866

2575

return False

1867

2576

1868

gobject.io_add_watch(parent_pipe.fileno(),

1869

gobject.IO_IN | gobject.IO_HUP,

1870

functools.partial(self.handle_ipc,

1871

parent_pipe =

1872

parent_pipe,

1873

proc = proc,

1874

client_object =

1875

client))

2577

GLib.io_add_watch(

2578

parent_pipe.fileno(),

2579

GLib.IO_IN | GLib.IO_HUP,

2580

functools.partial(self.handle_ipc,

2581

parent_pipe = parent_pipe,

2582

proc = proc,

2583

client_object = client))

1876

2584

parent_pipe.send(True)

1877

2585

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

1878

2586

# same fileno

1884

2592

1885

2593

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

1886

2594

funcname)(*args,

1887

**kwargs)))

2595

**kwargs)))

1888

2596

1889

2597

if command == 'getattr':

1890

2598

attrname = request[1]

1891

if callable(client_object.__getattribute__(attrname)):

1892

parent_pipe.send(('function',))

2599

if isinstance(client_object.__getattribute__(attrname),

2600

collections.Callable):

2601

parent_pipe.send(('function', ))

1893

2602

else:

1894

parent_pipe.send(('data', client_object

1895

.__getattribute__(attrname)))

2603

parent_pipe.send((

2604

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

1896

2605

1897

2606

if command == 'setattr':

1898

2607

attrname = request[1]

1902

2611

return True

1903

2612

1904

2613

2614

def rfc3339_duration_to_delta(duration):

2615

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

2616

2617

>>> rfc3339_duration_to_delta("P7D")

2618

datetime.timedelta(7)

2619

>>> rfc3339_duration_to_delta("PT60S")

2620

datetime.timedelta(0, 60)

2621

>>> rfc3339_duration_to_delta("PT60M")

2622

datetime.timedelta(0, 3600)

2623

>>> rfc3339_duration_to_delta("PT24H")

2624

datetime.timedelta(1)

2625

>>> rfc3339_duration_to_delta("P1W")

2626

datetime.timedelta(7)

2627

>>> rfc3339_duration_to_delta("PT5M30S")

2628

datetime.timedelta(0, 330)

2629

>>> rfc3339_duration_to_delta("P1DT3M20S")

2630

datetime.timedelta(1, 200)

2631

"""

2632

2633

# Parsing an RFC 3339 duration with regular expressions is not

2634

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

2635

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

2636

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

2637

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

2638

# avoid excessive use of external libraries.

2639

2640

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

2641

Token = collections.namedtuple("Token", (

2642

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

2643

# a "group" containing digits

2644

"value", # datetime.timedelta or None

2645

"followers")) # Tokens valid after this token

2646

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

2647

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

2648

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

2649

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

2650

datetime.timedelta(seconds=1),

2651

frozenset((token_end, )))

2652

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

2653

datetime.timedelta(minutes=1),

2654

frozenset((token_second, token_end)))

2655

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

2656

datetime.timedelta(hours=1),

2657

frozenset((token_minute, token_end)))

2658

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

2659

None,

2660

frozenset((token_hour, token_minute,

2661

token_second)))

2662

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

2663

datetime.timedelta(days=1),

2664

frozenset((token_time, token_end)))

2665

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

2666

datetime.timedelta(weeks=4),

2667

frozenset((token_day, token_end)))

2668

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

2669

datetime.timedelta(weeks=52),

2670

frozenset((token_month, token_end)))

2671

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

2672

datetime.timedelta(weeks=1),

2673

frozenset((token_end, )))

2674

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

2675

frozenset((token_year, token_month,

2676

token_day, token_time,

2677

token_week)))

2678

# Define starting values

2679

value = datetime.timedelta() # Value so far

2680

found_token = None

2681

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

2682

s = duration # String left to parse

2683

# Loop until end token is found

2684

while found_token is not token_end:

2685

# Search for any currently valid tokens

2686

for token in followers:

2687

match = token.regexp.match(s)

2688

if match is not None:

2689

# Token found

2690

if token.value is not None:

2691

# Value found, parse digits

2692

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

2693

# Add to value so far

2694

value += factor * token.value

2695

# Strip token from string

2696

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

2697

# Go to found token

2698

found_token = token

2699

# Set valid next tokens

2700

followers = found_token.followers

2701

break

2702

else:

2703

# No currently valid tokens were found

2704

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

2705

.format(duration))

2706

# End token found

2707

return value

2708

2709

1905

2710

def string_to_delta(interval):

1906

2711

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

1907

2712

1918

2723

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

1919

2724

datetime.timedelta(0, 330)

1920

2725

"""

2726

2727

try:

2728

return rfc3339_duration_to_delta(interval)

2729

except ValueError:

2730

pass

2731

1921

2732

timevalue = datetime.timedelta(0)

1922

2733

for s in interval.split():

1923

2734

try:

1924

suffix = unicode(s[-1])

2735

suffix = s[-1]

1925

2736

value = int(s[:-1])

1926

2737

if suffix == "d":

1927

2738

delta = datetime.timedelta(value)

1934

2745

elif suffix == "w":

1935

2746

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

1936

2747

else:

1937

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

1938

except (ValueError, IndexError) as e:

2748

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

2749

except IndexError as e:

1939

2750

raise ValueError(*(e.args))

1940

2751

timevalue += delta

1941

2752

return timevalue

1954

2765

sys.exit()

1955

2766

if not noclose:

1956

2767

# Close all standard open file descriptors

1957

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

2768

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

1958

2769

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

1959

2770

raise OSError(errno.ENODEV,

1960

"%s not a character device"

1961

% os.path.devnull)

2771

"{} not a character device"

2772

.format(os.devnull))

1962

2773

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

1963

2774

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

1964

2775

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

1973

2784

1974

2785

parser = argparse.ArgumentParser()

1975

2786

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

1976

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

2787

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

1977

2788

help="show version number and exit")

1978

2789

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

1979

2790

help="Bind to interface IF")

1985

2796

help="Run self-test")

1986

2797

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

1987

2798

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

1988

" to terminal")

2799

" to terminal", default=None)

1989

2800

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

1990

2801

help="Debug level for stdout output")

1991

2802

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

1998

2809

" files")

1999

2810

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

2000

2811

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

2001

" system bus interface")

2812

" system bus interface", default=None)

2002

2813

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

2003

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

2814

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

2815

default=None)

2004

2816

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

2005

2817

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

2006

" state")

2818

" state", default=None)

2819

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

2820

help="Specify a file descriptor to a network"

2821

" socket to use instead of creating one")

2007

2822

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

2008

2823

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

2824

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

2825

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

2826

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

2827

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

2828

default=None)

2009

2829

2010

2830

options = parser.parse_args()

2011

2831

2012

2832

if options.check:

2013

2833

import doctest

2014

doctest.testmod()

2015

sys.exit()

2834

fail_count, test_count = doctest.testmod()

2835

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

2016

2836

2017

2837

# Default values for config file for server-global settings

2018

2838

server_defaults = { "interface": "",

2020

2840

"port": "",

2021

2841

"debug": "False",

2022

2842

"priority":

2023

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

2843

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

2844

":+SIGN-DSA-SHA256",

2024

2845

"servicename": "Mandos",

2025

2846

"use_dbus": "True",

2026

2847

"use_ipv6": "True",

2027

2848

"debuglevel": "",

2028

2849

"restore": "True",

2029

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

2030

}

2850

"socket": "",

2851

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

2852

"foreground": "False",

2853

"zeroconf": "True",

2854

}

2031

2855

2032

2856

# Parse config file for server-global settings

2033

2857

server_config = configparser.SafeConfigParser(server_defaults)

2034

2858

del server_defaults

2035

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

2036

"mandos.conf"))

2859

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

2037

2860

# Convert the SafeConfigParser object to a dict

2038

2861

server_settings = server_config.defaults()

2039

2862

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

2040

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

2863

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

2041

2864

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

2042

2865

option)

2043

2866

if server_settings["port"]:

2044

2867

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

2045

2868

"port")

2869

if server_settings["socket"]:

2870

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

2871

"socket")

2872

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

2873

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

2874

# happen with a supplied network socket.

2875

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

2876

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

2877

["socket"])

2046

2878

del server_config

2047

2879

2048

2880

# Override the settings from the config file with command line

2049

2881

# options, if set.

2050

2882

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

2051

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

2052

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

2053

"statedir"):

2883

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

2884

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

2885

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

2054

2886

value = getattr(options, option)

2055

2887

if value is not None:

2056

2888

server_settings[option] = value

2057

2889

del options

2058

2890

# Force all strings to be unicode

2059

2891

for option in server_settings.keys():

2060

if type(server_settings[option]) is str:

2061

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

2892

if isinstance(server_settings[option], bytes):

2893

server_settings[option] = (server_settings[option]

2894

.decode("utf-8"))

2895

# Force all boolean options to be boolean

2896

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

2897

"foreground", "zeroconf"):

2898

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

2899

# Debug implies foreground

2900

if server_settings["debug"]:

2901

server_settings["foreground"] = True

2062

2902

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

2063

2903

2064

2904

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

2065

2905

2906

if (not server_settings["zeroconf"]

2907

and not (server_settings["port"]

2908

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

2909

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

2910

2066

2911

# For convenience

2067

2912

debug = server_settings["debug"]

2068

2913

debuglevel = server_settings["debuglevel"]

2070

2915

use_ipv6 = server_settings["use_ipv6"]

2071

2916

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

2072

2917

stored_state_file)

2918

foreground = server_settings["foreground"]

2919

zeroconf = server_settings["zeroconf"]

2073

2920

2074

2921

if debug:

2075

2922

initlogger(debug, logging.DEBUG)

2081

2928

initlogger(debug, level)

2082

2929

2083

2930

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

2084

syslogger.setFormatter(logging.Formatter

2085

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

2086

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

2087

% server_settings["servicename"]))

2931

syslogger.setFormatter(

2932

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

2933

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

2934

server_settings["servicename"])))

2088

2935

2089

2936

# Parse config file with clients

2090

2937

client_config = configparser.SafeConfigParser(Client

2095

2942

global mandos_dbus_service

2096

2943

mandos_dbus_service = None

2097

2944

2098

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

2099

server_settings["port"]),

2100

ClientHandler,

2101

interface=(server_settings["interface"]

2102

or None),

2103

use_ipv6=use_ipv6,

2104

gnutls_priority=

2105

server_settings["priority"],

2106

use_dbus=use_dbus)

2107

if not debug:

2108

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

2945

socketfd = None

2946

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

2947

socketfd = server_settings["socket"]

2948

tcp_server = MandosServer(

2949

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

2950

ClientHandler,

2951

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

2952

use_ipv6=use_ipv6,

2953

gnutls_priority=server_settings["priority"],

2954

use_dbus=use_dbus,

2955

socketfd=socketfd)

2956

if not foreground:

2957

pidfilename = "/run/mandos.pid"

2958

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

2959

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

2960

pidfile = None

2109

2961

try:

2110

pidfile = open(pidfilename, "w")

2111

except IOError:

2112

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

2962

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

2963

except IOError as e:

2964

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

2965

exc_info=e)

2113

2966

2114

try:

2115

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

2116

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

2117

except KeyError:

2967

for name, group in (("_mandos", "_mandos"),

2968

("mandos", "mandos"),

2969

("nobody", "nogroup")):

2118

2970

try:

2119

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

2120

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

2971

uid = pwd.getpwnam(name).pw_uid

2972

gid = pwd.getpwnam(group).pw_gid

2973

break

2121

2974

except KeyError:

2122

try:

2123

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

2124

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

2125

except KeyError:

2126

uid = 65534

2127

gid = 65534

2975

continue

2976

else:

2977

uid = 65534

2978

gid = 65534

2128

2979

try:

2129

2980

os.setgid(gid)

2130

2981

os.setuid(uid)

2982

if debug:

2983

logger.debug("Did setuid/setgid to {}:{}".format(uid,

2984

gid))

2131

2985

except OSError as error:

2132

if error[0] != errno.EPERM:

2133

raise error

2986

logger.warning("Failed to setuid/setgid to {}:{}: {}"

2987

.format(uid, gid, os.strerror(error.errno)))

2988

if error.errno != errno.EPERM:

2989

raise

2134

2990

2135

2991

if debug:

2136

2992

# Enable all possible GnuTLS debugging

2137

2993

2138

2994

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

2139

2995

# - GnuTLS manual

2140

gnutls.library.functions.gnutls_global_set_log_level(11)

2996

gnutls.global_set_log_level(11)

2141

2997

2142

@gnutls.library.types.gnutls_log_func

2998

@gnutls.log_func

2143

2999

def debug_gnutls(level, string):

2144

3000

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

2145

3001

2146

(gnutls.library.functions

2147

.gnutls_global_set_log_function(debug_gnutls))

3002

gnutls.global_set_log_function(debug_gnutls)

2148

3003

2149

3004

# Redirect stdin so all checkers get /dev/null

2150

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

3005

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

2151

3006

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

2152

3007

if null > 2:

2153

3008

os.close(null)

2154

3009

2155

3010

# Need to fork before connecting to D-Bus

2156

if not debug:

3011

if not foreground:

2157

3012

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

2158

3013

daemon()

2159

3014

2160

gobject.threads_init()

3015

# multiprocessing will use threads, so before we use GLib we need

3016

# to inform GLib that threads will be used.

3017

GLib.threads_init()

2161

3018

2162

3019

global main_loop

2163

3020

# From the Avahi example code

2164

DBusGMainLoop(set_as_default=True )

2165

main_loop = gobject.MainLoop()

3021

DBusGMainLoop(set_as_default=True)

3022

main_loop = GLib.MainLoop()

2166

3023

bus = dbus.SystemBus()

2167

3024

# End of Avahi example code

2168

3025

if use_dbus:

2169

3026

try:

2170

3027

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

2171

bus, do_not_queue=True)

2172

old_bus_name = (dbus.service.BusName

2173

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

2174

do_not_queue=True))

2175

except dbus.exceptions.NameExistsException as e:

2176

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

3028

bus,

3029

do_not_queue=True)

3030

old_bus_name = dbus.service.BusName(

3031

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

3032

do_not_queue=True)

3033

except dbus.exceptions.DBusException as e:

3034

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

2177

3035

use_dbus = False

2178

3036

server_settings["use_dbus"] = False

2179

3037

tcp_server.use_dbus = False

2180

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2181

service = AvahiServiceToSyslog(name =

2182

server_settings["servicename"],

2183

servicetype = "_mandos._tcp",

2184

protocol = protocol, bus = bus)

2185

if server_settings["interface"]:

2186

service.interface = (if_nametoindex

2187

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

3038

if zeroconf:

3039

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3040

service = AvahiServiceToSyslog(

3041

name = server_settings["servicename"],

3042

servicetype = "_mandos._tcp",

3043

protocol = protocol,

3044

bus = bus)

3045

if server_settings["interface"]:

3046

service.interface = if_nametoindex(

3047

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

2188

3048

2189

3049

global multiprocessing_manager

2190

3050

multiprocessing_manager = multiprocessing.Manager()

2191

3051

2192

3052

client_class = Client

2193

3053

if use_dbus:

2194

client_class = functools.partial(ClientDBusTransitional,

2195

bus = bus)

3054

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

2196

3055

2197

3056

client_settings = Client.config_parser(client_config)

2198

3057

old_client_settings = {}

2199

3058

clients_data = {}

2200

3059

3060

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

3061

global wnull

3062

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

3063

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

3064

# mode

3065

if debug or not foreground:

3066

wnull.close()

3067

2201

3068

# Get client data and settings from last running state.

2202

3069

if server_settings["restore"]:

2203

3070

try:

2204

3071

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

2205

clients_data, old_client_settings = (pickle.load

2206

(stored_state))

3072

if sys.version_info.major == 2:

3073

clients_data, old_client_settings = pickle.load(

3074

stored_state)

3075

else:

3076

bytes_clients_data, bytes_old_client_settings = (

3077

pickle.load(stored_state, encoding = "bytes"))

3078

### Fix bytes to strings

3079

## clients_data

3080

# .keys()

3081

clients_data = { (key.decode("utf-8")

3082

if isinstance(key, bytes)

3083

else key): value

3084

for key, value in

3085

bytes_clients_data.items() }

3086

del bytes_clients_data

3087

for key in clients_data:

3088

value = { (k.decode("utf-8")

3089

if isinstance(k, bytes) else k): v

3090

for k, v in

3091

clients_data[key].items() }

3092

clients_data[key] = value

3093

# .client_structure

3094

value["client_structure"] = [

3095

(s.decode("utf-8")

3096

if isinstance(s, bytes)

3097

else s) for s in

3098

value["client_structure"] ]

3099

# .name & .host

3100

for k in ("name", "host"):

3101

if isinstance(value[k], bytes):

3102

value[k] = value[k].decode("utf-8")

3103

## old_client_settings

3104

# .keys()

3105

old_client_settings = {

3106

(key.decode("utf-8")

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_old_client_settings.items() }

3111

del bytes_old_client_settings

3112

# .host

3113

for value in old_client_settings.values():

3114

if isinstance(value["host"], bytes):

3115

value["host"] = (value["host"]

3116

.decode("utf-8"))

2207

3117

os.remove(stored_state_path)

2208

3118

except IOError as e:

2209

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

2210

.format(e))

2211

if e.errno != errno.ENOENT:

3119

if e.errno == errno.ENOENT:

3120

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

3121

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

3122

else:

3123

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

3124

exc_info=e)

2212

3125

raise

2213

3126

except EOFError as e:

2214

3127

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

2215

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

3128

"EOFError:",

3129

exc_info=e)

2216

3130

2217

3131

with PGPEngine() as pgp:

2218

for client_name, client in clients_data.iteritems():

3132

for client_name, client in clients_data.items():

3133

# Skip removed clients

3134

if client_name not in client_settings:

3135

continue

3136

2219

3137

# Decide which value to use after restoring saved state.

2220

3138

# We have three different values: Old config file,

2221

3139

# new config file, and saved state.

2226

3144

# For each value in new config, check if it

2227

3145

# differs from the old config value (Except for

2228

3146

# the "secret" attribute)

2229

if (name != "secret" and

2230

value != old_client_settings[client_name]

2231

[name]):

3147

if (name != "secret"

3148

and (value !=

3149

old_client_settings[client_name][name])):

2232

3150

client[name] = value

2233

3151

except KeyError:

2234

3152

pass

2235

3153

2236

3154

# Clients who has passed its expire date can still be

2237

# enabled if its last checker was successful. Clients

3155

# enabled if its last checker was successful. A Client

2238

3156

# whose checker succeeded before we stored its state is

2239

3157

# assumed to have successfully run all checkers during

2240

3158

# downtime.

2242

3160

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

2243

3161

if not client["last_checked_ok"]:

2244

3162

logger.warning(

2245

"disabling client {0} - Client never "

2246

"performed a successful checker"

2247

.format(client_name))

3163

"disabling client {} - Client never "

3164

"performed a successful checker".format(

3165

client_name))

2248

3166

client["enabled"] = False

2249

3167

elif client["last_checker_status"] != 0:

2250

3168

logger.warning(

2251

"disabling client {0} - Client "

2252

"last checker failed with error code {1}"

2253

.format(client_name,

2254

client["last_checker_status"]))

3169

"disabling client {} - Client last"

3170

" checker failed with error code"

3171

" {}".format(

3172

client_name,

3173

client["last_checker_status"]))

2255

3174

client["enabled"] = False

2256

3175

else:

2257

client["expires"] = (datetime.datetime

2258

.utcnow()

2259

+ client["timeout"])

3176

client["expires"] = (

3177

datetime.datetime.utcnow()

3178

+ client["timeout"])

2260

3179

logger.debug("Last checker succeeded,"

2261

" keeping {0} enabled"

2262

.format(client_name))

3180

" keeping {} enabled".format(

3181

client_name))

2263

3182

try:

2264

client["secret"] = (

2265

pgp.decrypt(client["encrypted_secret"],

2266

client_settings[client_name]

2267

["secret"]))

3183

client["secret"] = pgp.decrypt(

3184

client["encrypted_secret"],

3185

client_settings[client_name]["secret"])

2268

3186

except PGPError:

2269

3187

# If decryption fails, we use secret from new settings

2270

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

2271

.format(client_name))

2272

client["secret"] = (

2273

client_settings[client_name]["secret"])

2274

3188

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

3189

client_name))

3190

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

3191

["secret"])

2275

3192

2276

3193

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

2277

3194

for client_name in (set(old_client_settings)

2280

3197

for client_name in (set(client_settings)

2281

3198

- set(old_client_settings)):

2282

3199

clients_data[client_name] = client_settings[client_name]

2283

3200

2284

3201

# Create all client objects

2285

for client_name, client in clients_data.iteritems():

3202

for client_name, client in clients_data.items():

2286

3203

tcp_server.clients[client_name] = client_class(

2287

name = client_name, settings = client)

3204

name = client_name,

3205

settings = client,

3206

server_settings = server_settings)

2288

3207

2289

3208

if not tcp_server.clients:

2290

3209

logger.warning("No clients defined")

2291

2292

if not debug:

2293

try:

2294

with pidfile:

2295

pid = os.getpid()

2296

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

2297

del pidfile

2298

except IOError:

2299

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

2300

pidfilename, pid)

2301

except NameError:

2302

# "pidfile" was never created

2303

pass

3210

3211

if not foreground:

3212

if pidfile is not None:

3213

pid = os.getpid()

3214

try:

3215

with pidfile:

3216

print(pid, file=pidfile)

3217

except IOError:

3218

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

3219

pidfilename, pid)

3220

del pidfile

2304

3221

del pidfilename

2305

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

2306

3222

2307

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

2308

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

3223

for termsig in (signal.SIGHUP, signal.SIGTERM):

3224

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3225

lambda: main_loop.quit() and False)

2309

3226

2310

3227

if use_dbus:

2311

class MandosDBusService(dbus.service.Object):

3228

3229

@alternate_dbus_interfaces(

3230

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

3231

class MandosDBusService(DBusObjectWithObjectManager):

2312

3232

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

3233

2313

3234

def __init__(self):

2314

3235

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

3236

2315

3237

_interface = "se.recompile.Mandos"

2316

3238

2317

3239

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

2324

3246

"D-Bus signal"

2325

3247

pass

2326

3248

3249

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

3250

"true"})

2327

3251

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

2328

3252

def ClientRemoved(self, objpath, name):

2329

3253

"D-Bus signal"

2330

3254

pass

2331

3255

3256

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

3257

"true"})

2332

3258

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

2333

3259

def GetAllClients(self):

2334

3260

"D-Bus method"

2335

return dbus.Array(c.dbus_object_path

2336

for c in

2337

tcp_server.clients.itervalues())

3261

return dbus.Array(c.dbus_object_path for c in

3262

tcp_server.clients.values())

2338

3263

3264

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

3265

"true"})

2339

3266

@dbus.service.method(_interface,

2340

3267

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

2341

3268

def GetAllClientsWithProperties(self):

2342

3269

"D-Bus method"

2343

3270

return dbus.Dictionary(

2344

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

2345

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

3271

{ c.dbus_object_path: c.GetAll(

3272

"se.recompile.Mandos.Client")

3273

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

2346

3274

signature="oa{sv}")

2347

3275

2348

3276

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

2349

3277

def RemoveClient(self, object_path):

2350

3278

"D-Bus method"

2351

for c in tcp_server.clients.itervalues():

3279

for c in tcp_server.clients.values():

2352

3280

if c.dbus_object_path == object_path:

2353

3281

del tcp_server.clients[c.name]

2354

3282

c.remove_from_connection()

2355

# Don't signal anything except ClientRemoved

3283

# Don't signal the disabling

2356

3284

c.disable(quiet=True)

2357

# Emit D-Bus signal

2358

self.ClientRemoved(object_path, c.name)

3285

# Emit D-Bus signal for removal

3286

self.client_removed_signal(c)

2359

3287

return

2360

3288

raise KeyError(object_path)

2361

3289

2362

3290

del _interface

3291

3292

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3293

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

3294

def GetManagedObjects(self):

3295

"""D-Bus method"""

3296

return dbus.Dictionary(

3297

{ client.dbus_object_path:

3298

dbus.Dictionary(

3299

{ interface: client.GetAll(interface)

3300

for interface in

3301

client._get_all_interface_names()})

3302

for client in tcp_server.clients.values()})

3303

3304

def client_added_signal(self, client):

3305

"""Send the new standard signal and the old signal"""

3306

if use_dbus:

3307

# New standard signal

3308

self.InterfacesAdded(

3309

client.dbus_object_path,

3310

dbus.Dictionary(

3311

{ interface: client.GetAll(interface)

3312

for interface in

3313

client._get_all_interface_names()}))

3314

# Old signal

3315

self.ClientAdded(client.dbus_object_path)

3316

3317

def client_removed_signal(self, client):

3318

"""Send the new standard signal and the old signal"""

3319

if use_dbus:

3320

# New standard signal

3321

self.InterfacesRemoved(

3322

client.dbus_object_path,

3323

client._get_all_interface_names())

3324

# Old signal

3325

self.ClientRemoved(client.dbus_object_path,

3326

client.name)

2363

3327

2364

class MandosDBusServiceTransitional(MandosDBusService):

2365

__metaclass__ = AlternateDBusNamesMetaclass

2366

mandos_dbus_service = MandosDBusServiceTransitional()

3328

mandos_dbus_service = MandosDBusService()

2367

3329

3330

# Save modules to variables to exempt the modules from being

3331

# unloaded before the function registered with atexit() is run.

3332

mp = multiprocessing

3333

wn = wnull

2368

3334

def cleanup():

2369

3335

"Cleanup function; run on exit"

2370

service.cleanup()

3336

if zeroconf:

3337

service.cleanup()

2371

3338

2372

multiprocessing.active_children()

3339

mp.active_children()

3340

wn.close()

2373

3341

if not (tcp_server.clients or client_settings):

2374

3342

return

2375

3343

2378

3346

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

2379

3347

clients = {}

2380

3348

with PGPEngine() as pgp:

2381

for client in tcp_server.clients.itervalues():

3349

for client in tcp_server.clients.values():

2382

3350

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

2383

3351

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

2384

3352

key)

2386

3354

2387

3355

# A list of attributes that can not be pickled

2388

3356

# + secret.

2389

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

2390

"checker"))

2391

for name, typ in (inspect.getmembers

2392

(dbus.service.Object)):

3357

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

3358

"checker", "server_settings" }

3359

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

3360

.Object):

2393

3361

exclude.add(name)

2394

3362

2395

3363

client_dict["encrypted_secret"] = (client

2402

3370

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

2403

3371

2404

3372

try:

2405

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

2406

prefix="clients-",

2407

dir=os.path.dirname

2408

(stored_state_path))

2409

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

2410

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

3373

with tempfile.NamedTemporaryFile(

3374

mode='wb',

3375

suffix=".pickle",

3376

prefix='clients-',

3377

dir=os.path.dirname(stored_state_path),

3378

delete=False) as stored_state:

3379

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

3380

protocol = 2)

3381

tempname = stored_state.name

2411

3382

os.rename(tempname, stored_state_path)

2412

3383

except (IOError, OSError) as e:

2413

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

2414

.format(e))

2415

3384

if not debug:

2416

3385

try:

2417

3386

os.remove(tempname)

2418

3387

except NameError:

2419

3388

pass

2420

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

2421

errno.EEXIST)):

2422

raise e

3389

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

3390

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

3391

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

3392

else:

3393

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

3394

exc_info=e)

3395

raise

2423

3396

2424

3397

# Delete all clients, and settings from config

2425

3398

while tcp_server.clients:

2426

3399

name, client = tcp_server.clients.popitem()

2427

3400

if use_dbus:

2428

3401

client.remove_from_connection()

2429

# Don't signal anything except ClientRemoved

3402

# Don't signal the disabling

2430

3403

client.disable(quiet=True)

3404

# Emit D-Bus signal for removal

2431

3405

if use_dbus:

2432

# Emit D-Bus signal

2433

mandos_dbus_service.ClientRemoved(client

2434

.dbus_object_path,

2435

client.name)

3406

mandos_dbus_service.client_removed_signal(client)

2436

3407

client_settings.clear()

2437

3408

2438

3409

atexit.register(cleanup)

2439

3410

2440

for client in tcp_server.clients.itervalues():

3411

for client in tcp_server.clients.values():

2441

3412

if use_dbus:

2442

# Emit D-Bus signal

2443

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3413

# Emit D-Bus signal for adding

3414

mandos_dbus_service.client_added_signal(client)

2444

3415

# Need to initiate checking of clients

2445

3416

if client.enabled:

2446

3417

client.init_checker()

2449

3420

tcp_server.server_activate()

2450

3421

2451

3422

# Find out what port we got

2452

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

3423

if zeroconf:

3424

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

2453

3425

if use_ipv6:

2454

3426

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

2455

" flowinfo %d, scope_id %d"

2456

% tcp_server.socket.getsockname())

3427

" flowinfo %d, scope_id %d",

3428

*tcp_server.socket.getsockname())

2457

3429

else: # IPv4

2458

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

2459

% tcp_server.socket.getsockname())

3430

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

3431

*tcp_server.socket.getsockname())

2460

3432

2461

3433

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

2462

3434

2463

3435

try:

2464

# From the Avahi example code

2465

try:

2466

service.activate()

2467

except dbus.exceptions.DBusException as error:

2468

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

2469

cleanup()

2470

sys.exit(1)

2471

# End of Avahi example code

3436

if zeroconf:

3437

# From the Avahi example code

3438

try:

3439

service.activate()

3440

except dbus.exceptions.DBusException as error:

3441

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

3442

cleanup()

3443

sys.exit(1)

3444

# End of Avahi example code

2472

3445

2473

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

2474

lambda *args, **kwargs:

2475

(tcp_server.handle_request

2476

(*args[2:], **kwargs) or True))

3446

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

3447

lambda *args, **kwargs:

3448

(tcp_server.handle_request

3449

(*args[2:], **kwargs) or True))

2477

3450

2478

3451

logger.debug("Starting main loop")

2479

3452

main_loop.run()

2480

3453

except AvahiError as error:

2481

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

3454

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

2482

3455

cleanup()

2483

3456

sys.exit(1)

2484

3457

except KeyboardInterrupt:

2489

3462

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

2490

3463

cleanup()

2491

3464

3465

2492

3466

if __name__ == '__main__':

2493

3467

main()