/mandos/release : revision 237.7.370

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

38

43

import socket

39

44

import argparse

40

45

import datetime

41

46

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

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

49

51

import sys

50

52

import re

51

53

import os

60

62

import struct

61

63

import fcntl

62

64

import functools

63

import cPickle as pickle

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

64

69

import multiprocessing

65

70

import types

66

71

import binascii

67

72

import tempfile

73

import itertools

74

import collections

75

import codecs

68

76

69

77

import dbus

70

78

import dbus.service

71

import gobject

79

try:

80

from gi.repository import GObject

81

except ImportError:

82

import gobject as GObject

72

83

import avahi

73

84

from dbus.mainloop.glib import DBusGMainLoop

74

85

import ctypes

75

86

import ctypes.util

76

87

import xml.dom.minidom

77

88

import inspect

78

import GnuPGInterface

79

89

80

90

try:

81

91

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except ImportError:

86

96

SO_BINDTODEVICE = None

87

97

88

version = "1.4.1"

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.3"

89

102

stored_state_file = "clients.pickle"

90

103

91

104

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

105

syslogger = None

95

106

96

107

try:

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

100

110

except (OSError, AttributeError):

111

101

112

def if_nametoindex(interface):

102

113

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

103

114

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

104

115

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

105

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

106

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

107

interface))

108

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

109

ifreq[16:20])[0]

117

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

118

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

110

119

return interface_index

111

120

112

121

113

def initlogger(level=logging.WARNING):

122

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

114

123

"""init logger and add loglevel"""

115

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

116

129

syslogger.setFormatter(logging.Formatter

117

130

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

118

131

' %(message)s'))

119

132

logger.addHandler(syslogger)

120

133

121

console = logging.StreamHandler()

122

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

123

' [%(process)d]:'

124

' %(levelname)s:'

125

' %(message)s'))

126

logger.addHandler(console)

134

if debug:

135

console = logging.StreamHandler()

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

127

141

logger.setLevel(level)

128

142

129

143

134

148

135

149

class PGPEngine(object):

136

150

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

151

137

152

def __init__(self):

138

self.gnupg = GnuPGInterface.GnuPG()

139

153

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

140

self.gnupg = GnuPGInterface.GnuPG()

141

self.gnupg.options.meta_interactive = False

142

self.gnupg.options.homedir = self.tempdir

143

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

144

'--quiet'])

154

self.gpg = "gpg"

155

try:

156

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

157

for line in output.splitlines():

158

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

159

if name == "gpg":

160

self.gpg = path

161

break

162

except OSError as e:

163

if e.errno != errno.ENOENT:

164

raise

165

self.gnupgargs = ['--batch',

166

'--homedir', self.tempdir,

167

'--force-mdc',

168

'--quiet',

169

'--no-use-agent']

145

170

146

171

def __enter__(self):

147

172

return self

148

173

149

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

174

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

150

175

self._cleanup()

151

176

return False

152

177

169

194

def password_encode(self, password):

170

195

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

171

196

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

172

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

197

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

198

if len(encoded) > 2048:

199

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

200

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

201

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

202

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

203

return encoded

173

204

174

205

def encrypt(self, data, password):

175

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

176

with open(os.devnull) as devnull:

177

try:

178

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

179

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

180

attach_fhs={'stderr': devnull})

181

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

182

f.write(data)

183

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

184

ciphertext = f.read()

185

proc.wait()

186

except IOError as e:

187

raise PGPError(e)

188

self.gnupg.passphrase = None

206

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(

208

dir=self.tempdir) as passfile:

209

passfile.write(passphrase)

210

passfile.flush()

211

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

212

'--passphrase-file',

213

passfile.name]

214

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

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

219

if proc.returncode != 0:

220

raise PGPError(err)

189

221

return ciphertext

190

222

191

223

def decrypt(self, data, password):

192

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

193

with open(os.devnull) as devnull:

194

try:

195

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

196

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

197

attach_fhs={'stderr': devnull})

198

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

199

f.write(data)

200

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

201

decrypted_plaintext = f.read()

202

proc.wait()

203

except IOError as e:

204

raise PGPError(e)

205

self.gnupg.passphrase = None

224

passphrase = self.password_encode(password)

225

with tempfile.NamedTemporaryFile(

226

dir = self.tempdir) as passfile:

227

passfile.write(passphrase)

228

passfile.flush()

229

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

230

'--passphrase-file',

231

passfile.name]

232

+ self.gnupgargs,

233

stdin = subprocess.PIPE,

234

stdout = subprocess.PIPE,

235

stderr = subprocess.PIPE)

236

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

237

if proc.returncode != 0:

238

raise PGPError(err)

206

239

return decrypted_plaintext

207

240

208

241

209

210

242

class AvahiError(Exception):

211

243

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

212

244

self.value = value

213

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

214

def __unicode__(self):

215

return unicode(repr(self.value))

245

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

246

**kwargs)

247

216

248

217

249

class AvahiServiceError(AvahiError):

218

250

pass

219

251

252

220

253

class AvahiGroupError(AvahiError):

221

254

pass

222

255

229

262

Used to optionally bind to the specified interface.

230

263

name: string; Example: 'Mandos'

231

264

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

232

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

265

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

233

266

port: integer; what port to announce

234

267

TXT: list of strings; TXT record for the service

235

268

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

241

274

server: D-Bus Server

242

275

bus: dbus.SystemBus()

243

276

"""

244

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

245

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

246

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

247

protocol = avahi.PROTO_UNSPEC, bus = None):

277

278

def __init__(self,

279

interface = avahi.IF_UNSPEC,

280

name = None,

281

servicetype = None,

282

port = None,

283

TXT = None,

284

domain = "",

285

host = "",

286

max_renames = 32768,

287

protocol = avahi.PROTO_UNSPEC,

288

bus = None):

248

289

self.interface = interface

249

290

self.name = name

250

291

self.type = servicetype

259

300

self.server = None

260

301

self.bus = bus

261

302

self.entry_group_state_changed_match = None

262

def rename(self):

303

304

def rename(self, remove=True):

263

305

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

264

306

if self.rename_count >= self.max_renames:

265

307

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

266

308

" after %i retries, exiting.",

267

309

self.rename_count)

268

310

raise AvahiServiceError("Too many renames")

269

self.name = unicode(self.server

270

.GetAlternativeServiceName(self.name))

311

self.name = str(

312

self.server.GetAlternativeServiceName(self.name))

313

self.rename_count += 1

271

314

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

272

315

self.name)

273

self.remove()

316

if remove:

317

self.remove()

274

318

try:

275

319

self.add()

276

320

except dbus.exceptions.DBusException as error:

277

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

278

self.cleanup()

279

os._exit(1)

280

self.rename_count += 1

321

if (error.get_dbus_name()

322

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

323

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

324

return self.rename(remove=False)

325

else:

326

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

327

self.cleanup()

328

os._exit(1)

329

281

330

def remove(self):

282

331

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

283

332

if self.entry_group_state_changed_match is not None:

285

334

self.entry_group_state_changed_match = None

286

335

if self.group is not None:

287

336

self.group.Reset()

337

288

338

def add(self):

289

339

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

290

340

self.remove()

307

357

dbus.UInt16(self.port),

308

358

avahi.string_array_to_txt_array(self.TXT))

309

359

self.group.Commit()

360

310

361

def entry_group_state_changed(self, state, error):

311

362

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

312

363

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

318

369

self.rename()

319

370

elif state == avahi.ENTRY_GROUP_FAILURE:

320

371

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

321

unicode(error))

322

raise AvahiGroupError("State changed: %s"

323

% unicode(error))

372

str(error))

373

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

374

324

375

def cleanup(self):

325

376

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

326

377

if self.group is not None:

331

382

pass

332

383

self.group = None

333

384

self.remove()

385

334

386

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

335

387

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

336

388

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

337

bad_states = { avahi.SERVER_INVALID:

338

"Zeroconf server invalid",

339

avahi.SERVER_REGISTERING: None,

340

avahi.SERVER_COLLISION:

341

"Zeroconf server name collision",

342

avahi.SERVER_FAILURE:

343

"Zeroconf server failure" }

389

bad_states = {

390

avahi.SERVER_INVALID: "Zeroconf server invalid",

391

avahi.SERVER_REGISTERING: None,

392

avahi.SERVER_COLLISION: "Zeroconf server name collision",

393

avahi.SERVER_FAILURE: "Zeroconf server failure",

394

}

344

395

if state in bad_states:

345

396

if bad_states[state] is not None:

346

397

if error is None:

349

400

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

350

401

self.cleanup()

351

402

elif state == avahi.SERVER_RUNNING:

352

self.add()

403

try:

404

self.add()

405

except dbus.exceptions.DBusException as error:

406

if (error.get_dbus_name()

407

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

408

logger.info("Local Zeroconf service name"

409

" collision.")

410

return self.rename(remove=False)

411

else:

412

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

413

self.cleanup()

414

os._exit(1)

353

415

else:

354

416

if error is None:

355

417

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

356

418

else:

357

419

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

420

358

421

def activate(self):

359

422

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

360

423

if self.server is None:

364

427

follow_name_owner_changes=True),

365

428

avahi.DBUS_INTERFACE_SERVER)

366

429

self.server.connect_to_signal("StateChanged",

367

self.server_state_changed)

430

self.server_state_changed)

368

431

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

369

432

433

370

434

class AvahiServiceToSyslog(AvahiService):

371

def rename(self):

435

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

372

436

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

373

ret = AvahiService.rename(self)

374

syslogger.setFormatter(logging.Formatter

375

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

376

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

377

% self.name))

437

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

438

syslogger.setFormatter(logging.Formatter(

439

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

440

.format(self.name)))

378

441

return ret

379

442

380

def timedelta_to_milliseconds(td):

381

"Convert a datetime.timedelta() to milliseconds"

382

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

383

+ (td.seconds * 1000)

384

+ (td.microseconds // 1000))

385

443

# Pretend that we have a GnuTLS module

444

class GnuTLS(object):

445

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

446

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

447

448

_library = ctypes.cdll.LoadLibrary(

449

ctypes.util.find_library("gnutls"))

450

_need_version = "3.3.0"

451

def __init__(self):

452

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

453

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

454

# happens.

455

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

456

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

457

.format(self._need_version))

458

459

# Unless otherwise indicated, the constants and types below are

460

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

461

462

# Constants

463

E_SUCCESS = 0

464

E_INTERRUPTED = -52

465

E_AGAIN = -28

466

CRT_OPENPGP = 2

467

CLIENT = 2

468

SHUT_RDWR = 0

469

CRD_CERTIFICATE = 1

470

E_NO_CERTIFICATE_FOUND = -49

471

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

472

473

# Types

474

class session_int(ctypes.Structure):

475

_fields_ = []

476

session_t = ctypes.POINTER(session_int)

477

class certificate_credentials_st(ctypes.Structure):

478

_fields_ = []

479

certificate_credentials_t = ctypes.POINTER(

480

certificate_credentials_st)

481

certificate_type_t = ctypes.c_int

482

class datum_t(ctypes.Structure):

483

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

484

('size', ctypes.c_uint)]

485

class openpgp_crt_int(ctypes.Structure):

486

_fields_ = []

487

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

488

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

489

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

490

credentials_type_t = ctypes.c_int #

491

transport_ptr_t = ctypes.c_void_p

492

close_request_t = ctypes.c_int

493

494

# Exceptions

495

class Error(Exception):

496

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

497

# exception might be raised from within GnuTLS.__init__,

498

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

499

# global variable has happened.

500

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

501

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

502

# code is passed, convert it to a string with

503

# gnutls.strerror()

504

self.code = code

505

if message is None and code is not None:

506

message = GnuTLS.strerror(code)

507

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

508

message, *args)

509

510

class CertificateSecurityError(Error):

511

pass

512

513

# Classes

514

class Credentials(object):

515

def __init__(self):

516

self._c_object = gnutls.certificate_credentials_t()

517

gnutls.certificate_allocate_credentials(

518

ctypes.byref(self._c_object))

519

self.type = gnutls.CRD_CERTIFICATE

520

521

def __del__(self):

522

gnutls.certificate_free_credentials(self._c_object)

523

524

class ClientSession(object):

525

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

526

self._c_object = gnutls.session_t()

527

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

528

gnutls.set_default_priority(self._c_object)

529

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

530

gnutls.handshake_set_private_extensions(self._c_object,

531

True)

532

self.socket = socket

533

if credentials is None:

534

credentials = gnutls.Credentials()

535

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

536

ctypes.cast(credentials._c_object,

537

ctypes.c_void_p))

538

self.credentials = credentials

539

540

def __del__(self):

541

gnutls.deinit(self._c_object)

542

543

def handshake(self):

544

return gnutls.handshake(self._c_object)

545

546

def send(self, data):

547

data = bytes(data)

548

data_len = len(data)

549

while data_len > 0:

550

data_len -= gnutls.record_send(self._c_object,

551

data[-data_len:],

552

data_len)

553

554

def bye(self):

555

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

556

557

# Error handling functions

558

def _error_code(result):

559

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

560

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

561

if result >= 0:

562

return result

563

if result == gnutls.E_NO_CERTIFICATE_FOUND:

564

raise gnutls.CertificateSecurityError(code = result)

565

raise gnutls.Error(code = result)

566

567

def _retry_on_error(result, func, arguments):

568

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

569

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

570

while result < 0:

571

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

572

return _error_code(result)

573

result = func(*arguments)

574

return result

575

576

# Unless otherwise indicated, the function declarations below are

577

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

578

579

# Functions

580

priority_set_direct = _library.gnutls_priority_set_direct

581

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

582

ctypes.POINTER(ctypes.c_char_p)]

583

priority_set_direct.restype = _error_code

584

585

init = _library.gnutls_init

586

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

587

init.restype = _error_code

588

589

set_default_priority = _library.gnutls_set_default_priority

590

set_default_priority.argtypes = [session_t]

591

set_default_priority.restype = _error_code

592

593

record_send = _library.gnutls_record_send

594

record_send.argtypes = [session_t, ctypes.c_void_p,

595

ctypes.c_size_t]

596

record_send.restype = ctypes.c_ssize_t

597

record_send.errcheck = _retry_on_error

598

599

certificate_allocate_credentials = (

600

_library.gnutls_certificate_allocate_credentials)

601

certificate_allocate_credentials.argtypes = [

602

ctypes.POINTER(certificate_credentials_t)]

603

certificate_allocate_credentials.restype = _error_code

604

605

certificate_free_credentials = (

606

_library.gnutls_certificate_free_credentials)

607

certificate_free_credentials.argtypes = [certificate_credentials_t]

608

certificate_free_credentials.restype = None

609

610

handshake_set_private_extensions = (

611

_library.gnutls_handshake_set_private_extensions)

612

handshake_set_private_extensions.argtypes = [session_t,

613

ctypes.c_int]

614

handshake_set_private_extensions.restype = None

615

616

credentials_set = _library.gnutls_credentials_set

617

credentials_set.argtypes = [session_t, credentials_type_t,

618

ctypes.c_void_p]

619

credentials_set.restype = _error_code

620

621

strerror = _library.gnutls_strerror

622

strerror.argtypes = [ctypes.c_int]

623

strerror.restype = ctypes.c_char_p

624

625

certificate_type_get = _library.gnutls_certificate_type_get

626

certificate_type_get.argtypes = [session_t]

627

certificate_type_get.restype = _error_code

628

629

certificate_get_peers = _library.gnutls_certificate_get_peers

630

certificate_get_peers.argtypes = [session_t,

631

ctypes.POINTER(ctypes.c_uint)]

632

certificate_get_peers.restype = ctypes.POINTER(datum_t)

633

634

global_set_log_level = _library.gnutls_global_set_log_level

635

global_set_log_level.argtypes = [ctypes.c_int]

636

global_set_log_level.restype = None

637

638

global_set_log_function = _library.gnutls_global_set_log_function

639

global_set_log_function.argtypes = [log_func]

640

global_set_log_function.restype = None

641

642

deinit = _library.gnutls_deinit

643

deinit.argtypes = [session_t]

644

deinit.restype = None

645

646

handshake = _library.gnutls_handshake

647

handshake.argtypes = [session_t]

648

handshake.restype = _error_code

649

handshake.errcheck = _retry_on_error

650

651

transport_set_ptr = _library.gnutls_transport_set_ptr

652

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

653

transport_set_ptr.restype = None

654

655

bye = _library.gnutls_bye

656

bye.argtypes = [session_t, close_request_t]

657

bye.restype = _error_code

658

bye.errcheck = _retry_on_error

659

660

check_version = _library.gnutls_check_version

661

check_version.argtypes = [ctypes.c_char_p]

662

check_version.restype = ctypes.c_char_p

663

664

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

665

666

openpgp_crt_init = _library.gnutls_openpgp_crt_init

667

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

668

openpgp_crt_init.restype = _error_code

669

670

openpgp_crt_import = _library.gnutls_openpgp_crt_import

671

openpgp_crt_import.argtypes = [openpgp_crt_t,

672

ctypes.POINTER(datum_t),

673

openpgp_crt_fmt_t]

674

openpgp_crt_import.restype = _error_code

675

676

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

677

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

678

ctypes.POINTER(ctypes.c_uint)]

679

openpgp_crt_verify_self.restype = _error_code

680

681

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

682

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

683

openpgp_crt_deinit.restype = None

684

685

openpgp_crt_get_fingerprint = (

686

_library.gnutls_openpgp_crt_get_fingerprint)

687

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

688

ctypes.c_void_p,

689

ctypes.POINTER(

690

ctypes.c_size_t)]

691

openpgp_crt_get_fingerprint.restype = _error_code

692

693

# Remove non-public functions

694

del _error_code, _retry_on_error

695

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

696

gnutls = GnuTLS()

697

698

def call_pipe(connection, # : multiprocessing.Connection

699

func, *args, **kwargs):

700

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

701

702

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

703

return value on the provided multiprocessing.Connection.

704

"""

