/mandos/release : revision 237.7.292

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

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

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

72

81

73

import dbus

82

74

import dbus.service

83

from gi.repository import GLib

75

import gobject

76

import avahi

84

77

from dbus.mainloop.glib import DBusGMainLoop

85

78

import ctypes

86

79

import ctypes.util

87

80

import xml.dom.minidom

88

81

import inspect

89

82

90

# Try to find the value of SO_BINDTODEVICE:

91

83

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:

94

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

85

except AttributeError:

96

86

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

87

from IN import SO_BINDTODEVICE

100

88

except ImportError:

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

89

SO_BINDTODEVICE = None

114

90

115

91

if sys.version_info.major == 2:

116

92

str = unicode

117

93

118

version = "1.7.15"

94

version = "1.6.9"

119

95

stored_state_file = "clients.pickle"

120

96

121

97

logger = logging.getLogger()

122

98

syslogger = None

123

99

124

100

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

127

104

except (OSError, AttributeError):

128

129

105

def if_nametoindex(interface):

130

106

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

131

107

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

136

112

return interface_index

137

113

138

114

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

155

115

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

156

116

"""init logger and add loglevel"""

157

117

158

118

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

162

123

syslogger.setFormatter(logging.Formatter

163

124

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

164

125

' %(message)s'))

165

126

logger.addHandler(syslogger)

166

127

167

128

if debug:

168

129

console = logging.StreamHandler()

169

130

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

181

142

182

143

class PGPEngine(object):

183

144

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

184

185

145

def __init__(self):

186

146

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

198

147

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

148

'--home', self.tempdir,

200

149

'--force-mdc',

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

150

'--quiet',

151

'--no-use-agent']

152

206

153

def __enter__(self):

207

154

return self

208

155

209

156

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

210

157

self._cleanup()

211

158

return False

212

159

213

160

def __del__(self):

214

161

self._cleanup()

215

162

216

163

def _cleanup(self):

217

164

if self.tempdir is not None:

218

165

# Delete contents of tempdir

219

166

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

220

topdown=False):

167

topdown = False):

221

168

for filename in files:

222

169

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

223

170

for dirname in dirs:

225

172

# Remove tempdir

226

173

os.rmdir(self.tempdir)

227

174

self.tempdir = None

228

175

229

176

def password_encode(self, password):

230

177

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

231

178

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

236

183

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

237

184

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

238

185

return encoded

239

186

240

187

def encrypt(self, data, password):

241

188

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

244

191

passfile.write(passphrase)

245

192

passfile.flush()

246

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

193

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

247

194

'--passphrase-file',

248

195

passfile.name]

249

196

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

254

201

if proc.returncode != 0:

255

202

raise PGPError(err)

256

203

return ciphertext

257

204

258

205

def decrypt(self, data, password):

259

206

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

262

209

passfile.write(passphrase)

263

210

passfile.flush()

264

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

211

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

265

212

'--passphrase-file',

266

213

passfile.name]

267

214

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

272

220

if proc.returncode != 0:

273

221

raise PGPError(err)

274

222

return decrypted_plaintext

275

223

276

224

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

304

225

class AvahiError(Exception):

305

226

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

306

227

self.value = value

307

228

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

308

229

**kwargs)

309

230

310

311

231

class AvahiServiceError(AvahiError):

312

232

pass

313

233

314

315

234

class AvahiGroupError(AvahiError):

316

235

pass

317

236

318

237

319

238

class AvahiService(object):

320

239

"""An Avahi (Zeroconf) service.

321

240

322

241

Attributes:

323

242

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

324

243

Used to optionally bind to the specified interface.

336

255

server: D-Bus Server

337

256

bus: dbus.SystemBus()

338

257

"""

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

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

351

263

self.interface = interface

352

264

self.name = name

353

265

self.type = servicetype

362

274

self.server = None

363

275

self.bus = bus

364

276

self.entry_group_state_changed_match = None

365

277

366

278

def rename(self, remove=True):

367

279

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

368

280

if self.rename_count >= self.max_renames:

370

282

" after %i retries, exiting.",

371

283

self.rename_count)

372

284

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

375

287

self.rename_count += 1

376

288

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

377

289

self.name)

388

300

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

389

301

self.cleanup()

390

302

os._exit(1)

391

303

392

304

def remove(self):

393

305

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

394

306

if self.entry_group_state_changed_match is not None:

396

308

self.entry_group_state_changed_match = None

397

309

if self.group is not None:

398

310

self.group.Reset()

399

311

400

312

def add(self):

401

313

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

402

314

self.remove()

419

331

dbus.UInt16(self.port),

420

332

avahi.string_array_to_txt_array(self.TXT))

421

333

self.group.Commit()

422

334

423

335

def entry_group_state_changed(self, state, error):

424

336

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

425

337

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

426

338

427

339

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

340

logger.debug("Zeroconf service established.")

429

341

elif state == avahi.ENTRY_GROUP_COLLISION:

432

344

elif state == avahi.ENTRY_GROUP_FAILURE:

433

345

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

434

346

str(error))

435

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

436

347

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

348

.format(error))

349

437

350

def cleanup(self):

438

351

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

439

352

if self.group is not None:

444

357

pass

445

358

self.group = None

446

359

self.remove()

447

360

448

361

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

449

362

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

450

363

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

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

}

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" }

457

371

if state in bad_states:

458

372

if bad_states[state] is not None:

459

373

if error is None:

462

376

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

463

377

self.cleanup()

464

378

elif state == avahi.SERVER_RUNNING:

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)

379

self.add()

477

380

else:

478

381

if error is None:

479

382

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

480

383

else:

481

384

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

482

385

483

386

def activate(self):

484

387

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

485

388

if self.server is None:

489

392

follow_name_owner_changes=True),

490

393

avahi.DBUS_INTERFACE_SERVER)

491

394

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

395

self.server_state_changed)

493

396

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

494

397

495

398

497

400

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

498

401

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

499

402

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

503

407

return ret

504

408

505

409

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

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

520

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

521

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

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

# exception might be raised from within GnuTLS.__init__,

567

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

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

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

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

778

779

780

410

class Client(object):

781

411

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

782

412

783

413

Attributes:

784

414

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

785

415

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

787

417

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

788

418

to see if the client lives.

789

419

'None' if no process is running.

790

checker_callback_tag: a GLib event source tag, or None

420

checker_callback_tag: a gobject event source tag, or None

791

421

checker_command: string; External command which is run to check

792

422

if client lives. %() expansions are done at

793

423

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

794

424

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

795

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

796

426

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

797

427

client_structure: Object describing what attributes a client has

798

428

and is used for storing the client at exit

799

429

current_checker_command: string; current running checker_command

800

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

801

431

enabled: bool()

802

432

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

803

433

uniquely identify the client

808

438

last_checker_status: integer between 0 and 255 reflecting exit

809

439

status of last checker. -1 reflects crashed

810

440

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

813

441

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

814

442

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

815

443

D-Bus identifiers

822

450

disabled, or None

823

451

server_settings: The server_settings dict from main()

824

452

