/mandos/release : revision 237.7.475

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

from gi.repository import GLib

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

79

86

import ctypes.util

80

87

import xml.dom.minidom

81

88

import inspect

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

try:

92

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

93

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

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

90

114

91

115

if sys.version_info.major == 2:

92

116

str = unicode

93

117

94

version = "1.6.9"

118

version = "1.7.16"

95

119

stored_state_file = "clients.pickle"

96

120

97

121

logger = logging.getLogger()

98

122

syslogger = None

99

123

100

124

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

104

127

except (OSError, AttributeError):

128

105

129

def if_nametoindex(interface):

106

130

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

107

131

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

112

136

return interface_index

113

137

114

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

115

155

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

116

156

"""init logger and add loglevel"""

117

157

118

158

global syslogger

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

123

162

syslogger.setFormatter(logging.Formatter

124

163

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

125

164

' %(message)s'))

126

165

logger.addHandler(syslogger)

127

166

128

167

if debug:

129

168

console = logging.StreamHandler()

130

169

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

142

181

143

182

class PGPEngine(object):

144

183

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

184

145

185

def __init__(self):

146

186

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

147

198

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

199

'--homedir', self.tempdir,

149

200

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

201

'--quiet']

202

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

203

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

204

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

205

153

206

def __enter__(self):

154

207

return self

155

208

156

209

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

157

210

self._cleanup()

158

211

return False

159

212

160

213

def __del__(self):

161

214

self._cleanup()

162

215

163

216

def _cleanup(self):

164

217

if self.tempdir is not None:

165

218

# Delete contents of tempdir

166

219

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

167

topdown = False):

220

topdown=False):

168

221

for filename in files:

169

222

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

170

223

for dirname in dirs:

172

225

# Remove tempdir

173

226

os.rmdir(self.tempdir)

174

227

self.tempdir = None

175

228

176

229

def password_encode(self, password):

177

230

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

178

231

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

183

236

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

184

237

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

185

238

return encoded

186

239

187

240

def encrypt(self, data, password):

188

241

passphrase = self.password_encode(password)

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

191

244

passfile.write(passphrase)

192

245

passfile.flush()

193

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

246

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

194

247

'--passphrase-file',

195

248

passfile.name]

196

249

+ self.gnupgargs,

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

201

254

if proc.returncode != 0:

202

255

raise PGPError(err)

203

256

return ciphertext

204

257

205

258

def decrypt(self, data, password):

206

259

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

209

262

passfile.write(passphrase)

210

263

passfile.flush()

211

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

264

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

212

265

'--passphrase-file',

213

266

passfile.name]

214

267

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

220

272

if proc.returncode != 0:

221

273

raise PGPError(err)

222

274

return decrypted_plaintext

223

275

224

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

225

304

class AvahiError(Exception):

226

305

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

227

306

self.value = value

228

307

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

229

308

**kwargs)

230

309

310

231

311

class AvahiServiceError(AvahiError):

232

312

pass

233

313

314

234

315

class AvahiGroupError(AvahiError):

235

316

pass

236

317

237

318

238

319

class AvahiService(object):

239

320

"""An Avahi (Zeroconf) service.

240

321

241

322

Attributes:

242

323

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

243

324

Used to optionally bind to the specified interface.

255

336

server: D-Bus Server

256

337

bus: dbus.SystemBus()

257

338

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

263

351

self.interface = interface

264

352

self.name = name

265

353

self.type = servicetype

274

362

self.server = None

275

363

self.bus = bus

276

364

self.entry_group_state_changed_match = None

277

365

278

366

def rename(self, remove=True):

279

367

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

280

368

if self.rename_count >= self.max_renames:

282

370

" after %i retries, exiting.",

283

371

self.rename_count)

284

372

raise AvahiServiceError("Too many renames")

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

287

375

self.rename_count += 1

288

376

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

289

377

self.name)

300

388

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

301

389

self.cleanup()

302

390

os._exit(1)

303

391

304

392

def remove(self):

305

393

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

306

394

if self.entry_group_state_changed_match is not None:

308

396

self.entry_group_state_changed_match = None

309

397

if self.group is not None:

310

398

self.group.Reset()

311

399

312

400

def add(self):

313

401

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

314

402

self.remove()

331

419

dbus.UInt16(self.port),

332

420

avahi.string_array_to_txt_array(self.TXT))

333

421

self.group.Commit()

334

422

335

423

def entry_group_state_changed(self, state, error):

336

424

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

337

425

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

338

426

339

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

340

428

logger.debug("Zeroconf service established.")

341

429

elif state == avahi.ENTRY_GROUP_COLLISION:

344

432

elif state == avahi.ENTRY_GROUP_FAILURE:

345

433

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

346

434

str(error))

347

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

348

.format(error))

349

435

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

436

350

437

def cleanup(self):

351

438

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

352

439

if self.group is not None:

357

444

pass

358

445

self.group = None

359

446

self.remove()

360

447

361

448

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

362

449

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

363

450

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

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

371

457

if state in bad_states:

372

458

if bad_states[state] is not None:

373

459

if error is None:

376

462

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

377

463

self.cleanup()

378

464

elif state == avahi.SERVER_RUNNING:

379

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

380

477

else:

381

478

if error is None:

382

479

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

383

480

else:

384

481

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

385

482

386

483

def activate(self):

387

484

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

388

485

if self.server is None:

392

489

follow_name_owner_changes=True),

393

490

avahi.DBUS_INTERFACE_SERVER)

394

491

self.server.connect_to_signal("StateChanged",

395

self.server_state_changed)

492

self.server_state_changed)

396

493

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

397

494

398

495

399

496

class AvahiServiceToSyslog(AvahiService):

400

497

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

401

498

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

402

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

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

407

503

return ret

408

504

409

505

506

# Pretend that we have a GnuTLS module

507

class GnuTLS(object):

508

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

509

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

510

511

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

512

if library is None:

513

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

514

_library = ctypes.cdll.LoadLibrary(library)

515

del library

516

_need_version = b"3.3.0"

517

518

def __init__(self):

519

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

520

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

521

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

522

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

523

.format(self._need_version))

524

525

# Unless otherwise indicated, the constants and types below are

526

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

527

528

# Constants

529

E_SUCCESS = 0

530

E_INTERRUPTED = -52

531

E_AGAIN = -28

532

CRT_OPENPGP = 2

533

CLIENT = 2

534

SHUT_RDWR = 0

535

CRD_CERTIFICATE = 1

536

E_NO_CERTIFICATE_FOUND = -49

537

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

538

539

# Types

540

class session_int(ctypes.Structure):

541

_fields_ = []

542

session_t = ctypes.POINTER(session_int)

543

544

class certificate_credentials_st(ctypes.Structure):

545

_fields_ = []

546

certificate_credentials_t = ctypes.POINTER(

547

certificate_credentials_st)

548

certificate_type_t = ctypes.c_int

549

550

class datum_t(ctypes.Structure):

551

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

552

('size', ctypes.c_uint)]

553

554

class openpgp_crt_int(ctypes.Structure):

555

_fields_ = []

556

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

557

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

558

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

559

credentials_type_t = ctypes.c_int

560

transport_ptr_t = ctypes.c_void_p

561

close_request_t = ctypes.c_int

562

563

# Exceptions

564

class Error(Exception):

565

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

566

# exception might be raised from within GnuTLS.__init__,

567

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

568

# global variable has happened.

569

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

570

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

571

# code is passed, convert it to a string with

572

# gnutls.strerror()

573

self.code = code

574

if message is None and code is not None:

575

message = GnuTLS.strerror(code)

576

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

577

message, *args)

578

579

class CertificateSecurityError(Error):

580

pass

581

582

# Classes

583

class Credentials(object):

584

def __init__(self):

585

self._c_object = gnutls.certificate_credentials_t()

586

gnutls.certificate_allocate_credentials(

587

ctypes.byref(self._c_object))

588

self.type = gnutls.CRD_CERTIFICATE

589

590

def __del__(self):

591

gnutls.certificate_free_credentials(self._c_object)

592

593

class ClientSession(object):

594

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

595

self._c_object = gnutls.session_t()

596

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

597

gnutls.set_default_priority(self._c_object)

598

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

599

gnutls.handshake_set_private_extensions(self._c_object,

600

True)

601

self.socket = socket

602

if credentials is None:

603

credentials = gnutls.Credentials()

604

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

605

ctypes.cast(credentials._c_object,

606

ctypes.c_void_p))

607

self.credentials = credentials

608

609

def __del__(self):

610

gnutls.deinit(self._c_object)

611

612

def handshake(self):

613

return gnutls.handshake(self._c_object)

614

615

def send(self, data):

616

data = bytes(data)

617

data_len = len(data)

618

while data_len > 0:

619

data_len -= gnutls.record_send(self._c_object,

620

data[-data_len:],

621

data_len)

622

623

def bye(self):

624

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

625

626

# Error handling functions

627

def _error_code(result):

628

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

629

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

630

if result >= 0:

631

return result

632

if result == gnutls.E_NO_CERTIFICATE_FOUND:

633

raise gnutls.CertificateSecurityError(code=result)

634

raise gnutls.Error(code=result)

635

636

def _retry_on_error(result, func, arguments):

637

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

638

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

639

while result < 0:

640

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

641

return _error_code(result)

642

result = func(*arguments)

643

return result

644

645

# Unless otherwise indicated, the function declarations below are

646

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

647

648

# Functions

649

priority_set_direct = _library.gnutls_priority_set_direct

650

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

651

ctypes.POINTER(ctypes.c_char_p)]

652

priority_set_direct.restype = _error_code

653

654

init = _library.gnutls_init

655

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

656

init.restype = _error_code

657

658

set_default_priority = _library.gnutls_set_default_priority

659

set_default_priority.argtypes = [session_t]

660

set_default_priority.restype = _error_code

661

662

record_send = _library.gnutls_record_send

663

record_send.argtypes = [session_t, ctypes.c_void_p,

664

ctypes.c_size_t]

665

record_send.restype = ctypes.c_ssize_t

666

record_send.errcheck = _retry_on_error

667

668

certificate_allocate_credentials = (

669

_library.gnutls_certificate_allocate_credentials)

670

certificate_allocate_credentials.argtypes = [

671

ctypes.POINTER(certificate_credentials_t)]

672

certificate_allocate_credentials.restype = _error_code

673

674

certificate_free_credentials = (

675

_library.gnutls_certificate_free_credentials)

676

certificate_free_credentials.argtypes = [

677

certificate_credentials_t]

678

certificate_free_credentials.restype = None

679

680

handshake_set_private_extensions = (

681

_library.gnutls_handshake_set_private_extensions)

682

handshake_set_private_extensions.argtypes = [session_t,

683

ctypes.c_int]

684

handshake_set_private_extensions.restype = None

685

686

credentials_set = _library.gnutls_credentials_set

687

credentials_set.argtypes = [session_t, credentials_type_t,

688

ctypes.c_void_p]

689

credentials_set.restype = _error_code

690

691

strerror = _library.gnutls_strerror

692

strerror.argtypes = [ctypes.c_int]

693

strerror.restype = ctypes.c_char_p

694

695

certificate_type_get = _library.gnutls_certificate_type_get

696

certificate_type_get.argtypes = [session_t]

697

certificate_type_get.restype = _error_code

698

699

certificate_get_peers = _library.gnutls_certificate_get_peers

700

certificate_get_peers.argtypes = [session_t,

701

ctypes.POINTER(ctypes.c_uint)]

702

certificate_get_peers.restype = ctypes.POINTER(datum_t)

703

704

global_set_log_level = _library.gnutls_global_set_log_level

705

global_set_log_level.argtypes = [ctypes.c_int]

706

global_set_log_level.restype = None

707

708

global_set_log_function = _library.gnutls_global_set_log_function

709

global_set_log_function.argtypes = [log_func]

710

global_set_log_function.restype = None

711

712

deinit = _library.gnutls_deinit

713

deinit.argtypes = [session_t]

714

deinit.restype = None

715

716

handshake = _library.gnutls_handshake

717

handshake.argtypes = [session_t]

718

handshake.restype = _error_code

719

handshake.errcheck = _retry_on_error

720

721

transport_set_ptr = _library.gnutls_transport_set_ptr

722

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

723

transport_set_ptr.restype = None

724

725

bye = _library.gnutls_bye

726

bye.argtypes = [session_t, close_request_t]

727

bye.restype = _error_code

728

bye.errcheck = _retry_on_error

729

730

check_version = _library.gnutls_check_version

731

check_version.argtypes = [ctypes.c_char_p]

732

check_version.restype = ctypes.c_char_p

733

734

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

735

736

openpgp_crt_init = _library.gnutls_openpgp_crt_init

737

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

738

openpgp_crt_init.restype = _error_code

739

740

openpgp_crt_import = _library.gnutls_openpgp_crt_import

741

openpgp_crt_import.argtypes = [openpgp_crt_t,

742

ctypes.POINTER(datum_t),

743

openpgp_crt_fmt_t]

744

openpgp_crt_import.restype = _error_code

745

746

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

747

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

748

ctypes.POINTER(ctypes.c_uint)]

749

openpgp_crt_verify_self.restype = _error_code

750

751

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

752

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

753

openpgp_crt_deinit.restype = None

754

755

openpgp_crt_get_fingerprint = (

756

_library.gnutls_openpgp_crt_get_fingerprint)

757

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

758

ctypes.c_void_p,

759

ctypes.POINTER(

760

ctypes.c_size_t)]

761

openpgp_crt_get_fingerprint.restype = _error_code

762

763

# Remove non-public functions

764

del _error_code, _retry_on_error

765

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

766

gnutls = GnuTLS()

767

768

769

def call_pipe(connection, # : multiprocessing.Connection

770

func, *args, **kwargs):

771

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

772

773

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

774

return value on the provided multiprocessing.Connection.

775

"""

