/mandos/release : revision 237.7.471

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

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

#

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

# This program is distributed in the hope that it will be useful,

23

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

24

# Mandos is distributed in the hope that it will be useful, but

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

# 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

# along with Mandos. If not, see <http://www.gnu.org/licenses/>.

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

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

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

90

114

91

115

if sys.version_info.major == 2:

92

116

str = unicode

93

117

94

version = "1.6.9"

118

version = "1.7.16"

95

119

stored_state_file = "clients.pickle"

96

120

97

121

logger = logging.getLogger()

98

122

syslogger = None

99

123

100

124

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

104

127

except (OSError, AttributeError):

128

105

129

def if_nametoindex(interface):

106

130

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

107

131

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

112

136

return interface_index

113

137

114

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

115

155

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

116

156

"""init logger and add loglevel"""

117

157

118

158

global syslogger

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

123

162

syslogger.setFormatter(logging.Formatter

124

163

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

125

164

' %(message)s'))

126

165

logger.addHandler(syslogger)

127

166

128

167

if debug:

129

168

console = logging.StreamHandler()

130

169

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

142

181

143

182

class PGPEngine(object):

144

183

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

184

145

185

def __init__(self):

146

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

147

198

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

199

'--homedir', self.tempdir,

149

200

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

201

'--quiet']

202

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

203

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

204

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

205

153

206

def __enter__(self):

154

207

return self

155

208

156

209

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

157

210

self._cleanup()

158

211

return False

159

212

160

213

def __del__(self):

161

214

self._cleanup()

162

215

163

216

def _cleanup(self):

164

217

if self.tempdir is not None:

165

218

# Delete contents of tempdir

166

219

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

167

topdown = False):

220

topdown=False):

168

221

for filename in files:

169

222

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

170

223

for dirname in dirs:

172

225

# Remove tempdir

173

226

os.rmdir(self.tempdir)

174

227

self.tempdir = None

175

228

176

229

def password_encode(self, password):

177

230

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

178

231

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

183

236

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

184

237

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

185

238

return encoded

186

239

187

240

def encrypt(self, data, password):

188

241

passphrase = self.password_encode(password)

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

191

244

passfile.write(passphrase)

192

245

passfile.flush()

193

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

246

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

194

247

'--passphrase-file',

195

248

passfile.name]

196

249

+ self.gnupgargs,

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

201

254

if proc.returncode != 0:

202

255

raise PGPError(err)

203

256

return ciphertext

204

257

205

258

def decrypt(self, data, password):

206

259

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

209

262

passfile.write(passphrase)

210

263

passfile.flush()

211

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

264

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

212

265

'--passphrase-file',

213

266

passfile.name]

214

267

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

220

272

if proc.returncode != 0:

221

273

raise PGPError(err)

222

274

return decrypted_plaintext

223

275

224

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

225

304

class AvahiError(Exception):

226

305

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

227

306

self.value = value

228

307

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

229

308

**kwargs)

230

309

310

231

311

class AvahiServiceError(AvahiError):

232

312

pass

233

313

314

234

315

class AvahiGroupError(AvahiError):

235

316

pass

236

317

237

318

238

319

class AvahiService(object):

239

320

"""An Avahi (Zeroconf) service.

240

321

241

322

Attributes:

242

323

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

243

324

Used to optionally bind to the specified interface.

255

336

server: D-Bus Server

256

337

bus: dbus.SystemBus()

257

338

"""

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

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

263

351

self.interface = interface

264

352

self.name = name

265

353

self.type = servicetype

274

362

self.server = None

275

363

self.bus = bus

276

364

self.entry_group_state_changed_match = None

277

365

278

366

def rename(self, remove=True):

279

367

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

280

368

if self.rename_count >= self.max_renames:

282

370

" after %i retries, exiting.",

283

371

self.rename_count)

284

372

raise AvahiServiceError("Too many renames")

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

287

375

self.rename_count += 1

288

376

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

289

377

self.name)

300

388

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

301

389

self.cleanup()

302

390

os._exit(1)

303

391

304

392

def remove(self):

305

393

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

306

394

if self.entry_group_state_changed_match is not None:

308

396

self.entry_group_state_changed_match = None

309

397

if self.group is not None:

310

398

self.group.Reset()

311

399

312

400

def add(self):

313

401

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

314

402

self.remove()

331

419

dbus.UInt16(self.port),

332

420

avahi.string_array_to_txt_array(self.TXT))

333

421

self.group.Commit()

334

422

335

423

def entry_group_state_changed(self, state, error):

336

424

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

337

425

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

338

426

339

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

340

428

logger.debug("Zeroconf service established.")

341

429

elif state == avahi.ENTRY_GROUP_COLLISION:

344

432

elif state == avahi.ENTRY_GROUP_FAILURE:

345

433

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

346

434

str(error))

347

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

348

.format(error))

349

435

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

436

350

437

def cleanup(self):

351

438

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

352

439

if self.group is not None:

357

444

pass

358

445

self.group = None

359

446

self.remove()

360

447

361

448

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

362

449

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

363

450

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

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

371

457

if state in bad_states:

372

458

if bad_states[state] is not None:

373

459

if error is None:

376

462

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

377

463

self.cleanup()

378

464

elif state == avahi.SERVER_RUNNING:

379

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

380

477

else:

381

478

if error is None:

382

479

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

383

480

else:

384

481

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

385

482

386

483

def activate(self):

387

484

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

388

485

if self.server is None:

392

489

follow_name_owner_changes=True),

393

490

avahi.DBUS_INTERFACE_SERVER)

394

491

self.server.connect_to_signal("StateChanged",

395

self.server_state_changed)

492

self.server_state_changed)

396

493

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

397

494

398

495

399

496

class AvahiServiceToSyslog(AvahiService):

400

497

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

401

498

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

402

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

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

499

ret = super(AvahiServiceToSyslog, self).rename(self, *args,

500

**kwargs)

501

syslogger.setFormatter(logging.Formatter(

502

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

503

.format(self.name)))

407

504

return ret

408

505

409

506

507

# Pretend that we have a GnuTLS module

508

class GnuTLS(object):

509

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

510

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

511

512

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

513

if library is None:

514

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

515

_library = ctypes.cdll.LoadLibrary(library)

516

del library

517

_need_version = b"3.3.0"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CLIENT = 2

535

SHUT_RDWR = 0

536

CRD_CERTIFICATE = 1

537

E_NO_CERTIFICATE_FOUND = -49

538

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

539

540

# Types

541

class session_int(ctypes.Structure):

542

_fields_ = []

543

session_t = ctypes.POINTER(session_int)

544

545

class certificate_credentials_st(ctypes.Structure):

546

_fields_ = []

547

certificate_credentials_t = ctypes.POINTER(

548

certificate_credentials_st)

549

certificate_type_t = ctypes.c_int

550

551

class datum_t(ctypes.Structure):

552

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

553

('size', ctypes.c_uint)]

554

555

class openpgp_crt_int(ctypes.Structure):

556

_fields_ = []

557

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

558

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

559

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

560

credentials_type_t = ctypes.c_int

561

transport_ptr_t = ctypes.c_void_p

562

close_request_t = ctypes.c_int

563

564

# Exceptions

565

class Error(Exception):

566

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

567

# exception might be raised from within GnuTLS.__init__,

568

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

569

# global variable has happened.

570

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

571

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

572

# code is passed, convert it to a string with

573

# gnutls.strerror()

574

self.code = code

575

if message is None and code is not None:

576

message = GnuTLS.strerror(code)

577

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

578

message, *args)

579

580

class CertificateSecurityError(Error):

581

pass

582

583

# Classes

584

class Credentials(object):

585

def __init__(self):

586

self._c_object = gnutls.certificate_credentials_t()

587

gnutls.certificate_allocate_credentials(

588

ctypes.byref(self._c_object))

589

self.type = gnutls.CRD_CERTIFICATE

590

591

def __del__(self):

592

gnutls.certificate_free_credentials(self._c_object)

593

594

class ClientSession(object):

595

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

596

self._c_object = gnutls.session_t()

597

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

598

gnutls.set_default_priority(self._c_object)

599

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

600

gnutls.handshake_set_private_extensions(self._c_object,

601

True)

602

self.socket = socket

603

if credentials is None:

604

credentials = gnutls.Credentials()

605

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

606

ctypes.cast(credentials._c_object,

607

ctypes.c_void_p))

608

self.credentials = credentials

609

610

def __del__(self):

611

gnutls.deinit(self._c_object)

612

613

def handshake(self):

614

return gnutls.handshake(self._c_object)

615

616

def send(self, data):

617

data = bytes(data)

618

data_len = len(data)

619

while data_len > 0:

620

data_len -= gnutls.record_send(self._c_object,

621

data[-data_len:],

622

data_len)

623

624

def bye(self):

625

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

626

627

# Error handling functions

628

def _error_code(result):

629

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

630

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

631

if result >= 0:

632

return result

633

if result == gnutls.E_NO_CERTIFICATE_FOUND:

634

raise gnutls.CertificateSecurityError(code=result)

635

raise gnutls.Error(code=result)

636

637

def _retry_on_error(result, func, arguments):

638

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

639

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

640

while result < 0:

641

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

642

return _error_code(result)

643

result = func(*arguments)

644

return result

645

646

# Unless otherwise indicated, the function declarations below are

647

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

648

649

# Functions

650

priority_set_direct = _library.gnutls_priority_set_direct

651

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

652

ctypes.POINTER(ctypes.c_char_p)]

653

priority_set_direct.restype = _error_code

654

655

init = _library.gnutls_init

656

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

657

init.restype = _error_code

658

659

set_default_priority = _library.gnutls_set_default_priority

660

set_default_priority.argtypes = [session_t]

661

set_default_priority.restype = _error_code

662

663

record_send = _library.gnutls_record_send

664

record_send.argtypes = [session_t, ctypes.c_void_p,

665

ctypes.c_size_t]

666

record_send.restype = ctypes.c_ssize_t

667

record_send.errcheck = _retry_on_error

668

669

certificate_allocate_credentials = (

670

_library.gnutls_certificate_allocate_credentials)

671

certificate_allocate_credentials.argtypes = [

672

ctypes.POINTER(certificate_credentials_t)]

673

certificate_allocate_credentials.restype = _error_code

