/mandos/release : revision 237.7.475

1

#!/usr/bin/python

2

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

3

#

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

import SocketServer as socketserver

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

38

47

import socket

39

48

import argparse

40

49

import datetime

41

50

import errno

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

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

49

55

import sys

50

56

import re

51

57

import os

60

66

import struct

61

67

import fcntl

62

68

import functools

63

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

64

73

import multiprocessing

65

74

import types

66

75

import binascii

67

76

import tempfile

68

77

import itertools

78

import collections

79

import codecs

69

80

70

81

import dbus

71

82

import dbus.service

72

import gobject

73

import avahi

83

from gi.repository import GLib

74

84

from dbus.mainloop.glib import DBusGMainLoop

75

85

import ctypes

76

86

import ctypes.util

77

87

import xml.dom.minidom

78

88

import inspect

79

import GnuPGInterface

80

89

90

# Try to find the value of SO_BINDTODEVICE:

81

91

try:

92

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

93

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

82

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

83

95

except AttributeError:

84

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

85

99

from IN import SO_BINDTODEVICE

86

100

except ImportError:

87

SO_BINDTODEVICE = None

88

89

version = "1.5.3"

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

90

119

stored_state_file = "clients.pickle"

91

120

92

121

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

122

syslogger = None

96

123

97

124

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

101

127

except (OSError, AttributeError):

128

102

129

def if_nametoindex(interface):

103

130

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

104

131

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

105

132

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

106

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

134

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

135

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

111

136

return interface_index

112

137

113

138

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

114

155

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

115

156

"""init logger and add loglevel"""

116

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

117

162

syslogger.setFormatter(logging.Formatter

118

163

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

119

164

' %(message)s'))

120

165

logger.addHandler(syslogger)

121

166

122

167

if debug:

123

168

console = logging.StreamHandler()

124

169

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

136

181

137

182

class PGPEngine(object):

138

183

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

184

139

185

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

186

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

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

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

149

206

def __enter__(self):

150

207

return self

151

152

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

208

209

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

153

210

self._cleanup()

154

211

return False

155

212

156

213

def __del__(self):

157

214

self._cleanup()

158

215

159

216

def _cleanup(self):

160

217

if self.tempdir is not None:

161

218

# Delete contents of tempdir

162

219

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

163

topdown = False):

220

topdown=False):

164

221

for filename in files:

165

222

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

166

223

for dirname in dirs:

168

225

# Remove tempdir

169

226

os.rmdir(self.tempdir)

170

227

self.tempdir = None

171

228

172

229

def password_encode(self, password):

173

230

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

174

231

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

175

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

176

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

177

240

def encrypt(self, data, password):

178

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

179

with open(os.devnull, "w") as devnull:

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

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)

192

256

return ciphertext

193

257

194

258

def decrypt(self, data, password):

195

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

196

with open(os.devnull, "w") as devnull:

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

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)

209

274

return decrypted_plaintext

210

275

211

276

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

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

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

212

304

class AvahiError(Exception):

213

305

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

214

306

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

307

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

308

**kwargs)

309

218

310

219

311

class AvahiServiceError(AvahiError):

220

312

pass

221

313

314

222

315

class AvahiGroupError(AvahiError):

223

316

pass

224

317

225

318

226

319

class AvahiService(object):

227

320

"""An Avahi (Zeroconf) service.

228

321

229

322

Attributes:

230

323

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

231

324

Used to optionally bind to the specified interface.

232

325

name: string; Example: 'Mandos'

233

326

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

234

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

327

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

235

328

port: integer; what port to announce

236

329

TXT: list of strings; TXT record for the service

237

330

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

243

336

server: D-Bus Server

244

337

bus: dbus.SystemBus()

245

338

"""

246

247

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

248

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

249

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

250

protocol = avahi.PROTO_UNSPEC, bus = None):

339

340

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

251

351

self.interface = interface

252

352

self.name = name

253

353

self.type = servicetype

262

362

self.server = None

263

363

self.bus = bus

264

364

self.entry_group_state_changed_match = None

265

266

def rename(self):

365

366

def rename(self, remove=True):

267

367

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

268

368

if self.rename_count >= self.max_renames:

269

369

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

270

370

" after %i retries, exiting.",

271

371

self.rename_count)

272

372

raise AvahiServiceError("Too many renames")

273

self.name = unicode(self.server

274

.GetAlternativeServiceName(self.name))

373

self.name = str(

374

self.server.GetAlternativeServiceName(self.name))

375

self.rename_count += 1

275

376

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

276

377

self.name)

277

self.remove()

378

if remove:

379

self.remove()

278

380

try:

279

381

self.add()

280

382

except dbus.exceptions.DBusException as error:

281

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

282

self.cleanup()

283

os._exit(1)

284

self.rename_count += 1

285

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

286

392

def remove(self):

287

393

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

288

394

if self.entry_group_state_changed_match is not None:

290

396

self.entry_group_state_changed_match = None

291

397

if self.group is not None:

292

398

self.group.Reset()

293

399

294

400

def add(self):

295

401

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

296

402

self.remove()

313

419

dbus.UInt16(self.port),

314

420

avahi.string_array_to_txt_array(self.TXT))

315

421

self.group.Commit()

316

422

317

423

def entry_group_state_changed(self, state, error):

318

424

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

319

425

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

320

426

321

427

if state == avahi.ENTRY_GROUP_ESTABLISHED:

322

428

logger.debug("Zeroconf service established.")

323

429

elif state == avahi.ENTRY_GROUP_COLLISION:

325

431

self.rename()

326

432

elif state == avahi.ENTRY_GROUP_FAILURE:

327

433

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

328

unicode(error))

329

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

330

.format(error))

331

434

str(error))

435

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

436

332

437

def cleanup(self):

333

438

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

334

439

if self.group is not None:

339

444

pass

340

445

self.group = None

341

446

self.remove()

342

447

343

448

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

344

449

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

345

450

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

346

bad_states = { avahi.SERVER_INVALID:

347

"Zeroconf server invalid",

348

avahi.SERVER_REGISTERING: None,

349

avahi.SERVER_COLLISION:

350

"Zeroconf server name collision",

351

avahi.SERVER_FAILURE:

352

"Zeroconf server failure" }

451

bad_states = {

452

avahi.SERVER_INVALID: "Zeroconf server invalid",

453

avahi.SERVER_REGISTERING: None,

454

avahi.SERVER_COLLISION: "Zeroconf server name collision",

455

avahi.SERVER_FAILURE: "Zeroconf server failure",

456

}

353

457

if state in bad_states:

354

458

if bad_states[state] is not None:

355

459

if error is None:

358

462

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

359

463

self.cleanup()

360

464

elif state == avahi.SERVER_RUNNING:

361

self.add()

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

362

477

else:

363

478

if error is None:

364

479

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

365

480

else:

366

481

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

367

482

368

483

def activate(self):

369

484

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

370

485

if self.server is None:

374

489

follow_name_owner_changes=True),

375

490

avahi.DBUS_INTERFACE_SERVER)

376

491

self.server.connect_to_signal("StateChanged",

377

self.server_state_changed)

492

self.server_state_changed)

378

493

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

379

494

495

380

496

class AvahiServiceToSyslog(AvahiService):

381

def rename(self):

497

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

382

498

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

383

ret = AvahiService.rename(self)

384

syslogger.setFormatter(logging.Formatter

385

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

386

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

387

.format(self.name)))

499

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

500

syslogger.setFormatter(logging.Formatter(

501

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

502

.format(self.name)))

388

503

return ret

389

504

390

def timedelta_to_milliseconds(td):

391

"Convert a datetime.timedelta() to milliseconds"

392

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

393

+ (td.seconds * 1000)

394