"""

825

453

826

454

runtime_expansions = ("approval_delay", "approval_duration",

827

455

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

828

456

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

829

457

"last_approval_request", "last_checked_ok",

830

458

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

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

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

843

470

@staticmethod

844

471

def config_parser(config):

845

472

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

852

479

for client_name in config.sections():

853

480

section = dict(config.items(client_name))

854

481

client = settings[client_name] = {}

855

482

856

483

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

857

484

# Reformat values from string types to Python types

858

485

client["approved_by_default"] = config.getboolean(

859

486

client_name, "approved_by_default")

860

487

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

861

488

"enabled")

862

489

863

490

# Uppercase and remove spaces from fingerprint for later

864

491

# comparison purposes with return value from the

865

492

# fingerprint() function

866

493

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

867

494

.replace(" ", ""))

868

495

if "secret" in section:

869

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

870

.encode("utf-8"),

871

"base64")

496

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

872

497

elif "secfile" in section:

873

498

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

874

499

(section["secfile"])),

889

514

client["last_approval_request"] = None

890

515

client["last_checked_ok"] = None

891

516

client["last_checker_status"] = -2

892

517

893

518

return settings

894

895

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

519

520

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

896

521

self.name = name

897

522

if server_settings is None:

898

523

server_settings = {}

900

525

# adding all client settings

901

526

for setting, value in settings.items():

902

527

setattr(self, setting, value)

903

528

904

529

if self.enabled:

905

530

if not hasattr(self, "last_enabled"):

906

531

self.last_enabled = datetime.datetime.utcnow()

910

535

else:

911

536

self.last_enabled = None

912

537

self.expires = None

913

538

914

539

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

915

540

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

916

541

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

917

542

datetime.datetime.utcnow())

918

543

919

544

# attributes specific for this server instance

920

545

self.checker = None

921

546

self.checker_initiator_tag = None

924

549

self.current_checker_command = None

925

550

self.approved = None

926

551

self.approvals_pending = 0

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

931

557

if not attr.startswith("_")]

932

558

self.client_structure.append("client_structure")

933

934

for name, t in inspect.getmembers(

935

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

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

936

564

if not name.startswith("_"):

937

565

self.client_structure.append(name)

938

566

939

567

# Send notice to process children that client state has changed

940

568

def send_changedstate(self):

941

569

with self.changedstate:

942

570

self.changedstate.notify_all()

943

571

944

572

def enable(self):

945

573

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

946

574

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

951

579

self.last_enabled = datetime.datetime.utcnow()

952

580

self.init_checker()

953

581

self.send_changedstate()

954

582

955

583

def disable(self, quiet=True):

956

584

"""Disable this client."""

957

585

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

959

587

if not quiet:

960

588

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

961

589

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

962

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

963

591

self.disable_initiator_tag = None

964

592

self.expires = None

965

593

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

966

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

967

595

self.checker_initiator_tag = None

968

596

self.stop_checker()

969

597

self.enabled = False

970

598

if not quiet:

971

599

self.send_changedstate()

972

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

600

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

973

601

return False

974

602

975

603

def __del__(self):

976

604

self.disable()

977

605

978

606

def init_checker(self):

979

607

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

980

608

# and every interval from then on.

981

609

if self.checker_initiator_tag is not None:

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

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

986

615

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

987

616

if self.disable_initiator_tag is not None:

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

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

991

622

# Also start a new checker *right now*.

992

623

self.start_checker()

993

994

def checker_callback(self, source, condition, connection,

995

command):

624

625

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

996

626

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

997

627

self.checker_callback_tag = None

998

628

self.checker = None

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1006

631

if self.last_checker_status == 0:

1007

632

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

1008

633

vars(self))

1009

634

self.checked_ok()

1010

635

else:

1011

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

636

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

637

vars(self))

1012

638

else:

1013

639

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

1015

640

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

1016

641

vars(self))

1017

return False

1018

642

1019

643

def checked_ok(self):

1020

644

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

1021

645

self.last_checked_ok = datetime.datetime.utcnow()

1022

646

self.last_checker_status = 0

1023

self.last_checker_signal = None

1024

647

self.bump_timeout()

1025

648

1026

649

def bump_timeout(self, timeout=None):

1027

650

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

1028

651

if timeout is None:

1029

652

timeout = self.timeout

1030

653

if self.disable_initiator_tag is not None:

1031

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1032

655

self.disable_initiator_tag = None

1033

656

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

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1036

660

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

1037

661

1038

662

def need_approval(self):

1039

663

self.last_approval_request = datetime.datetime.utcnow()

1040

664

1041

665

def start_checker(self):

1042

666

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

1043

667

1044

668

If a checker already exists, leave it running and do

1045

669

nothing."""

1046

670

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

1051

675

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

1052

676

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

1053

677

# should be.

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

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)

1059

693

# Start a new checker if needed

1060

694

if self.checker is None:

1061

695

# Escape attributes for the shell

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1065

699

try:

1066

700

command = self.checker_command % escaped_attrs

1067

701

except TypeError as error:

1068

702

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

1069

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

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

1070

727

exc_info=error)

1071

return True # Try again later

1072

self.current_checker_command = command

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

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

1099

748

return True

1100

749

1101

750

def stop_checker(self):

1102

751

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

1103

752

if self.checker_callback_tag:

1104

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1105

754

self.checker_callback_tag = None

1106

755

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

1107

756

return

1108

757

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

1109

self.checker.terminate()

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

766

self.checker = None

1111

767

1112

768

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1117

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1118

772

become properties on the D-Bus.

1119

773

1120

774

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

1121

775

and with one argument by "Set".

1122

776

1123

777

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

1124

778

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

1125

779

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

1129

783

if byte_arrays and signature != "ay":

1130

784

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

1131

785

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

1132

1133

786

def decorator(func):

1134

787

func._dbus_is_property = True

1135

788

func._dbus_interface = dbus_interface

1138

791

func._dbus_name = func.__name__

1139

792

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

1140

793

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

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1142

795

return func

1143

1144

796

return decorator

1145

797

1146

798

1147

799

def dbus_interface_annotations(dbus_interface):

1148

800

"""Decorator for marking functions returning interface annotations

1149

801

1150

802

Usage:

1151

803

1152

804

@dbus_interface_annotations("org.example.Interface")

1153

805

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

1154

806

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

1155

807

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

1156

808

"false"}

1157

809

"""

1158

1159

810

def decorator(func):

1160

811

func._dbus_is_interface = True

1161

812

func._dbus_interface = dbus_interface

1162

813

func._dbus_name = dbus_interface

1163

814

return func

1164

1165

815

return decorator

1166

816

1167

817

1168

818

def dbus_annotations(annotations):

1169

819

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

1170

820

Usage:

1171

821

1172

822

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

1173

823

"org.freedesktop.DBus.Property."

1174

824

"EmitsChangedSignal": "false"})

1176

826

access="r")

1177

827

def Property_dbus_property(self):

1178

828

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

1181

829

"""

1182

1183

830

def decorator(func):

1184

831

func._dbus_annotations = annotations

1185

832

return func

1186

1187

833

return decorator

1188

834

1189

835

1192

838

"""

1193

839

pass

1194

840

1195

1196

841

class DBusPropertyAccessException(DBusPropertyException):

1197

842

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

1198

843

"""

1205

850

pass

1206

851

1207

852

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

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.

1213

859

"""

1214

860

1215

861

@staticmethod

1216

862

def _is_dbus_thing(thing):

1217

863

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

1218

864

1219

865

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

1220

866

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

1221

867

"""

1222

868

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

1223

869

False)

1224

870

1225

871

def _get_all_dbus_things(self, thing):

1226

872

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

1227

873

"""

1228

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

874

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

875

name),

1229

876

athing.__get__(self))

1230

877

for cls in self.__class__.__mro__

1231

878

for name, athing in

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1305

882

def _get_dbus_property(self, interface_name, property_name):

1306

883

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

1307

884

property with the specified name and interface.

1308

885

"""

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1312

890

if (value._dbus_name == property_name

1313

891

and value._dbus_interface == interface_name):

1314

892

return value.__get__(self)

1315

893

1316

894

# No such property

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1331

900

out_signature="v")

1332

901

def Get(self, interface_name, property_name):

1333

902

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

1339

908

if not hasattr(value, "variant_level"):

1340

909

return value

1341

910

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

1342

911

1343

912

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

1344

913

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

1345

914

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

1357

926

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

1358

927

for byte in value))

1359

928

prop(value)

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

929

930

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

1363

931

out_signature="a{sv}")

1364

932

def GetAll(self, interface_name):

1365

933

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

1366

934

standard.

1367

935

1368

936

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

1369

937

"""

1370

938

properties = {}

1380

948

