/mandos/release : revision 237.7.281

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

3

#

4

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

5

#

5

#

6

# This program is partly derived from an example program for an Avahi

7

# service publisher, downloaded from

8

# <http://avahi.org/wiki/PythonPublishExample>. This includes the

9

# methods "add", "remove", "server_state_changed",

10

# "entry_group_state_changed", "cleanup", and "activate" in the

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

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

19

# the Free Software Foundation, either version 3 of the License, or

23

# but WITHOUT ANY WARRANTY; without even the implied warranty of

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

# GNU General Public License for more details.

26

#

26

#

27

# You should have received a copy of the GNU General Public License

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

30

#

31

# Contact the authors at <mandos@recompile.se>.

32

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

39

import SocketServer as socketserver

46

40

import socket

47

41

import argparse

48

42

import datetime

49

43

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

54

51

import sys

55

52

import re

56

53

import os

65

62

import struct

66

63

import fcntl

67

64

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

65

import cPickle as pickle

72

66

import multiprocessing

73

67

import types

74

68

import binascii

75

69

import tempfile

76

70

import itertools

77

71

import collections

78

import codecs

79

72

80

73

import dbus

81

74

import dbus.service

82

from gi.repository import GLib

75

import gobject

76

import avahi

83

77

from dbus.mainloop.glib import DBusGMainLoop

84

78

import ctypes

85

79

import ctypes.util

86

80

import xml.dom.minidom

87

81

import inspect

88

82

89

# Try to find the value of SO_BINDTODEVICE:

90

83

try:

91

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

92

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

93

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

85

except AttributeError:

95

86

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

87

from IN import SO_BINDTODEVICE

99

88

except ImportError:

100

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

101

# Try running the C preprocessor:

102

try:

103

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

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

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

109

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

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

89

SO_BINDTODEVICE = None

113

90

114

91

if sys.version_info.major == 2:

115

92

str = unicode

116

93

117

version = "1.7.15"

94

version = "1.6.8"

118

95

stored_state_file = "clients.pickle"

119

96

120

97

logger = logging.getLogger()

121

98

syslogger = None

122

99

123

100

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

126

104

except (OSError, AttributeError):

127

128

105

def if_nametoindex(interface):

129

106

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

130

107

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

135

112

return interface_index

136

113

137

114

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

154

115

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

155

116

"""init logger and add loglevel"""

156

117

157

118

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

160

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

161

123

syslogger.setFormatter(logging.Formatter

162

124

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

163

125

' %(message)s'))

164

126

logger.addHandler(syslogger)

165

127

166

128

if debug:

167

129

console = logging.StreamHandler()

168

130

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

180

142

181

143

class PGPEngine(object):

182

144

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

183

184

145

def __init__(self):

185

146

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

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

147

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

148

'--home', self.tempdir,

199

149

'--force-mdc',

200

'--quiet']

201

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

202

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

203

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

204

150

'--quiet',

151

'--no-use-agent']

152

205

153

def __enter__(self):

206

154

return self

207

155

208

156

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

209

157

self._cleanup()

210

158

return False

211

159

212

160

def __del__(self):

213

161

self._cleanup()

214

162

215

163

def _cleanup(self):

216

164

if self.tempdir is not None:

217

165

# Delete contents of tempdir

218

166

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

219

topdown=False):

167

topdown = False):

220

168

for filename in files:

221

169

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

222

170

for dirname in dirs:

224

172

# Remove tempdir

225

173

os.rmdir(self.tempdir)

226

174

self.tempdir = None

227

175

228

176

def password_encode(self, password):

229

177

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

230

178

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

235

183

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

236

184

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

237

185

return encoded

238

186

239

187

def encrypt(self, data, password):

240

188

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

243

191

passfile.write(passphrase)

244

192

passfile.flush()

245

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

193

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

246

194

'--passphrase-file',

247

195

passfile.name]

248

196

+ self.gnupgargs,

249

stdin=subprocess.PIPE,

250

stdout=subprocess.PIPE,

251

stderr=subprocess.PIPE)

252

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

253

201

if proc.returncode != 0:

254

202

raise PGPError(err)

255

203

return ciphertext

256

204

257

205

def decrypt(self, data, password):

258

206

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

261

209

passfile.write(passphrase)

262

210

passfile.flush()

263

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

211

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

264

212

'--passphrase-file',

265

213

passfile.name]

266

214

+ self.gnupgargs,

267

stdin=subprocess.PIPE,

268

stdout=subprocess.PIPE,

269

stderr=subprocess.PIPE)

270

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

271

220

if proc.returncode != 0:

272

221

raise PGPError(err)

273

222

return decrypted_plaintext

274

223

275

224

276

# Pretend that we have an Avahi module

277

class Avahi(object):

278

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

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

def string_array_to_txt_array(self, t):

290

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

291

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

292

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

293

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

294

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

295

SERVER_INVALID = 0 # avahi-common/defs.h

296

SERVER_REGISTERING = 1 # avahi-common/defs.h

297

SERVER_RUNNING = 2 # avahi-common/defs.h

298

SERVER_COLLISION = 3 # avahi-common/defs.h

299

SERVER_FAILURE = 4 # avahi-common/defs.h

300

avahi = Avahi()

301

302

303

225

class AvahiError(Exception):

304

226

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

305

227

self.value = value

306

228

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

307

229

**kwargs)

308

230

309

310

231

class AvahiServiceError(AvahiError):

311

232

pass

312

233

313

314

234

class AvahiGroupError(AvahiError):

315

235

pass

316

236

317

237

318

238

class AvahiService(object):

319

239

"""An Avahi (Zeroconf) service.

320

240

321

241

Attributes:

322

242

interface: integer; avahi.IF_UNSPEC or an interface index.

323

243

Used to optionally bind to the specified interface.

335

255

server: D-Bus Server

336

256

bus: dbus.SystemBus()

337

257

"""

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

350

263

self.interface = interface

351

264

self.name = name

352

265

self.type = servicetype

361

274

self.server = None

362

275

self.bus = bus

363

276

self.entry_group_state_changed_match = None

364

365

def rename(self, remove=True):

277

278

def rename(self):

366

279

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

367

280

if self.rename_count >= self.max_renames:

368

281

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

369

282

" after %i retries, exiting.",

370

283

self.rename_count)

371

284

raise AvahiServiceError("Too many renames")

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

375

287

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

376

288

self.name)

377

if remove:

378

self.remove()

289

self.remove()

379

290

try:

380

291

self.add()

381

292

except dbus.exceptions.DBusException as error:

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

391

298

def remove(self):

392

299

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

393

300

if self.entry_group_state_changed_match is not None:

395

302

self.entry_group_state_changed_match = None

396

303

if self.group is not None:

397

304

self.group.Reset()

398

305

399

306

def add(self):

400

307

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

401

308

self.remove()

418

325

dbus.UInt16(self.port),

419

326

avahi.string_array_to_txt_array(self.TXT))

420

327

self.group.Commit()

421

328

422

329

def entry_group_state_changed(self, state, error):

423

330

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

424

331

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

425

332

426

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

334

logger.debug("Zeroconf service established.")

428

335

elif state == avahi.ENTRY_GROUP_COLLISION:

431

338

elif state == avahi.ENTRY_GROUP_FAILURE:

432

339

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

433

340

str(error))

434

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

435

341

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

342

.format(error))

343

436

344

def cleanup(self):

437

345

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

438

346

if self.group is not None:

443

351

pass

444

352

self.group = None

445

353

self.remove()

446

354

447

355

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

448

356

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

449

357

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

456

365

if state in bad_states:

457

366

if bad_states[state] is not None:

458

367

if error is None:

461

370

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

462

371

self.cleanup()

463

372

elif state == avahi.SERVER_RUNNING:

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

373

self.add()

476

374

else:

477

375

if error is None:

478

376

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

479

377

else:

480

378

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

481

379

482

380

def activate(self):

483

381

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

484

382

if self.server is None:

488

386

follow_name_owner_changes=True),

489

387

avahi.DBUS_INTERFACE_SERVER)

490

388

self.server.connect_to_signal("StateChanged",

491

self.server_state_changed)

389

self.server_state_changed)

492

390

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

493

391

494

392

495

393

class AvahiServiceToSyslog(AvahiService):

496

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

394

def rename(self):

497

395

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

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

502

401

return ret

503

402

504

403

505

# Pretend that we have a GnuTLS module

506

class GnuTLS(object):

507

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

508

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

509

510

library = ctypes.util.find_library("gnutls")

511

if library is None:

512

library = ctypes.util.find_library("gnutls-deb0")

513

_library = ctypes.cdll.LoadLibrary(library)

514

del library

515

_need_version = b"3.3.0"

516

517

def __init__(self):

518

# Need to use "self" here, since this method is called before

519

# the assignment to the "gnutls" global variable happens.

520

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

521

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

522

.format(self._need_version))

523

524

# Unless otherwise indicated, the constants and types below are

525

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

526

527

# Constants

528

E_SUCCESS = 0

529

E_INTERRUPTED = -52

530

E_AGAIN = -28

531

CRT_OPENPGP = 2

532

CLIENT = 2

533

SHUT_RDWR = 0

534

CRD_CERTIFICATE = 1

535

E_NO_CERTIFICATE_FOUND = -49

536

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

537

538

# Types

539

class session_int(ctypes.Structure):

540

_fields_ = []

541

session_t = ctypes.POINTER(session_int)

542

543

class certificate_credentials_st(ctypes.Structure):

544

_fields_ = []

545

certificate_credentials_t = ctypes.POINTER(

546

certificate_credentials_st)

547

certificate_type_t = ctypes.c_int

548

549

class datum_t(ctypes.Structure):

550

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

551

('size', ctypes.c_uint)]

552

553

class openpgp_crt_int(ctypes.Structure):

554

_fields_ = []

555

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

556

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

557

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

558

credentials_type_t = ctypes.c_int

559

transport_ptr_t = ctypes.c_void_p

560

close_request_t = ctypes.c_int

561

562

# Exceptions

563

class Error(Exception):

564

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

565

# exception might be raised from within GnuTLS.__init__,

566

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

567

# global variable has happened.

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = GnuTLS.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials(object):

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession(object):

593

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

594

self._c_object = gnutls.session_t()

595

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

596

gnutls.set_default_priority(self._c_object)

597

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

598

gnutls.handshake_set_private_extensions(self._c_object,

599

True)

600

self.socket = socket

601

if credentials is None:

602

credentials = gnutls.Credentials()

603

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

604

ctypes.cast(credentials._c_object,

605

ctypes.c_void_p))

606

self.credentials = credentials

607

608

def __del__(self):

609

gnutls.deinit(self._c_object)

610

611

def handshake(self):

612

return gnutls.handshake(self._c_object)

613

614

def send(self, data):

615

data = bytes(data)

616

data_len = len(data)

617

while data_len > 0:

618

data_len -= gnutls.record_send(self._c_object,

619

data[-data_len:],

620

data_len)

621

622

def bye(self):

623

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

624

625

# Error handling functions

626

def _error_code(result):

627

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

628

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

629

if result >= 0:

630

return result

631

if result == gnutls.E_NO_CERTIFICATE_FOUND:

632

raise gnutls.CertificateSecurityError(code=result)

633

raise gnutls.Error(code=result)

634

635

def _retry_on_error(result, func, arguments):

636

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

637

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

638

while result < 0:

639

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

640

return _error_code(result)

641

result = func(*arguments)

642

return result

643

644

# Unless otherwise indicated, the function declarations below are

645

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

646

647

# Functions

648

priority_set_direct = _library.gnutls_priority_set_direct

649

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

650

ctypes.POINTER(ctypes.c_char_p)]

651

priority_set_direct.restype = _error_code

652

653

init = _library.gnutls_init

654

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

655

init.restype = _error_code

656

657

set_default_priority = _library.gnutls_set_default_priority

658

set_default_priority.argtypes = [session_t]

659

set_default_priority.restype = _error_code

660

661

record_send = _library.gnutls_record_send

662

record_send.argtypes = [session_t, ctypes.c_void_p,

663

ctypes.c_size_t]

664

record_send.restype = ctypes.c_ssize_t

665

record_send.errcheck = _retry_on_error

666

667

certificate_allocate_credentials = (

668

_library.gnutls_certificate_allocate_credentials)

669

certificate_allocate_credentials.argtypes = [

670

ctypes.POINTER(certificate_credentials_t)]

671

certificate_allocate_credentials.restype = _error_code

672

673

certificate_free_credentials = (

674

_library.gnutls_certificate_free_credentials)

675

certificate_free_credentials.argtypes = [

676

certificate_credentials_t]

677

certificate_free_credentials.restype = None

678

679

handshake_set_private_extensions = (

680

_library.gnutls_handshake_set_private_extensions)

681

handshake_set_private_extensions.argtypes = [session_t,

682

ctypes.c_int]

683

handshake_set_private_extensions.restype = None

684

685

credentials_set = _library.gnutls_credentials_set

686

credentials_set.argtypes = [session_t, credentials_type_t,

687

ctypes.c_void_p]

688

credentials_set.restype = _error_code

689

690

strerror = _library.gnutls_strerror

691

strerror.argtypes = [ctypes.c_int]

692

strerror.restype = ctypes.c_char_p