+ (td.microseconds // 1000))

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

395

779

396

780

class Client(object):

397

781

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

398

782

399

783

Attributes:

400

784

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

401

785

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

403

787

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

404

788

to see if the client lives.

405

789

'None' if no process is running.

406

checker_callback_tag: a gobject event source tag, or None

790

checker_callback_tag: a GLib event source tag, or None

407

791

checker_command: string; External command which is run to check

408

792

if client lives. %() expansions are done at

409

793

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

410

794

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

411

checker_initiator_tag: a gobject event source tag, or None

795

checker_initiator_tag: a GLib event source tag, or None

412

796

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

413

797

client_structure: Object describing what attributes a client has

414

798

and is used for storing the client at exit

415

799

current_checker_command: string; current running checker_command

416

disable_initiator_tag: a gobject event source tag, or None

800

disable_initiator_tag: a GLib event source tag, or None

417

801

enabled: bool()

418

802

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

419

803

uniquely identify the client

424

808

last_checker_status: integer between 0 and 255 reflecting exit

425

809

status of last checker. -1 reflects crashed

426

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

427

813

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

428

814

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

429

815

D-Bus identifiers

434

820

runtime_expansions: Allowed attributes for runtime expansion.

435

821

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

436

822

disabled, or None

823

server_settings: The server_settings dict from main()

437

824

"""

438

825

439

826

runtime_expansions = ("approval_delay", "approval_duration",

440

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

441

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

827

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

828

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

829

"last_approval_request", "last_checked_ok",

442

830

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

443

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

444

"extended_timeout": "15m",

445

"interval": "2m",

446

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

447

"host": "",

448

"approval_delay": "0s",

449

"approval_duration": "1s",

450

"approved_by_default": "True",

451

"enabled": "True",

452

}

453

454

def timeout_milliseconds(self):

455

"Return the 'timeout' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.timeout)

457

458

def extended_timeout_milliseconds(self):

459

"Return the 'extended_timeout' attribute in milliseconds"

460

return timedelta_to_milliseconds(self.extended_timeout)

461

462

def interval_milliseconds(self):

463

"Return the 'interval' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.interval)

465

466

def approval_delay_milliseconds(self):

467

return timedelta_to_milliseconds(self.approval_delay)

468

831

client_defaults = {

832

"timeout": "PT5M",

833

"extended_timeout": "PT15M",

834

"interval": "PT2M",

835

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

836

"host": "",

837

"approval_delay": "PT0S",

838

"approval_duration": "PT1S",

839

"approved_by_default": "True",

840

"enabled": "True",

841

}

842

469

843

@staticmethod

470

844

def config_parser(config):

471

845

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

478

852

for client_name in config.sections():

479

853

section = dict(config.items(client_name))

480

854

client = settings[client_name] = {}

481

855

482

856

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

483

857

# Reformat values from string types to Python types

484

858

client["approved_by_default"] = config.getboolean(

485

859

client_name, "approved_by_default")

486

860

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

487

861

"enabled")

488

862

863

# Uppercase and remove spaces from fingerprint for later

864

# comparison purposes with return value from the

865

# fingerprint() function

489

866

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

490

867

.replace(" ", ""))

491

868

if "secret" in section:

492

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

869

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

870

.encode("utf-8"),

871

"base64")

493

872

elif "secfile" in section:

494

873

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

495

874

(section["secfile"])),

496

875

"rb") as secfile:

497

876

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

498

877

else:

499

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

878

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

500

879

.format(section))

501

880

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

502

881

client["extended_timeout"] = string_to_delta(

510

889

client["last_approval_request"] = None

511

890

client["last_checked_ok"] = None

512

891

client["last_checker_status"] = -2

513

892

514

893

return settings

515

516

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

894

895

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

517

896

self.name = name

897

if server_settings is None:

898

server_settings = {}

899

self.server_settings = server_settings

518

900

# adding all client settings

519

for setting, value in settings.iteritems():

901

for setting, value in settings.items():

520

902

setattr(self, setting, value)

521

903

522

904

if self.enabled:

523

905

if not hasattr(self, "last_enabled"):

524

906

self.last_enabled = datetime.datetime.utcnow()

528

910

else:

529

911

self.last_enabled = None

530

912

self.expires = None

531

913

532

914

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

533

# Uppercase and remove spaces from fingerprint for later

534

# comparison purposes with return value from the fingerprint()

535

# function

536

915

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

537

916

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

538

917

datetime.datetime.utcnow())

539

918

540

919

# attributes specific for this server instance

541

920

self.checker = None

542

921

self.checker_initiator_tag = None

545

924

self.current_checker_command = None

546

925

self.approved = None

547

926

self.approvals_pending = 0

548

self.changedstate = (multiprocessing_manager

549

.Condition(multiprocessing_manager

550

.Lock()))

551

self.client_structure = [attr for attr in

552

self.__dict__.iterkeys()

927

self.changedstate = multiprocessing_manager.Condition(

928

multiprocessing_manager.Lock())

929

self.client_structure = [attr

930

for attr in self.__dict__.keys()

553

931

if not attr.startswith("_")]

554

932

self.client_structure.append("client_structure")

555

556

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

557

lambda obj:

558

isinstance(obj,

559

property)):

933

934

for name, t in inspect.getmembers(

935

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

560

936

if not name.startswith("_"):

561

937

self.client_structure.append(name)

562

938

563

939

# Send notice to process children that client state has changed

564

940

def send_changedstate(self):

565

941

with self.changedstate:

566

942

self.changedstate.notify_all()

567

943

568

944

def enable(self):

569

945

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

570

946

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

571

947

# Already enabled

572

948

return

573

self.send_changedstate()

574

949

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

575

950

self.enabled = True

576

951

self.last_enabled = datetime.datetime.utcnow()

577

952

self.init_checker()

578

953

self.send_changedstate()

954

579

955

def disable(self, quiet=True):

580

956

"""Disable this client."""

581

957

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

582

958

return False

583

959

if not quiet:

584

self.send_changedstate()

585

if not quiet:

586

960

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

587

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

588

gobject.source_remove(self.disable_initiator_tag)

961

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

962

GLib.source_remove(self.disable_initiator_tag)

589

963

self.disable_initiator_tag = None

590

964

self.expires = None

591

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

592

gobject.source_remove(self.checker_initiator_tag)

965

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

966

GLib.source_remove(self.checker_initiator_tag)

593

967

self.checker_initiator_tag = None

594

968

self.stop_checker()

595

969

self.enabled = False

596

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

970

if not quiet:

971

self.send_changedstate()

972

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

597

973

return False

598

974

599

975

def __del__(self):

600

976

self.disable()

601

977

602

978

def init_checker(self):

603

979

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

604

980

# and every interval from then on.

605

self.checker_initiator_tag = (gobject.timeout_add

606

(self.interval_milliseconds(),

607

self.start_checker))

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)

608

986

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

609

self.disable_initiator_tag = (gobject.timeout_add

610

(self.timeout_milliseconds(),

611

self.disable))

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)

612

991

# Also start a new checker *right now*.

613

992

self.start_checker()

614

615

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

993

994

def checker_callback(self, source, condition, connection,

995

command):

616

996

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

617

997

self.checker_callback_tag = None

618

998

self.checker = None

619

if os.WIFEXITED(condition):

620

self.last_checker_status = os.WEXITSTATUS(condition)

999

# Read return code from connection (see call_pipe)

1000

returncode = connection.recv()

1001

connection.close()

1002

1003

if returncode >= 0:

1004

self.last_checker_status = returncode

1005

self.last_checker_signal = None

621

1006

if self.last_checker_status == 0:

622

1007

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

623

1008

vars(self))

624

1009

self.checked_ok()

625

1010

else:

626

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

627

vars(self))

1011

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

628

1012

else:

629

1013

self.last_checker_status = -1

1014

self.last_checker_signal = -returncode

630

1015

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

631

1016

vars(self))

632

1017

return False

1018

633

1019

def checked_ok(self):

634

1020

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

635

1021

self.last_checked_ok = datetime.datetime.utcnow()

636

1022

self.last_checker_status = 0

1023

self.last_checker_signal = None

637

1024

self.bump_timeout()

638

1025

639

1026

def bump_timeout(self, timeout=None):

640

1027

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

641

1028

if timeout is None:

642

1029

timeout = self.timeout

643

1030

if self.disable_initiator_tag is not None:

644

gobject.source_remove(self.disable_initiator_tag)

1031

GLib.source_remove(self.disable_initiator_tag)

1032

self.disable_initiator_tag = None

645

1033

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

646

self.disable_initiator_tag = (gobject.timeout_add

647

(timedelta_to_milliseconds

648

(timeout), self.disable))

1034

self.disable_initiator_tag = GLib.timeout_add(

1035

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

649

1036

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

650

1037

651

1038

def need_approval(self):

652

1039

self.last_approval_request = datetime.datetime.utcnow()

653

1040

654

1041

def start_checker(self):

655

1042

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

656

1043

657

1044

If a checker already exists, leave it running and do

658

1045

nothing."""

659

1046

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

660

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

661

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

662

# client would inevitably timeout, since no checker would get

663

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

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

664

1051

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

665

1052

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

666

1053

# should be.

667

668

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

669

try:

670

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

671

except (AttributeError, OSError) as error:

672

if (isinstance(error, OSError)

673

and error.errno != errno.ECHILD):

674

raise error

675

else:

676

if pid:

677

logger.warning("Checker was a zombie")

678

gobject.source_remove(self.checker_callback_tag)

679

self.checker_callback(pid, status,

680

self.current_checker_command)

1054

1055

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

1056

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

1057

self.checker.join()

1058

self.checker = None

681

1059

# Start a new checker if needed

682

1060

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}

683

1065

try:

684

# In case checker_command has exactly one % operator

685

command = self.checker_command % self.host

686

except TypeError:

687

# Escape attributes for the shell

688

escaped_attrs = dict(

689

(attr,

690

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

691

errors=

692

'replace')))

693

for attr in

694

self.runtime_expansions)

695

696

try:

697

command = self.checker_command % escaped_attrs

698

except TypeError as error:

699

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

700

self.checker_command, exc_info=error)

701

return True # Try again later

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

702

1072

self.current_checker_command = command

703

try:

704

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

705

command, self.name)

706

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

707

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

708

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

709

# always replaced by /dev/null.)

710

self.checker = subprocess.Popen(command,

711

close_fds=True,

712

shell=True, cwd="/")

713

self.checker_callback_tag = (gobject.child_watch_add

714

(self.checker.pid,

715

self.checker_callback,

716

data=command))

717

# The checker may have completed before the gobject

718

# watch was added. Check for this.

719

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

720

if pid:

721

gobject.source_remove(self.checker_callback_tag)

722

self.checker_callback(pid, status, command)

723

except OSError as error:

724

logger.error("Failed to start subprocess",

725

exc_info=error)

726

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

1073

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

1074

self.name)

1075

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

1076

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

1077

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

1078

# always replaced by /dev/null.)

1079

# The exception is when not debugging but nevertheless

1080

# running in the foreground; use the previously

1081

# created wnull.

1082

popen_args = {"close_fds": True,

1083

"shell": True,

1084

"cwd": "/"}

1085

if (not self.server_settings["debug"]

1086

and self.server_settings["foreground"]):

1087

popen_args.update({"stdout": wnull,

1088

"stderr": wnull})

1089

pipe = multiprocessing.Pipe(duplex=False)

1090

self.checker = multiprocessing.Process(

1091

target=call_pipe,

1092

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

1093

kwargs=popen_args)

1094

self.checker.start()

1095

self.checker_callback_tag = GLib.io_add_watch(

1096

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

1097

self.checker_callback, pipe[0], command)

1098

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

727

1099

return True

728

1100

729

1101

def stop_checker(self):

730

1102

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

731

1103

if self.checker_callback_tag:

732

gobject.source_remove(self.checker_callback_tag)

1104

GLib.source_remove(self.checker_callback_tag)

733

1105

self.checker_callback_tag = None

734

1106

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

735

1107

return

736

1108

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

737

try:

738

self.checker.terminate()

739

#time.sleep(0.5)

740

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

741

# self.checker.kill()

742

except OSError as error:

743

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

744

raise

1109

self.checker.terminate()

745

1110

self.checker = None

746

1111

747

1112

748

def dbus_service_property(dbus_interface, signature="v",

749

access="readwrite", byte_arrays=False):

1113

def dbus_service_property(dbus_interface,

1114

signature="v",

1115

access="readwrite",

1116

byte_arrays=False):

750

1117

"""Decorators for marking methods of a DBusObjectWithProperties to

751

1118

become properties on the D-Bus.

752

1119

753

1120

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

754

1121

and with one argument by "Set".

755

1122

756

1123

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

757

1124

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

758

1125

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

761

1128

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

762

1129

if byte_arrays and signature != "ay":

763

1130

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

764

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

1131

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

1132

765

1133

def decorator(func):

766

1134

func._dbus_is_property = True

767

1135

func._dbus_interface = dbus_interface

770

1138

func._dbus_name = func.__name__

771

1139

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

772

1140

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

773

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1141

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

774

1142

return func

1143

775

1144

return decorator

776

1145

777

1146

778

1147

def dbus_interface_annotations(dbus_interface):

779

1148

"""Decorator for marking functions returning interface annotations

780

1149

781

1150

Usage:

782

1151

783

1152

@dbus_interface_annotations("org.example.Interface")

784

1153

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

785

1154

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

786

1155

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

787

1156

"false"}

788

1157

"""

1158

789

1159

def decorator(func):

790

1160

func._dbus_is_interface = True

791

1161

func._dbus_interface = dbus_interface

792

1162

func._dbus_name = dbus_interface

793

1163

return func

1164

794

1165

return decorator

795

1166

796

1167

797

1168

def dbus_annotations(annotations):

798

1169

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

799

1170

Usage:

800

1171

1172

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

1173

"org.freedesktop.DBus.Property."

1174

"EmitsChangedSignal": "false"})

801

1175

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

802

1176

access="r")

803

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

804

"org.freedesktop.DBus.Property."

805

"EmitsChangedSignal": "false"})

806

1177

def Property_dbus_property(self):

807

1178

return dbus.Boolean(False)

1179

1180

See also the DBusObjectWithAnnotations class.

808

1181

"""

1182

809

1183

def decorator(func):

810

1184

func._dbus_annotations = annotations

811

1185

return func

1186

812

1187

return decorator

813

1188

814

1189

815

1190

class DBusPropertyException(dbus.exceptions.DBusException):

816

1191

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

817

1192

"""

818

def __unicode__(self):

819

return unicode(str(self))

1193

pass

820

1194

821

1195

822

1196

class DBusPropertyAccessException(DBusPropertyException):

831

1205

pass

832

1206

833

1207

834

class DBusObjectWithProperties(dbus.service.Object):

835

"""A D-Bus object with properties.

836

837

Classes inheriting from this can use the dbus_service_property

838

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

839

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

1208

class DBusObjectWithAnnotations(dbus.service.Object):

1209

"""A D-Bus object with annotations.

1210

1211

Classes inheriting from this can use the dbus_annotations

1212

decorator to add annotations to methods or signals.

840

1213

"""

841

1214

842

1215

@staticmethod

843

1216

def _is_dbus_thing(thing):

844

1217

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

845

1218

846

1219

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

847

1220

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

848

1221

"""

849

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

1222

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

850

1223

False)

851

1224

852

1225

def _get_all_dbus_things(self, thing):

853

1226

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

854

1227

"""

855

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

856

name),

1228

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

857

1229

athing.__get__(self))

858

1230

for cls in self.__class__.__mro__

859

1231

for name, athing in

860

inspect.getmembers(cls,

861

self._is_dbus_thing(thing)))

862

1232

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

1233

1234

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1235

out_signature="s",

1236

path_keyword='object_path',

1237