776

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

777

connection.close()

778

779

410

780

class Client(object):

411

781

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

412

782

413

783

Attributes:

414

784

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

415

785

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

417

787

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

418

788

to see if the client lives.

419

789

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

421

791

checker_command: string; External command which is run to check

422

792

if client lives. %() expansions are done at

423

793

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

424

794

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

425

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

426

796

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

427

797

client_structure: Object describing what attributes a client has

428

798

and is used for storing the client at exit

429

799

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

431

801

enabled: bool()

432

802

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

433

803

uniquely identify the client

438

808

last_checker_status: integer between 0 and 255 reflecting exit

439

809

status of last checker. -1 reflects crashed

440

810

checker, -2 means no checker completed yet.

811

last_checker_signal: The signal which killed the last checker, if

812

last_checker_status is -1

441

813

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

442

814

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

443

815

D-Bus identifiers

450

822

disabled, or None

451

823

server_settings: The server_settings dict from main()

452

824

"""

453

825

454

826

runtime_expansions = ("approval_delay", "approval_duration",

455

827

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

456

828

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

457

829

"last_approval_request", "last_checked_ok",

458

830

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

470

843

@staticmethod

471

844

def config_parser(config):

472

845

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

479

852

for client_name in config.sections():

480

853

section = dict(config.items(client_name))

481

854

client = settings[client_name] = {}

482

855

483

856

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

484

857

# Reformat values from string types to Python types

485

858

client["approved_by_default"] = config.getboolean(

486

859

client_name, "approved_by_default")

487

860

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

488

861

"enabled")

489

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

490

866

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

491

867

.replace(" ", ""))

492

868

if "secret" in section:

493

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

869

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

870

.encode("utf-8"),

871

"base64")

494

872

elif "secfile" in section:

495

873

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

496

874

(section["secfile"])),

511

889

client["last_approval_request"] = None

512

890

client["last_checked_ok"] = None

513

891

client["last_checker_status"] = -2

514

892

515

893

return settings

516

517

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

894

895

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

518

896

self.name = name

519

897

if server_settings is None:

520

898

server_settings = {}

522

900

# adding all client settings

523

901

for setting, value in settings.items():

524

902

setattr(self, setting, value)

525

903

526

904

if self.enabled:

527

905

if not hasattr(self, "last_enabled"):

528

906

self.last_enabled = datetime.datetime.utcnow()

532

910

else:

533

911

self.last_enabled = None

534

912

self.expires = None

535

913

536

914

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

540

915

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

541

916

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

542

917

datetime.datetime.utcnow())

543

918

544

919

# attributes specific for this server instance

545

920

self.checker = None

546

921

self.checker_initiator_tag = None

549

924

self.current_checker_command = None

550

925

self.approved = None

551

926

self.approvals_pending = 0

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

557

931

if not attr.startswith("_")]

558

932

self.client_structure.append("client_structure")

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

933

934

for name, t in inspect.getmembers(

935

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

564

936

if not name.startswith("_"):

565

937

self.client_structure.append(name)

566

938

567

939

# Send notice to process children that client state has changed

568

940

def send_changedstate(self):

569

941

with self.changedstate:

570

942

self.changedstate.notify_all()

571

943

572

944

def enable(self):

573

945

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

574

946

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

579

951

self.last_enabled = datetime.datetime.utcnow()

580

952

self.init_checker()

581

953

self.send_changedstate()

582

954

583

955

def disable(self, quiet=True):

584

956

"""Disable this client."""

585

957

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

587

959

if not quiet:

588

960

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

589

961

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

590

gobject.source_remove(self.disable_initiator_tag)

962

GLib.source_remove(self.disable_initiator_tag)

591

963

self.disable_initiator_tag = None

592

964

self.expires = None

593

965

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

594

gobject.source_remove(self.checker_initiator_tag)

966

GLib.source_remove(self.checker_initiator_tag)

595

967

self.checker_initiator_tag = None

596

968

self.stop_checker()

597

969

self.enabled = False

598

970

if not quiet:

599

971

self.send_changedstate()

600

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

972

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

601

973

return False

602

974

603

975

def __del__(self):

604

976

self.disable()

605

977

606

978

def init_checker(self):

607

979

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

608

980

# and every interval from then on.

609

981

if self.checker_initiator_tag is not None:

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

615

986

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

616

987

if self.disable_initiator_tag is not None:

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

622

991

# Also start a new checker *right now*.

623

992

self.start_checker()

624

625

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

626

996

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

627

997

self.checker_callback_tag = None

628

998

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

631

1006

if self.last_checker_status == 0:

632

1007

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

633

1008

vars(self))

634

1009

self.checked_ok()

635

1010

else:

636

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

637

vars(self))

1011

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

638

1012

else:

639

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

640

1015

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

641

1016

vars(self))

642

1017

return False

1018

643

1019

def checked_ok(self):

644

1020

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

645

1021

self.last_checked_ok = datetime.datetime.utcnow()

646

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

647

1024

self.bump_timeout()

648

1025

649

1026

def bump_timeout(self, timeout=None):

650

1027

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

651

1028

if timeout is None:

652

1029

timeout = self.timeout

653

1030

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

655

1032

self.disable_initiator_tag = None

656

1033

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

660

1036

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

661

1037

662

1038

def need_approval(self):

663

1039

self.last_approval_request = datetime.datetime.utcnow()

664

1040

665

1041

def start_checker(self):

666

1042

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

667

1043

668

1044

If a checker already exists, leave it running and do

669

1045

nothing."""