if not hasattr(value, "variant_level"):

1381

949

properties[name] = value

1382

950

continue

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1385

953

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

1386

954

1387

955

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

1388

956

def PropertiesChanged(self, interface_name, changed_properties,

1389

957

invalidated_properties):

1391

959

standard.

1392

960

"""

1393

961

pass

1394

962

1395

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1396

964

out_signature="s",

1397

965

path_keyword='object_path',

1398

966

connection_keyword='connection')

1399

967

def Introspect(self, object_path, connection):

1400

968

"""Overloading of standard D-Bus method.

1401

969

1402

970

Inserts property tags and interface annotation tags.

1403

971

"""

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

972

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

973

connection)

1407

974

try:

1408

975

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

1409

1410

976

def make_tag(document, name, prop):

1411

977

e = document.createElement("property")

1412

978

e.setAttribute("name", name)

1413

979

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

1414

980

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

1415

981

return e

1416

1417

982

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

1418

983

# Add property tags

1419

984

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

1422

987

if prop._dbus_interface

1423

988

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

1424

989

if_tag.appendChild(tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_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)

1441

1021

# Add the names to the return values for the

1442

1022

# "org.freedesktop.DBus.Properties" methods

1443

1023

if (if_tag.getAttribute("name")

1462

1042

return xmlstring

1463

1043

1464

1044

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1536

1045

def datetime_to_dbus(dt, variant_level=0):

1537

1046

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

1538

1047

if dt is None:

1539

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

1540

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

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1541

1051

1542

1052

1543

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1545

1055

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

1546

1056

interface names according to the "alt_interface_names" mapping.

1547

1057

Usage:

1548

1058

1549

1059

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

1550

1060

"net.example.AlternateInterface"})

1551

1061

class SampleDBusObject(dbus.service.Object):

1552

1062

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

1553

1063

def SampleDBusMethod():

1554

1064

pass

1555

1065

1556

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1557

1067

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

1558

1068

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

1559

1069

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

1560

1070

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

1561

1071

1562

1072

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

1563

1073

(from DBusObjectWithProperties) and interfaces (from the

1564

1074

dbus_interface_annotations decorator).

1565

1075

"""

1566

1567

1076

def wrapper(cls):

1568

1077

for orig_interface_name, alt_interface_name in (

1569

alt_interface_names.items()):

1078

alt_interface_names.items()):

1570

1079

attr = {}

1571

1080

interface_names = set()

1572

1081

# Go though all attributes of the class

1574

1083

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

1575

1084

# with the wrong interface name

1576

1085

if (not hasattr(attribute, "_dbus_interface")

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1579

1088

continue

1580

1089

# Create an alternate D-Bus interface name based on

1581

1090

# the current name

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1584

1094

interface_names.add(alt_interface)

1585

1095

# Is this a D-Bus signal?

1586

1096

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

1587

1097

# Extract the original non-method undecorated

1588

1098

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1591

1100

zip(attribute.func_code.co_freevars,

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1599

1103

# Create a new, but exactly alike, function

1600

1104

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

1601

1105

# with the alternate D-Bus interface name

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

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

1606

1115

# Copy annotations, if any

1607

1116

try:

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1610

1119

except AttributeError:

1611

1120

pass

1612

1613

1121

# Define a creator of a function to call both the

1614

1122

# original and alternate functions, so both the

1615

1123

# original and alternate signals gets sent when

1618

1126

"""This function is a scope container to pass

1619

1127

func1 and func2 to the "call_both" function

1620

1128

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1623

1129

def call_both(*args, **kwargs):

1624

1130

"""This function will emit two D-Bus

1625

1131

signals by calling func1 and func2"""

1626

1132

func1(*args, **kwargs)

1627

1133

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1634

1134

return call_both

1635

1135

# Create the "call_both" function and add it to

1636

1136

# the class

1641

1141

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

1642

1142

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

1643

1143

# to the class.

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

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

1650

1154

# Copy annotations, if any

1651

1155

try:

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1654

1158

except AttributeError:

1655

1159

pass

1656

1160

# Is this a D-Bus property?

1659

1163

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

1660

1164

# property with the alternate D-Bus interface

1661

1165

# name. Add it to the class.

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

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

1668

1179

# Copy annotations, if any

1669

1180

try:

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1672

1183

except AttributeError:

1673

1184

pass

1674

1185

# Is this a D-Bus interface?

1677

1188

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

1678

1189

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

1679

1190

# to the class.

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

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

1683

1199

if deprecate:

1684

1200

# Deprecate all alternate interfaces

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1686

1202

for interface_name in interface_names:

1687

1688

1203

@dbus_interface_annotations(interface_name)

1689

1204

def func(self):

1690

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

1691

"true"}

1205

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

1206

"true" }

1692

1207

# Find an unused name

1693

1208

for aname in (iname.format(i)

1694

1209

for i in itertools.count()):

1698

1213

if interface_names:

1699

1214

# Replace the class with a new subclass of it with

1700

1215

# methods, signals, etc. as created above.

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1216

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

1217

(cls,), attr)

1707

1218

return cls

1708

1709

1219

return wrapper

1710

1220

1711

1221

1712

1222

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

1713

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1714

1224

class ClientDBus(Client, DBusObjectWithProperties):

1715

1225

"""A Client class using D-Bus

1716

1226

1717

1227

Attributes:

1718

1228

dbus_object_path: dbus.ObjectPath

1719

1229

bus: dbus.SystemBus()

1720

1230

"""

1721

1231

1722

1232

runtime_expansions = (Client.runtime_expansions

1723

+ ("dbus_object_path", ))

1724

1233

+ ("dbus_object_path",))

1234

1725

1235

_interface = "se.recompile.Mandos.Client"

1726

1236

1727

1237

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

1728

1729

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

1238

1239

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

1730

1240

self.bus = bus

1731

1241

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

1732

1242

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

1734

1244

client_object_name = str(self.name).translate(

1735

1245

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

1736

1246

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

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1739

1249

DBusObjectWithProperties.__init__(self, self.bus,

1740

1250

self.dbus_object_path)

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1746

1255

_interface=_interface):

1747

1256

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

1748

1257

its changes to DBus.

1749

1258

1750

1259

transform_fun: Function that takes a value and a variant_level

1751

1260

and transforms it to a D-Bus type.

1752

1261

dbus_name: D-Bus name of the variable

1755

1264

variant_level: D-Bus variant level. Default: 1

1756

1265

"""

1757

1266

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

1758

1759

1267

def setter(self, value):

1760

1268

if hasattr(self, "dbus_object_path"):

1761

1269

if (not hasattr(self, attrname) or

1762

1270

type_func(getattr(self, attrname, None))

1763

1271

!= type_func(value)):

1764

1272

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1768

1277

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1772

1281

self.PropertyChanged(dbus.String(dbus_name),

1773

1282

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1779

1287

setattr(self, attrname, value)

1780

1288

1781

1289

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

1782

1290

1783

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1784

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1785

1293

"ApprovalPending",

1786

type_func=bool)

1294

type_func = bool)

1787

1295

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

1788

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1789

1297

"LastEnabled")

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1793

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1794

1302

"LastCheckedOK")

1795

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1798

1306

datetime_to_dbus, "LastApprovalRequest")

1799

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1800

1308

"ApprovedByDefault")

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1804

1314

approval_duration = notifychangeproperty(

1805

1315

dbus.UInt64, "ApprovalDuration",

1806

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

1316

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

1807

1317

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

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1811

1321

extended_timeout = notifychangeproperty(

1812

1322

dbus.UInt64, "ExtendedTimeout",

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

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)

1817

1329

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

1818

1330

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

1819

1331

invalidate_only=True)

1820

1332

1821

1333

del notifychangeproperty

1822

1334

1823

1335

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

1824

1336

try:

1825

1337

self.remove_from_connection()

1828

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1829

1341

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

1830

1342

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

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

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)

1839

1350

