/mandos/trunk : revision 738.1.1

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.16"

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

496

399

class AvahiServiceToSyslog(AvahiService):

497

400

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

498

401

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

499

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

500

**kwargs)

501

syslogger.setFormatter(logging.Formatter(

502

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

503

.format(self.name)))

402

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

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

504

407

return ret

505

408

506

409

507

# Pretend that we have a GnuTLS module

508

class GnuTLS(object):

509

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

510

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

511

512

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

513

if library is None:

514

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

515

_library = ctypes.cdll.LoadLibrary(library)

516

del library

517

_need_version = b"3.3.0"

518

519

def __init__(self):

520

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

521

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

522

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

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CLIENT = 2

535

SHUT_RDWR = 0

536

CRD_CERTIFICATE = 1

537

E_NO_CERTIFICATE_FOUND = -49

538

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

539

540

# Types

541

class session_int(ctypes.Structure):

542

_fields_ = []

543

session_t = ctypes.POINTER(session_int)

544

545

class certificate_credentials_st(ctypes.Structure):

546

_fields_ = []

547

certificate_credentials_t = ctypes.POINTER(

548

certificate_credentials_st)

549

certificate_type_t = ctypes.c_int

550

551

class datum_t(ctypes.Structure):

552

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

553

('size', ctypes.c_uint)]

554

555

class openpgp_crt_int(ctypes.Structure):

556

_fields_ = []

557

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

558

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

559

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

560

credentials_type_t = ctypes.c_int

561

transport_ptr_t = ctypes.c_void_p

562

close_request_t = ctypes.c_int

563

564

# Exceptions

565

class Error(Exception):

566

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

567

# exception might be raised from within GnuTLS.__init__,

568

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

569

# global variable has happened.

570

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

571

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

572

# code is passed, convert it to a string with

573

# gnutls.strerror()

574

self.code = code

575

if message is None and code is not None:

576

message = GnuTLS.strerror(code)

577

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

578

message, *args)

579

580

class CertificateSecurityError(Error):

581

pass

582

583

# Classes

584

class Credentials(object):

585

def __init__(self):

586

self._c_object = gnutls.certificate_credentials_t()

587

gnutls.certificate_allocate_credentials(

588

ctypes.byref(self._c_object))

589

self.type = gnutls.CRD_CERTIFICATE

590

591

def __del__(self):

592

gnutls.certificate_free_credentials(self._c_object)

593

594

class ClientSession(object):

595

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

596

self._c_object = gnutls.session_t()

597

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

598

gnutls.set_default_priority(self._c_object)

599

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

600

gnutls.handshake_set_private_extensions(self._c_object,

601

True)

602

self.socket = socket

603

if credentials is None:

604

credentials = gnutls.Credentials()

605

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

606

ctypes.cast(credentials._c_object,

607

ctypes.c_void_p))

608

self.credentials = credentials

609

610

def __del__(self):

611

gnutls.deinit(self._c_object)

612

613

def handshake(self):

614

return gnutls.handshake(self._c_object)

615

616

def send(self, data):

617

data = bytes(data)

618

data_len = len(data)

619

while data_len > 0:

620

data_len -= gnutls.record_send(self._c_object,

621

data[-data_len:],

622

data_len)

623

624

def bye(self):

625

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

626

627

# Error handling functions

628

def _error_code(result):

629

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

630

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

631

if result >= 0:

632

return result

633

if result == gnutls.E_NO_CERTIFICATE_FOUND:

634

raise gnutls.CertificateSecurityError(code=result)

635

raise gnutls.Error(code=result)

636

637

def _retry_on_error(result, func, arguments):

638

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

639

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

640

while result < 0:

641

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

642

return _error_code(result)

643

result = func(*arguments)

644

return result

645

646

# Unless otherwise indicated, the function declarations below are

647

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

648

649

# Functions

650

priority_set_direct = _library.gnutls_priority_set_direct

651

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

652

ctypes.POINTER(ctypes.c_char_p)]

653

priority_set_direct.restype = _error_code

654

655

init = _library.gnutls_init

656

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

657

init.restype = _error_code

658

659

set_default_priority = _library.gnutls_set_default_priority

660

set_default_priority.argtypes = [session_t]

661

set_default_priority.restype = _error_code

662

663

record_send = _library.gnutls_record_send

664

record_send.argtypes = [session_t, ctypes.c_void_p,

665

ctypes.c_size_t]

666

record_send.restype = ctypes.c_ssize_t

667

record_send.errcheck = _retry_on_error

668

669

certificate_allocate_credentials = (

670

_library.gnutls_certificate_allocate_credentials)

671

certificate_allocate_credentials.argtypes = [

672

ctypes.POINTER(certificate_credentials_t)]

673

certificate_allocate_credentials.restype = _error_code

674

675

certificate_free_credentials = (

676

_library.gnutls_certificate_free_credentials)

677

certificate_free_credentials.argtypes = [

678

certificate_credentials_t]

679

certificate_free_credentials.restype = None

680

681

handshake_set_private_extensions = (

682

_library.gnutls_handshake_set_private_extensions)

683

handshake_set_private_extensions.argtypes = [session_t,

684

ctypes.c_int]

685

handshake_set_private_extensions.restype = None

686

687

credentials_set = _library.gnutls_credentials_set

688

credentials_set.argtypes = [session_t, credentials_type_t,

689

ctypes.c_void_p]

690

credentials_set.restype = _error_code

691

692

strerror = _library.gnutls_strerror

693

strerror.argtypes = [ctypes.c_int]

694

strerror.restype = ctypes.c_char_p

695

696

certificate_type_get = _library.gnutls_certificate_type_get

697

certificate_type_get.argtypes = [session_t]

698

certificate_type_get.restype = _error_code

699

700

certificate_get_peers = _library.gnutls_certificate_get_peers

701

certificate_get_peers.argtypes = [session_t,

702

ctypes.POINTER(ctypes.c_uint)]

703

certificate_get_peers.restype = ctypes.POINTER(datum_t)

704

705

global_set_log_level = _library.gnutls_global_set_log_level

706

global_set_log_level.argtypes = [ctypes.c_int]

707

global_set_log_level.restype = None

708

709

global_set_log_function = _library.gnutls_global_set_log_function

710

global_set_log_function.argtypes = [log_func]

711

global_set_log_function.restype = None

712

713

deinit = _library.gnutls_deinit

714

deinit.argtypes = [session_t]

715

deinit.restype = None

716

717

handshake = _library.gnutls_handshake

718

handshake.argtypes = [session_t]

719

handshake.restype = _error_code

720

handshake.errcheck = _retry_on_error

721

722

transport_set_ptr = _library.gnutls_transport_set_ptr

723

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

724

transport_set_ptr.restype = None

725

726

bye = _library.gnutls_bye

727

bye.argtypes = [session_t, close_request_t]

728

bye.restype = _error_code

729

bye.errcheck = _retry_on_error

730

731

check_version = _library.gnutls_check_version

732

check_version.argtypes = [ctypes.c_char_p]

733

check_version.restype = ctypes.c_char_p

734

735

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

736

737

openpgp_crt_init = _library.gnutls_openpgp_crt_init

738

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

739

openpgp_crt_init.restype = _error_code

740

741

openpgp_crt_import = _library.gnutls_openpgp_crt_import

742

openpgp_crt_import.argtypes = [openpgp_crt_t,

743

ctypes.POINTER(datum_t),

744

openpgp_crt_fmt_t]

745

openpgp_crt_import.restype = _error_code

746

747

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

748

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

749

ctypes.POINTER(ctypes.c_uint)]

750

openpgp_crt_verify_self.restype = _error_code

751

752

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

753

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

754

openpgp_crt_deinit.restype = None

755

756

openpgp_crt_get_fingerprint = (

757

_library.gnutls_openpgp_crt_get_fingerprint)

758

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

759

ctypes.c_void_p,

760

ctypes.POINTER(

761

ctypes.c_size_t)]

762

openpgp_crt_get_fingerprint.restype = _error_code

763

764

# Remove non-public functions

765

del _error_code, _retry_on_error

766

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

767

gnutls = GnuTLS()

768

769

770

def call_pipe(connection, # : multiprocessing.Connection

771

func, *args, **kwargs):

772

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

773

774

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

775

return value on the provided multiprocessing.Connection.

776

"""

777

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

778

connection.close()

779

780

781

410

class Client(object):

782

411

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

783

412

784

413

Attributes:

785

414

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

786

415

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

788

417

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

789

418

to see if the client lives.

790

419

'None' if no process is running.

791

checker_callback_tag: a GLib event source tag, or None

420

checker_callback_tag: a gobject event source tag, or None

792

421

checker_command: string; External command which is run to check

793

422

if client lives. %() expansions are done at

794

423

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

795

424

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

796

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

797

426

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

798

427

client_structure: Object describing what attributes a client has

799

428

and is used for storing the client at exit

800

429

current_checker_command: string; current running checker_command

801

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

802

431

enabled: bool()

803

432

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

804

433

uniquely identify the client

809

438

last_checker_status: integer between 0 and 255 reflecting exit

810

439

status of last checker. -1 reflects crashed

811

440

checker, -2 means no checker completed yet.

812

last_checker_signal: The signal which killed the last checker, if

813

last_checker_status is -1

814

441

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

815

442

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

816

443

D-Bus identifiers

823

450

disabled, or None

824

451

server_settings: The server_settings dict from main()

825

452

"""