670

1046

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

675

1051

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

676

1052

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

677

1053

# should be.

678

679

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

680

try:

681

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

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

693

1059

# Start a new checker if needed

694

1060

if self.checker is None:

695

1061

# Escape attributes for the shell

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

699

1065

try:

700

1066

command = self.checker_command % escaped_attrs

701

1067

except TypeError as error:

702

1068

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

705

1072

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

721

self.checker = subprocess.Popen(command,

722

close_fds=True,

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

747

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

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

748

1099

return True

749

1100

750

1101

def stop_checker(self):

751

1102

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

752

1103

if self.checker_callback_tag:

753

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

754

1105

self.checker_callback_tag = None

755

1106

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

756

1107

return

757

1108

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

758

try:

759

self.checker.terminate()

760

#time.sleep(0.5)

761

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

762

# self.checker.kill()

763

except OSError as error:

764

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

765

raise

1109

self.checker.terminate()

766

1110

self.checker = None

767

1111

768

1112

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

771

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

772

1118

become properties on the D-Bus.

773

1119

774

1120

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

775

1121

and with one argument by "Set".

776

1122

777

1123

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

778

1124

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

779

1125

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

783

1129

if byte_arrays and signature != "ay":

784

1130

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

785

1131

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

1132

786

1133

def decorator(func):

787

1134

func._dbus_is_property = True

788

1135

func._dbus_interface = dbus_interface

791

1138

func._dbus_name = func.__name__

792

1139

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

793

1140

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

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

795

1142

return func

1143

796

1144

return decorator

797

1145

798

1146

799

1147

def dbus_interface_annotations(dbus_interface):

800

1148

"""Decorator for marking functions returning interface annotations

801

1149

802

1150

Usage:

803

1151

804

1152

@dbus_interface_annotations("org.example.Interface")

805

1153

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

806

1154

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

807

1155

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

808

1156

"false"}

809

1157

"""

1158

810

1159

def decorator(func):

811

1160

func._dbus_is_interface = True

812

1161

func._dbus_interface = dbus_interface

813

1162

func._dbus_name = dbus_interface

814

1163

return func

1164

815

1165

return decorator

816

1166

817

1167

818

1168

def dbus_annotations(annotations):

819

1169

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

820

1170

Usage:

821

1171

822

1172

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

823

1173

"org.freedesktop.DBus.Property."

824

1174

"EmitsChangedSignal": "false"})

826

1176

access="r")

827

1177

def Property_dbus_property(self):

828

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

829

1181

"""

1182

830

1183

def decorator(func):

831

1184

func._dbus_annotations = annotations

832

1185

return func

1186

833

1187

return decorator

834

1188

835

1189

838

1192

"""

839

1193

pass

840

1194

1195

841

1196

class DBusPropertyAccessException(DBusPropertyException):

842

1197

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

843

1198

"""

850

1205

pass

851

1206

852

1207

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.

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

859

1213

"""

860

1214

861

1215

@staticmethod

862

1216

def _is_dbus_thing(thing):

863

1217

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

864

1218

865

1219

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

866

1220

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

867

1221

"""

868

1222

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

869

1223

False)

870

1224

871

1225

def _get_all_dbus_things(self, thing):

872

1226

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

873

1227

"""

874

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

875

name),

1228

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

876

1229

athing.__get__(self))

877

1230

for cls in self.__class__.__mro__

878

1231

for name, athing in

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

882

1305

def _get_dbus_property(self, interface_name, property_name):

883

1306

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

884

1307

property with the specified name and interface.

885

1308

"""

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

890

1312

if (value._dbus_name == property_name

891

1313

and value._dbus_interface == interface_name):

892

1314

return value.__get__(self)

893

1315

894

1316

# No such property

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

900

1331

out_signature="v")

901

1332

def Get(self, interface_name, property_name):

902

1333

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

908

1339

if not hasattr(value, "variant_level"):

909

1340

return value

910

1341

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

911

1342

912

1343

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

913

1344

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

914

1345

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

926

1357

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

927

1358

for byte in value))

928

1359

prop(value)

929

930

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

931

1363

out_signature="a{sv}")

932

1364

def GetAll(self, interface_name):

933

1365

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

934

1366

standard.

935

1367

936

1368

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

937

1369

"""

938

1370

properties = {}

948

1380

if not hasattr(value, "variant_level"):

949

1381

properties[name] = value

950

1382

continue

951

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

952

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

953

1385

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

954

1386

955

1387

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

956

1388

def PropertiesChanged(self, interface_name, changed_properties,

957

1389

invalidated_properties):

959

1391

standard.

960

1392

"""

961

1393

pass

962

1394

963

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

964

1396

out_signature="s",

965

1397

path_keyword='object_path',

966

1398

connection_keyword='connection')

967

1399

def Introspect(self, object_path, connection):

968

1400

"""Overloading of standard D-Bus method.

969

1401

970

1402

Inserts property tags and interface annotation tags.

971

1403

"""

972

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

973

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

974

1407

try:

975

1408

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

1409

976

1410

def make_tag(document, name, prop):

977

1411

e = document.createElement("property")

978

1412

e.setAttribute("name", name)

979

1413

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

980

1414

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

981

1415

return e

1416

982

1417

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

983

1418

# Add property tags

984

1419

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

987

1422

if prop._dbus_interface

988

1423

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

989

1424

if_tag.appendChild(tag)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

1021

1441

# Add the names to the return values for the

1022

1442

# "org.freedesktop.DBus.Properties" methods

1023

1443

if (if_tag.getAttribute("name")

1042

1462

return xmlstring

1043

1463

1044

1464

1465

try:

1466

dbus.OBJECT_MANAGER_IFACE

1467

except AttributeError:

1468

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

1469

1470

1471

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1472

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

1473

1474

Classes inheriting from this exposes the standard

1475

GetManagedObjects call and the InterfacesAdded and

1476

InterfacesRemoved signals on the standard

1477

"org.freedesktop.DBus.ObjectManager" interface.

1478

1479

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

1480

manually.

1481

"""

1482

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1483

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

1484

def GetManagedObjects(self):

1485

"""This function must be overridden"""

1486

raise NotImplementedError()

1487

1488

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1489

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

1490

def InterfacesAdded(self, object_path, interfaces_and_properties):

1491

pass

1492

1493

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

1494

def InterfacesRemoved(self, object_path, interfaces):

1495

pass

1496

1497

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1498

out_signature="s",

1499

path_keyword='object_path',

1500

connection_keyword='connection')

1501

def Introspect(self, object_path, connection):

1502

"""Overloading of standard D-Bus method.

1503

1504

Override return argument name of GetManagedObjects to be

1505

"objpath_interfaces_and_properties"

1506

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

1510

try:

1511

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

1512

1513

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

1514

# Fix argument name for the GetManagedObjects method

1515

if (if_tag.getAttribute("name")

1516

== dbus.OBJECT_MANAGER_IFACE):

1517

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

1518

if (cn.getAttribute("name")

1519

== "GetManagedObjects"):

1520

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

1521

if (arg.getAttribute("direction")

1522

== "out"):

1523

arg.setAttribute(

1524

"name",

1525

"objpath_interfaces"

1526

"_and_properties")

1527

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

1528

document.unlink()

1529

except (AttributeError, xml.dom.DOMException,

1530

xml.parsers.expat.ExpatError) as error:

1531

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

1532

exc_info=error)

1533

return xmlstring

1534

1535

1045

1536

def datetime_to_dbus(dt, variant_level=0):

1046

1537

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

1047

1538

if dt is None:

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1539

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

1540

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

1051

1541

1052

1542

1053

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1055

1545

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

1056

1546

interface names according to the "alt_interface_names" mapping.

1057

1547

Usage:

1058

1548

1059

1549

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

1060

1550

"net.example.AlternateInterface"})

1061

1551

class SampleDBusObject(dbus.service.Object):

1062

1552

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

1063

1553

def SampleDBusMethod():

1064

1554

pass

1065

1555

1066

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1067

1557

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

1068

1558

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

1069

1559

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

1070

1560

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

1071

1561

1072

1562

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

1073

1563

(from DBusObjectWithProperties) and interfaces (from the

1074

1564

dbus_interface_annotations decorator).

1075

1565

"""