705

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

706

connection.close()

707

386

708

class Client(object):

387

709

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

388

710

393

715

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

394

716

to see if the client lives.

395

717

'None' if no process is running.

396

checker_callback_tag: a gobject event source tag, or None

718

checker_callback_tag: a GObject event source tag, or None

397

719

checker_command: string; External command which is run to check

398

720

if client lives. %() expansions are done at

399

721

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

400

722

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

401

checker_initiator_tag: a gobject event source tag, or None

723

checker_initiator_tag: a GObject event source tag, or None

402

724

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

403

725

client_structure: Object describing what attributes a client has

404

726

and is used for storing the client at exit

405

727

current_checker_command: string; current running checker_command

406

disable_initiator_tag: a gobject event source tag, or None

728

disable_initiator_tag: a GObject event source tag, or None

407

729

enabled: bool()

408

730

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

409

731

uniquely identify the client

411

733

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

412

734

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

413

735

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

414

415

736

last_checker_status: integer between 0 and 255 reflecting exit

416

737

status of last checker. -1 reflects crashed

417

checker, or None.

738

checker, -2 means no checker completed yet.

739

last_checker_signal: The signal which killed the last checker, if

740

last_checker_status is -1

418

741

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

419

742

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

420

743

D-Bus identifiers

421

744

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

422

745

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

423

746

until this client is disabled

424

extended_timeout: extra long timeout when password has been sent

747

extended_timeout: extra long timeout when secret has been sent

425

748

runtime_expansions: Allowed attributes for runtime expansion.

426

749

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

427

750

disabled, or None

751

server_settings: The server_settings dict from main()

428

752

"""

429

753

430

754

runtime_expansions = ("approval_delay", "approval_duration",

431

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

432

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

755

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

756

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

757

"last_approval_request", "last_checked_ok",

433

758

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

434

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

435

"extended_timeout": "15m",

436

"interval": "2m",

437

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

438

"host": "",

439

"approval_delay": "0s",

440

"approval_duration": "1s",

441

"approved_by_default": "True",

442

"enabled": "True",

443

}

444

445

def timeout_milliseconds(self):

446

"Return the 'timeout' attribute in milliseconds"

447

return timedelta_to_milliseconds(self.timeout)

448

449

def extended_timeout_milliseconds(self):

450

"Return the 'extended_timeout' attribute in milliseconds"

451

return timedelta_to_milliseconds(self.extended_timeout)

452

453

def interval_milliseconds(self):

454

"Return the 'interval' attribute in milliseconds"

455

return timedelta_to_milliseconds(self.interval)

456

457

def approval_delay_milliseconds(self):

458

return timedelta_to_milliseconds(self.approval_delay)

459

759

client_defaults = {

760

"timeout": "PT5M",

761

"extended_timeout": "PT15M",

762

"interval": "PT2M",

763

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

764

"host": "",

765

"approval_delay": "PT0S",

766

"approval_duration": "PT1S",

767

"approved_by_default": "True",

768

"enabled": "True",

769

}

770

460

771

@staticmethod

461

772

def config_parser(config):

462

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

773

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

463

774

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

464

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

775

with exceptions for any special settings as defined above.

776

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

777

value given the same arguments.

778

"""

465

779

settings = {}

466

780

for client_name in config.sections():

467

781

section = dict(config.items(client_name))

468

782

client = settings[client_name] = {}

469

783

470

# Default copying each value from config to new dict

471

for setting, value in section.iteritems():

472

client[setting] = value

473

784

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

474

785

# Reformat values from string types to Python types

475

786

client["approved_by_default"] = config.getboolean(

476

787

client_name, "approved_by_default")

477

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

788

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

789

"enabled")

478

790

791

# Uppercase and remove spaces from fingerprint for later

792

# comparison purposes with return value from the

793

# fingerprint() function

479

794

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

480

795

.replace(" ", ""))

481

796

if "secret" in section:

486

801

"rb") as secfile:

487

802

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

488

803

else:

489

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

490

% section)

804

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

805

.format(section))

491

806

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

492

807

client["extended_timeout"] = string_to_delta(

493

808

section["extended_timeout"])

496

811

section["approval_delay"])

497

812

client["approval_duration"] = string_to_delta(

498

813

section["approval_duration"])

499

814

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

815

client["last_approval_request"] = None

816

client["last_checked_ok"] = None

817

client["last_checker_status"] = -2

818

500

819

return settings

501

502

503

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

504

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

505

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

506

attribute."""

820

821

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

507

822

self.name = name

823

if server_settings is None:

824

server_settings = {}

825

self.server_settings = server_settings

826

# adding all client settings

827

for setting, value in settings.items():

828

setattr(self, setting, value)

829

830

if self.enabled:

831

if not hasattr(self, "last_enabled"):

832

self.last_enabled = datetime.datetime.utcnow()

833

if not hasattr(self, "expires"):

834

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

835

+ self.timeout)

836

else:

837

self.last_enabled = None

838

self.expires = None

839

508

840

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

509

# Uppercase and remove spaces from fingerprint for later

510

# comparison purposes with return value from the fingerprint()

511

# function

512

self.fingerprint = config["fingerprint"]

513

841

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

514

self.secret = config["secret"]

515

self.host = config["host"]

516

self.created = datetime.datetime.utcnow()

517

self.enabled = config["enabled"]

518

self.last_approval_request = None

519

if self.enabled:

520

self.last_enabled = datetime.datetime.utcnow()

521

else:

522

self.last_enabled = None

523

self.last_checked_ok = None

524

self.last_checker_status = None

525

self.timeout = config["timeout"]

526

self.extended_timeout = config["extended_timeout"]

527

self.interval = config["interval"]

842

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

843

datetime.datetime.utcnow())

844

845

# attributes specific for this server instance

528

846

self.checker = None

529

847

self.checker_initiator_tag = None

530

848

self.disable_initiator_tag = None

531

if self.enabled:

532

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

533

else:

534

self.expires = None

535

849

self.checker_callback_tag = None

536

self.checker_command = config["checker"]

537

850

self.current_checker_command = None

538

851

self.approved = None

539

self.approved_by_default = config["approved_by_default"]

540

852

self.approvals_pending = 0

541

self.approval_delay = config["approval_delay"]

542

self.approval_duration = config["approval_duration"]

543

self.changedstate = (multiprocessing_manager

544

.Condition(multiprocessing_manager

545

.Lock()))

546

self.client_structure = [attr for attr in

547

self.__dict__.iterkeys()

853

self.changedstate = multiprocessing_manager.Condition(

854

multiprocessing_manager.Lock())

855

self.client_structure = [attr

856

for attr in self.__dict__.iterkeys()

548

857

if not attr.startswith("_")]

549

858

self.client_structure.append("client_structure")

550

859

551

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

552

lambda obj:

553

isinstance(obj,

554

property)):

860

for name, t in inspect.getmembers(

861

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

555

862

if not name.startswith("_"):

556

863

self.client_structure.append(name)

557

864

565

872

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

566

873

# Already enabled

567

874

return

568

self.send_changedstate()

569

875

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

570

876

self.enabled = True

571

877

self.last_enabled = datetime.datetime.utcnow()

572

878

self.init_checker()

879

self.send_changedstate()

573

880

574

881

def disable(self, quiet=True):

575

882

"""Disable this client."""

576

883

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

577

884

return False

578

885

if not quiet:

579

self.send_changedstate()

580

if not quiet:

581

886

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

582

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

583

gobject.source_remove(self.disable_initiator_tag)

887

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

888

GObject.source_remove(self.disable_initiator_tag)

584

889

self.disable_initiator_tag = None

585

890

self.expires = None

586

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

587

gobject.source_remove(self.checker_initiator_tag)

891

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

892

GObject.source_remove(self.checker_initiator_tag)

588

893

self.checker_initiator_tag = None

589

894

self.stop_checker()

590

895

self.enabled = False

591

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

896

if not quiet:

897

self.send_changedstate()

898

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

592

899

return False

593

900

594

901

def __del__(self):

597

904

def init_checker(self):

598

905

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

599

906

# and every interval from then on.

600

self.checker_initiator_tag = (gobject.timeout_add

601

(self.interval_milliseconds(),

602

self.start_checker))

907

if self.checker_initiator_tag is not None:

908

GObject.source_remove(self.checker_initiator_tag)

909

self.checker_initiator_tag = GObject.timeout_add(

910

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

911

self.start_checker)

603

912

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

604

self.disable_initiator_tag = (gobject.timeout_add

605

(self.timeout_milliseconds(),

606

self.disable))

913

if self.disable_initiator_tag is not None:

914

GObject.source_remove(self.disable_initiator_tag)

915

self.disable_initiator_tag = GObject.timeout_add(

916

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

607

917

# Also start a new checker *right now*.

608

918

self.start_checker()

609

919

610

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

920

def checker_callback(self, source, condition, connection,

921

command):

611

922

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

612

923

self.checker_callback_tag = None

613

924

self.checker = None

614

if os.WIFEXITED(condition):

615

self.last_checker_status = os.WEXITSTATUS(condition)

925

# Read return code from connection (see call_pipe)

926

returncode = connection.recv()

927

connection.close()

928

929

if returncode >= 0:

930

self.last_checker_status = returncode

931

self.last_checker_signal = None

616

932

if self.last_checker_status == 0:

617

933

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

618

934

vars(self))

619

935

self.checked_ok()

620

936

else:

621

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

622

vars(self))

937

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

623

938

else:

624

939

self.last_checker_status = -1

940

self.last_checker_signal = -returncode

625

941

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

626

942

vars(self))

627

628

def checked_ok(self, timeout=None):

629

"""Bump up the timeout for this client.

630

631

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

632

alive and well.

633

"""

943

return False

944

945

def checked_ok(self):

946

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

947

self.last_checked_ok = datetime.datetime.utcnow()

948

self.last_checker_status = 0

949

self.last_checker_signal = None

950

self.bump_timeout()

951

952

def bump_timeout(self, timeout=None):

953

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

634

954

if timeout is None:

635

955

timeout = self.timeout

636

self.last_checked_ok = datetime.datetime.utcnow()

637

956

if self.disable_initiator_tag is not None:

638

gobject.source_remove(self.disable_initiator_tag)

957

GObject.source_remove(self.disable_initiator_tag)

958

self.disable_initiator_tag = None

639

959

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

640

self.disable_initiator_tag = (gobject.timeout_add

641

(timedelta_to_milliseconds

642

(timeout), self.disable))

960

self.disable_initiator_tag = GObject.timeout_add(

961

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

643

962

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

644

963

645

964

def need_approval(self):

651

970

If a checker already exists, leave it running and do

652

971

nothing."""