693

694

certificate_type_get = _library.gnutls_certificate_type_get

695

certificate_type_get.argtypes = [session_t]

696

certificate_type_get.restype = _error_code

697

698

certificate_get_peers = _library.gnutls_certificate_get_peers

699

certificate_get_peers.argtypes = [session_t,

700

ctypes.POINTER(ctypes.c_uint)]

701

certificate_get_peers.restype = ctypes.POINTER(datum_t)

702

703

global_set_log_level = _library.gnutls_global_set_log_level

704

global_set_log_level.argtypes = [ctypes.c_int]

705

global_set_log_level.restype = None

706

707

global_set_log_function = _library.gnutls_global_set_log_function

708

global_set_log_function.argtypes = [log_func]

709

global_set_log_function.restype = None

710

711

deinit = _library.gnutls_deinit

712

deinit.argtypes = [session_t]

713

deinit.restype = None

714

715

handshake = _library.gnutls_handshake

716

handshake.argtypes = [session_t]

717

handshake.restype = _error_code

718

handshake.errcheck = _retry_on_error

719

720

transport_set_ptr = _library.gnutls_transport_set_ptr

721

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

722

transport_set_ptr.restype = None

723

724

bye = _library.gnutls_bye

725

bye.argtypes = [session_t, close_request_t]

726

bye.restype = _error_code

727

bye.errcheck = _retry_on_error

728

729

check_version = _library.gnutls_check_version

730

check_version.argtypes = [ctypes.c_char_p]

731

check_version.restype = ctypes.c_char_p

732

733

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

734

735

openpgp_crt_init = _library.gnutls_openpgp_crt_init

736

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

737

openpgp_crt_init.restype = _error_code

738

739

openpgp_crt_import = _library.gnutls_openpgp_crt_import

740

openpgp_crt_import.argtypes = [openpgp_crt_t,

741

ctypes.POINTER(datum_t),

742

openpgp_crt_fmt_t]

743

openpgp_crt_import.restype = _error_code

744

745

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

746

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

747

ctypes.POINTER(ctypes.c_uint)]

748

openpgp_crt_verify_self.restype = _error_code

749

750

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

751

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

752

openpgp_crt_deinit.restype = None

753

754

openpgp_crt_get_fingerprint = (

755

_library.gnutls_openpgp_crt_get_fingerprint)

756

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

757

ctypes.c_void_p,

758

ctypes.POINTER(

759

ctypes.c_size_t)]

760

openpgp_crt_get_fingerprint.restype = _error_code

761

762

# Remove non-public functions

763

del _error_code, _retry_on_error

764

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

765

gnutls = GnuTLS()

766

767

768

def call_pipe(connection, # : multiprocessing.Connection

769

func, *args, **kwargs):

770

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

771

772

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

773

return value on the provided multiprocessing.Connection.

774

"""

775

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

776

connection.close()

777

778

779

404

class Client(object):

780

405

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

781

406

782

407

Attributes:

783

408

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

784

409

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

786

411

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

787

412

to see if the client lives.

788

413

'None' if no process is running.

789

checker_callback_tag: a GLib event source tag, or None

414

checker_callback_tag: a gobject event source tag, or None

790

415

checker_command: string; External command which is run to check

791

416

if client lives. %() expansions are done at

792

417

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

793

418

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

794

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

795

420

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

796

421

client_structure: Object describing what attributes a client has

797

422

and is used for storing the client at exit

798

423

current_checker_command: string; current running checker_command

799

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

800

425

enabled: bool()

801

426

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

802

427

uniquely identify the client

807

432

last_checker_status: integer between 0 and 255 reflecting exit

808

433

status of last checker. -1 reflects crashed

809

434

checker, -2 means no checker completed yet.

810

last_checker_signal: The signal which killed the last checker, if

811

last_checker_status is -1

812

435

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

813

436

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

814

437

D-Bus identifiers

821

444

disabled, or None

822

445

server_settings: The server_settings dict from main()

823

446

"""

824

447

825

448

runtime_expansions = ("approval_delay", "approval_duration",

826

449

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

827

450

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

828

451

"last_approval_request", "last_checked_ok",

829

452

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

830

client_defaults = {

831

"timeout": "PT5M",

832

"extended_timeout": "PT15M",

833

"interval": "PT2M",

834

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

835

"host": "",

836

"approval_delay": "PT0S",

837

"approval_duration": "PT1S",

838

"approved_by_default": "True",

839

"enabled": "True",

840

}

841

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

463

842

464

@staticmethod

843

465

def config_parser(config):

844

466

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

851

473

for client_name in config.sections():

852

474

section = dict(config.items(client_name))

853

475

client = settings[client_name] = {}

854

476

855

477

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

856

478

# Reformat values from string types to Python types

857

479

client["approved_by_default"] = config.getboolean(

858

480

client_name, "approved_by_default")

859

481

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

860

482

"enabled")

861

862

# Uppercase and remove spaces from fingerprint for later

863

# comparison purposes with return value from the

864

# fingerprint() function

483

865

484

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

866

485

.replace(" ", ""))

867

486

if "secret" in section:

868

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

869

.encode("utf-8"),

870

"base64")

487

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

871

488

elif "secfile" in section:

872

489

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

873

490

(section["secfile"])),

888

505

client["last_approval_request"] = None

889

506

client["last_checked_ok"] = None

890

507

client["last_checker_status"] = -2

891

508

892

509

return settings

893

894

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

510

511

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

895

512

self.name = name

896

513

if server_settings is None:

897

514

server_settings = {}

899

516

# adding all client settings

900

517

for setting, value in settings.items():

901

518

setattr(self, setting, value)

902

519

903

520

if self.enabled:

904

521

if not hasattr(self, "last_enabled"):

905

522

self.last_enabled = datetime.datetime.utcnow()

909

526

else:

910

527

self.last_enabled = None

911

528

self.expires = None

912

529

913

530

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

914

534

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

915

535

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

916

536

datetime.datetime.utcnow())

917

537

918

538

# attributes specific for this server instance

919

539

self.checker = None

920

540

self.checker_initiator_tag = None

923

543

self.current_checker_command = None

924

544

self.approved = None

925

545

self.approvals_pending = 0

926

self.changedstate = multiprocessing_manager.Condition(

927

multiprocessing_manager.Lock())

928

self.client_structure = [attr

929

for attr in self.__dict__.keys()

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

930

551

if not attr.startswith("_")]

931

552

self.client_structure.append("client_structure")

932

933

for name, t in inspect.getmembers(

934

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

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

935

558

if not name.startswith("_"):

936

559

self.client_structure.append(name)

937

560

938

561

# Send notice to process children that client state has changed

939

562

def send_changedstate(self):

940

563

with self.changedstate:

941

564

self.changedstate.notify_all()

942

565

943

566

def enable(self):

944

567

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

945

568

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

950

573

self.last_enabled = datetime.datetime.utcnow()

951

574

self.init_checker()

952

575

self.send_changedstate()

953

576

954

577

def disable(self, quiet=True):

955

578

"""Disable this client."""

956

579

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

958

581

if not quiet:

959

582

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

960

583

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

961

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

962

585

self.disable_initiator_tag = None

963

586

self.expires = None

964

587

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

965

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

966

589

self.checker_initiator_tag = None

967

590

self.stop_checker()

968

591

self.enabled = False

969

592

if not quiet:

970

593

self.send_changedstate()

971

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

594

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

972

595

return False

973

596

974

597

def __del__(self):

975

598

self.disable()

976

599

977

600

def init_checker(self):

978

601

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

979

602

# and every interval from then on.

980

603

if self.checker_initiator_tag is not None:

981

GLib.source_remove(self.checker_initiator_tag)

982

self.checker_initiator_tag = GLib.timeout_add(

983

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

984

self.start_checker)

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

self.start_checker))

985

609

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

986

610

if self.disable_initiator_tag is not None:

987

GLib.source_remove(self.disable_initiator_tag)

988

self.disable_initiator_tag = GLib.timeout_add(

989

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

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

990

616

# Also start a new checker *right now*.

991

617

self.start_checker()

992

993

def checker_callback(self, source, condition, connection,

994

command):

618

619

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

995

620

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

996

621

self.checker_callback_tag = None

997

622

self.checker = None

998

# Read return code from connection (see call_pipe)

999

returncode = connection.recv()

1000

connection.close()

1001

1002

if returncode >= 0:

1003

self.last_checker_status = returncode

1004

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1005

625

if self.last_checker_status == 0:

1006

626

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

1007

627

vars(self))

1008

628

self.checked_ok()

1009

629

else:

1010

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

630

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

631

vars(self))

1011

632

else:

1012

633

self.last_checker_status = -1

1013

self.last_checker_signal = -returncode

1014

634

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

1015

635

vars(self))

1016

return False

1017

636

1018

637

def checked_ok(self):

1019

638

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

1020

639

self.last_checked_ok = datetime.datetime.utcnow()

1021

640

self.last_checker_status = 0

1022

self.last_checker_signal = None

1023

641

self.bump_timeout()

1024

642

1025

643

def bump_timeout(self, timeout=None):

1026

644

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

1027

645

if timeout is None:

1028

646

timeout = self.timeout

1029

647

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1031

649

self.disable_initiator_tag = None

1032

650

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

1033

self.disable_initiator_tag = GLib.timeout_add(

1034

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1035

654

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

1036

655

1037

656

def need_approval(self):

1038

657

self.last_approval_request = datetime.datetime.utcnow()

1039

658

1040

659

def start_checker(self):

1041

660

"""Start a new checker subprocess if one is not running.

1042

661

1043

662

If a checker already exists, leave it running and do

1044

663

nothing."""

1045

664

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

1050

669

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

1051

670

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

1052

671

# should be.

1053

1054

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

1055

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

1056

self.checker.join()

1057

self.checker = None

672

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1058

687

# Start a new checker if needed

1059

688

if self.checker is None:

1060

689

# Escape attributes for the shell

1061

escaped_attrs = {

1062

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

1063

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1064

693

try:

1065

694

command = self.checker_command % escaped_attrs

1066

695

except TypeError as error:

1067

696

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

1068

self.checker_command,

697

self.checker_command, exc_info=error)

698

return True # Try again later

699

self.current_checker_command = command

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

# The exception is when not debugging but nevertheless

708

# running in the foreground; use the previously

709

# created wnull.

710

popen_args = {}

711

if (not self.server_settings["debug"]

712

and self.server_settings["foreground"]):

713

popen_args.update({"stdout": wnull,

714

"stderr": wnull })

715

self.checker = subprocess.Popen(command,

716

close_fds=True,

717

shell=True, cwd="/",

718

**popen_args)

719

except OSError as error:

720

logger.error("Failed to start subprocess",

1069

721

exc_info=error)

1070

return True # Try again later

1071

self.current_checker_command = command

1072

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

1073

self.name)

1074

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

1075

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

1076

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

1077

# always replaced by /dev/null.)

1078

# The exception is when not debugging but nevertheless

1079

# running in the foreground; use the previously

1080

# created wnull.

1081

popen_args = {"close_fds": True,

1082

"shell": True,

1083

"cwd": "/"}

1084

if (not self.server_settings["debug"]

1085

and self.server_settings["foreground"]):

1086

popen_args.update({"stdout": wnull,

1087

"stderr": wnull})

1088

pipe = multiprocessing.Pipe(duplex=False)

1089

self.checker = multiprocessing.Process(

1090

target=call_pipe,

1091

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

1092

kwargs=popen_args)

1093

self.checker.start()

1094

self.checker_callback_tag = GLib.io_add_watch(

1095

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

1096

self.checker_callback, pipe[0], command)

1097

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

722

return True

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

try:

730

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

731

except OSError as error:

732

if error.errno == errno.ECHILD:

733

# This should never happen

734

logger.error("Child process vanished",

735

exc_info=error)

736

return True

737

raise

738

if pid:

739

gobject.source_remove(self.checker_callback_tag)

740

self.checker_callback(pid, status, command)

741

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

1098

742

return True

1099

743

1100

744

def stop_checker(self):

1101

745

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

1102

746

if self.checker_callback_tag:

1103

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1104

748

self.checker_callback_tag = None

1105

749

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

1106

750

return

1107

751

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

1108

self.checker.terminate()

752

try:

753

self.checker.terminate()

754

#time.sleep(0.5)

755

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

756

# self.checker.kill()

757

except OSError as error:

758

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

759

raise

1109

760

self.checker = None

1110

761

1111

762

1112