connection_keyword='connection')

1238

def Introspect(self, object_path, connection):

1239

"""Overloading of standard D-Bus method.

1240

1241

Inserts annotation tags on methods and signals.

1242

"""

1243

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

1244

connection)

1245

try:

1246

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

1247

1248

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

1249

# Add annotation tags

1250

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

1251

for tag in if_tag.getElementsByTagName(typ):

1252

annots = dict()

1253

for name, prop in (self.

1254

_get_all_dbus_things(typ)):

1255

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

1256

and prop._dbus_interface

1257

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

1258

annots.update(getattr(

1259

prop, "_dbus_annotations", {}))

1260

for name, value in annots.items():

1261

ann_tag = document.createElement(

1262

"annotation")

1263

ann_tag.setAttribute("name", name)

1264

ann_tag.setAttribute("value", value)

1265

tag.appendChild(ann_tag)

1266

# Add interface annotation tags

1267

for annotation, value in dict(

1268

itertools.chain.from_iterable(

1269

annotations().items()

1270

for name, annotations

1271

in self._get_all_dbus_things("interface")

1272

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

1273

)).items():

1274

ann_tag = document.createElement("annotation")

1275

ann_tag.setAttribute("name", annotation)

1276

ann_tag.setAttribute("value", value)

1277

if_tag.appendChild(ann_tag)

1278

# Fix argument name for the Introspect method itself

1279

if (if_tag.getAttribute("name")

1280

== dbus.INTROSPECTABLE_IFACE):

1281

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

1282

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

1283

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

1284

if (arg.getAttribute("direction")

1285

== "out"):

1286

arg.setAttribute("name",

1287

"xml_data")

1288

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

1289

document.unlink()

1290

except (AttributeError, xml.dom.DOMException,

1291

xml.parsers.expat.ExpatError) as error:

1292

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

1293

exc_info=error)

1294

return xmlstring

1295

1296

1297

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1298

"""A D-Bus object with properties.

1299

1300

Classes inheriting from this can use the dbus_service_property

1301

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

1302

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

1303

"""

1304

863

1305

def _get_dbus_property(self, interface_name, property_name):

864

1306

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

865

1307

property with the specified name and interface.

866

1308

"""

867

for cls in self.__class__.__mro__:

868

for name, value in (inspect.getmembers

869

(cls,

870

self._is_dbus_thing("property"))):

1309

for cls in self.__class__.__mro__:

1310

for name, value in inspect.getmembers(

1311

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

871

1312

if (value._dbus_name == property_name

872

1313

and value._dbus_interface == interface_name):

873

1314

return value.__get__(self)

874

1315

875

1316

# No such property

876

raise DBusPropertyNotFound(self.dbus_object_path + ":"

877

+ interface_name + "."

878

+ property_name)

879

880

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

1317

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

1318

self.dbus_object_path, interface_name, property_name))

1319

1320

@classmethod

1321

def _get_all_interface_names(cls):

1322

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

1323

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

1324

"_dbus_interface", None)

1325

for x in (inspect.getmro(cls))

1326

for attr in dir(x))

1327

if name is not None)

1328

1329

@dbus.service.method(dbus.PROPERTIES_IFACE,

1330

in_signature="ss",

881

1331

out_signature="v")

882

1332

def Get(self, interface_name, property_name):

883

1333

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

889

1339

if not hasattr(value, "variant_level"):

890

1340

return value

891

1341

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

892

1342

893

1343

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

894

1344

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

895

1345

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

901

1351

# The byte_arrays option is not supported yet on

902

1352

# signatures other than "ay".

903

1353

if prop._dbus_signature != "ay":

904

raise ValueError

1354

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

1355

"'ay' signature {!r}"

1356

.format(prop._dbus_signature))

905

1357

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

906

1358

for byte in value))

907

1359

prop(value)

908

909

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

1360

1361

@dbus.service.method(dbus.PROPERTIES_IFACE,

1362

in_signature="s",

910

1363

out_signature="a{sv}")

911

1364

def GetAll(self, interface_name):

912

1365

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

913

1366

standard.

914

1367

915

1368

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

916

1369

"""

917

1370

properties = {}

927

1380

if not hasattr(value, "variant_level"):

928

1381

properties[name] = value

929

1382

continue

930

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

931

value.variant_level+1)

1383

properties[name] = type(value)(

1384

value, variant_level=value.variant_level + 1)

932

1385

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

933

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

934

1395

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

935

1396

out_signature="s",

936

1397

path_keyword='object_path',

937

1398

connection_keyword='connection')

938

1399

def Introspect(self, object_path, connection):

939

1400

"""Overloading of standard D-Bus method.

940

1401

941

1402

Inserts property tags and interface annotation tags.

942

1403

"""

943

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

944

connection)

1404

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1405

object_path,

1406

connection)

945

1407

try:

946

1408

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

1409

947

1410

def make_tag(document, name, prop):

948

1411

e = document.createElement("property")

949

1412

e.setAttribute("name", name)

950

1413

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

951

1414

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

952

1415

return e

1416

953

1417

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

954

1418

# Add property tags

955

1419

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

958

1422

if prop._dbus_interface

959

1423

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

960

1424

if_tag.appendChild(tag)

961

# Add annotation tags

962

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

963

for tag in if_tag.getElementsByTagName(typ):

964

annots = dict()

965

for name, prop in (self.

966

_get_all_dbus_things(typ)):

967

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

968

and prop._dbus_interface

969

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

970

annots.update(getattr

971

(prop,

972

"_dbus_annotations",

973

{}))

974

for name, value in annots.iteritems():

975

ann_tag = document.createElement(

976

"annotation")

977

ann_tag.setAttribute("name", name)

978

ann_tag.setAttribute("value", value)

979

tag.appendChild(ann_tag)

980

# Add interface annotation tags

981

for annotation, value in dict(

982

itertools.chain.from_iterable(

983

annotations().iteritems()

984

for name, annotations in

985

self._get_all_dbus_things("interface")

986

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

987

)).iteritems():

988

ann_tag = document.createElement("annotation")

989

ann_tag.setAttribute("name", annotation)

990

ann_tag.setAttribute("value", value)

991

if_tag.appendChild(ann_tag)

1425

# Add annotation tags for properties

1426

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

1427

annots = dict()

1428

for name, prop in self._get_all_dbus_things(

1429

"property"):

1430

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

1431

and prop._dbus_interface

1432

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

1433

annots.update(getattr(

1434

prop, "_dbus_annotations", {}))

1435

for name, value in annots.items():

1436

ann_tag = document.createElement(

1437

"annotation")

1438

ann_tag.setAttribute("name", name)

1439

ann_tag.setAttribute("value", value)

1440

tag.appendChild(ann_tag)

992

1441

# Add the names to the return values for the

993

1442

# "org.freedesktop.DBus.Properties" methods

994

1443

if (if_tag.getAttribute("name")

1013

1462

return xmlstring

1014

1463

1015

1464

1016

def datetime_to_dbus (dt, variant_level=0):

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

1017

1537

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

1018

1538

if dt is None:

1019

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

1020

return dbus.String(dt.isoformat(),

1021

variant_level=variant_level)

1539

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

1540

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

1022

1541

1023

1542

1024

1543

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1026

1545

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

1027

1546

interface names according to the "alt_interface_names" mapping.

1028

1547

Usage:

1029

1030

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

1031

"net.example.AlternateInterface"})

1548

1549

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

1550

"net.example.AlternateInterface"})

1032

1551

class SampleDBusObject(dbus.service.Object):

1033

1552

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

1034

1553

def SampleDBusMethod():

1035

1554

pass

1036

1555

1037

1556

The above "SampleDBusMethod" on "SampleDBusObject" will be

1038

1557

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

1039

1558

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

1040

1559

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

1041

1560

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

1042

1561

1043

1562

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

1044

1563

(from DBusObjectWithProperties) and interfaces (from the

1045

1564

dbus_interface_annotations decorator).

1046

1565

"""

1566

1047

1567

def wrapper(cls):

1048

1568

for orig_interface_name, alt_interface_name in (

1049

alt_interface_names.iteritems()):

1569

alt_interface_names.items()):

1050

1570

attr = {}

1051

1571

interface_names = set()

1052

1572

# Go though all attributes of the class

1054

1574

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

1055

1575

# with the wrong interface name

1056

1576

if (not hasattr(attribute, "_dbus_interface")

1057

or not attribute._dbus_interface

1058

.startswith(orig_interface_name)):

1577

or not attribute._dbus_interface.startswith(

1578

orig_interface_name)):

1059

1579

continue

1060

1580

# Create an alternate D-Bus interface name based on

1061

1581

# the current name

1062

alt_interface = (attribute._dbus_interface

1063

.replace(orig_interface_name,

1064

alt_interface_name))

1582

alt_interface = attribute._dbus_interface.replace(

1583

orig_interface_name, alt_interface_name)

1065

1584

interface_names.add(alt_interface)

1066

1585

# Is this a D-Bus signal?

1067

1586

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

1068

# Extract the original non-method function by

1069

# black magic

1070

nonmethod_func = (dict(

1587

# Extract the original non-method undecorated

1588

# function by black magic

1589

if sys.version_info.major == 2:

1590

nonmethod_func = (dict(

1071

1591

zip(attribute.func_code.co_freevars,

1072

attribute.__closure__))["func"]

1073

.cell_contents)

1592

attribute.__closure__))

1593

["func"].cell_contents)

1594

else:

1595

nonmethod_func = (dict(

1596

zip(attribute.__code__.co_freevars,

1597

attribute.__closure__))

1598

["func"].cell_contents)

1074

1599

# Create a new, but exactly alike, function

1075

1600

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

1076

1601

# with the alternate D-Bus interface name

1077

new_function = (dbus.service.signal

1078

(alt_interface,

1079

attribute._dbus_signature)

1080

(types.FunctionType(

1081

nonmethod_func.func_code,

1082

nonmethod_func.func_globals,

1083

nonmethod_func.func_name,

1084

nonmethod_func.func_defaults,

1085

nonmethod_func.func_closure)))

1602

new_function = copy_function(nonmethod_func)

1603

new_function = (dbus.service.signal(

1604

alt_interface,

1605

attribute._dbus_signature)(new_function))

1086

1606

# Copy annotations, if any

1087

1607

try:

1088

new_function._dbus_annotations = (

1089

dict(attribute._dbus_annotations))

1608

new_function._dbus_annotations = dict(

1609

attribute._dbus_annotations)

1090

1610

except AttributeError:

1091

1611

pass

1612

1092

1613

# Define a creator of a function to call both the

1093

1614

# original and alternate functions, so both the

1094

1615

# original and alternate signals gets sent when

1097

1618

"""This function is a scope container to pass

1098

1619

func1 and func2 to the "call_both" function

1099

1620

outside of its arguments"""

1621

1622

@functools.wraps(func2)

1100

1623

def call_both(*args, **kwargs):

1101

1624

"""This function will emit two D-Bus

1102

1625