# Emit D-Bus signal

1840

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1843

1353

dbus.String(command))

1844

1354

else:

1845

1355

# Emit D-Bus signal

1846

1356

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

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1357

dbus.Int64(condition),

1851

1358

dbus.String(command))

1852

return ret

1853

1359

1360

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

1361

*args, **kwargs)

1362

1854

1363

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

1855

1364

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

1856

1365

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

1860

1369

# Emit D-Bus signal

1861

1370

self.CheckerStarted(self.current_checker_command)

1862

1371

return r

1863

1372

1864

1373

def _reset_approved(self):

1865

1374

self.approved = None

1866

1375

return False

1867

1376

1868

1377

def approve(self, value=True):

1869

1378

self.approved = value

1870

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

1871

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1872

1381

self.send_changedstate()

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1880

1389

# CheckerCompleted - signal

1881

1390

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

1882

1391

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

1883

1392

"D-Bus signal"

1884

1393

pass

1885

1394

1886

1395

# CheckerStarted - signal

1887

1396

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

1888

1397

def CheckerStarted(self, command):

1889

1398

"D-Bus signal"

1890

1399

pass

1891

1400

1892

1401

# PropertyChanged - signal

1893

1402

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

1894

1403

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

1895

1404

def PropertyChanged(self, property, value):

1896

1405

"D-Bus signal"

1897

1406

pass

1898

1407

1899

1408

# GotSecret - signal

1900

1409

@dbus.service.signal(_interface)

1901

1410

def GotSecret(self):

1904

1413

server to mandos-client

1905

1414

"""

1906

1415

pass

1907

1416

1908

1417

# Rejected - signal

1909

1418

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

1910

1419

def Rejected(self, reason):

1911

1420

"D-Bus signal"

1912

1421

pass

1913

1422

1914

1423

# NeedApproval - signal

1915

1424

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

1916

1425

def NeedApproval(self, timeout, default):

1917

1426

"D-Bus signal"

1918

1427

return self.need_approval()

1919

1920

# Methods

1921

1428

1429

## Methods

1430

1922

1431

# Approve - method

1923

1432

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

1924

1433

def Approve(self, value):

1925

1434

self.approve(value)

1926

1435

1927

1436

# CheckedOK - method

1928

1437

@dbus.service.method(_interface)

1929

1438

def CheckedOK(self):

1930

1439

self.checked_ok()

1931

1440

1932

1441

# Enable - method

1933

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

1934

1442

@dbus.service.method(_interface)

1935

1443

def Enable(self):

1936

1444

"D-Bus method"

1937

1445

self.enable()

1938

1446

1939

1447

# StartChecker - method

1940

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

1941

1448

@dbus.service.method(_interface)

1942

1449

def StartChecker(self):

1943

1450

"D-Bus method"

1944

1451

self.start_checker()

1945

1452

1946

1453

# Disable - method

1947

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

1948

1454

@dbus.service.method(_interface)

1949

1455

def Disable(self):

1950

1456

"D-Bus method"

1951

1457

self.disable()

1952

1458

1953

1459

# StopChecker - method

1954

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

1955

1460

@dbus.service.method(_interface)

1956

1461

def StopChecker(self):

1957

1462

self.stop_checker()

1958

1959

# Properties

1960

1463

1464

## Properties

1465

1961

1466

# ApprovalPending - property

1962

1467

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

1963

1468

def ApprovalPending_dbus_property(self):

1964

1469

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

1965

1470

1966

1471

# ApprovedByDefault - property

1967

@dbus_service_property(_interface,

1968

signature="b",

1472

@dbus_service_property(_interface, signature="b",

1969

1473

access="readwrite")

1970

1474

def ApprovedByDefault_dbus_property(self, value=None):

1971

1475

if value is None: # get

1972

1476

return dbus.Boolean(self.approved_by_default)

1973

1477

self.approved_by_default = bool(value)

1974

1478

1975

1479

# ApprovalDelay - property

1976

@dbus_service_property(_interface,

1977

signature="t",

1480

@dbus_service_property(_interface, signature="t",

1978

1481

access="readwrite")

1979

1482

def ApprovalDelay_dbus_property(self, value=None):

1980

1483

if value is None: # get

1981

1484

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

1982

1485

* 1000)

1983

1486

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

1984

1487

1985

1488

# ApprovalDuration - property

1986

@dbus_service_property(_interface,

1987

signature="t",

1489

@dbus_service_property(_interface, signature="t",

1988

1490

access="readwrite")

1989

1491

def ApprovalDuration_dbus_property(self, value=None):

1990

1492

if value is None: # get

1991

1493

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

1992

1494

* 1000)

1993

1495

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

1994

1496

1995

1497

# Name - property

1996

@dbus_annotations(

1997

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

1998

1498

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

1999

1499

def Name_dbus_property(self):

2000

1500

return dbus.String(self.name)

2001

1501

2002

1502

# Fingerprint - property

2003

@dbus_annotations(

2004

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

2005

1503

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

2006

1504

def Fingerprint_dbus_property(self):

2007

1505

return dbus.String(self.fingerprint)

2008

1506

2009

1507

# Host - property

2010

@dbus_service_property(_interface,

2011

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2012

1509

access="readwrite")

2013

1510

def Host_dbus_property(self, value=None):

2014

1511

if value is None: # get

2015

1512

return dbus.String(self.host)

2016

1513

self.host = str(value)

2017

1514

2018

1515

# Created - property

2019

@dbus_annotations(

2020

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

2021

1516

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

2022

1517

def Created_dbus_property(self):

2023

1518

return datetime_to_dbus(self.created)

2024

1519

2025

1520

# LastEnabled - property

2026

1521

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

2027

1522

def LastEnabled_dbus_property(self):

2028

1523

return datetime_to_dbus(self.last_enabled)

2029

1524

2030

1525

# Enabled - property

2031

@dbus_service_property(_interface,

2032

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2033

1527

access="readwrite")

2034

1528

def Enabled_dbus_property(self, value=None):

2035

1529

if value is None: # get

2038

1532

self.enable()

2039

1533

else:

2040

1534

self.disable()

2041

1535

2042

1536

# LastCheckedOK - property

2043

@dbus_service_property(_interface,

2044

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2045

1538

access="readwrite")

2046

1539

def LastCheckedOK_dbus_property(self, value=None):

2047

1540

if value is not None:

2048

1541

self.checked_ok()

2049

1542

return

2050

1543

return datetime_to_dbus(self.last_checked_ok)

2051

1544

2052

1545

# LastCheckerStatus - property

2053

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2054

1548

def LastCheckerStatus_dbus_property(self):

2055

1549

return dbus.Int16(self.last_checker_status)

2056

1550

2057

1551

# Expires - property

2058

1552

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

2059

1553

def Expires_dbus_property(self):

2060

1554

return datetime_to_dbus(self.expires)

2061

1555

2062

1556

# LastApprovalRequest - property

2063

1557

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

2064

1558

def LastApprovalRequest_dbus_property(self):

2065

1559

return datetime_to_dbus(self.last_approval_request)

2066

1560

2067

1561

# Timeout - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2070

1563

access="readwrite")

2071

1564

def Timeout_dbus_property(self, value=None):

2072

1565

if value is None: # get

2084

1577

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

2085

1578

is None):

2086

1579

return

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

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

2092

1586

# ExtendedTimeout - property

2093

@dbus_service_property(_interface,

2094

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2095

1588

access="readwrite")

2096

1589

def ExtendedTimeout_dbus_property(self, value=None):

2097

1590

if value is None: # get

2098

1591

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

2099

1592

* 1000)

2100

1593

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

2101

1594

2102

1595

# Interval - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2105

1597

access="readwrite")

2106

1598

def Interval_dbus_property(self, value=None):

2107

1599

if value is None: # get

2111

1603

return

2112

1604

if self.enabled:

2113

1605

# Reschedule checker run

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

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

2119

1611

# Checker - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2122

1613

access="readwrite")

2123

1614

def Checker_dbus_property(self, value=None):

2124

1615

if value is None: # get

2125

1616

return dbus.String(self.checker_command)

2126

1617

self.checker_command = str(value)

2127

1618

2128

1619

# CheckerRunning - property

2129

@dbus_service_property(_interface,

2130

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2131

1621

access="readwrite")

2132

1622

def CheckerRunning_dbus_property(self, value=None):

2133

1623

if value is None: # get

2136

1626

self.start_checker()

2137

1627

else:

2138

1628

self.stop_checker()

2139

1629

2140

1630

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

2144

1631

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

2145

1632

def ObjectPath_dbus_property(self):

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2148

1635

# Secret = property

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2156

1638

def Secret_dbus_property(self, value):

2157

1639

self.secret = bytes(value)

2158

1640

2159

1641

del _interface

2160

1642

2161

1643

2164

1646

self._pipe = child_pipe

2165

1647

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

2166

1648

if not self._pipe.recv():

2167

raise KeyError(fpr)

2168

1649

raise KeyError()

1650

2169

1651

def __getattribute__(self, name):

2170

1652

if name == '_pipe':

2171

1653

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

2174

1656

if data[0] == 'data':

2175

1657

return data[1]

2176

1658

if data[0] == 'function':

2177

2178

1659

def func(*args, **kwargs):

2179

1660

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

2180

1661

return self._pipe.recv()[1]

2181

2182

1662

return func

2183

1663

2184

1664

def __setattr__(self, name, value):

2185

1665

if name == '_pipe':

2186

1666

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

2189

1669

2190

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2191

1671

"""A class to handle client connections.