826

453

827

454

runtime_expansions = ("approval_delay", "approval_duration",

828

455

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

829

456

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

830

457

"last_approval_request", "last_checked_ok",

831

458

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

832

client_defaults = {

833

"timeout": "PT5M",

834

"extended_timeout": "PT15M",

835

"interval": "PT2M",

836

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

837

"host": "",

838

"approval_delay": "PT0S",

839

"approval_duration": "PT1S",

840

"approved_by_default": "True",

841

"enabled": "True",

842

}

843

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

844

470

@staticmethod

845

471

def config_parser(config):

846

472

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

853

479

for client_name in config.sections():

854

480

section = dict(config.items(client_name))

855

481

client = settings[client_name] = {}

856

482

857

483

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

858

484

# Reformat values from string types to Python types

859

485

client["approved_by_default"] = config.getboolean(

860

486

client_name, "approved_by_default")

861

487

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

862

488

"enabled")

863

864

# Uppercase and remove spaces from fingerprint for later

865

# comparison purposes with return value from the

866

# fingerprint() function

489

867

490

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

868

491

.replace(" ", ""))

869

492

if "secret" in section:

870

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

871

.encode("utf-8"),

872

"base64")

493

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

873

494

elif "secfile" in section:

874

495

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

875

496

(section["secfile"])),

890

511

client["last_approval_request"] = None

891

512

client["last_checked_ok"] = None

892

513

client["last_checker_status"] = -2

893

514

894

515

return settings

895

896

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

516

517

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

897

518

self.name = name

898

519

if server_settings is None:

899

520

server_settings = {}

901

522

# adding all client settings

902

523

for setting, value in settings.items():

903

524

setattr(self, setting, value)

904

525

905

526

if self.enabled:

906

527

if not hasattr(self, "last_enabled"):

907

528

self.last_enabled = datetime.datetime.utcnow()

911

532

else:

912

533

self.last_enabled = None

913

534

self.expires = None

914

535

915

536

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

537

# Uppercase and remove spaces from fingerprint for later

538

# comparison purposes with return value from the fingerprint()

539

# function

916

540

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

917

541

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

918

542

datetime.datetime.utcnow())

919

543

920

544

# attributes specific for this server instance

921

545

self.checker = None

922

546

self.checker_initiator_tag = None

925

549

self.current_checker_command = None

926

550

self.approved = None

927

551

self.approvals_pending = 0

928

self.changedstate = multiprocessing_manager.Condition(

929

multiprocessing_manager.Lock())

930

self.client_structure = [attr

931

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

932

557

if not attr.startswith("_")]

933

558

self.client_structure.append("client_structure")

934

935

for name, t in inspect.getmembers(

936

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

937

564

if not name.startswith("_"):

938

565

self.client_structure.append(name)

939

566

940

567

# Send notice to process children that client state has changed

941

568

def send_changedstate(self):

942

569

with self.changedstate:

943

570

self.changedstate.notify_all()

944

571

945

572

def enable(self):

946

573

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

947

574

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

952

579

self.last_enabled = datetime.datetime.utcnow()

953

580

self.init_checker()

954

581

self.send_changedstate()

955

582

956

583

def disable(self, quiet=True):

957

584

"""Disable this client."""

958

585

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

960

587

if not quiet:

961

588

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

962

589

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

963

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

964

591

self.disable_initiator_tag = None

965

592

self.expires = None

966

593

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

967

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

968

595

self.checker_initiator_tag = None

969

596

self.stop_checker()

970

597

self.enabled = False

971

598

if not quiet:

972

599

self.send_changedstate()

973

# 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

974

601

return False

975

602

976

603

def __del__(self):

977

604

self.disable()

978

605

979

606

def init_checker(self):

980

607

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

981

608

# and every interval from then on.

982

609

if self.checker_initiator_tag is not None:

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

985

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

986

self.start_checker)

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

987

615

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

988

616

if self.disable_initiator_tag is not None:

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

991

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

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

992

622

# Also start a new checker *right now*.

993

623

self.start_checker()

994

995

def checker_callback(self, source, condition, connection,

996

command):

624

625

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

997

626

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

998

627

self.checker_callback_tag = None

999

628

self.checker = None

1000

# Read return code from connection (see call_pipe)

1001

returncode = connection.recv()

1002

connection.close()

1003

1004

if returncode >= 0:

1005

self.last_checker_status = returncode

1006

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1007

631

if self.last_checker_status == 0:

1008

632

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

1009

633

vars(self))

1010

634

self.checked_ok()

1011

635

else:

1012

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

636

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

637

vars(self))

1013

638

else:

1014

639

self.last_checker_status = -1

1015

self.last_checker_signal = -returncode

1016

640

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

1017

641

vars(self))

1018

return False

1019

642

1020

643

def checked_ok(self):

1021

644

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

1022

645

self.last_checked_ok = datetime.datetime.utcnow()

1023

646

self.last_checker_status = 0

1024

self.last_checker_signal = None

1025

647

self.bump_timeout()

1026

648

1027

649

def bump_timeout(self, timeout=None):

1028

650

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

1029

651

if timeout is None:

1030

652

timeout = self.timeout

1031

653

if self.disable_initiator_tag is not None:

1032

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1033

655

self.disable_initiator_tag = None

1034

656

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

1035

self.disable_initiator_tag = GLib.timeout_add(

1036

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1037

660

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

1038

661

1039

662

def need_approval(self):

1040

663

self.last_approval_request = datetime.datetime.utcnow()

1041

664

1042

665

def start_checker(self):

1043

666

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

1044

667

1045

668

If a checker already exists, leave it running and do

1046

669

nothing."""

1047

670

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

1052

675

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

1053

676

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

1054

677

# should be.

1055

1056

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

1057

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

1058

self.checker.join()

1059

self.checker = None

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)

1060

693

# Start a new checker if needed

1061

694

if self.checker is None:

1062

695

# Escape attributes for the shell

1063

escaped_attrs = {

1064

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

1065

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1066

699

try:

1067

700

command = self.checker_command % escaped_attrs

1068

701

except TypeError as error:

1069

702

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

1070

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

1071

727

exc_info=error)

1072

return True # Try again later

1073

self.current_checker_command = command

1074

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

1075

self.name)

1076

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

1077

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

1078

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

1079

# always replaced by /dev/null.)

1080

# The exception is when not debugging but nevertheless

1081

# running in the foreground; use the previously

1082

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

1086

if (not self.server_settings["debug"]

1087

and self.server_settings["foreground"]):

1088

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

1091

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

1095

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

1098

self.checker_callback, pipe[0], command)

1099

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

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

1100

748

return True

1101

749

1102

750

def stop_checker(self):

1103

751

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

1104

752

if self.checker_callback_tag:

1105

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1106

754

self.checker_callback_tag = None

1107

755

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

1108

756

return

1109

757

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

1110

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

1111

766

self.checker = None

1112

767

1113

768

1114

def dbus_service_property(dbus_interface,

1115

signature="v",

1116

access="readwrite",

1117

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1118

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1119

772

become properties on the D-Bus.

1120

773

1121

774

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

1122

775

and with one argument by "Set".

1123

776

1124

777

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

1125

778

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

1126

779

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

1130

783

if byte_arrays and signature != "ay":

1131

784

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

1132

785

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

1133

1134

786

def decorator(func):

1135

787

func._dbus_is_property = True

1136

788

func._dbus_interface = dbus_interface

1139

791

func._dbus_name = func.__name__

1140

792

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

1141

793

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

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1143

795

return func

1144

1145

796

return decorator

1146

797

1147

798

1148

799

def dbus_interface_annotations(dbus_interface):

1149

800

"""Decorator for marking functions returning interface annotations

1150

801

1151

802

Usage:

1152

803

1153

804

@dbus_interface_annotations("org.example.Interface")

1154

805

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

1155

806

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

1156

807

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

1157

808

"false"}

1158

809

"""

1159

1160

810

def decorator(func):

1161

811

func._dbus_is_interface = True

1162

812

func._dbus_interface = dbus_interface

1163

813

func._dbus_name = dbus_interface

1164

814

return func

1165

1166

815

return decorator

1167

816

1168

817

1169

818

def dbus_annotations(annotations):

1170

819

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

1171

820

Usage:

1172

821

1173

822

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

1174

823

"org.freedesktop.DBus.Property."

1175

824

"EmitsChangedSignal": "false"})

1177

826

access="r")

1178

827

def Property_dbus_property(self):

1179

828

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

1182

829

"""