653

972

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

654

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

655

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

656

# client would inevitably timeout, since no checker would get

657

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

973

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

974

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

975

# would inevitably timeout, since no checker would get a

976

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

658

977

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

659

978

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

660

979

# should be.

661

980

662

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

663

try:

664

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

665

except (AttributeError, OSError) as error:

666

if (isinstance(error, OSError)

667

and error.errno != errno.ECHILD):

668

raise error

669

else:

670

if pid:

671

logger.warning("Checker was a zombie")

672

gobject.source_remove(self.checker_callback_tag)

673

self.checker_callback(pid, status,

674

self.current_checker_command)

981

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

982

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

983

self.checker.join()

984

self.checker = None

675

985

# Start a new checker if needed

676

986

if self.checker is None:

987

# Escape attributes for the shell

988

escaped_attrs = {

989

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

990

for attr in self.runtime_expansions }

677

991

try:

678

# In case checker_command has exactly one % operator

679

command = self.checker_command % self.host

680

except TypeError:

681

# Escape attributes for the shell

682

escaped_attrs = dict(

683

(attr,

684

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

685

errors=

686

'replace')))

687

for attr in

688

self.runtime_expansions)

689

690

try:

691

command = self.checker_command % escaped_attrs

692

except TypeError as error:

693

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

694

' %s', self.checker_command, error)

695

return True # Try again later

992

command = self.checker_command % escaped_attrs

993

except TypeError as error:

994

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

995

self.checker_command,

996

exc_info=error)

997

return True # Try again later

696

998

self.current_checker_command = command

697

try:

698

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

699

command, self.name)

700

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

701

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

702

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

703

# always replaced by /dev/null.)

704

self.checker = subprocess.Popen(command,

705

close_fds=True,

706

shell=True, cwd="/")

707

self.checker_callback_tag = (gobject.child_watch_add

708

(self.checker.pid,

709

self.checker_callback,

710

data=command))

711

# The checker may have completed before the gobject

712

# watch was added. Check for this.

713

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

714

if pid:

715

gobject.source_remove(self.checker_callback_tag)

716

self.checker_callback(pid, status, command)

717

except OSError as error:

718

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

719

error)

720

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

999

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

1000

self.name)

1001

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

1002

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

1003

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

1004

# always replaced by /dev/null.)

1005

# The exception is when not debugging but nevertheless

1006

# running in the foreground; use the previously

1007

# created wnull.

1008

popen_args = { "close_fds": True,

1009

"shell": True,

1010

"cwd": "/" }

1011

if (not self.server_settings["debug"]

1012

and self.server_settings["foreground"]):

1013

popen_args.update({"stdout": wnull,

1014

"stderr": wnull })

1015

pipe = multiprocessing.Pipe(duplex = False)

1016

self.checker = multiprocessing.Process(

1017

target = call_pipe,

1018

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

1019

kwargs = popen_args)

1020

self.checker.start()

1021

self.checker_callback_tag = GObject.io_add_watch(

1022

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

1023

self.checker_callback, pipe[0], command)

1024

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

721

1025

return True

722

1026

723

1027

def stop_checker(self):

724

1028

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

725

1029

if self.checker_callback_tag:

726

gobject.source_remove(self.checker_callback_tag)

1030

GObject.source_remove(self.checker_callback_tag)

727

1031

self.checker_callback_tag = None

728

1032

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

729

1033

return

730

1034

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

731

try:

732

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

733

#time.sleep(0.5)

734

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

735

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

736

except OSError as error:

737

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

738

raise

1035

self.checker.terminate()

739

1036

self.checker = None

740

1037

741

1038

742

def dbus_service_property(dbus_interface, signature="v",

743

access="readwrite", byte_arrays=False):

1039

def dbus_service_property(dbus_interface,

1040

signature="v",

1041

access="readwrite",

1042

byte_arrays=False):

744

1043

"""Decorators for marking methods of a DBusObjectWithProperties to

745

1044

become properties on the D-Bus.

746

1045

755

1054

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

756

1055

if byte_arrays and signature != "ay":

757

1056

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

758

" signature %r" % signature)

1057

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

1058

759

1059

def decorator(func):

760

1060

func._dbus_is_property = True

761

1061

func._dbus_interface = dbus_interface

766

1066

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

767

1067

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

768

1068

return func

1069

1070

return decorator

1071

1072

1073

def dbus_interface_annotations(dbus_interface):

1074

"""Decorator for marking functions returning interface annotations

1075

1076

Usage:

1077

1078

@dbus_interface_annotations("org.example.Interface")

1079

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

1080

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

1081

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

1082

"false"}

1083

"""

1084

1085

def decorator(func):

1086

func._dbus_is_interface = True

1087

func._dbus_interface = dbus_interface

1088

func._dbus_name = dbus_interface

1089

return func

1090

1091

return decorator

1092

1093

1094

def dbus_annotations(annotations):

1095

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

1096

Usage:

1097

1098

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

1099

"org.freedesktop.DBus.Property."

1100

"EmitsChangedSignal": "false"})

1101

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

1102

access="r")

1103

def Property_dbus_property(self):

1104

return dbus.Boolean(False)

1105

1106

See also the DBusObjectWithAnnotations class.

1107

"""

1108

1109

def decorator(func):

1110

func._dbus_annotations = annotations

1111

return func

1112

769

1113

return decorator

770

1114

771

1115

772

1116

class DBusPropertyException(dbus.exceptions.DBusException):

773

1117

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

774

1118

"""

775

def __unicode__(self):

776

return unicode(str(self))

1119

pass

777

1120

778

1121

779

1122

class DBusPropertyAccessException(DBusPropertyException):

788

1131

pass

789

1132

790

1133

791

class DBusObjectWithProperties(dbus.service.Object):

1134

class DBusObjectWithAnnotations(dbus.service.Object):

1135

"""A D-Bus object with annotations.

1136

1137

Classes inheriting from this can use the dbus_annotations

1138

decorator to add annotations to methods or signals.

1139

"""

1140

1141

@staticmethod

1142

def _is_dbus_thing(thing):

1143

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

1144

1145

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

1146

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

1147

"""

1148

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

1149

False)

1150

1151

def _get_all_dbus_things(self, thing):

1152

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

1153

"""

1154

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

1155

athing.__get__(self))

1156

for cls in self.__class__.__mro__

1157

for name, athing in

1158

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

1159

1160

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1161

out_signature = "s",

1162

path_keyword = 'object_path',

1163

connection_keyword = 'connection')

1164

def Introspect(self, object_path, connection):

1165

"""Overloading of standard D-Bus method.

1166

1167

Inserts annotation tags on methods and signals.

1168

"""

1169

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

1170

connection)

1171

try:

1172

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

1173

1174

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

1175

# Add annotation tags

1176

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

1177

for tag in if_tag.getElementsByTagName(typ):

1178

annots = dict()

1179

for name, prop in (self.

1180

_get_all_dbus_things(typ)):

1181

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

1182

and prop._dbus_interface

1183

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

1184

annots.update(getattr(

1185

prop, "_dbus_annotations", {}))

1186

for name, value in annots.items():

1187

ann_tag = document.createElement(

1188

"annotation")

1189

ann_tag.setAttribute("name", name)

1190

ann_tag.setAttribute("value", value)

1191

tag.appendChild(ann_tag)

1192

# Add interface annotation tags

1193

for annotation, value in dict(

1194

itertools.chain.from_iterable(

1195

annotations().items()

1196

for name, annotations

1197

in self._get_all_dbus_things("interface")

1198

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

1199

)).items():

1200

ann_tag = document.createElement("annotation")

1201

ann_tag.setAttribute("name", annotation)

1202

ann_tag.setAttribute("value", value)

1203

if_tag.appendChild(ann_tag)

1204

# Fix argument name for the Introspect method itself

1205

if (if_tag.getAttribute("name")

1206

== dbus.INTROSPECTABLE_IFACE):

1207

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

1208

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

1209

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

1210

if (arg.getAttribute("direction")

1211

== "out"):

1212

arg.setAttribute("name",

1213

"xml_data")

1214

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

1215

document.unlink()

1216

except (AttributeError, xml.dom.DOMException,

1217

xml.parsers.expat.ExpatError) as error:

1218

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

1219

exc_info=error)

1220

return xmlstring

1221

1222

1223

class DBusObjectWithProperties(DBusObjectWithAnnotations):

792

1224

"""A D-Bus object with properties.

793

1225

794

1226

Classes inheriting from this can use the dbus_service_property

796

1228

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

797

1229

"""

798

1230

799

@staticmethod

800

def _is_dbus_property(obj):

801

return getattr(obj, "_dbus_is_property", False)

802

803

def _get_all_dbus_properties(self):

804

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

805

"""

806

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

807

for cls in self.__class__.__mro__

808

for name, prop in

809

inspect.getmembers(cls, self._is_dbus_property))

810

811

1231

def _get_dbus_property(self, interface_name, property_name):

812

1232

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

813

1233

property with the specified name and interface.

814

1234

"""

815

for cls in self.__class__.__mro__:

816

for name, value in (inspect.getmembers

817

(cls, self._is_dbus_property)):

1235

for cls in self.__class__.__mro__:

1236

for name, value in inspect.getmembers(

1237

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

818

1238

if (value._dbus_name == property_name

819

1239

and value._dbus_interface == interface_name):

820

1240

return value.__get__(self)

821

1241

822

1242

# No such property

823

raise DBusPropertyNotFound(self.dbus_object_path + ":"

824

+ interface_name + "."

825

+ property_name)

826

827

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

1243

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

1244

self.dbus_object_path, interface_name, property_name))

1245

1246

@classmethod

1247

def _get_all_interface_names(cls):

1248

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

1249

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

1250

"_dbus_interface", None)

1251

for x in (inspect.getmro(cls))

1252

for attr in dir(x))

1253

if name is not None)

1254

1255

@dbus.service.method(dbus.PROPERTIES_IFACE,

1256

in_signature="ss",

828

1257

out_signature="v")

829

1258

def Get(self, interface_name, property_name):

830

1259

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

848

1277

# The byte_arrays option is not supported yet on

849

1278

# signatures other than "ay".

850

1279

if prop._dbus_signature != "ay":

851

raise ValueError

852

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

853

for byte in value))

1280

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

1281

"'ay' signature {!r}"

1282

.format(prop._dbus_signature))

1283

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

1284

for byte in value))

854

1285

prop(value)

855

1286

856

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

1287

@dbus.service.method(dbus.PROPERTIES_IFACE,

1288

in_signature="s",

857

1289

out_signature="a{sv}")

858

1290

def GetAll(self, interface_name):

859

1291

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

862

1294

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

863

1295

"""

864

1296

properties = {}

865

for name, prop in self._get_all_dbus_properties():

1297

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

866

1298

if (interface_name

867

1299

and interface_name != prop._dbus_interface):

868

1300

# Interface non-empty but did not match

874

1306

if not hasattr(value, "variant_level"):

875

1307

properties[name] = value

876

1308

continue

877

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

878

value.variant_level+1)

1309

properties[name] = type(value)(

1310

value, variant_level = value.variant_level + 1)

879

1311

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

880

1312

1313

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

1314

def PropertiesChanged(self, interface_name, changed_properties,

1315

invalidated_properties):

1316

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

1317

standard.

1318

"""

1319

pass

1320

881

1321

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

882

1322

out_signature="s",

883

1323

path_keyword='object_path',

884

1324

connection_keyword='connection')

885

1325

def Introspect(self, object_path, connection):

886

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

1326

"""Overloading of standard D-Bus method.

1327

1328

Inserts property tags and interface annotation tags.

887

1329

"""

888

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

889

connection)

1330

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1331

object_path,

1332

connection)

890

1333

try:

891

1334

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

1335

892

1336

def make_tag(document, name, prop):

893

1337

e = document.createElement("property")

894

1338

e.setAttribute("name", name)

895

1339

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

896

1340

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

897

1341

return e

1342

898

1343

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

1344

# Add property tags

899

1345

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

900

1346

for name, prop

901

in self._get_all_dbus_properties()

1347

in self._get_all_dbus_things("property")

902

1348

if prop._dbus_interface

903

1349

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

904

1350

if_tag.appendChild(tag)

1351

# Add annotation tags for properties

1352

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

1353

annots = dict()

1354

for name, prop in self._get_all_dbus_things(

1355

"property"):

1356

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

1357

and prop._dbus_interface

1358

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

1359

annots.update(getattr(

1360

prop, "_dbus_annotations", {}))

1361

for name, value in annots.items():

1362

ann_tag = document.createElement(

1363

"annotation")

1364

ann_tag.setAttribute("name", name)

1365

ann_tag.setAttribute("value", value)

1366

tag.appendChild(ann_tag)

905

1367

# Add the names to the return values for the

906

1368

# "org.freedesktop.DBus.Properties" methods

907

1369

if (if_tag.getAttribute("name")

922

1384

except (AttributeError, xml.dom.DOMException,

923

1385

xml.parsers.expat.ExpatError) as error:

924

1386

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

925

error)

926

return xmlstring

927

928

929

def datetime_to_dbus (dt, variant_level=0):

1387

exc_info=error)

1388

return xmlstring

1389

1390

try:

1391

dbus.OBJECT_MANAGER_IFACE

1392

except AttributeError:

1393

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

1394

1395

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1396

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

1397

1398

Classes inheriting from this exposes the standard

1399

GetManagedObjects call and the InterfacesAdded and

1400

InterfacesRemoved signals on the standard

1401

"org.freedesktop.DBus.ObjectManager" interface.

1402

1403

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

1404

manually.

1405

"""

1406

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1407

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

1408

def GetManagedObjects(self):

1409

"""This function must be overridden"""

1410

raise NotImplementedError()

1411

1412

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1413

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

1414