2192

1672

2193

1673

Instantiated once for each connection to handle it.

2194

1674

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

2195

1675

2196

1676

def handle(self):

2197

1677

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

2198

1678

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

2199

1679

str(self.client_address))

2200

1680

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

2201

1681

self.server.child_pipe.fileno())

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

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

2209

1697

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

2210

1698

priority = self.server.gnutls_priority

2211

1699

if priority is None:

2212

1700

priority = "NORMAL"

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2217

1705

# Start communication using the Mandos protocol

2218

1706

# Get protocol number

2219

1707

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

2224

1712

except (ValueError, IndexError, RuntimeError) as error:

2225

1713

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

2226

1714

return

2227

1715

2228

1716

# Start GnuTLS connection

2229

1717

try:

2230

1718

session.handshake()

2231

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2232

1720

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

2233

1721

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

2234

1722

# established. Just abandon the request.

2235

1723

return

2236

1724

logger.debug("Handshake succeeded")

2237

1725

2238

1726

approval_required = False

2239

1727

try:

2240

1728

try:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

2244

1733

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

2245

1734

return

2246

1735

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

2247

1736

2248

1737

try:

2249

1738

client = ProxyClient(child_pipe, fpr,

2250

1739

self.client_address)

2251

1740

except KeyError:

2252

1741

return

2253

1742

2254

1743

if client.approval_delay:

2255

1744

delay = client.approval_delay

2256

1745

client.approvals_pending += 1

2257

1746

approval_required = True

2258

1747

2259

1748

while True:

2260

1749

if not client.enabled:

2261

1750

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

2262

client.name)

1751

client.name)

2263

1752

if self.server.use_dbus:

2264

1753

# Emit D-Bus signal

2265

1754

client.Rejected("Disabled")

2266

1755

return

2267

1756

2268

1757

if client.approved or not client.approval_delay:

2269

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2270

1759

break

2271

1760

elif client.approved is None:

2272

1761

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

2283

1772

# Emit D-Bus signal

2284

1773

client.Rejected("Denied")

2285

1774

return

2286

2287

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2288

1777

time = datetime.datetime.now()

2289

1778

client.changedstate.acquire()

2290

1779

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

2303

1792

break

2304

1793

else:

2305

1794

delay -= time2 - time

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

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

2314

1809

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

2315

1810

# bump the timeout using extended_timeout

2316

1811

client.bump_timeout(client.extended_timeout)

2317

1812

if self.server.use_dbus:

2318

1813

# Emit D-Bus signal

2319

1814

client.GotSecret()

2320

1815

2321

1816

finally:

2322

1817

if approval_required:

2323

1818

client.approvals_pending -= 1

2324

1819

try:

2325

1820

session.bye()

2326

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2327

1822

logger.warning("GnuTLS bye failed",

2328

1823

exc_info=error)

2329

1824

2330

1825

@staticmethod

2331

1826

def peer_certificate(session):

2332

1827

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

2333

1828

# If not an OpenPGP certificate...

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

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

2338

1834

list_size = ctypes.c_uint(1)

2339

cert_list = (gnutls.certificate_get_peers

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2340

1837

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

2341

1838

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

2342

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

1839

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

1840

" certificate")

2343

1841

if list_size.value == 0:

2344

1842

return None

2345

1843

cert = cert_list[0]

2346

1844

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

2347

1845

2348

1846

@staticmethod

2349

1847

def fingerprint(openpgp):

2350

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2351

1849

# New GnuTLS "datum" with the OpenPGP public key

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

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

2356

1855

# New empty GnuTLS certificate

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2359

1859

# Import the OpenPGP public key into the certificate

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2362

1864

# Verify the self signature in the key

2363

1865

crtverify = ctypes.c_uint()

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2366

1869

if crtverify.value != 0:

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2369

1873

# New buffer for the fingerprint

2370

1874

buf = ctypes.create_string_buffer(20)

2371

1875

buf_len = ctypes.c_size_t()

2372

1876

# Get the fingerprint from the certificate into the buffer

2373

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

2374

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2375

1880

# Deinit the certificate

2376

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

1882

# Convert the buffer to a Python bytestring

2378

1883

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

2379

1884

# Convert the bytestring to hexadecimal notation

2383

1888

2384

1889

class MultiprocessingMixIn(object):

2385

1890

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

2386

2387

1891

def sub_process_main(self, request, address):

2388

1892

try:

2389

1893

self.finish_request(request, address)

2390

1894

except Exception:

2391

1895

self.handle_error(request, address)

2392

1896

self.close_request(request)

2393

1897

2394

1898

def process_request(self, request, address):

2395

1899

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

2396

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

2397

args=(request, address))

1900

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

1901

args = (request, address))

2398

1902

proc.start()

2399

1903

return proc

2400

1904

2401

1905

2402

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2403

1907

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

2404

2405

1908

def process_request(self, request, client_address):

2406

1909

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

2407

1910

2408

1911

This function creates a new pipe in self.pipe

2409

1912

"""

2410

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2411

1914

2412

1915

proc = MultiprocessingMixIn.process_request(self, request,

2413

1916

client_address)

2414

1917

self.child_pipe.close()

2415

1918

self.add_pipe(parent_pipe, proc)

2416

1919

2417

1920

def add_pipe(self, parent_pipe, proc):

2418

1921

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

2419

1922

raise NotImplementedError()

2422

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2423

1926

socketserver.TCPServer, object):

2424

1927

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

2425

1928

2426

1929

Attributes:

2427

1930

enabled: Boolean; whether this server is activated yet

2428

1931

interface: None or a network interface name (string)

2429

1932

use_ipv6: Boolean; to use IPv6 or not

2430

1933

"""

2431

2432

1934