signals by calling func1 and func2"""

1103

1626

func1(*args, **kwargs)

1104

1627

func2(*args, **kwargs)

1628

# Make wrapper function look like a D-Bus

1629

# signal

1630

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

1631

if name.startswith("_dbus_"):

1632

setattr(call_both, name, attr)

1633

1105

1634

return call_both

1106

1635

# Create the "call_both" function and add it to

1107

1636

# the class

1112

1641

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

1113

1642

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

1114

1643

# to the class.

1115

attr[attrname] = (dbus.service.method

1116

(alt_interface,

1117

attribute._dbus_in_signature,

1118

attribute._dbus_out_signature)

1119

(types.FunctionType

1120

(attribute.func_code,

1121

attribute.func_globals,

1122

attribute.func_name,

1123

attribute.func_defaults,

1124

attribute.func_closure)))

1644

attr[attrname] = (

1645

dbus.service.method(

1646

alt_interface,

1647

attribute._dbus_in_signature,

1648

attribute._dbus_out_signature)

1649

(copy_function(attribute)))

1125

1650

# Copy annotations, if any

1126

1651

try:

1127

attr[attrname]._dbus_annotations = (

1128

dict(attribute._dbus_annotations))

1652

attr[attrname]._dbus_annotations = dict(

1653

attribute._dbus_annotations)

1129

1654

except AttributeError:

1130

1655

pass

1131

1656

# Is this a D-Bus property?

1134

1659

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

1135

1660

# property with the alternate D-Bus interface

1136

1661

# name. Add it to the class.

1137

attr[attrname] = (dbus_service_property

1138

(alt_interface,

1139

attribute._dbus_signature,

1140

attribute._dbus_access,

1141

attribute

1142

._dbus_get_args_options

1143

["byte_arrays"])

1144

(types.FunctionType

1145

(attribute.func_code,

1146

attribute.func_globals,

1147

attribute.func_name,

1148

attribute.func_defaults,

1149

attribute.func_closure)))

1662

attr[attrname] = (dbus_service_property(

1663

alt_interface, attribute._dbus_signature,

1664

attribute._dbus_access,

1665

attribute._dbus_get_args_options

1666

["byte_arrays"])

1667

(copy_function(attribute)))

1150

1668

# Copy annotations, if any

1151

1669

try:

1152

attr[attrname]._dbus_annotations = (

1153

dict(attribute._dbus_annotations))

1670

attr[attrname]._dbus_annotations = dict(

1671

attribute._dbus_annotations)

1154

1672

except AttributeError:

1155

1673

pass

1156

1674

# Is this a D-Bus interface?

1159

1677

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

1160

1678

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

1161

1679

# to the class.

1162

attr[attrname] = (dbus_interface_annotations

1163

(alt_interface)

1164

(types.FunctionType

1165

(attribute.func_code,

1166

attribute.func_globals,

1167

attribute.func_name,

1168

attribute.func_defaults,

1169

attribute.func_closure)))

1680

attr[attrname] = (

1681

dbus_interface_annotations(alt_interface)

1682

(copy_function(attribute)))

1170

1683

if deprecate:

1171

1684

# Deprecate all alternate interfaces

1172

iname="_AlternateDBusNames_interface_annotation{0}"

1685

iname = "_AlternateDBusNames_interface_annotation{}"

1173

1686

for interface_name in interface_names:

1687

1174

1688

@dbus_interface_annotations(interface_name)

1175

1689

def func(self):

1176

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

1177

"true" }

1690

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

1691

"true"}

1178

1692

# Find an unused name

1179

1693

for aname in (iname.format(i)

1180

1694

for i in itertools.count()):

1184

1698

if interface_names:

1185

1699

# Replace the class with a new subclass of it with

1186

1700

# methods, signals, etc. as created above.

1187

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

1188

(cls,), attr)

1701

if sys.version_info.major == 2:

1702

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

1703

(cls, ), attr)

1704

else:

1705

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

1706

(cls, ), attr)

1189

1707

return cls

1708

1190

1709

return wrapper

1191

1710

1192

1711

1193

1712

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

1194

"se.bsnet.fukt.Mandos"})

1713

"se.bsnet.fukt.Mandos"})

1195

1714

class ClientDBus(Client, DBusObjectWithProperties):

1196

1715

"""A Client class using D-Bus

1197

1716

1198

1717

Attributes:

1199

1718

dbus_object_path: dbus.ObjectPath

1200

1719

bus: dbus.SystemBus()

1201

1720

"""

1202

1721

1203

1722

runtime_expansions = (Client.runtime_expansions

1204

+ ("dbus_object_path",))

1205

1723

+ ("dbus_object_path", ))

1724

1725

_interface = "se.recompile.Mandos.Client"

1726

1206

1727

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

1207

1208

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

1728

1729

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

1209

1730

self.bus = bus

1210

1731

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

1211

1732

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

1212

1733

# the D-Bus

1213

client_object_name = unicode(self.name).translate(

1734

client_object_name = str(self.name).translate(

1214

1735

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

1215

1736

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

1216

self.dbus_object_path = (dbus.ObjectPath

1217

("/clients/" + client_object_name))

1737

self.dbus_object_path = dbus.ObjectPath(

1738

"/clients/" + client_object_name)

1218

1739

DBusObjectWithProperties.__init__(self, self.bus,

1219

1740

self.dbus_object_path)

1220

1221

def notifychangeproperty(transform_func,

1222

dbus_name, type_func=lambda x: x,

1223

variant_level=1):

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

1224

1747

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

1225

1748

its changes to DBus.

1226

1749

1227

1750

transform_fun: Function that takes a value and a variant_level

1228

1751

and transforms it to a D-Bus type.

1229

1752

dbus_name: D-Bus name of the variable

1231

1754

to the D-Bus. Default: no transform

1232

1755

variant_level: D-Bus variant level. Default: 1

1233

1756

"""

1234

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

1757

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

1758

1235

1759

def setter(self, value):

1236

1760

if hasattr(self, "dbus_object_path"):

1237

1761

if (not hasattr(self, attrname) or

1238

1762

type_func(getattr(self, attrname, None))

1239

1763

!= type_func(value)):

1240

dbus_value = transform_func(type_func(value),

1241

variant_level

1242

=variant_level)

1243

self.PropertyChanged(dbus.String(dbus_name),

1244

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

1245

1779

setattr(self, attrname, value)

1246

1780

1247

1781

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

1248

1782

1249

1783

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1250

1784

approvals_pending = notifychangeproperty(dbus.Boolean,

1251

1785

"ApprovalPending",

1252

type_func = bool)

1786

type_func=bool)

1253

1787

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

1254

1788

last_enabled = notifychangeproperty(datetime_to_dbus,

1255

1789

"LastEnabled")

1256

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

1257

type_func = lambda checker:

1258

checker is not None)

1790

checker = notifychangeproperty(

1791

dbus.Boolean, "CheckerRunning",

1792

type_func=lambda checker: checker is not None)

1259

1793

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1260

1794

"LastCheckedOK")

1261

1795

last_checker_status = notifychangeproperty(dbus.Int16,

1264

1798

datetime_to_dbus, "LastApprovalRequest")

1265

1799

approved_by_default = notifychangeproperty(dbus.Boolean,

1266

1800

"ApprovedByDefault")

1267

approval_delay = notifychangeproperty(dbus.UInt64,

1268

"ApprovalDelay",

1269

type_func =

1270

timedelta_to_milliseconds)

1801

approval_delay = notifychangeproperty(

1802

dbus.UInt64, "ApprovalDelay",

1803

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

1271

1804

approval_duration = notifychangeproperty(

1272

1805

dbus.UInt64, "ApprovalDuration",

1273

type_func = timedelta_to_milliseconds)

1806

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

1274

1807

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

1275

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

1276

type_func =

1277

timedelta_to_milliseconds)

1808

timeout = notifychangeproperty(

1809

dbus.UInt64, "Timeout",

1810

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

1278

1811

extended_timeout = notifychangeproperty(

1279

1812

dbus.UInt64, "ExtendedTimeout",

1280

type_func = timedelta_to_milliseconds)

1281

interval = notifychangeproperty(dbus.UInt64,

1282

"Interval",

1283

type_func =

1284

timedelta_to_milliseconds)

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)

1285

1817

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

1286

1818

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

1819

invalidate_only=True)

1820

1287

1821

del notifychangeproperty

1288

1822

1289

1823

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

1290

1824

try:

1291

1825

self.remove_from_connection()

1294

1828

if hasattr(DBusObjectWithProperties, "__del__"):

1295

1829

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

1296

1830

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

1297

1298

def checker_callback(self, pid, condition, command,

1299

*args, **kwargs):

1300

self.checker_callback_tag = None

1301

self.checker = None

1302

if os.WIFEXITED(condition):

1303

exitstatus = os.WEXITSTATUS(condition)

1831

1832

def checker_callback(self, source, condition,

1833

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

1834

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

1835

connection, command, *args,

1836

**kwargs)

1837

exitstatus = self.last_checker_status

1838

if exitstatus >= 0:

1304

1839

# Emit D-Bus signal

1305

1840

self.CheckerCompleted(dbus.Int16(exitstatus),

1306

dbus.Int64(condition),

1841

# This is specific to GNU libC

1842

dbus.Int64(exitstatus << 8),

1307

1843

dbus.String(command))

1308

1844

else:

1309

1845

# Emit D-Bus signal

1310

1846

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

1311

dbus.Int64(condition),

1847

dbus.Int64(

1848

# This is specific to GNU libC

1849

(exitstatus << 8)

1850

| self.last_checker_signal),

1312

1851

dbus.String(command))

1313

1314

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

1315

*args, **kwargs)

1316

1852

return ret

1853

1317

1854

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

1318

old_checker = self.checker

1319

if self.checker is not None:

1320

old_checker_pid = self.checker.pid

1321

else:

1322

old_checker_pid = None

1855

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

1323

1856

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

1324

1857

# Only if new checker process was started

1325

1858

if (self.checker is not None

1327

1860

# Emit D-Bus signal

1328

1861

self.CheckerStarted(self.current_checker_command)

1329

1862

return r

1330

1863

1331

1864

def _reset_approved(self):

1332

1865

self.approved = None

1333

1866

return False

1334

1867

1335

1868

def approve(self, value=True):

1336

self.send_changedstate()

1337

1869

self.approved = value

1338

gobject.timeout_add(timedelta_to_milliseconds

1339

(self.approval_duration),

1340

self._reset_approved)

1341

1342

## D-Bus methods, signals & properties

1343

_interface = "se.recompile.Mandos.Client"

1344

1345

## Interfaces

1346

1347

@dbus_interface_annotations(_interface)

1348

def _foo(self):

1349

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

1350

"false"}

1351

1352

## Signals

1353

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

1354

1880

# CheckerCompleted - signal

1355

1881

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

1356

1882

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

1357

1883

"D-Bus signal"

1358

1884

pass

1359

1885

1360

1886

# CheckerStarted - signal

1361

1887

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

1362

1888

def CheckerStarted(self, command):

1363

1889

"D-Bus signal"

1364

1890

pass

1365

1891

1366

1892

# PropertyChanged - signal

1893

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

1367

1894

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

1368

1895

def PropertyChanged(self, property, value):

1369

1896

"D-Bus signal"

1370

1897

pass

1371

1898

1372

1899

# GotSecret - signal

1373

1900

@dbus.service.signal(_interface)

1374

1901

def GotSecret(self):

1377

1904

server to mandos-client

1378

1905