def dbus_service_property(dbus_interface,

1113

signature="v",

1114

access="readwrite",

1115

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1116

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1117

766

become properties on the D-Bus.

1118

767

1119

768

The decorated method will be called with no arguments by "Get"

1120

769

and with one argument by "Set".

1121

770

1122

771

The parameters, where they are supported, are the same as

1123

772

dbus.service.method, except there is only "signature", since the

1124

773

type from Get() and the type sent to Set() is the same.

1128

777

if byte_arrays and signature != "ay":

1129

778

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

1130

779

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

1131

1132

780

def decorator(func):

1133

781

func._dbus_is_property = True

1134

782

func._dbus_interface = dbus_interface

1137

785

func._dbus_name = func.__name__

1138

786

if func._dbus_name.endswith("_dbus_property"):

1139

787

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

1140

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

789

return func

1142

1143

790

return decorator

1144

791

1145

792

1146

793

def dbus_interface_annotations(dbus_interface):

1147

794

"""Decorator for marking functions returning interface annotations

1148

795

1149

796

Usage:

1150

797

1151

798

@dbus_interface_annotations("org.example.Interface")

1152

799

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

1153

800

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

1154

801

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

1155

802

"false"}

1156

803

"""

1157

1158

804

def decorator(func):

1159

805

func._dbus_is_interface = True

1160

806

func._dbus_interface = dbus_interface

1161

807

func._dbus_name = dbus_interface

1162

808

return func

1163

1164

809

return decorator

1165

810

1166

811

1167

812

def dbus_annotations(annotations):

1168

813

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

1169

814

Usage:

1170

815

1171

816

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

1172

817

"org.freedesktop.DBus.Property."

1173

818

"EmitsChangedSignal": "false"})

1175

820

access="r")

1176

821

def Property_dbus_property(self):

1177

822

return dbus.Boolean(False)

1178

1179

See also the DBusObjectWithAnnotations class.

1180

823

"""

1181

1182

824

def decorator(func):

1183

825

func._dbus_annotations = annotations

1184

826

return func

1185

1186

827

return decorator

1187

828

1188

829

1191

832

"""

1192

833

pass

1193

834

1194

1195

835

class DBusPropertyAccessException(DBusPropertyException):

1196

836

"""A property's access permissions disallows an operation.

1197

837

"""

1204

844

pass

1205

845

1206

846

1207

class DBusObjectWithAnnotations(dbus.service.Object):

1208

"""A D-Bus object with annotations.

1209

1210

Classes inheriting from this can use the dbus_annotations

1211

decorator to add annotations to methods or signals.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

decorator to expose methods as D-Bus properties. It exposes the

852

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

1212

853

"""

1213

854

1214

855

@staticmethod

1215

856

def _is_dbus_thing(thing):

1216

857

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

1217

858

1218

859

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

1219

860

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

1220

861

"""

1221

862

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

1222

863

False)

1223

864

1224

865

def _get_all_dbus_things(self, thing):

1225

866

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

1226

867

"""

1227

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

868

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

869

name),

1228

870

athing.__get__(self))

1229

871

for cls in self.__class__.__mro__

1230

872

for name, athing in

1231

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

1232

1233

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1234

out_signature="s",

1235

path_keyword='object_path',

1236

connection_keyword='connection')

1237

def Introspect(self, object_path, connection):

1238

"""Overloading of standard D-Bus method.

1239

1240

Inserts annotation tags on methods and signals.

1241

"""

1242

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

1243

connection)

1244

try:

1245

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

1246

1247

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

1248

# Add annotation tags

1249

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

1250

for tag in if_tag.getElementsByTagName(typ):

1251

annots = dict()

1252

for name, prop in (self.

1253

_get_all_dbus_things(typ)):

1254

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

1255

and prop._dbus_interface

1256

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

1257

annots.update(getattr(

1258

prop, "_dbus_annotations", {}))

1259

for name, value in annots.items():

1260

ann_tag = document.createElement(

1261

"annotation")

1262

ann_tag.setAttribute("name", name)

1263

ann_tag.setAttribute("value", value)

1264

tag.appendChild(ann_tag)

1265

# Add interface annotation tags

1266

for annotation, value in dict(

1267

itertools.chain.from_iterable(

1268

annotations().items()

1269

for name, annotations

1270

in self._get_all_dbus_things("interface")

1271

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

1272

)).items():

1273

ann_tag = document.createElement("annotation")

1274

ann_tag.setAttribute("name", annotation)

1275

ann_tag.setAttribute("value", value)

1276

if_tag.appendChild(ann_tag)

1277

# Fix argument name for the Introspect method itself

1278

if (if_tag.getAttribute("name")

1279

== dbus.INTROSPECTABLE_IFACE):

1280

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

1281

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

1282

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

1283

if (arg.getAttribute("direction")

1284

== "out"):

1285

arg.setAttribute("name",

1286

"xml_data")

1287

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

1288

document.unlink()

1289

except (AttributeError, xml.dom.DOMException,

1290

xml.parsers.expat.ExpatError) as error:

1291

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

1292

exc_info=error)

1293

return xmlstring

1294

1295

1296

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1297

"""A D-Bus object with properties.

1298

1299

Classes inheriting from this can use the dbus_service_property

1300

decorator to expose methods as D-Bus properties. It exposes the

1301

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

1302

"""

1303

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1304

876

def _get_dbus_property(self, interface_name, property_name):

1305

877

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

1306

878

property with the specified name and interface.

1307

879

"""

1308

for cls in self.__class__.__mro__:

1309

for name, value in inspect.getmembers(

1310

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1311

884

if (value._dbus_name == property_name

1312

885

and value._dbus_interface == interface_name):

1313

886

return value.__get__(self)

1314

887

1315

888

# No such property

1316

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

1317

self.dbus_object_path, interface_name, property_name))

1318

1319

@classmethod

1320

def _get_all_interface_names(cls):

1321

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

1322

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

1323

"_dbus_interface", None)

1324

for x in (inspect.getmro(cls))

1325

for attr in dir(x))

1326

if name is not None)

1327

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

in_signature="ss",

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1330

894

out_signature="v")

1331

895

def Get(self, interface_name, property_name):

1332

896

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

1338

902

if not hasattr(value, "variant_level"):

1339

903

return value

1340

904

return type(value)(value, variant_level=value.variant_level+1)

1341

905

1342

906

@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")

1343

907

def Set(self, interface_name, property_name, value):

1344

908

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

1356

920

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

1357

921

for byte in value))

1358

922

prop(value)

1359

1360

@dbus.service.method(dbus.PROPERTIES_IFACE,

1361

in_signature="s",

923

924

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

1362

925

out_signature="a{sv}")

1363

926

def GetAll(self, interface_name):

1364

927

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

1365

928

standard.

1366

929

1367

930

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

1368

931

"""

1369

932

properties = {}

1379

942

if not hasattr(value, "variant_level"):

1380

943

properties[name] = value

1381

944

continue

1382

properties[name] = type(value)(

1383

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1384

947

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

1385

948

1386

949

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

1387

950

def PropertiesChanged(self, interface_name, changed_properties,

1388

951

invalidated_properties):

1390

953

standard.

1391

954

"""

1392

955

pass

1393

956

1394

957

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1395

958

out_signature="s",

1396

959

path_keyword='object_path',

1397

960

connection_keyword='connection')

1398

961

def Introspect(self, object_path, connection):

1399

962

"""Overloading of standard D-Bus method.

1400

963

1401

964

Inserts property tags and interface annotation tags.

1402

965

"""

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

966

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

967

connection)

1406

968

try:

1407

969

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

1408

1409

970

def make_tag(document, name, prop):

1410

971

e = document.createElement("property")

1411

972

e.setAttribute("name", name)

1412

973

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

1413

974

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

1414

975

return e

1415

1416

976

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

1417

977

# Add property tags

1418

978

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

1421

981

if prop._dbus_interface

1422

982

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

1423

983

if_tag.appendChild(tag)

1424

# Add annotation tags for properties

1425

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

1426

annots = dict()

1427

for name, prop in self._get_all_dbus_things(

1428

"property"):

1429

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

1430

and prop._dbus_interface

1431

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

1432

annots.update(getattr(

1433

prop, "_dbus_annotations", {}))

1434

for name, value in annots.items():

1435

ann_tag = document.createElement(

1436

"annotation")

1437

ann_tag.setAttribute("name", name)

1438

ann_tag.setAttribute("value", value)

1439

tag.appendChild(ann_tag)

984

# Add annotation tags

985

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

986

for tag in if_tag.getElementsByTagName(typ):

987

annots = dict()

988

for name, prop in (self.

989

_get_all_dbus_things(typ)):

990

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

991

and prop._dbus_interface

992

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

993

annots.update(getattr

994

(prop,

995

"_dbus_annotations",

996

{}))

997

for name, value in annots.items():

998

ann_tag = document.createElement(

999

"annotation")

1000

ann_tag.setAttribute("name", name)

1001

ann_tag.setAttribute("value", value)

1002

tag.appendChild(ann_tag)

1003

# Add interface annotation tags

1004

for annotation, value in dict(

1005

itertools.chain.from_iterable(

1006

annotations().items()

1007

for name, annotations in

1008

self._get_all_dbus_things("interface")

1009

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

1010

)).items():

1011

ann_tag = document.createElement("annotation")

1012

ann_tag.setAttribute("name", annotation)

1013

ann_tag.setAttribute("value", value)

1014

if_tag.appendChild(ann_tag)

1440

1015

# Add the names to the return values for the

1441

1016

# "org.freedesktop.DBus.Properties" methods

1442

1017

if (if_tag.getAttribute("name")

1461

1036

return xmlstring

1462

1037

1463

1038

1464

try:

1465

dbus.OBJECT_MANAGER_IFACE

1466

except AttributeError:

1467

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

1468

1469

1470

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1471

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

1472

1473

Classes inheriting from this exposes the standard

1474

GetManagedObjects call and the InterfacesAdded and

1475

InterfacesRemoved signals on the standard

1476

"org.freedesktop.DBus.ObjectManager" interface.

1477

1478

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

1479

manually.

1480

"""

1481

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1482

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

1483

def GetManagedObjects(self):

1484

"""This function must be overridden"""

1485

raise NotImplementedError()

1486

1487

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1488

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

1489

def InterfacesAdded(self, object_path, interfaces_and_properties):

1490

pass

1491

1492

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

1493

def InterfacesRemoved(self, object_path, interfaces):

1494

pass

1495

1496

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1497

out_signature="s",

1498

path_keyword='object_path',

1499

connection_keyword='connection')

1500

def Introspect(self, object_path, connection):

1501

"""Overloading of standard D-Bus method.

1502

1503

Override return argument name of GetManagedObjects to be

1504

"objpath_interfaces_and_properties"

1505

"""

1506

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1507

object_path,

1508

connection)

1509

try:

1510

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

1511

1512

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

1513

# Fix argument name for the GetManagedObjects method

1514

if (if_tag.getAttribute("name")

1515

== dbus.OBJECT_MANAGER_IFACE):

1516

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

1517

if (cn.getAttribute("name")

1518

== "GetManagedObjects"):

1519

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

1520

if (arg.getAttribute("direction")

1521

== "out"):

1522

arg.setAttribute(

1523

"name",

1524

"objpath_interfaces"

1525

"_and_properties")

1526

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

1527

document.unlink()

1528

except (AttributeError, xml.dom.DOMException,

1529

xml.parsers.expat.ExpatError) as error:

1530

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

1531

exc_info=error)

1532

return xmlstring

1533

1534

1535

1039

def datetime_to_dbus(dt, variant_level=0):

1536

1040

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

1537

1041

if dt is None:

1538

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

1539

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

1042

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

1043

return dbus.String(dt.isoformat(),

1044

variant_level=variant_level)

1540

1045

1541

1046

1542

1047

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1544

1049

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

1545

1050

interface names according to the "alt_interface_names" mapping.

1546

1051

Usage:

1547

1052

1548

1053

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

1549

1054

"net.example.AlternateInterface"})

1550

1055

class SampleDBusObject(dbus.service.Object):

1551

1056

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

1552

1057

def SampleDBusMethod():

1553

1058

pass

1554

1059

1555

1060

The above "SampleDBusMethod" on "SampleDBusObject" will be

1556

1061

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

1557

1062

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

1558

1063

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

1559

1064

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

1560

1065

1561

1066

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

1562

1067

(from DBusObjectWithProperties) and interfaces (from the

1563

1068

dbus_interface_annotations decorator).

1564

1069

"""

1565

1566

1070

def wrapper(cls):

1567

1071

for orig_interface_name, alt_interface_name in (

1568

alt_interface_names.items()):

1072

alt_interface_names.items()):

1569

1073

attr = {}

1570

1074

interface_names = set()

1571

1075

# Go though all attributes of the class

1573

1077

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

1574

1078

# with the wrong interface name

1575

1079

if (not hasattr(attribute, "_dbus_interface")

1576

or not attribute._dbus_interface.startswith(

1577

orig_interface_name)):

1080

or not attribute._dbus_interface

1081

.startswith(orig_interface_name)):

1578

1082

continue

1579

1083

# Create an alternate D-Bus interface name based on

1580

1084

# the current name

1581

alt_interface = attribute._dbus_interface.replace(

1582

orig_interface_name, alt_interface_name)

1085

alt_interface = (attribute._dbus_interface

1086

.replace(orig_interface_name,

1087

alt_interface_name))

1583

1088

interface_names.add(alt_interface)

1584

1089

# Is this a D-Bus signal?

1585

1090

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

1586

1091

# Extract the original non-method undecorated

1587

1092

# function by black magic

1588

if sys.version_info.major == 2:

1589

nonmethod_func = (dict(

1093

nonmethod_func = (dict(

1590

1094

zip(attribute.func_code.co_freevars,

1591

attribute.__closure__))

1592

["func"].cell_contents)

1593

else:

1594

nonmethod_func = (dict(

1595

zip(attribute.__code__.co_freevars,

1596

attribute.__closure__))

1597

["func"].cell_contents)

1095

attribute.__closure__))["func"]

1096

.cell_contents)

1598

1097

# Create a new, but exactly alike, function

1599

1098

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

1600

1099

# with the alternate D-Bus interface name

1601

new_function = copy_function(nonmethod_func)

1602

new_function = (dbus.service.signal(

1603

alt_interface,

1604

attribute._dbus_signature)(new_function))

1100

new_function = (dbus.service.signal

1101

(alt_interface,

1102

attribute._dbus_signature)

1103

(types.FunctionType(

1104

nonmethod_func.func_code,

1105

nonmethod_func.func_globals,

1106

nonmethod_func.func_name,

1107

nonmethod_func.func_defaults,

1108

nonmethod_func.func_closure)))

1605

1109

# Copy annotations, if any

1606

1110

try:

1607

new_function._dbus_annotations = dict(

1608

attribute._dbus_annotations)

1111

new_function._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1609

1113

except AttributeError:

1610

1114

pass

1611

1612

1115

# Define a creator of a function to call both the

1613

1116

# original and alternate functions, so both the

1614

1117

# original and alternate signals gets sent when

1617

1120

"""This function is a scope container to pass

