/mandos/release : revision 295

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 file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

42

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

37

import SocketServer as socketserver

47

38

import socket

48

39

import argparse

49

40

import datetime

50

41

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

55

49

import sys

56

50

import re

57

51

import os

66

60

import struct

67

61

import fcntl

68

62

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

63

import cPickle as pickle

73

64

import multiprocessing

74

65

import types

75

66

import binascii

76

67

import tempfile

77

import itertools

78

import collections

79

import codecs

80

68

81

69

import dbus

82

70

import dbus.service

83

from gi.repository import GLib

71

import gobject

72

import avahi

84

73

from dbus.mainloop.glib import DBusGMainLoop

85

74

import ctypes

86

75

import ctypes.util

87

76

import xml.dom.minidom

88

77

import inspect

78

import GnuPGInterface

89

79

90

# Try to find the value of SO_BINDTODEVICE:

91

80

try:

92

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

93

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

94

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

82

except AttributeError:

96

83

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

84

from IN import SO_BINDTODEVICE

100

85

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.7.18"

86

SO_BINDTODEVICE = None

87

88

version = "1.5.2"

119

89

stored_state_file = "clients.pickle"

120

90

121

91

logger = logging.getLogger()

122

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

address = str("/dev/log")))

123

95

124

96

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

97

if_nametoindex = (ctypes.cdll.LoadLibrary

98

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

99

.if_nametoindex)

127

100

except (OSError, AttributeError):

128

129

101

def if_nametoindex(interface):

130

102

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

131

103

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

132

104

with contextlib.closing(socket.socket()) as s:

133

105

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

struct.pack(b"16s16x", interface))

135

interface_index = struct.unpack("I", ifreq[16:20])[0]

106

struct.pack(str("16s16x"),

107

interface))

108

interface_index = struct.unpack(str("I"),

109

ifreq[16:20])[0]

136

110

return interface_index

137

111

138

112

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

113

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

156

114

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

115

162

116

syslogger.setFormatter(logging.Formatter

163

117

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

164

118

' %(message)s'))

165

119

logger.addHandler(syslogger)

166

120

167

121

if debug:

168

122

console = logging.StreamHandler()

169

123

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

181

135

182

136

class PGPEngine(object):

183

137

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

184

185

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

186

140

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

self.gnupg.options.extra_args.extend(['--force-mdc',

145

'--quiet',

146

'--no-use-agent'])

147

206

148

def __enter__(self):

207

149

return self

208

209

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

150

151

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

210

152

self._cleanup()

211

153

return False

212

154

213

155

def __del__(self):

214

156

self._cleanup()

215

157

216

158

def _cleanup(self):

217

159

if self.tempdir is not None:

218

160

# Delete contents of tempdir

219

161

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

220

topdown=False):

162

topdown = False):

221

163

for filename in files:

222

164

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

223

165

for dirname in dirs:

225

167

# Remove tempdir

226

168

os.rmdir(self.tempdir)

227

169

self.tempdir = None

228

170

229

171

def password_encode(self, password):

230

172

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

231

173

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

232

encoded = b"mandos" + binascii.hexlify(password)

233

if len(encoded) > 2048:

234

# GnuPG can't handle long passwords, so encode differently

235

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

236

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

237

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

238

return encoded

239

174

return b"mandos" + binascii.hexlify(password)

175

240

176

def encrypt(self, data, password):

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

raise PGPError(err)

177

self.gnupg.passphrase = self.password_encode(password)

178

with open(os.devnull) as devnull:

179

try:

180

proc = self.gnupg.run(['--symmetric'],

181

create_fhs=['stdin', 'stdout'],

182

attach_fhs={'stderr': devnull})

183

with contextlib.closing(proc.handles['stdin']) as f:

184

f.write(data)

185

with contextlib.closing(proc.handles['stdout']) as f:

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

256

191

return ciphertext

257

192

258

193

def decrypt(self, data, password):

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

raise PGPError(err)

194

self.gnupg.passphrase = self.password_encode(password)

195

with open(os.devnull) as devnull:

196

try:

197

proc = self.gnupg.run(['--decrypt'],

198

create_fhs=['stdin', 'stdout'],

199

attach_fhs={'stderr': devnull})

200

with contextlib.closing(proc.handles['stdin'] ) as f:

201

f.write(data)

202

with contextlib.closing(proc.handles['stdout']) as f:

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

274

208

return decrypted_plaintext

275

209

276

210

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

211

304

212

class AvahiError(Exception):

305

213

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

306

214

self.value = value

307

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

308

**kwargs)

309

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

310

218

311

219

class AvahiServiceError(AvahiError):

312

220

pass

313

221

314

315

222

class AvahiGroupError(AvahiError):

316

223

pass

317

224

318

225

319

226

class AvahiService(object):

320

227

"""An Avahi (Zeroconf) service.

321

228

322

229

Attributes:

323

230

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

324

231

Used to optionally bind to the specified interface.

325

232

name: string; Example: 'Mandos'

326

233

type: string; Example: '_mandos._tcp'.

327

See <https://www.iana.org/assignments/service-names-port-numbers>

234

See <http://www.dns-sd.org/ServiceTypes.html>

328

235

port: integer; what port to announce

329

236

TXT: list of strings; TXT record for the service

330

237

domain: string; Domain to publish on, default to .local if empty.

336

243

server: D-Bus Server

337

244

bus: dbus.SystemBus()

338

245

"""

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

246

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

247

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

248

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

249

protocol = avahi.PROTO_UNSPEC, bus = None):

351

250

self.interface = interface

352

251

self.name = name

353

252

self.type = servicetype

362

261

self.server = None

363

262

self.bus = bus

364

263

self.entry_group_state_changed_match = None

365

366

def rename(self, remove=True):

264

def rename(self):

367

265

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

368

266

if self.rename_count >= self.max_renames:

369

267

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

370

268

" after %i retries, exiting.",

371

269

self.rename_count)

372

270

raise AvahiServiceError("Too many renames")

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

271

self.name = unicode(self.server

272

.GetAlternativeServiceName(self.name))

376

273

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

377

274

self.name)

378

if remove:

379

self.remove()

275

self.remove()

380

276

try:

381

277

self.add()

382

278

except dbus.exceptions.DBusException as error:

383

if (error.get_dbus_name()

384

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

385

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

386

return self.rename(remove=False)

387

else:

388

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

389

self.cleanup()

390

os._exit(1)

391

279

logger.critical("DBusException: %s", error)

280

self.cleanup()

281

os._exit(1)

282

self.rename_count += 1

392

283

def remove(self):

393

284

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

394

285

if self.entry_group_state_changed_match is not None:

396

287

self.entry_group_state_changed_match = None

397

288

if self.group is not None:

398

289

self.group.Reset()

399

400

290

def add(self):

401

291

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

402

292

self.remove()

419

309

dbus.UInt16(self.port),

420

310

avahi.string_array_to_txt_array(self.TXT))

421

311

self.group.Commit()

422

423

312

def entry_group_state_changed(self, state, error):

424

313

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

425

314

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

426

315

427

316

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

317

logger.debug("Zeroconf service established.")

429

318

elif state == avahi.ENTRY_GROUP_COLLISION:

431

320

self.rename()

432

321

elif state == avahi.ENTRY_GROUP_FAILURE:

433

322

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

434

str(error))

435

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

436

323

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

437

326

def cleanup(self):

438

327

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

439

328

if self.group is not None:

444

333

pass

445

334

self.group = None

446

335

self.remove()

447

448

336

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

449

337

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

450

338

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

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

339

bad_states = { avahi.SERVER_INVALID:

340

"Zeroconf server invalid",

341

avahi.SERVER_REGISTERING: None,

342

avahi.SERVER_COLLISION:

343

"Zeroconf server name collision",

344

avahi.SERVER_FAILURE:

345

"Zeroconf server failure" }

457

346

if state in bad_states:

458

347

if bad_states[state] is not None:

459

348

if error is None:

462

351

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

463

352

self.cleanup()

464

353

elif state == avahi.SERVER_RUNNING:

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

354

self.add()

477

355

else:

478

356

if error is None:

479

357

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

480

358

else:

481

359

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

482

483

360

def activate(self):

484

361

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

485

362

if self.server is None:

489

366

follow_name_owner_changes=True),

490

367

avahi.DBUS_INTERFACE_SERVER)

491

368

self.server.connect_to_signal("StateChanged",

492

self.server_state_changed)

369

self.server_state_changed)

493

370

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

494

371

495

496

372

class AvahiServiceToSyslog(AvahiService):

497

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

373

def rename(self):

498

374

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

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

375

ret = AvahiService.rename(self)

376

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

503

380

return ret

504

381

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

382

def timedelta_to_milliseconds(td):

383

"Convert a datetime.timedelta() to milliseconds"

384