674

675

certificate_free_credentials = (

676

_library.gnutls_certificate_free_credentials)

677

certificate_free_credentials.argtypes = [

678

certificate_credentials_t]

679

certificate_free_credentials.restype = None

680

681

handshake_set_private_extensions = (

682

_library.gnutls_handshake_set_private_extensions)

683

handshake_set_private_extensions.argtypes = [session_t,

684

ctypes.c_int]

685

handshake_set_private_extensions.restype = None

686

687

credentials_set = _library.gnutls_credentials_set

688

credentials_set.argtypes = [session_t, credentials_type_t,

689

ctypes.c_void_p]

690

credentials_set.restype = _error_code

691

692

strerror = _library.gnutls_strerror

693

strerror.argtypes = [ctypes.c_int]

694

strerror.restype = ctypes.c_char_p

695

696

certificate_type_get = _library.gnutls_certificate_type_get

697

certificate_type_get.argtypes = [session_t]

698

certificate_type_get.restype = _error_code

699

700

certificate_get_peers = _library.gnutls_certificate_get_peers

701

certificate_get_peers.argtypes = [session_t,

702

ctypes.POINTER(ctypes.c_uint)]

703

certificate_get_peers.restype = ctypes.POINTER(datum_t)

704

705

global_set_log_level = _library.gnutls_global_set_log_level

706

global_set_log_level.argtypes = [ctypes.c_int]

707

global_set_log_level.restype = None

708

709

global_set_log_function = _library.gnutls_global_set_log_function

710

global_set_log_function.argtypes = [log_func]

711

global_set_log_function.restype = None

712

713

deinit = _library.gnutls_deinit

714

deinit.argtypes = [session_t]

715

deinit.restype = None

716

717

handshake = _library.gnutls_handshake

718

handshake.argtypes = [session_t]

719

handshake.restype = _error_code

720

handshake.errcheck = _retry_on_error

721

722

transport_set_ptr = _library.gnutls_transport_set_ptr

723

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

724

transport_set_ptr.restype = None

725

726

bye = _library.gnutls_bye

727

bye.argtypes = [session_t, close_request_t]

728

bye.restype = _error_code

729

bye.errcheck = _retry_on_error

730

731

check_version = _library.gnutls_check_version

732

check_version.argtypes = [ctypes.c_char_p]

733

check_version.restype = ctypes.c_char_p

734

735

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

736

737

openpgp_crt_init = _library.gnutls_openpgp_crt_init

738

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

739

openpgp_crt_init.restype = _error_code

740

741

openpgp_crt_import = _library.gnutls_openpgp_crt_import

742

openpgp_crt_import.argtypes = [openpgp_crt_t,

743

ctypes.POINTER(datum_t),

744

openpgp_crt_fmt_t]

745

openpgp_crt_import.restype = _error_code

746

747

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

748

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

749

ctypes.POINTER(ctypes.c_uint)]

750

openpgp_crt_verify_self.restype = _error_code

751

752

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

753

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

754

openpgp_crt_deinit.restype = None

755

756

openpgp_crt_get_fingerprint = (

757

_library.gnutls_openpgp_crt_get_fingerprint)

758

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

759

ctypes.c_void_p,

760

ctypes.POINTER(

761

ctypes.c_size_t)]

762

openpgp_crt_get_fingerprint.restype = _error_code

763

764

# Remove non-public functions

765

del _error_code, _retry_on_error

766

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

767

gnutls = GnuTLS()

768

769

770

def call_pipe(connection, # : multiprocessing.Connection

771

func, *args, **kwargs):

772

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

773

774

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

775

return value on the provided multiprocessing.Connection.

776

"""

777

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

778

connection.close()

779

780

410

781

class Client(object):

411

782

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

412

783

413

784

Attributes:

414

785

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

415

786

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

417

788

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

418

789

to see if the client lives.

419

790

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

791

checker_callback_tag: a GLib event source tag, or None

421

792

checker_command: string; External command which is run to check

422

793

if client lives. %() expansions are done at

423

794

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

424

795

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

425

checker_initiator_tag: a gobject event source tag, or None

796

checker_initiator_tag: a GLib event source tag, or None

426

797

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

427

798

client_structure: Object describing what attributes a client has

428

799

and is used for storing the client at exit

429

800

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

801

disable_initiator_tag: a GLib event source tag, or None

431

802

enabled: bool()

432

803

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

433

804

uniquely identify the client

438

809

last_checker_status: integer between 0 and 255 reflecting exit

439

810

status of last checker. -1 reflects crashed

440

811

checker, -2 means no checker completed yet.

812

last_checker_signal: The signal which killed the last checker, if

813

last_checker_status is -1

441

814

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

442

815

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

443

816

D-Bus identifiers

450

823

disabled, or None

451

824

server_settings: The server_settings dict from main()

452

825

"""

453

826

454

827

runtime_expansions = ("approval_delay", "approval_duration",

455

828

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

456

829

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

457

830

"last_approval_request", "last_checked_ok",

458

831

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

832

client_defaults = {

833

"timeout": "PT5M",

834

"extended_timeout": "PT15M",

835

"interval": "PT2M",

836

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

837

"host": "",

838

"approval_delay": "PT0S",

839

"approval_duration": "PT1S",

840

"approved_by_default": "True",

841

"enabled": "True",

842

}

843

470

844

@staticmethod

471

845

def config_parser(config):

472

846

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

479

853

for client_name in config.sections():

480

854

section = dict(config.items(client_name))

481

855

client = settings[client_name] = {}

482

856

483

857

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

484

858

# Reformat values from string types to Python types

485

859

client["approved_by_default"] = config.getboolean(

486

860

client_name, "approved_by_default")

487

861

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

488

862

"enabled")

489

863

490

864

# Uppercase and remove spaces from fingerprint for later

491

865

# comparison purposes with return value from the

492

866

# fingerprint() function

493

867

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

494

868

.replace(" ", ""))

495

869

if "secret" in section:

496

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

870

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

871

.encode("utf-8"),

872

"base64")

497

873

elif "secfile" in section:

498

874

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

499

875

(section["secfile"])),

514

890

client["last_approval_request"] = None

515

891

client["last_checked_ok"] = None

516

892

client["last_checker_status"] = -2

517

893

518

894

return settings

519

520

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

895

896

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

521

897

self.name = name

522

898

if server_settings is None:

523

899

server_settings = {}

525

901

# adding all client settings

526

902

for setting, value in settings.items():

527

903

setattr(self, setting, value)

528

904

529

905

if self.enabled:

530

906

if not hasattr(self, "last_enabled"):

531

907

self.last_enabled = datetime.datetime.utcnow()

535

911

else:

536

912

self.last_enabled = None

537

913

self.expires = None

538

914

539

915

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

540

916

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

541

917

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

542

918

datetime.datetime.utcnow())

543

919

544

920

# attributes specific for this server instance

545

921

self.checker = None

546

922

self.checker_initiator_tag = None

549

925

self.current_checker_command = None

550

926

self.approved = None

551

927

self.approvals_pending = 0

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

928

self.changedstate = multiprocessing_manager.Condition(

929

multiprocessing_manager.Lock())

930

self.client_structure = [attr

931

for attr in self.__dict__.keys()

557

932

if not attr.startswith("_")]

558

933

self.client_structure.append("client_structure")

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

934

935

for name, t in inspect.getmembers(

936

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

564

937

if not name.startswith("_"):

565

938

self.client_structure.append(name)

566

939

567

940

# Send notice to process children that client state has changed

568

941

def send_changedstate(self):

569

942

with self.changedstate:

570

943

self.changedstate.notify_all()

571

944

572

945

def enable(self):

573

946

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

574

947

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

579

952

self.last_enabled = datetime.datetime.utcnow()

580

953

self.init_checker()

581

954

self.send_changedstate()

582

955

583

956

def disable(self, quiet=True):

584

957

"""Disable this client."""

585

958

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

587

960

if not quiet:

588

961

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

589

962

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

590

gobject.source_remove(self.disable_initiator_tag)

963

GLib.source_remove(self.disable_initiator_tag)

591

964

self.disable_initiator_tag = None

592

965

self.expires = None

593

966

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

594

gobject.source_remove(self.checker_initiator_tag)

967

GLib.source_remove(self.checker_initiator_tag)

595

968

self.checker_initiator_tag = None

596

969

self.stop_checker()

597

970

self.enabled = False

598

971

if not quiet:

599

972

self.send_changedstate()

600

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

973

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

601

974

return False

602

975

603

976

def __del__(self):

604

977

self.disable()

605

978

606

979

def init_checker(self):

607

980

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

608

981

# and every interval from then on.

609

982

if self.checker_initiator_tag is not None:

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

985

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

986

self.start_checker)

615

987

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

616

988

if self.disable_initiator_tag is not None:

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

991

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

622

992

# Also start a new checker *right now*.

623

993

self.start_checker()

624

625

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

994

995

def checker_callback(self, source, condition, connection,

996

command):

626

997

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

627

998

self.checker_callback_tag = None

628

999

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1000

# Read return code from connection (see call_pipe)

1001

returncode = connection.recv()

1002

connection.close()

1003

1004

if returncode >= 0:

1005

self.last_checker_status = returncode

1006

self.last_checker_signal = None

631

1007

if self.last_checker_status == 0:

632

1008

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

633

1009

vars(self))

634

1010

self.checked_ok()

635

1011

else:

636

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

637

vars(self))

1012

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

638

1013

else:

639

1014

self.last_checker_status = -1

1015

self.last_checker_signal = -returncode

640

1016

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

641

1017

vars(self))

642

1018

return False

1019

643

1020

def checked_ok(self):

644

1021

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

645

1022

self.last_checked_ok = datetime.datetime.utcnow()

646

1023

self.last_checker_status = 0

1024

self.last_checker_signal = None

647

1025

self.bump_timeout()

648

1026

649

1027

def bump_timeout(self, timeout=None):

650

1028

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

651

1029

if timeout is None:

652

1030

timeout = self.timeout

653

1031

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1032

GLib.source_remove(self.disable_initiator_tag)

655

1033

self.disable_initiator_tag = None

656

1034

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

660

1037

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

661

1038

662

1039

def need_approval(self):

663

1040

self.last_approval_request = datetime.datetime.utcnow()