1618

1121

func1 and func2 to the "call_both" function

1619

1122

outside of its arguments"""

1620

1621

@functools.wraps(func2)

1622

1123

def call_both(*args, **kwargs):

1623

1124

"""This function will emit two D-Bus

1624

1125

signals by calling func1 and func2"""

1625

1126

func1(*args, **kwargs)

1626

1127

func2(*args, **kwargs)

1627

# Make wrapper function look like a D-Bus

1628

# signal

1629

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

1630

if name.startswith("_dbus_"):

1631

setattr(call_both, name, attr)

1632

1633

1128

return call_both

1634

1129

# Create the "call_both" function and add it to

1635

1130

# the class

1640

1135

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

1641

1136

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

1642

1137

# to the class.

1643

attr[attrname] = (

1644

dbus.service.method(

1645

alt_interface,

1646

attribute._dbus_in_signature,

1647

attribute._dbus_out_signature)

1648

(copy_function(attribute)))

1138

attr[attrname] = (dbus.service.method

1139

(alt_interface,

1140

attribute._dbus_in_signature,

1141

attribute._dbus_out_signature)

1142

(types.FunctionType

1143

(attribute.func_code,

1144

attribute.func_globals,

1145

attribute.func_name,

1146

attribute.func_defaults,

1147

attribute.func_closure)))

1649

1148

# Copy annotations, if any

1650

1149

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1150

attr[attrname]._dbus_annotations = (

1151

dict(attribute._dbus_annotations))

1653

1152

except AttributeError:

1654

1153

pass

1655

1154

# Is this a D-Bus property?

1658

1157

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

1659

1158

# property with the alternate D-Bus interface

1660

1159

# name. Add it to the class.

1661

attr[attrname] = (dbus_service_property(

1662

alt_interface, attribute._dbus_signature,

1663

attribute._dbus_access,

1664

attribute._dbus_get_args_options

1665

["byte_arrays"])

1666

(copy_function(attribute)))

1160

attr[attrname] = (dbus_service_property

1161

(alt_interface,

1162

attribute._dbus_signature,

1163

attribute._dbus_access,

1164

attribute

1165

._dbus_get_args_options

1166

["byte_arrays"])

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1667

1173

# Copy annotations, if any

1668

1174

try:

1669

attr[attrname]._dbus_annotations = dict(

1670

attribute._dbus_annotations)

1175

attr[attrname]._dbus_annotations = (

1176

dict(attribute._dbus_annotations))

1671

1177

except AttributeError:

1672

1178

pass

1673

1179

# Is this a D-Bus interface?

1676

1182

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

1677

1183

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

1678

1184

# to the class.

1679

attr[attrname] = (

1680

dbus_interface_annotations(alt_interface)

1681

(copy_function(attribute)))

1185

attr[attrname] = (dbus_interface_annotations

1186

(alt_interface)

1187

(types.FunctionType

1188

(attribute.func_code,

1189

attribute.func_globals,

1190

attribute.func_name,

1191

attribute.func_defaults,

1192

attribute.func_closure)))

1682

1193

if deprecate:

1683

1194

# Deprecate all alternate interfaces

1684

iname = "_AlternateDBusNames_interface_annotation{}"

1195

iname="_AlternateDBusNames_interface_annotation{}"

1685

1196

for interface_name in interface_names:

1686

1687

1197

@dbus_interface_annotations(interface_name)

1688

1198

def func(self):

1689

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

1690

"true"}

1199

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

1200

"true" }

1691

1201

# Find an unused name

1692

1202

for aname in (iname.format(i)

1693

1203

for i in itertools.count()):

1697

1207

if interface_names:

1698

1208

# Replace the class with a new subclass of it with

1699

1209

# methods, signals, etc. as created above.

1700

if sys.version_info.major == 2:

1701

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

1702

(cls, ), attr)

1703

else:

1704

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

1705

(cls, ), attr)

1210

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

1211

(cls,), attr)

1706

1212

return cls

1707

1708

1213

return wrapper

1709

1214

1710

1215

1711

1216

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

1712

"se.bsnet.fukt.Mandos"})

1217

"se.bsnet.fukt.Mandos"})

1713

1218

class ClientDBus(Client, DBusObjectWithProperties):

1714

1219

"""A Client class using D-Bus

1715

1220

1716

1221

Attributes:

1717

1222

dbus_object_path: dbus.ObjectPath

1718

1223

bus: dbus.SystemBus()

1719

1224

"""

1720

1225

1721

1226

runtime_expansions = (Client.runtime_expansions

1722

+ ("dbus_object_path", ))

1723

1227

+ ("dbus_object_path",))

1228

1724

1229

_interface = "se.recompile.Mandos.Client"

1725

1230

1726

1231

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

1727

1728

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

1232

1233

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

1729

1234

self.bus = bus

1730

1235

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

1731

1236

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

1733

1238

client_object_name = str(self.name).translate(

1734

1239

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

1735

1240

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

1736

self.dbus_object_path = dbus.ObjectPath(

1737

"/clients/" + client_object_name)

1241

self.dbus_object_path = (dbus.ObjectPath

1242

("/clients/" + client_object_name))

1738

1243

DBusObjectWithProperties.__init__(self, self.bus,

1739

1244

self.dbus_object_path)

1740

1741

def notifychangeproperty(transform_func, dbus_name,

1742

type_func=lambda x: x,

1743

variant_level=1,

1744

invalidate_only=False,

1245

1246

def notifychangeproperty(transform_func,

1247

dbus_name, type_func=lambda x: x,

1248

variant_level=1, invalidate_only=False,

1745

1249

_interface=_interface):

1746

1250

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

1747

1251

its changes to DBus.

1748

1252

1749

1253

transform_fun: Function that takes a value and a variant_level

1750

1254

and transforms it to a D-Bus type.

1751

1255

dbus_name: D-Bus name of the variable

1754

1258

variant_level: D-Bus variant level. Default: 1

1755

1259

"""

1756

1260

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

1757

1758

1261

def setter(self, value):

1759

1262

if hasattr(self, "dbus_object_path"):

1760

1263

if (not hasattr(self, attrname) or

1761

1264

type_func(getattr(self, attrname, None))

1762

1265

!= type_func(value)):

1763

1266

if invalidate_only:

1764

self.PropertiesChanged(

1765

_interface, dbus.Dictionary(),

1766

dbus.Array((dbus_name, )))

1267

self.PropertiesChanged(_interface,

1268

dbus.Dictionary(),

1269

dbus.Array

1270

((dbus_name,)))

1767

1271

else:

1768

dbus_value = transform_func(

1769

type_func(value),

1770

variant_level=variant_level)

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1771

1275

self.PropertyChanged(dbus.String(dbus_name),

1772

1276

dbus_value)

1773

self.PropertiesChanged(

1774

_interface,

1775

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

1776

dbus_value}),

1777

dbus.Array())

1277

self.PropertiesChanged(_interface,

1278

dbus.Dictionary({

1279

dbus.String(dbus_name):

1280

dbus_value }), dbus.Array())

1778

1281

setattr(self, attrname, value)

1779

1282

1780

1283

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

1781

1284

1782

1285

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1783

1286

approvals_pending = notifychangeproperty(dbus.Boolean,

1784

1287

"ApprovalPending",

1785

type_func=bool)

1288

type_func = bool)

1786

1289

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

1787

1290

last_enabled = notifychangeproperty(datetime_to_dbus,

1788

1291

"LastEnabled")

1789

checker = notifychangeproperty(

1790

dbus.Boolean, "CheckerRunning",

1791

type_func=lambda checker: checker is not None)

1292

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

1293

type_func = lambda checker:

1294

checker is not None)

1792

1295

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1793

1296

"LastCheckedOK")

1794

1297

last_checker_status = notifychangeproperty(dbus.Int16,

1797

1300

datetime_to_dbus, "LastApprovalRequest")

1798

1301

approved_by_default = notifychangeproperty(dbus.Boolean,

1799

1302

"ApprovedByDefault")

1800

approval_delay = notifychangeproperty(

1801

dbus.UInt64, "ApprovalDelay",

1802

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

1303

approval_delay = notifychangeproperty(dbus.UInt64,

1304

"ApprovalDelay",

1305

type_func =

1306

lambda td: td.total_seconds()

1307

* 1000)

1803

1308

approval_duration = notifychangeproperty(

1804

1309

dbus.UInt64, "ApprovalDuration",

1805

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

1310

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

1806

1311

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

1807

timeout = notifychangeproperty(

1808

dbus.UInt64, "Timeout",

1809

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

1312

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

1313

type_func = lambda td:

1314

td.total_seconds() * 1000)

1810

1315

extended_timeout = notifychangeproperty(

1811

1316

dbus.UInt64, "ExtendedTimeout",

1812

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

1813

interval = notifychangeproperty(

1814

dbus.UInt64, "Interval",

1815

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

1317

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

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

lambda td: td.total_seconds()

1322

* 1000)

1816

1323

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

1817

1324

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

1818

1325

invalidate_only=True)

1819

1326

1820

1327

del notifychangeproperty

1821

1328

1822

1329

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

1823

1330

try:

1824

1331

self.remove_from_connection()

1827

1334

if hasattr(DBusObjectWithProperties, "__del__"):

1828

1335

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

1829

1336

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

1830

1831

def checker_callback(self, source, condition,

1832

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

1833

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

1834

connection, command, *args,

1835

**kwargs)

1836

exitstatus = self.last_checker_status

1837

if exitstatus >= 0:

1337

1338

def checker_callback(self, pid, condition, command,

1339

*args, **kwargs):

1340

self.checker_callback_tag = None

1341

self.checker = None

1342

if os.WIFEXITED(condition):

1343

exitstatus = os.WEXITSTATUS(condition)

1838

1344

# Emit D-Bus signal

1839

1345

self.CheckerCompleted(dbus.Int16(exitstatus),

1840

# This is specific to GNU libC

1841

dbus.Int64(exitstatus << 8),

1346

dbus.Int64(condition),

1842

1347

dbus.String(command))

1843

1348

else:

1844

1349

# Emit D-Bus signal

1845

1350

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

1846

dbus.Int64(

1847

# This is specific to GNU libC

1848

(exitstatus << 8)

1849

| self.last_checker_signal),

1351

dbus.Int64(condition),

1850

1352

dbus.String(command))

1851

return ret

1852

1353

1354

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

1355

*args, **kwargs)

1356

1853

1357

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

1854

1358

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

1855

1359

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

1859

1363

# Emit D-Bus signal

1860

1364

self.CheckerStarted(self.current_checker_command)

1861

1365

return r

1862

1366

1863

1367

def _reset_approved(self):

1864

1368

self.approved = None

1865

1369

return False

1866

1370

1867

1371

def approve(self, value=True):

1868

1372

self.approved = value

1869

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

1870

* 1000), self._reset_approved)

1373

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

1374

* 1000), self._reset_approved)

1871

1375

self.send_changedstate()

1872

1873

# D-Bus methods, signals & properties

1874

1875

# Interfaces

1876

1877

# Signals

1878

1376

1377

## D-Bus methods, signals & properties

1378

1379

## Interfaces

1380

1381

## Signals

1382

1879

1383

# CheckerCompleted - signal

1880

1384

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

1881

1385

def CheckerCompleted(self, exitcode, waitstatus, command):

1882

1386

"D-Bus signal"

1883

1387

pass

1884

1388

1885

1389

# CheckerStarted - signal

1886

1390

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

1887

1391

def CheckerStarted(self, command):

1888

1392

"D-Bus signal"

1889

1393

pass

1890

1394

1891

1395

# PropertyChanged - signal

1892

1396

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

1893

1397

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

1894

1398

def PropertyChanged(self, property, value):

1895

1399

"D-Bus signal"

1896

1400

pass

1897

1401

1898

1402

# GotSecret - signal

1899

1403

@dbus.service.signal(_interface)

1900

1404

def GotSecret(self):

1903

1407

server to mandos-client

1904

1408