return ((td.days * 24 * 60 * 60 * 1000)

385

+ (td.seconds * 1000)

386

+ (td.microseconds // 1000))

387

780

388

class Client(object):

781

389

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

782

390

783

391

Attributes:

784

392

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

785

393

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

787

395

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

788

396

to see if the client lives.

789

397

'None' if no process is running.

790

checker_callback_tag: a GLib event source tag, or None

398

checker_callback_tag: a gobject event source tag, or None

791

399

checker_command: string; External command which is run to check

792

400

if client lives. %() expansions are done at

793

401

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

794

402

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

795

checker_initiator_tag: a GLib event source tag, or None

403

checker_initiator_tag: a gobject event source tag, or None

796

404

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

797

405

client_structure: Object describing what attributes a client has

798

406

and is used for storing the client at exit

799

407

current_checker_command: string; current running checker_command

800

disable_initiator_tag: a GLib event source tag, or None

408

disable_initiator_tag: a gobject event source tag, or None

801

409

enabled: bool()

802

410

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

803

411

uniquely identify the client

807

415

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

808

416

last_checker_status: integer between 0 and 255 reflecting exit

809

417

status of last checker. -1 reflects crashed

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

418

checker, or None.

813

419

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

814

420

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

815

421

D-Bus identifiers

820

426

runtime_expansions: Allowed attributes for runtime expansion.

821

427

expires: datetime.datetime(); time (UTC) when a client will be

822

428

disabled, or None

823

server_settings: The server_settings dict from main()

824

429

"""

825

430

826

431

runtime_expansions = ("approval_delay", "approval_duration",

827

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

828

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

829

"last_approval_request", "last_checked_ok",

432

"created", "enabled", "fingerprint",

433

"host", "interval", "last_checked_ok",

830

434

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

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

435

client_defaults = { "timeout": "5m",

436

"extended_timeout": "15m",

437

"interval": "2m",

438

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

439

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

442

"approved_by_default": "True",

443

"enabled": "True",

444

}

445

446

def timeout_milliseconds(self):

447

"Return the 'timeout' attribute in milliseconds"

448

return timedelta_to_milliseconds(self.timeout)

449

450

def extended_timeout_milliseconds(self):

451

"Return the 'extended_timeout' attribute in milliseconds"

452

return timedelta_to_milliseconds(self.extended_timeout)

453

454

def interval_milliseconds(self):

455

"Return the 'interval' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.interval)

457

458

def approval_delay_milliseconds(self):

459

return timedelta_to_milliseconds(self.approval_delay)

842

460

843

461

@staticmethod

844

462

def config_parser(config):

852

470

for client_name in config.sections():

853

471

section = dict(config.items(client_name))

854

472

client = settings[client_name] = {}

855

473

856

474

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

857

475

# Reformat values from string types to Python types

858

476

client["approved_by_default"] = config.getboolean(

859

477

client_name, "approved_by_default")

860

478

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

861

479

"enabled")

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

480

866

481

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

867

482

.replace(" ", ""))

868

483

if "secret" in section:

869

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

870

.encode("utf-8"),

871

"base64")

484

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

872

485

elif "secfile" in section:

873

486

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

874

487

(section["secfile"])),

875

488

"rb") as secfile:

876

489

client["secret"] = secfile.read()

877

490

else:

878

raise TypeError("No secret or secfile for section {}"

879

.format(section))

491

raise TypeError("No secret or secfile for section %s"

492

% section)

880

493

client["timeout"] = string_to_delta(section["timeout"])

881

494

client["extended_timeout"] = string_to_delta(

882

495

section["extended_timeout"])

888

501

client["checker_command"] = section["checker"]

889

502

client["last_approval_request"] = None

890

503

client["last_checked_ok"] = None

891

client["last_checker_status"] = -2

892

504

client["last_checker_status"] = None

505

893

506

return settings

894

895

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

507

508

509

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

510

"""Note: the 'checker' key in 'config' sets the

511

'checker_command' attribute and *not* the 'checker'

512

attribute."""

896

513

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

900

514

# adding all client settings

901

for setting, value in settings.items():

515

for setting, value in settings.iteritems():

902

516

setattr(self, setting, value)

903

517

904

518

if self.enabled:

905

519

if not hasattr(self, "last_enabled"):

906

520

self.last_enabled = datetime.datetime.utcnow()

910

524

else:

911

525

self.last_enabled = None

912

526

self.expires = None

913

527

914

528

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

529

# Uppercase and remove spaces from fingerprint for later

530

# comparison purposes with return value from the fingerprint()

531

# function

915

532

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

916

533

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

917

534

datetime.datetime.utcnow())

924

541

self.current_checker_command = None

925

542

self.approved = None

926

543

self.approvals_pending = 0

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

544

self.changedstate = (multiprocessing_manager

545

.Condition(multiprocessing_manager

546

.Lock()))

547

self.client_structure = [attr for attr in

548

self.__dict__.iterkeys()

931

549

if not attr.startswith("_")]

932

550

self.client_structure.append("client_structure")

933

934

for name, t in inspect.getmembers(

935

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

551

552

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

553

lambda obj:

554

isinstance(obj,

555

property)):

936

556

if not name.startswith("_"):

937

557

self.client_structure.append(name)

938

558

939

559

# Send notice to process children that client state has changed

940

560

def send_changedstate(self):

941

561

with self.changedstate:

942

562

self.changedstate.notify_all()

943

563

944

564

def enable(self):

945

565

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

946

566

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

947

567

# Already enabled

948

568

return

569

self.send_changedstate()

949

570

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

950

571

self.enabled = True

951

572

self.last_enabled = datetime.datetime.utcnow()

952

573

self.init_checker()

953

self.send_changedstate()

954

574

955

575

def disable(self, quiet=True):

956

576

"""Disable this client."""

957

577

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

958

578

return False

959

579

if not quiet:

580

self.send_changedstate()

581

if not quiet:

960

582

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

961

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

962

GLib.source_remove(self.disable_initiator_tag)

583

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

584

gobject.source_remove(self.disable_initiator_tag)

963

585

self.disable_initiator_tag = None

964

586

self.expires = None

965

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

966

GLib.source_remove(self.checker_initiator_tag)

587

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

588

gobject.source_remove(self.checker_initiator_tag)

967

589

self.checker_initiator_tag = None

968

590

self.stop_checker()

969

591

self.enabled = False

970

if not quiet:

971

self.send_changedstate()

972

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

592

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

973

593

return False

974

594

975

595

def __del__(self):

976

596

self.disable()

977

597

978

598

def init_checker(self):

979

599

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

980

600

# and every interval from then on.

981

if self.checker_initiator_tag is not None:

982

GLib.source_remove(self.checker_initiator_tag)

983

self.checker_initiator_tag = GLib.timeout_add(

984

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

985

self.start_checker)

601

self.checker_initiator_tag = (gobject.timeout_add

602

(self.interval_milliseconds(),

603

self.start_checker))

986

604

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

987

if self.disable_initiator_tag is not None:

988

GLib.source_remove(self.disable_initiator_tag)

989

self.disable_initiator_tag = GLib.timeout_add(

990

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

605

self.disable_initiator_tag = (gobject.timeout_add

606

(self.timeout_milliseconds(),

607

self.disable))

991

608

# Also start a new checker *right now*.

992

609

self.start_checker()

993

994

def checker_callback(self, source, condition, connection,

995

command):

610

611

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

996

612

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

997

613

self.checker_callback_tag = None

998

614

self.checker = None

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

615

if os.WIFEXITED(condition):

616

self.last_checker_status = os.WEXITSTATUS(condition)

1006

617

if self.last_checker_status == 0:

1007

618

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

1008

619

vars(self))

1009

620

self.checked_ok()

1010

621

else:

1011

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

622

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

623

vars(self))

1012

624

else:

1013

625

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

1015

626

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

1016

627

vars(self))

1017

return False

1018

1019

def checked_ok(self):

1020

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

1021

self.last_checked_ok = datetime.datetime.utcnow()

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

1024

self.bump_timeout()

1025

1026

def bump_timeout(self, timeout=None):

1027

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

628

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

This should only be called when the client has been seen,

633

alive and well.

634

"""

1028

635

if timeout is None:

1029

636

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

1030

638

if self.disable_initiator_tag is not None:

1031

GLib.source_remove(self.disable_initiator_tag)

1032

self.disable_initiator_tag = None

639

gobject.source_remove(self.disable_initiator_tag)

1033

640

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

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

641

self.disable_initiator_tag = (gobject.timeout_add

642

(timedelta_to_milliseconds

643

(timeout), self.disable))

1036

644

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

1037

645

1038

646

def need_approval(self):

1039

647

self.last_approval_request = datetime.datetime.utcnow()

1040

648

1041

649

def start_checker(self):

1042

650

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

1043

651

1044

652

If a checker already exists, leave it running and do

1045

653

nothing."""

1046

654

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

1047

# did that, and if a checker (for some reason) started running

1048

# slowly and taking more than 'interval' time, then the client

1049

# would inevitably timeout, since no checker would get a

1050

# chance to run to completion. If we instead leave running

655

# did that, then if a checker (for some reason) started

656

# running slowly and taking more than 'interval' time, the

657

# client would inevitably timeout, since no checker would get

658

# a chance to run to completion. If we instead leave running

1051

659

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

1052

660

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

1053

661

# should be.

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

662

663

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

664

try:

665

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

670

else:

671

if pid:

672

logger.warning("Checker was a zombie")

673

gobject.source_remove(self.checker_callback_tag)

674

self.checker_callback(pid, status,

675

self.current_checker_command)

1059

676

# Start a new checker if needed

1060

677

if self.checker is None:

1061

# Escape attributes for the shell

1062

escaped_attrs = {

1063

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

1064

for attr in self.runtime_expansions}

1065

678

try:

1066

command = self.checker_command % escaped_attrs

1067

except TypeError as error:

1068

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

1069

self.checker_command,

1070

exc_info=error)

1071

return True # Try again later

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

1072

697

self.current_checker_command = command

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

698

try:

699

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

700

command, self.name)

701

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

702

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

703

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

704

# always replaced by /dev/null.)

705

self.checker = subprocess.Popen(command,

706

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

714

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

except OSError as error:

719

logger.error("Failed to start subprocess: %s",

720

error)

721

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

1099

722

return True

1100

723

1101

724

def stop_checker(self):

1102

725

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

1103

726

if self.checker_callback_tag:

1104

GLib.source_remove(self.checker_callback_tag)

727

gobject.source_remove(self.checker_callback_tag)

1105

728

self.checker_callback_tag = None

1106

729

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

1107

730

return

1108

731

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

1109

self.checker.terminate()

732

try:

733

os.kill(self.checker.pid, signal.SIGTERM)

734

#time.sleep(0.5)

735

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

736

# os.kill(self.checker.pid, signal.SIGKILL)

737

except OSError as error:

738

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

739

raise

1110

740

self.checker = None

1111

741

1112

742

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

743

def dbus_service_property(dbus_interface, signature="v",

744

access="readwrite", byte_arrays=False):

1117

745

"""Decorators for marking methods of a DBusObjectWithProperties to

1118

746

become properties on the D-Bus.

1119

747

1120

748

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

1121

749

and with one argument by "Set".

1122

750

1123

751

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

1124

752

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

1125

753

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

1128

756

# "Set" method, so we fail early here:

1129

757

if byte_arrays and signature != "ay":

1130

758

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

1131

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

1132

759

" signature %r" % signature)

1133

760

def decorator(func):

1134

761

func._dbus_is_property = True

1135

762

func._dbus_interface = dbus_interface

1138

765

func._dbus_name = func.__name__

1139

766

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

1140

767

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

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1142

return func

1143

1144

return decorator

1145

1146

1147

def dbus_interface_annotations(dbus_interface):

1148

"""Decorator for marking functions returning interface annotations

1149

1150

Usage:

1151

1152

@dbus_interface_annotations("org.example.Interface")

1153

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

1154

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

1155

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

1156

"false"}

1157

"""

1158

1159

def decorator(func):

1160

func._dbus_is_interface = True

1161

func._dbus_interface = dbus_interface

1162

func._dbus_name = dbus_interface

1163

return func

1164

1165

return decorator

1166

1167

1168

def dbus_annotations(annotations):

1169

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

1170

Usage:

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

1175

@dbus_service_property("org.example.Interface", signature="b",

1176

access="r")

1177

def Property_dbus_property(self):

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

1181

"""

1182

1183

def decorator(func):

1184

func._dbus_annotations = annotations

1185

return func

1186

768

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

769

return func

1187

770

return decorator

1188

771

1189

772

1190

773

class DBusPropertyException(dbus.exceptions.DBusException):

1191

774

"""A base class for D-Bus property-related exceptions

1192

775

"""

1193

pass

776

def __unicode__(self):

777

return unicode(str(self))

1194

778

1195

779

1196

780

class DBusPropertyAccessException(DBusPropertyException):

1205

789

pass

1206

790

1207

791

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.

1213

"""

1214

1215

@staticmethod

1216

def _is_dbus_thing(thing):

1217

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

1218

1219

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

1220

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

1221

"""

1222

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

1223

False)

1224

1225

def _get_all_dbus_things(self, thing):

1226

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

1227

"""

1228

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

1229

athing.__get__(self))

1230

for cls in self.__class__.__mro__

1231

for name, athing in

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

792

class DBusObjectWithProperties(dbus.service.Object):

1298

793

"""A D-Bus object with properties.

1299

794

1300

795

Classes inheriting from this can use the dbus_service_property

1301

796

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

1302

797

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

1303

798

"""

1304

799

800

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

803

804

def _get_all_dbus_properties(self):

805

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

806

"""

807

return ((prop.__get__(self)._dbus_name, prop.__get__(self))

808

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

811

1305

812

def _get_dbus_property(self, interface_name, property_name):

1306

813

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

1307

814

property with the specified name and interface.

1308

815

"""

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

816

for cls in self.__class__.__mro__:

817

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

1312

819

if (value._dbus_name == property_name

1313

820

and value._dbus_interface == interface_name):

1314

821

return value.__get__(self)

1315

822

1316

823

# No such property

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

824

raise DBusPropertyNotFound(self.dbus_object_path + ":"

825

+ interface_name + "."

826

+ property_name)

827

828

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

1331

829

out_signature="v")

1332

830

def Get(self, interface_name, property_name):

1333

831

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

1339

837

if not hasattr(value, "variant_level"):

1340

838

return value

1341

839

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

1342

840

1343

841

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

1344

842

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

1345

843

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

1351

849

# The byte_arrays option is not supported yet on

1352

850

# signatures other than "ay".

1353

851

if prop._dbus_signature != "ay":

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

852

raise ValueError

1357

853

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

1358

854

for byte in value))

1359

855

prop(value)

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

856

857

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

1363

858

out_signature="a{sv}")

1364

859

def GetAll(self, interface_name):

1365

860

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

1366

861

standard.

1367

862

1368

863

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

1369

864

"""

1370

865

properties = {}

1371

for name, prop in self._get_all_dbus_things("property"):

866

for name, prop in self._get_all_dbus_properties():

1372

867

if (interface_name

1373

868

and interface_name != prop._dbus_interface):

1374

869

# Interface non-empty but did not match

1380

875

if not hasattr(value, "variant_level"):

1381

876

properties[name] = value

1382

877

continue

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

878

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

879

value.variant_level+1)

1385

880

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

1386

1387

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

1388

def PropertiesChanged(self, interface_name, changed_properties,

1389

invalidated_properties):

1390

"""Standard D-Bus PropertiesChanged() signal, see D-Bus