"""

1379

1906

pass

1380

1907

1381

1908

# Rejected - signal

1382

1909

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

1383

1910

def Rejected(self, reason):

1384

1911

"D-Bus signal"

1385

1912

pass

1386

1913

1387

1914

# NeedApproval - signal

1388

1915

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

1389

1916

def NeedApproval(self, timeout, default):

1390

1917

"D-Bus signal"

1391

1918

return self.need_approval()

1392

1393

## Methods

1394

1919

1920

# Methods

1921

1395

1922

# Approve - method

1396

1923

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

1397

1924

def Approve(self, value):

1398

1925

self.approve(value)

1399

1926

1400

1927

# CheckedOK - method

1401

1928

@dbus.service.method(_interface)

1402

1929

def CheckedOK(self):

1403

1930

self.checked_ok()

1404

1931

1405

1932

# Enable - method

1933

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

1406

1934

@dbus.service.method(_interface)

1407

1935

def Enable(self):

1408

1936

"D-Bus method"

1409

1937

self.enable()

1410

1938

1411

1939

# StartChecker - method

1940

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

1412

1941

@dbus.service.method(_interface)

1413

1942

def StartChecker(self):

1414

1943

"D-Bus method"

1415

1944

self.start_checker()

1416

1945

1417

1946

# Disable - method

1947

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

1418

1948

@dbus.service.method(_interface)

1419

1949

def Disable(self):

1420

1950

"D-Bus method"

1421

1951

self.disable()

1422

1952

1423

1953

# StopChecker - method

1954

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

1424

1955

@dbus.service.method(_interface)

1425

1956

def StopChecker(self):

1426

1957

self.stop_checker()

1427

1428

## Properties

1429

1958

1959

# Properties

1960

1430

1961

# ApprovalPending - property

1431

1962

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

1432

1963

def ApprovalPending_dbus_property(self):

1433

1964

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

1434

1965

1435

1966

# ApprovedByDefault - property

1436

@dbus_service_property(_interface, signature="b",

1967

@dbus_service_property(_interface,

1968

signature="b",

1437

1969

access="readwrite")

1438

1970

def ApprovedByDefault_dbus_property(self, value=None):

1439

1971

if value is None: # get

1440

1972

return dbus.Boolean(self.approved_by_default)

1441

1973

self.approved_by_default = bool(value)

1442

1974

1443

1975

# ApprovalDelay - property

1444

@dbus_service_property(_interface, signature="t",

1976

@dbus_service_property(_interface,

1977

signature="t",

1445

1978

access="readwrite")

1446

1979

def ApprovalDelay_dbus_property(self, value=None):

1447

1980

if value is None: # get

1448

return dbus.UInt64(self.approval_delay_milliseconds())

1981

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

1982

* 1000)

1449

1983

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

1450

1984

1451

1985

# ApprovalDuration - property

1452

@dbus_service_property(_interface, signature="t",

1986

@dbus_service_property(_interface,

1987

signature="t",

1453

1988

access="readwrite")

1454

1989

def ApprovalDuration_dbus_property(self, value=None):

1455

1990

if value is None: # get

1456

return dbus.UInt64(timedelta_to_milliseconds(

1457

self.approval_duration))

1991

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

1992

* 1000)

1458

1993

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

1459

1994

1460

1995

# Name - property

1996

@dbus_annotations(

1997

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

1461

1998

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

1462

1999

def Name_dbus_property(self):

1463

2000

return dbus.String(self.name)

1464

2001

1465

2002

# Fingerprint - property

2003

@dbus_annotations(

2004

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

1466

2005

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

1467

2006

def Fingerprint_dbus_property(self):

1468

2007

return dbus.String(self.fingerprint)

1469

2008

1470

2009

# Host - property

1471

@dbus_service_property(_interface, signature="s",

2010

@dbus_service_property(_interface,

2011

signature="s",

1472

2012

access="readwrite")

1473

2013

def Host_dbus_property(self, value=None):

1474

2014

if value is None: # get

1475

2015

return dbus.String(self.host)

1476

self.host = unicode(value)

1477

2016

self.host = str(value)

2017

1478

2018

# Created - property

2019

@dbus_annotations(

2020

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

1479

2021

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

1480

2022

def Created_dbus_property(self):

1481

2023

return datetime_to_dbus(self.created)

1482

2024

1483

2025

# LastEnabled - property

1484

2026

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

1485

2027

def LastEnabled_dbus_property(self):

1486

2028

return datetime_to_dbus(self.last_enabled)

1487

2029

1488

2030

# Enabled - property

1489

@dbus_service_property(_interface, signature="b",

2031

@dbus_service_property(_interface,

2032

signature="b",

1490

2033

access="readwrite")

1491

2034

def Enabled_dbus_property(self, value=None):

1492

2035

if value is None: # get

1495

2038

self.enable()

1496

2039

else:

1497

2040

self.disable()

1498

2041

1499

2042

# LastCheckedOK - property

1500

@dbus_service_property(_interface, signature="s",

2043

@dbus_service_property(_interface,

2044

signature="s",

1501

2045

access="readwrite")

1502

2046

def LastCheckedOK_dbus_property(self, value=None):

1503

2047

if value is not None:

1504

2048

self.checked_ok()

1505

2049

return

1506

2050

return datetime_to_dbus(self.last_checked_ok)

1507

2051

1508

2052

# LastCheckerStatus - property

1509

@dbus_service_property(_interface, signature="n",

1510

access="read")

2053

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

1511

2054

def LastCheckerStatus_dbus_property(self):

1512

2055

return dbus.Int16(self.last_checker_status)

1513

2056

1514

2057

# Expires - property

1515

2058

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

1516

2059

def Expires_dbus_property(self):

1517

2060

return datetime_to_dbus(self.expires)

1518

2061

1519

2062

# LastApprovalRequest - property

1520

2063

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

1521

2064

def LastApprovalRequest_dbus_property(self):

1522

2065

return datetime_to_dbus(self.last_approval_request)

1523

2066

1524

2067

# Timeout - property

1525

@dbus_service_property(_interface, signature="t",

2068

@dbus_service_property(_interface,

2069

signature="t",

1526

2070

access="readwrite")

1527

2071

def Timeout_dbus_property(self, value=None):

1528

2072

if value is None: # get

1529

return dbus.UInt64(self.timeout_milliseconds())

2073

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

2074

old_timeout = self.timeout

1530

2075

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

1531

# Reschedule timeout

2076

# Reschedule disabling

1532

2077

if self.enabled:

1533

2078

now = datetime.datetime.utcnow()

1534

time_to_die = timedelta_to_milliseconds(

1535

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

1536

if time_to_die <= 0:

2079

self.expires += self.timeout - old_timeout

2080

if self.expires <= now:

1537

2081

# The timeout has passed

1538

2082

self.disable()

1539

2083

else:

1540

self.expires = (now +

1541

datetime.timedelta(milliseconds =

1542

time_to_die))

1543

2084

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

1544

2085

is None):

1545

2086

return

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (gobject.timeout_add

1548

(time_to_die,

1549

self.disable))

1550

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

1551

2092

# ExtendedTimeout - property

1552

@dbus_service_property(_interface, signature="t",

2093

@dbus_service_property(_interface,

2094

signature="t",

1553

2095

access="readwrite")

1554

2096

def ExtendedTimeout_dbus_property(self, value=None):

1555

2097

if value is None: # get

1556

return dbus.UInt64(self.extended_timeout_milliseconds())

2098

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

2099

* 1000)

1557

2100

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

1558

2101

1559

2102

# Interval - property

1560

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1561

2105

access="readwrite")

1562

2106

def Interval_dbus_property(self, value=None):

1563

2107

if value is None: # get

1564

return dbus.UInt64(self.interval_milliseconds())

2108

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

1565

2109

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

1566

2110

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

1567

2111

return

1568

2112

if self.enabled:

1569

2113

# Reschedule checker run

1570

gobject.source_remove(self.checker_initiator_tag)

1571

self.checker_initiator_tag = (gobject.timeout_add

1572

(value, self.start_checker))

1573

self.start_checker() # Start one now, too

1574

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

1575

2119

# Checker - property

1576

@dbus_service_property(_interface, signature="s",

2120

@dbus_service_property(_interface,

2121

signature="s",

1577

2122

access="readwrite")

1578

2123

def Checker_dbus_property(self, value=None):

1579

2124

if value is None: # get

1580

2125

return dbus.String(self.checker_command)

1581

self.checker_command = unicode(value)

1582

2126

self.checker_command = str(value)

2127

1583

2128

# CheckerRunning - property

1584

@dbus_service_property(_interface, signature="b",

2129

@dbus_service_property(_interface,

2130

signature="b",

1585

2131

access="readwrite")

1586

2132

def CheckerRunning_dbus_property(self, value=None):

1587

2133

if value is None: # get

1590

2136

self.start_checker()

1591

2137

else:

1592

2138

self.stop_checker()

1593

2139

1594

2140

# ObjectPath - property

2141

@dbus_annotations(

2142

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

2143

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

1595

2144

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

1596

2145

def ObjectPath_dbus_property(self):

1597

return self.dbus_object_path # is already a dbus.ObjectPath

1598

2146

return self.dbus_object_path # is already a dbus.ObjectPath

2147

1599

2148

# Secret = property

1600

@dbus_service_property(_interface, signature="ay",

1601

access="write", byte_arrays=True)

2149

@dbus_annotations(

2150

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

2151

"invalidates"})

2152

@dbus_service_property(_interface,

2153

signature="ay",

2154

access="write",

2155

byte_arrays=True)

1602

2156

def Secret_dbus_property(self, value):

1603

self.secret = str(value)

1604

2157

self.secret = bytes(value)

2158

1605

2159

del _interface

1606

2160

1607

2161

1610

2164

self._pipe = child_pipe

1611

2165

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

1612

2166

if not self._pipe.recv():

1613

raise KeyError()

1614

2167

raise KeyError(fpr)

2168

1615

2169

def __getattribute__(self, name):

1616

2170

if name == '_pipe':

1617

2171

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

1620

2174

if data[0] == 'data':

1621

2175

return data[1]

1622

2176

if data[0] == 'function':

2177

1623

2178

def func(*args, **kwargs):

1624

2179

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

1625

2180

return self._pipe.recv()[1]

2181

1626

2182

return func

1627

2183

1628

2184

def __setattr__(self, name, value):

1629

2185

if name == '_pipe':

1630

2186

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

1633

2189

1634

2190

class ClientHandler(socketserver.BaseRequestHandler, object):

1635

2191

"""A class to handle client connections.

1636

2192

1637

2193

Instantiated once for each connection to handle it.

1638

2194

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

1639

2195

1640

2196

def handle(self):

1641

2197

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

1642

2198

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

1643

unicode(self.client_address))

2199

str(self.client_address))

1644

2200

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

1645

2201

self.server.child_pipe.fileno())

1646

1647

session = (gnutls.connection

1648

.ClientSession(self.request,

1649

gnutls.connection

1650

.X509Credentials()))

1651

1652

# Note: gnutls.connection.X509Credentials is really a

1653

# generic GnuTLS certificate credentials object so long as

1654

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

1655

# here despite using OpenPGP certificates.

1656

1657

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

1658

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

1659

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

1660

# "+DHE-DSS"))

2202

2203

session = gnutls.ClientSession(self.request)

2204

2205

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

2206

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

2207

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

2208

# "+DHE-DSS"))

1661

2209

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

1662

2210

priority = self.server.gnutls_priority

1663

2211

if priority is None:

1664

2212

priority = "NORMAL"

1665

(gnutls.library.functions

1666

.gnutls_priority_set_direct(session._c_object,

1667

priority, None))

1668

2213

gnutls.priority_set_direct(session._c_object,

2214

priority.encode("utf-8"),

2215

None)

2216

1669

2217

# Start communication using the Mandos protocol

1670

2218

# Get protocol number

1671

2219

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

1672

2220

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

1673

2221

try:

1674

2222

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

1675

raise RuntimeError

2223

raise RuntimeError(line)

1676

2224

except (ValueError, IndexError, RuntimeError) as error:

1677

2225

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

1678

2226

return

1679

2227

1680

2228

# Start GnuTLS connection

1681

2229

try:

1682

2230

session.handshake()

1683

except gnutls.errors.GNUTLSError as error:

2231

except gnutls.Error as error:

1684

2232

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

1685

2233

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

1686

2234

# established. Just abandon the request.

1687

2235

return

1688

2236

logger.debug("Handshake succeeded")

1689

2237

1690

2238

approval_required = False

1691

2239

try:

1692

2240

try:

1693

fpr = self.fingerprint(self.peer_certificate

1694

(session))

1695

except (TypeError,

1696

gnutls.errors.GNUTLSError) as error:

2241

fpr = self.fingerprint(

2242

self.peer_certificate(session))

2243

except (TypeError, gnutls.Error) as error:

1697

2244

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

1698

2245

return

1699

2246

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

1700

2247

1701

2248

try:

1702

2249

client = ProxyClient(child_pipe, fpr,

1703

2250

self.client_address)

1704

2251

except KeyError:

1705

2252

return

1706

2253

1707

2254

if client.approval_delay:

1708

2255

delay = client.approval_delay

1709

2256

client.approvals_pending += 1

1710

2257

approval_required = True

1711

2258

1712

2259

while True:

1713

2260

if not client.enabled:

1714

2261

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

1715

client.name)

2262

client.name)

1716

2263

if self.server.use_dbus:

1717

2264

# Emit D-Bus signal

1718

2265

client.Rejected("Disabled")

1719

2266

return

1720

2267

1721

2268

if client.approved or not client.approval_delay:

1722

#We are approved or approval is disabled

2269

# We are approved or approval is disabled

1723

2270

break

1724

2271

elif client.approved is None:

1725

2272

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

1727

2274

if self.server.use_dbus:

1728

2275

# Emit D-Bus signal

1729

2276

client.NeedApproval(

1730

client.approval_delay_milliseconds(),

1731

client.approved_by_default)

2277

client.approval_delay.total_seconds()

2278

* 1000, client.approved_by_default)

1732

2279

else:

1733

2280

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

1734

2281

client.name)

1736

2283

# Emit D-Bus signal

1737

2284

client.Rejected("Denied")

1738

2285

return

1739

1740

#wait until timeout or approved

2286

2287

# wait until timeout or approved

1741

2288

time = datetime.datetime.now()

1742

2289

client.changedstate.acquire()

1743

(client.changedstate.wait

1744

(float(client.timedelta_to_milliseconds(delay)

1745

/ 1000)))

2290

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

1746

2291

client.changedstate.release()

1747

2292

time2 = datetime.datetime.now()

1748

2293

if (time2 - time) >= delay:

1758

2303

break

1759

2304

else:

1760

2305

delay -= time2 - time

1761

1762

sent_size = 0

1763

while sent_size < len(client.secret):

1764

try:

1765

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

1766

except gnutls.errors.GNUTLSError as error:

1767

logger.warning("gnutls send failed",

1768

exc_info=error)

1769

return

1770

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

1771

sent, len(client.secret)

1772

- (sent_size + sent))

1773

sent_size += sent

1774

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

1775

2314

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

1776

2315

# bump the timeout using extended_timeout

1777

2316

client.bump_timeout(client.extended_timeout)

1778

2317

if self.server.use_dbus:

1779

2318

# Emit D-Bus signal

1780

2319

client.GotSecret()

1781

2320

1782

2321

finally:

1783

2322

if approval_required:

1784

2323

client.approvals_pending -= 1

1785

2324

try:

1786

2325

session.bye()

1787

except gnutls.errors.GNUTLSError as error:

2326

except gnutls.Error as error:

1788

2327

logger.warning("GnuTLS bye failed",

1789

2328

exc_info=error)

1790

2329

1791

2330

@staticmethod

1792

2331

def peer_certificate(session):

1793

2332

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

1794

2333

# If not an OpenPGP certificate...

1795

if (gnutls.library.functions

1796

.gnutls_certificate_type_get(session._c_object)

1797

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1798

# ...do the normal thing

1799

return session.peer_certificate

2334

if (gnutls.certificate_type_get(session._c_object)

2335

!= gnutls.CRT_OPENPGP):

2336

# ...return invalid data

2337

return b""

1800

2338

list_size = ctypes.c_uint(1)

1801

cert_list = (gnutls.library.functions

1802

.gnutls_certificate_get_peers

2339

cert_list = (gnutls.certificate_get_peers

1803

2340

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

1804

2341

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

1805

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

1806

" certificate")

2342

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

1807

2343

if list_size.value == 0:

1808

2344

return None

1809

2345

cert = cert_list[0]

1810

2346

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

1811

2347

1812

2348

@staticmethod

1813

2349

def fingerprint(openpgp):

1814

2350

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1815

2351

# New GnuTLS "datum" with the OpenPGP public key

1816

datum = (gnutls.library.types

1817

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

1818

ctypes.POINTER

1819

(ctypes.c_ubyte)),

1820

ctypes.c_uint(len(openpgp))))

2352

datum = gnutls.datum_t(

2353

ctypes.cast(ctypes.c_char_p(openpgp),

2354

ctypes.POINTER(ctypes.c_ubyte)),

2355

ctypes.c_uint(len(openpgp)))

1821

2356

# New empty GnuTLS certificate

1822

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1823

(gnutls.library.functions

1824

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2357

crt = gnutls.openpgp_crt_t()

2358

gnutls.openpgp_crt_init(ctypes.byref(crt))

1825

2359

# Import the OpenPGP public key into the certificate

1826

(gnutls.library.functions

1827

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

1828

gnutls.library.constants

1829

.GNUTLS_OPENPGP_FMT_RAW))

2360

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

2361

gnutls.OPENPGP_FMT_RAW)

1830

2362

# Verify the self signature in the key

1831

2363

crtverify = ctypes.c_uint()

1832

(gnutls.library.functions

1833

.gnutls_openpgp_crt_verify_self(crt, 0,

1834

ctypes.byref(crtverify)))

2364

gnutls.openpgp_crt_verify_self(crt, 0,

2365

ctypes.byref(crtverify))

1835

2366

if crtverify.value != 0:

1836

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1837

raise (gnutls.errors.CertificateSecurityError

1838

("Verify failed"))

2367

gnutls.openpgp_crt_deinit(crt)

2368

raise gnutls.CertificateSecurityError("Verify failed")

1839

2369

# New buffer for the fingerprint

1840

2370

buf = ctypes.create_string_buffer(20)

1841

2371

buf_len = ctypes.c_size_t()

1842

2372

# Get the fingerprint from the certificate into the buffer

1843

(gnutls.library.functions

1844

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

1845

ctypes.byref(buf_len)))

2373

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

2374

ctypes.byref(buf_len))

1846

2375

# Deinit the certificate

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2376

gnutls.openpgp_crt_deinit(crt)

1848

2377

# Convert the buffer to a Python bytestring

1849

2378

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

1850

2379

# Convert the bytestring to hexadecimal notation

1854

2383

1855

2384

class MultiprocessingMixIn(object):

1856

2385

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

2386

1857

2387

def sub_process_main(self, request, address):

1858

2388

try:

1859

2389

self.finish_request(request, address)

1860

2390

except Exception:

1861

2391

self.handle_error(request, address)

1862

2392

self.close_request(request)

1863

2393

1864

2394

def process_request(self, request, address):

1865

2395

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

1866

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

1867

args = (request,

1868

address))

2396

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

2397

args=(request, address))

1869

2398

proc.start()

1870

2399

return proc

1871

2400

1872

2401

1873

2402

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1874

2403

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

2404

1875

2405

def process_request(self, request, client_address):

1876

2406

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

1877

2407

1878

2408

This function creates a new pipe in self.pipe

1879

2409

"""

1880

2410

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1881

2411

1882

2412

proc = MultiprocessingMixIn.process_request(self, request,

1883

2413

client_address)

1884

2414

self.child_pipe.close()

1885

2415

self.add_pipe(parent_pipe, proc)

1886

2416

1887

2417

def add_pipe(self, parent_pipe, proc):

1888

2418

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

1889

raise NotImplementedError

2419

raise NotImplementedError()

1890

2420

1891

2421

1892

2422

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1893

2423

socketserver.TCPServer, object):

1894

2424

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

1895

2425

1896

2426

Attributes:

1897

2427

enabled: Boolean; whether this server is activated yet

1898

2428

interface: None or a network interface name (string)

1899

2429

use_ipv6: Boolean; to use IPv6 or not

1900

2430

"""

2431

1901

2432

def __init__(self, server_address, RequestHandlerClass,

1902

interface=None, use_ipv6=True):

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

"""

1903

2439

self.interface = interface

1904

2440

if use_ipv6:

1905

2441

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.

1906

2469

socketserver.TCPServer.__init__(self, server_address,

1907

2470

RequestHandlerClass)

2471

1908

2472

def server_bind(self):

1909

2473

"""This overrides the normal server_bind() function

1910

2474

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

1911

2475

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

2476

global SO_BINDTODEVICE

1912

2477

if self.interface is not None:

1913

2478

if SO_BINDTODEVICE is None:

1914

logger.error("SO_BINDTODEVICE does not exist;"

1915

" cannot bind to interface %s",

1916

self.interface)

1917

else:

1918

try:

1919

self.socket.setsockopt(socket.SOL_SOCKET,

1920

SO_BINDTODEVICE,

1921

str(self.interface

1922

+ '\0'))

1923

except socket.error as error:

1924

if error[0] == errno.EPERM:

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1928

elif error[0] == errno.ENOPROTOOPT:

1929

logger.error("SO_BINDTODEVICE not available;"

1930

" cannot bind to interface %s",

1931

self.interface)

1932

else:

1933

raise

2479

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

2480

# common enough.

2481

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

2482

SO_BINDTODEVICE = 25

2483

try:

2484

self.socket.setsockopt(

2485

socket.SOL_SOCKET, SO_BINDTODEVICE,

2486

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

2487

except socket.error as error:

2488

if error.errno == errno.EPERM:

2489

logger.error("No permission to bind to"

2490

" interface %s", self.interface)

2491

elif error.errno == errno.ENOPROTOOPT:

2492

logger.error("SO_BINDTODEVICE not available;"

2493

" cannot bind to interface %s",

2494

self.interface)

2495

elif error.errno == errno.ENODEV:

2496

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

2497

" cannot bind", self.interface)

2498

else:

2499

raise

1934

2500

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

1935

2501

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

1936

2502

if not self.server_address[0]:

1937

2503

if self.address_family == socket.AF_INET6:

1938

any_address = "::" # in6addr_any

2504

any_address = "::" # in6addr_any

1939

2505

else:

1940

any_address = socket.INADDR_ANY

2506

any_address = "0.0.0.0" # INADDR_ANY

1941

2507

self.server_address = (any_address,

1942

2508

self.server_address[1])

1943

2509

elif not self.server_address[1]:

1944

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

1945

0)

2510

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

1946

2511

# if self.interface:

1947

2512

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

1948

2513

# 0, # port

1954

2519

1955

2520

class MandosServer(IPv6_TCPServer):

1956

2521

"""Mandos server.

1957

2522

1958

2523

Attributes:

1959

2524

clients: set of Client objects

1960

2525

gnutls_priority GnuTLS priority string

1961

2526

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

1962

1963

Assumes a gobject.MainLoop event loop.

2527

2528

Assumes a GLib.MainLoop event loop.

1964

2529

"""

2530

1965

2531

def __init__(self, server_address, RequestHandlerClass,

1966

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

1967

gnutls_priority=None, use_dbus=True):

2532

interface=None,

2533

use_ipv6=True,

2534

clients=None,

2535

gnutls_priority=None,

2536

use_dbus=True,

2537

socketfd=None):

1968

2538

self.enabled = False

1969

2539

self.clients = clients

1970

2540

if self.clients is None:

1973

2543

self.gnutls_priority = gnutls_priority

1974

2544

IPv6_TCPServer.__init__(self, server_address,

1975

2545

RequestHandlerClass,

1976

interface = interface,

1977

use_ipv6 = use_ipv6)

2546

interface=interface,

2547

use_ipv6=use_ipv6,

2548

socketfd=socketfd)

2549

1978

2550

def server_activate(self):

1979

2551

if self.enabled:

1980

2552

return socketserver.TCPServer.server_activate(self)

1981

2553

1982

2554

def enable(self):

1983

2555

self.enabled = True

1984

2556

1985

2557

def add_pipe(self, parent_pipe, proc):