"""

1905

1409

pass

1906

1410

1907

1411

# Rejected - signal

1908

1412

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

1909

1413

def Rejected(self, reason):

1910

1414

"D-Bus signal"

1911

1415

pass

1912

1416

1913

1417

# NeedApproval - signal

1914

1418

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

1915

1419

def NeedApproval(self, timeout, default):

1916

1420

"D-Bus signal"

1917

1421

return self.need_approval()

1918

1919

# Methods

1920

1422

1423

## Methods

1424

1921

1425

# Approve - method

1922

1426

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

1923

1427

def Approve(self, value):

1924

1428

self.approve(value)

1925

1429

1926

1430

# CheckedOK - method

1927

1431

@dbus.service.method(_interface)

1928

1432

def CheckedOK(self):

1929

1433

self.checked_ok()

1930

1434

1931

1435

# Enable - method

1932

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

1933

1436

@dbus.service.method(_interface)

1934

1437

def Enable(self):

1935

1438

"D-Bus method"

1936

1439

self.enable()

1937

1440

1938

1441

# StartChecker - method

1939

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

1940

1442

@dbus.service.method(_interface)

1941

1443

def StartChecker(self):

1942

1444

"D-Bus method"

1943

1445

self.start_checker()

1944

1446

1945

1447

# Disable - method

1946

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

1947

1448

@dbus.service.method(_interface)

1948

1449

def Disable(self):

1949

1450

"D-Bus method"

1950

1451

self.disable()

1951

1452

1952

1453

# StopChecker - method

1953

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

1954

1454

@dbus.service.method(_interface)

1955

1455

def StopChecker(self):

1956

1456

self.stop_checker()

1957

1958

# Properties

1959

1457

1458

## Properties

1459

1960

1460

# ApprovalPending - property

1961

1461

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

1962

1462

def ApprovalPending_dbus_property(self):

1963

1463

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

1964

1464

1965

1465

# ApprovedByDefault - property

1966

@dbus_service_property(_interface,

1967

signature="b",

1466

@dbus_service_property(_interface, signature="b",

1968

1467

access="readwrite")

1969

1468

def ApprovedByDefault_dbus_property(self, value=None):

1970

1469

if value is None: # get

1971

1470

return dbus.Boolean(self.approved_by_default)

1972

1471

self.approved_by_default = bool(value)

1973

1472

1974

1473

# ApprovalDelay - property

1975

@dbus_service_property(_interface,

1976

signature="t",

1474

@dbus_service_property(_interface, signature="t",

1977

1475

access="readwrite")

1978

1476

def ApprovalDelay_dbus_property(self, value=None):

1979

1477

if value is None: # get

1980

1478

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

1981

1479

* 1000)

1982

1480

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

1983

1481

1984

1482

# ApprovalDuration - property

1985

@dbus_service_property(_interface,

1986

signature="t",

1483

@dbus_service_property(_interface, signature="t",

1987

1484

access="readwrite")

1988

1485

def ApprovalDuration_dbus_property(self, value=None):

1989

1486

if value is None: # get

1990

1487

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

1991

1488

* 1000)

1992

1489

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

1993

1490

1994

1491

# Name - property

1995

@dbus_annotations(

1996

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

1997

1492

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

1998

1493

def Name_dbus_property(self):

1999

1494

return dbus.String(self.name)

2000

1495

2001

1496

# Fingerprint - property

2002

@dbus_annotations(

2003

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

2004

1497

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

2005

1498

def Fingerprint_dbus_property(self):

2006

1499

return dbus.String(self.fingerprint)

2007

1500

2008

1501

# Host - property

2009

@dbus_service_property(_interface,

2010

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2011

1503

access="readwrite")

2012

1504

def Host_dbus_property(self, value=None):

2013

1505

if value is None: # get

2014

1506

return dbus.String(self.host)

2015

1507

self.host = str(value)

2016

1508

2017

1509

# Created - property

2018

@dbus_annotations(

2019

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

2020

1510

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

2021

1511

def Created_dbus_property(self):

2022

1512

return datetime_to_dbus(self.created)

2023

1513

2024

1514

# LastEnabled - property

2025

1515

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

2026

1516

def LastEnabled_dbus_property(self):

2027

1517

return datetime_to_dbus(self.last_enabled)

2028

1518

2029

1519

# Enabled - property

2030

@dbus_service_property(_interface,

2031

signature="b",

1520

@dbus_service_property(_interface, signature="b",

2032

1521

access="readwrite")

2033

1522

def Enabled_dbus_property(self, value=None):

2034

1523

if value is None: # get

2037

1526

self.enable()

2038

1527

else:

2039

1528

self.disable()

2040

1529

2041

1530

# LastCheckedOK - property

2042

@dbus_service_property(_interface,

2043

signature="s",

1531

@dbus_service_property(_interface, signature="s",

2044

1532

access="readwrite")

2045

1533

def LastCheckedOK_dbus_property(self, value=None):

2046

1534

if value is not None:

2047

1535

self.checked_ok()

2048

1536

return

2049

1537

return datetime_to_dbus(self.last_checked_ok)

2050

1538

2051

1539

# LastCheckerStatus - property

2052

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

1540

@dbus_service_property(_interface, signature="n",

1541

access="read")

2053

1542

def LastCheckerStatus_dbus_property(self):

2054

1543

return dbus.Int16(self.last_checker_status)

2055

1544

2056

1545

# Expires - property

2057

1546

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

2058

1547

def Expires_dbus_property(self):

2059

1548

return datetime_to_dbus(self.expires)

2060

1549

2061

1550

# LastApprovalRequest - property

2062

1551

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

2063

1552

def LastApprovalRequest_dbus_property(self):

2064

1553

return datetime_to_dbus(self.last_approval_request)

2065

1554

2066

1555

# Timeout - property

2067

@dbus_service_property(_interface,

2068

signature="t",

1556

@dbus_service_property(_interface, signature="t",

2069

1557

access="readwrite")

2070

1558

def Timeout_dbus_property(self, value=None):

2071

1559

if value is None: # get

2083

1571

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

2084

1572

is None):

2085

1573

return

2086

GLib.source_remove(self.disable_initiator_tag)

2087

self.disable_initiator_tag = GLib.timeout_add(

2088

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

2089

self.disable)

2090

1574

gobject.source_remove(self.disable_initiator_tag)

1575

self.disable_initiator_tag = (

1576

gobject.timeout_add(

1577

int((self.expires - now).total_seconds()

1578

* 1000), self.disable))

1579

2091

1580

# ExtendedTimeout - property

2092

@dbus_service_property(_interface,

2093

signature="t",

1581

@dbus_service_property(_interface, signature="t",

2094

1582

access="readwrite")

2095

1583

def ExtendedTimeout_dbus_property(self, value=None):

2096

1584

if value is None: # get

2097

1585

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

2098

1586

* 1000)

2099

1587

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

2100

1588

2101

1589

# Interval - property

2102

@dbus_service_property(_interface,

2103

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2104

1591

access="readwrite")

2105

1592

def Interval_dbus_property(self, value=None):

2106

1593

if value is None: # get

2110

1597

return

2111

1598

if self.enabled:

2112

1599

# Reschedule checker run

2113

GLib.source_remove(self.checker_initiator_tag)

2114

self.checker_initiator_tag = GLib.timeout_add(

2115

value, self.start_checker)

2116

self.start_checker() # Start one now, too

2117

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2118

1605

# Checker - property

2119

@dbus_service_property(_interface,

2120

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2121

1607

access="readwrite")

2122

1608

def Checker_dbus_property(self, value=None):

2123

1609

if value is None: # get

2124

1610

return dbus.String(self.checker_command)

2125

1611

self.checker_command = str(value)

2126

1612

2127

1613

# CheckerRunning - property

2128

@dbus_service_property(_interface,

2129

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2130

1615

access="readwrite")

2131

1616

def CheckerRunning_dbus_property(self, value=None):

2132

1617

if value is None: # get

2135

1620

self.start_checker()

2136

1621

else:

2137

1622

self.stop_checker()

2138

1623

2139

1624

# ObjectPath - property

2140

@dbus_annotations(

2141

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

2142

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

2143

1625

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

2144

1626

def ObjectPath_dbus_property(self):

2145

return self.dbus_object_path # is already a dbus.ObjectPath

2146

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2147

1629

# Secret = property

2148

@dbus_annotations(

2149

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

2150

"invalidates"})

2151

@dbus_service_property(_interface,

2152

signature="ay",

2153

access="write",

2154

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2155

1632

def Secret_dbus_property(self, value):

2156

1633

self.secret = bytes(value)

2157

1634

2158

1635

del _interface

2159

1636

2160

1637

2163

1640

self._pipe = child_pipe

2164

1641

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

2165

1642

if not self._pipe.recv():

2166

raise KeyError(fpr)

2167

1643

raise KeyError()

1644

2168

1645

def __getattribute__(self, name):

2169

1646

if name == '_pipe':

2170

1647

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

2173

1650

if data[0] == 'data':

2174

1651

return data[1]

2175

1652

if data[0] == 'function':

2176

2177

1653

def func(*args, **kwargs):

2178

1654

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

2179

1655

return self._pipe.recv()[1]

2180

2181

1656

return func

2182

1657

2183

1658

def __setattr__(self, name, value):

2184

1659

if name == '_pipe':

2185

1660

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

2188

1663

2189

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2190

1665

"""A class to handle client connections.

2191

1666

2192

1667

Instantiated once for each connection to handle it.

2193

1668