1391

standard.

1392

"""

1393

pass

1394

881

1395

882

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1396

883

out_signature="s",

1397

884

path_keyword='object_path',

1398

885

connection_keyword='connection')

1399

886

def Introspect(self, object_path, connection):

1400

"""Overloading of standard D-Bus method.

1401

1402

Inserts property tags and interface annotation tags.

887

"""Standard D-Bus method, overloaded to insert property tags.

1403

888

"""

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

889

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

890

connection)

1407

891

try:

1408

892

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

1409

1410

893

def make_tag(document, name, prop):

1411

894

e = document.createElement("property")

1412

895

e.setAttribute("name", name)

1413

896

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

1414

897

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

1415

898

return e

1416

1417

899

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

1418

# Add property tags

1419

900

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

1420

901

for name, prop

1421

in self._get_all_dbus_things("property")

902

in self._get_all_dbus_properties()

1422

903

if prop._dbus_interface

1423

904

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

1424

905

if_tag.appendChild(tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

1441

906

# Add the names to the return values for the

1442

907

# "org.freedesktop.DBus.Properties" methods

1443

908

if (if_tag.getAttribute("name")

1458

923

except (AttributeError, xml.dom.DOMException,

1459

924

xml.parsers.expat.ExpatError) as error:

1460

925

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

1461

exc_info=error)

1462

return xmlstring

1463

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

1536

def datetime_to_dbus(dt, variant_level=0):

926

error)

927

return xmlstring

928

929

930

def datetime_to_dbus (dt, variant_level=0):

1537

931

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

1538

932

if dt is None:

1539

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

1540

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

1541

1542

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1544

"""A class decorator; applied to a subclass of

1545

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

1546

interface names according to the "alt_interface_names" mapping.

1547

Usage:

1548

1549

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

1550

"net.example.AlternateInterface"})

1551

class SampleDBusObject(dbus.service.Object):

1552

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

1553

def SampleDBusMethod():

1554

pass

1555

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1557

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

1558

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

1559

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

1560

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

1561

1562

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

1563

(from DBusObjectWithProperties) and interfaces (from the

1564

dbus_interface_annotations decorator).

933

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

934

return dbus.String(dt.isoformat(),

935

variant_level=variant_level)

936

937

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

"""Applied to an empty subclass of a D-Bus object, this metaclass

941

will add additional D-Bus attributes matching a certain pattern.

1565

942

"""

1566

1567

def wrapper(cls):

1568

for orig_interface_name, alt_interface_name in (

1569

alt_interface_names.items()):

1570

attr = {}

1571

interface_names = set()

1572

# Go though all attributes of the class

1573

for attrname, attribute in inspect.getmembers(cls):

943

def __new__(mcs, name, bases, attr):

944

# Go through all the base classes which could have D-Bus

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

if issubclass(b, dbus.service.Object)):

948

# Go though all attributes of the base class

949

for attrname, attribute in inspect.getmembers(base):

1574

950

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

1575

951

# with the wrong interface name

1576

952

if (not hasattr(attribute, "_dbus_interface")

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

953

or not attribute._dbus_interface

954

.startswith("se.recompile.Mandos")):

1579

955

continue

1580

956

# Create an alternate D-Bus interface name based on

1581

957

# the current name

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1584

interface_names.add(alt_interface)

958

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1585

961

# Is this a D-Bus signal?

1586

962

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

1587

# Extract the original non-method undecorated

1588

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

963

# Extract the original non-method function by

964

# black magic

965

nonmethod_func = (dict(

1591

966

zip(attribute.func_code.co_freevars,

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

967

attribute.__closure__))["func"]

968

.cell_contents)

1599

969

# Create a new, but exactly alike, function

1600

970

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

1601

971

# with the alternate D-Bus interface name

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1606

# Copy annotations, if any

1607

try:

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1610

except AttributeError:

1611

pass

1612

972

new_function = (dbus.service.signal

973

(alt_interface,

974

attribute._dbus_signature)

975

(types.FunctionType(

976

nonmethod_func.func_code,

977

nonmethod_func.func_globals,

978

nonmethod_func.func_name,

979

nonmethod_func.func_defaults,

980

nonmethod_func.func_closure)))

1613

981

# Define a creator of a function to call both the

1614

# original and alternate functions, so both the

1615

# original and alternate signals gets sent when

1616

# the function is called

982

# old and new functions, so both the old and new

983

# signals gets sent when the function is called

1617

984

def fixscope(func1, func2):

1618

985

"""This function is a scope container to pass

1619

986

func1 and func2 to the "call_both" function

1620

987

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1623

988

def call_both(*args, **kwargs):

1624

989

"""This function will emit two D-Bus

1625

990

signals by calling func1 and func2"""

1626

991

func1(*args, **kwargs)

1627

992

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1634

993

return call_both

1635

994

# Create the "call_both" function and add it to

1636

995

# the class

1637

attr[attrname] = fixscope(attribute, new_function)

996

attr[attrname] = fixscope(attribute,

997

new_function)

1638

998

# Is this a D-Bus method?

1639

999

elif getattr(attribute, "_dbus_is_method", False):

1640

1000

# Create a new, but exactly alike, function

1641

1001

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

1642

1002

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

1643

1003

# to the class.

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1650

# Copy annotations, if any

1651

try:

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1654

except AttributeError:

1655

pass

1004

attr[attrname] = (dbus.service.method

1005

(alt_interface,

1006

attribute._dbus_in_signature,

1007

attribute._dbus_out_signature)

1008

(types.FunctionType

1009

(attribute.func_code,

1010

attribute.func_globals,

1011

attribute.func_name,

1012

attribute.func_defaults,

1013

attribute.func_closure)))

1656

1014

# Is this a D-Bus property?

1657

1015

elif getattr(attribute, "_dbus_is_property", False):

1658

1016

# Create a new, but exactly alike, function

1659

1017

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

1660

1018

# property with the alternate D-Bus interface

1661

1019

# name. Add it to the class.

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1668

# Copy annotations, if any

1669

try:

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1672

except AttributeError:

1673

pass

1674

# Is this a D-Bus interface?

1675

elif getattr(attribute, "_dbus_is_interface", False):

1676

# Create a new, but exactly alike, function

1677

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

1678

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

1679

# to the class.

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1683

if deprecate:

1684

# Deprecate all alternate interfaces

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1686

for interface_name in interface_names:

1687

1688

@dbus_interface_annotations(interface_name)

1689

def func(self):

1690

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

1691

"true"}

1692

# Find an unused name

1693

for aname in (iname.format(i)

1694

for i in itertools.count()):

1695

if aname not in attr:

1696

attr[aname] = func

1697

break

1698

if interface_names:

1699

# Replace the class with a new subclass of it with

1700

# methods, signals, etc. as created above.

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1707

return cls

1708

1709

return wrapper

1710

1711

1712

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

1713

"se.bsnet.fukt.Mandos"})

1020

attr[attrname] = (dbus_service_property

1021

(alt_interface,

1022

attribute._dbus_signature,

1023

attribute._dbus_access,

1024

attribute

1025

._dbus_get_args_options

1026

["byte_arrays"])

1027

(types.FunctionType

1028

(attribute.func_code,

1029

attribute.func_globals,

1030

attribute.func_name,

1031

attribute.func_defaults,

1032

attribute.func_closure)))

1033

return type.__new__(mcs, name, bases, attr)

1034

1035

1714

1036

class ClientDBus(Client, DBusObjectWithProperties):

1715

1037

"""A Client class using D-Bus

1716

1038

1717

1039

Attributes:

1718

1040

dbus_object_path: dbus.ObjectPath

1719

1041

bus: dbus.SystemBus()

1720

1042

"""

1721

1043

1722

1044

runtime_expansions = (Client.runtime_expansions

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1045

+ ("dbus_object_path",))

1046

1727

1047

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

1728

1729

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

1048

1049

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

1730

1050

self.bus = bus

1731

1051

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

1732

1052

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

1733

1053

# the D-Bus

1734