1183

1184

830

def decorator(func):

1185

831

func._dbus_annotations = annotations

1186

832

return func

1187

1188

833

return decorator

1189

834

1190

835

1193

838

"""

1194

839

pass

1195

840

1196

1197

841

class DBusPropertyAccessException(DBusPropertyException):

1198

842

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

1199

843

"""

1206

850

pass

1207

851

1208

852

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

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.

1214

859

"""

1215

860

1216

861

@staticmethod

1217

862

def _is_dbus_thing(thing):

1218

863

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

1219

864

1220

865

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

1221

866

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

1222

867

"""

1223

868

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

1224

869

False)

1225

870

1226

871

def _get_all_dbus_things(self, thing):

1227

872

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

1228

873

"""

1229

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

874

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

875

name),

1230

876

athing.__get__(self))

1231

877

for cls in self.__class__.__mro__

1232

878

for name, athing in

1233

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

1234

1235

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1236

out_signature="s",

1237

path_keyword='object_path',

1238

connection_keyword='connection')

1239

def Introspect(self, object_path, connection):

1240

"""Overloading of standard D-Bus method.

1241

1242

Inserts annotation tags on methods and signals.

1243

"""

1244

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

1245

connection)

1246

try:

1247

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

1248

1249

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

1250

# Add annotation tags

1251

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

1252

for tag in if_tag.getElementsByTagName(typ):

1253

annots = dict()

1254

for name, prop in (self.

1255

_get_all_dbus_things(typ)):

1256

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

1257

and prop._dbus_interface

1258

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

1259

annots.update(getattr(

1260

prop, "_dbus_annotations", {}))

1261

for name, value in annots.items():

1262

ann_tag = document.createElement(

1263

"annotation")

1264

ann_tag.setAttribute("name", name)

1265

ann_tag.setAttribute("value", value)

1266

tag.appendChild(ann_tag)

1267

# Add interface annotation tags

1268

for annotation, value in dict(

1269

itertools.chain.from_iterable(

1270

annotations().items()

1271

for name, annotations

1272

in self._get_all_dbus_things("interface")

1273

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

1274

)).items():

1275

ann_tag = document.createElement("annotation")

1276

ann_tag.setAttribute("name", annotation)

1277

ann_tag.setAttribute("value", value)

1278

if_tag.appendChild(ann_tag)

1279

# Fix argument name for the Introspect method itself

1280

if (if_tag.getAttribute("name")

1281

== dbus.INTROSPECTABLE_IFACE):

1282

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

1283

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

1284

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

1285

if (arg.getAttribute("direction")

1286

== "out"):

1287

arg.setAttribute("name",

1288

"xml_data")

1289

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

1290

document.unlink()

1291

except (AttributeError, xml.dom.DOMException,

1292

xml.parsers.expat.ExpatError) as error:

1293

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

1294

exc_info=error)

1295

return xmlstring

1296

1297

1298

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1299

"""A D-Bus object with properties.

1300

1301

Classes inheriting from this can use the dbus_service_property

1302

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

1303

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

1304

"""

1305

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1306

882

def _get_dbus_property(self, interface_name, property_name):

1307

883

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

1308

884

property with the specified name and interface.

1309

885

"""

1310

for cls in self.__class__.__mro__:

1311

for name, value in inspect.getmembers(

1312

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

1313

890

if (value._dbus_name == property_name

1314

891

and value._dbus_interface == interface_name):

1315

892

return value.__get__(self)

1316

893

1317

894

# No such property

1318

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

1319

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

1330

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

in_signature="ss",

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1332

900

out_signature="v")

1333

901

def Get(self, interface_name, property_name):

1334

902

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

1340

908

if not hasattr(value, "variant_level"):

1341

909

return value

1342

910

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

1343

911

1344

912

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

1345

913

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

1346

914

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

1358

926

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

1359

927

for byte in value))

1360

928

prop(value)

1361

1362

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

in_signature="s",

929

930

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

1364

931

out_signature="a{sv}")

1365

932

def GetAll(self, interface_name):

1366

933

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

1367

934

standard.

1368

935

1369

936

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

1370

937

"""

1371

938

properties = {}

1381

948

if not hasattr(value, "variant_level"):

1382

949

properties[name] = value

1383

950

continue

1384

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1386

953

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

1387

954

1388

955

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

1389

956

def PropertiesChanged(self, interface_name, changed_properties,

1390

957

invalidated_properties):

1392

959

standard.

1393

960

"""

1394

961

pass

1395

962

1396

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1397

964

out_signature="s",

1398

965

path_keyword='object_path',

1399

966

connection_keyword='connection')

1400

967

def Introspect(self, object_path, connection):

1401

968

"""Overloading of standard D-Bus method.

1402

969

1403

970

Inserts property tags and interface annotation tags.

1404

971

"""

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

972

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

973

connection)

1408

974

try:

1409

975

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

1410

1411

976

def make_tag(document, name, prop):

1412

977

e = document.createElement("property")

1413

978

e.setAttribute("name", name)

1414

979

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

1415

980

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

1416

981

return e

1417

1418

982

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

1419

983

# Add property tags

1420

984

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

1423

987

if prop._dbus_interface

1424

988

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

1425

989

if_tag.appendChild(tag)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

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)

1442

1021

# Add the names to the return values for the

1443

1022

# "org.freedesktop.DBus.Properties" methods

1444

1023

if (if_tag.getAttribute("name")

1463

1042

return xmlstring

1464

1043

1465

1044

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1537

1045

def datetime_to_dbus(dt, variant_level=0):

1538

1046

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

1539

1047

if dt is None:

1540

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

1541

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)

1542

1051

1543

1052

1544

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1546

1055

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

1547

1056

interface names according to the "alt_interface_names" mapping.

1548

1057

Usage:

1549

1058

1550

1059

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

1551

1060

"net.example.AlternateInterface"})

1552

1061

class SampleDBusObject(dbus.service.Object):

1553

1062

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

1554

1063

def SampleDBusMethod():

1555

1064

pass

1556

1065

1557

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1558

1067

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

1559

1068

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

1560

1069

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

1561

1070

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

1562

1071

1563

1072

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

1564

1073

(from DBusObjectWithProperties) and interfaces (from the

1565

1074

dbus_interface_annotations decorator).

1566

1075

"""

1567

1568

1076

def wrapper(cls):

1569

1077

for orig_interface_name, alt_interface_name in (

1570

alt_interface_names.items()):

1078

alt_interface_names.items()):

1571

1079

attr = {}

1572

1080

interface_names = set()

1573

1081

# Go though all attributes of the class

1575

1083

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

1576

1084

# with the wrong interface name

1577

1085

if (not hasattr(attribute, "_dbus_interface")

1578

or not attribute._dbus_interface.startswith(

1579

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1580

1088

continue

1581

1089

# Create an alternate D-Bus interface name based on

1582

1090

# the current name

1583

alt_interface = attribute._dbus_interface.replace(

1584

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1585

1094

interface_names.add(alt_interface)

1586

1095

# Is this a D-Bus signal?

1587

1096

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

1588

1097

# Extract the original non-method undecorated

1589

1098

# function by black magic

1590

if sys.version_info.major == 2:

1591

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1592

1100

zip(attribute.func_code.co_freevars,

1593

attribute.__closure__))

1594

["func"].cell_contents)

1595

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1600

1103

# Create a new, but exactly alike, function

1601

1104

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

1602

1105

# with the alternate D-Bus interface name

1603

new_function = copy_function(nonmethod_func)

1604

new_function = (dbus.service.signal(

1605

alt_interface,

1606

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

1607

1115

# Copy annotations, if any

1608

1116

try:

1609

new_function._dbus_annotations = dict(

1610

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1611

1119

except AttributeError:

1612

1120

pass

1613

1614

1121

# Define a creator of a function to call both the

1615

1122

# original and alternate functions, so both the

1616

1123

# original and alternate signals gets sent when

1619

1126

"""This function is a scope container to pass

1620

1127

func1 and func2 to the "call_both" function

1621

1128

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1624

1129

def call_both(*args, **kwargs):

1625

1130

"""This function will emit two D-Bus

1626

1131

signals by calling func1 and func2"""

1627

1132

func1(*args, **kwargs)

1628

1133

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1635

1134

return call_both

1636

1135

# Create the "call_both" function and add it to

1637

1136

# the class

1642

1141

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

1643

1142

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

1644

1143

# to the class.

1645