Note: This will run in its own forked process."""

2194

1669

2195

1670

def handle(self):

2196

1671

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

2197

1672

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

2198

1673

str(self.client_address))

2199

1674

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

2200

1675

self.server.child_pipe.fileno())

2201

2202

session = gnutls.ClientSession(self.request)

2203

2204

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

2205

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

2206

# "+COMP-NULL", "+CTYPE-OPENPGP",

2207

# "+DHE-DSS"))

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

# "+COMP-NULL", "+CTYPE-OPENPGP",

1690

# "+DHE-DSS"))

2208

1691

# Use a fallback default, since this MUST be set.

2209

1692

priority = self.server.gnutls_priority

2210

1693

if priority is None:

2211

1694

priority = "NORMAL"

2212

gnutls.priority_set_direct(session._c_object,

2213

priority.encode("utf-8"),

2214

None)

2215

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2216

1699

# Start communication using the Mandos protocol

2217

1700

# Get protocol number

2218

1701

line = self.request.makefile().readline()

2223

1706

except (ValueError, IndexError, RuntimeError) as error:

2224

1707

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

2225

1708

return

2226

1709

2227

1710

# Start GnuTLS connection

2228

1711

try:

2229

1712

session.handshake()

2230

except gnutls.Error as error:

1713

except gnutls.errors.GNUTLSError as error:

2231

1714

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

2232

1715

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

2233

1716

# established. Just abandon the request.

2234

1717

return

2235

1718

logger.debug("Handshake succeeded")

2236

1719

2237

1720

approval_required = False

2238

1721

try:

2239

1722

try:

2240

fpr = self.fingerprint(

2241

self.peer_certificate(session))

2242

except (TypeError, gnutls.Error) as error:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

2243

1727

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

2244

1728

return

2245

1729

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

2246

1730

2247

1731

try:

2248

1732

client = ProxyClient(child_pipe, fpr,

2249

1733

self.client_address)

2250

1734

except KeyError:

2251

1735

return

2252

1736

2253

1737

if client.approval_delay:

2254

1738

delay = client.approval_delay

2255

1739

client.approvals_pending += 1

2256

1740

approval_required = True

2257

1741

2258

1742

while True:

2259

1743

if not client.enabled:

2260

1744

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

2261

client.name)

1745

client.name)

2262

1746

if self.server.use_dbus:

2263

1747

# Emit D-Bus signal

2264

1748

client.Rejected("Disabled")

2265

1749

return

2266

1750

2267

1751

if client.approved or not client.approval_delay:

2268

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2269

1753

break

2270

1754

elif client.approved is None:

2271

1755

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

2282

1766

# Emit D-Bus signal

2283

1767

client.Rejected("Denied")

2284

1768

return

2285

2286

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2287

1771

time = datetime.datetime.now()

2288

1772

client.changedstate.acquire()

2289

1773

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

2302

1786

break

2303

1787

else:

2304

1788

delay -= time2 - time

2305

2306

try:

2307

session.send(client.secret)

2308

except gnutls.Error as error:

2309

logger.warning("gnutls send failed",

2310

exc_info=error)

2311

return

2312

1789

1790

sent_size = 0

1791

while sent_size < len(client.secret):

1792

try:

1793

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

1794

except gnutls.errors.GNUTLSError as error:

1795

logger.warning("gnutls send failed",

1796

exc_info=error)

1797

return

1798

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

1799

sent, len(client.secret)

1800

- (sent_size + sent))

1801

sent_size += sent

1802

2313

1803

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

2314

1804

# bump the timeout using extended_timeout

2315

1805

client.bump_timeout(client.extended_timeout)

2316

1806

if self.server.use_dbus:

2317

1807

# Emit D-Bus signal

2318

1808

client.GotSecret()

2319

1809

2320

1810

finally:

2321

1811

if approval_required:

2322

1812

client.approvals_pending -= 1

2323

1813

try:

2324

1814

session.bye()

2325

except gnutls.Error as error:

1815

except gnutls.errors.GNUTLSError as error:

2326

1816

logger.warning("GnuTLS bye failed",

2327

1817

exc_info=error)

2328

1818

2329

1819

@staticmethod

2330

1820

def peer_certificate(session):

2331

1821

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

2332

1822

# If not an OpenPGP certificate...

2333

if (gnutls.certificate_type_get(session._c_object)

2334

!= gnutls.CRT_OPENPGP):

2335

# ...return invalid data

2336

return b""

1823

if (gnutls.library.functions

1824

.gnutls_certificate_type_get(session._c_object)

1825

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1826

# ...do the normal thing

1827

return session.peer_certificate

2337

1828

list_size = ctypes.c_uint(1)

2338

cert_list = (gnutls.certificate_get_peers

1829

cert_list = (gnutls.library.functions

1830

.gnutls_certificate_get_peers

2339

1831

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

2340

1832

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

2341

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

1833

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

1834

" certificate")

2342

1835

if list_size.value == 0:

2343

1836

return None

2344

1837

cert = cert_list[0]

2345

1838

return ctypes.string_at(cert.data, cert.size)

2346

1839

2347

1840

@staticmethod

2348

1841

def fingerprint(openpgp):

2349

1842

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2350

1843

# New GnuTLS "datum" with the OpenPGP public key

2351

datum = gnutls.datum_t(

2352

ctypes.cast(ctypes.c_char_p(openpgp),

2353

ctypes.POINTER(ctypes.c_ubyte)),

2354

ctypes.c_uint(len(openpgp)))

1844

datum = (gnutls.library.types

1845

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

1846

ctypes.POINTER

1847

(ctypes.c_ubyte)),

1848

ctypes.c_uint(len(openpgp))))

2355

1849

# New empty GnuTLS certificate

2356

crt = gnutls.openpgp_crt_t()

2357

gnutls.openpgp_crt_init(ctypes.byref(crt))

1850

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1851

(gnutls.library.functions

1852

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2358

1853

# Import the OpenPGP public key into the certificate

2359

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

2360

gnutls.OPENPGP_FMT_RAW)

1854

(gnutls.library.functions

1855

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

1856

gnutls.library.constants

1857

.GNUTLS_OPENPGP_FMT_RAW))

2361

1858

# Verify the self signature in the key

2362

1859

crtverify = ctypes.c_uint()

2363

gnutls.openpgp_crt_verify_self(crt, 0,

2364

ctypes.byref(crtverify))

1860

(gnutls.library.functions

1861

.gnutls_openpgp_crt_verify_self(crt, 0,

1862

ctypes.byref(crtverify)))

2365

1863

if crtverify.value != 0:

2366

gnutls.openpgp_crt_deinit(crt)

2367

raise gnutls.CertificateSecurityError("Verify failed")

1864

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1865

raise (gnutls.errors.CertificateSecurityError

1866

("Verify failed"))

2368

1867

# New buffer for the fingerprint

2369

1868

buf = ctypes.create_string_buffer(20)

2370

1869

buf_len = ctypes.c_size_t()

2371

1870

# Get the fingerprint from the certificate into the buffer

2372

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

2373

ctypes.byref(buf_len))

1871

(gnutls.library.functions

1872

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

1873

ctypes.byref(buf_len)))

2374

1874

# Deinit the certificate

2375

gnutls.openpgp_crt_deinit(crt)

1875

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

1876

# Convert the buffer to a Python bytestring

2377

1877

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

2378

1878

# Convert the bytestring to hexadecimal notation

2382

1882

2383

1883

class MultiprocessingMixIn(object):

2384

1884

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

2385

2386

1885

def sub_process_main(self, request, address):

2387

1886

try:

2388

1887

self.finish_request(request, address)

2389

1888

except Exception:

2390

1889

self.handle_error(request, address)

2391

1890

self.close_request(request)

2392

1891

2393

1892

def process_request(self, request, address):

2394

1893

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

2395

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

2396

args=(request, address))

1894

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

1895

args = (request, address))

2397

1896

proc.start()

2398

1897

return proc

2399

1898

2400

1899

2401

1900

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2402

1901

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

2403

2404

1902

def process_request(self, request, client_address):

2405

1903

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

2406

1904

2407

1905

This function creates a new pipe in self.pipe

2408

1906

"""

2409

1907

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2410

1908

2411

1909

proc = MultiprocessingMixIn.process_request(self, request,

2412

1910

client_address)

2413

1911

self.child_pipe.close()

2414

1912

self.add_pipe(parent_pipe, proc)

2415

1913

2416

1914

def add_pipe(self, parent_pipe, proc):

2417

1915

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

2418

1916

raise NotImplementedError()

2421

1919

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2422

1920

socketserver.TCPServer, object):

2423

1921

"""IPv6-capable TCP server. Accepts 'None' as address and/or port

2424

1922

2425

1923

Attributes:

2426

1924

enabled: Boolean; whether this server is activated yet

2427

1925

interface: None or a network interface name (string)

2428

1926

use_ipv6: Boolean; to use IPv6 or not

2429

1927

"""

2430

2431

1928

def __init__(self, server_address, RequestHandlerClass,

2432

interface=None,

2433

use_ipv6=True,

2434

socketfd=None):

1929

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

2435

1930

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

2436

1931

creating a new one with socket.socket().

2437

1932

"""

2443

1938

self.socketfd = socketfd

2444

1939

# Save the original socket.socket() function

2445

1940

self.socket_socket = socket.socket

2446

2447

1941

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

2448

#

1942

#

2449

1943

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

2450

1944

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

2451

1945

# patching socket.socket.)

2452

#

1946

#

2453

1947

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

2454

1948

@functools.wraps(socket.socket)

2455

1949

def socket_wrapper(*args, **kwargs):

2467

1961

# socket_wrapper(), if socketfd was set.

2468

1962

socketserver.TCPServer.__init__(self, server_address,

2469

1963

RequestHandlerClass)

2470

1964

2471

1965

def server_bind(self):

2472

1966

"""This overrides the normal server_bind() function

2473

1967

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

2474

1968

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

2475

global SO_BINDTODEVICE

2476

1969

if self.interface is not None:

2477

1970

if SO_BINDTODEVICE is None:

2478

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

2479

# common enough.

2480

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

2481

SO_BINDTODEVICE = 25

2482

try:

2483

self.socket.setsockopt(

2484

socket.SOL_SOCKET, SO_BINDTODEVICE,

2485

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

2486

except socket.error as error:

2487

if error.errno == errno.EPERM:

2488

logger.error("No permission to bind to"

2489

" interface %s", self.interface)

2490

elif error.errno == errno.ENOPROTOOPT:

2491

logger.error("SO_BINDTODEVICE not available;"

2492

" cannot bind to interface %s",

2493

self.interface)

2494

elif error.errno == errno.ENODEV:

2495

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

2496

" cannot bind", self.interface)

2497

else:

2498

raise

1971

logger.error("SO_BINDTODEVICE does not exist;"

1972

" cannot bind to interface %s",

1973

self.interface)

1974

else:

1975

try:

1976

self.socket.setsockopt(socket.SOL_SOCKET,

1977

SO_BINDTODEVICE,

1978

(self.interface + "\0")

1979

.encode("utf-8"))

1980

except socket.error as error:

1981

if error.errno == errno.EPERM:

1982

logger.error("No permission to bind to"

1983

" interface %s", self.interface)

1984

elif error.errno == errno.ENOPROTOOPT:

1985

logger.error("SO_BINDTODEVICE not available;"

1986

" cannot bind to interface %s",

1987

self.interface)

1988

elif error.errno == errno.ENODEV:

1989

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

1990

" cannot bind", self.interface)

1991

else:

1992

raise

2499

1993

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

2500

1994

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

2501

1995

if not self.server_address[0]:

2502

1996

if self.address_family == socket.AF_INET6:

2503

any_address = "::" # in6addr_any

1997

any_address = "::" # in6addr_any

2504

1998

else:

2505

any_address = "0.0.0.0" # INADDR_ANY

1999

any_address = "0.0.0.0" # INADDR_ANY

2506

2000

self.server_address = (any_address,

2507

2001

self.server_address[1])

2508

2002

elif not self.server_address[1]:

2509

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

2003

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

2004

0)

2510

2005

# if self.interface:

2511

2006

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

2512

2007

# 0, # port

2518

2013

2519

2014

class MandosServer(IPv6_TCPServer):

2520

2015

"""Mandos server.

2521

2016

2522

2017

Attributes:

2523

2018

clients: set of Client objects

2524

2019

gnutls_priority GnuTLS priority string

2525

2020

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

2526

2527

Assumes a GLib.MainLoop event loop.

2021

2022

Assumes a gobject.MainLoop event loop.

2528

2023

"""

2529

2530

2024

def __init__(self, server_address, RequestHandlerClass,

2531

interface=None,

2532

use_ipv6=True,

2533

clients=None,

2534

gnutls_priority=None,

2535

use_dbus=True,

2536

socketfd=None):

2025

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

2026

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

2537

2027

self.enabled = False

2538

2028

self.clients = clients

2539

2029

if self.clients is None:

2542

2032

self.gnutls_priority = gnutls_priority

2543

2033

IPv6_TCPServer.__init__(self, server_address,

2544

2034

RequestHandlerClass,

2545

interface=interface,

2546

use_ipv6=use_ipv6,

2547

socketfd=socketfd)

2548

2035

interface = interface,

2036

use_ipv6 = use_ipv6,

2037

socketfd = socketfd)

2549

2038

def server_activate(self):

2550

2039

if self.enabled:

2551

2040

return socketserver.TCPServer.server_activate(self)

2552

2041

2553

2042

def enable(self):

2554

2043

self.enabled = True

2555

2044

2556

2045

def add_pipe(self, parent_pipe, proc):

2557

2046

# Call "handle_ipc" for both data and EOF events

2558

GLib.io_add_watch(

2559

parent_pipe.fileno(),

2560

GLib.IO_IN | GLib.IO_HUP,

2561

functools.partial(self.handle_ipc,

2562

parent_pipe=parent_pipe,

2563

proc=proc))

2564

2565

def handle_ipc(self, source, condition,

2566

parent_pipe=None,

2567

proc=None,

2568

client_object=None):

2047

gobject.io_add_watch(parent_pipe.fileno(),

2048

gobject.IO_IN | gobject.IO_HUP,

2049

functools.partial(self.handle_ipc,

2050

parent_pipe =

2051

parent_pipe,

2052

proc = proc))

2053

2054

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

2055

proc = None, client_object=None):

2569

2056

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

2570

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

2057

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

2571

2058

# Wait for other process to exit

2572

2059

proc.join()

2573

2060

return False

2574

2061

2575

2062

# Read a request from the child

2576

2063

request = parent_pipe.recv()

2577

2064

command = request[0]

2578

2065

2579

2066

if command == 'init':

2580

2067

fpr = request[1]

2581

2068

address = request[2]

2582

2583

for c in self.clients.values():

2069

2070

for c in self.clients.itervalues():

2584

2071

if c.fingerprint == fpr:

2585

2072

client = c

2586

2073

break

2593

2080

address[0])

2594

2081

parent_pipe.send(False)

2595

2082

return False

2596

2597

GLib.io_add_watch(

2598

parent_pipe.fileno(),

2599

GLib.IO_IN | GLib.IO_HUP,

2600

functools.partial(self.handle_ipc,

2601

parent_pipe=parent_pipe,

2602

proc=proc,

2603

client_object=client))

2083

2084

gobject.io_add_watch(parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2086

functools.partial(self.handle_ipc,

2087

parent_pipe =

2088

parent_pipe,

2089

proc = proc,

2090

client_object =

2091

client))

2604

2092

parent_pipe.send(True)

2605

2093

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

2606

2094

# same fileno

2609

2097

funcname = request[1]

2610

2098

args = request[2]

2611

2099

kwargs = request[3]

2612

2100

2613

2101

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

2614

2102

funcname)(*args,

2615

**kwargs)))

2616

2103

**kwargs)))

2104

2617

2105

if command == 'getattr':

2618

2106

attrname = request[1]

2619

if isinstance(client_object.__getattribute__(attrname),

2620

collections.Callable):

2621

parent_pipe.send(('function', ))

2107

if callable(client_object.__getattribute__(attrname)):

2108

parent_pipe.send(('function',))

2622

2109

else:

2623