664

1041

665

1042

def start_checker(self):

666

1043

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

667

1044

668

1045

If a checker already exists, leave it running and do

669

1046

nothing."""

670

1047

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

675

1052

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

676

1053

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

677

1054

# should be.

678

679

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

680

try:

681

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

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1055

1056

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

1057

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

1058

self.checker.join()

1059

self.checker = None

693

1060

# Start a new checker if needed

694

1061

if self.checker is None:

695

1062

# Escape attributes for the shell

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1063

escaped_attrs = {

1064

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

1065

for attr in self.runtime_expansions}

699

1066

try:

700

1067

command = self.checker_command % escaped_attrs

701

1068

except TypeError as error:

702

1069

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1070

self.checker_command,

1071

exc_info=error)

1072

return True # Try again later

705

1073

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

721

self.checker = subprocess.Popen(command,

722

close_fds=True,

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

747

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

1074

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

1075

self.name)

1076

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

1077

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

1078

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

1079

# always replaced by /dev/null.)

1080

# The exception is when not debugging but nevertheless

1081

# running in the foreground; use the previously

1082

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

1086

if (not self.server_settings["debug"]

1087

and self.server_settings["foreground"]):

1088

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

1091

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

1095

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

1098

self.checker_callback, pipe[0], command)

1099

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

748

1100

return True

749

1101

750

1102

def stop_checker(self):

751

1103

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

752

1104

if self.checker_callback_tag:

753

gobject.source_remove(self.checker_callback_tag)

1105

GLib.source_remove(self.checker_callback_tag)

754

1106

self.checker_callback_tag = None

755

1107

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

756

1108

return

757

1109

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

758

try:

759

self.checker.terminate()

760

#time.sleep(0.5)

761

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

762

# self.checker.kill()

763

except OSError as error:

764

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

765

raise

1110

self.checker.terminate()

766

1111

self.checker = None

767

1112

768

1113

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1114

def dbus_service_property(dbus_interface,

1115

signature="v",

1116

access="readwrite",

1117

byte_arrays=False):

771

1118

"""Decorators for marking methods of a DBusObjectWithProperties to

772

1119

become properties on the D-Bus.

773

1120

774

1121

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

775

1122

and with one argument by "Set".

776

1123

777

1124

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

778

1125

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

779

1126

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

783

1130

if byte_arrays and signature != "ay":

784

1131

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

785

1132

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

1133

786

1134

def decorator(func):

787

1135

func._dbus_is_property = True

788

1136

func._dbus_interface = dbus_interface

791

1139

func._dbus_name = func.__name__

792

1140

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

793

1141

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

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

795

1143

return func

1144

796

1145

return decorator

797

1146

798

1147

799

1148

def dbus_interface_annotations(dbus_interface):

800

1149

"""Decorator for marking functions returning interface annotations

801

1150

802

1151

Usage:

803

1152

804

1153

@dbus_interface_annotations("org.example.Interface")

805

1154

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

806

1155

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

807

1156

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

808

1157

"false"}

809

1158

"""

1159

810

1160

def decorator(func):

811

1161

func._dbus_is_interface = True

812

1162

func._dbus_interface = dbus_interface

813

1163

func._dbus_name = dbus_interface

814

1164

return func

1165

815

1166

return decorator

816

1167

817

1168

818

1169

def dbus_annotations(annotations):

819

1170

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

820

1171

Usage:

821

1172

822

1173

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

823

1174

"org.freedesktop.DBus.Property."

824

1175

"EmitsChangedSignal": "false"})

826

1177

access="r")

827

1178

def Property_dbus_property(self):

828

1179

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

829

1182

"""

1183

830

1184

def decorator(func):

831

1185

func._dbus_annotations = annotations

832

1186

return func

1187

833

1188

return decorator

834

1189

835

1190

838

1193

"""

839

1194

pass

840

1195

1196

841

1197

class DBusPropertyAccessException(DBusPropertyException):

842

1198

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

843

1199

"""

850

1206

pass

851

1207

852

1208

853

class DBusObjectWithProperties(dbus.service.Object):

854

"""A D-Bus object with properties.

855

856

Classes inheriting from this can use the dbus_service_property

857

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

858

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

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

859

1214

"""

860

1215

861

1216

@staticmethod

862

1217

def _is_dbus_thing(thing):

863

1218

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

864

1219

865

1220

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

866

1221

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

867

1222

"""

868

1223

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

869

1224

False)

870

1225

871

1226

def _get_all_dbus_things(self, thing):

872

1227

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

873

1228

"""

874

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

875

name),

1229

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

876

1230

athing.__get__(self))

877

1231

for cls in self.__class__.__mro__

878

1232

for name, athing in

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1233

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

1234

1235

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1236

out_signature="s",

1237

path_keyword='object_path',

1238

connection_keyword='connection')

1239

def Introspect(self, object_path, connection):

1240

"""Overloading of standard D-Bus method.

1241

1242

Inserts annotation tags on methods and signals.

1243

"""

1244

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

1245

connection)

1246

try:

1247

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

1248

1249

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

1250

# Add annotation tags

1251

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

1252

for tag in if_tag.getElementsByTagName(typ):

1253

annots = dict()

1254

for name, prop in (self.

1255

_get_all_dbus_things(typ)):

1256

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

1257

and prop._dbus_interface

1258

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

1259

annots.update(getattr(

1260

prop, "_dbus_annotations", {}))

1261

for name, value in annots.items():

1262

ann_tag = document.createElement(

1263

"annotation")

1264

ann_tag.setAttribute("name", name)

1265

ann_tag.setAttribute("value", value)

1266

tag.appendChild(ann_tag)

1267

# Add interface annotation tags

1268

for annotation, value in dict(

1269

itertools.chain.from_iterable(

1270

annotations().items()

1271

for name, annotations

1272

in self._get_all_dbus_things("interface")

1273

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

1274

)).items():

1275

ann_tag = document.createElement("annotation")

1276

ann_tag.setAttribute("name", annotation)

1277

ann_tag.setAttribute("value", value)

1278

if_tag.appendChild(ann_tag)

1279

# Fix argument name for the Introspect method itself

1280

if (if_tag.getAttribute("name")

1281

== dbus.INTROSPECTABLE_IFACE):

1282

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

1283

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

1284

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

1285

if (arg.getAttribute("direction")

1286

== "out"):

1287

arg.setAttribute("name",

1288

"xml_data")

1289

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

1290

document.unlink()

1291

except (AttributeError, xml.dom.DOMException,

1292

xml.parsers.expat.ExpatError) as error:

1293

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

1294

exc_info=error)

1295

return xmlstring

1296

1297

1298

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1299

"""A D-Bus object with properties.

1300

1301

Classes inheriting from this can use the dbus_service_property

1302

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

1303

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

1304

"""

1305

882

1306

def _get_dbus_property(self, interface_name, property_name):

883

1307

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

884

1308

property with the specified name and interface.

885

1309

"""

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1310

for cls in self.__class__.__mro__:

1311

for name, value in inspect.getmembers(

1312

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

890

1313

if (value._dbus_name == property_name

891

1314

and value._dbus_interface == interface_name):

892

1315

return value.__get__(self)

893

1316

894

1317

# No such property

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1318

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

1319

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

1330

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

in_signature="ss",

900

1332

out_signature="v")

901

1333

def Get(self, interface_name, property_name):

902

1334

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

908

1340

if not hasattr(value, "variant_level"):

909

1341

return value

910

1342

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

911

1343

912

1344

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

913

1345

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

914

1346

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

926

1358

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

927

1359

for byte in value))

928

1360

prop(value)

929

930

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

1361

1362

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

in_signature="s",

931

1364

out_signature="a{sv}")

932

1365

def GetAll(self, interface_name):

933

1366

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

934

1367

standard.

935

1368

936

1369

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

937

1370

"""

938

1371

properties = {}

948

1381

if not hasattr(value, "variant_level"):

949

1382

properties[name] = value

950

1383

continue

951

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

952

value.variant_level+1)

1384

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

953

1386

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

954

1387

955

1388

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

956

1389

def PropertiesChanged(self, interface_name, changed_properties,

957

1390

invalidated_properties):

959

1392

standard.

960

1393

"""

961

1394

pass

962

1395

963

1396

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

964

1397

out_signature="s",

965

1398

path_keyword='object_path',

966

1399

connection_keyword='connection')

967

1400

def Introspect(self, object_path, connection):

968

1401

"""Overloading of standard D-Bus method.

969

1402

970

1403

Inserts property tags and interface annotation tags.

971

1404

"""

972

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

973

connection)

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

974

1408

try:

975

1409

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

1410

976

1411

def make_tag(document, name, prop):

977

1412

e = document.createElement("property")

978

1413

e.setAttribute("name", name)

979

1414

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

980

1415

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

981

1416

return e

1417

982

1418

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

983

1419

# Add property tags

984

1420

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

987

1423

if prop._dbus_interface

988

1424

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

989

1425

if_tag.appendChild(tag)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

1021

1442

# Add the names to the return values for the

1022

1443

# "org.freedesktop.DBus.Properties" methods

1023

1444

if (if_tag.getAttribute("name")

1042

1463

return xmlstring

1043

1464

1044

1465

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1045

1537

def datetime_to_dbus(dt, variant_level=0):

1046

1538

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

1047

1539

if dt is None:

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1540

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

1541

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

1051

1542

1052

1543

1053

1544

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1055

1546

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

1056

1547

interface names according to the "alt_interface_names" mapping.

1057

1548

Usage:

1058

1549

1059

1550

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

1060

1551

"net.example.AlternateInterface"})

1061

1552

class SampleDBusObject(dbus.service.Object):

1062

1553

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

1063

1554

def SampleDBusMethod():

1064

1555

pass

1065

1556

1066

1557

The above "SampleDBusMethod" on "SampleDBusObject" will be

1067

1558

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

1068

1559

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

1069

1560

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

1070

1561

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

1071

1562

1072

1563

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

1073

1564

(from DBusObjectWithProperties) and interfaces (from the

1074

1565

dbus_interface_annotations decorator).

1075

1566