attr[attrname] = (

1646

dbus.service.method(

1647

alt_interface,

1648

attribute._dbus_in_signature,

1649

attribute._dbus_out_signature)

1650

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

1651

1154

# Copy annotations, if any

1652

1155

try:

1653

attr[attrname]._dbus_annotations = dict(

1654

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1655

1158

except AttributeError:

1656

1159

pass

1657

1160

# Is this a D-Bus property?

1660

1163

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

1661

1164

# property with the alternate D-Bus interface

1662

1165

# name. Add it to the class.

1663

attr[attrname] = (dbus_service_property(

1664

alt_interface, attribute._dbus_signature,

1665

attribute._dbus_access,

1666

attribute._dbus_get_args_options

1667

["byte_arrays"])

1668

(copy_function(attribute)))

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

1669

1179

# Copy annotations, if any

1670

1180

try:

1671

attr[attrname]._dbus_annotations = dict(

1672

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1673

1183

except AttributeError:

1674

1184

pass

1675

1185

# Is this a D-Bus interface?

1678

1188

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

1679

1189

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

1680

1190

# to the class.

1681

attr[attrname] = (

1682

dbus_interface_annotations(alt_interface)

1683

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

1684

1199

if deprecate:

1685

1200

# Deprecate all alternate interfaces

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1687

1202

for interface_name in interface_names:

1688

1689

1203

@dbus_interface_annotations(interface_name)

1690

1204

def func(self):

1691

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

1692

"true"}

1205

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

1206

"true" }

1693

1207

# Find an unused name

1694

1208

for aname in (iname.format(i)

1695

1209

for i in itertools.count()):

1699

1213

if interface_names:

1700

1214

# Replace the class with a new subclass of it with

1701

1215

# methods, signals, etc. as created above.

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1216

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

1217

(cls,), attr)

1708

1218

return cls

1709

1710

1219

return wrapper

1711

1220

1712

1221

1713

1222

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

1714

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1715

1224

class ClientDBus(Client, DBusObjectWithProperties):

1716

1225

"""A Client class using D-Bus

1717

1226

1718

1227

Attributes:

1719

1228

dbus_object_path: dbus.ObjectPath

1720

1229

bus: dbus.SystemBus()

1721

1230

"""

1722

1231

1723

1232

runtime_expansions = (Client.runtime_expansions

1724

+ ("dbus_object_path", ))

1725

1233

+ ("dbus_object_path",))

1234

1726

1235

_interface = "se.recompile.Mandos.Client"

1727

1236

1728

1237

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

1729

1730

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

1238

1239

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

1731

1240

self.bus = bus

1732

1241

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

1733

1242

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

1735

1244