def InterfacesAdded(self, object_path, interfaces_and_properties):

1415

pass

1416

1417

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

1418

def InterfacesRemoved(self, object_path, interfaces):

1419

pass

1420

1421

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1422

out_signature = "s",

1423

path_keyword = 'object_path',

1424

connection_keyword = 'connection')

1425

def Introspect(self, object_path, connection):

1426

"""Overloading of standard D-Bus method.

1427

1428

Override return argument name of GetManagedObjects to be

1429

"objpath_interfaces_and_properties"

1430

"""

1431

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1432

object_path,

1433

connection)

1434

try:

1435

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

1436

1437

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

1438

# Fix argument name for the GetManagedObjects method

1439

if (if_tag.getAttribute("name")

1440

== dbus.OBJECT_MANAGER_IFACE):

1441

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

1442

if (cn.getAttribute("name")

1443

== "GetManagedObjects"):

1444

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

1445

if (arg.getAttribute("direction")

1446

== "out"):

1447

arg.setAttribute(

1448

"name",

1449

"objpath_interfaces"

1450

"_and_properties")

1451

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

1452

document.unlink()

1453

except (AttributeError, xml.dom.DOMException,

1454

xml.parsers.expat.ExpatError) as error:

1455

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

1456

exc_info = error)

1457

return xmlstring

1458

1459

def datetime_to_dbus(dt, variant_level=0):

930

1460

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

931

1461

if dt is None:

932

1462

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

933

return dbus.String(dt.isoformat(),

934

variant_level=variant_level)

935

936

937

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

938

.__metaclass__):

939

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

940

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

1463

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

1464

1465

1466

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1467

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

1468

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

1469

interface names according to the "alt_interface_names" mapping.

1470

Usage:

1471

1472

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

1473

"net.example.AlternateInterface"})

1474

class SampleDBusObject(dbus.service.Object):

1475

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

1476

def SampleDBusMethod():

1477

pass

1478

1479

The above "SampleDBusMethod" on "SampleDBusObject" will be

1480

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

1481

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

1482

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

1483

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

1484

1485

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

1486

(from DBusObjectWithProperties) and interfaces (from the

1487

dbus_interface_annotations decorator).

941

1488

"""

942

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

943

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

944

# methods, signals, or properties in them

945

for base in (b for b in bases

946

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

947

# Go though all attributes of the base class

948

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

1489

1490

def wrapper(cls):

1491

for orig_interface_name, alt_interface_name in (

1492

alt_interface_names.items()):

1493

attr = {}

1494

interface_names = set()

1495

# Go though all attributes of the class

1496

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

949

1497

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

950

1498

# with the wrong interface name

951

1499

if (not hasattr(attribute, "_dbus_interface")

952

or not attribute._dbus_interface

953

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

1500

or not attribute._dbus_interface.startswith(

1501

orig_interface_name)):

954

1502

continue

955

1503

# Create an alternate D-Bus interface name based on

956

1504

# the current name

957

alt_interface = (attribute._dbus_interface

958

.replace("se.recompile.Mandos",

959

"se.bsnet.fukt.Mandos"))

1505

alt_interface = attribute._dbus_interface.replace(

1506

orig_interface_name, alt_interface_name)

1507

interface_names.add(alt_interface)

960

1508

# Is this a D-Bus signal?

961

1509

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

962

# Extract the original non-method function by

963

# black magic

964

nonmethod_func = (dict(

1510

if sys.version_info.major == 2:

1511

# Extract the original non-method undecorated

1512

# function by black magic

1513

nonmethod_func = (dict(

965

1514

zip(attribute.func_code.co_freevars,

966

attribute.__closure__))["func"]

967

.cell_contents)

1515

attribute.__closure__))

1516

["func"].cell_contents)

1517

else:

1518

nonmethod_func = attribute

968

1519

# Create a new, but exactly alike, function

969

1520

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

970

1521

# with the alternate D-Bus interface name

971

new_function = (dbus.service.signal

972

(alt_interface,

973

attribute._dbus_signature)

974

(types.FunctionType(

975

nonmethod_func.func_code,

976

nonmethod_func.func_globals,

977

nonmethod_func.func_name,

978

nonmethod_func.func_defaults,

979

nonmethod_func.func_closure)))

1522

if sys.version_info.major == 2:

1523

new_function = types.FunctionType(

1524

nonmethod_func.func_code,

1525

nonmethod_func.func_globals,

1526

nonmethod_func.func_name,

1527

nonmethod_func.func_defaults,

1528

nonmethod_func.func_closure)

1529

else:

1530

new_function = types.FunctionType(

1531

nonmethod_func.__code__,

1532

nonmethod_func.__globals__,

1533

nonmethod_func.__name__,

1534

nonmethod_func.__defaults__,

1535

nonmethod_func.__closure__)

1536

new_function = (dbus.service.signal(

1537

alt_interface,

1538

attribute._dbus_signature)(new_function))

1539

# Copy annotations, if any

1540

try:

1541

new_function._dbus_annotations = dict(

1542

attribute._dbus_annotations)

1543

except AttributeError:

1544

pass

980

1545

# Define a creator of a function to call both the

981

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

982

# signals gets sent when the function is called

1546

# original and alternate functions, so both the

1547

# original and alternate signals gets sent when

1548

# the function is called

983

1549

def fixscope(func1, func2):

984

1550

"""This function is a scope container to pass

985

1551

func1 and func2 to the "call_both" function

986

1552

outside of its arguments"""

1553

1554

@functools.wraps(func2)

987

1555

def call_both(*args, **kwargs):

988

1556

"""This function will emit two D-Bus

989

1557

signals by calling func1 and func2"""

990

1558

func1(*args, **kwargs)

991

1559

func2(*args, **kwargs)

1560

# Make wrapper function look like a D-Bus signal

1561

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

1562

if name.startswith("_dbus_"):

1563

setattr(call_both, name, attr)

1564

992

1565

return call_both

993

1566

# Create the "call_both" function and add it to

994

1567

# the class

995

attr[attrname] = fixscope(attribute,

996

new_function)

1568

attr[attrname] = fixscope(attribute, new_function)

997

1569

# Is this a D-Bus method?

998

1570

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

999

1571

# Create a new, but exactly alike, function

1000

1572

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

1001

1573

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

1002

1574

# to the class.

1003

attr[attrname] = (dbus.service.method

1004

(alt_interface,

1005

attribute._dbus_in_signature,

1006

attribute._dbus_out_signature)

1007

(types.FunctionType

1008

(attribute.func_code,

1009

attribute.func_globals,

1010

attribute.func_name,

1011

attribute.func_defaults,

1012

attribute.func_closure)))

1575

attr[attrname] = (

1576

dbus.service.method(

1577

alt_interface,

1578

attribute._dbus_in_signature,

1579

attribute._dbus_out_signature)

1580

(types.FunctionType(attribute.func_code,

1581

attribute.func_globals,

1582

attribute.func_name,

1583

attribute.func_defaults,

1584

attribute.func_closure)))

1585

# Copy annotations, if any

1586

try:

1587

attr[attrname]._dbus_annotations = dict(

1588

attribute._dbus_annotations)

1589

except AttributeError:

1590

pass

1013

1591

# Is this a D-Bus property?

1014

1592

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

1015

1593

# Create a new, but exactly alike, function

1016

1594

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

1017

1595

# property with the alternate D-Bus interface

1018

1596

# name. Add it to the class.

1019

attr[attrname] = (dbus_service_property

1020

(alt_interface,

1021

attribute._dbus_signature,

1022

attribute._dbus_access,

1023

attribute

1024

._dbus_get_args_options

1025

["byte_arrays"])

1026

(types.FunctionType

1027

(attribute.func_code,

1028

attribute.func_globals,

1029

attribute.func_name,

1030

attribute.func_defaults,

1031

attribute.func_closure)))

1032

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

1033

1034

1597

attr[attrname] = (dbus_service_property(

1598

alt_interface, attribute._dbus_signature,

1599

attribute._dbus_access,

1600

attribute._dbus_get_args_options

1601

["byte_arrays"])

1602

(types.FunctionType(

1603

attribute.func_code,

1604

attribute.func_globals,

1605

attribute.func_name,

1606

attribute.func_defaults,

1607

attribute.func_closure)))

1608

# Copy annotations, if any

1609

try:

1610

attr[attrname]._dbus_annotations = dict(

1611

attribute._dbus_annotations)

1612

except AttributeError:

1613

pass

1614

# Is this a D-Bus interface?

1615

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

1616

# Create a new, but exactly alike, function

1617

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

1618

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

1619

# to the class.

1620

attr[attrname] = (

1621

dbus_interface_annotations(alt_interface)

1622

(types.FunctionType(attribute.func_code,

1623

attribute.func_globals,

1624

attribute.func_name,

1625

attribute.func_defaults,

1626

attribute.func_closure)))

1627

if deprecate:

1628

# Deprecate all alternate interfaces

1629

iname="_AlternateDBusNames_interface_annotation{}"

1630

for interface_name in interface_names:

1631

1632

@dbus_interface_annotations(interface_name)

1633

def func(self):

1634

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

1635

"true" }

1636

# Find an unused name

1637

for aname in (iname.format(i)

1638

for i in itertools.count()):

1639

if aname not in attr:

1640

attr[aname] = func

1641

break

1642

if interface_names:

1643

# Replace the class with a new subclass of it with

1644

# methods, signals, etc. as created above.

1645

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

1646

(cls, ), attr)

1647

return cls

1648

1649

return wrapper

1650

1651

1652

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

1653

"se.bsnet.fukt.Mandos"})

1035

1654

class ClientDBus(Client, DBusObjectWithProperties):

1036

1655

"""A Client class using D-Bus

1037

1656

1041

1660

"""

1042

1661

1043

1662

runtime_expansions = (Client.runtime_expansions

1044

+ ("dbus_object_path",))

1663

+ ("dbus_object_path", ))

1664

1665

_interface = "se.recompile.Mandos.Client"

1045

1666

1046

1667

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

1047

1668

1048

1669

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

1049

1670

self.bus = bus

1050

1671

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

1051

1052

self._approvals_pending = 0

1053

1672

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

1054

1673

# the D-Bus

1055

client_object_name = unicode(self.name).translate(

1674

client_object_name = str(self.name).translate(

1056

1675

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

1057

1676

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

1058

self.dbus_object_path = (dbus.ObjectPath

1059

("/clients/" + client_object_name))

1677

self.dbus_object_path = dbus.ObjectPath(

1678

"/clients/" + client_object_name)

1060

1679

DBusObjectWithProperties.__init__(self, self.bus,

1061

1680

self.dbus_object_path)

1062

1063

def notifychangeproperty(transform_func,

1064

dbus_name, type_func=lambda x: x,

1065

variant_level=1):

1681

1682

def notifychangeproperty(transform_func, dbus_name,

1683

type_func=lambda x: x,

1684

variant_level=1,

1685

invalidate_only=False,

1686

_interface=_interface):

1066

1687

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

1067

1688

its changes to DBus.

1068

1689

1073

1694

to the D-Bus. Default: no transform

1074

1695

variant_level: D-Bus variant level. Default: 1

1075

1696

"""

1076

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

1697

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

1698

1077

1699

def setter(self, value):

1078

1700

if hasattr(self, "dbus_object_path"):

1079

1701

if (not hasattr(self, attrname) or

1080

1702

type_func(getattr(self, attrname, None))

1081

1703

!= type_func(value)):

1082

dbus_value = transform_func(type_func(value),

1083

variant_level

1084

=variant_level)

1085

self.PropertyChanged(dbus.String(dbus_name),

1086

dbus_value)

1704

if invalidate_only:

1705

self.PropertiesChanged(

1706

_interface, dbus.Dictionary(),

1707

dbus.Array((dbus_name, )))

1708

else:

1709

dbus_value = transform_func(

1710

type_func(value),

1711

variant_level = variant_level)

1712

self.PropertyChanged(dbus.String(dbus_name),

1713

dbus_value)

1714

self.PropertiesChanged(

1715

_interface,

1716

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

1717

dbus_value }),

1718

dbus.Array())

1087

1719

setattr(self, attrname, value)

1088

1720

1089

1721

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

1090

1722

1091

1092

1723

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1093

1724

approvals_pending = notifychangeproperty(dbus.Boolean,

1094

1725

"ApprovalPending",

1096

1727

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

1097

1728

last_enabled = notifychangeproperty(datetime_to_dbus,

1098

1729

"LastEnabled")

1099

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

1100

type_func = lambda checker:

1101

checker is not None)

1730

checker = notifychangeproperty(

1731

dbus.Boolean, "CheckerRunning",

1732

type_func = lambda checker: checker is not None)

1102

1733

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1103

1734

"LastCheckedOK")

1735

last_checker_status = notifychangeproperty(dbus.Int16,

1736

"LastCheckerStatus")

1104

1737

last_approval_request = notifychangeproperty(

1105

1738

datetime_to_dbus, "LastApprovalRequest")

1106

1739

approved_by_default = notifychangeproperty(dbus.Boolean,

1107

1740

"ApprovedByDefault")

1108

approval_delay = notifychangeproperty(dbus.UInt64,

1109

"ApprovalDelay",

1110

type_func =

1111

timedelta_to_milliseconds)

1741

approval_delay = notifychangeproperty(

1742

dbus.UInt64, "ApprovalDelay",

1743

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

1112

1744

approval_duration = notifychangeproperty(

1113

1745

dbus.UInt64, "ApprovalDuration",

1114

type_func = timedelta_to_milliseconds)

1746

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

1115

1747

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

1116

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

1117

type_func =

1118

timedelta_to_milliseconds)

1748