"""

1567

1076

1568

def wrapper(cls):

1077

1569

for orig_interface_name, alt_interface_name in (

1078

alt_interface_names.items()):

1570

alt_interface_names.items()):

1079

1571

attr = {}

1080

1572

interface_names = set()

1081

1573

# Go though all attributes of the class

1083

1575

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

1084

1576

# with the wrong interface name

1085

1577

if (not hasattr(attribute, "_dbus_interface")

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1578

or not attribute._dbus_interface.startswith(

1579

orig_interface_name)):

1088

1580

continue

1089

1581

# Create an alternate D-Bus interface name based on

1090

1582

# the current name

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1583

alt_interface = attribute._dbus_interface.replace(

1584

orig_interface_name, alt_interface_name)

1094

1585

interface_names.add(alt_interface)

1095

1586

# Is this a D-Bus signal?

1096

1587

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

1097

1588

# Extract the original non-method undecorated

1098

1589

# function by black magic

1099

nonmethod_func = (dict(

1590

if sys.version_info.major == 2:

1591

nonmethod_func = (dict(

1100

1592

zip(attribute.func_code.co_freevars,

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1593

attribute.__closure__))

1594

["func"].cell_contents)

1595

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1103

1600

# Create a new, but exactly alike, function

1104

1601

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

1105

1602

# with the alternate D-Bus interface name

1106

new_function = (dbus.service.signal

1107

(alt_interface,

1108

attribute._dbus_signature)

1109

(types.FunctionType(

1110

nonmethod_func.func_code,

1111

nonmethod_func.func_globals,

1112

nonmethod_func.func_name,

1113

nonmethod_func.func_defaults,

1114

nonmethod_func.func_closure)))

1603

new_function = copy_function(nonmethod_func)

1604

new_function = (dbus.service.signal(

1605

alt_interface,

1606

attribute._dbus_signature)(new_function))

1115

1607

# Copy annotations, if any

1116

1608

try:

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1609

new_function._dbus_annotations = dict(

1610

attribute._dbus_annotations)

1119

1611

except AttributeError:

1120

1612

pass

1613

1121

1614

# Define a creator of a function to call both the

1122

1615

# original and alternate functions, so both the

1123

1616

# original and alternate signals gets sent when

1126

1619

"""This function is a scope container to pass

1127

1620

func1 and func2 to the "call_both" function

1128

1621

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1129

1624

def call_both(*args, **kwargs):

1130

1625

"""This function will emit two D-Bus

1131

1626

signals by calling func1 and func2"""

1132

1627

func1(*args, **kwargs)

1133

1628

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1134

1635

return call_both

1135

1636

# Create the "call_both" function and add it to

1136

1637

# the class

1141

1642

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

1142

1643

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

1143

1644

# to the class.

1144

attr[attrname] = (dbus.service.method

1145

(alt_interface,

1146

attribute._dbus_in_signature,

1147

attribute._dbus_out_signature)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1645

attr[attrname] = (

1646

dbus.service.method(

1647

alt_interface,

1648

attribute._dbus_in_signature,

1649

attribute._dbus_out_signature)

1650

(copy_function(attribute)))

1154

1651

# Copy annotations, if any

1155

1652

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1653

attr[attrname]._dbus_annotations = dict(

1654

attribute._dbus_annotations)

1158

1655

except AttributeError:

1159

1656

pass

1160

1657

# Is this a D-Bus property?

1163

1660

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

1164

1661

# property with the alternate D-Bus interface

1165

1662

# name. Add it to the class.

1166

attr[attrname] = (dbus_service_property

1167

(alt_interface,

1168

attribute._dbus_signature,

1169

attribute._dbus_access,

1170

attribute

1171

._dbus_get_args_options

1172

["byte_arrays"])

1173

(types.FunctionType

1174

(attribute.func_code,

1175

attribute.func_globals,

1176

attribute.func_name,

1177

attribute.func_defaults,

1178

attribute.func_closure)))

1663

attr[attrname] = (dbus_service_property(

1664

alt_interface, attribute._dbus_signature,

1665

attribute._dbus_access,

1666

attribute._dbus_get_args_options

1667

["byte_arrays"])

1668

(copy_function(attribute)))

1179

1669

# Copy annotations, if any

1180

1670

try:

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1671

attr[attrname]._dbus_annotations = dict(

1672

attribute._dbus_annotations)

1183

1673

except AttributeError:

1184

1674

pass

1185

1675

# Is this a D-Bus interface?

1188

1678

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

1189

1679

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

1190

1680

# to the class.

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1681

attr[attrname] = (

1682

dbus_interface_annotations(alt_interface)

1683

(copy_function(attribute)))

1199

1684

if deprecate:

1200

1685

# Deprecate all alternate interfaces

1201

iname="_AlternateDBusNames_interface_annotation{}"

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1202

1687

for interface_name in interface_names:

1688

1203

1689

@dbus_interface_annotations(interface_name)

1204

1690

def func(self):

1205

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

1206

"true" }

1691

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

1692

"true"}

1207

1693

# Find an unused name

1208

1694

for aname in (iname.format(i)

1209

1695

for i in itertools.count()):

1213

1699

if interface_names:

1214

1700

# Replace the class with a new subclass of it with

1215

1701

# methods, signals, etc. as created above.

1216

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

1217

(cls,), attr)

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1218

1708

return cls

1709

1219

1710

return wrapper

1220

1711

1221

1712

1222

1713

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

1223

"se.bsnet.fukt.Mandos"})

1714

"se.bsnet.fukt.Mandos"})

1224

1715

class ClientDBus(Client, DBusObjectWithProperties):

1225

1716

"""A Client class using D-Bus

1226

1717

1227

1718

Attributes:

1228

1719

dbus_object_path: dbus.ObjectPath

1229

1720

bus: dbus.SystemBus()

1230

1721

"""

1231

1722

1232

1723

runtime_expansions = (Client.runtime_expansions

1233

+ ("dbus_object_path",))

1234

1724

+ ("dbus_object_path", ))

1725

1235

1726

_interface = "se.recompile.Mandos.Client"

1236

1727

1237

1728

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

1238

1239

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

1729

1730

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

1240

1731

self.bus = bus

1241

1732

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

1242

1733

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

1244

1735