client_object_name = str(self.name).translate(

1736

1245

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

1737

1246

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

1738

self.dbus_object_path = dbus.ObjectPath(

1739

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1740

1249

DBusObjectWithProperties.__init__(self, self.bus,

1741

1250

self.dbus_object_path)

1742

1743

def notifychangeproperty(transform_func, dbus_name,

1744

type_func=lambda x: x,

1745

variant_level=1,

1746

invalidate_only=False,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1747

1255

_interface=_interface):

1748

1256

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

1749

1257

its changes to DBus.

1750

1258

1751

1259

transform_fun: Function that takes a value and a variant_level

1752

1260

and transforms it to a D-Bus type.

1753

1261

dbus_name: D-Bus name of the variable

1756

1264

variant_level: D-Bus variant level. Default: 1

1757

1265

"""

1758

1266

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

1759

1760

1267

def setter(self, value):

1761

1268

if hasattr(self, "dbus_object_path"):

1762

1269

if (not hasattr(self, attrname) or

1763

1270

type_func(getattr(self, attrname, None))

1764

1271

!= type_func(value)):

1765

1272

if invalidate_only:

1766

self.PropertiesChanged(

1767

_interface, dbus.Dictionary(),

1768

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1769

1277

else:

1770

dbus_value = transform_func(

1771

type_func(value),

1772

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1773

1281

self.PropertyChanged(dbus.String(dbus_name),

1774

1282

dbus_value)

1775

self.PropertiesChanged(

1776

_interface,

1777

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

1778

dbus_value}),

1779

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1780

1287

setattr(self, attrname, value)

1781

1288

1782

1289

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

1783

1290

1784

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1785

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1786

1293

"ApprovalPending",

1787

type_func=bool)

1294

type_func = bool)

1788

1295

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

1789

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1790

1297

"LastEnabled")

1791

checker = notifychangeproperty(

1792

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1794

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1795

1302

"LastCheckedOK")

1796

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1799

1306

datetime_to_dbus, "LastApprovalRequest")

1800

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1801

1308

"ApprovedByDefault")

1802

approval_delay = notifychangeproperty(

1803

dbus.UInt64, "ApprovalDelay",

1804

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)

1805

1314

approval_duration = notifychangeproperty(

1806

1315

dbus.UInt64, "ApprovalDuration",

1807

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

1316

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

1808

1317

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

1809

timeout = notifychangeproperty(

1810

dbus.UInt64, "Timeout",

1811

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1812

1321

extended_timeout = notifychangeproperty(

1813

1322

dbus.UInt64, "ExtendedTimeout",

1814

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

1815

interval = notifychangeproperty(

1816

dbus.UInt64, "Interval",

1817

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

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)

1818

1329

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

1819

1330

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

1820

1331

invalidate_only=True)

1821

1332

1822

1333

del notifychangeproperty

1823

1334

1824

1335

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

1825

1336

try:

1826

1337

self.remove_from_connection()

1829

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1830

1341

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

1831

1342

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

1832

1833

def checker_callback(self, source, condition,

1834

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

1835

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

1836

connection, command, *args,

1837

**kwargs)

1838

exitstatus = self.last_checker_status

1839

if exitstatus >= 0:

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)

1840

1350

# Emit D-Bus signal

1841

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1844

1353

dbus.String(command))

1845

1354

else:

1846

1355

# Emit D-Bus signal

1847

1356

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

1848

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1357

dbus.Int64(condition),

1852

1358

dbus.String(command))

1853

return ret

1854

1359

1360

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

1361

*args, **kwargs)

1362

1855

1363

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

1856

1364

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

1857

1365

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

1861

1369

# Emit D-Bus signal

1862

1370

self.CheckerStarted(self.current_checker_command)

1863

1371

return r

1864

1372

1865

1373

def _reset_approved(self):

1866

1374

self.approved = None

1867

1375

return False

1868

1376

1869

1377

def approve(self, value=True):

1870

1378

self.approved = value

1871

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

1872

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1873

1381

self.send_changedstate()

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1881

1389

# CheckerCompleted - signal

1882

1390

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

1883

1391

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

1884

1392

"D-Bus signal"

1885

1393

pass

1886

1394

1887

1395

# CheckerStarted - signal

1888

1396

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

1889

1397

def CheckerStarted(self, command):

1890

1398

"D-Bus signal"

1891

1399

pass

1892

1400

1893

1401

# PropertyChanged - signal

1894

1402

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

1895

1403

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

1896

1404

def PropertyChanged(self, property, value):

1897

1405

"D-Bus signal"

1898

1406

pass

1899

1407

1900

1408

# GotSecret - signal

1901

1409

@dbus.service.signal(_interface)

1902

1410

def GotSecret(self):

1905

1413

server to mandos-client

1906

1414

"""

1907

1415

pass

1908

1416

1909

1417

# Rejected - signal

1910

1418

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

1911

1419

def Rejected(self, reason):

1912

1420

"D-Bus signal"

1913

1421

pass

1914

1422

1915

1423

# NeedApproval - signal

1916

1424

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

1917

1425

def NeedApproval(self, timeout, default):

1918

1426

"D-Bus signal"

1919

1427

return self.need_approval()

1920

1921

# Methods

1922

1428

1429

## Methods

1430

1923

1431

# Approve - method

1924

1432

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

1925

1433

def Approve(self, value):

1926

1434

self.approve(value)

1927

1435

1928

1436

# CheckedOK - method

1929

1437

@dbus.service.method(_interface)

1930

1438

def CheckedOK(self):

1931

1439

self.checked_ok()

1932

1440

1933

1441

# Enable - method

1934

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

1935

1442

@dbus.service.method(_interface)

1936

1443

def Enable(self):

1937

1444

"D-Bus method"

1938

1445

self.enable()

1939

1446

1940

1447

# StartChecker - method

1941

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

1942

1448

@dbus.service.method(_interface)

1943

1449

def StartChecker(self):

1944

1450

"D-Bus method"

1945

1451

self.start_checker()

1946

1452

1947

1453

# Disable - method

1948

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

1949

1454

@dbus.service.method(_interface)

1950

1455

def Disable(self):

1951

1456

"D-Bus method"

1952

1457

self.disable()

1953

1458

1954

1459

# StopChecker - method

1955

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

1956

1460

@dbus.service.method(_interface)

1957

1461

def StopChecker(self):

1958

1462

self.stop_checker()

1959

1960

# Properties

1961

1463

1464

## Properties

1465

1962

1466

# ApprovalPending - property

1963

1467

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

1964

1468

def ApprovalPending_dbus_property(self):

1965

1469

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

1966

1470

1967

1471

# ApprovedByDefault - property

1968

@dbus_service_property(_interface,

1969

signature="b",

1472

@dbus_service_property(_interface, signature="b",

1970

1473

access="readwrite")

1971

1474

def ApprovedByDefault_dbus_property(self, value=None):

1972

1475

if value is None: # get

1973

1476

return dbus.Boolean(self.approved_by_default)

1974

1477

self.approved_by_default = bool(value)

1975

1478

1976

1479

# ApprovalDelay - property

1977

@dbus_service_property(_interface,

1978

signature="t",

1480

@dbus_service_property(_interface, signature="t",

1979

1481

access="readwrite")

1980

1482

def ApprovalDelay_dbus_property(self, value=None):

1981

1483

if value is None: # get

1982

1484

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

1983

1485

* 1000)

1984

1486

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

1985

1487

1986

1488

# ApprovalDuration - property

1987

@dbus_service_property(_interface,

1988

signature="t",

1489

@dbus_service_property(_interface, signature="t",

1989

1490

access="readwrite")

1990

1491

def ApprovalDuration_dbus_property(self, value=None):

1991

1492

if value is None: # get

1992

1493

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

1993

1494

* 1000)

1994

1495

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

1995

1496

1996

1497

# Name - property

1997

@dbus_annotations(

1998

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

1999

1498

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

2000

1499

def Name_dbus_property(self):

2001

1500

return dbus.String(self.name)

2002

1501

2003

1502

# Fingerprint - property

2004

@dbus_annotations(

2005

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

2006

1503

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

2007

1504

def Fingerprint_dbus_property(self):

2008

1505

return dbus.String(self.fingerprint)

2009

1506

2010

1507

# Host - property

2011

@dbus_service_property(_interface,

2012

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2013

1509

access="readwrite")

2014

1510

def Host_dbus_property(self, value=None):

2015

1511

if value is None: # get

2016

1512

return dbus.String(self.host)

2017

1513

self.host = str(value)

2018

1514

2019

1515

# Created - property

2020

@dbus_annotations(

2021

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

2022

1516

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

2023

1517

def Created_dbus_property(self):

2024

1518

return datetime_to_dbus(self.created)

2025

1519

2026

1520

# LastEnabled - property

2027

1521

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

2028

1522

def LastEnabled_dbus_property(self):

2029

1523

return datetime_to_dbus(self.last_enabled)

2030

1524

2031

1525

# Enabled - property

2032

@dbus_service_property(_interface,

2033

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2034

1527

access="readwrite")

2035

1528

def Enabled_dbus_property(self, value=None):

2036

1529

if value is None: # get

2039

1532

self.enable()

2040

1533

else:

2041

1534

self.disable()

2042

1535

2043

1536

# LastCheckedOK - property

2044

@dbus_service_property(_interface,

2045

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2046

1538

access="readwrite")

2047

1539

def LastCheckedOK_dbus_property(self, value=None):

2048

1540

if value is not None:

2049

1541

self.checked_ok()

2050

1542

return

2051

1543

return datetime_to_dbus(self.last_checked_ok)

2052

1544

2053

1545

# LastCheckerStatus - property

2054

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2055

1548

def LastCheckerStatus_dbus_property(self):

2056

1549

return dbus.Int16(self.last_checker_status)

2057

1550

2058

1551

# Expires - property

2059

1552

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

2060

1553

def Expires_dbus_property(self):

2061

1554

return datetime_to_dbus(self.expires)

2062

1555

2063

1556

# LastApprovalRequest - property

2064

1557

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

2065

1558

def LastApprovalRequest_dbus_property(self):

2066

1559

return datetime_to_dbus(self.last_approval_request)

2067

1560

2068

1561

# Timeout - property

2069

@dbus_service_property(_interface,

2070

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2071

1563

access="readwrite")

2072

1564

def Timeout_dbus_property(self, value=None):

2073

1565

if value is None: # get

2085

1577

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

2086

1578

is None):

2087

1579

return

2088

GLib.source_remove(self.disable_initiator_tag)

2089

self.disable_initiator_tag = GLib.timeout_add(

2090

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

2091

self.disable)

2092

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

2093

1586

# ExtendedTimeout - property

2094

@dbus_service_property(_interface,

2095

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2096

1588

access="readwrite")

2097

1589

def ExtendedTimeout_dbus_property(self, value=None):

2098

1590

if value is None: # get

2099

1591

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

2100

1592

* 1000)

2101

1593

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

2102

1594

2103

1595

# Interval - property

2104

@dbus_service_property(_interface,

2105

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2106

1597

access="readwrite")

2107

1598

def Interval_dbus_property(self, value=None):

2108

1599

if value is None: # get

2112

1603

return

2113

1604

if self.enabled:

2114

1605

# Reschedule checker run

2115

GLib.source_remove(self.checker_initiator_tag)

2116

self.checker_initiator_tag = GLib.timeout_add(

2117

value, self.start_checker)

2118

self.start_checker() # Start one now, too

2119

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

2120

1611

# Checker - property

2121

@dbus_service_property(_interface,

2122

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2123

1613

access="readwrite")

2124

1614

def Checker_dbus_property(self, value=None):

2125

1615

if value is None: # get

2126

1616

return dbus.String(self.checker_command)

2127

1617

self.checker_command = str(value)

2128

1618

2129

1619

# CheckerRunning - property

2130

@dbus_service_property(_interface,

2131

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2132

1621

access="readwrite")

2133

1622

def CheckerRunning_dbus_property(self, value=None):

2134

1623

if value is None: # get

2137

1626

self.start_checker()

2138

1627

else:

2139

1628

self.stop_checker()

2140

1629

2141

1630

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

2145

1631

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

2146

1632

def ObjectPath_dbus_property(self):

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2149

1635

# Secret = property

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

@dbus_service_property(_interface,

2154

signature="ay",

2155

access="write",

2156

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2157

1638

def Secret_dbus_property(self, value):

2158

1639

self.secret = bytes(value)

2159

1640

2160

1641

del _interface

2161

1642

2162

1643

2165

1646

self._pipe = child_pipe

2166

1647

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

2167

1648

if not self._pipe.recv():

2168

raise KeyError(fpr)

2169

1649

raise KeyError()

1650

2170

1651

def __getattribute__(self, name):

2171

1652

if name == '_pipe':

2172

1653

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

2175

1656

if data[0] == 'data':

2176

1657

return data[1]

2177

1658

if data[0] == 'function':

2178

2179

1659

def func(*args, **kwargs):

2180

1660

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

2181

1661

return self._pipe.recv()[1]

2182

2183

1662

return func

2184

1663

2185

1664

def __setattr__(self, name, value):

2186

1665

if name == '_pipe':

2187

1666

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

2190

1669

2191

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2192

1671

"""A class to handle client connections.

2193

1672

2194

1673

Instantiated once for each connection to handle it.

2195

1674

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

2196

1675

2197

1676

def handle(self):

2198

1677

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

2199

1678

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

2200

1679

str(self.client_address))

2201

1680

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

2202

1681

self.server.child_pipe.fileno())

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

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

2210

1697

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

2211

1698

priority = self.server.gnutls_priority

2212

1699

if priority is None:

2213

1700

priority = "NORMAL"

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2218

1705

# Start communication using the Mandos protocol

2219

1706

# Get protocol number

2220

1707

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

2225

1712

except (ValueError, IndexError, RuntimeError) as error:

2226

1713

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

2227

1714

return

2228

1715

2229

1716

# Start GnuTLS connection

2230

1717

try:

2231

1718

session.handshake()

2232

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2233

1720

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

2234

1721

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

2235

1722

# established. Just abandon the request.

2236

1723

return

2237

1724

logger.debug("Handshake succeeded")

2238

1725

2239

1726

approval_required = False

2240

1727

try:

2241

1728

try:

2242

fpr = self.fingerprint(

2243

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

2245

1733

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

2246

1734

return

2247

1735

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

2248

1736

2249

1737

try:

2250

1738

client = ProxyClient(child_pipe, fpr,

2251

1739

self.client_address)

2252

1740

except KeyError:

2253

1741

return

2254

1742

2255

1743

if client.approval_delay:

2256

1744

delay = client.approval_delay

2257

1745

client.approvals_pending += 1

2258

1746

approval_required = True

2259

1747

2260

1748

while True:

2261

1749

if not client.enabled:

2262

1750

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

2263

client.name)

1751

client.name)

2264

1752

if self.server.use_dbus:

2265

1753

# Emit D-Bus signal

2266

1754

client.Rejected("Disabled")

2267

1755

return

2268

1756

2269

1757

if client.approved or not client.approval_delay:

2270

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2271

1759

break

2272

1760

elif client.approved is None:

2273

1761

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

2284

1772

# Emit D-Bus signal

2285

1773

client.Rejected("Denied")

2286

1774

return

2287

2288

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2289

1777

time = datetime.datetime.now()

2290

1778

client.changedstate.acquire()

2291

1779

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

2304

1792

break

2305

1793

else:

2306

1794

delay -= time2 - time

2307

2308

try:

2309

session.send(client.secret)

2310

except gnutls.Error as error:

2311

logger.warning("gnutls send failed",

2312

exc_info=error)

2313

return

2314

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

2315

1809

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

2316

1810

# bump the timeout using extended_timeout

2317

1811

client.bump_timeout(client.extended_timeout)

2318

1812

if self.server.use_dbus:

2319

1813

# Emit D-Bus signal

2320

1814

client.GotSecret()

2321

1815

2322

1816

finally:

2323

1817

if approval_required:

2324

1818

client.approvals_pending -= 1

2325

1819

try:

2326

1820

session.bye()

2327

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2328

1822

logger.warning("GnuTLS bye failed",

2329

1823

exc_info=error)

2330

1824

2331

1825

@staticmethod

2332

1826

def peer_certificate(session):

2333

1827

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

2334

1828

# If not an OpenPGP certificate...

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

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

2339

1834

list_size = ctypes.c_uint(1)

2340

cert_list = (gnutls.certificate_get_peers

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2341

1837

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

2342

1838

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

2343

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

1839

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

1840

" certificate")

2344

1841

if list_size.value == 0:

2345

1842

return None

2346

1843

cert = cert_list[0]

2347

1844

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

2348

1845

2349

1846

@staticmethod

2350

1847

def fingerprint(openpgp):

2351

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2352

1849

# New GnuTLS "datum" with the OpenPGP public key

2353

datum = gnutls.datum_t(

2354

ctypes.cast(ctypes.c_char_p(openpgp),

2355

ctypes.POINTER(ctypes.c_ubyte)),

2356

ctypes.c_uint(len(openpgp)))

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

2357

1855

# New empty GnuTLS certificate

2358

crt = gnutls.openpgp_crt_t()

2359

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

2360

1859

# Import the OpenPGP public key into the certificate

2361

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

2362

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

2363

1864

# Verify the self signature in the key

2364

1865

crtverify = ctypes.c_uint()

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2367

1869

if crtverify.value != 0:

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2370

1873

# New buffer for the fingerprint

2371

1874

buf = ctypes.create_string_buffer(20)

2372

1875

buf_len = ctypes.c_size_t()

2373

1876

# Get the fingerprint from the certificate into the buffer

2374

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

2375

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2376

1880

# Deinit the certificate

2377

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2378

1882

# Convert the buffer to a Python bytestring

2379

1883

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

2380

1884

# Convert the bytestring to hexadecimal notation

2384

1888

2385

1889

class MultiprocessingMixIn(object):

2386

1890

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

2387

2388

1891

def sub_process_main(self, request, address):

2389

1892

try:

2390

1893

self.finish_request(request, address)

2391

1894

except Exception:

2392

1895

self.handle_error(request, address)

2393

1896

self.close_request(request)

2394

1897

2395

1898

def process_request(self, request, address):

2396

1899

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

2397

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

2398

args=(request, address))

1900

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

1901

args = (request, address))

2399

1902

proc.start()

2400

1903

return proc

2401

1904

2402

1905

2403

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2404

1907

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

2405

2406

1908

def process_request(self, request, client_address):

2407

1909

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

2408

1910

2409

1911

This function creates a new pipe in self.pipe

2410

1912

"""

2411

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2412

1914

2413

1915

proc = MultiprocessingMixIn.process_request(self, request,

2414

1916

client_address)

2415

1917

self.child_pipe.close()

2416

1918

self.add_pipe(parent_pipe, proc)

2417

1919

2418

1920

def add_pipe(self, parent_pipe, proc):

2419

1921

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

2420

1922

raise NotImplementedError()

2423

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2424

1926

socketserver.TCPServer, object):

2425

1927

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

2426

1928

2427

1929

Attributes:

2428

1930

enabled: Boolean; whether this server is activated yet

2429

1931

interface: None or a network interface name (string)

2430

1932

use_ipv6: Boolean; to use IPv6 or not

2431

1933

"""

2432

2433

1934

def __init__(self, server_address, RequestHandlerClass,

2434

interface=None,

2435

use_ipv6=True,

2436

socketfd=None):

1935

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

2437

1936

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

2438

1937

creating a new one with socket.socket().

2439

1938

"""

2445

1944

self.socketfd = socketfd

2446

1945

# Save the original socket.socket() function

2447

1946

self.socket_socket = socket.socket

2448

2449

1947

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

2450

#

1948

#

2451

1949

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

2452

1950

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

2453

1951

# patching socket.socket.)

2454

#

1952

#

2455

1953

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

2456

1954

@functools.wraps(socket.socket)

2457

1955

def socket_wrapper(*args, **kwargs):

2469

1967

# socket_wrapper(), if socketfd was set.

2470

1968

socketserver.TCPServer.__init__(self, server_address,

2471

1969

RequestHandlerClass)

2472

1970

2473

1971

def server_bind(self):

2474

1972

"""This overrides the normal server_bind() function

2475

1973

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

2476

1974

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

2477

global SO_BINDTODEVICE

2478

1975

if self.interface is not None:

2479

1976

if SO_BINDTODEVICE is None:

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

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

2501

1999

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

2502

2000

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

2503

2001

if not self.server_address[0]:

2504

2002

if self.address_family == socket.AF_INET6:

2505

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2506

2004

else:

2507

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2508

2006

self.server_address = (any_address,

2509

2007

self.server_address[1])

2510

2008

elif not self.server_address[1]:

2511

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

2009

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

2010

0)

2512

2011

# if self.interface:

2513

2012

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

2514

2013

# 0, # port

2520

2019

2521

2020

class MandosServer(IPv6_TCPServer):

2522

2021

"""Mandos server.

2523

2022

2524

2023

Attributes:

2525

2024

clients: set of Client objects

2526

2025

gnutls_priority GnuTLS priority string

2527

2026

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

2528

2529

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2530

2029

"""

2531

2532

2030

def __init__(self, server_address, RequestHandlerClass,

2533

interface=None,

2534

use_ipv6=True,

2535

clients=None,

2536

gnutls_priority=None,

2537

use_dbus=True,

2538

socketfd=None):

2031

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

2032

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

2539

2033

self.enabled = False

2540

2034

self.clients = clients

2541

2035

if self.clients is None:

2544

2038

self.gnutls_priority = gnutls_priority

2545

2039

IPv6_TCPServer.__init__(self, server_address,

2546

2040

RequestHandlerClass,

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2551

2044

def server_activate(self):

2552

2045

if self.enabled:

2553

2046

return socketserver.TCPServer.server_activate(self)

2554

2047

2555

2048

def enable(self):

2556

2049

self.enabled = True

2557

2050

2558

2051

def add_pipe(self, parent_pipe, proc):

2559

2052

# Call "handle_ipc" for both data and EOF events

2560

GLib.io_add_watch(

2561

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2563

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2567

def handle_ipc(self, source, condition,

2568

parent_pipe=None,

2569

proc=None,

2570

client_object=None):

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

2571

2062

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

2572

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

2063

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

2573

2064

# Wait for other process to exit

2574

2065

proc.join()

2575

2066

return False

2576

2067

2577

2068

# Read a request from the child

2578

2069

request = parent_pipe.recv()

2579

2070

command = request[0]

2580

2071

2581

2072

if command == 'init':

2582

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

2073

fpr = request[1]

2583

2074

address = request[2]

2584

2585

for c in self.clients.values():

2075

2076

for c in self.clients.itervalues():

2586

2077

if c.fingerprint == fpr:

2587

2078

client = c

2588

2079

break

2595

2086

address[0])

2596

2087

parent_pipe.send(False)

2597

2088

return False

2598

2599

GLib.io_add_watch(

2600

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2602

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

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

2606

2098

parent_pipe.send(True)

2607

2099

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

2608

2100

# same fileno

2611

2103

funcname = request[1]

2612

2104

args = request[2]

2613

2105

kwargs = request[3]

2614

2106

2615

2107

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

2616

2108

funcname)(*args,

2617

**kwargs)))

2618

2109

**kwargs)))

2110

2619

2111

if command == 'getattr':

2620

2112

attrname = request[1]

2621

if isinstance(client_object.__getattribute__(attrname),

2622

collections.Callable):

2623

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2624

2115

else:

2625

parent_pipe.send((

2626

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

2627

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2628

2119

if command == 'setattr':

2629

2120

attrname = request[1]

2630

2121

value = request[2]

2631

2122

setattr(client_object, attrname, value)

2632

2123

2633

2124

return True

2634

2125

2635

2126

2636

2127

def rfc3339_duration_to_delta(duration):

2637

2128

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

2638

2129

2639

2130

>>> rfc3339_duration_to_delta("P7D")

2640

2131

datetime.timedelta(7)

2641

2132

>>> rfc3339_duration_to_delta("PT60S")

2651

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2652

2143

datetime.timedelta(1, 200)

2653

2144

"""

2654

2145

2655

2146

# Parsing an RFC 3339 duration with regular expressions is not

2656

2147

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

2657

2148

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

2658

2149

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

2659

2150

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

2660

2151

# avoid excessive use of external libraries.

2661

2152

2662

2153

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

2663

Token = collections.namedtuple("Token", (

2664

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

2665

# a "group" containing digits

2666

"value", # datetime.timedelta or None

2667

"followers")) # Tokens valid after this token

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

2668

2163

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

2669

2164

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

2670

2165

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

2671

2166

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

2672

2167

datetime.timedelta(seconds=1),

2673

frozenset((token_end, )))

2168

frozenset((token_end,)))

2674

2169

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

2675

2170

datetime.timedelta(minutes=1),

2676

2171

frozenset((token_second, token_end)))

2692

2187

frozenset((token_month, token_end)))