1566

1076

1567

def wrapper(cls):

1077

1568

for orig_interface_name, alt_interface_name in (

1078

alt_interface_names.items()):

1569

alt_interface_names.items()):

1079

1570

attr = {}

1080

1571

interface_names = set()

1081

1572

# Go though all attributes of the class

1083

1574

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

1084

1575

# with the wrong interface name

1085

1576

if (not hasattr(attribute, "_dbus_interface")

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1088

1579

continue

1089

1580

# Create an alternate D-Bus interface name based on

1090

1581

# the current name

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1094

1584

interface_names.add(alt_interface)

1095

1585

# Is this a D-Bus signal?

1096

1586

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

1097

1587

# Extract the original non-method undecorated

1098

1588

# function by black magic

1099

nonmethod_func = (dict(

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1100

1591

zip(attribute.func_code.co_freevars,

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1103

1599

# Create a new, but exactly alike, function

1104

1600

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

1105

1601

# with the alternate D-Bus interface name

1106

new_function = (dbus.service.signal

1107

(alt_interface,

1108

attribute._dbus_signature)

1109

(types.FunctionType(

1110

nonmethod_func.func_code,

1111

nonmethod_func.func_globals,

1112

nonmethod_func.func_name,

1113

nonmethod_func.func_defaults,

1114

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1115

1606

# Copy annotations, if any

1116

1607

try:

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1119

1610

except AttributeError:

1120

1611

pass

1612

1121

1613

# Define a creator of a function to call both the

1122

1614

# original and alternate functions, so both the

1123

1615

# original and alternate signals gets sent when

1126

1618

"""This function is a scope container to pass

1127

1619

func1 and func2 to the "call_both" function

1128

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1129

1623

def call_both(*args, **kwargs):

1130

1624

"""This function will emit two D-Bus

1131

1625

signals by calling func1 and func2"""

1132

1626

func1(*args, **kwargs)

1133

1627

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1134

1634

return call_both

1135

1635

# Create the "call_both" function and add it to

1136

1636

# the class

1141

1641

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

1142

1642

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

1143

1643

# to the class.

1144

attr[attrname] = (dbus.service.method

1145

(alt_interface,

1146

attribute._dbus_in_signature,

1147

attribute._dbus_out_signature)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1154

1650

# Copy annotations, if any

1155

1651

try:

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1158

1654

except AttributeError:

1159

1655

pass

1160

1656

# Is this a D-Bus property?

1163

1659

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

1164

1660

# property with the alternate D-Bus interface

1165

1661

# name. Add it to the class.

1166

attr[attrname] = (dbus_service_property

1167

(alt_interface,

1168

attribute._dbus_signature,

1169

attribute._dbus_access,

1170

attribute

1171

._dbus_get_args_options

1172

["byte_arrays"])

1173

(types.FunctionType

1174

(attribute.func_code,

1175

attribute.func_globals,

1176

attribute.func_name,

1177

attribute.func_defaults,

1178

attribute.func_closure)))

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1179

1668

# Copy annotations, if any

1180

1669

try:

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1183

1672

except AttributeError:

1184

1673

pass

1185

1674

# Is this a D-Bus interface?

1188

1677

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

1189

1678

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

1190

1679

# to the class.

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1199

1683

if deprecate:

1200

1684

# Deprecate all alternate interfaces

1201

iname="_AlternateDBusNames_interface_annotation{}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1202

1686

for interface_name in interface_names:

1687

1203

1688

@dbus_interface_annotations(interface_name)

1204

1689

def func(self):

1205

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

1206

"true" }

1690

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

1691

"true"}

1207

1692

# Find an unused name

1208

1693

for aname in (iname.format(i)

1209

1694

for i in itertools.count()):

1213

1698

if interface_names:

1214

1699

# Replace the class with a new subclass of it with

1215

1700

# methods, signals, etc. as created above.

1216

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

1217

(cls,), attr)

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1218

1707

return cls

1708

1219

1709

return wrapper

1220

1710

1221

1711

1222

1712

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

1223

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1224

1714

class ClientDBus(Client, DBusObjectWithProperties):

1225

1715

"""A Client class using D-Bus

1226

1716

1227

1717

Attributes:

1228

1718

dbus_object_path: dbus.ObjectPath

1229

1719

bus: dbus.SystemBus()

1230

1720

"""

1231

1721

1232

1722

runtime_expansions = (Client.runtime_expansions

1233

+ ("dbus_object_path",))

1234

1723

+ ("dbus_object_path", ))

1724

1235

1725

_interface = "se.recompile.Mandos.Client"

1236

1726

1237

1727

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

1238

1239

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

1728

1729

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

1240

1730

self.bus = bus

1241

1731

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

1242

1732

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

1244

1734

client_object_name = str(self.name).translate(

1245

1735

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

1246

1736

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

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1249

1739

DBusObjectWithProperties.__init__(self, self.bus,

1250

1740

self.dbus_object_path)

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1255

1746

_interface=_interface):

1256

1747

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

1257

1748

its changes to DBus.

1258

1749

1259

1750

transform_fun: Function that takes a value and a variant_level

1260

1751

and transforms it to a D-Bus type.

1261

1752

dbus_name: D-Bus name of the variable

1264

1755

variant_level: D-Bus variant level. Default: 1

1265

1756

"""

1266

1757

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

1758

1267

1759

def setter(self, value):

1268

1760

if hasattr(self, "dbus_object_path"):

1269

1761

if (not hasattr(self, attrname) or

1270

1762

type_func(getattr(self, attrname, None))

1271

1763

!= type_func(value)):

1272

1764

if invalidate_only:

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1277

1768

else:

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1281

1772

self.PropertyChanged(dbus.String(dbus_name),

1282

1773

dbus_value)

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1287

1779

setattr(self, attrname, value)

1288

1780

1289

1781

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

1290

1782

1291

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1292

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1293

1785

"ApprovalPending",

1294

type_func = bool)

1786

type_func=bool)

1295

1787

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

1296

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1297

1789

"LastEnabled")

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1301

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1302

1794

"LastCheckedOK")

1303

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1306

1798

datetime_to_dbus, "LastApprovalRequest")

1307

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1308

1800

"ApprovedByDefault")

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1314

1804

approval_duration = notifychangeproperty(

1315

1805

dbus.UInt64, "ApprovalDuration",

1316

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

1806

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

1317

1807

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1321

1811

extended_timeout = notifychangeproperty(

1322

1812

dbus.UInt64, "ExtendedTimeout",

1323

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

1324

interval = notifychangeproperty(dbus.UInt64,

1325

"Interval",

1326

type_func =

1327

lambda td: td.total_seconds()

1328

* 1000)

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1329

1817

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

1330

1818

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

1331

1819

invalidate_only=True)

1332

1820

1333

1821

del notifychangeproperty

1334

1822

1335

1823

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

1336

1824

try:

1337

1825

self.remove_from_connection()

1340

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1341

1829

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

1342

1830

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

1343

1344

def checker_callback(self, pid, condition, command,

1345

*args, **kwargs):

1346

self.checker_callback_tag = None

1347

self.checker = None

1348

if os.WIFEXITED(condition):

1349

exitstatus = os.WEXITSTATUS(condition)

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1350

1839

# Emit D-Bus signal

1351

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1352

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1353

1843

dbus.String(command))

1354

1844

else:

1355

1845

# Emit D-Bus signal

1356

1846

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

1357

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1358

1851

dbus.String(command))

1359

1360

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

1361

*args, **kwargs)

1362

1852

return ret

1853

1363

1854

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

1364

1855

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

1365

1856

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

1369

1860

# Emit D-Bus signal

1370

1861

self.CheckerStarted(self.current_checker_command)

1371

1862

return r

1372

1863

1373

1864

def _reset_approved(self):

1374

1865

self.approved = None

1375

1866

return False

1376

1867

1377

1868

def approve(self, value=True):

1378

1869

self.approved = value

1379

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

1380

* 1000), self._reset_approved)

1870

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

1871

* 1000), self._reset_approved)

1381

1872

self.send_changedstate()

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1389

1880

# CheckerCompleted - signal

1390

1881

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

1391

1882

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

1392

1883

"D-Bus signal"

1393

1884

pass

1394

1885

1395

1886

# CheckerStarted - signal

1396

1887

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

1397

1888

def CheckerStarted(self, command):

1398

1889

"D-Bus signal"

1399

1890

pass

1400

1891

1401

1892

# PropertyChanged - signal

1402

1893

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

1403

1894

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

1404

1895

def PropertyChanged(self, property, value):

1405

1896

"D-Bus signal"

1406

1897

pass

1407

1898

1408

1899

# GotSecret - signal

1409

1900

@dbus.service.signal(_interface)

1410

1901

def GotSecret(self):

1413

1904

server to mandos-client

1414

1905