client_object_name = str(self.name).translate(

1245

1736

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

1246

1737

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

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1738

self.dbus_object_path = dbus.ObjectPath(

1739

"/clients/" + client_object_name)

1249

1740

DBusObjectWithProperties.__init__(self, self.bus,

1250

1741

self.dbus_object_path)

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1742

1743

def notifychangeproperty(transform_func, dbus_name,

1744

type_func=lambda x: x,

1745

variant_level=1,

1746

invalidate_only=False,

1255

1747

_interface=_interface):

1256

1748

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

1257

1749

its changes to DBus.

1258

1750

1259

1751

transform_fun: Function that takes a value and a variant_level

1260

1752

and transforms it to a D-Bus type.

1261

1753

dbus_name: D-Bus name of the variable

1264

1756

variant_level: D-Bus variant level. Default: 1

1265

1757

"""

1266

1758

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

1759

1267

1760

def setter(self, value):

1268

1761

if hasattr(self, "dbus_object_path"):

1269

1762

if (not hasattr(self, attrname) or

1270

1763

type_func(getattr(self, attrname, None))

1271

1764

!= type_func(value)):

1272

1765

if invalidate_only:

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1766

self.PropertiesChanged(

1767

_interface, dbus.Dictionary(),

1768

dbus.Array((dbus_name, )))

1277

1769

else:

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1770

dbus_value = transform_func(

1771

type_func(value),

1772

variant_level=variant_level)

1281

1773

self.PropertyChanged(dbus.String(dbus_name),

1282

1774

dbus_value)

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1775

self.PropertiesChanged(

1776

_interface,

1777

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

1778

dbus_value}),

1779

dbus.Array())

1287

1780

setattr(self, attrname, value)

1288

1781

1289

1782

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

1290

1783

1291

1784

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1292

1785

approvals_pending = notifychangeproperty(dbus.Boolean,

1293

1786

"ApprovalPending",

1294

type_func = bool)

1787

type_func=bool)

1295

1788

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

1296

1789

last_enabled = notifychangeproperty(datetime_to_dbus,

1297

1790

"LastEnabled")

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1791

checker = notifychangeproperty(

1792

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1301

1794

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1302

1795

"LastCheckedOK")

1303

1796

last_checker_status = notifychangeproperty(dbus.Int16,

1306

1799

datetime_to_dbus, "LastApprovalRequest")

1307

1800

approved_by_default = notifychangeproperty(dbus.Boolean,

1308

1801

"ApprovedByDefault")

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1802

approval_delay = notifychangeproperty(

1803

dbus.UInt64, "ApprovalDelay",

1804

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

1314

1805

approval_duration = notifychangeproperty(

1315

1806

dbus.UInt64, "ApprovalDuration",

1316

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

1807

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

1317

1808

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1809

timeout = notifychangeproperty(

1810

dbus.UInt64, "Timeout",

1811

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

1321

1812

extended_timeout = notifychangeproperty(

1322

1813

dbus.UInt64, "ExtendedTimeout",

1323

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

1324

interval = notifychangeproperty(dbus.UInt64,

1325

"Interval",

1326

type_func =

1327

lambda td: td.total_seconds()

1328

* 1000)

1814

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

1815

interval = notifychangeproperty(

1816

dbus.UInt64, "Interval",

1817

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

1329

1818

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

1330

1819

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

1331

1820

invalidate_only=True)

1332

1821

1333

1822

del notifychangeproperty

1334

1823

1335

1824

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

1336

1825

try:

1337

1826

self.remove_from_connection()

1340

1829

if hasattr(DBusObjectWithProperties, "__del__"):

1341

1830

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

1342

1831

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

1343

1344

def checker_callback(self, pid, condition, command,

1345

*args, **kwargs):

1346

self.checker_callback_tag = None

1347

self.checker = None

1348

if os.WIFEXITED(condition):

1349

exitstatus = os.WEXITSTATUS(condition)

1832

1833

def checker_callback(self, source, condition,

1834

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

1835

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

1836

connection, command, *args,

1837

**kwargs)

1838

exitstatus = self.last_checker_status

1839

if exitstatus >= 0:

1350

1840

# Emit D-Bus signal

1351

1841

self.CheckerCompleted(dbus.Int16(exitstatus),

1352

dbus.Int64(condition),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1353

1844

dbus.String(command))

1354

1845

else:

1355

1846

# Emit D-Bus signal

1356

1847

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

1357

dbus.Int64(condition),

1848

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1358

1852

dbus.String(command))

1359

1360

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

1361

*args, **kwargs)

1362

1853

return ret

1854

1363

1855

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

1364

1856

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

1365

1857

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

1369

1861

# Emit D-Bus signal

1370

1862

self.CheckerStarted(self.current_checker_command)

1371

1863

return r

1372

1864

1373

1865

def _reset_approved(self):

1374

1866

self.approved = None

1375

1867

return False

1376

1868

1377

1869

def approve(self, value=True):

1378

1870

self.approved = value

1379

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

1380

* 1000), self._reset_approved)

1871

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

1872

* 1000), self._reset_approved)

1381

1873

self.send_changedstate()

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1389

1881

# CheckerCompleted - signal

1390

1882

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

1391

1883

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

1392

1884

"D-Bus signal"

1393

1885

pass

1394

1886

1395

1887

# CheckerStarted - signal

1396

1888

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

1397

1889

def CheckerStarted(self, command):

1398

1890

"D-Bus signal"

1399

1891

pass

1400

1892

1401

1893

# PropertyChanged - signal

1402

1894

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

1403

1895

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

1404

1896

def PropertyChanged(self, property, value):

1405

1897

"D-Bus signal"

1406

1898

pass

1407

1899

1408

1900

# GotSecret - signal

1409

1901

@dbus.service.signal(_interface)

1410

1902

def GotSecret(self):

1413

1905

server to mandos-client

1414

1906

"""

1415

1907

pass

1416

1908

1417

1909

# Rejected - signal

1418

1910

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

1419

1911

def Rejected(self, reason):

1420

1912

"D-Bus signal"

1421

1913

pass

1422

1914

1423

1915

# NeedApproval - signal

1424

1916

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

1425

1917

def NeedApproval(self, timeout, default):

1426

1918

"D-Bus signal"

1427

1919

return self.need_approval()

1428

1429

## Methods

1430

1920

1921

# Methods

1922

1431

1923

# Approve - method

1432

1924

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

1433

1925

def Approve(self, value):

1434

1926

self.approve(value)

1435

1927

1436

1928

# CheckedOK - method

1437

1929

@dbus.service.method(_interface)

1438

1930

def CheckedOK(self):

1439

1931

self.checked_ok()

1440

1932

1441

1933

# Enable - method

1934

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

1442

1935

@dbus.service.method(_interface)

1443

1936

def Enable(self):

1444

1937

"D-Bus method"

1445

1938

self.enable()

1446

1939

1447

1940

# StartChecker - method

1941

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

1448

1942

@dbus.service.method(_interface)

1449

1943

def StartChecker(self):

1450

1944

"D-Bus method"

1451

1945

self.start_checker()

1452

1946

1453

1947

# Disable - method

1948

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

1454

1949

@dbus.service.method(_interface)

1455

1950

def Disable(self):

1456

1951

"D-Bus method"

1457

1952

self.disable()

1458

1953

1459

1954

# StopChecker - method

1955

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

1460

1956

@dbus.service.method(_interface)

1461

1957

def StopChecker(self):

1462

1958

self.stop_checker()

1463

1464

## Properties

1465

1959

1960

# Properties

1961

1466

1962

# ApprovalPending - property

1467

1963

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

1468

1964

def ApprovalPending_dbus_property(self):

1469

1965

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

1470

1966

1471

1967

# ApprovedByDefault - property

1472

@dbus_service_property(_interface, signature="b",

1968

@dbus_service_property(_interface,

1969

signature="b",

1473

1970

access="readwrite")

1474

1971

def ApprovedByDefault_dbus_property(self, value=None):

1475

1972

if value is None: # get

1476

1973

return dbus.Boolean(self.approved_by_default)

1477

1974

self.approved_by_default = bool(value)

1478

1975

1479

1976

# ApprovalDelay - property

1480

@dbus_service_property(_interface, signature="t",

1977

@dbus_service_property(_interface,

1978

signature="t",

1481

1979

access="readwrite")

1482

1980

def ApprovalDelay_dbus_property(self, value=None):

1483

1981

if value is None: # get

1484

1982

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

1485

1983

* 1000)

1486

1984

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

1487

1985

1488

1986

# ApprovalDuration - property

1489

@dbus_service_property(_interface, signature="t",

1987

@dbus_service_property(_interface,

1988

signature="t",

1490

1989

access="readwrite")

1491

1990

def ApprovalDuration_dbus_property(self, value=None):

1492

1991

if value is None: # get

1493

1992

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

1494

1993

* 1000)

1495

1994

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

1496

1995

1497

1996

# Name - property

1997

@dbus_annotations(

1998

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

1498

1999

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

1499

2000

def Name_dbus_property(self):

1500

2001

return dbus.String(self.name)

1501

2002

1502

2003

# Fingerprint - property

2004

@dbus_annotations(

2005

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

1503

2006

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

1504

2007

def Fingerprint_dbus_property(self):

1505

2008

return dbus.String(self.fingerprint)

1506

2009

1507

2010

# Host - property

1508

@dbus_service_property(_interface, signature="s",

2011

@dbus_service_property(_interface,

2012

signature="s",

1509

2013

access="readwrite")

1510

2014

def Host_dbus_property(self, value=None):

1511

2015

if value is None: # get

1512

2016

return dbus.String(self.host)

1513

2017

self.host = str(value)

1514

2018

1515

2019

# Created - property

2020

@dbus_annotations(

2021

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

1516

2022

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

1517

2023

def Created_dbus_property(self):

1518

2024

return datetime_to_dbus(self.created)

1519

2025

1520

2026

# LastEnabled - property

1521

2027

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

1522

2028

def LastEnabled_dbus_property(self):

1523

2029

return datetime_to_dbus(self.last_enabled)

1524

2030

1525

2031

# Enabled - property

1526

@dbus_service_property(_interface, signature="b",

2032

@dbus_service_property(_interface,

2033

signature="b",

1527

2034

access="readwrite")

1528

2035

def Enabled_dbus_property(self, value=None):

1529

2036

if value is None: # get

1532

2039

self.enable()

1533

2040

else:

1534

2041

self.disable()

1535

2042

1536

2043

# LastCheckedOK - property

1537

@dbus_service_property(_interface, signature="s",

2044

@dbus_service_property(_interface,

2045

signature="s",

1538

2046

access="readwrite")

1539

2047

def LastCheckedOK_dbus_property(self, value=None):

1540

2048

if value is not None:

1541

2049

self.checked_ok()

1542

2050

return

1543

2051

return datetime_to_dbus(self.last_checked_ok)

1544

2052

1545

2053

# LastCheckerStatus - property

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2054

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

1548

2055

def LastCheckerStatus_dbus_property(self):

1549

2056

return dbus.Int16(self.last_checker_status)

1550

2057

1551

2058

# Expires - property

1552

2059

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

1553

2060

def Expires_dbus_property(self):

1554

2061

return datetime_to_dbus(self.expires)

1555

2062

1556

2063

# LastApprovalRequest - property

1557

2064

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

1558

2065

def LastApprovalRequest_dbus_property(self):

1559

2066

return datetime_to_dbus(self.last_approval_request)

1560

2067

1561

2068

# Timeout - property

1562

@dbus_service_property(_interface, signature="t",

2069

@dbus_service_property(_interface,

2070

signature="t",

1563

2071

access="readwrite")

1564

2072

def Timeout_dbus_property(self, value=None):

1565

2073

if value is None: # get

1577

2085

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

1578

2086

is None):

1579

2087

return

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

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

1584

* 1000), self.disable))

1585

2088

GLib.source_remove(self.disable_initiator_tag)

2089

self.disable_initiator_tag = GLib.timeout_add(

2090

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

2091

self.disable)

2092

1586

2093

# ExtendedTimeout - property

1587

@dbus_service_property(_interface, signature="t",

2094

@dbus_service_property(_interface,

2095

signature="t",

1588

2096

access="readwrite")

1589

2097

def ExtendedTimeout_dbus_property(self, value=None):

1590

2098

if value is None: # get

1591

2099

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

1592

2100

* 1000)

1593

2101

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

1594

2102

1595

2103

# Interval - property

1596

@dbus_service_property(_interface, signature="t",

2104

@dbus_service_property(_interface,

2105

signature="t",

1597

2106

access="readwrite")

1598

2107

def Interval_dbus_property(self, value=None):

1599

2108

if value is None: # get

1603

2112

return

1604

2113

if self.enabled:

1605

2114

# Reschedule checker run

1606

gobject.source_remove(self.checker_initiator_tag)

1607

self.checker_initiator_tag = (gobject.timeout_add

1608

(value, self.start_checker))

1609

self.start_checker() # Start one now, too

1610

2115

GLib.source_remove(self.checker_initiator_tag)

2116

self.checker_initiator_tag = GLib.timeout_add(

2117

value, self.start_checker)

2118

self.start_checker() # Start one now, too

2119

1611

2120

# Checker - property

1612

@dbus_service_property(_interface, signature="s",

2121

@dbus_service_property(_interface,

2122

signature="s",

1613

2123

access="readwrite")

1614

2124

def Checker_dbus_property(self, value=None):

1615

2125

if value is None: # get

1616

2126

return dbus.String(self.checker_command)

1617

2127

self.checker_command = str(value)

1618

2128

1619

2129

# CheckerRunning - property

1620

@dbus_service_property(_interface, signature="b",

2130

@dbus_service_property(_interface,

2131

signature="b",

1621

2132

access="readwrite")

1622

2133

def CheckerRunning_dbus_property(self, value=None):

1623

2134

if value is None: # get

1626

2137

self.start_checker()

1627

2138

else:

1628

2139

self.stop_checker()

1629

2140

1630

2141

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

1631

2145

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

1632

2146

def ObjectPath_dbus_property(self):

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1635

2149

# Secret = property

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

@dbus_service_property(_interface,

2154

signature="ay",

2155

access="write",

2156

byte_arrays=True)

1638

2157

def Secret_dbus_property(self, value):

1639

2158

self.secret = bytes(value)

1640

2159

1641

2160

del _interface

1642

2161

1643

2162

1646

2165

self._pipe = child_pipe

1647

2166

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

1648

2167

if not self._pipe.recv():

1649

raise KeyError()

1650

2168

raise KeyError(fpr)

2169

1651

2170

def __getattribute__(self, name):

1652

2171

if name == '_pipe':

1653

2172

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

1656

2175

if data[0] == 'data':

1657

2176

return data[1]

1658

2177

if data[0] == 'function':

2178

1659

2179

def func(*args, **kwargs):

1660

2180

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

1661

2181

return self._pipe.recv()[1]

2182

1662

2183

return func

1663

2184

1664

2185

def __setattr__(self, name, value):

1665

2186

if name == '_pipe':

1666

2187

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

1669

2190

1670

2191

class ClientHandler(socketserver.BaseRequestHandler, object):

1671

2192

"""A class to handle client connections.

1672

2193

1673

2194

Instantiated once for each connection to handle it.

1674

2195

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

1675

2196

1676

2197

def handle(self):

1677

2198

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

1678

2199

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

1679

2200

str(self.client_address))

1680

2201

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

1681

2202

self.server.child_pipe.fileno())

1682

1683

session = (gnutls.connection

1684

.ClientSession(self.request,

1685

gnutls.connection

1686

.X509Credentials()))

1687

1688

# Note: gnutls.connection.X509Credentials is really a

1689

# generic GnuTLS certificate credentials object so long as

1690

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

1691

# here despite using OpenPGP certificates.

1692

1693

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

1694

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

1695

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

1696

# "+DHE-DSS"))

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

1697

2210

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

1698

2211

priority = self.server.gnutls_priority

1699

2212

if priority is None:

1700

2213

priority = "NORMAL"

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1705

2218

# Start communication using the Mandos protocol

1706

2219

# Get protocol number

1707

2220

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

1712

2225

except (ValueError, IndexError, RuntimeError) as error:

1713

2226

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

1714

2227

return

1715

2228

1716

2229

# Start GnuTLS connection

1717

2230

try:

1718

2231

session.handshake()

1719

except gnutls.errors.GNUTLSError as error:

2232

except gnutls.Error as error:

1720

2233

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

1721

2234

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

1722

2235

# established. Just abandon the request.

1723

2236

return

1724

2237

logger.debug("Handshake succeeded")

1725

2238

1726

2239

approval_required = False

1727

2240

try:

1728

2241

try:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

2242

fpr = self.fingerprint(

2243

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1733

2245

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

1734

2246

return

1735

2247

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

1736

2248

1737

2249

try:

1738

2250

client = ProxyClient(child_pipe, fpr,

1739

2251

self.client_address)

1740

2252

except KeyError:

1741

2253

return

1742

2254

1743

2255

if client.approval_delay:

1744

2256

delay = client.approval_delay

1745

2257

client.approvals_pending += 1

1746

2258

approval_required = True

1747

2259

1748

2260

while True:

1749

2261

if not client.enabled:

1750

2262

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

1751

client.name)

2263

client.name)

1752

2264

if self.server.use_dbus:

1753

2265

# Emit D-Bus signal

1754

2266

client.Rejected("Disabled")

1755

2267

return

1756

2268

1757

2269

if client.approved or not client.approval_delay:

1758

#We are approved or approval is disabled

2270

# We are approved or approval is disabled

1759

2271

break

1760

2272

elif client.approved is None:

1761

2273

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

1772

2284

# Emit D-Bus signal

1773

2285

client.Rejected("Denied")

1774

2286

return

1775

1776

#wait until timeout or approved

2287

2288

# wait until timeout or approved

1777

2289

time = datetime.datetime.now()

1778

2290

client.changedstate.acquire()

1779

2291

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

1792

2304

break

1793

2305

else:

1794

2306

delay -= time2 - time

1795

1796

sent_size = 0

1797

while sent_size < len(client.secret):

1798

try:

1799

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

1800

except gnutls.errors.GNUTLSError as error:

1801

logger.warning("gnutls send failed",

1802

exc_info=error)

1803

return

1804

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

1805

sent, len(client.secret)

1806

- (sent_size + sent))

1807

sent_size += sent

1808

2307

2308

try:

2309

session.send(client.secret)

2310

except gnutls.Error as error:

2311

logger.warning("gnutls send failed",

2312

exc_info=error)

2313

return

2314

1809

2315

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

1810

2316

# bump the timeout using extended_timeout

1811

2317

client.bump_timeout(client.extended_timeout)

1812

2318

if self.server.use_dbus:

1813

2319

# Emit D-Bus signal

1814

2320

client.GotSecret()

1815

2321

1816

2322

finally:

1817

2323

if approval_required:

1818

2324

client.approvals_pending -= 1

1819

2325

try:

1820

2326

session.bye()

1821

except gnutls.errors.GNUTLSError as error:

2327

except gnutls.Error as error:

1822

2328

logger.warning("GnuTLS bye failed",

1823

2329

exc_info=error)

1824

2330

1825

2331

@staticmethod

1826

2332

def peer_certificate(session):

1827

2333

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

1828

2334

# If not an OpenPGP certificate...

1829

if (gnutls.library.functions

1830

.gnutls_certificate_type_get(session._c_object)

1831

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1832

# ...do the normal thing

1833

return session.peer_certificate

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

return b""

1834

2339

list_size = ctypes.c_uint(1)

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2340

cert_list = (gnutls.certificate_get_peers

1837

2341

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

1838

2342

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

1839

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

1840

" certificate")

2343

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

1841

2344

if list_size.value == 0:

1842

2345

return None

1843

2346

cert = cert_list[0]

1844

2347

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

1845

2348

1846

2349

@staticmethod

1847

2350

def fingerprint(openpgp):

1848

2351

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1849

2352

# New GnuTLS "datum" with the OpenPGP public key

1850

datum = (gnutls.library.types

1851

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

1852

ctypes.POINTER

1853

(ctypes.c_ubyte)),

1854

ctypes.c_uint(len(openpgp))))

2353

datum = gnutls.datum_t(

2354

ctypes.cast(ctypes.c_char_p(openpgp),

2355

ctypes.POINTER(ctypes.c_ubyte)),

2356

ctypes.c_uint(len(openpgp)))

1855

2357

# New empty GnuTLS certificate

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2358

crt = gnutls.openpgp_crt_t()

2359

gnutls.openpgp_crt_init(ctypes.byref(crt))

1859

2360

# Import the OpenPGP public key into the certificate

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2361

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

2362

gnutls.OPENPGP_FMT_RAW)

1864

2363

# Verify the self signature in the key

1865

2364

crtverify = ctypes.c_uint()

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1869

2367

if crtverify.value != 0:

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

1873

2370

# New buffer for the fingerprint

1874

2371

buf = ctypes.create_string_buffer(20)

1875

2372

buf_len = ctypes.c_size_t()

1876

2373

# Get the fingerprint from the certificate into the buffer

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2374

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

2375

ctypes.byref(buf_len))

1880

2376

# Deinit the certificate

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

gnutls.openpgp_crt_deinit(crt)

1882

2378

# Convert the buffer to a Python bytestring

1883

2379

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

1884

2380

# Convert the bytestring to hexadecimal notation

1888

2384

1889

2385

class MultiprocessingMixIn(object):

1890

2386

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

2387

1891

2388

def sub_process_main(self, request, address):

1892

2389

try:

1893

2390

self.finish_request(request, address)

1894

2391

except Exception:

1895

2392

self.handle_error(request, address)

1896

2393

self.close_request(request)

1897

2394

1898

2395

def process_request(self, request, address):

1899

2396

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

1900

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

1901

args = (request, address))

2397

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

2398

args=(request, address))

1902

2399

proc.start()

1903

2400

return proc

1904

2401

1905

2402

1906

2403

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1907

2404

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

2405

1908

2406

def process_request(self, request, client_address):

1909

2407

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

1910

2408

1911

2409

This function creates a new pipe in self.pipe

1912

2410

"""

1913

2411

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1914

2412

1915

2413

proc = MultiprocessingMixIn.process_request(self, request,

1916

2414

client_address)

1917

2415

self.child_pipe.close()

1918

2416

self.add_pipe(parent_pipe, proc)

1919

2417

1920

2418

def add_pipe(self, parent_pipe, proc):

1921

2419

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

1922

2420

raise NotImplementedError()

1925

2423

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1926

2424

socketserver.TCPServer, object):

1927

2425

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

1928

2426

1929

2427

Attributes:

1930

2428

enabled: Boolean; whether this server is activated yet

1931

2429

interface: None or a network interface name (string)

1932

2430

use_ipv6: Boolean; to use IPv6 or not

1933

2431

"""

2432

1934

2433

def __init__(self, server_address, RequestHandlerClass,

1935

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

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1936

2437

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

1937

2438

creating a new one with socket.socket().

1938

2439

"""

1944

2445

self.socketfd = socketfd

1945

2446

# Save the original socket.socket() function

1946

2447

self.socket_socket = socket.socket

2448

1947

2449

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

1948

#

2450

#

1949

2451

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

1950

2452

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

1951

2453

# patching socket.socket.)

1952

#

2454

#

1953

2455

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

1954

2456

@functools.wraps(socket.socket)

1955

2457

def socket_wrapper(*args, **kwargs):

1967

2469

# socket_wrapper(), if socketfd was set.

1968

2470

socketserver.TCPServer.__init__(self, server_address,

1969

2471

RequestHandlerClass)

1970

2472

1971

2473

def server_bind(self):

1972

2474

"""This overrides the normal server_bind() function

1973

2475

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

1974

2476

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

2477

global SO_BINDTODEVICE

1975

2478

if self.interface is not None:

1976

2479

if SO_BINDTODEVICE is None:

1977

logger.error("SO_BINDTODEVICE does not exist;"

1978

" cannot bind to interface %s",

1979

self.interface)

1980

else:

1981

try:

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1983

SO_BINDTODEVICE,

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

1999

2501

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

2000

2502

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

2001

2503

if not self.server_address[0]:

2002

2504

if self.address_family == socket.AF_INET6:

2003

any_address = "::" # in6addr_any

2505

any_address = "::" # in6addr_any

2004

2506

else:

2005

any_address = "0.0.0.0" # INADDR_ANY

2507

any_address = "0.0.0.0" # INADDR_ANY

2006

2508

self.server_address = (any_address,

2007

2509

self.server_address[1])

2008

2510

elif not self.server_address[1]:

2009

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

2010

0)

2511

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

2011

2512

# if self.interface:

2012

2513

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

2013

2514

# 0, # port

2019

2520

2020

2521

class MandosServer(IPv6_TCPServer):

2021

2522

"""Mandos server.

2022

2523

2023

2524

Attributes:

2024

2525

clients: set of Client objects

2025

2526

gnutls_priority GnuTLS priority string

2026

2527

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

2027

2028

Assumes a gobject.MainLoop event loop.

2528

2529

Assumes a GLib.MainLoop event loop.

2029

2530

"""

2531

2030

2532

def __init__(self, server_address, RequestHandlerClass,

2031

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

2032

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

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

2033

2539

self.enabled = False

2034

2540

self.clients = clients

2035

2541

if self.clients is None:

2038

2544

self.gnutls_priority = gnutls_priority

2039

2545

IPv6_TCPServer.__init__(self, server_address,

2040

2546

RequestHandlerClass,

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2044

2551

def server_activate(self):

2045

2552

if self.enabled:

2046

2553

return socketserver.TCPServer.server_activate(self)

2047

2554

2048

2555

def enable(self):

2049

2556

self.enabled = True

2050

2557

2051

2558

def add_pipe(self, parent_pipe, proc):

2052

2559

# Call "handle_ipc" for both data and EOF events

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2059

2060

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

2061

proc = None, client_object=None):

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

2062

2571

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

2063

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

2572

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

2064

2573

# Wait for other process to exit

2065

2574

proc.join()

2066

2575

return False

2067

2576

2068

2577

# Read a request from the child

2069

2578

request = parent_pipe.recv()

2070

2579

command = request[0]

2071

2580

2072

2581

if command == 'init':

2073

fpr = request[1]

2582

fpr = request[1].decode("ascii")

2074

2583

address = request[2]

2075

2076

for c in self.clients.itervalues():

2584

2585

for c in self.clients.values():

2077

2586

if c.fingerprint == fpr:

2078

2587

client = c

2079

2588

break

2086

2595

address[0])

2087

2596

parent_pipe.send(False)

2088

2597

return False

2089

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2098

2606

parent_pipe.send(True)

2099

2607

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

2100

2608

# same fileno

2103

2611

funcname = request[1]

2104

2612

args = request[2]

2105

2613

kwargs = request[3]

2106

2614

2107

2615

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

2108

2616

funcname)(*args,

2109

**kwargs)))

2110

2617

**kwargs)))

2618

2111

2619

if command == 'getattr':

2112

2620

attrname = request[1]

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2115

2624

else:

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2625

parent_pipe.send((

2626

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

2627

2119

2628

if command == 'setattr':

2120

2629

attrname = request[1]

2121

2630

value = request[2]

2122

2631

setattr(client_object, attrname, value)

2123

2632

2124

2633

return True

2125

2634

2126

2635

2127

2636

def rfc3339_duration_to_delta(duration):

2128

2637

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

2129

2638

2130

2639

>>> rfc3339_duration_to_delta("P7D")

2131

2640

datetime.timedelta(7)

2132

2641

>>> rfc3339_duration_to_delta("PT60S")

2142

2651

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

2652

datetime.timedelta(1, 200)

2144

2653

"""

2145

2654

2146

2655

# Parsing an RFC 3339 duration with regular expressions is not

2147

2656

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

2148

2657

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

2149

2658

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

2150

2659

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

2151

2660

# avoid excessive use of external libraries.

2152

2661

2153

2662

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

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

2163

2668

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

2164

2669

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

2165

2670

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

2166

2671

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

2167

2672

datetime.timedelta(seconds=1),

2168

frozenset((token_end,)))

2673

frozenset((token_end, )))

2169

2674

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

2170

2675

datetime.timedelta(minutes=1),

2171

2676

frozenset((token_second, token_end)))

2187

2692

frozenset((token_month, token_end)))

2188

2693

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

2189

2694

datetime.timedelta(weeks=1),

2190

frozenset((token_end,)))

2695

frozenset((token_end, )))

2191

2696

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

2192

2697

frozenset((token_year, token_month,

2193

2698

token_day, token_time,

2194

2699

token_week)))

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2197