timeout = notifychangeproperty(

1749

dbus.UInt64, "Timeout",

1750

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

1119

1751

extended_timeout = notifychangeproperty(

1120

1752

dbus.UInt64, "ExtendedTimeout",

1121

type_func = timedelta_to_milliseconds)

1122

interval = notifychangeproperty(dbus.UInt64,

1123

"Interval",

1124

type_func =

1125

timedelta_to_milliseconds)

1753

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

1754

interval = notifychangeproperty(

1755

dbus.UInt64, "Interval",

1756

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

1126

1757

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

1758

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

1759

invalidate_only=True)

1127

1760

1128

1761

del notifychangeproperty

1129

1762

1136

1769

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

1137

1770

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

1138

1771

1139

def checker_callback(self, pid, condition, command,

1140

*args, **kwargs):

1141

self.checker_callback_tag = None

1142

self.checker = None

1143

if os.WIFEXITED(condition):

1144

exitstatus = os.WEXITSTATUS(condition)

1772

def checker_callback(self, source, condition,

1773

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

1774

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

1775

connection, command, *args,

1776

**kwargs)

1777

exitstatus = self.last_checker_status

1778

if exitstatus >= 0:

1145

1779

# Emit D-Bus signal

1146

1780

self.CheckerCompleted(dbus.Int16(exitstatus),

1147

dbus.Int64(condition),

1781

# This is specific to GNU libC

1782

dbus.Int64(exitstatus << 8),

1148

1783

dbus.String(command))

1149

1784

else:

1150

1785

# Emit D-Bus signal

1151

1786

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

1152

dbus.Int64(condition),

1787

dbus.Int64(

1788

# This is specific to GNU libC

1789

(exitstatus << 8)

1790

| self.last_checker_signal),

1153

1791

dbus.String(command))

1154

1155

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

1156

*args, **kwargs)

1792

return ret

1157

1793

1158

1794

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

1159

old_checker = self.checker

1160

if self.checker is not None:

1161

old_checker_pid = self.checker.pid

1162

else:

1163

old_checker_pid = None

1795

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

1164

1796

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

1165

1797

# Only if new checker process was started

1166

1798

if (self.checker is not None

1174

1806

return False

1175

1807

1176

1808

def approve(self, value=True):

1177

self.send_changedstate()

1178

1809

self.approved = value

1179

gobject.timeout_add(timedelta_to_milliseconds

1180

(self.approval_duration),

1181

self._reset_approved)

1182

1810

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

1811

* 1000), self._reset_approved)

1812

self.send_changedstate()

1183

1813

1184

1814

## D-Bus methods, signals & properties

1185

_interface = "se.recompile.Mandos.Client"

1815

1816

## Interfaces

1186

1817

1187

1818

## Signals

1188

1819

1199

1830

pass

1200

1831

1201

1832

# PropertyChanged - signal

1833

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

1202

1834

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

1203

1835

def PropertyChanged(self, property, value):

1204

1836

"D-Bus signal"

1225

1857

"D-Bus signal"

1226

1858

return self.need_approval()

1227

1859

1228

# NeRwequest - signal

1229

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

1230

def NewRequest(self, ip):

1231

"""D-Bus signal

1232

Is sent after a client request a password.

1233

"""

1234

pass

1235

1236

1860

## Methods

1237

1861

1238

1862

# Approve - method

1246

1870

self.checked_ok()

1247

1871

1248

1872

# Enable - method

1873

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

1249

1874

@dbus.service.method(_interface)

1250

1875

def Enable(self):

1251

1876

"D-Bus method"

1252

1877

self.enable()

1253

1878

1254

1879

# StartChecker - method

1880

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

1255

1881

@dbus.service.method(_interface)

1256

1882

def StartChecker(self):

1257

1883

"D-Bus method"

1258

1884

self.start_checker()

1259

1885

1260

1886

# Disable - method

1887

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

1261

1888

@dbus.service.method(_interface)

1262

1889

def Disable(self):

1263

1890

"D-Bus method"

1264

1891

self.disable()

1265

1892

1266

1893

# StopChecker - method

1894

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

1267

1895

@dbus.service.method(_interface)

1268

1896

def StopChecker(self):

1269

1897

self.stop_checker()

1276

1904

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

1277

1905

1278

1906

# ApprovedByDefault - property

1279