1986

2558

# Call "handle_ipc" for both data and EOF events

1987

gobject.io_add_watch(parent_pipe.fileno(),

1988

gobject.IO_IN | gobject.IO_HUP,

1989

functools.partial(self.handle_ipc,

1990

parent_pipe =

1991

parent_pipe,

1992

proc = proc))

1993

1994

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

1995

proc = None, client_object=None):

1996

condition_names = {

1997

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

1998

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

1999

# blocking).

2000

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

2001

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

2002

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

2003

# broken, usually for pipes and

2004

# sockets).

2005

}

2006

conditions_string = ' | '.join(name

2007

for cond, name in

2008

condition_names.iteritems()

2009

if cond & condition)

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

2010

2570

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

2011

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

2571

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

2012

2572

# Wait for other process to exit

2013

2573

proc.join()

2014

2574

return False

2015

2575

2016

2576

# Read a request from the child

2017

2577

request = parent_pipe.recv()

2018

2578

command = request[0]

2019

2579

2020

2580

if command == 'init':

2021

fpr = request[1]

2581

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

2022

2582

address = request[2]

2023

2024

for c in self.clients.itervalues():

2583

2584

for c in self.clients.values():

2025

2585

if c.fingerprint == fpr:

2026

2586

client = c

2027

2587

break

2034

2594

address[0])

2035

2595

parent_pipe.send(False)

2036

2596

return False

2037

2038

gobject.io_add_watch(parent_pipe.fileno(),

2039

gobject.IO_IN | gobject.IO_HUP,

2040

functools.partial(self.handle_ipc,

2041

parent_pipe =

2042

parent_pipe,

2043

proc = proc,

2044

client_object =

2045

client))

2597

2598

GLib.io_add_watch(

2599

parent_pipe.fileno(),

2600

GLib.IO_IN | GLib.IO_HUP,

2601

functools.partial(self.handle_ipc,

2602

parent_pipe=parent_pipe,

2603

proc=proc,

2604

client_object=client))

2046

2605

parent_pipe.send(True)

2047

2606

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

2048

2607

# same fileno

2051

2610

funcname = request[1]

2052

2611

args = request[2]

2053

2612

kwargs = request[3]

2054

2613

2055

2614

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

2056

2615

funcname)(*args,

2057

**kwargs)))

2058

2616

**kwargs)))

2617

2059

2618

if command == 'getattr':

2060

2619

attrname = request[1]

2061

if callable(client_object.__getattribute__(attrname)):

2062

parent_pipe.send(('function',))

2620

if isinstance(client_object.__getattribute__(attrname),

2621

collections.Callable):

2622

parent_pipe.send(('function', ))

2063

2623

else:

2064

parent_pipe.send(('data', client_object

2065

.__getattribute__(attrname)))

2066

2624