"""

1415

1906

pass

1416

1907

1417

1908

# Rejected - signal

1418

1909

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

1419

1910

def Rejected(self, reason):

1420

1911

"D-Bus signal"

1421

1912

pass

1422

1913

1423

1914

# NeedApproval - signal

1424

1915

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

1425

1916

def NeedApproval(self, timeout, default):

1426

1917

"D-Bus signal"

1427

1918

return self.need_approval()

1428

1429

## Methods

1430

1919

1920

# Methods

1921

1431

1922

# Approve - method

1432

1923

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

1433

1924

def Approve(self, value):

1434

1925

self.approve(value)

1435

1926

1436

1927

# CheckedOK - method

1437

1928

@dbus.service.method(_interface)

1438

1929

def CheckedOK(self):

1439

1930

self.checked_ok()

1440

1931

1441

1932

# Enable - method

1933

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

1442

1934

@dbus.service.method(_interface)

1443

1935

def Enable(self):

1444

1936

"D-Bus method"

1445

1937

self.enable()

1446

1938

1447

1939

# StartChecker - method

1940

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

1448

1941

@dbus.service.method(_interface)

1449

1942

def StartChecker(self):

1450

1943

"D-Bus method"

1451

1944

self.start_checker()

1452

1945

1453

1946

# Disable - method

1947

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

1454

1948

@dbus.service.method(_interface)

1455

1949

def Disable(self):

1456

1950

"D-Bus method"

1457

1951

self.disable()

1458

1952

1459

1953

# StopChecker - method

1954

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

1460

1955

@dbus.service.method(_interface)

1461

1956

def StopChecker(self):

1462

1957

self.stop_checker()

1463

1464

## Properties

1465

1958

1959

# Properties

1960

1466

1961

# ApprovalPending - property

1467

1962

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

1468

1963

def ApprovalPending_dbus_property(self):

1469

1964

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

1470

1965

1471

1966

# ApprovedByDefault - property

1472

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1473

1969

access="readwrite")

1474

1970

def ApprovedByDefault_dbus_property(self, value=None):

1475

1971

if value is None: # get

1476

1972

return dbus.Boolean(self.approved_by_default)

1477

1973

self.approved_by_default = bool(value)

1478

1974

1479

1975

# ApprovalDelay - property

1480

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1481

1978

access="readwrite")

1482

1979

def ApprovalDelay_dbus_property(self, value=None):

1483

1980

if value is None: # get

1484

1981

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

1485

1982

* 1000)

1486

1983

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

1487

1984

1488

1985

# ApprovalDuration - property

1489

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1490

1988

access="readwrite")

1491

1989

def ApprovalDuration_dbus_property(self, value=None):

1492

1990

if value is None: # get

1493

1991

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

1494

1992

* 1000)

1495

1993

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

1496

1994

1497

1995

# Name - property

1996

@dbus_annotations(

1997

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

1498

1998

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

1499

1999

def Name_dbus_property(self):

1500

2000

return dbus.String(self.name)

1501

2001

1502

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1503

2005

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

1504

2006

def Fingerprint_dbus_property(self):

1505

2007

return dbus.String(self.fingerprint)

1506

2008

1507

2009

# Host - property

1508

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1509

2012

access="readwrite")

1510

2013

def Host_dbus_property(self, value=None):

1511

2014

if value is None: # get

1512

2015

return dbus.String(self.host)

1513

2016

self.host = str(value)

1514

2017

1515

2018

# Created - property

2019

@dbus_annotations(

2020

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

1516

2021

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

1517

2022

def Created_dbus_property(self):

1518

2023

return datetime_to_dbus(self.created)

1519

2024

1520

2025

# LastEnabled - property

1521

2026

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

1522

2027

def LastEnabled_dbus_property(self):

1523

2028

return datetime_to_dbus(self.last_enabled)

1524

2029

1525

2030

# Enabled - property

1526

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1527

2033

access="readwrite")

1528

2034

def Enabled_dbus_property(self, value=None):

1529

2035

if value is None: # get

1532

2038

self.enable()

1533

2039

else:

1534

2040

self.disable()

1535

2041

1536

2042

# LastCheckedOK - property

1537

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1538

2045

access="readwrite")

1539

2046

def LastCheckedOK_dbus_property(self, value=None):

1540

2047

if value is not None:

1541

2048

self.checked_ok()

1542

2049

return

1543

2050

return datetime_to_dbus(self.last_checked_ok)

1544

2051

1545

2052

# LastCheckerStatus - property

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2053

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

1548

2054

def LastCheckerStatus_dbus_property(self):

1549

2055

return dbus.Int16(self.last_checker_status)

1550

2056

1551

2057

# Expires - property

1552

2058

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

1553

2059

def Expires_dbus_property(self):

1554

2060

return datetime_to_dbus(self.expires)

1555

2061

1556

2062

# LastApprovalRequest - property

1557

2063

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

1558

2064

def LastApprovalRequest_dbus_property(self):

1559

2065

return datetime_to_dbus(self.last_approval_request)

1560

2066

1561

2067

# Timeout - property

1562

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1563

2070

access="readwrite")

1564

2071

def Timeout_dbus_property(self, value=None):

1565

2072

if value is None: # get

1577

2084

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

1578

2085

is None):

1579

2086

return

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

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

1584

* 1000), self.disable))

1585

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1586

2092

# ExtendedTimeout - property

1587

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1588

2095

access="readwrite")

1589

2096

def ExtendedTimeout_dbus_property(self, value=None):

1590

2097

if value is None: # get

1591

2098

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

1592

2099

* 1000)

1593

2100

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

1594

2101

1595

2102

# Interval - property

1596

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1597

2105

access="readwrite")

1598

2106

def Interval_dbus_property(self, value=None):

1599

2107

if value is None: # get

1603

2111

return

1604

2112

if self.enabled:

1605

2113

# Reschedule checker run

1606

gobject.source_remove(self.checker_initiator_tag)

1607

self.checker_initiator_tag = (gobject.timeout_add

1608

(value, self.start_checker))

1609

self.start_checker() # Start one now, too

1610

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1611

2119

# Checker - property

1612

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1613

2122

access="readwrite")

1614

2123

def Checker_dbus_property(self, value=None):

1615

2124

if value is None: # get

1616

2125

return dbus.String(self.checker_command)

1617

2126

self.checker_command = str(value)

1618

2127

1619

2128

# CheckerRunning - property

1620

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1621

2131

access="readwrite")

1622

2132

def CheckerRunning_dbus_property(self, value=None):

1623

2133

if value is None: # get

1626

2136

self.start_checker()

1627

2137

else:

1628

2138

self.stop_checker()

1629

2139

1630

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1631

2144

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

1632

2145

def ObjectPath_dbus_property(self):

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1635

2148

# Secret = property

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1638

2156

def Secret_dbus_property(self, value):

1639

2157

self.secret = bytes(value)

1640

2158

1641

2159

del _interface

1642

2160

1643

2161

1646

2164

self._pipe = child_pipe

1647

2165

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

1648

2166

if not self._pipe.recv():

1649

raise KeyError()

1650

2167

raise KeyError(fpr)

2168

1651

2169

def __getattribute__(self, name):

1652

2170

if name == '_pipe':

1653

2171

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

1656

2174

if data[0] == 'data':

1657

2175

return data[1]

1658

2176

if data[0] == 'function':

2177

1659

2178

def func(*args, **kwargs):

1660

2179

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

1661

2180

return self._pipe.recv()[1]

2181

1662

2182

return func

1663

2183

1664

2184

def __setattr__(self, name, value):

1665

2185

if name == '_pipe':

1666

2186

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

1669

2189

1670

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1671

2191

"""A class to handle client connections.

1672

2192

1673

2193

Instantiated once for each connection to handle it.

1674

2194

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

1675

2195

1676

2196

def handle(self):

1677

2197

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

1678

2198

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

1679

2199

str(self.client_address))

1680

2200

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

1681

2201

self.server.child_pipe.fileno())

1682

1683

session = (gnutls.connection

1684

.ClientSession(self.request,

1685

gnutls.connection

1686

.X509Credentials()))

1687

1688

# Note: gnutls.connection.X509Credentials is really a

1689

# generic GnuTLS certificate credentials object so long as

1690

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

1691

# here despite using OpenPGP certificates.

1692

1693

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

1694

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

1695

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

1696

# "+DHE-DSS"))

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1697

2209

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

1698

2210

priority = self.server.gnutls_priority

1699

2211

if priority is None:

1700

2212

priority = "NORMAL"

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1705

2217

# Start communication using the Mandos protocol

1706

2218

# Get protocol number

1707

2219

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

1712

2224

except (ValueError, IndexError, RuntimeError) as error:

1713

2225

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

1714

2226

return

1715

2227

1716

2228

# Start GnuTLS connection

1717

2229

try:

1718

2230

session.handshake()

1719

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1720

2232

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

1721

2233

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

1722

2234

# established. Just abandon the request.

1723

2235

return

1724

2236

logger.debug("Handshake succeeded")

1725

2237

1726

2238

approval_required = False

1727

2239

try:

1728

2240

try:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1733

2244

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

1734

2245

return

1735

2246

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

1736

2247

1737

2248

try:

1738

2249

client = ProxyClient(child_pipe, fpr,

1739

2250

self.client_address)

1740

2251

except KeyError:

1741

2252

return

1742

2253

1743

2254

if client.approval_delay:

1744

2255

delay = client.approval_delay

1745

2256

client.approvals_pending += 1

1746

2257

approval_required = True

1747

2258

1748

2259

while True:

1749

2260

if not client.enabled:

1750

2261

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

1751

client.name)

2262

client.name)

1752

2263

if self.server.use_dbus:

1753

2264

# Emit D-Bus signal

1754

2265

client.Rejected("Disabled")

1755

2266

return

1756

2267

1757

2268

if client.approved or not client.approval_delay:

1758

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1759

2270

break

1760

2271

elif client.approved is None:

1761

2272

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

1772

2283

# Emit D-Bus signal

1773

2284

client.Rejected("Denied")

1774

2285

return

1775

1776

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1777

2288

time = datetime.datetime.now()

1778

2289

client.changedstate.acquire()

1779

2290

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

1792

2303

break

1793

2304

else:

1794

2305

delay -= time2 - time

1795

1796

sent_size = 0

1797

while sent_size < len(client.secret):

1798

try:

1799

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

1800

except gnutls.errors.GNUTLSError as error:

1801

logger.warning("gnutls send failed",

1802

exc_info=error)

1803

return

1804

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

1805

sent, len(client.secret)

1806

- (sent_size + sent))

1807

sent_size += sent

1808

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1809

2314

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

1810

2315

# bump the timeout using extended_timeout

1811

2316

client.bump_timeout(client.extended_timeout)

1812

2317

if self.server.use_dbus:

1813

2318

# Emit D-Bus signal

1814

2319

client.GotSecret()

1815

2320

1816

2321

finally:

1817

2322

if approval_required:

1818

2323

client.approvals_pending -= 1

1819

2324

try:

1820

2325

session.bye()

1821

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1822

2327

logger.warning("GnuTLS bye failed",

1823

2328

exc_info=error)

1824

2329

1825

2330

@staticmethod

1826

2331

def peer_certificate(session):

1827

2332

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

1828

2333

# If not an OpenPGP certificate...

1829

if (gnutls.library.functions

1830

.gnutls_certificate_type_get(session._c_object)

1831

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1832

# ...do the normal thing

1833

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1834

2338

list_size = ctypes.c_uint(1)

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1837

2340

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

1838

2341

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

1839

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

1840

" certificate")

2342

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

1841

2343

if list_size.value == 0:

1842

2344

return None

1843

2345

cert = cert_list[0]

1844

2346

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

1845

2347

1846

2348

@staticmethod

1847

2349

def fingerprint(openpgp):

1848

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1849

2351

# New GnuTLS "datum" with the OpenPGP public key

1850

datum = (gnutls.library.types

1851

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

1852

ctypes.POINTER

1853

(ctypes.c_ubyte)),

1854

ctypes.c_uint(len(openpgp))))

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1855

2356

# New empty GnuTLS certificate

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1859

2359

# Import the OpenPGP public key into the certificate

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1864

2362

# Verify the self signature in the key

1865

2363

crtverify = ctypes.c_uint()

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1869

2366

if crtverify.value != 0:

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1873

2369

# New buffer for the fingerprint

1874

2370

buf = ctypes.create_string_buffer(20)

1875

2371

buf_len = ctypes.c_size_t()

1876

2372

# Get the fingerprint from the certificate into the buffer

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2373

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

2374

ctypes.byref(buf_len))

1880

2375

# Deinit the certificate

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

gnutls.openpgp_crt_deinit(crt)

1882

2377

# Convert the buffer to a Python bytestring

1883

2378

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

1884

2379

# Convert the bytestring to hexadecimal notation

1888

2383

1889

2384

class MultiprocessingMixIn(object):

1890

2385

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

2386

1891

2387

def sub_process_main(self, request, address):

1892

2388

try:

1893

2389

self.finish_request(request, address)

1894

2390

except Exception:

1895

2391

self.handle_error(request, address)

1896

2392

self.close_request(request)

1897

2393

1898

2394

def process_request(self, request, address):

1899

2395

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

1900

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

1901

args = (request, address))

2396

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

2397

args=(request, address))

1902

2398

proc.start()

1903

2399

return proc

1904

2400

1905

2401

1906

2402

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1907

2403

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

2404

1908

2405

def process_request(self, request, client_address):

1909

2406

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

1910

2407

1911

2408

This function creates a new pipe in self.pipe

1912

2409

"""

1913

2410

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1914

2411

1915

2412

proc = MultiprocessingMixIn.process_request(self, request,

1916

2413

client_address)

1917

2414

self.child_pipe.close()

1918

2415

self.add_pipe(parent_pipe, proc)

1919

2416

1920

2417

def add_pipe(self, parent_pipe, proc):

1921

2418

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

1922

2419

raise NotImplementedError()

1925

2422

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1926

2423

socketserver.TCPServer, object):

1927

2424

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

1928

2425

1929

2426

Attributes:

1930

2427

enabled: Boolean; whether this server is activated yet

1931

2428

interface: None or a network interface name (string)

1932

2429

use_ipv6: Boolean; to use IPv6 or not

1933

2430

"""

2431

1934

2432

def __init__(self, server_address, RequestHandlerClass,

1935

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

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

1936

2436

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

1937

2437

creating a new one with socket.socket().

1938

2438

"""

1944

2444

self.socketfd = socketfd

1945

2445

# Save the original socket.socket() function

1946

2446

self.socket_socket = socket.socket

2447

1947

2448

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

1948

#

2449

#

1949

2450

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

1950

2451

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

1951

2452

# patching socket.socket.)

1952

#

2453

#

1953

2454

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

1954

2455

@functools.wraps(socket.socket)

1955

2456

def socket_wrapper(*args, **kwargs):

1967

2468

# socket_wrapper(), if socketfd was set.

1968

2469

socketserver.TCPServer.__init__(self, server_address,

1969

2470

RequestHandlerClass)

1970

2471

1971

2472

def server_bind(self):

1972

2473

"""This overrides the normal server_bind() function

1973

2474

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

1974

2475

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

2476

global SO_BINDTODEVICE

1975

2477

if self.interface is not None:

1976

2478

if SO_BINDTODEVICE is None:

1977

logger.error("SO_BINDTODEVICE does not exist;"

1978

" cannot bind to interface %s",

1979

self.interface)

1980

else:

1981

try:

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1983

SO_BINDTODEVICE,

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1999

2500

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

2000

2501

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

2001

2502

if not self.server_address[0]:

2002

2503

if self.address_family == socket.AF_INET6:

2003

any_address = "::" # in6addr_any

2504

any_address = "::" # in6addr_any

2004

2505

else:

2005

any_address = "0.0.0.0" # INADDR_ANY

2506

any_address = "0.0.0.0" # INADDR_ANY

2006

2507

self.server_address = (any_address,

2007

2508

self.server_address[1])

2008

2509

elif not self.server_address[1]:

2009

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

2010

0)

2510

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

2011

2511

# if self.interface:

2012

2512

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

2013

2513

# 0, # port

2019

2519

2020

2520

class MandosServer(IPv6_TCPServer):

2021

2521

"""Mandos server.

2022

2522

2023

2523

Attributes:

2024

2524

clients: set of Client objects

2025

2525

gnutls_priority GnuTLS priority string

2026

2526

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

2027

2028

Assumes a gobject.MainLoop event loop.

2527

2528

Assumes a GLib.MainLoop event loop.

2029

2529

"""

2530

2030

2531

def __init__(self, server_address, RequestHandlerClass,

2031

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

2032

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

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

2033

2538

self.enabled = False

2034

2539

self.clients = clients

2035

2540

if self.clients is None:

2038

2543

self.gnutls_priority = gnutls_priority

2039

2544

IPv6_TCPServer.__init__(self, server_address,

2040

2545

RequestHandlerClass,

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

2044

2550

def server_activate(self):

2045

2551

if self.enabled:

2046

2552

return socketserver.TCPServer.server_activate(self)

2047

2553

2048

2554

def enable(self):

2049

2555

self.enabled = True

2050

2556

2051

2557

def add_pipe(self, parent_pipe, proc):

2052

2558

# Call "handle_ipc" for both data and EOF events

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2059

2060

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

2061

proc = None, client_object=None):

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

2062

2570

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

2063

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

2571

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

2064

2572

# Wait for other process to exit

2065

2573

proc.join()

2066

2574

return False

2067

2575

2068

2576

# Read a request from the child

2069

2577

request = parent_pipe.recv()

2070

2578

command = request[0]

2071

2579

2072

2580

if command == 'init':

2073

fpr = request[1]

2581

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

2074

2582

address = request[2]

2075

2076

for c in self.clients.itervalues():

2583

2584

for c in self.clients.values():

2077

2585

if c.fingerprint == fpr:

2078

2586

client = c

2079

2587

break

2086

2594

address[0])

2087

2595