@dbus_service_property(_interface, signature="b",

1907

@dbus_service_property(_interface,

1908

signature="b",

1280

1909

access="readwrite")

1281

1910

def ApprovedByDefault_dbus_property(self, value=None):

1282

1911

if value is None: # get

1284

1913

self.approved_by_default = bool(value)

1285

1914

1286

1915

# ApprovalDelay - property

1287

@dbus_service_property(_interface, signature="t",

1916

@dbus_service_property(_interface,

1917

signature="t",

1288

1918

access="readwrite")

1289

1919

def ApprovalDelay_dbus_property(self, value=None):

1290

1920

if value is None: # get

1291

return dbus.UInt64(self.approval_delay_milliseconds())

1921

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

1922

* 1000)

1292

1923

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

1293

1924

1294

1925

# ApprovalDuration - property

1295

@dbus_service_property(_interface, signature="t",

1926

@dbus_service_property(_interface,

1927

signature="t",

1296

1928

access="readwrite")

1297

1929

def ApprovalDuration_dbus_property(self, value=None):

1298

1930

if value is None: # get

1299

return dbus.UInt64(timedelta_to_milliseconds(

1300

self.approval_duration))

1931

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

1932

* 1000)

1301

1933

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

1302

1934

1303

1935

# Name - property

1936

@dbus_annotations(

1937

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

1304

1938

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

1305

1939

def Name_dbus_property(self):

1306

1940

return dbus.String(self.name)

1307

1941

1308

1942

# Fingerprint - property

1943

@dbus_annotations(

1944

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

1309

1945

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

1310

1946

def Fingerprint_dbus_property(self):

1311

1947

return dbus.String(self.fingerprint)

1312

1948

1313

1949

# Host - property

1314

@dbus_service_property(_interface, signature="s",

1950

@dbus_service_property(_interface,

1951

signature="s",

1315

1952

access="readwrite")

1316

1953

def Host_dbus_property(self, value=None):

1317

1954

if value is None: # get

1318

1955

return dbus.String(self.host)

1319

self.host = unicode(value)

1956

self.host = str(value)

1320

1957

1321

1958

# Created - property

1959

@dbus_annotations(

1960

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

1322

1961

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

1323

1962

def Created_dbus_property(self):

1324

1963

return datetime_to_dbus(self.created)

1329

1968

return datetime_to_dbus(self.last_enabled)

1330

1969

1331

1970

# Enabled - property

1332

@dbus_service_property(_interface, signature="b",

1971

@dbus_service_property(_interface,

1972

signature="b",

1333

1973

access="readwrite")

1334

1974

def Enabled_dbus_property(self, value=None):

1335

1975

if value is None: # get

1340

1980

self.disable()

1341

1981

1342

1982

# LastCheckedOK - property

1343

@dbus_service_property(_interface, signature="s",

1983

@dbus_service_property(_interface,

1984

signature="s",

1344

1985

access="readwrite")

1345

1986

def LastCheckedOK_dbus_property(self, value=None):

1346

1987

if value is not None:

1348

1989

return

1349

1990

return datetime_to_dbus(self.last_checked_ok)

1350

1991

1992

# LastCheckerStatus - property

1993

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

1994

def LastCheckerStatus_dbus_property(self):

1995

return dbus.Int16(self.last_checker_status)

1996

1351

1997

# Expires - property

1352

1998

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

1353

1999

def Expires_dbus_property(self):

1359

2005

return datetime_to_dbus(self.last_approval_request)

1360

2006

1361

2007

# Timeout - property

1362

@dbus_service_property(_interface, signature="t",

2008

@dbus_service_property(_interface,

2009

signature="t",

1363

2010

access="readwrite")

1364

2011

def Timeout_dbus_property(self, value=None):

1365

2012

if value is None: # get

1366

return dbus.UInt64(self.timeout_milliseconds())

2013

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

2014

old_timeout = self.timeout

1367

2015

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

1368

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

1369

return

1370

# Reschedule timeout

1371

gobject.source_remove(self.disable_initiator_tag)

1372

self.disable_initiator_tag = None

1373

self.expires = None

1374

time_to_die = timedelta_to_milliseconds((self

1375

.last_checked_ok

1376

+ self.timeout)

1377

- datetime.datetime

1378

.utcnow())

1379

if time_to_die <= 0:

1380

# The timeout has passed

1381

self.disable()

1382

else:

1383

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

1384

+ datetime.timedelta(milliseconds =

1385

time_to_die))

1386

self.disable_initiator_tag = (gobject.timeout_add

1387

(time_to_die, self.disable))

2016

# Reschedule disabling

2017

if self.enabled:

2018

now = datetime.datetime.utcnow()

2019

self.expires += self.timeout - old_timeout

2020

if self.expires <= now:

2021

# The timeout has passed

2022

self.disable()

2023

else:

2024

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

2025

is None):

2026

return

2027

GObject.source_remove(self.disable_initiator_tag)

2028

self.disable_initiator_tag = GObject.timeout_add(

2029

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

2030

self.disable)

1388

2031

1389

2032

# ExtendedTimeout - property

1390

@dbus_service_property(_interface, signature="t",

2033

@dbus_service_property(_interface,

2034

signature="t",

1391

2035

access="readwrite")

1392

2036

def ExtendedTimeout_dbus_property(self, value=None):

1393

2037

if value is None: # get

1394

return dbus.UInt64(self.extended_timeout_milliseconds())

2038

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

2039

* 1000)

1395

2040

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

1396

2041

1397

2042

# Interval - property

1398

@dbus_service_property(_interface, signature="t",

2043

@dbus_service_property(_interface,

2044

signature="t",

1399

2045

access="readwrite")

1400

2046

def Interval_dbus_property(self, value=None):

1401

2047

if value is None: # get

1402

return dbus.UInt64(self.interval_milliseconds())

2048

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

1403

2049

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

1404

2050

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

1405

2051

return

1406

2052

if self.enabled:

1407

2053

# Reschedule checker run

1408

gobject.source_remove(self.checker_initiator_tag)

1409

self.checker_initiator_tag = (gobject.timeout_add

1410

(value, self.start_checker))

1411

self.start_checker() # Start one now, too

2054

GObject.source_remove(self.checker_initiator_tag)

2055

self.checker_initiator_tag = GObject.timeout_add(

2056

value, self.start_checker)

2057

self.start_checker() # Start one now, too

1412

2058

1413

2059

# Checker - property

1414

@dbus_service_property(_interface, signature="s",

2060

@dbus_service_property(_interface,

2061

signature="s",

1415

2062

access="readwrite")

1416

2063

def Checker_dbus_property(self, value=None):

1417

2064

if value is None: # get

1418

2065

return dbus.String(self.checker_command)

1419

self.checker_command = unicode(value)

2066

self.checker_command = str(value)

1420

2067

1421

2068

# CheckerRunning - property

1422

@dbus_service_property(_interface, signature="b",

2069

@dbus_service_property(_interface,

2070

signature="b",

1423

2071

access="readwrite")

1424

2072

def CheckerRunning_dbus_property(self, value=None):

1425

2073

if value is None: # get

1430

2078

self.stop_checker()

1431

2079

1432

2080

# ObjectPath - property

2081

@dbus_annotations(

2082

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

2083

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

1433

2084

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

1434

2085

def ObjectPath_dbus_property(self):

1435

2086

return self.dbus_object_path # is already a dbus.ObjectPath

1436

2087

1437

2088

# Secret = property

1438

@dbus_service_property(_interface, signature="ay",

1439

access="write", byte_arrays=True)

2089

@dbus_annotations(

2090

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

2091

"invalidates"})

2092

@dbus_service_property(_interface,

2093

signature="ay",

2094

access="write",

2095

byte_arrays=True)

1440

2096

def Secret_dbus_property(self, value):

1441

self.secret = str(value)

2097

self.secret = bytes(value)

1442

2098

1443

2099

del _interface

1444

2100

1448

2104

self._pipe = child_pipe

1449

2105

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

1450

2106

if not self._pipe.recv():

1451

raise KeyError()

2107

raise KeyError(fpr)

1452

2108

1453

2109

def __getattribute__(self, name):

1454

2110

if name == '_pipe':

1458

2114

if data[0] == 'data':

1459

2115

return data[1]

1460

2116

if data[0] == 'function':

2117

1461

2118

def func(*args, **kwargs):

1462

2119

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

1463

2120

return self._pipe.recv()[1]

2121

1464

2122

return func

1465

2123

1466

2124

def __setattr__(self, name, value):

1469

2127

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

1470

2128

1471

2129

1472

class ClientDBusTransitional(ClientDBus):

1473

__metaclass__ = AlternateDBusNamesMetaclass

1474

1475

1476

2130

class ClientHandler(socketserver.BaseRequestHandler, object):

1477

2131

"""A class to handle client connections.

1478

2132

1482

2136

def handle(self):

1483

2137

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

1484

2138

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

1485

unicode(self.client_address))

2139

str(self.client_address))

1486

2140

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

1487

2141

self.server.child_pipe.fileno())

1488

2142

1489

session = (gnutls.connection

1490

.ClientSession(self.request,

1491

gnutls.connection

1492

.X509Credentials()))

1493

1494

# Note: gnutls.connection.X509Credentials is really a

1495

# generic GnuTLS certificate credentials object so long as

1496

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

1497

# here despite using OpenPGP certificates.

2143

session = gnutls.ClientSession(self.request)

1498

2144

1499

2145

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

1500

2146

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

1504

2150

priority = self.server.gnutls_priority

1505

2151

if priority is None:

1506

2152

priority = "NORMAL"

1507

(gnutls.library.functions

1508

.gnutls_priority_set_direct(session._c_object,

1509

priority, None))

2153

gnutls.priority_set_direct(session._c_object, priority,

2154

None)

1510

2155

1511

2156

# Start communication using the Mandos protocol

1512

2157

# Get protocol number

1514

2159

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

1515

2160

try:

1516

2161

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

1517

raise RuntimeError

2162

raise RuntimeError(line)

1518

2163

except (ValueError, IndexError, RuntimeError) as error:

1519

2164

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

1520

2165

return

1522

2167

# Start GnuTLS connection

1523

2168

try:

1524

2169

session.handshake()

1525

except gnutls.errors.GNUTLSError as error:

2170

except gnutls.Error as error:

1526

2171

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

1527

2172

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

1528

2173

# established. Just abandon the request.

1532

2177

approval_required = False

1533

2178

try:

1534

2179

try:

1535

fpr = self.fingerprint(self.peer_certificate

1536

(session))

1537

except (TypeError,

1538

gnutls.errors.GNUTLSError) as error:

2180

fpr = self.fingerprint(

2181

self.peer_certificate(session))

2182

except (TypeError, gnutls.Error) as error:

1539

2183

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

1540

2184

return

1541

2185

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

1546

2190

except KeyError:

1547

2191

return

1548

2192

1549

if self.server.use_dbus:

1550

# Emit D-Bus signal

1551

client.NewRequest(str(self.client_address))

1552

1553

2193

if client.approval_delay:

1554

2194

delay = client.approval_delay

1555

2195

client.approvals_pending += 1

1558

2198

while True:

1559

2199

if not client.enabled:

1560

2200

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

1561

client.name)

2201

client.name)

1562

2202

if self.server.use_dbus:

1563

2203

# Emit D-Bus signal

1564

2204

client.Rejected("Disabled")

1573

2213

if self.server.use_dbus:

1574

2214

# Emit D-Bus signal

1575

2215

client.NeedApproval(

1576

client.approval_delay_milliseconds(),

1577

client.approved_by_default)

2216

client.approval_delay.total_seconds()

2217

* 1000, client.approved_by_default)

1578

2218

else:

1579

2219

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

1580

2220

client.name)

1586

2226

#wait until timeout or approved

1587

2227

time = datetime.datetime.now()

1588

2228

client.changedstate.acquire()

1589

(client.changedstate.wait

1590

(float(client.timedelta_to_milliseconds(delay)

1591

/ 1000)))

2229

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

1592

2230

client.changedstate.release()

1593

2231

time2 = datetime.datetime.now()

1594

2232

if (time2 - time) >= delay:

1605

2243

else:

1606

2244

delay -= time2 - time

1607

2245

1608

sent_size = 0

1609

while sent_size < len(client.secret):

1610

try:

1611

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

1612

except gnutls.errors.GNUTLSError as error:

1613

logger.warning("gnutls send failed")

1614

return

1615

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

1616

sent, len(client.secret)

1617

- (sent_size + sent))

1618

sent_size += sent

2246

try:

2247

session.send(client.secret)

2248

except gnutls.Error as error:

2249

logger.warning("gnutls send failed",

2250

exc_info = error)

2251

return

1619

2252

1620

2253

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

1621

2254

# bump the timeout using extended_timeout

1622

client.checked_ok(client.extended_timeout)

2255

client.bump_timeout(client.extended_timeout)

1623

2256

if self.server.use_dbus:

1624

2257

# Emit D-Bus signal

1625

2258

client.GotSecret()

1629

2262

client.approvals_pending -= 1

1630

2263

try:

1631

2264

session.bye()

1632

except gnutls.errors.GNUTLSError as error:

1633

logger.warning("GnuTLS bye failed")

2265

except gnutls.Error as error:

2266

logger.warning("GnuTLS bye failed",

2267

exc_info=error)

1634

2268

1635

2269

@staticmethod

1636

2270

def peer_certificate(session):

1637

2271

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

1638

2272

# If not an OpenPGP certificate...

1639

if (gnutls.library.functions

1640

.gnutls_certificate_type_get(session._c_object)

1641

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1642

# ...do the normal thing

1643

return session.peer_certificate

2273

if (gnutls.certificate_type_get(session._c_object)

2274

!= gnutls.CRT_OPENPGP):

2275

# ...return invalid data

2276

return b""

1644

2277

list_size = ctypes.c_uint(1)

1645

cert_list = (gnutls.library.functions

1646

.gnutls_certificate_get_peers

2278

cert_list = (gnutls.certificate_get_peers

1647

2279

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

1648

2280

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

1649

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

1650

" certificate")

2281

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

1651

2282

if list_size.value == 0:

1652

2283

return None

1653

2284

cert = cert_list[0]

1657

2288

def fingerprint(openpgp):

1658

2289

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1659

2290

# New GnuTLS "datum" with the OpenPGP public key

1660

datum = (gnutls.library.types

1661

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

1662

ctypes.POINTER

1663

(ctypes.c_ubyte)),

1664

ctypes.c_uint(len(openpgp))))

2291

datum = gnutls.datum_t(

2292

ctypes.cast(ctypes.c_char_p(openpgp),

2293

ctypes.POINTER(ctypes.c_ubyte)),

2294

ctypes.c_uint(len(openpgp)))

1665

2295

# New empty GnuTLS certificate

1666

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1667

(gnutls.library.functions

1668

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2296

crt = gnutls.openpgp_crt_t()

2297

gnutls.openpgp_crt_init(ctypes.byref(crt))

1669

2298

# Import the OpenPGP public key into the certificate

1670

(gnutls.library.functions

1671

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

1672

gnutls.library.constants

1673

.GNUTLS_OPENPGP_FMT_RAW))

2299

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

2300

gnutls.OPENPGP_FMT_RAW)

1674

2301

# Verify the self signature in the key

1675

2302

crtverify = ctypes.c_uint()

1676

(gnutls.library.functions

1677

.gnutls_openpgp_crt_verify_self(crt, 0,

1678

ctypes.byref(crtverify)))

2303

gnutls.openpgp_crt_verify_self(crt, 0,

2304

ctypes.byref(crtverify))

1679

2305

if crtverify.value != 0:

1680

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1681

raise (gnutls.errors.CertificateSecurityError

1682

("Verify failed"))

2306

gnutls.openpgp_crt_deinit(crt)

2307

raise gnutls.CertificateSecurityError("Verify failed")

1683

2308

# New buffer for the fingerprint

1684

2309

buf = ctypes.create_string_buffer(20)

1685

2310

buf_len = ctypes.c_size_t()

1686

2311

# Get the fingerprint from the certificate into the buffer

1687

(gnutls.library.functions

1688

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

1689

ctypes.byref(buf_len)))

2312

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

2313

ctypes.byref(buf_len))

1690

2314

# Deinit the certificate

1691

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2315

gnutls.openpgp_crt_deinit(crt)

1692

2316

# Convert the buffer to a Python bytestring

1693

2317

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

1694

2318

# Convert the bytestring to hexadecimal notation

1698

2322

1699

2323

class MultiprocessingMixIn(object):

1700

2324

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

2325

1701

2326

def sub_process_main(self, request, address):

1702

2327

try:

1703

2328

self.finish_request(request, address)

1708

2333

def process_request(self, request, address):

1709

2334

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

1710

2335

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

1711

args = (request,

1712

address))

2336

args = (request, address))

1713

2337

proc.start()

1714

2338

return proc

1715

2339

1716

2340

1717

2341

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1718

2342

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

2343

1719

2344

def process_request(self, request, client_address):

1720

2345

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

1721

2346

1730

2355

1731

2356

def add_pipe(self, parent_pipe, proc):

1732

2357

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

1733

raise NotImplementedError

2358

raise NotImplementedError()

1734

2359

1735

2360

1736

2361

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1742

2367

interface: None or a network interface name (string)

1743

2368

use_ipv6: Boolean; to use IPv6 or not

1744

2369

"""

2370

1745

2371

def __init__(self, server_address, RequestHandlerClass,

1746

interface=None, use_ipv6=True):

2372

interface=None,

2373

use_ipv6=True,

2374

socketfd=None):

2375

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

2376

creating a new one with socket.socket().

2377

"""

1747

2378

self.interface = interface

1748

2379

if use_ipv6:

1749

2380

self.address_family = socket.AF_INET6

2381

if socketfd is not None:

2382

# Save the file descriptor

2383

self.socketfd = socketfd

2384

# Save the original socket.socket() function

2385

self.socket_socket = socket.socket

2386

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

2387

#

2388

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

2389

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

2390

# patching socket.socket.)

2391

#

2392

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

2393

@functools.wraps(socket.socket)

2394

def socket_wrapper(*args, **kwargs):

2395

# Restore original function so subsequent calls are

2396

# not affected.

2397

socket.socket = self.socket_socket

2398

del self.socket_socket

2399

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

2400

# saved file descriptor.

2401

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

2402

# Replace socket.socket() function with wrapper

2403

socket.socket = socket_wrapper

2404

# The socketserver.TCPServer.__init__ will call

2405

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

2406

# socket_wrapper(), if socketfd was set.

1750

2407

socketserver.TCPServer.__init__(self, server_address,

1751

2408

RequestHandlerClass)

2409

1752

2410

def server_bind(self):

1753

2411

"""This overrides the normal server_bind() function

1754

2412

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

1760

2418

self.interface)

1761

2419

else:

1762

2420

try:

1763

self.socket.setsockopt(socket.SOL_SOCKET,

1764

SO_BINDTODEVICE,

1765

str(self.interface

1766

+ '\0'))

2421

self.socket.setsockopt(

2422

socket.SOL_SOCKET, SO_BINDTODEVICE,

2423

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

1767

2424

except socket.error as error:

1768

if error[0] == errno.EPERM:

1769

logger.error("No permission to"

1770

" bind to interface %s",

1771

self.interface)

1772

elif error[0] == errno.ENOPROTOOPT:

2425

if error.errno == errno.EPERM:

2426

logger.error("No permission to bind to"

2427

" interface %s", self.interface)

2428

elif error.errno == errno.ENOPROTOOPT:

1773

2429

logger.error("SO_BINDTODEVICE not available;"

1774

2430

" cannot bind to interface %s",

1775

2431

self.interface)

2432

elif error.errno == errno.ENODEV:

2433

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

2434

" cannot bind", self.interface)

1776

2435

else:

1777

2436

raise

1778

2437

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

1781

2440

if self.address_family == socket.AF_INET6:

1782

2441

any_address = "::" # in6addr_any

1783

2442

else:

1784

any_address = socket.INADDR_ANY

2443

any_address = "0.0.0.0" # INADDR_ANY

1785

2444

self.server_address = (any_address,

1786

2445

self.server_address[1])

1787

2446

elif not self.server_address[1]:

1788

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

1789

0)

2447

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

1790

2448

# if self.interface:

1791

2449

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

1792

2450

# 0, # port

1804

2462

gnutls_priority GnuTLS priority string

1805

2463

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

1806

2464

1807

Assumes a gobject.MainLoop event loop.

2465

Assumes a GObject.MainLoop event loop.

1808

2466

"""

2467

1809

2468

def __init__(self, server_address, RequestHandlerClass,

1810

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

1811

gnutls_priority=None, use_dbus=True):

2469

interface=None,

2470

use_ipv6=True,

2471

clients=None,

2472

gnutls_priority=None,

2473

use_dbus=True,

2474

socketfd=None):

1812

2475

self.enabled = False

1813

2476

self.clients = clients

1814

2477

if self.clients is None:

1818

2481

IPv6_TCPServer.__init__(self, server_address,

1819

2482

RequestHandlerClass,

1820

2483

interface = interface,

1821

use_ipv6 = use_ipv6)

2484

use_ipv6 = use_ipv6,

2485

socketfd = socketfd)

2486

1822

2487

def server_activate(self):

1823

2488

if self.enabled:

1824

2489

return socketserver.TCPServer.server_activate(self)

1828

2493

1829

2494

def add_pipe(self, parent_pipe, proc):

1830

2495

# Call "handle_ipc" for both data and EOF events

1831

gobject.io_add_watch(parent_pipe.fileno(),

1832

gobject.IO_IN | gobject.IO_HUP,

1833

functools.partial(self.handle_ipc,

1834

parent_pipe =

1835

parent_pipe,

1836

proc = proc))

2496

GObject.io_add_watch(

2497

parent_pipe.fileno(),

2498

GObject.IO_IN | GObject.IO_HUP,

2499

functools.partial(self.handle_ipc,

2500

parent_pipe = parent_pipe,

2501

proc = proc))

1837

2502

1838

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

1839

proc = None, client_object=None):

1840

condition_names = {

1841

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

1842

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

1843

# blocking).

1844

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

1845

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

1846

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

1847

# broken, usually for pipes and

1848

# sockets).

1849

}

1850

conditions_string = ' | '.join(name

1851

for cond, name in

1852

condition_names.iteritems()

1853

if cond & condition)

2503

def handle_ipc(self, source, condition,

2504

parent_pipe=None,

2505

proc = None,

2506

client_object=None):

1854

2507

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

1855

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

2508

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

1856

2509

# Wait for other process to exit

1857

2510

proc.join()

1858

2511

return False

1879

2532

parent_pipe.send(False)

1880

2533

return False

1881

2534

1882

gobject.io_add_watch(parent_pipe.fileno(),

1883

gobject.IO_IN | gobject.IO_HUP,

1884

functools.partial(self.handle_ipc,

1885

parent_pipe =

1886

parent_pipe,

1887

proc = proc,

1888

client_object =

1889

client))

2535

GObject.io_add_watch(

2536

parent_pipe.fileno(),

2537

GObject.IO_IN | GObject.IO_HUP,

2538

functools.partial(self.handle_ipc,

2539

parent_pipe = parent_pipe,

2540

proc = proc,

2541

client_object = client))

1890

2542

parent_pipe.send(True)

1891

2543

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

1892

2544

# same fileno

1898

2550

1899

2551

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

1900

2552

funcname)(*args,

1901

**kwargs)))

2553

**kwargs)))

1902

2554

1903

2555

if command == 'getattr':

1904

2556

attrname = request[1]

1905

if callable(client_object.__getattribute__(attrname)):

1906

parent_pipe.send(('function',))

2557

if isinstance(client_object.__getattribute__(attrname),

2558

collections.Callable):

2559

parent_pipe.send(('function', ))

1907

2560

else:

1908

parent_pipe.send(('data', client_object

1909

.__getattribute__(attrname)))

2561

parent_pipe.send((

2562

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

1910

2563

1911

2564

if command == 'setattr':

1912

2565

attrname = request[1]

1916

2569

return True

1917

2570

1918

2571

2572

def rfc3339_duration_to_delta(duration):

2573

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

2574

2575

>>> rfc3339_duration_to_delta("P7D")

2576

datetime.timedelta(7)

2577

>>> rfc3339_duration_to_delta("PT60S")

2578

datetime.timedelta(0, 60)

2579

>>> rfc3339_duration_to_delta("PT60M")

2580

datetime.timedelta(0, 3600)

2581

>>> rfc3339_duration_to_delta("PT24H")

2582

datetime.timedelta(1)

2583

>>> rfc3339_duration_to_delta("P1W")

2584

datetime.timedelta(7)

2585

>>> rfc3339_duration_to_delta("PT5M30S")

2586

datetime.timedelta(0, 330)

2587

>>> rfc3339_duration_to_delta("P1DT3M20S")

2588

datetime.timedelta(1, 200)

2589

"""

2590

2591

# Parsing an RFC 3339 duration with regular expressions is not

2592

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

2593

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

2594

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

2595

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

2596

# avoid excessive use of external libraries.

2597

2598

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

2599

Token = collections.namedtuple("Token", (

2600

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

2601

# a "group" containing digits

2602

"value", # datetime.timedelta or None

2603

"followers")) # Tokens valid after this token

2604

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

2605

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

2606

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

2607

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

2608

datetime.timedelta(seconds=1),

2609

frozenset((token_end, )))

2610

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

2611

datetime.timedelta(minutes=1),

2612

frozenset((token_second, token_end)))

2613

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

2614

datetime.timedelta(hours=1),

2615

frozenset((token_minute, token_end)))

2616

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

2617

None,

2618

frozenset((token_hour, token_minute,

2619

token_second)))

2620

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

2621

datetime.timedelta(days=1),

2622

frozenset((token_time, token_end)))

2623

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

2624

datetime.timedelta(weeks=4),

2625

frozenset((token_day, token_end)))