parent_pipe.send((

2624

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

2625

2110

parent_pipe.send(('data', client_object

2111

.__getattribute__(attrname)))

2112

2626

2113

if command == 'setattr':

2627

2114

attrname = request[1]

2628

2115

value = request[2]

2629

2116

setattr(client_object, attrname, value)

2630

2117

2631

2118

return True

2632

2119

2633

2120

2634

2121

def rfc3339_duration_to_delta(duration):

2635

2122

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

2636

2123

2637

2124

>>> rfc3339_duration_to_delta("P7D")

2638

2125

datetime.timedelta(7)

2639

2126

>>> rfc3339_duration_to_delta("PT60S")

2649

2136

>>> rfc3339_duration_to_delta("P1DT3M20S")

2650

2137

datetime.timedelta(1, 200)

2651

2138

"""

2652

2139

2653

2140

# Parsing an RFC 3339 duration with regular expressions is not

2654

2141

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

2655

2142

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

2656

2143

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

2657

2144

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

2658

2145

# avoid excessive use of external libraries.

2659

2146

2660

2147

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

2661

Token = collections.namedtuple("Token", (

2662

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

2663

# a "group" containing digits

2664

"value", # datetime.timedelta or None

2665

"followers")) # Tokens valid after this token

2148

Token = collections.namedtuple("Token",

2149

("regexp", # To match token; if

2150

# "value" is not None,

2151

# must have a "group"

2152

# containing digits

2153

"value", # datetime.timedelta or

2154

# None

2155

"followers")) # Tokens valid after

2156

# this token

2666

2157

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

2667

2158

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

2668

2159

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

2669

2160

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

2670

2161

datetime.timedelta(seconds=1),

2671

frozenset((token_end, )))

2162

frozenset((token_end,)))

2672

2163

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

2673

2164

datetime.timedelta(minutes=1),

2674

2165

frozenset((token_second, token_end)))

2690

2181

frozenset((token_month, token_end)))

2691

2182

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

2692

2183

datetime.timedelta(weeks=1),

2693

frozenset((token_end, )))

2184

frozenset((token_end,)))

2694

2185

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

2695

2186

frozenset((token_year, token_month,

2696

2187

token_day, token_time,

2697

2188

token_week)))

2698

# Define starting values:

2699

# Value so far

2700

value = datetime.timedelta()

2189

# Define starting values

2190

value = datetime.timedelta() # Value so far

2701

2191

found_token = None

2702

# Following valid tokens

2703

followers = frozenset((token_duration, ))

2704

# String left to parse

2705

s = duration

2192

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

2193

s = duration # String left to parse

2706

2194

# Loop until end token is found

2707

2195

while found_token is not token_end:

2708

2196

# Search for any currently valid tokens

2724

2212

break

2725

2213

else:

2726

2214

# No currently valid tokens were found

2727

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

2728

.format(duration))

2215

raise ValueError("Invalid RFC 3339 duration")

2729

2216

# End token found

2730

2217

return value

2731

2218

2732

2219

2733

2220

def string_to_delta(interval):

2734

2221

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

2735

2222

2736

2223

>>> string_to_delta('7d')

2737

2224

datetime.timedelta(7)

2738

2225

>>> string_to_delta('60s')

2746

2233

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

2747

2234

datetime.timedelta(0, 330)

2748

2235

"""

2749

2236

2750

2237

try:

2751

2238

return rfc3339_duration_to_delta(interval)

2752

2239

except ValueError:

2753

2240

pass

2754

2241

2755

2242

timevalue = datetime.timedelta(0)

2756

2243

for s in interval.split():

2757

2244

try:

2768

2255

elif suffix == "w":

2769

2256

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

2770

2257

else:

2771

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

2258

raise ValueError("Unknown suffix {!r}"

2259

.format(suffix))

2772

2260

except IndexError as e:

2773

2261

raise ValueError(*(e.args))

2774

2262

timevalue += delta

2775

2263

return timevalue

2776

2264

2777

2265

2778

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

2266

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

2779

2267

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

2780

2268

2781

2269

This should really exist as os.daemon, but it doesn't (yet)."""

2782

2270

if os.fork():

2783

2271

sys.exit()

2790

2278

# Close all standard open file descriptors

2791

2279

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

2792

2280

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

2793

raise OSError(errno.ENODEV,

2794

"{} not a character device"

2281

raise OSError(errno.ENODEV, "{} not a character device"

2795

2282

.format(os.devnull))

2796

2283

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

2797

2284

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

2801

2288

2802

2289

2803

2290

def main():

2804

2291

2805

2292

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

2806

2293

# Parsing of options, both command line and config file

2807

2294

2808

2295

parser = argparse.ArgumentParser()

2809

2296

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

2810

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

2297

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

2811

2298

help="show version number and exit")

2812

2299

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

2813

2300

help="Bind to interface IF")

2849

2336

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

2850

2337

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

2851

2338

default=None)

2852

2339

2853

2340

options = parser.parse_args()

2854

2341

2855

2342

if options.check:

2856

2343

import doctest

2857

2344

fail_count, test_count = doctest.testmod()

2858

2345

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

2859

2346

2860

2347

# Default values for config file for server-global settings

2861

server_defaults = {"interface": "",

2862

"address": "",

2863

"port": "",

2864

"debug": "False",

2865

"priority":

2866

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

2867

":+SIGN-DSA-SHA256",

2868

"servicename": "Mandos",

2869

"use_dbus": "True",

2870

"use_ipv6": "True",

2871

"debuglevel": "",

2872

"restore": "True",

2873

"socket": "",

2874

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

2875

"foreground": "False",

2876

"zeroconf": "True",

2877

}

2878

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

"zeroconf": "True",

2363

}

2364

2879

2365

# Parse config file for server-global settings

2880

2366

server_config = configparser.SafeConfigParser(server_defaults)

2881

2367

del server_defaults

2882

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

2368

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

2369

"mandos.conf"))

2883

2370

# Convert the SafeConfigParser object to a dict

2884

2371

server_settings = server_config.defaults()

2885

2372

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

2886

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

2887

"foreground", "zeroconf"):

2373

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

2888

2374

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

2889

2375

option)

2890

2376

if server_settings["port"]:

2900

2386

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

2901

2387

["socket"])

2902

2388

del server_config

2903

2389

2904

2390

# Override the settings from the config file with command line

2905

2391

# options, if set.

2906

2392

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

2907

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

2908

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

2909

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

2393

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

2394

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

2395

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

2910

2396

value = getattr(options, option)

2911

2397

if value is not None:

2912

2398

server_settings[option] = value

2924

2410

if server_settings["debug"]:

2925

2411

server_settings["foreground"] = True

2926

2412

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

2927

2413

2928

2414

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

2929

2930

if (not server_settings["zeroconf"]

2931

and not (server_settings["port"]

2932

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

2933

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

2934

2415

2416

if (not server_settings["zeroconf"] and

2417

not (server_settings["port"]

2418

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

2419

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

2420

" Zeroconf")

2421

2935

2422

# For convenience

2936

2423

debug = server_settings["debug"]

2937

2424

debuglevel = server_settings["debuglevel"]

2941

2428

stored_state_file)

2942

2429

foreground = server_settings["foreground"]

2943

2430

zeroconf = server_settings["zeroconf"]

2944

2431

2945

2432

if debug:

2946

2433

initlogger(debug, logging.DEBUG)

2947

2434

else:

2950

2437

else:

2951

2438

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

2952

2439

initlogger(debug, level)

2953

2440

2954

2441

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

2955

syslogger.setFormatter(

2956

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

2957

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

2958

server_settings["servicename"])))

2959

2442

syslogger.setFormatter(logging.Formatter

2443

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

2444

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

2445

.format(server_settings

2446

["servicename"])))

2447

2960

2448

# Parse config file with clients

2961

2449

client_config = configparser.SafeConfigParser(Client

2962

2450

.client_defaults)

2963

2451

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

2964

2452

"clients.conf"))

2965

2453

2966

2454

global mandos_dbus_service

2967

2455

mandos_dbus_service = None

2968

2456

2969

2457

socketfd = None

2970

2458

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

2971

2459

socketfd = server_settings["socket"]

2972

tcp_server = MandosServer(

2973

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

2974

ClientHandler,

2975

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

2976

use_ipv6=use_ipv6,

2977

gnutls_priority=server_settings["priority"],

2978

use_dbus=use_dbus,

2979

socketfd=socketfd)

2460

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

2461

server_settings["port"]),

2462

ClientHandler,

2463

interface=(server_settings["interface"]

2464

or None),

2465

use_ipv6=use_ipv6,

2466

gnutls_priority=

2467

server_settings["priority"],

2468

use_dbus=use_dbus,

2469

socketfd=socketfd)

2980

2470

if not foreground:

2981

2471

pidfilename = "/run/mandos.pid"

2982

2472

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

2983

2473

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

2984

2474

pidfile = None

2985

2475

try:

2986

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

2476

pidfile = open(pidfilename, "w")

2987

2477

except IOError as e:

2988

2478

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

2989

2479

exc_info=e)

2990

2991

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

2992

("mandos", "mandos"),

2993

("nobody", "nogroup")):

2480

2481

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

2994

2482

try:

2995

2483

uid = pwd.getpwnam(name).pw_uid

2996

gid = pwd.getpwnam(group).pw_gid

2484

gid = pwd.getpwnam(name).pw_gid

2997

2485

break

2998

2486

except KeyError:

2999

2487

continue

3003

2491

try:

3004

2492

os.setgid(gid)

3005

2493

os.setuid(uid)

3006

if debug:

3007

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

3008

gid))

3009

2494

except OSError as error:

3010

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

3011

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

3012

2495

if error.errno != errno.EPERM:

3013

2496

raise

3014

2497

3015

2498

if debug:

3016

2499

# Enable all possible GnuTLS debugging

3017

2500

3018

2501

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

3019

2502

# - GnuTLS manual

3020

gnutls.global_set_log_level(11)

3021

3022

@gnutls.log_func

2503

gnutls.library.functions.gnutls_global_set_log_level(11)

2504

2505

@gnutls.library.types.gnutls_log_func

3023

2506

def debug_gnutls(level, string):

3024

2507

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

3025

3026

gnutls.global_set_log_function(debug_gnutls)

3027

2508

2509

(gnutls.library.functions

2510

.gnutls_global_set_log_function(debug_gnutls))

2511

3028

2512

# Redirect stdin so all checkers get /dev/null

3029

2513

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

3030

2514

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

3031

2515

if null > 2:

3032

2516

os.close(null)

3033

2517

3034

2518

# Need to fork before connecting to D-Bus

3035

2519

if not foreground:

3036

2520

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

3037

2521

daemon()

3038

3039

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

3040

# to inform GLib that threads will be used.

3041

GLib.threads_init()

3042

2522

2523

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

2524

# need to inform gobject that threads will be used.

2525

gobject.threads_init()

2526

3043

2527

global main_loop

3044

2528

# From the Avahi example code

3045

2529

DBusGMainLoop(set_as_default=True)

3046

main_loop = GLib.MainLoop()

2530

main_loop = gobject.MainLoop()

3047

2531

bus = dbus.SystemBus()

3048

2532

# End of Avahi example code

3049

2533

if use_dbus:

3050

2534

try:

3051

2535

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

3052

bus,

3053

do_not_queue=True)

3054

old_bus_name = dbus.service.BusName(

3055

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

3056

do_not_queue=True)

3057

except dbus.exceptions.DBusException as e:

2536

bus, do_not_queue=True)

2537

old_bus_name = (dbus.service.BusName

2538

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

2539

do_not_queue=True))

2540

except dbus.exceptions.NameExistsException as e:

3058

2541

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

3059

2542

use_dbus = False

3060

2543

server_settings["use_dbus"] = False

3061

2544

tcp_server.use_dbus = False

3062

2545

if zeroconf:

3063

2546

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3064

service = AvahiServiceToSyslog(

3065

name=server_settings["servicename"],

3066

servicetype="_mandos._tcp",

3067

protocol=protocol,

3068

bus=bus)

2547

service = AvahiServiceToSyslog(name =

2548

server_settings["servicename"],

2549

servicetype = "_mandos._tcp",

2550

protocol = protocol, bus = bus)

3069

2551

if server_settings["interface"]:

3070

service.interface = if_nametoindex(

3071

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

3072

2552

service.interface = (if_nametoindex

2553

(server_settings["interface"]

2554

.encode("utf-8")))

2555

3073

2556

global multiprocessing_manager

3074

2557

multiprocessing_manager = multiprocessing.Manager()

3075

2558

3076

2559

client_class = Client

3077

2560

if use_dbus:

3078

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

3079

2561

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

2562

3080

2563

client_settings = Client.config_parser(client_config)

3081

2564

old_client_settings = {}

3082

2565

clients_data = {}

3083

2566

3084

2567

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

3085

2568

global wnull

3086

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

2569

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

3087

2570

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

3088

2571

# mode

3089

2572

if debug or not foreground:

3090

2573

wnull.close()

3091

2574

3092

2575

# Get client data and settings from last running state.

3093

2576

if server_settings["restore"]:

3094

2577

try:

3095

2578

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

3096

if sys.version_info.major == 2:

3097

clients_data, old_client_settings = pickle.load(

3098

stored_state)

3099

else:

3100

bytes_clients_data, bytes_old_client_settings = (

3101

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

3102

# Fix bytes to strings

3103

# clients_data

3104

# .keys()

3105

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

3106

if isinstance(key, bytes)

3107

else key): value

3108

for key, value in

3109

bytes_clients_data.items()}

3110

del bytes_clients_data

3111

for key in clients_data:

3112

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

3113

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

3114

for k, v in

3115

clients_data[key].items()}

3116

clients_data[key] = value

3117

# .client_structure

3118

value["client_structure"] = [

3119

(s.decode("utf-8")

3120

if isinstance(s, bytes)

3121

else s) for s in

3122

value["client_structure"]]

3123

# .name & .host

3124

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

3125

if isinstance(value[k], bytes):

3126

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

3127

# old_client_settings

3128

# .keys()

3129