def __init__(self, server_address, RequestHandlerClass,

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

1935

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

2436

1936

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

2437

1937

creating a new one with socket.socket().

2438

1938

"""

2444

1944

self.socketfd = socketfd

2445

1945

# Save the original socket.socket() function

2446

1946

self.socket_socket = socket.socket

2447

2448

1947

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

2449

#

1948

#

2450

1949

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

2451

1950

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

2452

1951

# patching socket.socket.)

2453

#

1952

#

2454

1953

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

2455

1954

@functools.wraps(socket.socket)

2456

1955

def socket_wrapper(*args, **kwargs):

2468

1967

# socket_wrapper(), if socketfd was set.

2469

1968

socketserver.TCPServer.__init__(self, server_address,

2470

1969

RequestHandlerClass)

2471

1970

2472

1971

def server_bind(self):

2473

1972

"""This overrides the normal server_bind() function

2474

1973

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

2475

1974

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

2476

global SO_BINDTODEVICE

2477

1975

if self.interface is not None:

2478

1976

if SO_BINDTODEVICE is None:

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

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

2500

1999

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

2501

2000

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

2502

2001

if not self.server_address[0]:

2503

2002

if self.address_family == socket.AF_INET6:

2504

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2505

2004

else:

2506

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2507

2006

self.server_address = (any_address,

2508

2007

self.server_address[1])

2509

2008

elif not self.server_address[1]:

2510

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

2009

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

2010

0)

2511

2011

# if self.interface:

2512

2012

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

2513

2013

# 0, # port

2519

2019

2520

2020

class MandosServer(IPv6_TCPServer):

2521

2021

"""Mandos server.

2522

2022

2523

2023

Attributes:

2524

2024

clients: set of Client objects

2525

2025

gnutls_priority GnuTLS priority string

2526

2026

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

2527

2528

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2529

2029

"""

2530

2531

2030

def __init__(self, server_address, RequestHandlerClass,

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

2031

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

2032

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

2538

2033

self.enabled = False

2539

2034

self.clients = clients

2540

2035

if self.clients is None:

2543

2038

self.gnutls_priority = gnutls_priority

2544

2039

IPv6_TCPServer.__init__(self, server_address,

2545

2040

RequestHandlerClass,

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2550

2044

def server_activate(self):

2551

2045

if self.enabled:

2552

2046

return socketserver.TCPServer.server_activate(self)

2553

2047

2554

2048

def enable(self):

2555

2049

self.enabled = True

2556

2050

2557

2051

def add_pipe(self, parent_pipe, proc):

2558

2052

# Call "handle_ipc" for both data and EOF events

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

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

2570

2062

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

2571

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

2063

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

2572

2064

# Wait for other process to exit

2573

2065

proc.join()

2574

2066

return False

2575

2067

2576

2068

# Read a request from the child

2577

2069

request = parent_pipe.recv()

2578

2070

command = request[0]

2579

2071

2580

2072

if command == 'init':

2581

2073

fpr = request[1]

2582

2074

address = request[2]

2583

2584

for c in self.clients.values():

2075

2076

for c in self.clients.itervalues():

2585

2077

if c.fingerprint == fpr:

2586

2078

client = c

2587

2079

break

2594

2086

address[0])

2595

2087

parent_pipe.send(False)

2596

2088

return False

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

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

2605

2098

parent_pipe.send(True)

2606

2099

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

2607

2100

# same fileno

2610

2103

funcname = request[1]

2611

2104

args = request[2]

2612

2105

kwargs = request[3]

2613

2106

2614

2107

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

2615

2108

funcname)(*args,

2616

**kwargs)))

2617

2109

**kwargs)))

2110

2618

2111

if command == 'getattr':

2619

2112

attrname = request[1]

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2623

2115

else:

2624

parent_pipe.send((

2625

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

2626

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2627

2119

if command == 'setattr':

2628

2120

attrname = request[1]

2629

2121

value = request[2]

2630

2122

setattr(client_object, attrname, value)

2631

2123

2632

2124

return True

2633

2125

2634

2126

2635

2127

def rfc3339_duration_to_delta(duration):

2636

2128

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

2637

2129

2638

2130

>>> rfc3339_duration_to_delta("P7D")

2639

2131

datetime.timedelta(7)

2640

2132

>>> rfc3339_duration_to_delta("PT60S")

2650

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2651

2143

datetime.timedelta(1, 200)

2652

2144

"""

2653

2145

2654

2146

# Parsing an RFC 3339 duration with regular expressions is not

2655

2147

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

2656

2148

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

2657

2149

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

2658

2150

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

2659

2151

# avoid excessive use of external libraries.

2660

2152

2661

2153

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

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

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

2667

2163

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

2668

2164

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

2669

2165

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

2670

2166

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

2671

2167

datetime.timedelta(seconds=1),

2672

frozenset((token_end, )))

2168

frozenset((token_end,)))

2673

2169

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

2674

2170

datetime.timedelta(minutes=1),

2675

2171

frozenset((token_second, token_end)))

2691

2187

frozenset((token_month, token_end)))

2692

2188

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

2693

2189

datetime.timedelta(weeks=1),

2694

frozenset((token_end, )))

2190

frozenset((token_end,)))

2695

2191

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

2696

2192

frozenset((token_year, token_month,

2697

2193

token_day, token_time,

2698

2194

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2702

2197

found_token = None

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2198

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

2199

s = duration # String left to parse

2707

2200

# Loop until end token is found

2708

2201

while found_token is not token_end:

2709

2202

# Search for any currently valid tokens

2725

2218

break

2726

2219

else:

2727

2220

# No currently valid tokens were found

2728

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

2729

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2730

2222

# End token found

2731

2223

return value

2732

2224

2733

2225

2734

2226

def string_to_delta(interval):

2735

2227

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

2736

2228

2737

2229

>>> string_to_delta('7d')

2738

2230

datetime.timedelta(7)

2739

2231

>>> string_to_delta('60s')

2747

2239

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

2748

2240

datetime.timedelta(0, 330)

2749

2241

"""

2750

2242

2751

2243

try:

2752

2244

return rfc3339_duration_to_delta(interval)

2753

2245

except ValueError:

2754

2246

pass

2755

2247

2756

2248

timevalue = datetime.timedelta(0)

2757

2249

for s in interval.split():

2758

2250

try:

2769

2261

elif suffix == "w":

2770

2262

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

2771

2263

else:

2772

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2773

2266

except IndexError as e:

2774

2267

raise ValueError(*(e.args))

2775

2268

timevalue += delta

2776

2269

return timevalue

2777

2270

2778

2271

2779

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

2272

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

2780

2273

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

2781

2274

2782

2275

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

2783

2276

if os.fork():

2784

2277

sys.exit()

2791

2284

# Close all standard open file descriptors

2792

2285

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

2793

2286

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

2794

raise OSError(errno.ENODEV,

2795

"{} not a character device"

2287

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

2796

2288

.format(os.devnull))

2797

2289

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

2798

2290

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

2802

2294

2803

2295

2804

2296

def main():

2805

2297

2806

2298

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

2807

2299

# Parsing of options, both command line and config file

2808

2300

2809

2301

parser = argparse.ArgumentParser()

2810

2302

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

2811

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

2303

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

2812

2304

help="show version number and exit")

2813

2305

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

2814

2306

help="Bind to interface IF")

2850

2342

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

2851

2343

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

2852

2344

default=None)

2853

2345

2854

2346

options = parser.parse_args()

2855

2347

2856

2348

if options.check:

2857

2349

import doctest

2858

2350

fail_count, test_count = doctest.testmod()

2859

2351

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

2860

2352

2861

2353

# Default values for config file for server-global settings

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2354

server_defaults = { "interface": "",

2355

"address": "",

2356

"port": "",

2357

"debug": "False",

2358

"priority":

2359

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

2360

":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2361

"servicename": "Mandos",

2362

"use_dbus": "True",

2363

"use_ipv6": "True",

2364

"debuglevel": "",

2365

"restore": "True",

2366

"socket": "",

2367

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

2368

"foreground": "False",

2369

"zeroconf": "True",

2370

}

2371

2880

2372

# Parse config file for server-global settings

2881

2373

server_config = configparser.SafeConfigParser(server_defaults)

2882

2374

del server_defaults

2883

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

2375

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

2376

"mandos.conf"))

2884

2377

# Convert the SafeConfigParser object to a dict

2885

2378

server_settings = server_config.defaults()