2626

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

2627

datetime.timedelta(weeks=52),

2628

frozenset((token_month, token_end)))

2629

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

2630

datetime.timedelta(weeks=1),

2631

frozenset((token_end, )))

2632

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

2633

frozenset((token_year, token_month,

2634

token_day, token_time,

2635

token_week)))

2636

# Define starting values

2637

value = datetime.timedelta() # Value so far

2638

found_token = None

2639

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

2640

s = duration # String left to parse

2641

# Loop until end token is found

2642

while found_token is not token_end:

2643

# Search for any currently valid tokens

2644

for token in followers:

2645

match = token.regexp.match(s)

2646

if match is not None:

2647

# Token found

2648

if token.value is not None:

2649

# Value found, parse digits

2650

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

2651

# Add to value so far

2652

value += factor * token.value

2653

# Strip token from string

2654

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

2655

# Go to found token

2656

found_token = token

2657

# Set valid next tokens

2658

followers = found_token.followers

2659

break

2660

else:

2661

# No currently valid tokens were found

2662

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

2663

.format(duration))

2664

# End token found

2665

return value

2666

2667

1919

2668

def string_to_delta(interval):

1920

2669

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

1921

2670

1932

2681

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

1933

2682

datetime.timedelta(0, 330)

1934

2683

"""

2684

2685

try:

2686

return rfc3339_duration_to_delta(interval)

2687

except ValueError:

2688

pass

2689

1935

2690

timevalue = datetime.timedelta(0)

1936

2691

for s in interval.split():

1937

2692

try:

1938

suffix = unicode(s[-1])

2693

suffix = s[-1]

1939

2694

value = int(s[:-1])

1940

2695

if suffix == "d":

1941

2696

delta = datetime.timedelta(value)

1948

2703

elif suffix == "w":

1949

2704

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

1950

2705

else:

1951

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

1952

except (ValueError, IndexError) as e:

2706

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

2707

except IndexError as e:

1953

2708

raise ValueError(*(e.args))

1954

2709

timevalue += delta

1955

2710

return timevalue

1968

2723

sys.exit()

1969

2724

if not noclose:

1970

2725

# Close all standard open file descriptors

1971

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

2726

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

1972

2727

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

1973

2728

raise OSError(errno.ENODEV,

1974

"%s not a character device"

1975

% os.path.devnull)

2729

"{} not a character device"

2730

.format(os.devnull))

1976

2731

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

1977

2732

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

1978

2733

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

1987

2742

1988

2743

parser = argparse.ArgumentParser()

1989

2744

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

1990

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

2745

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

1991

2746

help="show version number and exit")

1992

2747

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

1993

2748

help="Bind to interface IF")

1999

2754

help="Run self-test")

2000

2755

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

2001

2756

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

2002

" to terminal")

2757

" to terminal", default=None)

2003

2758

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

2004

2759

help="Debug level for stdout output")

2005

2760

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

2012

2767

" files")

2013

2768

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

2014

2769

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

2015

" system bus interface")

2770

" system bus interface", default=None)

2016

2771

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

2017

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

2772

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

2773

default=None)

2018

2774

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

2019

2775

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

2020

" state")

2776

" state", default=None)

2777

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

2778

help="Specify a file descriptor to a network"

2779

" socket to use instead of creating one")

2021

2780

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

2022

2781

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

2782

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

2783

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

2784

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

2785

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

2786

default=None)

2023

2787

2024

2788

options = parser.parse_args()

2025

2789

2026

2790

if options.check:

2027

2791

import doctest

2028

doctest.testmod()

2029

sys.exit()

2792

fail_count, test_count = doctest.testmod()

2793

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

2030

2794

2031

2795

# Default values for config file for server-global settings

2032

2796

server_defaults = { "interface": "",

2034

2798

"port": "",

2035

2799

"debug": "False",

2036

2800

"priority":

2037

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

2801

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

2802

":+SIGN-DSA-SHA256",

2038

2803

"servicename": "Mandos",

2039

2804

"use_dbus": "True",

2040

2805

"use_ipv6": "True",

2041

2806

"debuglevel": "",

2042

2807

"restore": "True",

2043

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

2044

}

2808

"socket": "",

2809

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

2810

"foreground": "False",

2811

"zeroconf": "True",

2812

}

2045

2813

2046

2814

# Parse config file for server-global settings

2047

2815

server_config = configparser.SafeConfigParser(server_defaults)

2048

2816

del server_defaults

2049

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

2050

"mandos.conf"))

2817

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

2051

2818

# Convert the SafeConfigParser object to a dict

2052

2819

server_settings = server_config.defaults()

2053

2820

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

2054

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

2821

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

2055

2822

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

2056

2823

option)

2057

2824

if server_settings["port"]:

2058

2825

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

2059

2826

"port")

2827

if server_settings["socket"]:

2828

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

2829

"socket")

2830

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

2831

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

2832

# happen with a supplied network socket.

2833

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

2834

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

2835

["socket"])

2060

2836

del server_config

2061

2837

2062

2838

# Override the settings from the config file with command line

2063

2839

# options, if set.

2064

2840

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

2065

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

2066

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

2067

"statedir"):

2841

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

2842

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

2843

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

2068

2844

value = getattr(options, option)

2069

2845

if value is not None:

2070

2846

server_settings[option] = value

2071

2847

del options

2072

2848

# Force all strings to be unicode

2073

2849

for option in server_settings.keys():

2074

if type(server_settings[option]) is str:

2075

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

2850

if isinstance(server_settings[option], bytes):

2851

server_settings[option] = (server_settings[option]

2852

.decode("utf-8"))

2853

# Force all boolean options to be boolean

2854

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

2855

"foreground", "zeroconf"):

2856

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

2857

# Debug implies foreground

2858

if server_settings["debug"]:

2859

server_settings["foreground"] = True

2076

2860

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

2077

2861

2078

2862

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

2079

2863

2864

if (not server_settings["zeroconf"]

2865

and not (server_settings["port"]

2866

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

2867

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

2868

2080

2869

# For convenience

2081

2870

debug = server_settings["debug"]

2082

2871

debuglevel = server_settings["debuglevel"]

2084

2873

use_ipv6 = server_settings["use_ipv6"]

2085

2874

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

2086

2875

stored_state_file)

2876

foreground = server_settings["foreground"]

2877

zeroconf = server_settings["zeroconf"]

2087

2878

2088

2879

if debug:

2089

initlogger(logging.DEBUG)

2880

initlogger(debug, logging.DEBUG)

2090

2881

else:

2091

2882

if not debuglevel:

2092

initlogger()

2883

initlogger(debug)

2093

2884

else:

2094

2885

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

2095

initlogger(level)

2886

initlogger(debug, level)

2096

2887

2097

2888

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

2098

syslogger.setFormatter(logging.Formatter

2099

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

2100

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

2101

% server_settings["servicename"]))

2889

syslogger.setFormatter(

2890

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

2891

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

2892

server_settings["servicename"])))

2102

2893

2103

2894

# Parse config file with clients

2104

client_config = configparser.SafeConfigParser(Client.client_defaults)

2895

client_config = configparser.SafeConfigParser(Client

2896

.client_defaults)

2105

2897

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

2106

2898

"clients.conf"))

2107

2899

2108

2900

global mandos_dbus_service

2109

2901

mandos_dbus_service = None

2110

2902

2111

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

2112

server_settings["port"]),

2113

ClientHandler,

2114

interface=(server_settings["interface"]

2115

or None),

2116

use_ipv6=use_ipv6,

2117

gnutls_priority=

2118

server_settings["priority"],

2119

use_dbus=use_dbus)

2120

if not debug:

2121

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

2903

socketfd = None

2904

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

2905

socketfd = server_settings["socket"]

2906

tcp_server = MandosServer(

2907

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

2908

ClientHandler,

2909

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

2910

use_ipv6=use_ipv6,

2911

gnutls_priority=server_settings["priority"],

2912

use_dbus=use_dbus,

2913

socketfd=socketfd)

2914

if not foreground:

2915

pidfilename = "/run/mandos.pid"

2916

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

2917

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

2918

pidfile = None

2122

2919

try:

2123

pidfile = open(pidfilename, "w")

2124

except IOError:

2125

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

2920

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

2921

except IOError as e:

2922

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

2923

exc_info=e)

2126

2924

2127

try:

2128

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

2129

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

2130

except KeyError:

2925

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

2926

("mandos", "mandos"),

2927

("nobody", "nogroup")):

2131

2928

try:

2132

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

2133

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

2929

uid = pwd.getpwnam(name).pw_uid

2930

gid = pwd.getpwnam(group).pw_gid

2931

break

2134

2932

except KeyError:

2135

try:

2136

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

2137

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

2138

except KeyError:

2139

uid = 65534

2140

gid = 65534

2933

continue

2934

else:

2935

uid = 65534

2936

gid = 65534

2141

2937

try:

2142

2938

os.setgid(gid)

2143

2939

os.setuid(uid)

2144

2940

except OSError as error:

2145

if error[0] != errno.EPERM:

2146

raise error

2941

if error.errno != errno.EPERM:

2942

raise

2147

2943

2148

2944

if debug:

2149

2945

# Enable all possible GnuTLS debugging

2150

2946

2151

2947

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

2152

2948

# - GnuTLS manual

2153

gnutls.library.functions.gnutls_global_set_log_level(11)

2949

gnutls.global_set_log_level(11)

2154

2950

2155

@gnutls.library.types.gnutls_log_func

2951

@gnutls.log_func

2156

2952

def debug_gnutls(level, string):

2157

2953

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

2158

2954

2159

(gnutls.library.functions

2160

.gnutls_global_set_log_function(debug_gnutls))

2955

gnutls.global_set_log_function(debug_gnutls)

2161

2956

2162

2957

# Redirect stdin so all checkers get /dev/null

2163

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

2958

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

2164

2959

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

2165

2960

if null > 2:

2166

2961

os.close(null)

2167

else:

2168

# No console logging

2169

logger.removeHandler(console)

2170

2962

2171

2963

# Need to fork before connecting to D-Bus

2172

if not debug:

2964

if not foreground:

2173

2965

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

2174

2966

daemon()

2175

2967

2968

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

2969

# need to inform GObject that threads will be used.

2970

GObject.threads_init()

2971

2176

2972

global main_loop

2177

2973

# From the Avahi example code

2178

DBusGMainLoop(set_as_default=True )

2179

main_loop = gobject.MainLoop()

2974

DBusGMainLoop(set_as_default=True)

2975

main_loop = GObject.MainLoop()

2180

2976

bus = dbus.SystemBus()

2181

2977

# End of Avahi example code

2182

2978

if use_dbus:

2183

2979

try:

2184

2980

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

2185

bus, do_not_queue=True)

2186

old_bus_name = (dbus.service.BusName

2187

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

2188

do_not_queue=True))

2189

except dbus.exceptions.NameExistsException as e:

2190

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

2981

bus,

2982

do_not_queue=True)

2983

old_bus_name = dbus.service.BusName(

2984

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

2985

do_not_queue=True)

2986

except dbus.exceptions.DBusException as e:

2987

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

2191

2988

use_dbus = False

2192

2989

server_settings["use_dbus"] = False

2193

2990

tcp_server.use_dbus = False

2194

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2195

service = AvahiServiceToSyslog(name =

2196

server_settings["servicename"],

2197

servicetype = "_mandos._tcp",

2198

protocol = protocol, bus = bus)

2199

if server_settings["interface"]:

2200

service.interface = (if_nametoindex

2201

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

2991

if zeroconf:

2992

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2993

service = AvahiServiceToSyslog(

2994

name = server_settings["servicename"],

2995

servicetype = "_mandos._tcp",

2996

protocol = protocol,

2997

bus = bus)

2998

if server_settings["interface"]:

2999

service.interface = if_nametoindex(

3000

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

2202

3001

2203

3002

global multiprocessing_manager

2204

3003

multiprocessing_manager = multiprocessing.Manager()

2205

3004

2206

3005

client_class = Client

2207

3006

if use_dbus:

2208

client_class = functools.partial(ClientDBusTransitional,

2209

bus = bus)

3007

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

2210

3008

2211

3009

client_settings = Client.config_parser(client_config)

2212

3010

old_client_settings = {}

2213

clients_data = []

3011

clients_data = {}

3012

3013

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

3014

global wnull

3015

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

3016

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

3017

# mode

3018

if debug or not foreground:

3019

wnull.close()

2214

3020

2215

3021

# Get client data and settings from last running state.

2216

3022

if server_settings["restore"]:

2217

3023

try:

2218

3024

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

2219

clients_data, old_client_settings = (pickle.load

2220

(stored_state))

3025

clients_data, old_client_settings = pickle.load(

3026

stored_state)

2221

3027

os.remove(stored_state_path)

2222

3028

except IOError as e:

2223

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

2224

.format(e))

2225

if e.errno != errno.ENOENT:

3029

if e.errno == errno.ENOENT:

3030

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

3031

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

3032

else:

3033

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

3034

exc_info=e)

2226

3035

raise

3036

except EOFError as e:

3037

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

3038

"EOFError:",

3039

exc_info=e)

2227

3040

2228

3041

with PGPEngine() as pgp:

2229

for client in clients_data:

2230

client_name = client["name"]

3042

for client_name, client in clients_data.items():

3043

# Skip removed clients

3044

if client_name not in client_settings:

3045

continue

2231

3046

2232

3047

# Decide which value to use after restoring saved state.

2233

3048

# We have three different values: Old config file,

2239

3054

# For each value in new config, check if it

2240

3055

# differs from the old config value (Except for

2241

3056

# the "secret" attribute)

2242

if (name != "secret" and

2243

value != old_client_settings[client_name]

2244

[name]):

3057

if (name != "secret"

3058

and (value !=

3059

old_client_settings[client_name][name])):

2245

3060

client[name] = value

2246

3061

except KeyError:

2247

3062

pass

2248

3063

2249

3064

# Clients who has passed its expire date can still be

2250

# enabled if its last checker was successful. Clients

2251

# whose checker failed before we stored its state is

2252

# assumed to have failed all checkers during downtime.

3065

# enabled if its last checker was successful. A Client

3066

# whose checker succeeded before we stored its state is

3067

# assumed to have successfully run all checkers during

3068

# downtime.

2253

3069

if client["enabled"]:

2254

3070

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

2255

3071

if not client["last_checked_ok"]:

2256

3072

logger.warning(

2257

"disabling client {0} - Client never "

2258

"performed a successfull checker"

2259

.format(client["name"]))

3073

"disabling client {} - Client never "

3074

"performed a successful checker".format(

3075

client_name))

2260

3076

client["enabled"] = False

2261

3077

elif client["last_checker_status"] != 0:

2262

3078

logger.warning(

2263

"disabling client {0} - Client "

2264

"last checker failed with error code {1}"

2265

.format(client["name"],

2266

client["last_checker_status"]))

3079

"disabling client {} - Client last"

3080

" checker failed with error code"

3081

" {}".format(

3082

client_name,

3083

client["last_checker_status"]))

2267

3084

client["enabled"] = False

2268

3085

else:

2269

client["expires"] = (datetime.datetime

2270

.utcnow()

2271

+ client["timeout"])

2272

2273

client["changedstate"] = (multiprocessing_manager

2274

.Condition

2275

(multiprocessing_manager

2276

.Lock()))

2277

client["checker"] = None

2278

if use_dbus:

2279

new_client = (ClientDBusTransitional.__new__

2280

(ClientDBusTransitional))

2281

tcp_server.clients[client_name] = new_client

2282

new_client.bus = bus

2283

for name, value in client.iteritems():

2284

setattr(new_client, name, value)

2285

client_object_name = unicode(client_name).translate(

2286

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

2287

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

2288

new_client.dbus_object_path = (dbus.ObjectPath

2289

("/clients/"

2290

+ client_object_name))

2291

DBusObjectWithProperties.__init__(new_client,

2292

new_client.bus,

2293

new_client

2294

.dbus_object_path)

2295

else:

2296

tcp_server.clients[client_name] = (Client.__new__

2297

(Client))

2298

for name, value in client.iteritems():

2299

setattr(tcp_server.clients[client_name],

2300

name, value)

2301

3086

client["expires"] = (

3087

datetime.datetime.utcnow()

3088

+ client["timeout"])

3089

logger.debug("Last checker succeeded,"

3090

" keeping {} enabled".format(

3091

client_name))

2302

3092

try:

2303

tcp_server.clients[client_name].secret = (

2304

pgp.decrypt(tcp_server.clients[client_name]

2305

.encrypted_secret,

2306

client_settings[client_name]

2307

["secret"]))

3093

client["secret"] = pgp.decrypt(

3094

client["encrypted_secret"],

3095

client_settings[client_name]["secret"])

2308

3096

except PGPError:

2309

3097

# If decryption fails, we use secret from new settings

2310

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

2311

.format(client_name))

2312

tcp_server.clients[client_name].secret = (

2313

client_settings[client_name]["secret"])

2314

2315

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

2316

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

2317

del tcp_server.clients[clientname]

2318

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

2319

tcp_server.clients[clientname] = (client_class(name = clientname,

2320

config =

2321

client_settings

2322

[clientname]))

3098

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

3099

client_name))

3100

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

3101

["secret"])

3102

3103

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

3104

for client_name in (set(old_client_settings)

3105

- set(client_settings)):

3106

del clients_data[client_name]

3107

for client_name in (set(client_settings)

3108

- set(old_client_settings)):

3109

clients_data[client_name] = client_settings[client_name]

3110

3111

# Create all client objects

3112

for client_name, client in clients_data.items():

3113

tcp_server.clients[client_name] = client_class(

3114

name = client_name,

3115

settings = client,

3116

server_settings = server_settings)

2323

3117

2324

3118

if not tcp_server.clients:

2325

3119

logger.warning("No clients defined")

2326

2327

if not debug:

2328

try:

2329

with pidfile:

2330

pid = os.getpid()

2331

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

2332

del pidfile

2333

except IOError:

2334

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

2335

pidfilename, pid)

2336

except NameError:

2337

# "pidfile" was never created

2338

pass

3120

3121

if not foreground:

3122

if pidfile is not None:

3123

pid = os.getpid()

3124

try:

3125

with pidfile:

3126

print(pid, file=pidfile)

3127

except IOError:

3128

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

3129

pidfilename, pid)

3130

del pidfile

2339

3131

del pidfilename

2340

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

2341

3132

2342

3133

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

2343

3134

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

2344

3135

2345

3136

if use_dbus:

2346

class MandosDBusService(dbus.service.Object):

3137

3138

@alternate_dbus_interfaces(

3139

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

3140

class MandosDBusService(DBusObjectWithObjectManager):

2347

3141

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

3142

2348

3143

def __init__(self):

2349

3144

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

3145

2350

3146

_interface = "se.recompile.Mandos"

2351

3147

2352

3148

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

2359

3155

"D-Bus signal"

2360

3156

pass

2361

3157

3158

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

3159

"true"})

2362

3160

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

2363

3161

def ClientRemoved(self, objpath, name):

2364

3162

"D-Bus signal"

2365

3163

pass

2366

3164

3165

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

3166

"true"})

2367

3167

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

2368

3168

def GetAllClients(self):

2369

3169

"D-Bus method"

2370

return dbus.Array(c.dbus_object_path

2371

for c in

3170

return dbus.Array(c.dbus_object_path for c in

2372

3171

tcp_server.clients.itervalues())

2373

3172

3173

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

3174

"true"})

2374

3175

@dbus.service.method(_interface,

2375

3176

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

2376

3177

def GetAllClientsWithProperties(self):

2377

3178

"D-Bus method"

2378

3179

return dbus.Dictionary(

2379

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

2380

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

3180

{ c.dbus_object_path: c.GetAll(

3181

"se.recompile.Mandos.Client")

3182

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

2381

3183

signature="oa{sv}")

2382

3184

2383

3185

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

2387

3189

if c.dbus_object_path == object_path:

2388

3190

del tcp_server.clients[c.name]

2389

3191

c.remove_from_connection()

2390

# Don't signal anything except ClientRemoved

3192

# Don't signal the disabling

2391

3193

c.disable(quiet=True)

2392

# Emit D-Bus signal

2393

self.ClientRemoved(object_path, c.name)

3194

# Emit D-Bus signal for removal

3195

self.client_removed_signal(c)

2394

3196

return

2395

3197

raise KeyError(object_path)

2396

3198

2397

3199

del _interface

3200

3201

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3202

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

3203

def GetManagedObjects(self):

3204

"""D-Bus method"""

3205

return dbus.Dictionary(

3206

{ client.dbus_object_path:

3207

dbus.Dictionary(

3208

{ interface: client.GetAll(interface)

3209

for interface in

3210

client._get_all_interface_names()})

3211

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

3212

3213

def client_added_signal(self, client):

3214

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

3215

if use_dbus:

3216

# New standard signal

3217

self.InterfacesAdded(

3218

client.dbus_object_path,

3219

dbus.Dictionary(

3220

{ interface: client.GetAll(interface)

3221

for interface in

3222

client._get_all_interface_names()}))

3223

# Old signal

3224

self.ClientAdded(client.dbus_object_path)

3225

3226

def client_removed_signal(self, client):

3227

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

3228

if use_dbus:

3229

# New standard signal

3230

self.InterfacesRemoved(

3231

client.dbus_object_path,

3232

client._get_all_interface_names())

3233

# Old signal

3234

self.ClientRemoved(client.dbus_object_path,

3235

client.name)

2398

3236

2399

class MandosDBusServiceTransitional(MandosDBusService):

2400

__metaclass__ = AlternateDBusNamesMetaclass

2401

mandos_dbus_service = MandosDBusServiceTransitional()

3237

mandos_dbus_service = MandosDBusService()

2402

3238

2403

3239

def cleanup():

2404

3240

"Cleanup function; run on exit"

2405

service.cleanup()

3241

if zeroconf:

3242

service.cleanup()

2406

3243

2407

3244

multiprocessing.active_children()

3245

wnull.close()

2408

3246

if not (tcp_server.clients or client_settings):

2409

3247

return

2410

3248

2411

3249

# Store client before exiting. Secrets are encrypted with key

2412

3250

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

2413

3251

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

2414

clients = []

3252

clients = {}

2415

3253

with PGPEngine() as pgp:

2416

3254

for client in tcp_server.clients.itervalues():

2417

3255

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

2419

3257

key)

2420

3258

client_dict = {}

2421

3259

2422

# A list of attributes that will not be stored when

2423

# shutting down.

2424

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

2425

"checker"))

2426

for name, typ in (inspect.getmembers

2427

(dbus.service.Object)):

3260

# A list of attributes that can not be pickled

3261

# + secret.

3262

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

3263

"checker", "server_settings" }

3264

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

3265

.Object):

2428

3266

exclude.add(name)

2429

3267

2430

3268

client_dict["encrypted_secret"] = (client

2433

3271

if attr not in exclude:

2434

3272

client_dict[attr] = getattr(client, attr)

2435

3273

2436

clients.append(client_dict)

3274

clients[client.name] = client_dict

2437

3275

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

2438

3276

2439

3277

try:

2440

with os.fdopen(os.open(stored_state_path,

2441

os.O_CREAT|os.O_WRONLY|os.O_TRUNC,

2442

0600), "wb") as stored_state:

3278

with tempfile.NamedTemporaryFile(

3279

mode='wb',

3280

suffix=".pickle",

3281

prefix='clients-',

3282

dir=os.path.dirname(stored_state_path),

3283

delete=False) as stored_state:

2443

3284

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

3285

tempname = stored_state.name

3286

os.rename(tempname, stored_state_path)

2444

3287

except (IOError, OSError) as e:

2445

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

2446

.format(e))

2447

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

3288

if not debug:

3289

try:

3290

os.remove(tempname)

3291

except NameError:

3292

pass

3293

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

3294

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

3295

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

3296

else:

3297

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

3298

exc_info=e)

2448

3299

raise

2449

3300

2450

3301

# Delete all clients, and settings from config

2452

3303

name, client = tcp_server.clients.popitem()

2453

3304

if use_dbus:

2454

3305

client.remove_from_connection()

2455

# Don't signal anything except ClientRemoved

3306

# Don't signal the disabling

2456

3307

client.disable(quiet=True)

3308

# Emit D-Bus signal for removal

2457

3309

if use_dbus:

2458

# Emit D-Bus signal

2459

mandos_dbus_service.ClientRemoved(client

2460

.dbus_object_path,

2461

client.name)

3310

mandos_dbus_service.client_removed_signal(client)

2462

3311

client_settings.clear()

2463

3312

2464

3313

atexit.register(cleanup)

2465

3314

2466

3315

for client in tcp_server.clients.itervalues():

2467

3316

if use_dbus:

2468

# Emit D-Bus signal

2469

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3317

# Emit D-Bus signal for adding

3318

mandos_dbus_service.client_added_signal(client)

2470

3319

# Need to initiate checking of clients

2471

3320

if client.enabled:

2472

3321

client.init_checker()

2475

3324

tcp_server.server_activate()

2476

3325

2477

3326

# Find out what port we got

2478

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

3327

if zeroconf:

3328

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

2479

3329

if use_ipv6:

2480

3330

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

2481

" flowinfo %d, scope_id %d"

2482

% tcp_server.socket.getsockname())

3331

" flowinfo %d, scope_id %d",

3332

*tcp_server.socket.getsockname())

2483

3333

else: # IPv4

2484

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

2485

% tcp_server.socket.getsockname())

3334

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

3335

*tcp_server.socket.getsockname())

2486

3336

2487

3337

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

2488

3338

2489

3339

try:

2490

# From the Avahi example code

2491

try:

2492

service.activate()

2493

except dbus.exceptions.DBusException as error:

2494

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

2495

cleanup()

2496

sys.exit(1)

2497

# End of Avahi example code

3340

if zeroconf:

3341

# From the Avahi example code

3342

try:

3343

service.activate()

3344

except dbus.exceptions.DBusException as error:

3345

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

3346

cleanup()

3347

sys.exit(1)

3348

# End of Avahi example code

2498

3349

2499

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

3350

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

2500

3351

lambda *args, **kwargs:

2501

3352

(tcp_server.handle_request

2502

3353

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

2504

3355

logger.debug("Starting main loop")

2505

3356

main_loop.run()

2506

3357

except AvahiError as error:

2507

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

3358

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

2508

3359

cleanup()

2509

3360

sys.exit(1)

2510

3361

except KeyboardInterrupt:

2515

3366

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

2516

3367

cleanup()

2517

3368

3369

2518

3370

if __name__ == '__main__':

2519

3371

main()