old_client_settings = {

3130

(key.decode("utf-8")

3131

if isinstance(key, bytes)

3132

else key): value

3133

for key, value in

3134

bytes_old_client_settings.items()}

3135

del bytes_old_client_settings

3136

# .host

3137

for value in old_client_settings.values():

3138

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

3139

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

3140

.decode("utf-8"))

2579

clients_data, old_client_settings = (pickle.load

2580

(stored_state))

3141

2581

os.remove(stored_state_path)

3142

2582

except IOError as e:

3143

2583

if e.errno == errno.ENOENT:

3144

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

3145

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

2584

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

2585

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

3146

2586

else:

3147

2587

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

3148

2588

exc_info=e)

3149

2589

raise

3150

2590

except EOFError as e:

3151

2591

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

3152

"EOFError:",

3153

exc_info=e)

3154

2592

"EOFError:", exc_info=e)

2593

3155

2594

with PGPEngine() as pgp:

3156

2595

for client_name, client in clients_data.items():

3157

2596

# Skip removed clients

3158

2597

if client_name not in client_settings:

3159

2598

continue

3160

2599

3161

2600

# Decide which value to use after restoring saved state.

3162

2601

# We have three different values: Old config file,

3163

2602

# new config file, and saved state.

3168

2607

# For each value in new config, check if it

3169

2608

# differs from the old config value (Except for

3170

2609

# the "secret" attribute)

3171

if (name != "secret"

3172

and (value !=

3173

old_client_settings[client_name][name])):

2610

if (name != "secret" and

2611

value != old_client_settings[client_name]

2612

[name]):

3174

2613

client[name] = value

3175

2614

except KeyError:

3176

2615

pass

3177

2616

3178

2617

# Clients who has passed its expire date can still be

3179

# enabled if its last checker was successful. A Client

2618

# enabled if its last checker was successful. Clients

3180

2619

# whose checker succeeded before we stored its state is

3181

2620

# assumed to have successfully run all checkers during

3182

2621

# downtime.

3185

2624

if not client["last_checked_ok"]:

3186

2625

logger.warning(

3187

2626

"disabling client {} - Client never "

3188

"performed a successful checker".format(

3189

client_name))

2627

"performed a successful checker"

2628

.format(client_name))

3190

2629

client["enabled"] = False

3191

2630

elif client["last_checker_status"] != 0:

3192

2631

logger.warning(

3193

2632

"disabling client {} - Client last"

3194

" checker failed with error code"

3195

" {}".format(

3196

client_name,

3197

client["last_checker_status"]))

2633

" checker failed with error code {}"

2634

.format(client_name,

2635

client["last_checker_status"]))

3198

2636

client["enabled"] = False

3199

2637

else:

3200

client["expires"] = (

3201

datetime.datetime.utcnow()

3202

+ client["timeout"])

2638

client["expires"] = (datetime.datetime

2639

.utcnow()

2640

+ client["timeout"])

3203

2641

logger.debug("Last checker succeeded,"

3204

" keeping {} enabled".format(

3205

client_name))

2642

" keeping {} enabled"

2643

.format(client_name))

3206

2644

try:

3207

client["secret"] = pgp.decrypt(

3208

client["encrypted_secret"],

3209

client_settings[client_name]["secret"])

2645

client["secret"] = (

2646

pgp.decrypt(client["encrypted_secret"],

2647

client_settings[client_name]

2648

["secret"]))

3210

2649

except PGPError:

3211

2650

# If decryption fails, we use secret from new settings

3212

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

3213

client_name))

3214

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

3215

["secret"])

3216

2651

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

2652

.format(client_name))

2653

client["secret"] = (

2654

client_settings[client_name]["secret"])

2655

3217

2656

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

3218

2657

for client_name in (set(old_client_settings)

3219

2658

- set(client_settings)):

3221

2660

for client_name in (set(client_settings)

3222

2661

- set(old_client_settings)):

3223

2662

clients_data[client_name] = client_settings[client_name]

3224

2663

3225

2664

# Create all client objects

3226

2665

for client_name, client in clients_data.items():

3227

2666

tcp_server.clients[client_name] = client_class(

3228

name=client_name,

3229

settings=client,

3230

server_settings=server_settings)

3231

2667

name = client_name, settings = client,

2668

server_settings = server_settings)

2669

3232

2670

if not tcp_server.clients:

3233

2671

logger.warning("No clients defined")

3234

2672

3235

2673

if not foreground:

3236

2674

if pidfile is not None:

3237

pid = os.getpid()

3238

2675

try:

3239

2676

with pidfile:

3240

print(pid, file=pidfile)

2677

pid = os.getpid()

2678

pidfile.write("{}\n".format(pid).encode("utf-8"))

3241

2679

except IOError:

3242

2680

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

3243

2681

pidfilename, pid)

3244

2682

del pidfile

3245

2683

del pidfilename

3246

3247

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

3248

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3249

lambda: main_loop.quit() and False)

3250

2684

2685

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

2686

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

2687

3251

2688

if use_dbus:

3252

3253

@alternate_dbus_interfaces(

3254

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

3255

class MandosDBusService(DBusObjectWithObjectManager):

2689

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

2690

"se.bsnet.fukt.Mandos"})

2691

class MandosDBusService(DBusObjectWithProperties):

3256

2692

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

3257

3258

2693

def __init__(self):

3259

2694

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

3260

3261

2695

_interface = "se.recompile.Mandos"

3262

2696

2697

@dbus_interface_annotations(_interface)

2698

def _foo(self):

2699

return { "org.freedesktop.DBus.Property"

2700

".EmitsChangedSignal":

2701

"false"}

2702

3263

2703

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

3264

2704

def ClientAdded(self, objpath):

3265

2705

"D-Bus signal"

3266

2706

pass

3267

2707

3268

2708

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

3269

2709

def ClientNotFound(self, fingerprint, address):

3270

2710

"D-Bus signal"

3271

2711

pass

3272

3273

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

3274

"true"})

2712

3275

2713

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

3276

2714

def ClientRemoved(self, objpath, name):

3277

2715

"D-Bus signal"

3278

2716

pass

3279

3280

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

3281

"true"})

2717

3282

2718

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

3283

2719

def GetAllClients(self):

3284

2720

"D-Bus method"

3285

return dbus.Array(c.dbus_object_path for c in

3286

tcp_server.clients.values())

3287

3288

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

3289

"true"})

2721

return dbus.Array(c.dbus_object_path

2722

for c in

2723

tcp_server.clients.itervalues())

2724

3290

2725

@dbus.service.method(_interface,

3291

2726

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

3292

2727

def GetAllClientsWithProperties(self):

3293

2728

"D-Bus method"

3294

2729

return dbus.Dictionary(

3295

{c.dbus_object_path: c.GetAll(

3296

"se.recompile.Mandos.Client")

3297

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

2730

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

2731

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

3298

2732

signature="oa{sv}")

3299

2733

3300

2734

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

3301

2735

def RemoveClient(self, object_path):

3302

2736

"D-Bus method"

3303

for c in tcp_server.clients.values():

2737

for c in tcp_server.clients.itervalues():

3304

2738

if c.dbus_object_path == object_path:

3305

2739

del tcp_server.clients[c.name]

3306

2740

c.remove_from_connection()

3307

# Don't signal the disabling

2741

# Don't signal anything except ClientRemoved

3308

2742

c.disable(quiet=True)

3309

# Emit D-Bus signal for removal

3310

self.client_removed_signal(c)

2743

# Emit D-Bus signal

2744

self.ClientRemoved(object_path, c.name)

3311

2745

return

3312

2746

raise KeyError(object_path)

3313

2747

3314

2748

del _interface

3315

3316

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3317

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

3318

def GetManagedObjects(self):

3319

"""D-Bus method"""

3320

return dbus.Dictionary(

3321

{client.dbus_object_path:

3322

dbus.Dictionary(

3323

{interface: client.GetAll(interface)

3324

for interface in

3325

client._get_all_interface_names()})

3326

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

3327

3328

def client_added_signal(self, client):

3329

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

3330

if use_dbus:

3331

# New standard signal

3332

self.InterfacesAdded(

3333

client.dbus_object_path,

3334

dbus.Dictionary(

3335

{interface: client.GetAll(interface)

3336

for interface in

3337

client._get_all_interface_names()}))

3338

# Old signal

3339

self.ClientAdded(client.dbus_object_path)

3340

3341

def client_removed_signal(self, client):

3342

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

3343

if use_dbus:

3344

# New standard signal

3345

self.InterfacesRemoved(

3346

client.dbus_object_path,

3347

client._get_all_interface_names())

3348

# Old signal

3349

self.ClientRemoved(client.dbus_object_path,

3350

client.name)

3351

2749

3352

2750

mandos_dbus_service = MandosDBusService()

3353

3354

# Save modules to variables to exempt the modules from being

3355

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

3356

mp = multiprocessing

3357

wn = wnull

3358

2751

3359

2752

def cleanup():

3360

2753

"Cleanup function; run on exit"

3361

2754

if zeroconf:

3362

2755

service.cleanup()

3363

3364

mp.active_children()

3365

wn.close()

2756

2757

multiprocessing.active_children()

2758

wnull.close()

3366

2759

if not (tcp_server.clients or client_settings):

3367

2760

return

3368

2761

3369

2762

# Store client before exiting. Secrets are encrypted with key

3370

2763

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

3371

2764

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

3372

2765

clients = {}

3373

2766

with PGPEngine() as pgp:

3374

for client in tcp_server.clients.values():

2767

for client in tcp_server.clients.itervalues():

3375

2768

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

3376

2769

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

3377

2770

key)

3378

2771

client_dict = {}

3379

2772

3380

2773

# A list of attributes that can not be pickled

3381

2774

# + secret.

3382

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

3383

"checker", "server_settings"}

3384

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

3385

.Object):

2775

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

2776

"checker", "server_settings" }

2777

for name, typ in (inspect.getmembers

2778

(dbus.service.Object)):

3386

2779

exclude.add(name)

3387

2780

3388

2781

client_dict["encrypted_secret"] = (client

3389

2782

.encrypted_secret)

3390

2783

for attr in client.client_structure:

3391

2784

if attr not in exclude:

3392

2785

client_dict[attr] = getattr(client, attr)

3393

2786

3394

2787

clients[client.name] = client_dict

3395

2788

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

3396

2789

3397

2790

try:

3398

with tempfile.NamedTemporaryFile(

3399

mode='wb',

3400

suffix=".pickle",

3401

prefix='clients-',

3402

dir=os.path.dirname(stored_state_path),

3403

delete=False) as stored_state:

3404

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

3405

protocol=2)

3406

tempname = stored_state.name

2791

with (tempfile.NamedTemporaryFile

2792

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

2793

dir=os.path.dirname(stored_state_path),

2794

delete=False)) as stored_state:

2795

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

2796

tempname=stored_state.name

3407

2797

os.rename(tempname, stored_state_path)

3408

2798

except (IOError, OSError) as e:

3409

2799

if not debug:

3418

2808

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

3419

2809

exc_info=e)

3420

2810

raise

3421

2811

3422

2812

# Delete all clients, and settings from config

3423

2813

while tcp_server.clients:

3424

2814

name, client = tcp_server.clients.popitem()

3425

2815

if use_dbus:

3426

2816

client.remove_from_connection()

3427

# Don't signal the disabling

2817

# Don't signal anything except ClientRemoved

3428

2818

client.disable(quiet=True)

3429

# Emit D-Bus signal for removal

3430

2819

if use_dbus:

3431

mandos_dbus_service.client_removed_signal(client)

2820

# Emit D-Bus signal

2821

mandos_dbus_service.ClientRemoved(client

2822

.dbus_object_path,

2823

client.name)

3432

2824

client_settings.clear()

3433

2825

3434

2826

atexit.register(cleanup)

3435

3436

for client in tcp_server.clients.values():

2827

2828

for client in tcp_server.clients.itervalues():

3437

2829

if use_dbus:

3438

# Emit D-Bus signal for adding

3439

mandos_dbus_service.client_added_signal(client)

2830

# Emit D-Bus signal

2831

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

2832

# Need to initiate checking of clients

3441

2833

if client.enabled:

3442

2834

client.init_checker()

3443

2835

3444

2836

tcp_server.enable()

3445

2837

tcp_server.server_activate()

3446

2838

3447

2839

# Find out what port we got

3448

2840

if zeroconf:

3449

2841

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

3454

2846

else: # IPv4

3455

2847

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

3456

2848

*tcp_server.socket.getsockname())

3457

3458

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

3459

2849

2850

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

2851

3460

2852

try:

3461

2853

if zeroconf:

3462

2854

# From the Avahi example code

3467

2859

cleanup()

3468

2860

sys.exit(1)

3469

2861

# End of Avahi example code

3470

3471

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

3472

lambda *args, **kwargs:

3473

(tcp_server.handle_request

3474

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

3475

2862

2863

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

2864

lambda *args, **kwargs:

2865

(tcp_server.handle_request

2866

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

2867

3476

2868

logger.debug("Starting main loop")

3477

2869

main_loop.run()

3478

2870

except AvahiError as error:

3487

2879

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

3488

2880

cleanup()

3489

2881

3490

3491

2882

if __name__ == '__main__':

3492

2883

main()