2886

2379

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

2887

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

2888

"foreground", "zeroconf"):

2380

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

2889

2381

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

2890

2382

option)

2891

2383

if server_settings["port"]:

2901

2393

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

2902

2394

["socket"])

2903

2395

del server_config

2904

2396

2905

2397

# Override the settings from the config file with command line

2906

2398

# options, if set.

2907

2399

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

2908

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

2909

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

2910

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

2400

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

2401

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

2402

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

2911

2403

value = getattr(options, option)

2912

2404

if value is not None:

2913

2405

server_settings[option] = value

2925

2417

if server_settings["debug"]:

2926

2418

server_settings["foreground"] = True

2927

2419

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

2928

2420

2929

2421

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

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2422

2423

if (not server_settings["zeroconf"] and

2424

not (server_settings["port"]

2425

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

2426

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

2427

" Zeroconf")

2428

2936

2429

# For convenience

2937

2430

debug = server_settings["debug"]

2938

2431

debuglevel = server_settings["debuglevel"]

2942

2435

stored_state_file)

2943

2436

foreground = server_settings["foreground"]

2944

2437

zeroconf = server_settings["zeroconf"]

2945

2438

2946

2439

if debug:

2947

2440

initlogger(debug, logging.DEBUG)

2948

2441

else:

2951

2444

else:

2952

2445

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

2953

2446

initlogger(debug, level)

2954

2447

2955

2448

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

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2449

syslogger.setFormatter(logging.Formatter

2450

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

2451

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

2452

.format(server_settings

2453

["servicename"])))

2454

2961

2455

# Parse config file with clients

2962

2456

client_config = configparser.SafeConfigParser(Client

2963

2457

.client_defaults)

2964

2458

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

2965

2459

"clients.conf"))

2966

2460

2967

2461

global mandos_dbus_service

2968

2462

mandos_dbus_service = None

2969

2463

2970

2464

socketfd = None

2971

2465

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

2972

2466

socketfd = server_settings["socket"]

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2467

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

2468

server_settings["port"]),

2469

ClientHandler,

2470

interface=(server_settings["interface"]

2471

or None),

2472

use_ipv6=use_ipv6,

2473

gnutls_priority=

2474

server_settings["priority"],

2475

use_dbus=use_dbus,

2476

socketfd=socketfd)

2981

2477

if not foreground:

2982

2478

pidfilename = "/run/mandos.pid"

2983

2479

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

2984

2480

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

2985

2481

pidfile = None

2986

2482

try:

2987

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

2483

pidfile = open(pidfilename, "w")

2988

2484

except IOError as e:

2989

2485

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

2990

2486

exc_info=e)

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2487

2488

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

2995

2489

try:

2996

2490

uid = pwd.getpwnam(name).pw_uid

2997

gid = pwd.getpwnam(group).pw_gid

2491

gid = pwd.getpwnam(name).pw_gid

2998

2492

break

2999

2493

except KeyError:

3000

2494

continue

3004

2498

try:

3005

2499

os.setgid(gid)

3006

2500

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

3010

2501

except OSError as error:

3011

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

3012

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

3013

2502

if error.errno != errno.EPERM:

3014

2503

raise

3015

2504

3016

2505

if debug:

3017

2506

# Enable all possible GnuTLS debugging

3018

2507

3019

2508

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

3020

2509

# - GnuTLS manual

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2510

gnutls.library.functions.gnutls_global_set_log_level(11)

2511

2512

@gnutls.library.types.gnutls_log_func

3024

2513

def debug_gnutls(level, string):

3025

2514

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

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2515

2516

(gnutls.library.functions

2517

.gnutls_global_set_log_function(debug_gnutls))

2518

3029

2519

# Redirect stdin so all checkers get /dev/null

3030

2520

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

3031

2521

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

3032

2522

if null > 2:

3033

2523

os.close(null)

3034

2524

3035

2525

# Need to fork before connecting to D-Bus

3036

2526

if not foreground:

3037

2527

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

3038

2528

daemon()

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2529

2530

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

2531

# need to inform gobject that threads will be used.

2532

gobject.threads_init()

2533

3044

2534

global main_loop

3045

2535

# From the Avahi example code

3046

2536

DBusGMainLoop(set_as_default=True)

3047

main_loop = GLib.MainLoop()

2537

main_loop = gobject.MainLoop()

3048

2538

bus = dbus.SystemBus()

3049

2539

# End of Avahi example code

3050

2540

if use_dbus:

3051

2541

try:

3052

2542

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

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2543

bus, do_not_queue=True)

2544

old_bus_name = (dbus.service.BusName

2545

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

2546

do_not_queue=True))

2547

except dbus.exceptions.NameExistsException as e:

3059

2548

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

3060

2549

use_dbus = False

3061

2550

server_settings["use_dbus"] = False

3062

2551

tcp_server.use_dbus = False

3063

2552

if zeroconf:

3064

2553

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

2554

service = AvahiServiceToSyslog(name =

2555

server_settings["servicename"],

2556

servicetype = "_mandos._tcp",

2557

protocol = protocol, bus = bus)

3070

2558

if server_settings["interface"]:

3071

service.interface = if_nametoindex(

3072

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

3073

2559

service.interface = (if_nametoindex

2560

(server_settings["interface"]

2561

.encode("utf-8")))

2562

3074

2563

global multiprocessing_manager

3075

2564

multiprocessing_manager = multiprocessing.Manager()

3076

2565

3077

2566

client_class = Client

3078

2567

if use_dbus:

3079

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

3080

2568

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

2569

3081

2570

client_settings = Client.config_parser(client_config)

3082

2571

old_client_settings = {}

3083

2572

clients_data = {}

3084

2573

3085

2574

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

3086

2575

global wnull

3087

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

2576

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

3088

2577

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

3089

2578

# mode

3090

2579

if debug or not foreground:

3091

2580

wnull.close()

3092

2581

3093

2582

# Get client data and settings from last running state.

3094

2583

if server_settings["restore"]:

3095

2584

try:

3096

2585

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

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2586

clients_data, old_client_settings = (pickle.load

2587

(stored_state))

3142

2588

os.remove(stored_state_path)

3143

2589

except IOError as e:

3144

2590

if e.errno == errno.ENOENT:

3145

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

3146

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

2591

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

2592

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

3147

2593

else:

3148

2594

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

3149

2595

exc_info=e)

3150

2596

raise

3151

2597

except EOFError as e:

3152

2598

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

3153

"EOFError:",

3154

exc_info=e)

3155

2599

"EOFError:", exc_info=e)

2600

3156

2601

with PGPEngine() as pgp:

3157

2602

for client_name, client in clients_data.items():

3158

2603

# Skip removed clients

3159

2604

if client_name not in client_settings:

3160

2605

continue

3161

2606

3162

2607

# Decide which value to use after restoring saved state.

3163

2608

# We have three different values: Old config file,

3164

2609

# new config file, and saved state.

3169

2614

# For each value in new config, check if it

3170

2615

# differs from the old config value (Except for

3171

2616

# the "secret" attribute)

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2617

if (name != "secret" and

2618

value != old_client_settings[client_name]

2619

[name]):

3175

2620

client[name] = value

3176

2621

except KeyError:

3177

2622

pass

3178

2623

3179

2624

# Clients who has passed its expire date can still be

3180

# enabled if its last checker was successful. A Client

2625

# enabled if its last checker was successful. Clients

3181

2626

# whose checker succeeded before we stored its state is

3182

2627

# assumed to have successfully run all checkers during

3183

2628

# downtime.

3186

2631

if not client["last_checked_ok"]:

3187

2632

logger.warning(

3188

2633

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2634

"performed a successful checker"

2635

.format(client_name))

3191

2636

client["enabled"] = False

3192

2637

elif client["last_checker_status"] != 0:

3193

2638

logger.warning(

3194

2639

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2640

" checker failed with error code {}"

2641

.format(client_name,

2642

client["last_checker_status"]))