parent_pipe.send(False)

2088

2596

return False

2089

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2098

2605

parent_pipe.send(True)

2099

2606

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

2100

2607

# same fileno

2103

2610

funcname = request[1]

2104

2611

args = request[2]

2105

2612

kwargs = request[3]

2106

2613

2107

2614

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

2108

2615

funcname)(*args,

2109

**kwargs)))

2110

2616

**kwargs)))

2617

2111

2618

if command == 'getattr':

2112

2619

attrname = request[1]

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2115

2623

else:

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2624

parent_pipe.send((

2625

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

2626

2119

2627

if command == 'setattr':

2120

2628

attrname = request[1]

2121

2629

value = request[2]

2122

2630

setattr(client_object, attrname, value)

2123

2631

2124

2632

return True

2125

2633

2126

2634

2127

2635

def rfc3339_duration_to_delta(duration):

2128

2636

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

2129

2637

2130

2638

>>> rfc3339_duration_to_delta("P7D")

2131

2639

datetime.timedelta(7)

2132

2640

>>> rfc3339_duration_to_delta("PT60S")

2142

2650

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

2651

datetime.timedelta(1, 200)

2144

2652

"""

2145

2653

2146

2654

# Parsing an RFC 3339 duration with regular expressions is not

2147

2655

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

2148

2656

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

2149

2657

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

2150

2658

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

2151

2659

# avoid excessive use of external libraries.

2152

2660

2153

2661

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

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2163

2667

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

2164

2668

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

2165

2669

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

2166

2670

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

2167

2671

datetime.timedelta(seconds=1),

2168

frozenset((token_end,)))

2672

frozenset((token_end, )))

2169

2673

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

2170

2674

datetime.timedelta(minutes=1),

2171

2675

frozenset((token_second, token_end)))

2187

2691

frozenset((token_month, token_end)))

2188

2692

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

2189

2693

datetime.timedelta(weeks=1),

2190

frozenset((token_end,)))

2694

frozenset((token_end, )))

2191

2695

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

2192

2696

frozenset((token_year, token_month,

2193

2697

token_day, token_time,

2194

2698

token_week)))

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2197

2702

found_token = None

2198

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

2199

s = duration # String left to parse

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2200

2707

# Loop until end token is found

2201

2708

while found_token is not token_end:

2202

2709

# Search for any currently valid tokens

2218

2725

break

2219

2726

else:

2220

2727

# No currently valid tokens were found

2221

raise ValueError("Invalid RFC 3339 duration")

2728

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

2729

.format(duration))

2222

2730

# End token found

2223

2731

return value

2224

2732

2225

2733

2226

2734

def string_to_delta(interval):

2227

2735

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

2228

2736

2229

2737

>>> string_to_delta('7d')

2230

2738

datetime.timedelta(7)

2231

2739

>>> string_to_delta('60s')

2239

2747

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

2240

2748

datetime.timedelta(0, 330)

2241

2749

"""

2242

2750

2243

2751

try:

2244

2752

return rfc3339_duration_to_delta(interval)

2245

2753

except ValueError:

2246

2754

pass

2247

2755

2248

2756

timevalue = datetime.timedelta(0)

2249

2757

for s in interval.split():

2250

2758

try:

2261

2769

elif suffix == "w":

2262

2770

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

2263

2771

else:

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2772

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

2266

2773

except IndexError as e:

2267

2774

raise ValueError(*(e.args))

2268

2775

timevalue += delta

2269

2776

return timevalue

2270

2777

2271

2778

2272

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

2779

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

2273

2780

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

2274

2781

2275

2782

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

2276

2783

if os.fork():

2277

2784

sys.exit()

2284

2791

# Close all standard open file descriptors

2285

2792

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

2286

2793

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

2287

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

2794

raise OSError(errno.ENODEV,

2795

"{} not a character device"

2288

2796

.format(os.devnull))

2289

2797

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

2290

2798

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

2294

2802

2295

2803

2296

2804

def main():

2297

2805

2298

2806

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

2299

2807

# Parsing of options, both command line and config file

2300

2808

2301

2809

parser = argparse.ArgumentParser()

2302

2810

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

2303

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

2811

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

2304

2812

help="show version number and exit")

2305

2813

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

2306

2814

help="Bind to interface IF")

2342

2850

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

2343

2851

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

2344

2852

default=None)

2345

2853

2346

2854

options = parser.parse_args()

2347

2855

2348

2856

if options.check:

2349

2857

import doctest

2350

2858

fail_count, test_count = doctest.testmod()

2351

2859

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

2352

2860

2353

2861

# Default values for config file for server-global settings

2354

server_defaults = { "interface": "",

2355

"address": "",

2356

"port": "",

2357

"debug": "False",

2358

"priority":

2359

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

2360

"servicename": "Mandos",

2361

"use_dbus": "True",

2362

"use_ipv6": "True",

2363

"debuglevel": "",

2364

"restore": "True",

2365

"socket": "",

2366

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

2367

"foreground": "False",

2368

"zeroconf": "True",

2369

}

2370

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2371

2880

# Parse config file for server-global settings

2372

2881

server_config = configparser.SafeConfigParser(server_defaults)

2373

2882

del server_defaults

2374

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

2375

"mandos.conf"))

2883

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

2376

2884

# Convert the SafeConfigParser object to a dict

2377

2885

server_settings = server_config.defaults()

2378

2886

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

2379

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

2887

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

2888

"foreground", "zeroconf"):

2380

2889

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

2381

2890

option)

2382

2891

if server_settings["port"]:

2392

2901

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

2393

2902

["socket"])

2394

2903

del server_config

2395

2904

2396

2905

# Override the settings from the config file with command line

2397

2906

# options, if set.

2398

2907

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

2399

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

2400

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

2401

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

2908

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

2909

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

2910

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

2402

2911

value = getattr(options, option)

2403

2912

if value is not None:

2404

2913

server_settings[option] = value

2416

2925

if server_settings["debug"]:

2417

2926

server_settings["foreground"] = True

2418

2927

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

2419

2928

2420

2929

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

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

2930

2931

if (not server_settings["zeroconf"]

2932

and not (server_settings["port"]

2933

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

2934

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

2935

2428

2936

# For convenience

2429

2937

debug = server_settings["debug"]

2430

2938

debuglevel = server_settings["debuglevel"]

2434

2942

stored_state_file)

2435

2943

foreground = server_settings["foreground"]

2436

2944

zeroconf = server_settings["zeroconf"]

2437

2945

2438

2946

if debug:

2439

2947

initlogger(debug, logging.DEBUG)

2440

2948

else:

2443

2951

else:

2444

2952

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

2445

2953

initlogger(debug, level)

2446

2954

2447

2955

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

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2454

2961

# Parse config file with clients

2455

2962

client_config = configparser.SafeConfigParser(Client

2456

2963

.client_defaults)

2457

2964

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

2458

2965

"clients.conf"))

2459

2966

2460

2967

global mandos_dbus_service

2461

2968

mandos_dbus_service = None

2462

2969

2463

2970

socketfd = None

2464

2971

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

2465

2972

socketfd = server_settings["socket"]

2466

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

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2476

2981

if not foreground:

2477

2982

pidfilename = "/run/mandos.pid"

2478

2983

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

2479

2984

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

2480

2985

pidfile = None

2481

2986

try:

2482

pidfile = open(pidfilename, "w")

2987

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

2483

2988

except IOError as e:

2484

2989

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

2485

2990

exc_info=e)

2486

2487

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

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2488

2995

try:

2489

2996

uid = pwd.getpwnam(name).pw_uid

2490

gid = pwd.getpwnam(name).pw_gid

2997

gid = pwd.getpwnam(group).pw_gid

2491

2998

break

2492

2999

except KeyError:

2493

3000

continue

2497

3004

try:

2498

3005

os.setgid(gid)

2499

3006

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

2500

3010

except OSError as error:

3011

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

3012

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

2501

3013

if error.errno != errno.EPERM:

2502

3014

raise

2503

3015

2504

3016

if debug:

2505

3017

# Enable all possible GnuTLS debugging

2506

3018

2507

3019

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

2508

3020

# - GnuTLS manual

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2512

3024

def debug_gnutls(level, string):

2513

3025

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

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2518

3029

# Redirect stdin so all checkers get /dev/null

2519

3030

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

2520

3031

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

2521

3032

if null > 2:

2522

3033

os.close(null)

2523

3034

2524

3035

# Need to fork before connecting to D-Bus

2525

3036

if not foreground:

2526

3037

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

2527

3038

daemon()

2528

2529

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

2530

# need to inform gobject that threads will be used.

2531

gobject.threads_init()

2532

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2533

3044

global main_loop

2534

3045

# From the Avahi example code

2535

3046

DBusGMainLoop(set_as_default=True)

2536

main_loop = gobject.MainLoop()

3047

main_loop = GLib.MainLoop()

2537

3048

bus = dbus.SystemBus()

2538

3049

# End of Avahi example code

2539

3050

if use_dbus:

2540

3051

try:

2541

3052

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

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2547

3059

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

2548

3060

use_dbus = False

2549

3061

server_settings["use_dbus"] = False