2703

found_token = None

2198

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

2199

s = duration # String left to parse

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2200

2708

# Loop until end token is found

2201

2709

while found_token is not token_end:

2202

2710

# Search for any currently valid tokens

2218

2726

break

2219

2727

else:

2220

2728

# No currently valid tokens were found

2221

raise ValueError("Invalid RFC 3339 duration")

2729

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

2730

.format(duration))

2222

2731

# End token found

2223

2732

return value

2224

2733

2225

2734

2226

2735

def string_to_delta(interval):

2227

2736

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

2228

2737

2229

2738

>>> string_to_delta('7d')

2230

2739

datetime.timedelta(7)

2231

2740

>>> string_to_delta('60s')

2239

2748

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

2240

2749

datetime.timedelta(0, 330)

2241

2750

"""

2242

2751

2243

2752

try:

2244

2753

return rfc3339_duration_to_delta(interval)

2245

2754

except ValueError:

2246

2755

pass

2247

2756

2248

2757

timevalue = datetime.timedelta(0)

2249

2758

for s in interval.split():

2250

2759

try:

2261

2770

elif suffix == "w":

2262

2771

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

2263

2772

else:

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2773

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

2266

2774

except IndexError as e:

2267

2775

raise ValueError(*(e.args))

2268

2776

timevalue += delta

2269

2777

return timevalue

2270

2778

2271

2779

2272

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

2780

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

2273

2781

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

2274

2782

2275

2783

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

2276

2784

if os.fork():

2277

2785

sys.exit()

2284

2792

# Close all standard open file descriptors

2285

2793

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

2286

2794

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

2287

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

2795

raise OSError(errno.ENODEV,

2796

"{} not a character device"

2288

2797

.format(os.devnull))

2289

2798

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

2290

2799

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

2294

2803

2295

2804

2296

2805

def main():

2297

2806

2298

2807

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

2299

2808

# Parsing of options, both command line and config file

2300

2809

2301

2810

parser = argparse.ArgumentParser()

2302

2811

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

2303

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

2812

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

2304

2813

help="show version number and exit")

2305

2814

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

2306

2815

help="Bind to interface IF")

2342

2851

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

2343

2852

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

2344

2853

default=None)

2345

2854

2346

2855

options = parser.parse_args()

2347

2856

2348

2857

if options.check:

2349

2858

import doctest

2350

2859

fail_count, test_count = doctest.testmod()

2351

2860

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

2352

2861

2353

2862

# Default values for config file for server-global settings

2354

server_defaults = { "interface": "",

2355

"address": "",

2356

"port": "",

2357

"debug": "False",

2358

"priority":

2359

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

2360

"servicename": "Mandos",

2361

"use_dbus": "True",

2362

"use_ipv6": "True",

2363

"debuglevel": "",

2364

"restore": "True",

2365

"socket": "",

2366

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

2367

"foreground": "False",

2368

"zeroconf": "True",

2369

}

2370

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2371

2881

# Parse config file for server-global settings

2372

2882

server_config = configparser.SafeConfigParser(server_defaults)

2373

2883

del server_defaults

2374

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

2375

"mandos.conf"))

2884

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

2376

2885

# Convert the SafeConfigParser object to a dict

2377

2886

server_settings = server_config.defaults()

2378

2887

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

2379

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

2888

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

2889

"foreground", "zeroconf"):

2380

2890

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

2381

2891

option)

2382

2892

if server_settings["port"]:

2392

2902

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

2393

2903

["socket"])

2394

2904

del server_config

2395

2905

2396

2906

# Override the settings from the config file with command line

2397

2907

# options, if set.

2398

2908

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

2399

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

2400

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

2401

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

2909

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

2910

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

2911

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

2402

2912

value = getattr(options, option)

2403

2913

if value is not None:

2404

2914

server_settings[option] = value

2416

2926

if server_settings["debug"]:

2417

2927

server_settings["foreground"] = True

2418

2928

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

2419

2929

2420

2930

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

2421

2422

if (not server_settings["zeroconf"] and

2423

not (server_settings["port"]

2424

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

2425

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

2426

" Zeroconf")

2427

2931

2932

if (not server_settings["zeroconf"]

2933

and not (server_settings["port"]

2934

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

2935

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

2936

2428

2937

# For convenience

2429

2938

debug = server_settings["debug"]

2430

2939

debuglevel = server_settings["debuglevel"]

2434

2943

stored_state_file)

2435

2944

foreground = server_settings["foreground"]

2436

2945

zeroconf = server_settings["zeroconf"]

2437

2946

2438

2947

if debug:

2439

2948

initlogger(debug, logging.DEBUG)

2440

2949

else:

2443

2952

else:

2444

2953

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

2445

2954

initlogger(debug, level)

2446

2955

2447

2956

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

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2454

2962

# Parse config file with clients

2455

2963

client_config = configparser.SafeConfigParser(Client

2456

2964

.client_defaults)

2457

2965

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

2458

2966

"clients.conf"))

2459

2967

2460

2968

global mandos_dbus_service

2461

2969

mandos_dbus_service = None

2462

2970

2463

2971

socketfd = None

2464

2972

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

2465

2973

socketfd = server_settings["socket"]

2466

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

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2476

2982

if not foreground:

2477

2983

pidfilename = "/run/mandos.pid"

2478

2984

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

2479

2985

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

2480

2986

pidfile = None

2481

2987

try:

2482

pidfile = open(pidfilename, "w")

2988

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

2483

2989

except IOError as e:

2484

2990

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

2485

2991

exc_info=e)

2486

2487

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

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2488

2996

try:

2489

2997

uid = pwd.getpwnam(name).pw_uid

2490

gid = pwd.getpwnam(name).pw_gid

2998

gid = pwd.getpwnam(group).pw_gid

2491

2999

break

2492

3000

except KeyError:

2493

3001

continue

2497

3005

try:

2498

3006

os.setgid(gid)

2499

3007

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

2500

3011

except OSError as error:

3012

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

3013

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

2501

3014

if error.errno != errno.EPERM:

2502

3015

raise

2503

3016

2504

3017

if debug:

2505

3018

# Enable all possible GnuTLS debugging

2506

3019

2507

3020

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

2508

3021

# - GnuTLS manual

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2512

3025

def debug_gnutls(level, string):

2513

3026

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

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2518

3030

# Redirect stdin so all checkers get /dev/null

2519

3031

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

2520

3032

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

2521

3033

if null > 2:

2522

3034

os.close(null)

2523

3035

2524

3036

# Need to fork before connecting to D-Bus

2525

3037

if not foreground:

2526

3038

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

2527

3039

daemon()

2528

2529

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

2530

# need to inform gobject that threads will be used.

2531

gobject.threads_init()

2532

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2533

3045

global main_loop

2534

3046

# From the Avahi example code

2535

3047

DBusGMainLoop(set_as_default=True)

2536

main_loop = gobject.MainLoop()

3048

main_loop = GLib.MainLoop()

2537

3049

bus = dbus.SystemBus()

2538

3050

# End of Avahi example code

2539

3051

if use_dbus:

2540

3052

try:

2541

3053

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

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2547

3060

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

2548

3061

use_dbus = False

2549

3062

server_settings["use_dbus"] = False

2550

3063

tcp_server.use_dbus = False

2551

3064

if zeroconf:

2552

3065

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3066

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

2557

3071

if server_settings["interface"]:

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3072

service.interface = if_nametoindex(

3073

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

3074

2562

3075

global multiprocessing_manager

2563

3076

multiprocessing_manager = multiprocessing.Manager()

2564

3077

2565

3078

client_class = Client

2566

3079

if use_dbus:

2567

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

2568

3080

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

3081

2569

3082

client_settings = Client.config_parser(client_config)

2570

3083

old_client_settings = {}

2571

3084

clients_data = {}

2572

3085

2573

3086

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

2574

3087

global wnull

2575

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

3088

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

2576

3089

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

2577

3090

# mode

2578

3091

if debug or not foreground:

2579

3092

wnull.close()

2580

3093

2581

3094

# Get client data and settings from last running state.

2582

3095

if server_settings["restore"]:

2583

3096

try:

2584

3097

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

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

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

3141

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

3142

.decode("utf-8"))

2587

3143

os.remove(stored_state_path)

2588

3144

except IOError as e:

2589

3145

if e.errno == errno.ENOENT:

2590

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

2591

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

3146

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

3147

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

2592

3148

else:

2593

3149

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

2594

3150

exc_info=e)

2595

3151

raise

2596

3152

except EOFError as e:

2597

3153

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

2598

"EOFError:", exc_info=e)

2599

3154

"EOFError:",

3155

exc_info=e)

3156

2600

3157

with PGPEngine() as pgp:

2601

3158

for client_name, client in clients_data.items():

2602

3159

# Skip removed clients

2603

3160

if client_name not in client_settings:

2604

3161

continue

2605

3162

2606

3163

# Decide which value to use after restoring saved state.

2607

3164

# We have three different values: Old config file,

2608

3165

# new config file, and saved state.

2613

3170

# For each value in new config, check if it

2614

3171

# differs from the old config value (Except for

2615

3172

# the "secret" attribute)

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2619

3176

client[name] = value

2620

3177

except KeyError:

2621

3178

pass

2622

3179

2623

3180

# Clients who has passed its expire date can still be

2624

# enabled if its last checker was successful. Clients

3181

# enabled if its last checker was successful. A Client

2625

3182

# whose checker succeeded before we stored its state is

2626

3183

# assumed to have successfully run all checkers during

2627

3184

# downtime.

2630

3187

if not client["last_checked_ok"]:

2631

3188

logger.warning(

2632

3189

"disabling client {} - Client never "

2633

"performed a successful checker"

2634

.format(client_name))

3190

"performed a successful checker".format(

3191

client_name))

2635

3192

client["enabled"] = False

2636

3193

elif client["last_checker_status"] != 0:

2637

3194

logger.warning(

2638

3195

"disabling client {} - Client last"

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2642

3200

client["enabled"] = False

2643

3201

else:

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2647

3205

logger.debug("Last checker succeeded,"

2648

" keeping {} enabled"

2649

.format(client_name))

3206

" keeping {} enabled".format(

3207

client_name))

2650

3208

try:

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2655

3212

except PGPError:

2656

3213

# If decryption fails, we use secret from new settings

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2662

3219

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

2663

3220

for client_name in (set(old_client_settings)

2664

3221

- set(client_settings)):

2666

3223

for client_name in (set(client_settings)

2667

3224

- set(old_client_settings)):

2668

3225

clients_data[client_name] = client_settings[client_name]

2669

3226

2670

3227

# Create all client objects

2671

3228

for client_name, client in clients_data.items():

2672

3229

tcp_server.clients[client_name] = client_class(

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2676

3234

if not tcp_server.clients:

2677

3235

logger.warning("No clients defined")

2678

3236

2679

3237

if not foreground:

2680

3238

if pidfile is not None:

3239

pid = os.getpid()

2681

3240

try:

2682

3241

with pidfile:

2683

pid = os.getpid()

2684

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

3242

print(pid, file=pidfile)

2685

3243

except IOError:

2686

3244

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

2687

3245

pidfilename, pid)

2688

3246

del pidfile

2689

3247

del pidfilename

2690

2691

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

2692

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

2693

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2694

3253

if use_dbus:

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2698

3258

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

3259

2699

3260

def __init__(self):

2700

3261

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

3262

2701

3263

_interface = "se.recompile.Mandos"

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3264

2709

3265

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

2710

3266

def ClientAdded(self, objpath):

2711

3267

"D-Bus signal"

2712

3268

pass

2713

3269

2714

3270

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

2715

3271

def ClientNotFound(self, fingerprint, address):

2716

3272

"D-Bus signal"

2717

3273

pass

2718

3274

3275

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

3276

"true"})

2719

3277

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

2720

3278

def ClientRemoved(self, objpath, name):

2721

3279

"D-Bus signal"

2722

3280

pass

2723

3281

3282

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

3283

"true"})

2724

3284

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

2725

3285

def GetAllClients(self):

2726

3286

"D-Bus method"

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3287

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2731

3292

@dbus.service.method(_interface,

2732

3293

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

2733

3294

def GetAllClientsWithProperties(self):

2734

3295

"D-Bus method"

2735

3296

return dbus.Dictionary(

2736

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

2737

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

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2738

3300

signature="oa{sv}")

2739

3301

2740

3302

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

2741

3303

def RemoveClient(self, object_path):

2742

3304

"D-Bus method"

2743

for c in tcp_server.clients.itervalues():

3305

for c in tcp_server.clients.values():

2744

3306

if c.dbus_object_path == object_path:

2745

3307

del tcp_server.clients[c.name]

2746

3308

c.remove_from_connection()

2747

# Don't signal anything except ClientRemoved

3309

# Don't signal the disabling

2748

3310

c.disable(quiet=True)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2751

3313

return

2752

3314

raise KeyError(object_path)

2753

3315

2754

3316

del _interface

2755

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2756

3354

mandos_dbus_service = MandosDBusService()

2757

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2758

3361

def cleanup():

2759

3362

"Cleanup function; run on exit"

2760

3363

if zeroconf:

2761

3364

service.cleanup()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3365

3366

mp.active_children()

3367

wn.close()

2765

3368

if not (tcp_server.clients or client_settings):

2766

3369

return

2767

3370

2768

3371

# Store client before exiting. Secrets are encrypted with key

2769

3372

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

2770

3373

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

2771

3374

clients = {}

2772

3375

with PGPEngine() as pgp:

2773

for client in tcp_server.clients.itervalues():

3376

for client in tcp_server.clients.values():

2774

3377

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

2775

3378

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

2776

3379

key)

2777

3380

client_dict = {}

2778

3381

2779

3382

# A list of attributes that can not be pickled

2780

3383

# + secret.

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2785

3388

exclude.add(name)

2786

3389

2787

3390

client_dict["encrypted_secret"] = (client

2788

3391

.encrypted_secret)

2789

3392

for attr in client.client_structure:

2790

3393

if attr not in exclude:

2791

3394

client_dict[attr] = getattr(client, attr)

2792

3395

2793

3396

clients[client.name] = client_dict

2794

3397

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

2795

3398

2796

3399

try:

2797

with (tempfile.NamedTemporaryFile

2798

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

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2803

3409

os.rename(tempname, stored_state_path)

2804

3410

except (IOError, OSError) as e:

2805

3411

if not debug:

2814

3420

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

2815

3421

exc_info=e)

2816

3422

raise

2817

3423

2818

3424

# Delete all clients, and settings from config

2819

3425

while tcp_server.clients:

2820

3426

name, client = tcp_server.clients.popitem()

2821

3427

if use_dbus:

2822

3428

client.remove_from_connection()

2823

# Don't signal anything except ClientRemoved

3429

# Don't signal the disabling

2824

3430

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

2825

3432

if use_dbus:

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3433

mandos_dbus_service.client_removed_signal(client)

2830

3434

client_settings.clear()

2831

3435

2832

3436

atexit.register(cleanup)

2833

2834

for client in tcp_server.clients.itervalues():

3437

3438

for client in tcp_server.clients.values():

2835

3439

if use_dbus:

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2838

3442

# Need to initiate checking of clients

2839

3443

if client.enabled:

2840

3444

client.init_checker()

2841

3445

2842

3446

tcp_server.enable()

2843

3447

tcp_server.server_activate()

2844

3448

2845

3449

# Find out what port we got

2846

3450

if zeroconf:

2847

3451

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

2852

3456

else: # IPv4

2853

3457

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

2854

3458

*tcp_server.socket.getsockname())

2855

2856

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

2857

3459

3460

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

3461

2858

3462

try:

2859

3463

if zeroconf:

2860

3464

# From the Avahi example code

2865

3469

cleanup()

2866

3470

sys.exit(1)

2867

3471

# End of Avahi example code

2868

2869

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

2870

lambda *args, **kwargs:

2871

(tcp_server.handle_request

2872

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

2873

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2874

3478

logger.debug("Starting main loop")

2875

3479

main_loop.run()

2876

3480

except AvahiError as error:

2885

3489

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

2886

3490

cleanup()

2887

3491

3492

2888

3493

if __name__ == '__main__':

2889

3494

main()