client_object_name = str(self.name).translate(

1054

client_object_name = unicode(self.name).translate(

1735

1055

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

1736

1056

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

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1057

self.dbus_object_path = (dbus.ObjectPath

1058

("/clients/" + client_object_name))

1739

1059

DBusObjectWithProperties.__init__(self, self.bus,

1740

1060

self.dbus_object_path)

1741

1742

def notifychangeproperty(transform_func, dbus_name,

1743

type_func=lambda x: x,

1744

variant_level=1,

1745

invalidate_only=False,

1746

_interface=_interface):

1061

1062

def notifychangeproperty(transform_func,

1063

dbus_name, type_func=lambda x: x,

1064

variant_level=1):

1747

1065

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

1748

1066

its changes to DBus.

1749

1067

1750

1068

transform_fun: Function that takes a value and a variant_level

1751

1069

and transforms it to a D-Bus type.

1752

1070

dbus_name: D-Bus name of the variable

1754

1072

to the D-Bus. Default: no transform

1755

1073

variant_level: D-Bus variant level. Default: 1

1756

1074

"""

1757

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

1758

1075

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

1759

1076

def setter(self, value):

1760

1077

if hasattr(self, "dbus_object_path"):

1761

1078

if (not hasattr(self, attrname) or

1762

1079

type_func(getattr(self, attrname, None))

1763

1080

!= type_func(value)):

1764

if invalidate_only:

1765

self.PropertiesChanged(

1766

_interface, dbus.Dictionary(),

1767

dbus.Array((dbus_name, )))

1768

else:

1769

dbus_value = transform_func(

1770

type_func(value),

1771

variant_level=variant_level)

1772

self.PropertyChanged(dbus.String(dbus_name),

1773

dbus_value)

1774

self.PropertiesChanged(

1775

_interface,

1776

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

1777

dbus_value}),

1778

dbus.Array())

1081

dbus_value = transform_func(type_func(value),

1082

variant_level

1083

=variant_level)

1084

self.PropertyChanged(dbus.String(dbus_name),

1085

dbus_value)

1779

1086

setattr(self, attrname, value)

1780

1087

1781

1088

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

1782

1089

1090

1783

1091

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1784

1092

approvals_pending = notifychangeproperty(dbus.Boolean,

1785

1093

"ApprovalPending",

1786

type_func=bool)

1094

type_func = bool)

1787

1095

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

1788

1096

last_enabled = notifychangeproperty(datetime_to_dbus,

1789

1097

"LastEnabled")

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1098

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

1099

type_func = lambda checker:

1100

checker is not None)

1793

1101

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1794

1102

"LastCheckedOK")

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1796

"LastCheckerStatus")

1797

1103

last_approval_request = notifychangeproperty(

1798

1104

datetime_to_dbus, "LastApprovalRequest")

1799

1105

approved_by_default = notifychangeproperty(dbus.Boolean,

1800

1106

"ApprovedByDefault")

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1107

approval_delay = notifychangeproperty(dbus.UInt64,

1108

"ApprovalDelay",

1109

type_func =

1110

timedelta_to_milliseconds)

1804

1111

approval_duration = notifychangeproperty(

1805

1112

dbus.UInt64, "ApprovalDuration",

1806

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

1113

type_func = timedelta_to_milliseconds)

1807

1114

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

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1115

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

1116

type_func =

1117

timedelta_to_milliseconds)

1811

1118

extended_timeout = notifychangeproperty(

1812

1119

dbus.UInt64, "ExtendedTimeout",

1813

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

1814

interval = notifychangeproperty(

1815

dbus.UInt64, "Interval",

1816

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

1120

type_func = timedelta_to_milliseconds)

1121

interval = notifychangeproperty(dbus.UInt64,

1122

"Interval",

1123

type_func =

1124

timedelta_to_milliseconds)

1817

1125

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

1818

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

1819

invalidate_only=True)

1820

1126

1821

1127

del notifychangeproperty

1822

1128

1823

1129

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

1824

1130

try:

1825

1131

self.remove_from_connection()

1828

1134

if hasattr(DBusObjectWithProperties, "__del__"):

1829

1135

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

1830

1136

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

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1137

1138

def checker_callback(self, pid, condition, command,

1139

*args, **kwargs):

1140

self.checker_callback_tag = None

1141

self.checker = None

1142

if os.WIFEXITED(condition):

1143

exitstatus = os.WEXITSTATUS(condition)

1839

1144

# Emit D-Bus signal

1840

1145

self.CheckerCompleted(dbus.Int16(exitstatus),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1146

dbus.Int64(condition),

1843

1147

dbus.String(command))

1844

1148

else:

1845

1149

# Emit D-Bus signal

1846

1150

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

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1151

dbus.Int64(condition),

1851

1152

dbus.String(command))

1852

return ret

1853

1153

1154

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

1155

*args, **kwargs)

1156

1854

1157

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

1855

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

1158

old_checker = self.checker

1159

if self.checker is not None:

1160

old_checker_pid = self.checker.pid

1161

else:

1162

old_checker_pid = None

1856

1163

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

1857

1164

# Only if new checker process was started

1858

1165

if (self.checker is not None

1860

1167

# Emit D-Bus signal

1861

1168

self.CheckerStarted(self.current_checker_command)

1862

1169

return r

1863

1170

1864

1171

def _reset_approved(self):

1865

1172

self.approved = None

1866

1173

return False

1867

1174

1868

1175

def approve(self, value=True):

1176

self.send_changedstate()

1869

1177

self.approved = value

1870

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

1871

* 1000), self._reset_approved)

1872

self.send_changedstate()

1873

1874

# D-Bus methods, signals & properties

1875

1876

# Interfaces

1877

1878

# Signals

1879

1178

gobject.timeout_add(timedelta_to_milliseconds

1179

(self.approval_duration),

1180

self._reset_approved)

1181

1182

1183

## D-Bus methods, signals & properties

1184

_interface = "se.recompile.Mandos.Client"

1185

1186

## Signals

1187

1880

1188

# CheckerCompleted - signal

1881

1189

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

1882

1190

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

1883

1191

"D-Bus signal"

1884

1192

pass

1885

1193

1886

1194

# CheckerStarted - signal

1887

1195

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

1888

1196

def CheckerStarted(self, command):

1889

1197

"D-Bus signal"

1890

1198

pass

1891

1199

1892

1200

# PropertyChanged - signal

1893

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

1894

1201

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

1895

1202

def PropertyChanged(self, property, value):

1896

1203

"D-Bus signal"

1897

1204

pass

1898

1205

1899

1206

# GotSecret - signal

1900

1207

@dbus.service.signal(_interface)

1901

1208

def GotSecret(self):

1904

1211

server to mandos-client

1905

1212

"""

1906

1213

pass

1907

1214

1908

1215

# Rejected - signal

1909

1216

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

1910

1217

def Rejected(self, reason):

1911

1218

"D-Bus signal"

1912

1219

pass

1913

1220

1914

1221

# NeedApproval - signal

1915

1222

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

1916

1223

def NeedApproval(self, timeout, default):

1917

1224

"D-Bus signal"

1918

1225

return self.need_approval()

1919

1920

# Methods

1921

1226

1227

## Methods

1228

1922

1229

# Approve - method

1923

1230

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

1924

1231

def Approve(self, value):

1925

1232

self.approve(value)

1926

1233

1927

1234

# CheckedOK - method

1928

1235

@dbus.service.method(_interface)

1929

1236

def CheckedOK(self):

1930

1237

self.checked_ok()

1931

1238

1932

1239

# Enable - method

1933

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

1934

1240

@dbus.service.method(_interface)

1935

1241

def Enable(self):

1936

1242

"D-Bus method"

1937

1243

self.enable()

1938

1244

1939

1245

# StartChecker - method

1940

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

1941

1246

@dbus.service.method(_interface)

1942

1247

def StartChecker(self):

1943

1248

"D-Bus method"

1944

1249

self.start_checker()

1945

1250

1946

1251

# Disable - method

1947

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

1948

1252

@dbus.service.method(_interface)

1949

1253

def Disable(self):

1950

1254

"D-Bus method"

1951

1255

self.disable()

1952

1256

1953

1257

# StopChecker - method

1954

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

1955

1258

@dbus.service.method(_interface)

1956

1259

def StopChecker(self):

1957

1260

self.stop_checker()

1958

1959

# Properties

1960

1261

1262

## Properties

1263

1961

1264

# ApprovalPending - property

1962

1265

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

1963

1266

def ApprovalPending_dbus_property(self):

1964

1267

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

1965

1268

1966

1269

# ApprovedByDefault - property

1967

@dbus_service_property(_interface,

1968

signature="b",

1270

@dbus_service_property(_interface, signature="b",

1969

1271

access="readwrite")

1970

1272

def ApprovedByDefault_dbus_property(self, value=None):

1971

1273

if value is None: # get

1972

1274

return dbus.Boolean(self.approved_by_default)

1973

1275

self.approved_by_default = bool(value)

1974

1276

1975

1277

# ApprovalDelay - property

1976

@dbus_service_property(_interface,

1977

signature="t",

1278

@dbus_service_property(_interface, signature="t",

1978

1279

access="readwrite")

1979

1280

def ApprovalDelay_dbus_property(self, value=None):

1980

1281

if value is None: # get

1981

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

1982

* 1000)

1282

return dbus.UInt64(self.approval_delay_milliseconds())

1983

1283

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

1984

1284

1985

1285

# ApprovalDuration - property

1986

@dbus_service_property(_interface,

1987

signature="t",

1286

@dbus_service_property(_interface, signature="t",

1988

1287

access="readwrite")

1989

1288

def ApprovalDuration_dbus_property(self, value=None):

1990

1289

if value is None: # get

1991

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

1992

* 1000)

1290

return dbus.UInt64(timedelta_to_milliseconds(

1291

self.approval_duration))

1993

1292

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

1994

1293

1995

1294

# Name - property

1996

@dbus_annotations(

1997

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

1998

1295

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

1999

1296

def Name_dbus_property(self):

2000

1297

return dbus.String(self.name)

2001

1298

2002

1299

# Fingerprint - property

2003

@dbus_annotations(

2004

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

2005

1300

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

2006

1301

def Fingerprint_dbus_property(self):

2007

1302

return dbus.String(self.fingerprint)

2008

1303

2009

1304

# Host - property

2010

@dbus_service_property(_interface,

2011

signature="s",

1305

@dbus_service_property(_interface, signature="s",

2012

1306

access="readwrite")

2013

1307

def Host_dbus_property(self, value=None):

2014

1308

if value is None: # get

2015

1309

return dbus.String(self.host)

2016

self.host = str(value)

2017

1310

self.host = unicode(value)

1311

2018

1312

# Created - property

2019

@dbus_annotations(

2020

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

2021

1313

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

2022

1314

def Created_dbus_property(self):

2023

1315

return datetime_to_dbus(self.created)

2024

1316

2025

1317

# LastEnabled - property

2026

1318

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

2027

1319

def LastEnabled_dbus_property(self):

2028

1320

return datetime_to_dbus(self.last_enabled)

2029

1321

2030

1322

# Enabled - property

2031

@dbus_service_property(_interface,

2032

signature="b",

1323

@dbus_service_property(_interface, signature="b",

2033

1324

access="readwrite")

2034

1325

def Enabled_dbus_property(self, value=None):

2035

1326

if value is None: # get

2038

1329

self.enable()

2039

1330

else:

2040

1331

self.disable()

2041

1332

2042

1333

# LastCheckedOK - property

2043

@dbus_service_property(_interface,

2044

signature="s",

1334

@dbus_service_property(_interface, signature="s",

2045

1335

access="readwrite")

2046

1336

def LastCheckedOK_dbus_property(self, value=None):

2047

1337

if value is not None:

2048

1338

self.checked_ok()

2049

1339

return

2050

1340

return datetime_to_dbus(self.last_checked_ok)

2051

2052

# LastCheckerStatus - property

2053

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

2054

def LastCheckerStatus_dbus_property(self):

2055

return dbus.Int16(self.last_checker_status)

2056

1341

2057

1342

# Expires - property

2058

1343

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

2059

1344

def Expires_dbus_property(self):

2060

1345

return datetime_to_dbus(self.expires)

2061

1346

2062

1347

# LastApprovalRequest - property

2063

1348

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

2064

1349

def LastApprovalRequest_dbus_property(self):

2065

1350

return datetime_to_dbus(self.last_approval_request)

2066

1351

2067

1352

# Timeout - property

2068

@dbus_service_property(_interface,

2069

signature="t",

1353

@dbus_service_property(_interface, signature="t",

2070

1354

access="readwrite")

2071

1355

def Timeout_dbus_property(self, value=None):

2072

1356

if value is None: # get

2073

return dbus.UInt64(self.timeout.total_seconds() * 1000)

2074

old_timeout = self.timeout

1357

return dbus.UInt64(self.timeout_milliseconds())

2075

1358

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

2076

# Reschedule disabling

1359

# Reschedule timeout

2077

1360

if self.enabled:

2078

1361

now = datetime.datetime.utcnow()

2079

self.expires += self.timeout - old_timeout

2080

if self.expires <= now:

1362

time_to_die = timedelta_to_milliseconds(

1363

(self.last_checked_ok + self.timeout) - now)

1364

if time_to_die <= 0:

2081

1365

# The timeout has passed

2082

1366

self.disable()

2083

1367

else:

1368

self.expires = (now +

1369

datetime.timedelta(milliseconds =

1370

time_to_die))

2084

1371

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

2085

1372

is None):

2086

1373

return

2087

GLib.source_remove(self.disable_initiator_tag)

2088

self.disable_initiator_tag = GLib.timeout_add(

2089

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

2090

self.disable)

2091

1374

gobject.source_remove(self.disable_initiator_tag)

1375

self.disable_initiator_tag = (gobject.timeout_add

1376

(time_to_die,

1377

self.disable))

1378

2092

1379

# ExtendedTimeout - property

2093

@dbus_service_property(_interface,

2094

signature="t",

1380

@dbus_service_property(_interface, signature="t",

2095

1381

access="readwrite")

2096

1382

def ExtendedTimeout_dbus_property(self, value=None):

2097

1383

if value is None: # get

2098

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

2099

* 1000)

1384

return dbus.UInt64(self.extended_timeout_milliseconds())

2100

1385

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

2101

1386

2102

1387

# Interval - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1388

@dbus_service_property(_interface, signature="t",

2105

1389

access="readwrite")

2106

1390

def Interval_dbus_property(self, value=None):

2107

1391

if value is None: # get

2108

return dbus.UInt64(self.interval.total_seconds() * 1000)

1392

return dbus.UInt64(self.interval_milliseconds())

2109

1393

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

2110

1394

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

2111

1395

return

2112

1396

if self.enabled:

2113

1397

# Reschedule checker run

2114

GLib.source_remove(self.checker_initiator_tag)

2115

self.checker_initiator_tag = GLib.timeout_add(

2116

value, self.start_checker)

2117

self.start_checker() # Start one now, too

2118

1398

gobject.source_remove(self.checker_initiator_tag)

1399

self.checker_initiator_tag = (gobject.timeout_add

1400

(value, self.start_checker))

1401

self.start_checker() # Start one now, too

1402

2119

1403

# Checker - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1404

@dbus_service_property(_interface, signature="s",

2122

1405

access="readwrite")

2123

1406

def Checker_dbus_property(self, value=None):

2124

1407

if value is None: # get

2125

1408

return dbus.String(self.checker_command)

2126

self.checker_command = str(value)

2127

1409

self.checker_command = unicode(value)

1410

2128

1411

# CheckerRunning - property

2129

@dbus_service_property(_interface,

2130

signature="b",

1412

@dbus_service_property(_interface, signature="b",

2131

1413

access="readwrite")

2132

1414

def CheckerRunning_dbus_property(self, value=None):

2133

1415

if value is None: # get

2136

1418

self.start_checker()

2137

1419

else:

2138

1420

self.stop_checker()

2139

1421

2140

1422

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

2144

1423

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

2145

1424

def ObjectPath_dbus_property(self):

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1425

return self.dbus_object_path # is already a dbus.ObjectPath

1426

2148

1427

# Secret = property

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1428

@dbus_service_property(_interface, signature="ay",

1429

access="write", byte_arrays=True)

2156

1430

def Secret_dbus_property(self, value):

2157

self.secret = bytes(value)

2158

1431

self.secret = str(value)

1432

2159

1433

del _interface

2160

1434

2161

1435

2164

1438

self._pipe = child_pipe

2165

1439

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

2166

1440

if not self._pipe.recv():

2167

raise KeyError(fpr)

2168

1441

raise KeyError()

1442

2169

1443

def __getattribute__(self, name):

2170

1444

if name == '_pipe':

2171

1445

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

2174

1448

if data[0] == 'data':

2175

1449

return data[1]

2176

1450

if data[0] == 'function':

2177

2178

1451

def func(*args, **kwargs):

2179

1452

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

2180

1453

return self._pipe.recv()[1]

2181

2182

1454

return func

2183

1455

2184

1456

def __setattr__(self, name, value):

2185

1457

if name == '_pipe':

2186

1458

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

2187

1459

self._pipe.send(('setattr', name, value))

2188

1460

2189

1461

1462

class ClientDBusTransitional(ClientDBus):

1463

__metaclass__ = AlternateDBusNamesMetaclass

1464

1465

2190

1466

class ClientHandler(socketserver.BaseRequestHandler, object):

2191

1467

"""A class to handle client connections.

2192

1468

2193

1469

Instantiated once for each connection to handle it.

2194

1470

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

2195

1471

2196

1472

def handle(self):

2197

1473

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

2198

1474

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

2199

str(self.client_address))

1475

unicode(self.client_address))

2200

1476

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

2201

1477

self.server.child_pipe.fileno())

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1478

1479

session = (gnutls.connection

1480

.ClientSession(self.request,

1481

gnutls.connection

1482

.X509Credentials()))

1483

1484

# Note: gnutls.connection.X509Credentials is really a

1485

# generic GnuTLS certificate credentials object so long as

1486

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

1487

# here despite using OpenPGP certificates.

1488

1489

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

1490

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

1491

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

1492

# "+DHE-DSS"))

2209

1493

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

2210

1494

priority = self.server.gnutls_priority

2211

1495

if priority is None:

2212

1496

priority = "NORMAL"

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1497

(gnutls.library.functions

1498

.gnutls_priority_set_direct(session._c_object,

1499

priority, None))

1500

2217

1501

# Start communication using the Mandos protocol

2218

1502

# Get protocol number

2219

1503

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

2220

1504

logger.debug("Protocol version: %r", line)

2221

1505

try:

2222

1506

if int(line.strip().split()[0]) > 1:

2223

raise RuntimeError(line)

1507

raise RuntimeError

2224

1508

except (ValueError, IndexError, RuntimeError) as error:

2225

1509

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

2226

1510

return

2227

1511

2228

1512

# Start GnuTLS connection

2229

1513

try:

2230

1514

session.handshake()

2231

except gnutls.Error as error:

1515

except gnutls.errors.GNUTLSError as error:

2232

1516

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

2233

1517

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

2234

1518

# established. Just abandon the request.

2235

1519

return

2236

1520

logger.debug("Handshake succeeded")

2237

1521

2238

1522

approval_required = False

2239

1523

try:

2240

1524

try:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1525

fpr = self.fingerprint(self.peer_certificate

1526

(session))

1527

except (TypeError,

1528

gnutls.errors.GNUTLSError) as error:

2244

1529

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

2245

1530

return

2246

1531

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

2247

1532

2248

1533

try:

2249

1534

client = ProxyClient(child_pipe, fpr,

2250

1535

self.client_address)

2251

1536

except KeyError:

2252

1537

return

2253

1538

2254

1539

if client.approval_delay:

2255

1540

delay = client.approval_delay

2256

1541

client.approvals_pending += 1

2257

1542

approval_required = True

2258

1543

2259

1544

while True:

2260

1545

if not client.enabled:

2261

1546

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

2262

client.name)

1547

client.name)

2263

1548

if self.server.use_dbus:

2264

1549

# Emit D-Bus signal

2265

1550

client.Rejected("Disabled")

2266

1551

return

2267

1552

2268

1553

if client.approved or not client.approval_delay:

2269

# We are approved or approval is disabled

1554

#We are approved or approval is disabled

2270

1555

break

2271

1556

elif client.approved is None:

2272

1557

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

2274

1559

if self.server.use_dbus:

2275

1560

# Emit D-Bus signal

2276

1561

client.NeedApproval(

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1562

client.approval_delay_milliseconds(),

1563

client.approved_by_default)

2279

1564

else:

2280

1565

logger.warning("Client %s was not approved",

2281

1566

client.name)

2283

1568

# Emit D-Bus signal

2284

1569

client.Rejected("Denied")

2285

1570

return

2286

2287

# wait until timeout or approved

1571

1572

#wait until timeout or approved

2288

1573

time = datetime.datetime.now()

2289

1574

client.changedstate.acquire()

2290

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

1575

(client.changedstate.wait

1576

(float(client.timedelta_to_milliseconds(delay)

1577

/ 1000)))

2291

1578

client.changedstate.release()

2292

1579

time2 = datetime.datetime.now()

2293

1580

if (time2 - time) >= delay:

2303

1590

break

2304

1591

else:

2305

1592

delay -= time2 - time

2306

2307

try:

2308

session.send(client.secret)

2309

except gnutls.Error as error:

2310

logger.warning("gnutls send failed",

2311

exc_info=error)

2312

return

2313

1593

1594

sent_size = 0

1595

while sent_size < len(client.secret):

1596

try:

1597

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

1598

except gnutls.errors.GNUTLSError as error:

1599

logger.warning("gnutls send failed")

1600

return

1601

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

1602

sent, len(client.secret)

1603

- (sent_size + sent))

1604

sent_size += sent

1605

2314

1606

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

2315

1607

# bump the timeout using extended_timeout

2316

client.bump_timeout(client.extended_timeout)

1608

client.checked_ok(client.extended_timeout)

2317

1609

if self.server.use_dbus:

2318

1610

# Emit D-Bus signal

2319

1611

client.GotSecret()

2320

1612

2321

1613

finally:

2322

1614

if approval_required:

2323

1615

client.approvals_pending -= 1

2324

1616

try:

2325

1617

session.bye()

2326

except gnutls.Error as error:

2327

logger.warning("GnuTLS bye failed",

2328

exc_info=error)

2329

1618

except gnutls.errors.GNUTLSError as error:

1619

logger.warning("GnuTLS bye failed")

1620

2330

1621

@staticmethod

2331

1622

def peer_certificate(session):

2332

1623

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

2333

1624

# If not an OpenPGP certificate...

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1625

if (gnutls.library.functions

1626

.gnutls_certificate_type_get(session._c_object)

1627

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1628

# ...do the normal thing

1629

return session.peer_certificate

2338

1630

list_size = ctypes.c_uint(1)

2339

cert_list = (gnutls.certificate_get_peers

1631

cert_list = (gnutls.library.functions

1632

.gnutls_certificate_get_peers

2340

1633

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

2341

1634

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

2342

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

1635

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

1636

" certificate")

2343

1637

if list_size.value == 0:

2344

1638

return None

2345

1639

cert = cert_list[0]

2346

1640

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

2347

1641

2348

1642

@staticmethod

2349

1643

def fingerprint(openpgp):

2350

1644

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2351

1645

# New GnuTLS "datum" with the OpenPGP public key

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1646

datum = (gnutls.library.types

1647

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

1648

ctypes.POINTER

1649

(ctypes.c_ubyte)),

1650

ctypes.c_uint(len(openpgp))))

2356

1651

# New empty GnuTLS certificate

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1652

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1653

(gnutls.library.functions

1654

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2359

1655

# Import the OpenPGP public key into the certificate

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1656

(gnutls.library.functions

1657

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

1658

gnutls.library.constants

1659

.GNUTLS_OPENPGP_FMT_RAW))

2362

1660

# Verify the self signature in the key

2363

1661

crtverify = ctypes.c_uint()

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1662

(gnutls.library.functions

1663

.gnutls_openpgp_crt_verify_self(crt, 0,

1664

ctypes.byref(crtverify)))

2366

1665

if crtverify.value != 0:

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1666

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1667

raise (gnutls.errors.CertificateSecurityError

1668

("Verify failed"))

2369

1669

# New buffer for the fingerprint

2370

1670

buf = ctypes.create_string_buffer(20)

2371

1671

buf_len = ctypes.c_size_t()

2372

1672

# Get the fingerprint from the certificate into the buffer

2373

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

2374

ctypes.byref(buf_len))

1673

(gnutls.library.functions

1674

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

1675

ctypes.byref(buf_len)))

2375

1676

# Deinit the certificate

2376

gnutls.openpgp_crt_deinit(crt)

1677

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2377

1678

# Convert the buffer to a Python bytestring

2378

1679

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

2379

1680

# Convert the bytestring to hexadecimal notation

2383

1684

2384

1685

class MultiprocessingMixIn(object):

2385

1686

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

2386

2387

1687

def sub_process_main(self, request, address):

2388

1688

try:

2389

1689

self.finish_request(request, address)

2390

1690

except Exception:

2391

1691

self.handle_error(request, address)

2392

1692

self.close_request(request)

2393

1693

2394

1694

def process_request(self, request, address):

2395

1695

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

2396

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

2397

args=(request, address))

1696

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

1697

args = (request,

1698

address))

2398

1699

proc.start()

2399

1700

return proc

2400

1701

2401

1702

2402

1703

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2403

1704

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

2404

2405

1705

def process_request(self, request, client_address):

2406

1706

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

2407

1707

2408

1708

This function creates a new pipe in self.pipe

2409

1709

"""

2410

1710

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2411

1711

2412

1712

proc = MultiprocessingMixIn.process_request(self, request,

2413

1713

client_address)

2414

1714

self.child_pipe.close()

2415

1715

self.add_pipe(parent_pipe, proc)

2416

1716

2417

1717

def add_pipe(self, parent_pipe, proc):

2418

1718

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

2419

raise NotImplementedError()

1719

raise NotImplementedError

2420

1720

2421

1721

2422

1722

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2423

1723

socketserver.TCPServer, object):

2424

1724

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

2425

1725

2426

1726

Attributes:

2427

1727

enabled: Boolean; whether this server is activated yet

2428

1728

interface: None or a network interface name (string)

2429

1729

use_ipv6: Boolean; to use IPv6 or not

2430

1730

"""

2431

2432

1731

def __init__(self, server_address, RequestHandlerClass,

2433

interface=None,

2434

use_ipv6=True,

2435

socketfd=None):

2436

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

2437

creating a new one with socket.socket().

2438

"""

1732

interface=None, use_ipv6=True):

2439

1733

self.interface = interface

2440

1734

if use_ipv6:

2441

1735

self.address_family = socket.AF_INET6

2442

if socketfd is not None:

2443

# Save the file descriptor

2444

self.socketfd = socketfd

2445

# Save the original socket.socket() function

2446

self.socket_socket = socket.socket

2447

2448

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

2449

#

2450

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

2451

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

2452

# patching socket.socket.)

2453

#

2454

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

2455

@functools.wraps(socket.socket)

2456

def socket_wrapper(*args, **kwargs):

2457

# Restore original function so subsequent calls are

2458

# not affected.

2459

socket.socket = self.socket_socket

2460

del self.socket_socket

2461

# This time only, return a new socket object from the

2462

# saved file descriptor.

2463

return socket.fromfd(self.socketfd, *args, **kwargs)

2464

# Replace socket.socket() function with wrapper

2465

socket.socket = socket_wrapper

2466

# The socketserver.TCPServer.__init__ will call

2467

# socket.socket(), which might be our replacement,

2468

# socket_wrapper(), if socketfd was set.

2469

1736

socketserver.TCPServer.__init__(self, server_address,

2470

1737

RequestHandlerClass)

2471

2472

1738

def server_bind(self):

2473

1739

"""This overrides the normal server_bind() function

2474

1740

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

2475

1741

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

2476

global SO_BINDTODEVICE

2477

1742

if self.interface is not None:

2478

1743

if SO_BINDTODEVICE is None:

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1744

logger.error("SO_BINDTODEVICE does not exist;"

1745

" cannot bind to interface %s",

1746

self.interface)

1747

else:

1748

try:

1749

self.socket.setsockopt(socket.SOL_SOCKET,

1750

SO_BINDTODEVICE,

1751

str(self.interface

1752

+ '\0'))

1753

except socket.error as error:

1754

if error[0] == errno.EPERM:

1755

logger.error("No permission to"

1756

" bind to interface %s",

1757

self.interface)

1758

elif error[0] == errno.ENOPROTOOPT:

1759

logger.error("SO_BINDTODEVICE not available;"

1760

" cannot bind to interface %s",

1761

self.interface)

1762

else:

1763

raise

2500

1764

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

2501

1765

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

2502

1766

if not self.server_address[0]:

2503

1767

if self.address_family == socket.AF_INET6:

2504

any_address = "::" # in6addr_any

1768

any_address = "::" # in6addr_any

2505

1769

else:

2506

any_address = "0.0.0.0" # INADDR_ANY

1770

any_address = socket.INADDR_ANY

2507

1771

self.server_address = (any_address,

2508

1772

self.server_address[1])

2509

1773

elif not self.server_address[1]:

2510

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

1774

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

1775

0)

2511

1776

# if self.interface:

2512

1777

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

2513

1778

# 0, # port

2519

1784

2520

1785

class MandosServer(IPv6_TCPServer):

2521

1786

"""Mandos server.

2522

1787

2523

1788

Attributes:

2524

1789

clients: set of Client objects

2525

1790

gnutls_priority GnuTLS priority string

2526

1791

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

2527

2528

Assumes a GLib.MainLoop event loop.

1792

1793

Assumes a gobject.MainLoop event loop.

2529

1794

"""

2530

2531

1795

def __init__(self, server_address, RequestHandlerClass,

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

1796

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

1797

gnutls_priority=None, use_dbus=True):

2538

1798

self.enabled = False

2539

1799

self.clients = clients

2540

1800

if self.clients is None:

2543

1803

self.gnutls_priority = gnutls_priority

2544

1804

IPv6_TCPServer.__init__(self, server_address,

2545

1805

RequestHandlerClass,

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

1806

interface = interface,

1807

use_ipv6 = use_ipv6)

2550

1808

def server_activate(self):

2551

1809

if self.enabled:

2552

1810

return socketserver.TCPServer.server_activate(self)

2553

1811

2554

1812

def enable(self):

2555

1813

self.enabled = True

2556

1814

2557

1815

def add_pipe(self, parent_pipe, proc):

2558

1816

# Call "handle_ipc" for both data and EOF events

2559

GLib.io_add_watch(

2560

parent_pipe.fileno(),

2561

GLib.IO_IN | GLib.IO_HUP,

2562

functools.partial(self.handle_ipc,

2563

parent_pipe=parent_pipe,

2564

proc=proc))

2565

2566

def handle_ipc(self, source, condition,

2567

parent_pipe=None,

2568

proc=None,

2569

client_object=None):

1817

gobject.io_add_watch(parent_pipe.fileno(),

1818

gobject.IO_IN | gobject.IO_HUP,

1819

functools.partial(self.handle_ipc,

1820

parent_pipe =

1821

parent_pipe,

1822

proc = proc))

1823

1824

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

1825

proc = None, client_object=None):

1826

condition_names = {

1827

gobject.IO_IN: "IN", # There is data to read.

1828

gobject.IO_OUT: "OUT", # Data can be written (without

1829

# blocking).

1830

gobject.IO_PRI: "PRI", # There is urgent data to read.

1831

gobject.IO_ERR: "ERR", # Error condition.

1832

gobject.IO_HUP: "HUP" # Hung up (the connection has been

1833

# broken, usually for pipes and

1834

# sockets).

1835

}

1836

conditions_string = ' | '.join(name

1837

for cond, name in

1838

condition_names.iteritems()

1839

if cond & condition)

2570

1840

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

2571

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

1841

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

2572

1842

# Wait for other process to exit

2573

1843

proc.join()

2574

1844

return False

2575

1845

2576

1846

# Read a request from the child

2577

1847

request = parent_pipe.recv()

2578

1848

command = request[0]

2579

1849

2580

1850

if command == 'init':

2581

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

1851

fpr = request[1]

2582

1852

address = request[2]

2583

2584

for c in self.clients.values():

1853

1854

for c in self.clients.itervalues():

2585

1855

if c.fingerprint == fpr:

2586

1856

client = c

2587

1857

break

2594

1864

address[0])

2595

1865

parent_pipe.send(False)

2596

1866

return False

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

1867

1868

gobject.io_add_watch(parent_pipe.fileno(),

1869

gobject.IO_IN | gobject.IO_HUP,

1870

functools.partial(self.handle_ipc,

1871

parent_pipe =

1872

parent_pipe,

1873

proc = proc,

1874

client_object =

1875

client))

2605

1876

parent_pipe.send(True)

2606

1877

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

2607

1878

# same fileno

2610

1881

funcname = request[1]

2611

1882

args = request[2]

2612

1883

kwargs = request[3]

2613

1884

2614

1885

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

2615

1886

funcname)(*args,

2616

**kwargs)))

2617

1887

**kwargs)))

1888

2618

1889

if command == 'getattr':

2619

1890

attrname = request[1]

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

1891

if callable(client_object.__getattribute__(attrname)):

1892

parent_pipe.send(('function',))

2623

1893

else:

2624

parent_pipe.send((

2625

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

2626

1894

parent_pipe.send(('data', client_object

1895

.__getattribute__(attrname)))

1896

2627

1897

if command == 'setattr':

2628

1898

attrname = request[1]

2629

1899

value = request[2]

2630

1900

setattr(client_object, attrname, value)

2631

1901

2632

1902

return True

2633

1903

2634

1904

2635

def rfc3339_duration_to_delta(duration):

2636

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

2637

2638

>>> rfc3339_duration_to_delta("P7D")

2639

datetime.timedelta(7)

2640

>>> rfc3339_duration_to_delta("PT60S")

2641

datetime.timedelta(0, 60)

2642

>>> rfc3339_duration_to_delta("PT60M")

2643

datetime.timedelta(0, 3600)

2644

>>> rfc3339_duration_to_delta("PT24H")

2645

datetime.timedelta(1)

2646

>>> rfc3339_duration_to_delta("P1W")

2647

datetime.timedelta(7)

2648

>>> rfc3339_duration_to_delta("PT5M30S")

2649

datetime.timedelta(0, 330)

2650

>>> rfc3339_duration_to_delta("P1DT3M20S")

2651

datetime.timedelta(1, 200)

2652

"""

2653

2654

# Parsing an RFC 3339 duration with regular expressions is not

2655

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

2656

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

2657

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

2658

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

2659

# avoid excessive use of external libraries.

2660

2661

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

2662

Token = collections.namedtuple("Token", (

2663

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

2664

# a "group" containing digits

2665

"value", # datetime.timedelta or None

2666

"followers")) # Tokens valid after this token

2667

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

2668

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

2669

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

2670

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

2671

datetime.timedelta(seconds=1),

2672

frozenset((token_end, )))

2673

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

2674

datetime.timedelta(minutes=1),

2675

frozenset((token_second, token_end)))

2676

token_hour = Token(re.compile(r"(\d+)H"),

2677

datetime.timedelta(hours=1),

2678

frozenset((token_minute, token_end)))

2679

token_time = Token(re.compile(r"T"),

2680

None,

2681

frozenset((token_hour, token_minute,

2682

token_second)))

2683

token_day = Token(re.compile(r"(\d+)D"),

2684

datetime.timedelta(days=1),

2685

frozenset((token_time, token_end)))

2686

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

2687

datetime.timedelta(weeks=4),

2688

frozenset((token_day, token_end)))

2689

token_year = Token(re.compile(r"(\d+)Y"),

2690

datetime.timedelta(weeks=52),

2691

frozenset((token_month, token_end)))

2692

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

2693

datetime.timedelta(weeks=1),

2694

frozenset((token_end, )))

2695

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

2696

frozenset((token_year, token_month,

2697

token_day, token_time,

2698

token_week)))

2699

# Define starting values:

2700

# Value so far

2701

value = datetime.timedelta()

2702

found_token = None

2703

# Following valid tokens

2704

followers = frozenset((token_duration, ))

2705

# String left to parse

2706

s = duration

2707

# Loop until end token is found

2708

while found_token is not token_end:

2709

# Search for any currently valid tokens

2710

for token in followers:

2711

match = token.regexp.match(s)

2712

if match is not None:

2713

# Token found

2714

if token.value is not None:

2715

# Value found, parse digits

2716

factor = int(match.group(1), 10)

2717

# Add to value so far

2718

value += factor * token.value

2719

# Strip token from string

2720

s = token.regexp.sub("", s, 1)

2721

# Go to found token

2722

found_token = token

2723

# Set valid next tokens

2724

followers = found_token.followers

2725

break

2726

else:

2727

# No currently valid tokens were found

2728

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

2729

.format(duration))

2730

# End token found

2731

return value

2732

2733

2734

1905

def string_to_delta(interval):

2735

1906

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

2736

1907

2737

1908

>>> string_to_delta('7d')

2738

1909

datetime.timedelta(7)

2739

1910

>>> string_to_delta('60s')

2747

1918

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

2748

1919

datetime.timedelta(0, 330)

2749

1920

"""

2750

2751

try:

2752

return rfc3339_duration_to_delta(interval)

2753

except ValueError:

2754

pass

2755

2756

1921

timevalue = datetime.timedelta(0)

2757

1922

for s in interval.split():

2758

1923

try:

2759

suffix = s[-1]

1924

suffix = unicode(s[-1])

2760

1925

value = int(s[:-1])

2761

1926

if suffix == "d":

2762

1927

delta = datetime.timedelta(value)

2769

1934

elif suffix == "w":

2770

1935

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

2771

1936

else:

2772

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

2773

except IndexError as e:

1937

raise ValueError("Unknown suffix %r" % suffix)

1938

except (ValueError, IndexError) as e:

2774

1939

raise ValueError(*(e.args))

2775

1940

timevalue += delta

2776

1941

return timevalue

2777

1942

2778

1943

2779

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

1944

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

2780

1945

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

2781

1946

2782

1947

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

2783

1948

if os.fork():

2784

1949

sys.exit()

2789

1954

sys.exit()

2790

1955

if not noclose:

2791

1956

# Close all standard open file descriptors

2792

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

1957

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

2793

1958

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

2794

1959

raise OSError(errno.ENODEV,

2795

"{} not a character device"

2796

.format(os.devnull))

1960

"%s not a character device"

1961

% os.path.devnull)

2797

1962

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

2798

1963

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

2799

1964

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

2802

1967

2803

1968

2804

1969

def main():

2805

1970

2806

1971

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

2807

1972

# Parsing of options, both command line and config file

2808

1973

2809

1974

parser = argparse.ArgumentParser()

2810

1975

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

2811

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

1976

version = "%%(prog)s %s" % version,

2812

1977

help="show version number and exit")

2813

1978

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

2814

1979

help="Bind to interface IF")

2820

1985

help="Run self-test")

2821

1986

parser.add_argument("--debug", action="store_true",

2822

1987

help="Debug mode; run in foreground and log"

2823

" to terminal", default=None)

1988

" to terminal")

2824

1989

parser.add_argument("--debuglevel", metavar="LEVEL",

2825

1990

help="Debug level for stdout output")

2826

1991

parser.add_argument("--priority", help="GnuTLS"

2833

1998

" files")

2834

1999

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

2835

2000

dest="use_dbus", help="Do not provide D-Bus"

2836

" system bus interface", default=None)

2001

" system bus interface")

2837

2002

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

2838

dest="use_ipv6", help="Do not use IPv6",

2839

default=None)

2003

dest="use_ipv6", help="Do not use IPv6")

2840

2004

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

2841

2005

dest="restore", help="Do not restore stored"

2842

" state", default=None)

2843

parser.add_argument("--socket", type=int,

2844

help="Specify a file descriptor to a network"

2845

" socket to use instead of creating one")

2006

" state")

2846

2007

parser.add_argument("--statedir", metavar="DIR",

2847

2008

help="Directory to save/restore state in")

2848

parser.add_argument("--foreground", action="store_true",

2849

help="Run in foreground", default=None)

2850

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

2851

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

2852

default=None)

2853

2009

2854

2010

options = parser.parse_args()

2855

2011

2856

2012

if options.check:

2857

2013

import doctest

2858

fail_count, test_count = doctest.testmod()

2859

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

2860

2014

doctest.testmod()

2015

sys.exit()

2016

2861

2017

# Default values for config file for server-global settings

2862

server_defaults = {"interface": "",

2863

"address": "",

2864

"port": "",

2865

"debug": "False",

2866

"priority":

2867

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

2868

":+SIGN-DSA-SHA256",

2869

"servicename": "Mandos",

2870

"use_dbus": "True",

2871

"use_ipv6": "True",

2872

"debuglevel": "",

2873

"restore": "True",

2874

"socket": "",

2875

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

2876

"foreground": "False",

2877

"zeroconf": "True",

2878

}

2879

2018

server_defaults = { "interface": "",

2019

"address": "",

2020

"port": "",

2021

"debug": "False",

2022

"priority":

2023

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

2024

"servicename": "Mandos",

2025

"use_dbus": "True",

2026

"use_ipv6": "True",

2027

"debuglevel": "",

2028

"restore": "True",

2029

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

2030

}

2031

2880

2032

# Parse config file for server-global settings

2881

2033

server_config = configparser.SafeConfigParser(server_defaults)

2882

2034

del server_defaults

2883

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

2035

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

2036

"mandos.conf"))

2884

2037

# Convert the SafeConfigParser object to a dict

2885

2038

server_settings = server_config.defaults()

2886

2039

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

2887

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

2888

"foreground", "zeroconf"):

2040

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

2889

2041

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

2890

2042

option)

2891

2043

if server_settings["port"]:

2892

2044

server_settings["port"] = server_config.getint("DEFAULT",

2893

2045

"port")

2894

if server_settings["socket"]:

2895

server_settings["socket"] = server_config.getint("DEFAULT",

2896

"socket")

2897

# Later, stdin will, and stdout and stderr might, be dup'ed

2898

# over with an opened os.devnull. But we don't want this to

2899

# happen with a supplied network socket.

2900

if 0 <= server_settings["socket"] <= 2:

2901

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

2902

["socket"])

2903

2046

del server_config

2904

2047

2905

2048

# Override the settings from the config file with command line

2906

2049

# options, if set.

2907

2050

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

2908

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

2909

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

2910

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

2051

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

2052

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

2053

"statedir"):

2911

2054

value = getattr(options, option)

2912

2055

if value is not None:

2913

2056

server_settings[option] = value

2914

2057

del options

2915

2058

# Force all strings to be unicode

2916

2059

for option in server_settings.keys():

2917

if isinstance(server_settings[option], bytes):

2918

server_settings[option] = (server_settings[option]

2919

.decode("utf-8"))

2920

# Force all boolean options to be boolean

2921

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

2922

"foreground", "zeroconf"):

2923

server_settings[option] = bool(server_settings[option])

2924

# Debug implies foreground

2925

if server_settings["debug"]:

2926

server_settings["foreground"] = True

2060

if type(server_settings[option]) is str:

2061

server_settings[option] = unicode(server_settings[option])

2927

2062

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

2928

2063

2929

2064

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

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

2065

2936

2066

# For convenience

2937

2067

debug = server_settings["debug"]

2938

2068

debuglevel = server_settings["debuglevel"]

2940

2070

use_ipv6 = server_settings["use_ipv6"]

2941

2071

stored_state_path = os.path.join(server_settings["statedir"],

2942

2072

stored_state_file)

2943

foreground = server_settings["foreground"]

2944

zeroconf = server_settings["zeroconf"]

2945

2073

2946

2074

if debug:

2947

2075

initlogger(debug, logging.DEBUG)

2948

2076

else:

2951

2079

else:

2952

2080

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

2953

2081

initlogger(debug, level)

2954

2082

2955

2083

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

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2084

syslogger.setFormatter(logging.Formatter

2085

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

2086

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

2087

% server_settings["servicename"]))

2088

2961

2089

# Parse config file with clients

2962

2090

client_config = configparser.SafeConfigParser(Client

2963

2091

.client_defaults)

2964

2092

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

2965

2093

"clients.conf"))

2966

2094

2967

2095

global mandos_dbus_service

2968

2096

mandos_dbus_service = None

2969

2970

socketfd = None

2971

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

2972

socketfd = server_settings["socket"]

2973

tcp_server = MandosServer(

2974

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

2975

ClientHandler,

2976

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

2977

use_ipv6=use_ipv6,

2978

gnutls_priority=server_settings["priority"],

2979

use_dbus=use_dbus,

2980

socketfd=socketfd)

2981

if not foreground:

2982

pidfilename = "/run/mandos.pid"

2983

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

2984

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

2985

pidfile = None

2986

try:

2987

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

2988

except IOError as e:

2989

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

2990

exc_info=e)

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2995

try:

2996

uid = pwd.getpwnam(name).pw_uid

2997

gid = pwd.getpwnam(group).pw_gid

2998

break

2097

2098

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

2099

server_settings["port"]),

2100

ClientHandler,

2101

interface=(server_settings["interface"]

2102

or None),

2103

use_ipv6=use_ipv6,

2104

gnutls_priority=

2105

server_settings["priority"],

2106

use_dbus=use_dbus)

2107

if not debug:

2108

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

2109

try:

2110

pidfile = open(pidfilename, "w")

2111

except IOError:

2112

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

2113

2114

try:

2115

uid = pwd.getpwnam("_mandos").pw_uid

2116

gid = pwd.getpwnam("_mandos").pw_gid

2117

except KeyError:

2118

try:

2119

uid = pwd.getpwnam("mandos").pw_uid

2120

gid = pwd.getpwnam("mandos").pw_gid

2999

2121

except KeyError:

3000

continue

3001

else:

3002

uid = 65534

3003

gid = 65534

2122

try:

2123

uid = pwd.getpwnam("nobody").pw_uid

2124

gid = pwd.getpwnam("nobody").pw_gid

2125

except KeyError:

2126

uid = 65534

2127

gid = 65534

3004

2128

try:

3005

2129

os.setgid(gid)

3006

2130

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

3010

2131

except OSError as error:

3011

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

3012

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

3013

if error.errno != errno.EPERM:

3014

raise

3015

2132

if error[0] != errno.EPERM:

2133

raise error

2134

3016

2135

if debug:

3017

2136

# Enable all possible GnuTLS debugging

3018

2137

3019

2138

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

3020

2139

# - GnuTLS manual

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2140

gnutls.library.functions.gnutls_global_set_log_level(11)

2141

2142

@gnutls.library.types.gnutls_log_func

3024

2143

def debug_gnutls(level, string):

3025

2144

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

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2145

2146

(gnutls.library.functions

2147

.gnutls_global_set_log_function(debug_gnutls))

2148

3029

2149

# Redirect stdin so all checkers get /dev/null

3030

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

2150

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

3031

2151

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

3032

2152

if null > 2:

3033

2153

os.close(null)

3034

2154

3035

2155

# Need to fork before connecting to D-Bus

3036

if not foreground:

2156

if not debug:

3037

2157

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

3038

2158

daemon()

3039

3040

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

3041

# to inform GLib that threads will be used.

3042

GLib.threads_init()

3043

2159

2160

gobject.threads_init()

2161

3044

2162

global main_loop

3045

2163

# From the Avahi example code

3046

DBusGMainLoop(set_as_default=True)

3047

main_loop = GLib.MainLoop()

2164

DBusGMainLoop(set_as_default=True )

2165

main_loop = gobject.MainLoop()

3048

2166

bus = dbus.SystemBus()

3049

2167

# End of Avahi example code

3050

2168

if use_dbus:

3051

2169

try:

3052

2170

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

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

3059

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

2171

bus, do_not_queue=True)

2172

old_bus_name = (dbus.service.BusName

2173

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

2174

do_not_queue=True))

2175

except dbus.exceptions.NameExistsException as e:

2176

logger.error(unicode(e) + ", disabling D-Bus")

3060

2177

use_dbus = False

3061

2178

server_settings["use_dbus"] = False

3062

2179

tcp_server.use_dbus = False

3063

if zeroconf:

3064

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3065

service = AvahiServiceToSyslog(

3066

name=server_settings["servicename"],

3067

servicetype="_mandos._tcp",

3068

protocol=protocol,

3069

bus=bus)

3070

if server_settings["interface"]:

3071

service.interface = if_nametoindex(

3072

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

3073

2180

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2181

service = AvahiServiceToSyslog(name =

2182

server_settings["servicename"],

2183

servicetype = "_mandos._tcp",

2184

protocol = protocol, bus = bus)

2185

if server_settings["interface"]:

2186

service.interface = (if_nametoindex

2187

(str(server_settings["interface"])))

2188

3074

2189

global multiprocessing_manager

3075

2190

multiprocessing_manager = multiprocessing.Manager()

3076

2191

3077

2192

client_class = Client

3078

2193

if use_dbus:

3079

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

3080

2194

client_class = functools.partial(ClientDBusTransitional,

2195

bus = bus)

2196

3081

2197

client_settings = Client.config_parser(client_config)

3082

2198

old_client_settings = {}

3083

2199

clients_data = {}

3084

3085

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

3086

global wnull

3087

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

3088

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

3089

# mode

3090

if debug or not foreground:

3091

wnull.close()

3092

2200

3093

2201

# Get client data and settings from last running state.

3094

2202

if server_settings["restore"]:

3095

2203

try:

3096

2204

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

3097

if sys.version_info.major == 2:

3098

clients_data, old_client_settings = pickle.load(

3099

stored_state)

3100

else:

3101

bytes_clients_data, bytes_old_client_settings = (

3102

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

3103

# Fix bytes to strings

3104

# clients_data

3105

# .keys()

3106

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

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_clients_data.items()}

3111

del bytes_clients_data

3112

for key in clients_data:

3113

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

3114

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

3115

for k, v in

3116

clients_data[key].items()}

3117

clients_data[key] = value

3118

# .client_structure

3119

value["client_structure"] = [

3120

(s.decode("utf-8")

3121

if isinstance(s, bytes)

3122

else s) for s in

3123

value["client_structure"]]

3124

# .name & .host

3125

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

3126

if isinstance(value[k], bytes):

3127

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

3128

# old_client_settings

3129

# .keys()

3130

old_client_settings = {

3131

(key.decode("utf-8")

3132

if isinstance(key, bytes)

3133

else key): value

3134

for key, value in

3135

bytes_old_client_settings.items()}

3136

del bytes_old_client_settings

3137

# .host

3138

for value in old_client_settings.values():

3139

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

3140

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

3141

.decode("utf-8"))

2205

clients_data, old_client_settings = (pickle.load

2206

(stored_state))

3142

2207

os.remove(stored_state_path)

3143

2208

except IOError as e:

3144

if e.errno == errno.ENOENT:

3145

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

3146

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

3147

else:

3148

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

3149

exc_info=e)

2209

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

2210

.format(e))

2211

if e.errno != errno.ENOENT:

3150

2212

raise

3151

2213

except EOFError as e:

3152

2214

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

3153

"EOFError:",

3154

exc_info=e)

3155

2215

"EOFError: {0}".format(e))

2216

3156

2217

with PGPEngine() as pgp:

3157

for client_name, client in clients_data.items():

3158

# Skip removed clients

3159

if client_name not in client_settings:

3160

continue

3161

2218

for client_name, client in clients_data.iteritems():

3162

2219

# Decide which value to use after restoring saved state.

3163

2220

# We have three different values: Old config file,

3164

2221

# new config file, and saved state.

3169

2226

# For each value in new config, check if it

3170

2227

# differs from the old config value (Except for

3171

2228

# the "secret" attribute)

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2229

if (name != "secret" and

2230

value != old_client_settings[client_name]

2231

[name]):

3175

2232

client[name] = value

3176

2233

except KeyError:

3177

2234

pass

3178

2235

3179

2236

# Clients who has passed its expire date can still be

3180

# enabled if its last checker was successful. A Client

2237

# enabled if its last checker was successful. Clients

3181

2238

# whose checker succeeded before we stored its state is

3182

2239

# assumed to have successfully run all checkers during

3183

2240

# downtime.

3185

2242

if datetime.datetime.utcnow() >= client["expires"]:

3186

2243

if not client["last_checked_ok"]:

3187

2244

logger.warning(

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2245

"disabling client {0} - Client never "

2246

"performed a successful checker"

2247

.format(client_name))

3191

2248

client["enabled"] = False

3192

2249

elif client["last_checker_status"] != 0:

3193

2250

logger.warning(

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2251

"disabling client {0} - Client "

2252

"last checker failed with error code {1}"

2253

.format(client_name,

2254

client["last_checker_status"]))

3199

2255

client["enabled"] = False

3200

2256

else:

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2257

client["expires"] = (datetime.datetime

2258

.utcnow()

2259

+ client["timeout"])

3204

2260

logger.debug("Last checker succeeded,"

3205

" keeping {} enabled".format(

3206

client_name))

2261

" keeping {0} enabled"

2262

.format(client_name))

3207

2263

try:

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2264

client["secret"] = (

2265

pgp.decrypt(client["encrypted_secret"],

2266

client_settings[client_name]

2267

["secret"]))

3211

2268

except PGPError:

3212

2269

# If decryption fails, we use secret from new settings

3213

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

3214

client_name))

3215

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

3216

["secret"])

2270

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

2271

.format(client_name))

2272

client["secret"] = (

2273

client_settings[client_name]["secret"])

3217

2274

2275

3218

2276

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

3219

2277

for client_name in (set(old_client_settings)

3220

2278

- set(client_settings)):

3224

2282

clients_data[client_name] = client_settings[client_name]

3225

2283

3226

2284

# Create all client objects

3227

for client_name, client in clients_data.items():

2285

for client_name, client in clients_data.iteritems():

3228

2286

tcp_server.clients[client_name] = client_class(

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2287

name = client_name, settings = client)

2288

3233

2289

if not tcp_server.clients:

3234

2290

logger.warning("No clients defined")

3235

3236

if not foreground:

3237

if pidfile is not None:

3238

pid = os.getpid()

3239

try:

3240

with pidfile:

3241

print(pid, file=pidfile)

3242

except IOError:

3243

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

3244

pidfilename, pid)

3245

del pidfile

2291

2292

if not debug:

2293

try:

2294

with pidfile:

2295

pid = os.getpid()

2296

pidfile.write(str(pid) + "\n".encode("utf-8"))

2297

del pidfile

2298

except IOError:

2299

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

2300

pidfilename, pid)

2301

except NameError:

2302

# "pidfile" was never created

2303

pass

3246

2304

del pidfilename

3247

3248

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

3249

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3250

lambda: main_loop.quit() and False)

3251

2305

signal.signal(signal.SIGINT, signal.SIG_IGN)

2306

2307

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

2308

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

2309

3252

2310

if use_dbus:

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2311

class MandosDBusService(dbus.service.Object):

3257

2312

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

3258

3259

2313

def __init__(self):

3260

2314

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

3261

3262

2315

_interface = "se.recompile.Mandos"

3263

2316

3264

2317

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

3265

2318

def ClientAdded(self, objpath):

3266

2319

"D-Bus signal"

3267

2320

pass

3268

2321

3269

2322

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

3270

2323

def ClientNotFound(self, fingerprint, address):

3271

2324

"D-Bus signal"

3272

2325

pass

3273

3274

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

3275

"true"})

2326

3276

2327

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

3277

2328

def ClientRemoved(self, objpath, name):

3278

2329

"D-Bus signal"

3279

2330

pass

3280

3281

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

3282

"true"})

2331

3283

2332

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

3284

2333

def GetAllClients(self):

3285

2334

"D-Bus method"

3286

return dbus.Array(c.dbus_object_path for c in

3287

tcp_server.clients.values())

3288

3289

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

3290

"true"})

2335

return dbus.Array(c.dbus_object_path

2336

for c in

2337

tcp_server.clients.itervalues())

2338

3291

2339

@dbus.service.method(_interface,

3292

2340

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

3293

2341

def GetAllClientsWithProperties(self):

3294

2342

"D-Bus method"

3295

2343

return dbus.Dictionary(

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2344

((c.dbus_object_path, c.GetAll(""))

2345

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

3299

2346

signature="oa{sv}")

3300

2347

3301

2348

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

3302

2349

def RemoveClient(self, object_path):

3303

2350

"D-Bus method"

3304

for c in tcp_server.clients.values():

2351

for c in tcp_server.clients.itervalues():

3305

2352

if c.dbus_object_path == object_path:

3306

2353

del tcp_server.clients[c.name]

3307

2354

c.remove_from_connection()

3308

# Don't signal the disabling

2355

# Don't signal anything except ClientRemoved

3309

2356

c.disable(quiet=True)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2357

# Emit D-Bus signal

2358

self.ClientRemoved(object_path, c.name)

3312

2359

return

3313

2360

raise KeyError(object_path)

3314

2361

3315

2362

del _interface

3316

3317

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3318

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

3319

def GetManagedObjects(self):

3320

"""D-Bus method"""

3321

return dbus.Dictionary(

3322

{client.dbus_object_path:

3323

dbus.Dictionary(

3324

{interface: client.GetAll(interface)

3325

for interface in

3326

client._get_all_interface_names()})

3327

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

3328

3329

def client_added_signal(self, client):

3330

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

3331

if use_dbus:

3332

# New standard signal

3333

self.InterfacesAdded(

3334

client.dbus_object_path,

3335

dbus.Dictionary(

3336

{interface: client.GetAll(interface)

3337

for interface in

3338

client._get_all_interface_names()}))

3339

# Old signal

3340

self.ClientAdded(client.dbus_object_path)

3341

3342

def client_removed_signal(self, client):

3343

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

3344

if use_dbus:

3345

# New standard signal

3346

self.InterfacesRemoved(

3347

client.dbus_object_path,

3348

client._get_all_interface_names())

3349

# Old signal

3350

self.ClientRemoved(client.dbus_object_path,

3351

client.name)

3352

3353

mandos_dbus_service = MandosDBusService()

3354

3355

# Save modules to variables to exempt the modules from being

3356

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

3357

mp = multiprocessing

3358

wn = wnull

3359

2363

2364

class MandosDBusServiceTransitional(MandosDBusService):

2365

__metaclass__ = AlternateDBusNamesMetaclass

2366

mandos_dbus_service = MandosDBusServiceTransitional()

2367

3360

2368

def cleanup():

3361

2369

"Cleanup function; run on exit"

3362

if zeroconf:

3363

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2370

service.cleanup()

2371

2372

multiprocessing.active_children()

3367

2373

if not (tcp_server.clients or client_settings):

3368

2374

return

3369

2375

3370

2376

# Store client before exiting. Secrets are encrypted with key

3371

2377

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

3372

2378

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

3373

2379

clients = {}

3374

2380

with PGPEngine() as pgp:

3375

for client in tcp_server.clients.values():

2381

for client in tcp_server.clients.itervalues():

3376

2382

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

3377

2383

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

3378

2384

key)

3379

2385

client_dict = {}

3380

2386

3381

2387

# A list of attributes that can not be pickled

3382

2388

# + secret.

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2389

exclude = set(("bus", "changedstate", "secret",

2390

"checker"))

2391

for name, typ in (inspect.getmembers

2392

(dbus.service.Object)):

3387

2393

exclude.add(name)

3388

2394

3389

2395

client_dict["encrypted_secret"] = (client

3390

2396

.encrypted_secret)

3391

2397

for attr in client.client_structure:

3392

2398

if attr not in exclude:

3393

2399

client_dict[attr] = getattr(client, attr)

3394

2400

3395

2401

clients[client.name] = client_dict

3396

2402

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

3397

2403

3398

2404

try:

3399

with tempfile.NamedTemporaryFile(

3400

mode='wb',

3401

suffix=".pickle",

3402

prefix='clients-',

3403

dir=os.path.dirname(stored_state_path),

3404

delete=False) as stored_state:

3405

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

3406

protocol=2)

3407

tempname = stored_state.name

2405

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2406

prefix="clients-",

2407

dir=os.path.dirname

2408

(stored_state_path))

2409

with os.fdopen(tempfd, "wb") as stored_state:

2410

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

3408

2411

os.rename(tempname, stored_state_path)

3409

2412

except (IOError, OSError) as e:

2413

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

2414

.format(e))

3410

2415

if not debug:

3411

2416

try:

3412

2417

os.remove(tempname)

3413

2418

except NameError:

3414

2419

pass

3415

if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):

3416

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

3417

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

3418

else:

3419

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

3420

exc_info=e)

3421

raise

3422

2420

if e.errno not in set((errno.ENOENT, errno.EACCES,

2421

errno.EEXIST)):

2422

raise e

2423

3423

2424

# Delete all clients, and settings from config

3424

2425

while tcp_server.clients:

3425

2426

name, client = tcp_server.clients.popitem()

3426

2427

if use_dbus:

3427

2428

client.remove_from_connection()

3428

# Don't signal the disabling

2429

# Don't signal anything except ClientRemoved

3429

2430

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

3431

2431

if use_dbus:

3432

mandos_dbus_service.client_removed_signal(client)

2432

# Emit D-Bus signal

2433

mandos_dbus_service.ClientRemoved(client

2434

.dbus_object_path,

2435

client.name)

3433

2436

client_settings.clear()

3434

2437

3435

2438

atexit.register(cleanup)

3436

3437

for client in tcp_server.clients.values():

2439

2440

for client in tcp_server.clients.itervalues():

3438

2441

if use_dbus:

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2442

# Emit D-Bus signal

2443

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3441

2444

# Need to initiate checking of clients

3442

2445

if client.enabled:

3443

2446

client.init_checker()

3444

2447

3445

2448

tcp_server.enable()

3446

2449

tcp_server.server_activate()

3447

2450

3448

2451

# Find out what port we got

3449

if zeroconf:

3450

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

2452

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

3451

2453

if use_ipv6:

3452

2454

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

3453

" flowinfo %d, scope_id %d",

3454

*tcp_server.socket.getsockname())

2455

" flowinfo %d, scope_id %d"

2456

% tcp_server.socket.getsockname())

3455

2457

else: # IPv4

3456

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

3457

*tcp_server.socket.getsockname())

3458

3459

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

3460

2458

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

2459

% tcp_server.socket.getsockname())

2460

2461

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

2462

3461

2463

try:

3462

if zeroconf:

3463

# From the Avahi example code

3464

try:

3465

service.activate()

3466

except dbus.exceptions.DBusException as error:

3467

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

3468

cleanup()

3469

sys.exit(1)

3470

# End of Avahi example code

3471

3472

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

3473

lambda *args, **kwargs:

3474

(tcp_server.handle_request

3475

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

3476

2464

# From the Avahi example code

2465

try:

2466

service.activate()

2467

except dbus.exceptions.DBusException as error:

2468

logger.critical("DBusException: %s", error)

2469

cleanup()

2470

sys.exit(1)

2471

# End of Avahi example code

2472

2473

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

2474

lambda *args, **kwargs:

2475

(tcp_server.handle_request

2476

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

2477

3477

2478

logger.debug("Starting main loop")

3478

2479

main_loop.run()

3479

2480

except AvahiError as error:

3480

logger.critical("Avahi Error", exc_info=error)

2481

logger.critical("AvahiError: %s", error)

3481

2482

cleanup()

3482

2483

sys.exit(1)

3483

2484

except KeyboardInterrupt:

3488

2489

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

3489

2490

cleanup()

3490

2491

3491

3492

2492

if __name__ == '__main__':

3493

2493

main()