3199

2643

client["enabled"] = False

3200

2644

else:

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2645

client["expires"] = (datetime.datetime

2646

.utcnow()

2647

+ client["timeout"])

3204

2648

logger.debug("Last checker succeeded,"

3205

" keeping {} enabled".format(

3206

client_name))

2649

" keeping {} enabled"

2650

.format(client_name))

3207

2651

try:

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2652

client["secret"] = (

2653

pgp.decrypt(client["encrypted_secret"],

2654

client_settings[client_name]

2655

["secret"]))

3211

2656

except PGPError:

3212

2657

# If decryption fails, we use secret from new settings

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2658

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

2659

.format(client_name))

2660

client["secret"] = (

2661

client_settings[client_name]["secret"])

2662

3218

2663

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

3219

2664

for client_name in (set(old_client_settings)

3220

2665

- set(client_settings)):

3222

2667

for client_name in (set(client_settings)

3223

2668

- set(old_client_settings)):

3224

2669

clients_data[client_name] = client_settings[client_name]

3225

2670

3226

2671

# Create all client objects

3227

2672

for client_name, client in clients_data.items():

3228

2673

tcp_server.clients[client_name] = client_class(

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2674

name = client_name, settings = client,

2675

server_settings = server_settings)

2676

3233

2677

if not tcp_server.clients:

3234

2678

logger.warning("No clients defined")

3235

2679

3236

2680

if not foreground:

3237

2681

if pidfile is not None:

3238

pid = os.getpid()

3239

2682

try:

3240

2683

with pidfile:

3241

print(pid, file=pidfile)

2684

pid = os.getpid()

2685

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

3242

2686

except IOError:

3243

2687

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

3244

2688

pidfilename, pid)

3245

2689

del pidfile

3246

2690

del pidfilename

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2691

2692

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

2693

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

2694

3252

2695

if use_dbus:

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2696

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

2697

"se.bsnet.fukt.Mandos"})

2698

class MandosDBusService(DBusObjectWithProperties):

3257

2699

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

3258

3259

2700

def __init__(self):

3260

2701

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

3261

3262

2702

_interface = "se.recompile.Mandos"

3263

2703

2704

@dbus_interface_annotations(_interface)

2705

def _foo(self):

2706

return { "org.freedesktop.DBus.Property"

2707

".EmitsChangedSignal":

2708

"false"}

2709

3264

2710

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

3265

2711

def ClientAdded(self, objpath):

3266

2712

"D-Bus signal"

3267

2713

pass

3268

2714

3269

2715

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

3270

2716

def ClientNotFound(self, fingerprint, address):

3271

2717

"D-Bus signal"

3272

2718

pass

3273

3274

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

3275

"true"})

2719

3276

2720

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

3277

2721

def ClientRemoved(self, objpath, name):

3278

2722

"D-Bus signal"

3279

2723

pass

3280

3281

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

3282

"true"})

2724

3283

2725

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

3284

2726

def GetAllClients(self):

3285

2727

"D-Bus method"

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2728

return dbus.Array(c.dbus_object_path

2729

for c in

2730

tcp_server.clients.itervalues())

2731

3291

2732

@dbus.service.method(_interface,

3292

2733

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

3293

2734

def GetAllClientsWithProperties(self):

3294

2735

"D-Bus method"

3295

2736

return dbus.Dictionary(

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2737

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

2738

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

3299

2739

signature="oa{sv}")

3300

2740

3301

2741

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

3302

2742

def RemoveClient(self, object_path):

3303

2743

"D-Bus method"

3304

for c in tcp_server.clients.values():

2744

for c in tcp_server.clients.itervalues():

3305

2745

if c.dbus_object_path == object_path:

3306

2746

del tcp_server.clients[c.name]

3307

2747

c.remove_from_connection()

3308

# Don't signal the disabling

2748

# Don't signal anything except ClientRemoved

3309

2749

c.disable(quiet=True)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2750

# Emit D-Bus signal

2751

self.ClientRemoved(object_path, c.name)

3312

2752

return

3313

2753

raise KeyError(object_path)

3314

2754

3315

2755

del _interface

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

2756

3353

2757

mandos_dbus_service = MandosDBusService()

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2758

3360

2759

def cleanup():

3361

2760

"Cleanup function; run on exit"

3362

2761

if zeroconf:

3363

2762

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2763

2764

multiprocessing.active_children()

2765

wnull.close()

3367

2766

if not (tcp_server.clients or client_settings):

3368

2767

return

3369

2768

3370

2769

# Store client before exiting. Secrets are encrypted with key

3371

2770

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

3372

2771

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

3373

2772

clients = {}

3374

2773

with PGPEngine() as pgp:

3375

for client in tcp_server.clients.values():

2774

for client in tcp_server.clients.itervalues():

3376

2775

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

3377

2776

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

3378

2777

key)

3379

2778

client_dict = {}

3380

2779

3381

2780

# A list of attributes that can not be pickled

3382

2781

# + secret.

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2782

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

2783

"checker", "server_settings" }

2784

for name, typ in (inspect.getmembers

2785

(dbus.service.Object)):

3387

2786

exclude.add(name)

3388

2787

3389

2788

client_dict["encrypted_secret"] = (client

3390

2789

.encrypted_secret)

3391

2790

for attr in client.client_structure:

3392

2791

if attr not in exclude:

3393

2792

client_dict[attr] = getattr(client, attr)

3394

2793

3395

2794

clients[client.name] = client_dict

3396

2795

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

3397

2796

3398

2797

try:

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2798

with (tempfile.NamedTemporaryFile

2799

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

2800

dir=os.path.dirname(stored_state_path),

2801

delete=False)) as stored_state:

2802

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

2803

tempname=stored_state.name

3408

2804

os.rename(tempname, stored_state_path)

3409

2805

except (IOError, OSError) as e:

3410

2806

if not debug:

3419

2815

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

3420

2816

exc_info=e)

3421

2817

raise

3422

2818

3423

2819

# Delete all clients, and settings from config

3424

2820

while tcp_server.clients:

3425

2821

name, client = tcp_server.clients.popitem()

3426

2822

if use_dbus:

3427

2823

client.remove_from_connection()

3428

# Don't signal the disabling

2824

# Don't signal anything except ClientRemoved

3429

2825

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

3431

2826

if use_dbus:

3432

mandos_dbus_service.client_removed_signal(client)

2827

# Emit D-Bus signal

2828

mandos_dbus_service.ClientRemoved(client

2829

.dbus_object_path,

2830

client.name)

3433

2831

client_settings.clear()

3434

2832

3435

2833

atexit.register(cleanup)

3436

3437

for client in tcp_server.clients.values():

2834

2835

for client in tcp_server.clients.itervalues():

3438

2836

if use_dbus:

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2837

# Emit D-Bus signal

2838

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3441

2839

# Need to initiate checking of clients

3442

2840

if client.enabled:

3443

2841

client.init_checker()

3444

2842

3445

2843

tcp_server.enable()

3446

2844

tcp_server.server_activate()

3447

2845

3448

2846

# Find out what port we got

3449

2847

if zeroconf:

3450

2848

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

3455

2853

else: # IPv4

3456

2854

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

3457

2855

*tcp_server.socket.getsockname())

3458

3459

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

3460

2856

2857

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

2858

3461

2859

try:

3462

2860

if zeroconf:

3463

2861

# From the Avahi example code

3468

2866

cleanup()

3469

2867

sys.exit(1)

3470

2868

# End of Avahi example code

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2869

2870

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

2871

lambda *args, **kwargs:

2872

(tcp_server.handle_request

2873

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

2874

3477

2875

logger.debug("Starting main loop")

3478

2876

main_loop.run()

3479

2877

except AvahiError as error:

3488

2886

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

3489

2887

cleanup()

3490

2888

3491

3492

2889

if __name__ == '__main__':

3493

2890

main()