parent_pipe.send((

2625

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

2626

2067

2627

if command == 'setattr':

2068

2628

attrname = request[1]

2069

2629

value = request[2]

2070

2630

setattr(client_object, attrname, value)

2071

2631

2072

2632

return True

2073

2633

2074

2634

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

2075

2734

def string_to_delta(interval):

2076

2735

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

2077

2736

2078

2737

>>> string_to_delta('7d')

2079

2738

datetime.timedelta(7)

2080

2739

>>> string_to_delta('60s')

2088

2747

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

2089

2748

datetime.timedelta(0, 330)

2090

2749

"""

2750

2751

try:

2752

return rfc3339_duration_to_delta(interval)

2753

except ValueError:

2754

pass

2755

2091

2756

timevalue = datetime.timedelta(0)

2092

2757

for s in interval.split():

2093

2758

try:

2094

suffix = unicode(s[-1])

2759

suffix = s[-1]

2095

2760

value = int(s[:-1])

2096

2761

if suffix == "d":

2097

2762

delta = datetime.timedelta(value)

2104

2769

elif suffix == "w":

2105

2770

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

2106

2771

else:

2107

raise ValueError("Unknown suffix {0!r}"

2108

.format(suffix))

2109

except (ValueError, IndexError) as e:

2772

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

2773

except IndexError as e:

2110

2774

raise ValueError(*(e.args))

2111

2775

timevalue += delta

2112

2776

return timevalue

2113

2777

2114

2778

2115

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

2779

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

2116

2780

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

2117

2781

2118

2782

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

2119

2783

if os.fork():

2120

2784

sys.exit()

2128

2792

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

2129

2793

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

2130

2794

raise OSError(errno.ENODEV,

2131

"{0} not a character device"

2795

"{} not a character device"

2132

2796

.format(os.devnull))

2133

2797

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

2134

2798

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

2138

2802

2139

2803

2140

2804

def main():

2141

2805

2142

2806

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

2143

2807

# Parsing of options, both command line and config file

2144

2808

2145

2809

parser = argparse.ArgumentParser()

2146

2810

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

2147

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

2811

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

2148

2812

help="show version number and exit")

2149

2813

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

2150

2814

help="Bind to interface IF")

2156

2820

help="Run self-test")

2157

2821

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

2158

2822

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

2159

" to terminal")

2823

" to terminal", default=None)

2160

2824

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

2161

2825

help="Debug level for stdout output")

2162

2826

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

2169

2833

" files")

2170

2834

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

2171

2835

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

2172

" system bus interface")

2836

" system bus interface", default=None)

2173

2837

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

2174

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

2838

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

2839

default=None)

2175

2840

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

2176

2841

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

2177

" state")

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

2178

2846

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

2179

2847

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

2180

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

2181

2854

options = parser.parse_args()

2182

2855

2183

2856

if options.check:

2184

2857

import doctest

2185

doctest.testmod()

2186

sys.exit()

2187

2858

fail_count, test_count = doctest.testmod()

2859

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

2860

2188

2861

# Default values for config file for server-global settings

2189

server_defaults = { "interface": "",

2190

"address": "",

2191

"port": "",

2192

"debug": "False",

2193

"priority":

2194

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

2195

"servicename": "Mandos",

2196

"use_dbus": "True",

2197

"use_ipv6": "True",

2198

"debuglevel": "",

2199

"restore": "True",

2200

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

2201

}

2202

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

2203

2880

# Parse config file for server-global settings

2204

2881

server_config = configparser.SafeConfigParser(server_defaults)

2205

2882

del server_defaults

2206

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

2207

"mandos.conf"))

2883

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

2208

2884

# Convert the SafeConfigParser object to a dict

2209

2885

server_settings = server_config.defaults()

2210

2886

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

2211

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

2887

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

2888

"foreground", "zeroconf"):

2212

2889

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

2213

2890

option)

2214

2891

if server_settings["port"]:

2215

2892

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

2216

2893

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

2217

2903

del server_config

2218

2904

2219

2905

# Override the settings from the config file with command line

2220

2906

# options, if set.

2221

2907

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

2222

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

2223

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

2224

"statedir"):

2908

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

2909

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

2910

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

2225

2911

value = getattr(options, option)

2226

2912

if value is not None:

2227

2913

server_settings[option] = value

2228

2914

del options

2229

2915

# Force all strings to be unicode

2230

2916

for option in server_settings.keys():

2231

if type(server_settings[option]) is str:

2232

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

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

2233

2927

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

2234

2928

2235

2929

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

2236

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

2237

2936

# For convenience

2238

2937

debug = server_settings["debug"]

2239

2938

debuglevel = server_settings["debuglevel"]

2241

2940

use_ipv6 = server_settings["use_ipv6"]

2242

2941

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

2243

2942

stored_state_file)

2244

2943

foreground = server_settings["foreground"]

2944

zeroconf = server_settings["zeroconf"]

2945

2245

2946

if debug:

2246

2947

initlogger(debug, logging.DEBUG)

2247

2948

else:

2250

2951

else:

2251

2952

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

2252

2953

initlogger(debug, level)

2253

2954

2254

2955

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

2255

syslogger.setFormatter(logging.Formatter

2256

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

2257

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

2258

.format(server_settings

2259

["servicename"])))

2260

2956

syslogger.setFormatter(

2957

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

2958

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

2959

server_settings["servicename"])))

2960

2261

2961

# Parse config file with clients

2262

2962

client_config = configparser.SafeConfigParser(Client

2263

2963

.client_defaults)

2264

2964

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

2265

2965

"clients.conf"))

2266

2966

2267

2967

global mandos_dbus_service

2268

2968

mandos_dbus_service = None

2269

2270

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

2271

server_settings["port"]),

2272

ClientHandler,

2273

interface=(server_settings["interface"]

2274

or None),

2275

use_ipv6=use_ipv6,

2276

gnutls_priority=

2277

server_settings["priority"],

2278

use_dbus=use_dbus)

2279

if not debug:

2280

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

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

2281

2986

try:

2282

pidfile = open(pidfilename, "w")

2987

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

2283

2988

except IOError as e:

2284

2989

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

2285

2990

exc_info=e)

2286

2287

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

2991

2992

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

2993

("mandos", "mandos"),

2994

("nobody", "nogroup")):

2288

2995

try:

2289

2996

uid = pwd.getpwnam(name).pw_uid

2290

gid = pwd.getpwnam(name).pw_gid

2997

gid = pwd.getpwnam(group).pw_gid

2291

2998

break

2292

2999

except KeyError:

2293

3000

continue

2297

3004

try:

2298

3005

os.setgid(gid)

2299

3006

os.setuid(uid)

3007

if debug:

3008

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

3009

gid))

2300

3010

except OSError as error:

2301

if error[0] != errno.EPERM:

2302

raise error

2303

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

2304

3016

if debug:

2305

3017

# Enable all possible GnuTLS debugging

2306

3018

2307

3019

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

2308

3020

# - GnuTLS manual

2309

gnutls.library.functions.gnutls_global_set_log_level(11)

2310

2311

@gnutls.library.types.gnutls_log_func

3021

gnutls.global_set_log_level(11)

3022

3023

@gnutls.log_func

2312

3024

def debug_gnutls(level, string):

2313

3025

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

2314

2315

(gnutls.library.functions

2316

.gnutls_global_set_log_function(debug_gnutls))

2317

3026

3027

gnutls.global_set_log_function(debug_gnutls)

3028

2318

3029

# Redirect stdin so all checkers get /dev/null

2319

3030

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

2320

3031

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

2321

3032

if null > 2:

2322

3033

os.close(null)

2323

3034

2324

3035

# Need to fork before connecting to D-Bus

2325

if not debug:

3036

if not foreground:

2326

3037

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

2327

3038

daemon()

2328

2329

gobject.threads_init()

2330

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

2331

3044

global main_loop

2332

3045

# From the Avahi example code

2333

3046

DBusGMainLoop(set_as_default=True)

2334

main_loop = gobject.MainLoop()

3047

main_loop = GLib.MainLoop()

2335

3048

bus = dbus.SystemBus()

2336

3049

# End of Avahi example code

2337

3050

if use_dbus:

2338

3051

try:

2339

3052

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

2340

bus, do_not_queue=True)

2341

old_bus_name = (dbus.service.BusName

2342

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

2343

do_not_queue=True))

2344

except dbus.exceptions.NameExistsException as e:

3053

bus,

3054

do_not_queue=True)

3055

old_bus_name = dbus.service.BusName(

3056

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

3057

do_not_queue=True)

3058

except dbus.exceptions.DBusException as e:

2345

3059

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

2346

3060

use_dbus = False

2347

3061

server_settings["use_dbus"] = False

2348

3062

tcp_server.use_dbus = False

2349

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2350

service = AvahiServiceToSyslog(name =

2351

server_settings["servicename"],

2352

servicetype = "_mandos._tcp",

2353

protocol = protocol, bus = bus)

2354

if server_settings["interface"]:

2355

service.interface = (if_nametoindex

2356

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

2357

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

2358

3074

global multiprocessing_manager

2359

3075

multiprocessing_manager = multiprocessing.Manager()

2360

3076

2361

3077

client_class = Client

2362

3078

if use_dbus:

2363

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

2364

3079

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

3080

2365

3081

client_settings = Client.config_parser(client_config)

2366

3082

old_client_settings = {}

2367

3083

clients_data = {}

2368

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

2369

3093

# Get client data and settings from last running state.

2370

3094

if server_settings["restore"]:

2371

3095

try:

2372

3096

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

2373

clients_data, old_client_settings = (pickle.load

2374

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

2375

3142

os.remove(stored_state_path)

2376

3143

except IOError as e:

2377

3144

if e.errno == errno.ENOENT:

2378

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

2379

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

3145

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

3146

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

2380

3147

else:

2381

3148

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

2382

3149

exc_info=e)

2383

3150

raise

2384

3151

except EOFError as e:

2385

3152

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

2386

"EOFError:", exc_info=e)

2387

3153

"EOFError:",

3154

exc_info=e)

3155

2388

3156

with PGPEngine() as pgp:

2389

for client_name, client in clients_data.iteritems():

3157

for client_name, client in clients_data.items():

3158

# Skip removed clients

3159

if client_name not in client_settings:

3160

continue

3161

2390

3162

# Decide which value to use after restoring saved state.

2391

3163

# We have three different values: Old config file,

2392

3164

# new config file, and saved state.

2397

3169

# For each value in new config, check if it

2398

3170

# differs from the old config value (Except for

2399

3171

# the "secret" attribute)

2400

if (name != "secret" and

2401

value != old_client_settings[client_name]

2402

[name]):

3172

if (name != "secret"

3173

and (value !=

3174

old_client_settings[client_name][name])):

2403

3175

client[name] = value

2404

3176

except KeyError:

2405

3177

pass

2406

3178

2407

3179

# Clients who has passed its expire date can still be

2408

# enabled if its last checker was successful. Clients

3180

# enabled if its last checker was successful. A Client

2409

3181

# whose checker succeeded before we stored its state is

2410

3182

# assumed to have successfully run all checkers during

2411

3183

# downtime.

2413

3185

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

2414

3186

if not client["last_checked_ok"]:

2415

3187

logger.warning(

2416

"disabling client {0} - Client never "

2417

"performed a successful checker"

2418

.format(client_name))

3188

"disabling client {} - Client never "

3189

"performed a successful checker".format(

3190

client_name))

2419

3191

client["enabled"] = False

2420

3192

elif client["last_checker_status"] != 0:

2421

3193

logger.warning(

2422

"disabling client {0} - Client "

2423

"last checker failed with error code {1}"

2424

.format(client_name,

2425

client["last_checker_status"]))

3194

"disabling client {} - Client last"

3195

" checker failed with error code"

3196

" {}".format(

3197

client_name,

3198

client["last_checker_status"]))

2426

3199

client["enabled"] = False

2427

3200

else:

2428

client["expires"] = (datetime.datetime

2429

.utcnow()

2430

+ client["timeout"])

3201

client["expires"] = (

3202

datetime.datetime.utcnow()

3203

+ client["timeout"])

2431

3204

logger.debug("Last checker succeeded,"

2432

" keeping {0} enabled"

2433

.format(client_name))

3205

" keeping {} enabled".format(

3206

client_name))

2434

3207

try:

2435

client["secret"] = (

2436

pgp.decrypt(client["encrypted_secret"],

2437

client_settings[client_name]

2438

["secret"]))

3208

client["secret"] = pgp.decrypt(

3209

client["encrypted_secret"],

3210

client_settings[client_name]["secret"])

2439

3211

except PGPError:

2440

3212

# If decryption fails, we use secret from new settings

2441

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

2442

.format(client_name))

2443

client["secret"] = (

2444

client_settings[client_name]["secret"])

2445

3213

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

3214

client_name))

3215

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

3216

["secret"])

3217

2446

3218

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

2447

3219

for client_name in (set(old_client_settings)

2448

3220

- set(client_settings)):

2450

3222

for client_name in (set(client_settings)

2451

3223

- set(old_client_settings)):

2452

3224

clients_data[client_name] = client_settings[client_name]

2453

3225

2454

3226

# Create all client objects

2455

for client_name, client in clients_data.iteritems():

3227

for client_name, client in clients_data.items():

2456

3228

tcp_server.clients[client_name] = client_class(

2457

name = client_name, settings = client)

2458

3229

name=client_name,

3230

settings=client,

3231

server_settings=server_settings)

3232

2459

3233

if not tcp_server.clients:

2460

3234

logger.warning("No clients defined")

2461

2462

if not debug:

2463

try:

2464

with pidfile:

2465

pid = os.getpid()

2466

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

2467

del pidfile

2468

except IOError:

2469

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

2470

pidfilename, pid)

2471

except NameError:

2472

# "pidfile" was never created

2473

pass

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

2474

3246

del pidfilename

2475

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

2476

2477

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

2478

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

2479

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

2480

3252

if use_dbus:

2481

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

2482

"se.bsnet.fukt.Mandos"})

2483

class MandosDBusService(DBusObjectWithProperties):

3253

3254

@alternate_dbus_interfaces(

3255

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

3256

class MandosDBusService(DBusObjectWithObjectManager):

2484

3257

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

3258

2485

3259

def __init__(self):

2486

3260

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

3261

2487

3262

_interface = "se.recompile.Mandos"

2488

2489

@dbus_interface_annotations(_interface)

2490

def _foo(self):

2491

return { "org.freedesktop.DBus.Property"

2492

".EmitsChangedSignal":

2493

"false"}

2494

3263

2495

3264

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

2496

3265

def ClientAdded(self, objpath):

2497

3266

"D-Bus signal"

2498

3267

pass

2499

3268

2500

3269

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

2501

3270

def ClientNotFound(self, fingerprint, address):

2502

3271

"D-Bus signal"

2503

3272

pass

2504

3273

3274

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

3275

"true"})

2505

3276

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

2506

3277

def ClientRemoved(self, objpath, name):

2507

3278

"D-Bus signal"

2508

3279

pass

2509

3280

3281

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

3282

"true"})

2510

3283

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

2511

3284

def GetAllClients(self):

2512

3285

"D-Bus method"

2513

return dbus.Array(c.dbus_object_path

2514

for c in

2515

tcp_server.clients.itervalues())

2516

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

2517

3291

@dbus.service.method(_interface,

2518

3292

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

2519

3293

def GetAllClientsWithProperties(self):

2520

3294

"D-Bus method"

2521

3295

return dbus.Dictionary(

2522

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

2523

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

3296

{c.dbus_object_path: c.GetAll(

3297

"se.recompile.Mandos.Client")

3298

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

2524

3299

signature="oa{sv}")

2525

3300

2526

3301

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

2527

3302

def RemoveClient(self, object_path):

2528

3303

"D-Bus method"

2529

for c in tcp_server.clients.itervalues():

3304

for c in tcp_server.clients.values():

2530

3305

if c.dbus_object_path == object_path:

2531

3306

del tcp_server.clients[c.name]

2532

3307

c.remove_from_connection()

2533

# Don't signal anything except ClientRemoved

3308

# Don't signal the disabling

2534

3309

c.disable(quiet=True)

2535

# Emit D-Bus signal

2536

self.ClientRemoved(object_path, c.name)

3310

# Emit D-Bus signal for removal

3311

self.client_removed_signal(c)

2537

3312

return

2538

3313

raise KeyError(object_path)

2539

3314

2540

3315

del _interface

2541

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

2542

3353

mandos_dbus_service = MandosDBusService()

2543

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

2544

3360

def cleanup():

2545

3361

"Cleanup function; run on exit"

2546

service.cleanup()

2547

2548

multiprocessing.active_children()

3362

if zeroconf:

3363

service.cleanup()

3364

3365

mp.active_children()

3366

wn.close()

2549

3367

if not (tcp_server.clients or client_settings):

2550

3368

return

2551

3369

2552

3370

# Store client before exiting. Secrets are encrypted with key

2553

3371

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

2554

3372

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

2555

3373

clients = {}

2556

3374

with PGPEngine() as pgp:

2557

for client in tcp_server.clients.itervalues():

3375

for client in tcp_server.clients.values():

2558

3376

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

2559

3377

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

2560

3378

key)

2561

3379

client_dict = {}

2562

3380

2563

3381

# A list of attributes that can not be pickled

2564

3382

# + secret.

2565

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

2566

"checker"))

2567

for name, typ in (inspect.getmembers

2568

(dbus.service.Object)):

3383

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

3384

"checker", "server_settings"}

3385

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

3386

.Object):

2569

3387

exclude.add(name)

2570

3388

2571

3389

client_dict["encrypted_secret"] = (client

2572

3390

.encrypted_secret)

2573

3391

for attr in client.client_structure:

2574

3392

if attr not in exclude:

2575

3393

client_dict[attr] = getattr(client, attr)

2576

3394

2577

3395

clients[client.name] = client_dict

2578

3396

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

2579

3397

2580

3398

try:

2581

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

2582

prefix="clients-",

2583

dir=os.path.dirname

2584

(stored_state_path))

2585

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

2586

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

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

2587

3408

os.rename(tempname, stored_state_path)

2588

3409

except (IOError, OSError) as e:

2589

3410

if not debug:

2592

3413

except NameError:

2593

3414

pass

2594

3415

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

2595

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

3416

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

2596

3417

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

2597

3418

else:

2598

3419

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

2599

3420

exc_info=e)

2600

raise e

2601

3421

raise

3422

2602

3423

# Delete all clients, and settings from config

2603

3424

while tcp_server.clients:

2604

3425

name, client = tcp_server.clients.popitem()

2605

3426

if use_dbus:

2606

3427

client.remove_from_connection()

2607

# Don't signal anything except ClientRemoved

3428

# Don't signal the disabling

2608

3429

client.disable(quiet=True)

3430

# Emit D-Bus signal for removal

2609

3431

if use_dbus:

2610

# Emit D-Bus signal

2611

mandos_dbus_service.ClientRemoved(client

2612

.dbus_object_path,

2613

client.name)

3432

mandos_dbus_service.client_removed_signal(client)

2614

3433

client_settings.clear()

2615

3434

2616

3435

atexit.register(cleanup)

2617

2618

for client in tcp_server.clients.itervalues():

3436

3437

for client in tcp_server.clients.values():

2619

3438

if use_dbus:

2620

# Emit D-Bus signal

2621

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3439

# Emit D-Bus signal for adding

3440

mandos_dbus_service.client_added_signal(client)

2622

3441

# Need to initiate checking of clients

2623

3442

if client.enabled:

2624

3443

client.init_checker()

2625

3444

2626

3445

tcp_server.enable()

2627

3446

tcp_server.server_activate()

2628

3447

2629

3448

# Find out what port we got

2630

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

3449

if zeroconf:

3450

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

2631

3451

if use_ipv6:

2632

3452

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

2633

3453

" flowinfo %d, scope_id %d",

2635

3455

else: # IPv4

2636

3456

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

2637

3457

*tcp_server.socket.getsockname())

2638

2639

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

2640

3458

3459

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

3460

2641

3461

try:

2642

# From the Avahi example code

2643

try:

2644

service.activate()

2645

except dbus.exceptions.DBusException as error:

2646

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

2647

cleanup()

2648

sys.exit(1)

2649

# End of Avahi example code

2650

2651

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

2652

lambda *args, **kwargs:

2653

(tcp_server.handle_request

2654

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

2655

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

2656

3477

logger.debug("Starting main loop")

2657

3478

main_loop.run()

2658

3479

except AvahiError as error:

2667

3488

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

2668

3489

cleanup()

2669

3490

3491

2670

3492

if __name__ == '__main__':

2671

3493

main()