2550

3062

tcp_server.use_dbus = False

2551

3063

if zeroconf:

2552

3064

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

2557

3070

if server_settings["interface"]:

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3071

service.interface = if_nametoindex(

3072

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

3073

2562

3074

global multiprocessing_manager

2563

3075

multiprocessing_manager = multiprocessing.Manager()

2564

3076

2565

3077

client_class = Client

2566

3078

if use_dbus:

2567

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

2568

3079

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

3080

2569

3081

client_settings = Client.config_parser(client_config)

2570

3082

old_client_settings = {}

2571

3083

clients_data = {}

2572

3084

2573

3085

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

2574

3086

global wnull

2575

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

3087

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

2576

3088

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

2577

3089

# mode

2578

3090

if debug or not foreground:

2579

3091

wnull.close()

2580

3092

2581

3093

# Get client data and settings from last running state.

2582

3094

if server_settings["restore"]:

2583

3095

try:

2584

3096

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

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2587

3142

os.remove(stored_state_path)

2588

3143

except IOError as e:

2589

3144

if e.errno == errno.ENOENT:

2590

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

2591

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

3145

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

3146

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

2592

3147

else:

2593

3148

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

2594

3149

exc_info=e)

2595

3150

raise

2596

3151

except EOFError as e:

2597

3152

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

2598

"EOFError:", exc_info=e)

2599

3153

"EOFError:",

3154

exc_info=e)

3155

2600

3156

with PGPEngine() as pgp:

2601

3157

for client_name, client in clients_data.items():

2602

3158

# Skip removed clients

2603

3159

if client_name not in client_settings:

2604

3160

continue

2605

3161

2606

3162

# Decide which value to use after restoring saved state.

2607

3163

# We have three different values: Old config file,

2608

3164

# new config file, and saved state.

2613

3169

# For each value in new config, check if it

2614

3170

# differs from the old config value (Except for

2615

3171

# the "secret" attribute)

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2619

3175

client[name] = value

2620

3176

except KeyError:

2621

3177

pass

2622

3178

2623

3179

# Clients who has passed its expire date can still be

2624

# enabled if its last checker was successful. Clients

3180

# enabled if its last checker was successful. A Client

2625

3181

# whose checker succeeded before we stored its state is

2626

3182

# assumed to have successfully run all checkers during

2627

3183

# downtime.

2630

3186

if not client["last_checked_ok"]:

2631

3187

logger.warning(

2632

3188

"disabling client {} - Client never "

2633

"performed a successful checker"

2634

.format(client_name))

3189

"performed a successful checker".format(

3190

client_name))

2635

3191

client["enabled"] = False

2636

3192

elif client["last_checker_status"] != 0:

2637

3193

logger.warning(

2638

3194

"disabling client {} - Client last"

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2642

3199

client["enabled"] = False

2643

3200

else:

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2647

3204

logger.debug("Last checker succeeded,"

2648

" keeping {} enabled"

2649

.format(client_name))

3205

" keeping {} enabled".format(

3206

client_name))

2650

3207

try:

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2655

3211

except PGPError:

2656

3212

# If decryption fails, we use secret from new settings

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2662

3218

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

2663

3219

for client_name in (set(old_client_settings)

2664

3220

- set(client_settings)):

2666

3222

for client_name in (set(client_settings)

2667

3223

- set(old_client_settings)):

2668

3224

clients_data[client_name] = client_settings[client_name]

2669

3225

2670

3226

# Create all client objects

2671

3227

for client_name, client in clients_data.items():

2672

3228

tcp_server.clients[client_name] = client_class(

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2676

3233

if not tcp_server.clients:

2677

3234

logger.warning("No clients defined")

2678

3235

2679

3236

if not foreground:

2680

3237

if pidfile is not None:

3238

pid = os.getpid()

2681

3239

try:

2682

3240

with pidfile:

2683

pid = os.getpid()

2684

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

3241

print(pid, file=pidfile)

2685

3242

except IOError:

2686

3243

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

2687

3244

pidfilename, pid)

2688

3245

del pidfile

2689

3246

del pidfilename

2690

2691

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

2692

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

2693

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2694

3252

if use_dbus:

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2698

3257

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

3258

2699

3259

def __init__(self):

2700

3260

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

3261

2701

3262

_interface = "se.recompile.Mandos"

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3263

2709

3264

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

2710

3265

def ClientAdded(self, objpath):

2711

3266

"D-Bus signal"

2712

3267

pass

2713

3268

2714

3269

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

2715

3270

def ClientNotFound(self, fingerprint, address):

2716

3271

"D-Bus signal"

2717

3272

pass

2718

3273

3274

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

3275

"true"})

2719

3276

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

2720

3277

def ClientRemoved(self, objpath, name):

2721

3278

"D-Bus signal"

2722

3279

pass

2723

3280

3281

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

3282

"true"})

2724

3283

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

2725

3284

def GetAllClients(self):

2726

3285

"D-Bus method"

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2731

3291

@dbus.service.method(_interface,

2732

3292

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

2733

3293

def GetAllClientsWithProperties(self):

2734

3294

"D-Bus method"

2735

3295

return dbus.Dictionary(

2736

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

2737

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

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2738

3299

signature="oa{sv}")

2739

3300

2740

3301

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

2741

3302

def RemoveClient(self, object_path):

2742

3303

"D-Bus method"

2743

for c in tcp_server.clients.itervalues():

3304

for c in tcp_server.clients.values():

2744

3305

if c.dbus_object_path == object_path:

2745

3306

del tcp_server.clients[c.name]

2746

3307

c.remove_from_connection()

2747

# Don't signal anything except ClientRemoved

3308

# Don't signal the disabling

2748

3309

c.disable(quiet=True)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2751

3312

return

2752

3313

raise KeyError(object_path)

2753

3314

2754

3315

del _interface

2755

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

2756

3353

mandos_dbus_service = MandosDBusService()

2757

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2758

3360

def cleanup():

2759

3361

"Cleanup function; run on exit"

2760

3362

if zeroconf:

2761

3363

service.cleanup()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3364

3365

mp.active_children()

3366

wn.close()

2765

3367

if not (tcp_server.clients or client_settings):

2766

3368

return

2767

3369

2768

3370

# Store client before exiting. Secrets are encrypted with key

2769

3371

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

2770

3372

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

2771

3373

clients = {}

2772

3374

with PGPEngine() as pgp:

2773

for client in tcp_server.clients.itervalues():

3375

for client in tcp_server.clients.values():

2774

3376

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

2775

3377

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

2776

3378

key)

2777

3379

client_dict = {}

2778

3380

2779

3381

# A list of attributes that can not be pickled

2780

3382

# + secret.

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2785

3387

exclude.add(name)

2786

3388

2787

3389

client_dict["encrypted_secret"] = (client

2788

3390

.encrypted_secret)

2789

3391

for attr in client.client_structure:

2790

3392

if attr not in exclude:

2791

3393

client_dict[attr] = getattr(client, attr)

2792

3394

2793

3395

clients[client.name] = client_dict

2794

3396

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

2795

3397

2796

3398

try:

2797

with (tempfile.NamedTemporaryFile

2798

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

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2803

3408

os.rename(tempname, stored_state_path)

2804

3409

except (IOError, OSError) as e:

2805

3410

if not debug:

2814

3419

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

2815

3420

exc_info=e)

2816

3421

raise

2817

3422

2818

3423

# Delete all clients, and settings from config

2819

3424

while tcp_server.clients:

2820

3425

name, client = tcp_server.clients.popitem()

2821

3426

if use_dbus:

2822

3427

client.remove_from_connection()

2823

# Don't signal anything except ClientRemoved

3428

# Don't signal the disabling

2824

3429

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

2825

3431

if use_dbus:

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3432

mandos_dbus_service.client_removed_signal(client)

2830

3433

client_settings.clear()

2831

3434

2832

3435

atexit.register(cleanup)

2833

2834

for client in tcp_server.clients.itervalues():

3436

3437

for client in tcp_server.clients.values():

2835

3438

if use_dbus:

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2838

3441

# Need to initiate checking of clients

2839

3442

if client.enabled:

2840

3443

client.init_checker()

2841

3444

2842

3445

tcp_server.enable()

2843

3446

tcp_server.server_activate()

2844

3447

2845

3448

# Find out what port we got

2846

3449

if zeroconf:

2847

3450

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

2852

3455

else: # IPv4

2853

3456

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

2854

3457

*tcp_server.socket.getsockname())

2855

2856

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

2857

3458

3459

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

3460

2858

3461

try:

2859

3462

if zeroconf:

2860

3463

# From the Avahi example code

2865

3468

cleanup()

2866

3469

sys.exit(1)

2867

3470

# End of Avahi example code

2868

2869

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

2870

lambda *args, **kwargs:

2871

(tcp_server.handle_request

2872

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

2873

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2874

3477

logger.debug("Starting main loop")

2875

3478

main_loop.run()

2876

3479

except AvahiError as error:

2885

3488

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

2886

3489

cleanup()

2887

3490

3491

2888

3492

if __name__ == '__main__':

2889

3493

main()