2693

2188

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

2694

2189

datetime.timedelta(weeks=1),

2695

frozenset((token_end, )))

2190

frozenset((token_end,)))

2696

2191

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

2697

2192

frozenset((token_year, token_month,

2698

2193

token_day, token_time,

2699

2194

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2703

2197

found_token = None

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2198

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

2199

s = duration # String left to parse

2708

2200

# Loop until end token is found

2709

2201

while found_token is not token_end:

2710

2202

# Search for any currently valid tokens

2726

2218

break

2727

2219

else:

2728

2220

# No currently valid tokens were found

2729

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

2730

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2731

2222

# End token found

2732

2223

return value

2733

2224

2734

2225

2735

2226

def string_to_delta(interval):

2736

2227

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

2737

2228

2738

2229

>>> string_to_delta('7d')

2739

2230

datetime.timedelta(7)

2740

2231

>>> string_to_delta('60s')

2748

2239

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

2749

2240

datetime.timedelta(0, 330)

2750

2241

"""

2751

2242

2752

2243

try:

2753

2244

return rfc3339_duration_to_delta(interval)

2754

2245

except ValueError:

2755

2246

pass

2756

2247

2757

2248

timevalue = datetime.timedelta(0)

2758

2249

for s in interval.split():

2759

2250

try:

2770

2261

elif suffix == "w":

2771

2262

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

2772

2263

else:

2773

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2774

2266

except IndexError as e:

2775

2267

raise ValueError(*(e.args))

2776

2268

timevalue += delta

2777

2269

return timevalue

2778

2270

2779

2271

2780

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

2272

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

2781

2273

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

2782

2274

2783

2275

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

2784

2276

if os.fork():

2785

2277

sys.exit()

2792

2284

# Close all standard open file descriptors

2793

2285

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

2794

2286

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

2795

raise OSError(errno.ENODEV,

2796

"{} not a character device"

2287

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

2797

2288

.format(os.devnull))

2798

2289

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

2799

2290

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

2803

2294

2804

2295

2805

2296

def main():

2806

2297

2807

2298

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

2808

2299

# Parsing of options, both command line and config file

2809

2300

2810

2301

parser = argparse.ArgumentParser()

2811

2302

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

2812

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

2303

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

2813

2304

help="show version number and exit")

2814

2305

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

2815

2306

help="Bind to interface IF")

2851

2342

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

2852

2343

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

2853

2344

default=None)

2854

2345

2855

2346

options = parser.parse_args()

2856

2347

2857

2348

if options.check:

2858

2349

import doctest

2859

2350

fail_count, test_count = doctest.testmod()

2860

2351

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

2861

2352

2862

2353

# Default values for config file for server-global settings

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2354

server_defaults = { "interface": "",

2355

"address": "",

2356

"port": "",

2357

"debug": "False",

2358

"priority":

2359

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

2360

"servicename": "Mandos",

2361

"use_dbus": "True",

2362

"use_ipv6": "True",

2363

"debuglevel": "",

2364

"restore": "True",

2365

"socket": "",

2366

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

2367

"foreground": "False",

2368

"zeroconf": "True",

2369

}

2370

2881

2371

# Parse config file for server-global settings

2882

2372

server_config = configparser.SafeConfigParser(server_defaults)

2883

2373

del server_defaults

2884

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

2374

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

2375

"mandos.conf"))

2885

2376

# Convert the SafeConfigParser object to a dict

2886

2377

server_settings = server_config.defaults()

2887

2378

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

2888

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

2889

"foreground", "zeroconf"):

2379

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

2890

2380

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

2891

2381

option)

2892

2382

if server_settings["port"]:

2902

2392

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

2903

2393

["socket"])

2904

2394

del server_config

2905

2395

2906

2396

# Override the settings from the config file with command line

2907

2397

# options, if set.

2908

2398

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

2909

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

2910

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

2911

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

2399

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

2400

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

2401

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

2912

2402

value = getattr(options, option)

2913

2403

if value is not None:

2914

2404

server_settings[option] = value

2926

2416

if server_settings["debug"]:

2927

2417

server_settings["foreground"] = True

2928

2418

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

2929

2419

2930

2420

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

2931

2932

if (not server_settings["zeroconf"]

2933

and not (server_settings["port"]

2934

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

2935

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

2936

2421

2422

if (not server_settings["zeroconf"] and

2423

not (server_settings["port"]

2424

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

2425

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

2426

" Zeroconf")

2427

2937

2428

# For convenience

2938

2429

debug = server_settings["debug"]

2939

2430

debuglevel = server_settings["debuglevel"]

2943

2434

stored_state_file)

2944

2435

foreground = server_settings["foreground"]

2945

2436

zeroconf = server_settings["zeroconf"]

2946

2437

2947

2438

if debug:

2948

2439

initlogger(debug, logging.DEBUG)

2949

2440

else:

2952

2443

else:

2953

2444

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

2954

2445

initlogger(debug, level)

2955

2446

2956

2447

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

2957

syslogger.setFormatter(

2958

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

2959

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

2960

server_settings["servicename"])))

2961

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

2962

2454

# Parse config file with clients

2963

2455

client_config = configparser.SafeConfigParser(Client

2964

2456

.client_defaults)

2965

2457

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

2966

2458

"clients.conf"))

2967

2459

2968

2460

global mandos_dbus_service

2969

2461

mandos_dbus_service = None

2970

2462

2971

2463

socketfd = None

2972

2464

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

2973

2465

socketfd = server_settings["socket"]

2974

tcp_server = MandosServer(

2975

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

2976

ClientHandler,

2977

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

2978

use_ipv6=use_ipv6,

2979

gnutls_priority=server_settings["priority"],

2980

use_dbus=use_dbus,

2981

socketfd=socketfd)

2466

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

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

2982

2476

if not foreground:

2983

2477

pidfilename = "/run/mandos.pid"

2984

2478

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

2985

2479

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

2986

2480

pidfile = None

2987

2481

try:

2988

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

2482

pidfile = open(pidfilename, "w")

2989

2483

except IOError as e:

2990

2484

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

2991

2485

exc_info=e)

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2486

2487

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

2996

2488

try:

2997

2489

uid = pwd.getpwnam(name).pw_uid

2998

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

2999

2491

break

3000

2492

except KeyError:

3001

2493

continue

3005

2497

try:

3006

2498

os.setgid(gid)

3007

2499

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

3011

2500

except OSError as error:

3012

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

3013

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

3014

2501

if error.errno != errno.EPERM:

3015

2502

raise

3016

2503

3017

2504

if debug:

3018

2505

# Enable all possible GnuTLS debugging

3019

2506

3020

2507

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

3021

2508

# - GnuTLS manual

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3025

2512

def debug_gnutls(level, string):

3026

2513

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

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3030

2518

# Redirect stdin so all checkers get /dev/null

3031

2519

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

3032

2520

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

3033

2521

if null > 2:

3034

2522

os.close(null)

3035

2523

3036

2524

# Need to fork before connecting to D-Bus

3037

2525

if not foreground:

3038

2526

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

3039

2527

daemon()

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2528

2529

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

2530

# need to inform gobject that threads will be used.

2531

gobject.threads_init()

2532

3045

2533

global main_loop

3046

2534

# From the Avahi example code

3047

2535

DBusGMainLoop(set_as_default=True)

3048

main_loop = GLib.MainLoop()

2536

main_loop = gobject.MainLoop()

3049

2537

bus = dbus.SystemBus()

3050

2538

# End of Avahi example code

3051

2539

if use_dbus:

3052

2540

try:

3053

2541

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

3054

bus,

3055

do_not_queue=True)

3056

old_bus_name = dbus.service.BusName(

3057

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

3058

do_not_queue=True)

3059

except dbus.exceptions.DBusException as e:

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

3060

2547

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

3061

2548

use_dbus = False

3062

2549

server_settings["use_dbus"] = False

3063

2550

tcp_server.use_dbus = False

3064

2551

if zeroconf:

3065

2552

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3066

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3071

2557

if server_settings["interface"]:

3072

service.interface = if_nametoindex(

3073

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

3074

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3075

2562

global multiprocessing_manager

3076

2563

multiprocessing_manager = multiprocessing.Manager()

3077

2564

3078

2565

client_class = Client

3079

2566

if use_dbus:

3080

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

3081

2567

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

2568

3082

2569

client_settings = Client.config_parser(client_config)

3083

2570

old_client_settings = {}

3084

2571

clients_data = {}

3085

2572

3086

2573

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

3087

2574

global wnull

3088

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

2575

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

3089

2576

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

3090

2577

# mode

3091

2578

if debug or not foreground:

3092

2579

wnull.close()

3093

2580

3094

2581

# Get client data and settings from last running state.

3095

2582

if server_settings["restore"]:

3096

2583

try:

3097

2584

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

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

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

3141

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

3142

.decode("utf-8"))

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3143

2587

os.remove(stored_state_path)

3144

2588

except IOError as e:

3145

2589

if e.errno == errno.ENOENT:

3146

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

3147

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

2590

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

2591

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

3148

2592

else:

3149

2593

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

3150

2594

exc_info=e)

3151

2595

raise

3152

2596

except EOFError as e:

3153

2597

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

3154

"EOFError:",

3155

exc_info=e)

3156

2598

"EOFError:", exc_info=e)

2599

3157

2600

with PGPEngine() as pgp:

3158

2601

for client_name, client in clients_data.items():

3159

2602

# Skip removed clients

3160

2603

if client_name not in client_settings:

3161

2604

continue

3162

2605

3163

2606

# Decide which value to use after restoring saved state.

3164

2607

# We have three different values: Old config file,

3165

2608

# new config file, and saved state.

3170

2613

# For each value in new config, check if it

3171

2614

# differs from the old config value (Except for

3172

2615

# the "secret" attribute)

3173

if (name != "secret"

3174

and (value !=

3175

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3176

2619

client[name] = value

3177

2620

except KeyError:

3178

2621

pass

3179

2622

3180

2623

# Clients who has passed its expire date can still be

3181

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3182

2625

# whose checker succeeded before we stored its state is

3183

2626

# assumed to have successfully run all checkers during

3184

2627

# downtime.

3187

2630

if not client["last_checked_ok"]:

3188

2631

logger.warning(

3189

2632

"disabling client {} - Client never "

3190

"performed a successful checker".format(

3191

client_name))

2633

"performed a successful checker"

2634

.format(client_name))

3192

2635

client["enabled"] = False

3193

2636

elif client["last_checker_status"] != 0:

3194

2637

logger.warning(

3195

2638

"disabling client {} - Client last"

3196

" checker failed with error code"

3197

" {}".format(

3198

client_name,

3199

client["last_checker_status"]))

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3200

2642

client["enabled"] = False

3201

2643

else:

3202

client["expires"] = (

3203

datetime.datetime.utcnow()

3204

+ client["timeout"])

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3205

2647

logger.debug("Last checker succeeded,"

3206

" keeping {} enabled".format(

3207

client_name))

2648

" keeping {} enabled"

2649

.format(client_name))

3208

2650

try:

3209

client["secret"] = pgp.decrypt(

3210

client["encrypted_secret"],

3211

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3212

2655

except PGPError:

3213

2656

# If decryption fails, we use secret from new settings

3214

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

3215

client_name))

3216

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

3217

["secret"])

3218

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3219

2662

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

3220

2663

for client_name in (set(old_client_settings)

3221

2664

- set(client_settings)):

3223

2666

for client_name in (set(client_settings)

3224

2667

- set(old_client_settings)):

3225

2668

clients_data[client_name] = client_settings[client_name]

3226

2669

3227

2670

# Create all client objects

3228

2671

for client_name, client in clients_data.items():

3229

2672

tcp_server.clients[client_name] = client_class(

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3234

2676

if not tcp_server.clients:

3235

2677

logger.warning("No clients defined")

3236

2678

3237

2679

if not foreground:

3238

2680

if pidfile is not None:

3239

pid = os.getpid()

3240

2681

try:

3241

2682

with pidfile:

3242

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3243

2685

except IOError:

3244

2686

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

3245

2687

pidfilename, pid)

3246

2688

del pidfile

3247

2689

del pidfilename

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2690

2691

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

2692

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

2693

3253

2694

if use_dbus:

3254

3255

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3258

2698

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

3259

3260

2699

def __init__(self):

3261

2700

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

3262

3263

2701

_interface = "se.recompile.Mandos"

3264

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3265

2709

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

3266

2710

def ClientAdded(self, objpath):

3267

2711

"D-Bus signal"

3268

2712

pass

3269

2713

3270

2714

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

3271

2715

def ClientNotFound(self, fingerprint, address):

3272

2716

"D-Bus signal"

3273

2717

pass

3274

3275

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

3276

"true"})

2718

3277

2719

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

3278

2720

def ClientRemoved(self, objpath, name):

3279

2721

"D-Bus signal"

3280

2722

pass

3281

3282

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

3283

"true"})

2723

3284

2724

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

3285

2725

def GetAllClients(self):

3286

2726

"D-Bus method"

3287

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3292

2731

@dbus.service.method(_interface,

3293

2732

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

3294

2733

def GetAllClientsWithProperties(self):

3295

2734

"D-Bus method"

3296

2735

return dbus.Dictionary(

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2736

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

2737

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

3300

2738

signature="oa{sv}")

3301

2739

3302

2740

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

3303

2741

def RemoveClient(self, object_path):

3304

2742

"D-Bus method"

3305

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3306

2744

if c.dbus_object_path == object_path:

3307

2745

del tcp_server.clients[c.name]

3308

2746

c.remove_from_connection()

3309

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3310

2748

c.disable(quiet=True)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3313

2751

return

3314

2752

raise KeyError(object_path)

3315

2753

3316

2754

del _interface

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2755

3354

2756

mandos_dbus_service = MandosDBusService()

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2757

3361

2758

def cleanup():

3362

2759

"Cleanup function; run on exit"

3363

2760

if zeroconf:

3364

2761

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3368

2765

if not (tcp_server.clients or client_settings):

3369

2766

return

3370

2767

3371

2768

# Store client before exiting. Secrets are encrypted with key

3372

2769

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

3373

2770

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

3374

2771

clients = {}

3375

2772

with PGPEngine() as pgp:

3376

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3377

2774

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

3378

2775

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

3379

2776

key)

3380

2777

client_dict = {}

3381

2778

3382

2779

# A list of attributes that can not be pickled

3383

2780

# + secret.

3384

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

3385

"checker", "server_settings"}

3386

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

3387

.Object):

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3388

2785

exclude.add(name)

3389

2786

3390

2787

client_dict["encrypted_secret"] = (client

3391

2788

.encrypted_secret)

3392

2789

for attr in client.client_structure:

3393

2790

if attr not in exclude:

3394

2791

client_dict[attr] = getattr(client, attr)

3395

2792

3396

2793

clients[client.name] = client_dict

3397

2794

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

3398

2795

3399

2796

try:

3400

with tempfile.NamedTemporaryFile(

3401

mode='wb',

3402

suffix=".pickle",

3403

prefix='clients-',

3404

dir=os.path.dirname(stored_state_path),

3405

delete=False) as stored_state:

3406

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

3407

protocol=2)

3408

tempname = stored_state.name

2797

with (tempfile.NamedTemporaryFile

2798

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

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3409

2803

os.rename(tempname, stored_state_path)

3410

2804

except (IOError, OSError) as e:

3411

2805

if not debug:

3420

2814

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

3421

2815

exc_info=e)

3422

2816

raise

3423

2817

3424

2818

# Delete all clients, and settings from config

3425

2819

while tcp_server.clients:

3426

2820

name, client = tcp_server.clients.popitem()

3427

2821

if use_dbus:

3428

2822

client.remove_from_connection()

3429

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3430

2824

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

3432

2825

if use_dbus:

3433

mandos_dbus_service.client_removed_signal(client)

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3434

2830

client_settings.clear()

3435

2831

3436

2832

atexit.register(cleanup)

3437

3438

for client in tcp_server.clients.values():

2833

2834

for client in tcp_server.clients.itervalues():

3439

2835

if use_dbus:

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3442

2838

# Need to initiate checking of clients

3443

2839

if client.enabled:

3444

2840

client.init_checker()

3445

2841

3446

2842

tcp_server.enable()

3447

2843

tcp_server.server_activate()

3448

2844

3449

2845

# Find out what port we got

3450

2846

if zeroconf:

3451

2847

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

3456

2852

else: # IPv4

3457

2853

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

3458

2854

*tcp_server.socket.getsockname())

3459

3460

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

3461

2855

2856

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

2857

3462

2858

try:

3463

2859

if zeroconf:

3464

2860

# From the Avahi example code

3469

2865

cleanup()

3470

2866

sys.exit(1)

3471

2867

# End of Avahi example code

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2868

2869

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

2870

lambda *args, **kwargs:

2871

(tcp_server.handle_request

2872

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

2873

3478

2874

logger.debug("Starting main loop")

3479

2875

main_loop.run()

3480

2876

except AvahiError as error:

3489

2885

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

3490

2886

cleanup()

3491

2887

3492

3493

2888

if __name__ == '__main__':

3494

2889

main()